Common Element Manager User Guide Part Number D4000-006 Rev A1

TRADEMARK This document contains proprietary information that is protected by copyright; it is intended for your internal use only. It is not to be disclosed to third parties. All rights reserved. No part of this document may be photocopied or reproduced in any way without the prior written permission of NewNet Communication Technologies, LLC. (NewNet) The information contained in this document is subject to change without notice. NewNet makes no warranty of any kind with regard to this material. NewNet shall not be liable for errors contained herein or for incidental or consequential damages in connection with the use of this material. COPYRIGHT INFORMATION In no event shall the authors or distributors be liable to any party for direct, indirect, special, incidental, or consequential damages arising out of the use of this software, its documentation, or any derivatives thereof, even if the authors have been advised of the possibility of such damage. The authors and distributors specifically disclaim any warranties, including, but not limited to, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement. This software is provided on an as is basis, and the authors and distributors have no obligation to provide maintenance, support, updates, enhancements or modifications. GOVERNMENT USE If you are acquiring this software on behalf of the U.S. government, the Government shall have only "Restricted Rights" in the software and related documentation as defined in the Federal Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2). If you are acquiring the software on behalf of the Department of Defense, the software shall be classified as "Commercial Computer Software" and the Government shall have only "Restricted Rights" as defined in Clause 252.227-7013 (c) (1) of DFARs. Notwithstanding the foregoing, the authors grant the U.S. Government and others acting in its behalf permission to use and distribute the software in accordance with the terms specified in this license.

ALL RIGHTS RESERVED Copyright 2011-2020 by: NewNet Communication Technologies, LLC. 2 Trap Falls Road Shelton, CT 06484 1-203-926-0049 www.newnet.com

CONTENTS

ABOUT THIS GUIDE

Guide Conventions .................................................................................................................. 21 Figures and Screen Captures............................................................................................. 21 Text ..................................................................................................................................... 21 Figures................................................................................................................................ 21 Notices................................................................................................................................ 22 Related Documentation............................................................................................................ 22 CEM Help System .............................................................................................................. 22 Contacting the Customer Service Department......................................................................... 23 Obtaining Technical Assistance .......................................................................................... 23 Support Website ................................................................................................................. 23 Warranty Support................................................................................................................ 23 ................................................................................................................................................. 23

INSTALLING

AND

USING CEM

PRODUCT OVERVIEW
Features................................................................................................................................... 27 Benefits .................................................................................................................................... 28 CEM Software Components..................................................................................................... 29 Graphical User Interface Basics .............................................................................................. 29 Menu Bar ............................................................................................................................ 30 Toolbar................................................................................................................................ 31 Left-hand Pane Views......................................................................................................... 31 Explorer View ................................................................................................................ 31 List View........................................................................................................................ 31 Map View ...................................................................................................................... 32 Logical View Folders ..................................................................................................... 32 Right-hand Pane Views ...................................................................................................... 32 Properties View ............................................................................................................. 32 Related View ................................................................................................................. 32 Root Folders ....................................................................................................................... 32 Pop-up Menus .................................................................................................................... 33 SNMP Devices ................................................................................................................... 34 Help Options ............................................................................................................................ 34 Help Menu .......................................................................................................................... 34 Tool Tips ............................................................................................................................. 35 Advisor Window.................................................................................................................. 35 Online Help......................................................................................................................... 37
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

Web Browser Interface ....................................................................................................... 37 Printing Options ....................................................................................................................... 38 CEM Event Processing ............................................................................................................ 38 Event Flow.......................................................................................................................... 39 CEM Core Events............................................................................................................... 40 Base Events.................................................................................................................. 40 Audit Events.................................................................................................................. 40 Security Events ............................................................................................................. 41 SNMP Trap Events ....................................................................................................... 41 syslog Events................................................................................................................ 41 Trap/syslog Source Identification ....................................................................................... 42 Alarm Events ...................................................................................................................... 42 Event Viewer ...................................................................................................................... 43 Alarm Counts GUI .............................................................................................................. 43 Clearing Traps/Events Automatically.................................................................................. 43 CEM Server Redundancy ........................................................................................................ 43 Selecting a Redundant Configuration................................................................................. 44 Shared Database .......................................................................................................... 44 Separate Databases ..................................................................................................... 45 Determining Perceived States ............................................................................................ 46 Determining Startup State .................................................................................................. 47 State Transitions................................................................................................................. 47 Failsafe Shutdown .............................................................................................................. 48 Redundancy Consistency Check ....................................................................................... 48 Startup and Shutdown Traps .............................................................................................. 48 Client Switchover................................................................................................................ 48

PRE-INSTALLATION
System Requirements.............................................................................................................. 49 Hardware Requirements .................................................................................................... 49 Network Interface Card Requirements.......................................................................... 50 Platform and Operating System Requirements .................................................................. 50 Platform Related Installation Issues......................................................................................... 52 Solaris ................................................................................................................................ 52 Running CEM in a Single User Environment ................................................................ 52 Running the CEM Server from Root Accounts ............................................................. 52 Setting User Read-Write Permissions .......................................................................... 52 Using Static IP Addresses............................................................................................. 53 Using the CEM GUI Client Without a Monitor ............................................................... 53 Using UNIX Filenames.................................................................................................. 53 Copying and Pasting Across Applications .................................................................... 53 Windows............................................................................................................................. 53 Using Windows Filenames............................................................................................ 53 HP-UX ................................................................................................................................ 53 Resolving Out of Memory Errors................................................................................... 54 Linux................................................................................................................................... 54
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Resolving Remote Client Login Problems..................................................................... 54 UNIX and Linux .................................................................................................................. 54 Installing from /.............................................................................................................. 54 Client-only Installations on UNIX................................................................................... 54 CEM Support for NewNet TC2000................................................................................ 55 Obtaining License Keys ........................................................................................................... 55 Ports Used by CEM.................................................................................................................. 55 Accessing the CEM Server through a Firewall ........................................................................ 56 HP OpenView Installation Issues ............................................................................................. 56 General Issues ................................................................................................................... 56 HP Openview 7.1 Issues .................................................................................................... 57

INSTALLATION AND INITIAL SETUP

Installing CEM Software Components ..................................................................................... 59 Silently Installing the CEM Server ...................................................................................... 61 Starting the CEM Server .......................................................................................................... 62 Using the Windows Shortcut .............................................................................................. 62 Using a Command Prompt ................................................................................................. 63 Installing a CEM Package ........................................................................................................ 64 Installing Multiple CEM Packages............................................................................................ 65 Configuring CEM Server for Multi-homed Support .................................................................. 66 Configuring CEM Server with a Static IP Address ................................................................... 67 Starting the CEM GUI Client .................................................................................................... 67 Using Windows Shortcut Options ....................................................................................... 67 Using a Command Prompt ................................................................................................. 69 Starting the CEM CLI Client ..................................................................................................... 71 Database Configuration Options .............................................................................................. 72

PROVISIONING
Customizing the GUI Client Environment ................................................................................ 74 Provisioning Background Job Display...................................................................................... 80 Displaying Jobs Individually................................................................................................ 80 Displaying Jobs using the Job Status Window ................................................................... 81 Provisioning the Printer Page Setup ........................................................................................ 82 Provisioning Users ................................................................................................................... 83 Creating Logical Views ....................................................................................................... 83 Creating User Folders ........................................................................................................ 86 Creating New Users ........................................................................................................... 86 Assigning a Root View to a User ........................................................................................ 87 Exporting and Importing Users ........................................................................................... 89 Exporting Users............................................................................................................. 89 Importing CEM Users.................................................................................................... 89 Setting a Login Expiration Date and Time .......................................................................... 90 Provisioning SNMP Devices .................................................................................................... 91 Creating Device Folders ..................................................................................................... 91
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

Creating Equipment Bays and Racks................................................................................. 92 Discovering Multiple SNMP Devices .................................................................................. 93 Discovering Single SNMP Devices .................................................................................... 98 Viewing SNMP Device Identification ................................................................................ 104 Provisioning Read and Write Community Strings............................................................. 105 Common SNMP Device Configuration ............................................................................. 105 Exporting and Importing SNMP Devices .......................................................................... 105 Exporting SNMP Devices............................................................................................ 105 Importing SNMP Devices............................................................................................ 106 Provisioning Map/Topology Views ......................................................................................... 107 Map View.......................................................................................................................... 107 Map View Components ............................................................................................... 108 Selecting Map Elements ............................................................................................. 109 Map Background Popup Menu ................................................................................... 110 Navigating Folders ...................................................................................................... 110 Selecting a Specific Map..............................................................................................111 Moving Map Elements .................................................................................................111 Setting a Map Background Image................................................................................111 Clearing the Background Image ................................................................................. 113 Working with Static Connections ...................................................................................... 113 Considerations in Establishing Static Connections ..................................................... 114 Establishing Static Connections.................................................................................. 114 Viewing Static Connections in Explorer View.............................................................. 115 Viewing Static Connections in Map View .................................................................... 115 Provisioning Table Data Loading ........................................................................................... 116 Provisioning the Logical Log Size and Log Full Action .......................................................... 117 Viewing the Current Logical Log Settings......................................................................... 117 Provisioning the Logical Log Size and Log Full Action..................................................... 118 Provisioning How Often CEM Polls for Operational State...................................................... 119 Modifying Server Properties .................................................................................................. 120 Embedded and External Database Options........................................................................... 121 Embedded Databases...................................................................................................... 121 Features and Benefits................................................................................................. 121 Limitations................................................................................................................... 122 Provisioning Embedded Databases............................................................................ 122 Maintenance Options .................................................................................................. 123 External Databases .......................................................................................................... 123 Features and Benefits................................................................................................. 123 Deploying on a CEM Server ....................................................................................... 124 Deploying on a Dedicated Server ............................................................................... 124 Provisioning Oracle External Databases .................................................................... 124 Provisioning MySQL External Databases ................................................................... 126 Running Multiple External Databases on a Single Database Server .......................... 128 Multiple User Access for External Databases............................................................. 128 External Database Tools and Options......................................................................... 128 Provisioning CEM Server Redundancy.................................................................................. 128 Verifying CEM Core and Package Version Compatibility ................................................. 129
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Configuring the Redundancy Properties........................................................................... 129 Synchronizing Files .......................................................................................................... 130 Performing a Manual Switchover...................................................................................... 131 HP OpenView Integration....................................................................................................... 131 Manually Integrating HP OpenView.................................................................................. 131 Provisioning HP OpenView to Collect SNMP Traps ......................................................... 132 Provisioning SNMP Trap Forwarding..................................................................................... 132 Provisioning Memory and Disk Size for Different Network Sizes........................................... 133 Allocating Memory for Server and Clients ........................................................................ 133 Example............................................................................................................................ 134 Provisioning the Display of Non-supported MIB Objects in the CEM GUI ............................. 134 Provisioning the Default Refresh Rate for the GUI Client ...................................................... 134 Provisioning the Default Maximum PDU Size for SNMP Device Discovery........................... 135 Provisioning the Maximum PDU Size for SNMP Devices ...................................................... 136 Provisioning Default TCP/IP and UDP Ports Used By CEM .................................................. 136 Provisioning a Syslog Client .................................................................................................. 138

OPERATIONS
Viewing Software Version and Copyright Information ............................................................ 140 Viewing GUI and Client Information ....................................................................................... 141 Toggling between the Explorer and List View ........................................................................ 142 Toggling between the Properties and Related View............................................................... 144 Expanding and Collapsing Elements ..................................................................................... 145 Using the Tree Menu Option............................................................................................. 146 Using the Toolbar.............................................................................................................. 146 Using Standard Double-clicking........................................................................................ 146 Executing Commands for Multiple Elements ......................................................................... 146 Organizing Elements.............................................................................................................. 147 Monitoring the Status of GUI Elements .................................................................................. 148 Viewing the Status ............................................................................................................ 148 Using the State Tab ..................................................................................................... 148 Using the State Icon .................................................................................................... 149 Using the Web Browser Interface ............................................................................... 149 Using the Monitor State Utility ..................................................................................... 151 Refreshing the Status ....................................................................................................... 153 Broadcasting Messages to Users .......................................................................................... 154 Sending a Message to One User ..................................................................................... 154 Sending a Message to Multiple Users .............................................................................. 155 Viewing Virtual Panel Displays............................................................................................... 155 Using the MIB Browser .......................................................................................................... 157 Starting the MIB Browser.................................................................................................. 157 Getting and Setting MIB Values........................................................................................ 158 Viewing Numeric Values in Alternative Formats .................................................................... 159 Monitoring Properties............................................................................................................. 161 Setting the Poll Rate......................................................................................................... 162 Monitoring Additional Attributes........................................................................................ 163
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

Changing the Scope......................................................................................................... 163 Using CEM to Edit Network Device Properties ...................................................................... 164 Editing Simple Properties ................................................................................................. 165 Editing Tabular Properties ................................................................................................ 166 Copying and Pasting Values between Elements ................................................................... 168 Locating Information Using the Find Command..................................................................... 169 Locating Information in MIB Tables Using the Find Button .................................................... 171 Creating Inventory Reports .................................................................................................... 172 Opening a Telnet Session ...................................................................................................... 173 Accessing the Web Browser Interface ................................................................................... 174 Viewing the Daily Audit Log ................................................................................................... 175 Using the Web Browser Interface..................................................................................... 175 Using the CEM GUI Main Menu ....................................................................................... 176 Using the Log Directory.................................................................................................... 177 Viewing FTP Logs.................................................................................................................. 177 Using the Web Browser Interface..................................................................................... 177 Using the CEM GUI Main Menu ....................................................................................... 177 Using the Log Directory.................................................................................................... 179 Viewing Server Console Logs................................................................................................ 179 Using the Web Browser Interface..................................................................................... 179 Using the CEM GUI Main Menu ....................................................................................... 179 Using the Log Directory.................................................................................................... 181 Printing the CEM GUI Explorer Tree...................................................................................... 181 Starting and Stopping CEM Software Components ............................................................... 181 Starting the CEM Server................................................................................................... 181 Starting the CEM Server as a Daemon ............................................................................ 181 Starting the Server as a UNIX Background Process................................................... 182 Starting the Server as a Windows 2000 Background Process.................................... 182 Stopping the CEM Server................................................................................................. 183 Starting the CEM GUI Client............................................................................................. 184 Starting the CEM GUI Client Using HP OpenView ........................................................... 184 Stopping the CEM GUI Client........................................................................................... 184 Starting the CEM CLI Client ............................................................................................. 184 Stopping the CEM CLI Client............................................................................................ 184 Using the Server Monitor to Monitor CEM Server Performance ............................................ 185 Monitoring CEM Server Memory............................................................................................ 186 Monitoring CEM GUI Memory................................................................................................ 187 Displaying Server Console Commands ................................................................................. 187 Displaying CEM CLI Client Console Commands ................................................................... 188 Logging in as Another User ................................................................................................... 188

MAINTENANCE
Reserving and Unreserving Elements ................................................................................... 190 Reserving an Element ...................................................................................................... 190 Unreserving an Element................................................................................................... 190 Renaming Elements............................................................................................................... 190
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Resetting User Passwords..................................................................................................... 191 Changing User Access Rights ............................................................................................... 192 Removing an Assigned Root View......................................................................................... 193 Forcing a Logout .................................................................................................................... 193 From the CEM GUI........................................................................................................... 193 From the Command Line.................................................................................................. 193 Deleting a User ...................................................................................................................... 194 Deleting a Logical View.......................................................................................................... 194 Deleting SNMP Devices and Folders..................................................................................... 194 Rediscovering an SNMP Device ............................................................................................ 195 Changing the SNMP Version ................................................................................................. 196 Managing Logical Logs .......................................................................................................... 196 Purging Log Events .......................................................................................................... 197 Automatically Purging Event Records......................................................................... 198 Manually Purging Event Records................................................................................ 198 Monitoring the Availability of Logical Logs........................................................................ 199 Clearing All Event Records............................................................................................... 199 Stopping Event Logging.................................................................................................... 199 Restarting Event Logging ................................................................................................. 200 Using the Event and Alarm Viewer ........................................................................................ 200 Launching the Event Viewer............................................................................................. 200 Viewing Log Events .......................................................................................................... 201 Sorting Log Events ........................................................................................................... 201 Selecting Multiple Log Events .......................................................................................... 202 Customizing the Event Viewer Window ............................................................................ 202 Configuring Event Logging and Forwarding Filtering ....................................................... 204 Configuring Event Severity ............................................................................................... 206 Exporting Current Events ................................................................................................. 207 Refreshing Log Events ..................................................................................................... 207 Acknowledging Log Events .............................................................................................. 208 Deleting Log Events ......................................................................................................... 209 Uninstalling CEM Components .............................................................................................. 209 Using Windows Shortcut Options ..................................................................................... 209 Using a Command Prompt ............................................................................................... 211 Uninstalling CEM Packages........................................................................................ 211 Uninstalling the CEM Core.......................................................................................... 212 Relicensing the CEM Server.................................................................................................. 213 Upgrading CEM ..................................................................................................................... 214 Upgrading from Non-NewNet CEM........................................................................................ 215 Upgrading Redundant CEM Servers ..................................................................................... 217 Importing SDL Files for Device Upgrades.............................................................................. 218 Removing HP OpenView Integration ..................................................................................... 218 Compacting Embedded Databases on Server Startup .......................................................... 219 Manually Compacting Databases ..................................................................................... 219 Automatically Compacting Databases .............................................................................. 219

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

10

TROUBLE LOCATING AND CLEARING

Recovering from Power Failures............................................................................................ 221 Encountering an Unsupported SNMP Device........................................................................ 222 Using the Refresh Button....................................................................................................... 223 Known Issues ........................................................................................................................ 223 Installation Issues ............................................................................................................. 223 Provisioning Issues .......................................................................................................... 224 Operation Issues .............................................................................................................. 224

USING CEM VALUE-ADDED PACKAGES

PERFORMANCE AND CAPACITY MANAGER
PCM Overview ....................................................................................................................... 229 Installing PCM........................................................................................................................ 230 Working with PCM Data Collection ........................................................................................ 231 Adding a Data Collection Folder....................................................................................... 232 Adding a Data Collector ................................................................................................... 233 Adding a Scheduled Event Data Collector.................................................................. 233 Adding a Specific Field Data Collector........................................................................ 233 Labeling a Data Collector ................................................................................................. 235 Selecting Data Collector Targets ...................................................................................... 235 Specifying Data Collection Filters..................................................................................... 236 Indicating Trigger and Clear Levels.................................................................................. 236 Threshold Logs................................................................................................................. 238 Specifying Start and Stop Times....................................................................................... 238 Viewing Data Collector Information .................................................................................. 241 Filter Tab ..................................................................................................................... 241 Identification Tab ......................................................................................................... 242 Schedule Tab .............................................................................................................. 243 State Tab ..................................................................................................................... 244 Threshold Tab ............................................................................................................. 245 Viewing Historical Data..................................................................................................... 246 Forecasting....................................................................................................................... 249 Exporting Data to CSV ..................................................................................................... 249 Exporting Data to TSV...................................................................................................... 250 Exported Data .................................................................................................................. 252 Establishing Purge Policies .............................................................................................. 252 Purge Data on Demand .............................................................................................. 254 Forcing Data Collection............................................................................................... 254 Enabling and Disabling Data Collectors ........................................................................... 255 Editing Data Collector Settings......................................................................................... 256 Resetting Counters........................................................................................................... 257 Deleting Data Collectors................................................................................................... 257 Working with Scheduled Reports........................................................................................... 257 Scheduled Report Overview............................................................................................. 257
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

11

Scheduled Report Format ........................................................................................... 258 Scheduled Report Section Style.................................................................................. 258 Scheduled Report Metrics........................................................................................... 259 Scheduled Report Procedures ......................................................................................... 260 Creating a Scheduled Report Folder........................................................................... 260 Creating a Scheduled Report...................................................................................... 261 Adding a Section to a Scheduled Report .................................................................... 262 Editing a Scheduled Report ........................................................................................ 265 Deleting a Scheduled Report ...................................................................................... 265 Generating a Scheduled Report On Demand ............................................................. 265 Customizing the Scheduled Report Logo.................................................................... 266

ADVANCED CONFIGURATION MANAGER

ACM Overview ....................................................................................................................... 267 About Configuration Templates ........................................................................................ 268 Template Creation ....................................................................................................... 268 Template Assignment.................................................................................................. 269 Template Application ................................................................................................... 270 Template Import and Export ........................................................................................ 270 Template Audit Reports............................................................................................... 270 Installing ACM ........................................................................................................................ 271 ACM Procedures.................................................................................................................... 271 Creating a Configuration Template ................................................................................... 272 Assigning a Configuration Template ................................................................................. 272 Applying a Configuration Template................................................................................... 272 Exporting a Configuration Template ................................................................................. 273 Importing a Configuration Template.................................................................................. 273 Editing a Configuration Template...................................................................................... 273 Deleting a Configuration Template ................................................................................... 274 Generating a Configuration Template Audit Report.......................................................... 274 Generating a Configuration Template Audit Report On-Demand................................ 274 Generating a Scheduled Configuration Template Audit Report .................................. 275

DEVICE LEARNING WIZARD

Device Learning Wizard Overview......................................................................................... 277 Example............................................................................................................................ 277 Device Learning Wizard: Process Summary .................................................................... 278 Additional Process Information ................................................................................... 278 Installing the Device Learning Wizard.................................................................................... 280 Device Learning Wizard Procedures ..................................................................................... 280 Learning a New Device .................................................................................................... 280 Importing MIB Files........................................................................................................... 281

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

12

CDR SERVER
CDR Server Overview............................................................................................................ 283 Retained and Merged CDR Information ........................................................................... 283 CDR Server Tools............................................................................................................. 284 CDR Query ................................................................................................................. 284 CDR Plot ..................................................................................................................... 284 CDR Watch ................................................................................................................. 285 CDR Analysis Report .................................................................................................. 285 CDR Purge.................................................................................................................. 286 CDR Export................................................................................................................. 287 Installing CDR Server ............................................................................................................ 287 Configuring CDR Server ........................................................................................................ 288 Configuring the override.properties File ........................................................................... 288 Provisioning the NAS Secret ............................................................................................ 289 Configuring Attribute Retention ........................................................................................ 289 Provisioning Filters .......................................................................................................... 292 Configuring the RADIUS Client ........................................................................................ 293 Managing CDR Server........................................................................................................... 294 Statistics Tab .................................................................................................................... 294 Purge Policy Tab .............................................................................................................. 295 Configuration Tab ............................................................................................................. 296 CDR Server Procedures ........................................................................................................ 296 Performing a CDR Server Query...................................................................................... 296 Plotting a CDR.................................................................................................................. 297 Performing a CDR Watch ................................................................................................. 299 Purging CDRs .................................................................................................................. 300 Exporting CDRs................................................................................................................ 300 Creating a Scheduled CDR Analysis Report.................................................................... 301

CEM NOTIFICATIONS
CEM Notifications Overview .................................................................................................. 303 CEM Notification Creation ................................................................................................ 303 Notification Methods......................................................................................................... 303 Email Templates.......................................................................................................... 304 Provisioning Event Sounds ......................................................................................... 306 Viewing CEM Notification Properties and Relationships .................................................. 307 Properties.................................................................................................................... 307 Relationships .............................................................................................................. 307 Installing CEM Notifications ................................................................................................... 308 CEM Notification Procedures................................................................................................. 309 Creating a CEM Notification ............................................................................................. 309 Editing a CEM Notification................................................................................................ 314 Deleting a Notification ...................................................................................................... 314

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

13

PERFORMANCE MONITOR
Performance Monitor Overview ............................................................................................. 315 About Performance Profiles.............................................................................................. 315 Performance Profile Creation...................................................................................... 315 Performance Profile Management .............................................................................. 316 Installing Performance Monitor .............................................................................................. 316 Performance Monitor Procedures .......................................................................................... 317 Creating a Performance Monitor Profile ........................................................................... 317 Launching a Performance Monitor Profile ........................................................................ 320 Adding a Gauge to a Performance Monitor Profile........................................................... 320 Exporting a Performance Monitor Profile.......................................................................... 321 Importing a Performance Monitor Profile.......................................................................... 321 Editing a Performance Monitor Profile.............................................................................. 322

APPENDICES
COMMAND LINE INTERFACE REFERENCE
CEM Server Console ............................................................................................................. 325 Using Daemon-specific Server Console Commands ....................................................... 326 CEM CLI Client Console ........................................................................................................ 327

SNMP DEVICE COMMON CONFIGURATION TABS

Navigating to the Common Configuration Tabs for an SNMP Device .................................... 330 Addressing Information Tab ................................................................................................... 330 Address Translation Tab ........................................................................................................ 331 Conn Table Tab ...................................................................................................................... 332 ICMP Tab ............................................................................................................................... 333 Interfaces Tab ........................................................................................................................ 334 IP Tab..................................................................................................................................... 336 NetToMedia Table Tab ........................................................................................................... 338 Routes Tab............................................................................................................................. 339 SNMP Tab.............................................................................................................................. 341 SNMP Options Tab ................................................................................................................ 343 SNMP Statistics Tab............................................................................................................... 345 System Tab ............................................................................................................................ 345 TCP Tab ................................................................................................................................. 346 TFTP Options Tab .................................................................................................................. 347 UDP Tab................................................................................................................................. 348

INDEX

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

14

LIST OF TABLES
Table 1 Table 2 Table 3 Table 4 Table 5 Table 6 Table 7 Table 8 Table 9 Table 10 Table 11 Table 12 Table 13 Table 14 Table 15 Table 16 Table 17 Table 18 Table 19 Table 20 Table 21 Table 22 Table 23 Table 24 Table 25 Table 26 Table 27 Table 28 Table 29 Table 30 Table 31 Table 32 Table 33 Table 34 Table 35 Table 36 Table 37 Table 38 Table 39 Table 40 Table 41 Table 42 Table 43 Table 44 Table 45 Table 46 Table 47 Table 48 Table 49 Table 50 Table 51 Table 52
Common Element Manager User Guide

Text Convention Descriptions .................................................................................21 Notice Icon Descriptions..........................................................................................22 Standard Audit Events.............................................................................................40 Standard Security Events........................................................................................41 Syslog Severity and ID Mapping .............................................................................42 CEM State Transitions ............................................................................................47 Minimum Hardware Requirements for CEM............................................................49 Platform and Operating System Requirements for CEM.........................................50 Default TCP/IP and UDP Ports Used by CEM ........................................................55 TCP Ports for CEM Servers Behind Firewalls .........................................................56 Common Element Manager Installation Options .....................................................61 Server Login Optional Properties ............................................................................63 GUI Login Optional Parameters ..............................................................................70 CLI Client Startup Optional Parameters ..................................................................71 Monitor State Types ................................................................................................77 New User Information..............................................................................................87 Discovery Parameters .............................................................................................94 Additional Discovery Parameters for SNMPv3 with No Authentication ...................95 Additional Parameters for SNMPv3, Authentication and No Encryption .................96 Discovery Parameters .............................................................................................99 Additional Discovery Parameters for SNMPv3 with No Authentication .................100 Additional Parameters for SNMPv3, Authentication and No Encryption ...............101 Identification Tab Values .......................................................................................104 Map View Components .........................................................................................109 Connection Line Color Code .................................................................................116 Oracle Server Section of the server.properties File ..............................................125 MySQL DB Section of the server.properties File...................................................127 SNMP.forward Parameters ...................................................................................133 Default TCP/IP and UDP Ports Used by CEM ......................................................137 Syslog Client Parameters ......................................................................................138 State Types for Elements ......................................................................................148 Element Status Color Indications ..........................................................................149 Background Color Indications ...............................................................................157 Optional Parameters for the Server Monitor..........................................................185 Availability Status for Logical Logs ........................................................................199 Event Viewer Details .............................................................................................203 Windows Registry Additions for TCP/IP Connection Timeout Period....................224 Filter Tab ...............................................................................................................242 Identification Tab ...................................................................................................242 Schedule Tab ........................................................................................................243 State Tab...............................................................................................................245 Threshold Tab .......................................................................................................246 Purge Policy Tab ...................................................................................................253 Historical Performance Report Section Wizard Report Type Entries ....................263 RADIUS/CDR Server Property Settings ................................................................288 Filter Specification String Patterns ........................................................................293 CDR Server Statistics Tab Field Descriptions .......................................................294 CDR Server Purge Policy Tab Field Descriptions .................................................295 CDR Data Query Entries .......................................................................................297 CDR Details Analysis Dialog Box Field Descriptions ............................................298 CDR Data Export Entries ......................................................................................301 Default Email Notification Event Properties...........................................................305
Part Number D4000-006 Rev A1 January 2011

15

Table 53 Table 54 Table 55 Table 56 Table 57 Table 58 Table 59 Table 60 Table 61 Table 62 Table 63 Table 64 Table 65 Table 66 Table 67 Table 68 Table 69 Table 70 Table 71 Table 72 Table 73

Examples for Sending to Email Notifications to Cell Phones or Pagers ............... 305 Gauge Properties Entries ..................................................................................... 318 Server Console Commands ................................................................................. 325 CLI Client Commands Used to Control CEM Server............................................ 326 CEM CLI Client Commands ................................................................................. 327 Addressing Information Tab Values ..................................................................... 331 Address Translation Tab Values .......................................................................... 331 Conn Table Tab Values........................................................................................ 332 ICMP Tab Values ................................................................................................. 333 Interfaces Tab Value ............................................................................................ 334 IP Tab Values ....................................................................................................... 336 NetToMedia Table Tab Values............................................................................. 339 Routes Add Row to Table Dialog Box Values ...................................................... 340 Routes Tab Self-Generated Values...................................................................... 341 SNMP Tab Values ................................................................................................ 341 SNMP Options Tab Values................................................................................... 344 SNMP Statistics Tab Values................................................................................. 345 System Tab Values .............................................................................................. 346 TCP Tab Values ................................................................................................... 346 TFTP Options Tab Values .................................................................................... 347 UDP Tab Values................................................................................................... 348

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

16

LIST OF FIGURES
Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Figure 11 Figure 12 Figure 13 Figure 14 Figure 15 Figure 16 Figure 17 Figure 18 Figure 19 Figure 20 Figure 21 Figure 22 Figure 23 Figure 24 Figure 25 Figure 26 Figure 27 Figure 28 Figure 29 Figure 30 Figure 31 Figure 32 Figure 33 Figure 34 Figure 35 Figure 36 Figure 37 Figure 38 Figure 39 Figure 40 Figure 41 Figure 42 Figure 43 Figure 44 Figure 45 Figure 46 Figure 47 Figure 48 Figure 49 Figure 50 Figure 51 Figure 52
Common Element Manager User Guide

Left and Right Panes of the CEM GUI Main Window ........................................... 30 Menu Bar Options ................................................................................................ 30 Toolbar Commands .............................................................................................. 31 Example Pop-up Menu ......................................................................................... 33 Example Tool Tip ................................................................................................. 35 Locating the Advisor Button ................................................................................. 36 Advisor Window .................................................................................................... 36 Web Browser Access Window ............................................................................. 37 Event Flow ............................................................................................................ 39 Alarm Counts GUI ................................................................................................ 43 Active and Standby CEM Servers Sharing a Common Database ........................ 45 Active and Standby CEM Servers using Synchronized Databases ..................... 46 Perceived State Change Message Examples ...................................................... 46 Heartbeat Loss Message Examples ..................................................................... 47 CEM Client Switchover Message ......................................................................... 48 Installation Options for Common Element Manager ............................................. 61 CEM Server Shortcut Icon .................................................................................... 62 CEM GUI Client Shortcut Icon .............................................................................. 67 Login Dialog Box .................................................................................................. 68 CEM GUI Main Window ....................................................................................... 69 Preferences Tab ................................................................................................... 74 State ICONs tab ................................................................................................... 76 State ICON to Show in Tree View ........................................................................ 76 Changing a State Color ........................................................................................ 77 State Color Palette ............................................................................................... 78 Event Options tab ................................................................................................. 79 Multiple Jobs Displayed in Individual Windows .................................................... 80 Multiple Jobs Displayed in a Single Job Status Window ...................................... 81 Page Setup Dialog Box ........................................................................................ 82 New Dialog Box .................................................................................................... 84 Select Tree Nodes Dialog Box ............................................................................. 84 Assigning a Device Folder as a Logical View ....................................................... 85 New Logical View Folder ...................................................................................... 85 New Dialog Box .................................................................................................... 86 New User in Users Dialog Box ............................................................................. 86 Assigning a Root View to a User .......................................................................... 88 Exporting Users .................................................................................................... 89 Importing Users .................................................................................................... 90 New Dialog Box .................................................................................................... 91 Bays and Racks in CEM ....................................................................................... 92 Selecting an Equipment Folder ............................................................................ 92 New Dialog Box .................................................................................................... 93 Discovery Dialog Box for SNMP Devices ............................................................. 94 Dialog Box for SNMPv3 with No Authentication ................................................... 95 Dialog Box for SNMPv3 with Authentication and No Encryption .......................... 96 Dialog Box for SNMPv3 with Authentication and Encryption ............................... 97 Device Discovery Progress Dialog Box ................................................................ 97 Device Discovery Summary Dialog Box ............................................................... 98 New Device Dialog Box ........................................................................................ 99 Dialog Box for SNMPv3 with No Authentication ................................................. 100 Dialog Box for SNMPv3 with Authentication and No Encryption ........................ 101 Dialog Box for SNMPv3 with Authentication and Encryption ............................. 102
Part Number D4000-006 Rev A1 January 2011

17

Figure 53 Device Discovery Progress Dialog Box .............................................................. 103 Figure 54 Device Discovery Summary Dialog Box ............................................................. 103 Figure 55 SNMP Device Selection ..................................................................................... 104 Figure 56 Exporting Equipment .......................................................................................... 106 Figure 57 Map Tab ............................................................................................................. 107 Figure 58 Equipment Folder to Map View Relationship ...................................................... 107 Figure 59 Map View Components ...................................................................................... 108 Figure 60 Map Element Popup Menu ................................................................................. 109 Figure 61 Overall Map Popup Menu ................................................................................... 110 Figure 62 Map Selection ..................................................................................................... 111 Figure 63 Standard File Selection Dialog Box .................................................................... 112 Figure 64 Map Background ................................................................................................ 113 Figure 65 Select Tree Nodes Window ................................................................................ 114 Figure 66 Static Connection To or From an Element ......................................................... 115 Figure 67 Static Connections Viewed on the Map .............................................................. 115 Figure 68 Logical Log Configuration Tab ............................................................................ 117 Figure 69 SNMP Trap Log Purge Policy ............................................................................. 118 Figure 70 CEM Root Node Configuration Tab. ................................................................... 119 Figure 71 Embedded Databases ........................................................................................ 122 Figure 72 External Databases ............................................................................................ 123 Figure 73 Uncommenting the SNMP.forward Line ............................................................. 133 Figure 74 Uncommenting the showNoSuchName Line ...................................................... 134 Figure 75 Uncommenting the mimic.refresh Line ............................................................... 135 Figure 76 Uncommenting the SNMP.maxpdu Line ............................................................ 135 Figure 77 SNMP Options Tab ............................................................................................. 136 Figure 78 Uncommenting the HTTP.port Line .................................................................... 138 Figure 79 Uncommenting the syslog.client.host Line ......................................................... 138 Figure 80 Viewing the CEM Software Version .................................................................... 140 Figure 81 Viewing Copyright Information ............................................................................ 141 Figure 82 List Tab ............................................................................................................... 142 Figure 83 Target Filter Selection Window ........................................................................... 143 Figure 84 Selecting an Element in the List View ................................................................ 144 Figure 85 Related Tab ........................................................................................................ 145 Figure 86 Expanding and Collapsing Elements .................................................................. 145 Figure 87 Select a Tree Node Dialog Box .......................................................................... 147 Figure 88 Web Browser Access Window ............................................................................ 150 Figure 89 Viewing User States Using the Web Browser Interface ..................................... 151 Figure 90 Accessing the Monitor State Utility ..................................................................... 152 Figure 91 Class Selection Filter Window ............................................................................ 153 Figure 92 CEM Chat Window ............................................................................................. 154 Figure 93 Send Message Dialog Box ................................................................................. 155 Figure 94 Device Visual Button .......................................................................................... 155 Figure 95 Total Control 1000 Chassis Device Visual ......................................................... 156 Figure 96 Total Control 2000 Chassis Card Type Device Visual ........................................ 156 Figure 97 Browse MIB Selection ........................................................................................ 158 Figure 98 MIB browser ....................................................................................................... 159 Figure 99 Displaying an Alternate Data Format .................................................................. 160 Figure 100 Displaying All of the Data Formats for a Numeric Property ............................... 160 Figure 101 Property Monitor - Table View ........................................................................... 161 Figure 102 Property Monitor - Graph View .......................................................................... 162 Figure 103 Polling Rate Dialog Box ..................................................................................... 162 Figure 104 Property Monitor Attributes ................................................................................ 163 Figure 105 Property Monitor Scope ..................................................................................... 164 Figure 106 Editing a Property .............................................................................................. 165 Figure 107 Editing Simple Properties .................................................................................. 166
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

18

Figure 108 Selecting Simple Properties .............................................................................. 166 Figure 109 Tabular Properties ............................................................................................. 167 Figure 110 SNMP Values to Change Dialog Box ................................................................ 168 Figure 111 Find Window ...................................................................................................... 169 Figure 112 Explorer Tree Window ....................................................................................... 170 Figure 113 Sample Search Using the Find Command ........................................................ 170 Figure 114 Finding a Row in a Table ................................................................................... 171 Figure 115 Inventory Report ................................................................................................ 172 Figure 116 CEM Telnet Target Dialog Box .......................................................................... 173 Figure 117 CEM Telnet Session with SSH .......................................................................... 173 Figure 118 Web Browser Access Window .......................................................................... 174 Figure 119 Log Files Window .............................................................................................. 176 Figure 120 Sample Daily Audit Log File .............................................................................. 176 Figure 121 Log Files Window .............................................................................................. 177 Figure 122 FTP Files Page .................................................................................................. 178 Figure 123 Sample FTP Log File ......................................................................................... 178 Figure 124 Log Files Window .............................................................................................. 180 Figure 125 Sample Server Console Log File ....................................................................... 180 Figure 126 Stopping the CEM GUI Client ............................................................................ 184 Figure 127 CEM Server Monitor Window ............................................................................ 185 Figure 128 Memory Tab on the CEM Server Monitor .......................................................... 186 Figure 129 GUIClient Memory Monitor ................................................................................ 187 Figure 130 CEM Server Console Commands ..................................................................... 188 Figure 131 Reserving Elements .......................................................................................... 190 Figure 132 Rename Dialog Box .......................................................................................... 190 Figure 133 Password Change Dialog Box ........................................................................... 191 Figure 134 Operation Complete Dialog Box ........................................................................ 191 Figure 135 Changing User Access Rights ........................................................................... 192 Figure 136 Rediscovering an SNMP Device ....................................................................... 195 Figure 137 Rediscover Finished Window ............................................................................ 195 Figure 138 Logical Logs ...................................................................................................... 197 Figure 139 SNMP Trap Log Purge Policy ........................................................................... 198 Figure 140 Log Events Window ........................................................................................... 201 Figure 141 Options Window for Log Events ........................................................................ 202 Figure 142 CEM Server Configuration Window ................................................................... 205 Figure 143 Options Window - Export Events ....................................................................... 207 Figure 144 Log Events Window ........................................................................................... 208 Figure 145 Acknowledgement of Events ............................................................................. 209 Figure 146 Selecting Components to Uninstall ................................................................... 210 Figure 147 Selecting Components to Uninstall ................................................................... 213 Figure 148 Importing SDL Files ........................................................................................... 218 Figure 149 Checking the Database Size ............................................................................. 220 Figure 150 Uncommenting the compactOnStartup Line ..................................................... 220 Figure 151 Unsupported SNMP Device .............................................................................. 222 Figure 152 PCM (Scheduled Events and Scheduled Reports) Icon .................................... 230 Figure 153 Data Collectors Folder ....................................................................................... 232 Figure 154 New Data Collector Folder Window .................................................................. 232 Figure 155 Adding a New Data Collector for a Specific Field .............................................. 234 Figure 156 New Data Collector Created Window ................................................................ 234 Figure 157 Data Collector Targets ...................................................................................... 235 Figure 158 Data Collection Filters ....................................................................................... 236 Figure 159 Attributes to Collect Window ............................................................................. 237 Figure 160 Trigger and Clear Values Crossed .................................................................... 238 Figure 161 Schedule Start Time Window ............................................................................ 239 Figure 162 Schedule Interval Window ................................................................................. 239
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

19

Figure 163 Schedule Repeat Until Time Window ................................................................ 240 Figure 164 Enable Data Collector Window .......................................................................... 240 Figure 165 Filter Tab ........................................................................................................... 241 Figure 166 Identification Tab ............................................................................................... 242 Figure 167 Schedule Tab .................................................................................................... 243 Figure 168 State Tab ........................................................................................................... 245 Figure 169 Threshold Tab ................................................................................................... 246 Figure 170 No Historical Data Window ................................................................................ 247 Figure 171 Historical Data Window ..................................................................................... 247 Figure 172 Choose Starting Date Window .......................................................................... 248 Figure 173 Choose Ending Date Window ............................................................................ 248 Figure 174 Save Graph Data Window ................................................................................. 250 Figure 175 Exporting Data to TSV ....................................................................................... 250 Figure 176 Historical Data Export Window .......................................................................... 251 Figure 177 Exporting Data File Sample Opened with MS Excel ......................................... 252 Figure 178 Purge Policy Tab ............................................................................................... 253 Figure 179 Purge Now Window ........................................................................................... 254 Figure 180 Collect Now Window .......................................................................................... 255 Figure 181 Enable Data Collector ........................................................................................ 256 Figure 182 Data Collector Update Window ......................................................................... 256 Figure 183 Verification Dialog Box ...................................................................................... 257 Figure 184 Sample Scheduled Report: Graphical Format ................................................... 259 Figure 185 Sample Scheduled Report: Tabular Format ...................................................... 260 Figure 186 Scheduled Report Wizard Report Type Screen ................................................ 261 Figure 187 Advanced Configuration Manager Icon ............................................................. 271 Figure 188 Sample Configuration Audit Report ................................................................... 276 Figure 189 Accessing the Device Learning Wizard ............................................................. 280 Figure 190 Example of Device Added with Device Learning Wizard ................................... 281 Figure 191 CDR Analysis Report Sample Output - Call Duration by Domain ..................... 285 Figure 192 CDR Analysis Report Sample Output - Busy Hour Analysis by Domain ........... 286 Figure 193 CDR Analysis Report Sample Output - Data Throughput by Domain ............... 286 Figure 194 CDR Server Icon ............................................................................................... 287 Figure 195 CDR Server Statistics Tab ................................................................................. 294 Figure 196 CDR Server Purge Policy Tab ........................................................................... 295 Figure 197 CDR Server Configuration Tab .......................................................................... 296 Figure 198 CDR Data Query Dialog Box: Sample Output ................................................... 297 Figure 199 CDR Server Plot Dialog Box: Sample Output .................................................... 299 Figure 200 CDR RADIUS Watch Dialog Box: Sample Output ............................................. 300 Figure 201 CDR Data Export Dialog Box ............................................................................ 301 Figure 202 CEM Popup Notification Examples .................................................................... 304 Figure 203 Event Options Tab ............................................................................................. 306 Figure 204 CEM Notifications Properties Tab ..................................................................... 307 Figure 205 Monitor Events from Tab ................................................................................... 307 Figure 206 Sent to Tab ........................................................................................................ 308 Figure 207 CEM Notifications Icon ...................................................................................... 308 Figure 208 CEN Notifications Wizard Select Event Dialog Box: Selecting Event Category 310 Figure 209 CEM Notifications WIzard Select Event Dialog Box: Selecting attributeChange 311 Figure 210 CEM Notifications Wizard Select Event Category: Selecting an Event with No Options 312 Figure 211 CEM Notifications Wizard Select Scope Dialog Box ......................................... 313 Figure 212 Performance Profile with Multiple Gauges ........................................................ 316 Figure 213 Accessing the Performance Monitor .................................................................. 317 Figure 214 Gauge Properties Dialog Box ............................................................................ 318 Figure 215 Adding a Performance Bar Gauge to a Profile .................................................. 320 Figure 216 Configuration Tabs for an SNMP Device ........................................................... 330
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

20

Figure 217 Routes Add Row to Table Dialog Box ............................................................... 339

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

ABOUT THIS GUIDE

This chapter contains an overview of NewNet common element manager (CEM), lists guide conventions, provides related documentation, and provides information for contacting customer service and technical documentation. This guide describes how to use CEM effectively, and it provides detail on the functionality of the software. It also describes how to install, provision, operate, and maintain the CEM software components. This guide is intended for network administrators with some training or experience working in a data center using NewNet equipment. Prior experience with NewNet equipment is helpful but not required.

Guide Conventions

This guide may contain notices, figures, screen captures, and certain text conventions. This guide provides figures and screen captures as examples. These examples contain sample data. This data may vary from the actual data on an installed system. Table 1 lists text conventions in this guide. Table 1 Text Convention Descriptions
Convention Text represented as a screen display Text represented as user entry. Text represented as menus, sub-menus, buttons, tabs, directories, and field names Description This typeface represents text that appears on a terminal screen, for example login:. user, for example, cd

Figures and Screen Captures

Text

This typeface represents commands entered by the $HOME.

This typeface represents all menus, sub-menus, buttons, tabs, directories, and field names within procedures, for example: On the File menu, click New.

Text represented by <variable> This typeface represents a required variable, for example: <filename>

Figures

This guide provides figures and screen captures as examples. These examples contain sample data. This data may vary from the actual data on an installed system.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

22

About This Guide

Notices

Table 2 lists notice icons used in this guide. Table 2 Notice Icon Descriptions
Icon Notice Type Information Note Description Information that contains important features or instructions but is not hazard-related.

Caution or Warning

Cautions are preceded with the word Caution. This type of caution indicates a potentially hazardous situation which, if not avoided, may result in minor or moderate injury. It may also alert against unsafe practices and potential program, data, system, or device damage. Warnings are preceded with the word Warning. This type of warning indicates a potentially hazardous situation which, if not avoided, could result in death or serious injury.

Caution or Warning due to potential electrical hazard

Cautions due to potential electrical hazards are preceded with the word Caution. This type of caution indicates a potential electrical hazard. This hazard, if not avoided, may result in minor or moderate injury. It may also alert against unsafe practices and potential program, data, system, or device damage. Warnings due to potential electrical hazards are preceded with the word Warning. This type of warning indicates a potential electrical hazard. This hazard, if not avoided, could result in death or serious injury.

ESD

Information that indicates proper grounding precautions are required before handling a product.

Related Documentation

The CEM documentation set includes the following documents. To order additional copies of this document or to order a document that you do not have, contact your sales representative. The integrated CEM help system describes basic CEM functionality. This help system is bundled with the software; it is basically this document converted into an HTML format. You can access this help system through the CEM GUI client. For more information, refer to Online Help.

CEM Help System

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Contacting the Customer Service Department

23

Contacting the Customer Service Department

For general inquiries, please email us at [email protected]. For information about customer service, visit our website at http://newnet.com/support.htm or call 1-877-735-6162. Before requesting technical support, have this information available:
n n

Contract number Product information

n

Software and hardware versions Serial numbers Symptoms Known causes Any error messages Whether the problem is repeatable or sporadic A list of any other symptoms that are affected by the problem The approximate number of customers affected by the problem

Problem description
n

Trouble locating and clearing attempts

Obtaining Technical Assistance

NewNet maintains a strong global presence, operating Technical Response and Service Centers, in the US,India, and Romania. These centers are available for technical telephone support to entitled customers during normal business hours. After hours support is available to customers who purchase a premium Service Agreement. The NewNet Support website provides a variety of tools to assist customers in resolving technical issues on NewNet products. The NewNet Support website is available 24 hours per day. Customer registration is required. Certain premium features require a valid Service Agreement. NewNet provides its customers warranty support per the terms of the NewNet Warranty Statement for their equipment. Customers who require warranty support should contact the NewNet Service Center that serves their territory. Contact details for the Service Center can be found at http://newnet.com/support.htmor you can call the support hotline at 1-877-735-6162.

Support Website

Warranty Support

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

I
Chapter 1 Chapter 2 Chapter 3 Chapter 4 Chapter 5 Chapter 6 Chapter 7

INSTALLING

AND

USING CEM

Product Overview Pre-Installation Installation and Initial Setup Provisioning Operations Maintenance Trouble Locating and Clearing

PRODUCT OVERVIEW

Common Element Manager (CEM) provides customers with flexible and intuitive management solutions, comprehensive and integrated management abilities, and advanced value-added features that provide industry-leading element management capabilities. This chapter contains the following topics:
n n n n n n n n

Features Benefits CEM Software Components Graphical User Interface Basics Help Options Printing Options CEM Event Processing CEM Server Redundancy

Features

CEM provides the following features:

n

client-server architecture supporting both Graphical User Interface (GUI) and command line interface (CLI) clients with remote browser access to key functions Java-based platform independent architecture consistent, common interfaces across applications and components open solutions environment hierarchical organization of discovered devices into several different views. For more information, refer to Left-hand Pane Views. comprehensive management of NewNet devices and basic management of most SNMP devices. For more information, refer to SNMP Device Common Configuration Tabs. extensive performance monitoring capabilities, including the ability to graph any numeric device attribute over time. For more information, refer to Monitoring Properties. integrated SNMP trap log with device correlation. For more information, refer to Managing Logical Logs.

n n n n

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

28

Chapter 1: Product Overview

HP OpenView integration. For more information, refer to HP OpenView Installation Issues and HP OpenView Integration. centralized user access control and audit logging; logs are accessible using the GUI interface or through a web browser. For more information, refer to Viewing the Daily Audit Log, Viewing FTP Logs, and Viewing Server Console Logs. device reservation feature allows administrators to reserve a set of devices for exclusive use. For more information, refer to Reserving and Unreserving Elements. web browser interface to remotely access the state of managed devices and users and to view event logs and related documentation. For more information, refer to Accessing the Web Browser Interface. external database support (instead of the embedded InstantDB database) for larger networks. For more information, refer to Embedded and External Database Options. Redundant server support when using external databases. For more information, refer to Provisioning CEM Server Redundancy.

Benefits

CEM provides the following benefits:

n

Simple, Intuitive Interface-CEM features an easy-to-use GUI that enables network operators to view system status and device availability at a glance. Supports Multiple Platforms-Based on Java architecture, CEM enables network operators to use the network management platform of choice, giving them power to leverage their existing equipment investment. Highly Customizable-CEM includes an XML interface and scripting APIs, which provides a wide variety of options for developing custom device management extensions and clients. If you need more information about customizable scripting, please contact your customer service representative. Flexible Client/Server Architecture-Client (both GUI and CLI) and server components can be separated, giving network operators the flexibility to deploy the management solution in ways that best suit their needs. Extensive Value-Added Features-An array of advanced features, including customizable device folders and view, enhanced security and access options add superior value to this robust product.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Software Components

29

CEM Software Components

CEM is a client-server management solution that provides a Java-based GUI for managing individual SNMP devices. CEM is bundled with three main software applications:
n

Server
n

runs as a Java application contains no GUI component runs from a DOS/Shell prompt has a console command line interface manages network devices and organizes them in an explorer tree maps MIB objects to their associated device provides event logs for all GUI activity contains no GUI component manages network devices

GUI client
n

CLI client
n

Graphical User Interface Basics

The CEM GUI provides a simple and intuitive device management environment. As shown in Figure 1, all managed devices, event logs, and users are organized in an explorer tree (Explorer view) in the left-hand pane of the CEM GUI main window. The Explorer view is the default view for the CEM GUI. Element properties (MIB objects) are displayed in the right-hand pane of the CEM GUI main window (Properties view). The Properties view is the default view for the right-hand pane of the CEM GUI. For more information on element views, refer to Left-hand Pane Views and Right-hand Pane Views.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

30

Chapter 1: Product Overview

Figure 1 shows the left-hand and right-hand panes of the CEM GUI main window. Figure 1 Left and Right Panes of the CEM GUI Main Window

explorer tree

device icons

This guide provides screen captures as examples. These examples contain sample data. This data may vary from the actual data on an installed system. The system administrator can create different logical views of managed devices and assign those views to individual users. For more information, refer to Provisioning Users. Menu Bar The menu bar provides quick access to specific commands and features available for the CEM GUI. Figure 2 shows the menu bar options for the CEM GUI. Figure 2 Menu Bar Options
Tree Menu View Menu Help Menu

File Menu

Tools Menu

Configuration Menu

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Graphical User Interface Basics

31

Toolbar

The toolbar provides quick access to specific commands and features available for the CEM GUI. Figure 3 shows the toolbar buttons for the CEM GUI. Figure 3 Toolbar Commands

expand delete node node find

copy paste SNMP SNMP values values to all

show job status window*

help

logout collapse and exit node

user options

paste SNMP values

device visual

toggle background table loading

advisor

* This button only appears when the CEM GUI is configured to display progress for all jobs in a single window (rather than individual windows). Refer to Provisioning Background Job Display for more information. Left-hand Pane Views The CEM GUI gives you three general views-the Explorer view, the List view, and the Map view to view elements in the left-hand pane of the CEM GUI main window. The Explorer view may contain Logical View Folders. Element is a generic term used in this document to describe any folder, sub-folder, SNMP device, user or other sub-element found in the explorer tree. Explorer View The Explorer view lets you view all of the elements in an explorer tree, a hierarchical organization containing multiple levels of tree nodes. The Explorer view is the default view in the CEM GUI client and all procedures in this document begin from this view. Many folders and devices have sub-elements. You can expand and collapse elements (nodes in the tree) which have sub-elements. For more information, refer to Expanding and Collapsing Elements. List View The List view provides an alternative way to view and manage SNMP devices. For more information, refer to Toggling between the Explorer and List View. The List view allows you to:
n n n

manage properties invoke operations filter by class and optional attribute name and values The Tree menu bar option is not available for the List view.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

32

Chapter 1: Product Overview

Map View This view consists of two major, distinct, and functional elements:
n n

A Map-style view of the current Equipment containment hierarchy The ability for the operator to manually specify/establish dependent connections between equipment in the containment hierarchy

Like the Explorer and List views, the Map view is an independent view of the Equipment in CEM or a specialized view of the equipment containment hierarchy. The Map view has exactly ONE Map view for each Equipment Folder, Rack or Bay in CEM. Additionally, the equipment contained in a specific map is the same as the equipment contained in the folder. Logical View Folders In the Explorer view, create logical views to quickly access and view a specific group of devices organized by device type, geographical region, and so forth. For more information, refer to Creating Logical Views. Right-hand Pane Views The right-hand pane of the CEM GUI main window has two views to choose between-Properties and Related. For more information, refer to Toggling between the Properties and Related View. Properties View The Properties view is the default view for the right-hand pane of the CEM GUI main window. This view contains configuration tabs and MIB tables used for provisioning all elements in the left-hand pane of the CEM GUI main window. Related View The Related view is the optional view which allows you to see the different relationships between related elements in the explorer tree. The most common example of related elements is the relationship between a specific user and the root view assigned to that user. Root Folders The CEM GUI main window contains five default root folders which are sub-elements of the root node (the first node in the explorer tree; typically, it is the hostname of the workstation where your CEM server resides). You can not move, rename, or delete these elements. All elements you add to the CEM GUI (SNMP devices, users, and folders) are sub-elements of the root folders. The CEM GUI contains the following root folders:
n

Equipment-This root folder contains SNMP devices organized in various arrangements of folders, bays, and racks. For more information, refer to Provisioning SNMP Devices. Logical Views-This root folder contains a logical collection of SNMP devices. After creating logical views, you can assign a logical view to a
Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

Graphical User Interface Basics

33

specific user (also referred to as a root view). For more information, refer to Creating Logical Views.
n

SNMP Agents-This root folder contains a relationship to all SNMP agents discovered by CEM. To view these agents and their associated relationships, use the Related view. For more information, refer to Related View. Logs-This root folder contains logical logs, which are collections of related event records. For more information, refer to CEM Event Processing and Managing Logical Logs. Users-This root folder contains all managed users of the CEM server. For more information, refer to Provisioning Users.

Pop-up Menus

The majority of commands are provided in pop-up menus accessed by right-clicking an element in the left-hand pane of the CEM GUI main window. Each pop-up menu is specific to the type of element selected, as shown in Figure 4. The pop-up menu can change based on the state of the equipment. For example, menu items may not appear when the equipment is down and some menu items are disabled/greyed then the particular operation is not available to the equipment. Figure 4 Example Pop-up Menu

pop-up menus provide elementspecific commands

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

34

Chapter 1: Product Overview

SNMP Devices

In this guide, SNMP device refers to any SNMP agent that can be managed through CEM. You must discover SNMP devices and initially provision them before they can be used in your network. For more information, refer to Provisioning SNMP Devices. CEM labels each SNMP device in the left-hand pane of the CEM GUI main window. By default the name is taken from the sysName MIB (if not blank). If the sysName is not available, CEM uses the reverse DNS lookup for the hostname (if not blank). If neither is available, CEM defaults to the IP address of the device. If the discovered device is a NewNet product, a NewNet (UTStarcom) Icon appears in front of the IP address.

Help Options

CEM has five help options available -the Help menu, tool tips, the Advisor window, online help, and the web browser interface. The Help menu on the CEM toolbar allows access to the following information:
n

Help Menu

CEM core and package software information For more information, refer to Viewing Software Version and Copyright Information.

CEM GUI information For more information, refer to Viewing GUI and Client Information. CEM Online help access For more information, refer to Online Help. Show Advisor command For more information, refer to Advisor Window. Copyright information

For more information, refer to Viewing Software Version and Copyright Information.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Help Options

35

Tool Tips

Tool tips are available for most commands and functions. To display a tool tip, place the mouse cursor over a node, command, or parameter in CEM and a tool tip appears. Refer to Figure 5. Figure 5 Example Tool Tip

Tool Tip

Advisor Window

When you start the CEM GUI, the CEM Advisor window opens. The Advisor window displays status information on a selected device, as well as MIB definitions on a selected property. For more information, refer to Figure 7. To open the CEM Advisor window, use one of the following methods:
n n

Click the Advisor button, as shown in Figure 6. From the Help menu, select Show Advisor.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

36

Chapter 1: Product Overview

Figure 6 Locating the Advisor Button

Advisor Button

Figure 7 shows the Advisor window. Figure 7 Advisor Window

MIB object MIB description

table of related information

The Advisor window is resizable and it allows scrolling if the information is too verbose for a single screen display. To close the Advisor window, click the Hide button located at the bottom of the Advisor window. Select the Show on Startup check box to provision the CEM GUI to open the Advisor Window each time it starts.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Help Options

37

Online Help

The CEM online help describes how to use CEM effectively, and it provides detail on the functionality of the software. The online help is basically this document converted into an HTML format. It also describes how to install, initially configure, provision, operate, and maintain each CEM software component. To open the online help, use one of the following methods:
n n

From the toolbar, click the Help contents button. From the Help menu, select Contents.

Web Browser Interface

To view and search help using the web browser interface: 1 Use a standard web browser and navigate to the CEM server installation directory. 2 Access the cemServerAddress:port file. where cemServerAddress:port is the IP address of your CEM server and port designates the port number assigned to the internal HTTP web server. The default value is 1080. For more information on port usage, refer to Ports Used by CEM. For example: http://10.1.1.1:1080. Figure 8 shows the web browser access window. Figure 8 Web Browser Access Window

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

38

Chapter 1: Product Overview

3 Under the General Documentation section, do one of the following:

n

Search the general help.

a Enter a search term into the Search field. b From the drop-down list, select text to search all the text or select title to search just the title.
n n

Click General Help to view the general help. Click Readme to view the readme.

Printing Options

The CEM GUI client allows you to print various types of information to any configured printer. CEM allows you to print from various GUI windows, such as equipment inventory reports (refer to Creating Inventory Reports), log files (refer to Viewing the Daily Audit Log), and related documentation and help topics (refer to Help Options). However, before printing, you must provision the printer page setup. For more information, refer to Provisioning the Printer Page Setup.

CEM Event Processing

In general, an event is an action or occurrence detected by a software program. Specifically, CEM events are messages which report internal activity and communication between the CEM server and each client and managed SNMP device. For example, when a user logs in, an event is logged and saved on the CEM server in the security log and in the daily audit log. All events have similar syntax; for more information on the standard syntax for events, refer to Table 36 in the Maintenance chapter. Various CEM components detect and generate events. For example, CEM translates a received SNMP trap into a formal CEM event to be processed accordingly. For more information, refer to Event Flow. Events come from a variety of sources. Sources include the following internal processes:
n n

User Manager-processes all user login and logout activity SNMP Trap Receiver-processes and translates all SNMP traps that the CEM server receives Syslog Daemon-processes all of the syslog messages the CEM server receives CEM Server Process-monitors each time a user runs an operation or changes an attribute/MIB value for a CEM client

For high event rates (over 60 events per minute), deploy the CEM server using a supported external database, not the embedded database. For more information, refer to Database Configuration Options.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Event Processing

39

Event Flow

Depending on the source of the event, CEM processes events through the different internal engines and applications found on the CEM server. Figure 9 shows typical paths for different events. Figure 9 Event Flow

B
Translate to Event

A D

SNMP device

SNMP Trap

SNMP Trap Forwarding filter

syslog device

syslog message

SNMP Trap

CEM Event

Other Management Plaftorms(s)

SNMP Trap CEM Server Process CEM Event Event Manager Event Action Script Log filter Launch Daily Audit Log

I C F

DB Event Table

Any SNMP device managed by CEM (A) can send SNMP traps to CEM. When CEM receives SNMP traps, it forwards the traps to the Forwarding Filter (B) and translates them into CEM events which are processed by the Event Manager (C). The Forwarding Filter (B) determines if a specific SNMP trap should be forwarded to another management platform (J). Any SNMP device can send syslog messages (D) to CEM. CEM translates the message into a CEM event and passes the event to the Event Manager (C). Any CEM server process (E) can generate CEM events and SNMP traps. CEM passes the event to the Event Manager (C) while sending the SNMP trap to the Forwarding Filter (B). The Event Manager (C) uses the Log Filter (F) to determine if the specific event should be written to the daily audit log (G) and stored in the Event Table (H) for the database. The Event Manager (C) independently launches the Event Action Script (I) if one has been supplied.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

40

Chapter 1: Product Overview

CEM Core Events

The following events are considered part of the CEM Core:

n n n n n

Base Events Audit Events Security Events SNMP Trap Events syslog Events

Base Events This is the base class for all events. Audit Events Audit events are the collections of all events that are initiated by some user (except security events). Table 3 lists the Standard Audit Events. Table 3 Standard Audit Events
eventID ranOperation attributeChange objectCreated objectDeleted objectRenamed objectMoved label Ran operation severity informational probable cause An operator ran an operation on this object An operator changed the value of the attribute. An operator created a new object An operator deleted an existing object An operator renamed an object An operator moved an object in the containment tree An operator acknowledged an event Uses the same sourceOID as original eventNever expected to be acknowledged or cleared. notes

Changed attributeLabel from informational oldValue to newValue Created objectLabel Deleted objectLabel Renamed oldObjectLabel to newObjectLabel Move objectLabel from oldParentLabel to newParentLabel Acknowledged eventLabel informational informational informational informational

acknowledgeEvent

informational

clearEvent

Cleared eventLabel

cleared

An operator cleared an event Uses the same sourceOID as original eventNever expected to be acknowledged or cleared.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Event Processing

41

Security Events Security events are the collections of all events associated with user accounts. Table 4 lists the standard security events Table 4 Standard Security Events
eventID noUserID disabled multiLogin expired loginPasswordChanged invalidPassword login logout passwordChanged label Login failure: userID invalid Login failure: userID disabled Login failure: userID already logged in Login failure: userID expired userID changed password upon login Login failure: userID invalid password userID logged in userID logged out userID changed password severity warning warning warning warning informational warning informational informational informational probable cause Attempted login with invalid userID Attempted login with disabled userID Attempted duplicate login Attempted login with expired userID The user changed the password upon logging in Attempted login with valid userID but wrong password User successfully logged in User successfully logged out User successfully changed their password
.

SNMP Trap Events SNMP Trap events are the collections of all events that are generated when an SNMP Trap/Inform is received. The actual event specifications for each TRAP-TYPE and NOTIFICATION-TYPE are derived each time the server starts up by compiling the files in the /mib directory. A simple inheritance hierarchy is automatically created for each MIB module containing trap specifications. An event "category" is created for the MIB module itself extending FDSNMPEvent, and each trap then extends this event category. syslog Events The optional CEM syslog daemon can receive syslog messages from any source. It can log all syslog messages to both the daily audit log and the "Syslog" logical log. When syslog messages are converted into CEM Events, the label is similar to the following:
sourceIPAddress mmm dd hh:mm:ss [facility:priority] processName: messageString
n

The sourceIPAddress is not included in the label if the source of the syslog message can be found in the CEM equipment tree. The priority indicated in the syslog message determines the Event severity and event ID as listed in Table 5.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

42

Chapter 1: Product Overview

Table 5 Syslog Severity and ID Mapping

syslog priority LOG_EMERG LOG_ALERT LOG_CRIT LOG_ERR LOG_WARNING LOG_NOTICE LOG_INFO LOG_DEBUG unknown event severity critical critical critical major warning informational informational informational indeterminate eventID FDSyslogEvent-panic FDSyslogEvent-alert FDSyslogEvent-critical FDSyslogEvent-error FDSyslogEvent-warning FDSyslogEvent-notice FDSyslogEvent-info FDSyslogEvent-debug FDSyslogEvent description A panic emergency condition that is normally broadcast to all users. A condition that should be corrected immediately. A condition that should be corrected immediately. A condition that should be corrected immediately. Warning messages. Conditions that are not error conditions, but may require special handling. Informational message. Messages that contain information normally used only when debugging a program.

Trap/syslog Source Identification

CEM attempts to determine the source of all events - as related to objects in its current containment tree. This source is displayed in the GUI for each event and allows CEM to automatically filter all events by their source. This allows the user to view only those events related to a specific source by launching the Event Viewer from a specific object in the containment tree. Alarms usually indicate a condition that requires attention to the specific equipment listed in the Alarm. An Alarm is any event has a corresponding to one of the following severities:
n

Alarm Events

critical - One or more critical alarms indicating a fault have been detected in the resource, and have not been cleared. The operational state of the managed object can be disabled or enabled. major - One or more major alarms indicating a fault have been detected in the resource, and have not yet been cleared. The operational state of the managed object can be disabled or enabled. minor - One or more minor alarms indicating a fault have been detected in the resource, and have not yet been cleared. The operational state of the managed object can be disabled or enabled. warning - One or more warning alarms indicating a fault have been detected in the resource, and have not yet been cleared. The operational state of the managed object can be disabled or enabled.

For containers, such as Folder or chassis, the Alarm Status is determined as the most severe current alarm for the container itself, or any of its children.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Server Redundancy

43

Event Viewer

CEM's Event Viewer can show All Events, the Alarm History, and Current Alarms. Current Alarms are all Alarm events that have not been Cleared, and Alarm History is all Alarm events that have been Cleared. Refer to Using the Event and Alarm Viewer for information about viewing and clearing events and alarms. Current and Historical alarms are only viewable when using an external database.

Alarm Counts GUI

When using an external database, the main CEM GUI shows the Current Alarm counts by severity for the overall system and the currently selected object in a panel below the Explorer tree. Figure 10 Alarm Counts GUI

The critical, major, minor and warning counts represent the number of alarms with each severity that have not been cleared. The "informational" row is a count of all informational events. The "cleared" row shows the total number of alarms that have been cleared.

n n

Clearing Traps/Events Automatically

Traps are automatically cleared when CEM receives a trap that is configured to clear a previous condition. For example, if CEM receives a Link Down trap, it associates the trap with the specific managed object that sent the trap. When CEM later receives a Link Up trap from the same device, it can again associate the trap to same device. If the Link up trap is configured as a clear trap, the Link Down trap is automatically cleared.

CEM Server Redundancy

The goal of CEM Redundancy support is to deploy a warm-standby server that can take over all network management capabilities if the primary server fails minimizing (but not eliminating) the amount of database information lost during the switchover. A switchover is the event when the standby server starts providing service because the active server either failed or was taken out of service. Only two servers can be configured as redundant to one another. One CEM Server is the active server while the other is the standby. The active CEM server actively provides service while the standby CEM server remains inactive until the active server is disabled. The standby server does not communicate with client GUIs or databases while inactive.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

44

Chapter 1: Product Overview

This section describes the following:

n n n n n n n n

Selecting a Redundant Configuration Determining Perceived States Determining Startup State State Transitions Failsafe Shutdown Redundancy Consistency Check Startup and Shutdown Traps Client Switchover

To provision CEM server redundancy, refer to Provisioning CEM Server Redundancy in the Provisioning chapter. Selecting a Redundant Configuration There are two typical CEM redundancy implementations: redundant CEM servers connecting to a shared database or redundant CEM servers connecting to separate synchronized databases. Both redundancy implementations require external databases and both implementations have advantages and limitations. For information about the two implementations, refer to the Shared Database and Separate Databases sections. External databases typically use TCP/IP to connect to the CEM server. If network connectivity is lost between the database and the CEM server, it may take a considerable amount of time for the TCP/IP protocol to declare the connection has been broken. This causes CEM to appear frozen while it waits for the transaction to complete or timeout. For more information, refer to Operation Issues in the Trouble Locating and Clearing chapter. Shared Database Figure 11 shows the shared database implementation. Each CEM Server is deployed on a separate workstation and the database is deployed on a 3rd workstation. Although both servers are connected to the database, only the active server updates the database. The standby server does not perform any updates to the database, until it takes on the active role. The shared database implementation is the most effective deployment technique to minimize the loss of information during a switchover. It does, however, place the database server as a single point of failure. Redundant hardware and software database technologies can minimize the risk of the database server failing.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Server Redundancy

45

Figure 11 Active and Standby CEM Servers Sharing a Common Database

GUI Client
Workstation

GUI Client
Workstation

Heartbeats Heartbeats CEM Server (Active) CEM Server (Standby)

Database Workstation

Separate Databases Figure 12 shows the separate database implementation. Each CEM Server is deployed with its own database on separate workstations. The active server updates the database and the database technology itself is responsible for synchronizing the information in the standby database. CEM plays no role in the database synchronization. The loss of information is dependent on the database synchronization window, which is how much delay is incurred between the active CEM Server updating its database and the standby database being updated to reflect the same changes. This mirroring technique depends heavily on the database technology and mirroring configuration. For information about database redundancy, refer to the database software manufacture's documentation. For MySQL go to http://www.mysql.com/doc/en/Replication_FAQ.html and for Oracle go to http://otn.oracle.com/deploy/availability/pdf/oscp_remote_mirror_use.pdf (as of October 2004).

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

46

Chapter 1: Product Overview

Figure 12 Active and Standby CEM Servers using Synchronized Databases

GUI Client

GUI Client

Workstation Heartbeats

Workstation

Heartbeats

CEM Server

(Active)

CEM Server

(Standby)

Database

Synchronization*

Database

* Database synchronization is provided by the database software, not by CEM.

Determining Perceived States

Each CEM server determines the perceived state of their peer using heartbeat messages that are sent every 5 seconds or when the server changes state. The perceived state is one of the following:
n

Standby-the heartbeat from the peer server contained a state of Standby. The peer server is in the standby mode, ready to go active but not providing service. Active-the heartbeat from the peer server contained a state of Active. The peer server is actively providing full capabilities. Shutdown-the heartbeat from the peer server contained a state of Shutdown. The peer server has gracefully shutdown. If this is detected, the perceived per state will go back to Unknown until the first heartbeat is received. Unknown-this server cannot determine the state of the peer - probably because it never received a heartbeat message from the peer. Timeout-the peer was sending regular heartbeats but, for some reason, they are no longer being received.

When the perceived state of the peer server changes, a message is logged to the CEM server console. If the server stops receiving heartbeats from the peer it will log messages to the CEM server console before changing state. Refer to Figure 13 and Figure 14 for examples. Figure 13 Perceived State Change Message Examples
10/14/2004 17:07:08 (I) RedundancyMonitor: 192.168.90.15 stopped sending heartbeats, FAILSAFE shutdown... 10/18/2004 16:25:12 (I) RedundancyMonitor: 192.168.90.15 controlled shutdown, going active...
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

CEM Server Redundancy

47

Figure 14 Heartbeat Loss Message Examples

10/19/2004 10:46:29 (W) RedundancyMonitor: 20 seconds since last heartbeat from 192.168.90.15 10/19/2004 10:46:39 (W) RedundancyMonitor: 30 seconds since last heartbeat from 192.168.90.15 10/19/2004 10:46:39 (I) RedundancyMonitor: Timeout receiving heartbeats from 192.168.90.15, going active...

Determining Startup State

During startup, if the CEM server is configured for redundancy, the server will startup in standby mode and then determine whether to remain in standby or to go into active mode based on the perceived state of the peer server.
n n

If the perceived state of the peer is Standby, the server starts in active mode. If the perceived state of the peer is Unknown, then the server remains in standby mode until the operator issues the "goActive" command.

State Transitions

During operation, switchover from the active to the standby CEM server occurs in the following situations:
n

If the active server is gracefully shutdown, the active server sends the standby server a shutdown notification. Upon receiving this notification, the standby server assumes the active role. Gracefully shutting down the standby server does not affect the state of the active server. If the active server terminates abruptly, the standby server detects a timeout and assumes the active role. If the standby server and active server lose network connectivity to each other, the standby server detects a timeout and assumes the active role.

Table 6 shows how the different state transitions affect each server. Table 6 CEM State Transitions
Current Server State Perceived Peer State Unknown - Never received heartbeat messages from the peer server. Timeout - No longer receiving heartbeat messages from the peer. The peer may have failed. Standby - Peer is reporting Standby. Active - Peer is reporting Active Shutdown - Peer is reporting Shutdown. Standby Active Remain Standby Remain Active Go Active Go Active Go Active Failsafe Shutdown Remain Active Remain Active

Remain Standby Failsafe Shutdown

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

48

Chapter 1: Product Overview

Failsafe Shutdown

During Operation, the active server performs a failsafe shutdown in the following situations:
n n n

If the active server loses network connectivity to the standby server. If the standby server terminates abruptly. If the standby server reports that it is active while the active server is still active.

Redundancy Consistency Check

When the standby server becomes the active server, the standby server sends an SNMP trap and performs a redundancy consistency check. The redundancy check ensures that the CEM Core Versions are identical and that the Database Drivers are identical (i.e. this server uses the same database technology as the previously active server). The results of the consistency check will be logged to the CEM Server console. Any discrepancies will be reported as a warning. Example:
10/18/2004 16:21:51 (I) RedundancyMonitor: Using same database technology: com.mysql.jdbc.Driver 10/18/2004 16:21:51 (I) RedundancyMonitor: Using common database location: jdbc:mysql://localhost/cem

Startup and Shutdown Traps

If the SNMP.forward property is provisioned properly (refer to Provisioning SNMP Trap Forwarding), the CEM server sends traps when starting up or shutting down.
n

When the server goes into active mode, the cem server sends the "CEM Server Started" trap with the reason the server started (normal, switchover due to a switchover, or panic - the operator issued the GoActive command to the server while it was in standby mode. When the server shuts down, the cem server sends the "CEM Server Shutdown" trap with the reason the server shutdown (normal, switchover, or panic).

Client Switchover

When the active server fails or shuts down, any clients logged onto the previously active server are logged off. The GUI client alters the user to the shutdown and then prompts the client to log onto the standby server. Figure 15 CEM Client Switchover Message

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

PRE-INSTALLATION

This chapter provides minimum hardware and software requirements for using the common element manager (CEM) server, GUI client, and CLI client. This chapter contains the following topics:
n n n n n n

System Requirements Platform Related Installation Issues Obtaining License Keys Ports Used by CEM Accessing the CEM Server through a Firewall HP OpenView Installation Issues

System Requirements

This section explains hardware, software, and platform-related requirements necessary to run CEM. The CEM server, GUI client, and CLI client all run on mixed hardware/software platforms. For example, you can use a CEM GUI client installed on a Windows workstation to access a CEM server installed on a UNIX server. Table 7 lists the minimum hardware specifications for server and client environments. Table 7 Minimum Hardware Requirements for CEM
Component CPU Speed Memory Minimum Requirement 450 MHz 256 MB (server and client) 128 MB (server alone) 128 MB (client alone) Note: these memory requirements are in addition to the existing operating system memory requirements. Free Disk Space Network Type 500 MB (server); 50 MB (client) TCP/IP

Hardware Requirements

If you are using external databases in your network, the minimum hardware requirements change. For more information, refer to Deploying on a CEM Server and Deploying on a Dedicated Server.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

50

Chapter 2: Pre-Installation

Network Interface Card Requirements A 10/100 Ethernet Network Interface Card (NIC) is required for both client and server workstations. If a client and server are installed on the same workstation, use the same NIC. The CEM server can run on workstations that have more than one NIC. For configuration information, refer to Configuring CEM Server for Multi-homed Support. Platform and Operating System Requirements For detailed installation information, refer to the software installation documentation and release notes for these external products. Table 8 lists the minimum platform and operating system requirements for CEM. Table 8 Platform and Operating System Requirements for CEM
Platform Sun Microsystems Minimum Requirements Sun Ultra 10 NewNet supports the following Solaris operating systems:
n n n n

6.0 7.0 8.0 9.0

Solaris patches: http://sunsolve.sun.com/pub-cgi/show.pl?target=patches/JavaSE For Solaris: SUN Java 2, Runtime Environment 1.5 NOTE: Use the JRE provided by Sun Microsystems and follow their recommended patch guidelines for the Solaris and JRE versions you are using. There are no CEM specific patches. JRE Download page: http://java.sun.com/j2se/1.5/ NOTE: Certain UNIX JRE downloads may require a free registration with the JRE vendor. Intel x86 - Windows Pentium III 450 MHz NewNet supports the following Windows operating systems:
n n n

98 and 98 SE NT 4.0 (SP6a) 2000

SUN Java 2, Runtime Environment 1.5 SUN Java 2, Runtime Environment 1.5 (on NT 4.0 and 2000)

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

System Requirements

51

Table 8 Platform and Operating System Requirements for CEM (continued)

Platform Intel x86 - Linux Minimum Requirements Pentium II 450 MHz CEM requires the following Linux kernel and components:
n n n

Kernel 2.2+ X11R6 3.3x from XFree86 glibc 2.1+

Kernel updates: http://www.kernel.org/ X11 updates: http://www.xfree86.org glibc sources: http://sources.redhat.com/glibc/ IBM Java 2, Runtime Environment 1.5 NOTE: Use the JRE provided by IBM and follow the patch guidelines (if any) recommended by your Linux vendor. There are no CEM-specific patches. Distribution updates are distribution specific. Contact your Linux distribution vendor for distribution update information. Hewlett Packard - HP-UX HP B2000 HP-UX 11.x HP Java 2, Runtime Environment 1.5.1.01 NOTE: Use the JRE provided by Hewlett-Packard and follow their recommended patch guidelines for the HP-UX and JRE versions you are using. There are no CEM-specific patches.

NewNet supports the platform and operating system versions listed in Table 8. You may have some success using a different version listed in the JRE Requirements by platform section of the readme.html file (located in the CEM server folder), but that version is not officially supported at this time. Red Hat 8 has known problems interacting with JRE and cannot be used.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

52

Chapter 2: Pre-Installation

Platform Related Installation Issues

This section provides installation information related to these specific platforms:

n n n n n

Solaris Windows Linux HP-UX UNIX and Linux

The readme.html file describes the latest information, installation updates, and descriptions of resolved and unresolved issues with the product. The readme.html file is located in the CEM server directory. If the information in the Release Notes differs from the information in this guide, follow the instructions in the Release Notes. Solaris This section provides additional information and issues related to UNIX environments you will need to review before installing and using the CEM server and clients in your network. To integrate CEM with HP OpenView, refer to HP OpenView Integration. Running CEM in a Single User Environment CEM must be installed and run from the root/administrator account. refer to Running the CEM Server from Root Accounts. Running the CEM Server from Root Accounts On UNIX platforms, run the CEM server from a root user account to successfully receive SNMP traps. If you do not run the server from a root account, the JRE does not signal the failure to bind to port 162 thus leading you to believe that CEM is ready to receive traps when, in fact, it is not. Setting User Read-Write Permissions The user read-write permissions must be set for CEM clients installed on a workstation using a UNIX platform. To set the user read-write permissions in a UNIX environment: 1 Change to root. 2 Change to the directory where the CEM client is installed. 3 Enter the following command:
chmod -R 777 <file or directory>

Or, you may substitute an explicit list of permissions.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Platform Related Installation Issues

53

Using Static IP Addresses On UNIX platforms, run the CEM server on a workstation with a static IP address. For more information, refer to Configuring CEM Server with a Static IP Address. Using the CEM GUI Client Without a Monitor CEM GUI Clients only run on a workstation that is using X server or that has its DISPLAY environment variable pointing to a workstation that is using X server. This is a JRE requirement. Workaround: If you need to run the CEM GUI Client on a workstation without a monitor, point the DISPLAY variable (syntax varies according to your shell) to a workstation running an X Server. Or, use a virtual frame buffer such as X Virtual Frame Buffer (Xvfb) or an X server with no GUI monitor. Starting the CEM GUI client from a remote X terminal or emulator causes slow GUI redraw rates. NewNet recommends installing and running the CEM GUI client locally. Using UNIX Filenames UNIX filenames are case sensitive. Copying and Pasting Across Applications Certain UNIX variants only allow cutting and pasting between Java applications, not between non-Java applications and Java applications. This is only noticeable when you try to copy and paste your license key from the text file into the installation script. This is not a CEM shortcoming. Workaround: The only workaround is to type in the license key instead of copying and pasting the information. Windows This section provides additional information and issues related to Windows environments you will need to review before installing and using the CEM server and clients in your network. Using Windows Filenames Be careful how you capitalize and use filenames in a Windows environment. This will ensure consistent behavior across platforms which may have case-sensitive file systems. HP-UX This section provides additional information and issues related to HP-UX environments you will need to review before installing and using the CEM server and clients in your network. To integrate CEM with HP OpenView, refer to HP OpenView Integration.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

54

Chapter 2: Pre-Installation

Resolving Out of Memory Errors HP-UX environments default to 64 threads per process. This is too low for most Java applications and results in JVM outOfMemory errors. To increase the default value: 1 Shut down all running applications. 2 Log into the server as root and launch the SAM console. 3 Change the value of the max_thread_proc parameter from 64 to 1024. If you are managing a large number of devices, continue to increase this parameter. In general, the CEM server requires approximately 60 threads, plus one per background job. 4 Save the changes. 5 Recompile the kernel. For more information on recompiling kernels, refer to the HP-UX documentation. 6 Reboot the system. Linux This section provides additional information and issues related to Linux environments you will need to review before installing and using the CEM server and clients in your network. Resolving Remote Client Login Problems If you experience problems with remote client login when the CEM server is running on Linux systems, make sure the first line in your /etc/hosts file on the server contains the server name and IP address of the server. You may experience problems if the first entry in the /etc/hosts file is localhost. UNIX and Linux This section provides additional information and issues related to supported UNIX and Linux environments. Installing from / If the setup archive is located in the "/" directory when setup is run, a dialog message is displayed during the install action stating, "Insert Media #1". Workaround: If this occurs, the setup process must be killed using "Ctrl-C" or the "kill" command. Move the setup archive to a directory other than "/" and begin the setup again. Client-only Installations on UNIX On UNIX workstations where only the client has been installed, change the permissions of /opt/CEM/lib/temp directory:
chmod 777 /opt/CEM/lib/temp

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Obtaining License Keys

55

CEM Support for NewNet TC2000 CEM Support for NewNet Total Control 2000 requires the use of the internal CEM ftp server. Most UNIX systems already have an ftp server installed and running that may conflict with the default configuration of CEM. If file transfers between the CEM Server and a Total Control 2000 device are failing, it is recommended that the CEM ftp server port be re-configured to any available TCP port on the workstation. Refer to Ports Used by CEM for more information.

Obtaining License Keys

You must obtain two license keys for each CEM server software package you want to install-one for the CEM core and one for the CEM package. CEM GUI and CLI clients do not use license keys. To obtain CEM core and package licenses for the CEM server, please send the information that is requested in the Common Element Manager License Information Request form provided with your order. E-mail the completed form to [email protected] with a subject title of "Common Element Manager." If you did not receive this form or do not have access to the document containing the license keys, please request the Common Element Manager License Information Request form from [email protected].

Ports Used by CEM

Table 9 lists the TCP/IP and UDP ports used by the CEM server. Ensure that other software or daemons do not use these ports prior to installing CEM server. To change the default ports used by CEM, refer to Provisioning Default TCP/IP and UDP Ports Used By CEM. On UNIX systems, CEM must be run with root privileges in order to properly bind to the well-known TCP/IP ports (21, 161, 514). CEM cannot properly bind to the well-known TCP/IP ports (21, 161, 514) if another standard daemon is already running. The CEM GUI and CLI clients do not use fixed TCP/IP ports to communicate with the CEM server. The operating system assigns a free outgoing port number when the client requests a new connection. Table 9 Default TCP/IP and UDP Ports Used by CEM
Port 21 (TCP/IP) 161 (UDP) 162 (UDP) 514 (TCP/IP) 1080 (TCP/IP) 1097 (TCP/IP) Description CEM-specific FTP daemon. Port used for SNMP Management (Gets and Sets) Port that receives all SNMP Traps CEM-specific syslog daemon. Internal HTTP web server to facilitate GUI Help Panels and server-generated reports. Experimental XML Server interface.
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

56

Chapter 2: Pre-Installation

Table 9 Default TCP/IP and UDP Ports Used by CEM (continued)

Port 1098 (TCP/IP) 1099 (TCP/IP) 2099 (TCP/IP) Description Broadcast change notifications to all logged-in clients. Port used by clients to locate the CEM Server RMI interface. Port used by clients to access the CEM Server.

Accessing the CEM Server through a Firewall

If the CEM Server will be deployed behind a firewall, ensure the TCP ports listed in Table 10 are accessible from the clients outside the firewall: Table 10 TCP Ports for CEM Servers Behind Firewalls
Port TCP 1099 TCP 2099 TCP 1098 TCP 1080 Usage override.properties

RMI Registry / Name Service - used by clients to RMIBindingPort locate the CEM Server RMI interface RMI Server - used by clients to access the CEM RMIServerPort Server Broadcast change notifications to all logged-in clients notification.port

Internal HTTP Web server - to facilitate GUI Help HTTP.port Panels and server generated reports

Refer to Ports Used by CEM for complete list of ports used by the CEM Server. To change the ports, refer to Provisioning Default TCP/IP and UDP Ports Used By CEM in the Provisioning chapter.

HP OpenView Installation Issues

HP OpenView has an SNMP MIB browser that allows you to browse NewNet MIBs. All NewNet traps sent to the network management station are decoded and shown in the log window. CEM only supports HP OpenView version 6.1 or higher. Software patches may be necessary for some versions of HP OpenView. For a list of a related patches, refer to the HP OpenView website (http://www.openview.hp.com/). HP OpenView can only integrate with CEM on a Solaris or HP-UX platform. You cannot use HP OpenView on a Windows platform. If you plan to use HP OpenView with your CEM server, install it before installing any CEM software component (on the same workstation as the CEM server). During CEM installation, you will have an opportunity to automatically integrate HP OpenView. For more information, refer to Starting the CEM Server. If you plan on installing HP OpenView at a later time, manually integrate HP OpenView and CEM using the HP OpenView Integration procedure.

General Issues

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

HP OpenView Installation Issues

57

HP Openview 7.1 Issues

When installing HP Openview 7.1 and later, do not use the network autodiscovery feature.
Do you want Network Node Manager to discover your network automatically after the installation? (y/n):n

Using auto-discovery causes HP to incorrectly label NewNet entities as 3Com entities and prevents you from launching CEM from within HP Openview. Instead, discover NewNet devices manually. 1 After installation, select Add Objects from the Edit menu. 2 From the Add Objects Palate select the Connector symbol class. 3 From the Symbol Subclass list, select the NewNet (UTStarcom) Icon and drag it onto the main HP Openview window. CEM cannot be integrated with HP OpenView Network Node Manager version 7.01 or greater.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

INSTALLATION AND INITIAL SETUP

This chapter explains how to install and run the common element manager (CEM) server software and client software. CEM is distributed as an executable Java Archive (JAR) file that can be installed on most operating systems. This chapter provides information necessary for the first-time setup of a CEM server and CEM GUI and CLI clients. Before you begin, download and install the proper Java Runtime Environment (JRE) and patches. For more information about installing CEM on a specific hardware and software platform, refer to Pre-Installation. This chapter contains the following topics:
n n n n n n n n n

Installing CEM Software Components Starting the CEM Server Installing a CEM Package Installing Multiple CEM Packages Configuring CEM Server for Multi-homed Support Configuring CEM Server with a Static IP Address Starting the CEM GUI Client Starting the CEM CLI Client Database Configuration Options

Installing CEM Software Components

The CEM GUI and CEM CLI client software can be installed on the same workstation or on many other workstations, subject to the terms and conditions of your specific license agreement. To install CEM software components: 1 Make sure your workstation is properly configured. For more information, refer to System Requirements and Platform Related Installation Issues. 2 Save all the CEM installation files in a folder on your workstation:
n

disk.id is a file containing detailed information regarding the software model number and version number.
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

60

Chapter 3: Installation and Initial Setup

CEMSetup.jar is the "CEM Core Software" installation program. It is an executable jar file that installs what is commonly called the "CEM Core Software," which includes all of the basic CEM capabilities, including support for generic SNMP devices. It does not include support for NewNet-specific card sets, gateways, or servers. readme.html is the file providing basic installation notes and workstation requisites. packageName.jar is the "CEM Package" which, when installed, extends the Core Software to support NewNet-specific equipment and added-value capabilities. (for example, TCS47.jar, 3G30.jar and VOIP24.jar) CEM-Users-Guide.pdf is an Adobe Acrobat version of the user documentation. This manual only describes the "Core" CEM software capabilities. For more information, refer to product-specific documentation. Release Notes are often included which contain last minute information that could not be included in the previously-released documentation.

If you plan to use HP OpenView on the same workstation as your CEM server, install it before installing any CEM software component. If you plan on installing HP OpenView at a later time, manually integrate HP OpenView and CEM using the HP OpenView Integration procedure. 3 From a command prompt or terminal window, navigate to the folder where the CEMSetup.jar executable file is located. 4 From the folder containing the CEM Setup.jar executable file, enter the following command:
n

Windows: java -jar CEMSetup.jar

UNIX or Linux: ./java -jar CEMSetup.jar

The installation wizard for Common Element Manager opens. 5 Click Next. 6 Read the License Agreement and Warranty information and select I agree. 7 Click Next. 8 In the Directory Name field, type the desired directory and folder or use the Browse button to search for a specific directory. If you plan to use HP OpenView on the same workstation as your CEM server, install it before installing any CEM software component. If you plan on installing HP OpenView at a later time, manually integrate HP OpenView and CEM using the HP OpenView Integration procedure. 9 Once you have selected the desired directory, click Next.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Installing CEM Software Components

61

Three installation options appear. Figure 16 shows these options and Table 11 describes each option. Figure 16 Installation Options for Common Element Manager

Table 11 Common Element Manager Installation Options

Option All Server only Client only Description Use this option to install all CEM software components on the workstation (CEM server and CEM GUI and CLI clients). Use this option to install CEM server software components only. Use this option to install CEM GUI and CLI client software components only.

10 Select the installation option of choice and click Next. CEM installs all associated files into the desired directory and folder. 11 Click Next to view additional installation instructions. 12 Read the installation notes and click Finish. CAUTION: Do not manually rename/move the CEM files to another directory after installation. CEM does additional initialization the first time it is run and cannot recover from the operator/administrator manually changing the installation location of any CEM files. Silently Installing the CEM Server To install the core on a dumb terminal or from a Telnet console, use the silent installation command option:
java -jar CEMSetup.jar -silent

CAUTION: With this option, you cannot override any installation defaults. You will not be able to choose the name of the installation directory or which CEM components to install.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

62

Chapter 3: Installation and Initial Setup

CAUTION: Do not manually rename/move the CEM files to another directory after installation. CEM does additional initialization the first time it is run and cannot recover from the operator/administrator manually changing the installation location of any CEM files.

Starting the CEM Server

CEM uses a client-server deployment model. You must start the CEM server before starting the CEM GUI or CLI clients. Run the CEM server in either a terminal window (using either shortcut options or a command prompt) or as a daemon. For more information on running the server as a daemon, refer to Starting the CEM Server as a Daemon.

Using the Windows Shortcut

To start the CEM server using shortcut options: 1 From the desktop, double-click the CEM Server icon. Figure 17 CEM Server Shortcut Icon
Double-click the CEM Server shortcut icon

A Java-based CEM Server window opens showing the progress of the CEM server startup sequence. If this is not a new installation, continue with step 4 in this procedure. If this is a new installation, the CEM Server window prompts you to enter the core services license key. For information on obtaining license keys, refer to Obtaining License Keys. 2 Copy and paste the core license key for the first .jar executable file. If you do not enter a valid license key, the CEM server will operate for 30 days in demo mode. In this mode, CEM can manage a maximum of 10 SNMP devices. 3 From the command prompt, enter your name and organization. Allow the server to complete its startup sequence. After initialization, the server command prompt displays in the CEM Server window. For example:
CEMServer#station3>

CAUTION: Do not close the CEM Server window. If you close it, you will lose the session with the CEM server. To access the server console commands available, refer to Displaying Server Console Commands and Command Line Interface Reference.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Starting the CEM Server

63

Using a Command Prompt

To start the CEM server using a command prompt: 1 From a command prompt, navigate to the folder where the FDServer.jar executable file is located. 2 From the folder containing the FDServer.jar executable file, enter the following command and optional parameters:
./runServer [parameter1 parameter2 parameter3]

Table 12 lists the parameters for the runServer command. Table 12 Server Login Optional Properties
Property -db<name> -compact -license -Dcache.python=no -Dcache.java=no -Dpurge=yes -daemon -DfreshDB=yes -rediscoverAll Description Start with specific database (a previous database saved with export <name>). Compact database on start-up. Prompt for license information on startup. Do not cache python scripts (compile each time invoked). Do not cache Java methods (reload each time invoked). Purge orphan objects from database on start-up. Tell the server it is running as a daemon. For configuration information, refer to Starting the CEM Server as a Daemon. Start with an empty database (deletes existing database records). prompt for rediscovery of all SNMP devices.

The command prompt window displays the progress of the CEM server startup sequence. If this is a new installation, the command prompt window prompts you to enter the core license key. Attempting to start a new cem server when one is already running deletes hidden files in the CEM home mib directory. For information on obtaining license keys, refer to Obtaining License Keys. 3 Copy and paste the core license key. If you do not enter a valid license key, the CEM server will operate for 30 days in demo mode. In this mode, CEM can manage a maximum of 10 SNMP devices. 4 From the command prompt, enter your name and organization. Allow the server to complete its startup sequence. After initialization, the server command prompt displays in the window. For example:
CEMServer#station3>

CAUTION: Do not close the CEM Server window. If you close it, you will lose the session with the CEM server.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

64

Chapter 3: Installation and Initial Setup

To access the server console commands available, refer to Displaying Server Console Commands and Command Line Interface Reference.

Installing a CEM Package

CEM uses a package mechanism to provide support for NewNet-specific equipment and to provide added capabilities. Each package includes specific features, and packages can be combined to customize CEM. For instructions on installing multiple packages, refer to Installing Multiple CEM Packages. This section provides instructions for installing a CEM package. 1 From the server command prompt, enter the following:
install c:\temp\package.jar

where <c:\temp\package.jar> is the path and filename of the package .jar executable file. The following message appears:
MM/DD/YYYY HH:MM:SS (I) Please enter your license for package <c:\temp\package.jar> :

2 Copy and paste the package license key for the .jar executable file. After initialization, the following message appears:
MM/DD/YYYY HH:MM:SS (I) Server needs to be restarted for changes to take effect. Restart (y/n)?

a If your operating system is any one of the supported UNIX platforms, use the following step. If not, continue with step 3. The command prompt asks you the following question: Do you have HPOV installed? b If you answer no, go to step 3 after being prompted to shut down the server. If you answer yes, the following message appears: Please input the location of HPOV c Enter the location of HP OpenView. For example: /opt/OV The following message appears: Server needs to be restarted for changes to take effect. Restart (y/n)? The integration process creates a NewNet option under the Misc menu in the HP OpenView window. NewNet devices appear in the Connector category. If HP OpenView was integrated during installation, HP Openview is automatically re-integrated during a CEM package upgrade.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Installing Multiple CEM Packages

65

3 To restart the CEM server, enter y. For installation changes from both .jar executable files to take effect, you must restart the server application. This command only restarts the CEM server application, not the hardware on which the CEM server is installed. After restarting, the server command prompt displays in the CEM Server window. For example:
CEMServer#station3>

4 After the server has completed its startup sequence, minimize the CEM Server window. Once both license keys have been entered, there is no need to reenter them when you start the CEM server again.

Installing Multiple CEM Packages

Multiple packages can be installed on a single CEM server. Each package allows CEM to support additional NewNet-specific equipment or additional functionality. A license key is required for each package. Refer to Obtaining License Keys for more information. Every CEM package includes a unique core (CEMSetup.jar) with the installation files. This CEMSetup.jar must be installed first to ensure compatibility between CEM packages. To install multiple CEM packages on a CEM server: 1 Install the CEMSetup.jar 2 Start the server and enter the CEM core license. Refer to Installing CEM Software Components. 3 Install the package and enter the proper package license. 4 Stop the CEM server. 5 Repeat these steps for each new pair of core and package. Any additional core and package files must be installed in the same folder as the first installation.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

66

Chapter 3: Installation and Initial Setup

Configuring CEM Server for Multi-homed Support

If the CEM server will run on a workstation that has more than one NIC and is configured to be on more than one network (multi-homed), you must manually assign which address listens for connections from CEM clients (the client interface) and which address is used to communicate with managed devices (management interface). Unless specified, CEM assigns these functions to the first IP address that responds to an internal query. Use this procedure to guarantee that the CEM server binds to the correct IP address on the correct management and client networks. To configure the CEM server for multi-homed support: 1 Using a standard text editor, create a new files in the CEM base directory named override.properties. If this file already exists, modify the existing file. 2 Open the server.properties file and copy the "Client Interface IP config" section. 3 Paste the entire section into the new override.properties file. 4 Go back to the server.properties file and copy the Management Interface IP config section. 5 Paste the entire section into the new override.properties file. 6 Close the server.properties file. Do not make changes to this file. 7 In the override.properties file, modify the Client Interface IP config section, edit the ClientInterface field according to your customized needs. The Client interface is the IP address on which CEM listens for connections from CEM GUI clients. For example, on a workstation with two NICs and two unique IP addresses: address a = 1.2.3.4 address b = 5.6.7.8 If you want the CEM server to listen for client connections on address b only, change the ClientInterface field to ClientInterface=5.6.7.8. 8 To enable the new configuration, uncomment the ClientInterface field by deleting the # symbol at the beginning of the line. 9 In the override.properties file, change the Management Interface IP config ManagementInterface field the static IP address of the management interface. This address is used by CEM for all SNMP transactions with managed devices. For example:
ManagementInterface=10.10.3.1

10 To enable the new configuration, uncomment the ManagementInterface field. 11 Save and close the override.properties file. 12 For these changes to take effect, stop and restart the CEM server.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Configuring CEM Server with a Static IP Address

67

Configuring CEM Server with a Static IP Address

The CEM server must run on a workstation with a static IP address. If you use a system configured for DHCP, you will get an error indicating that the RMI connection with the server was terminated. If you completed the Configuring CEM Server for Multi-homed Support section then this procedure is already competed. To configure CEM server with a static IP address: 1 Using a standard text editor, create a new files in the CEM base directory named override.properties. If this file already exists, modify the existing file. 2 Open the server.properties file and copy the Management Interface IP config section. 3 Paste the entire section into the new override.properties file. 4 Close the server.properties file. Do not make changes to this file. 5 In the override.properties file, modify the Management Interface IP config section, edit the ManagementInterface field according to your customized needs. For example:
ManagementInterface=10.10.3.1

6 To enable the new configuration, uncomment the ManagementInterface field. 7 Save and close the override.properties file. 8 For these changes to take effect, stop and restart the CEM server.

Starting the CEM GUI Client

The CEM GUI client is independent of the CEM server. Therefore, the procedures in this section assume that the CEM server is running. You can start the CEM GUI client using shortcut options or commands from a command prompt described in this section. To run the CEM GUI client using Windows shortcut options: 1 Double-click the CEM GUI icon. Figure 18 CEM GUI Client Shortcut Icon
Double-click the CEM GUI shortcut icon

Using Windows Shortcut Options

You can also double-click the GUIClient.jar icon within Windows Explorer.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

68

Chapter 3: Installation and Initial Setup

Two windows open after executing the GUIClient.jar executable file. A Java-based command prompt window for the CEM GUI opens first. After initialization, a standard CEM GUI splash screen and Login dialog box open, as shown in Figure 19. Figure 19 Login Dialog Box

2 Minimize the CEM GUI command prompt window. CAUTION: Do not close the CEM GUI command prompt window. If you close it, you will lose the session with the CEM GUI. 3 In the Login dialog box, type a valid User ID, Password, and Server IP address/host name. If this is the first time running a CEM GUI client, type the User ID Administrator with a blank password. The Server field should be the IP address of the CEM server, or type localhost if you are running the CEM GUI client on the same workstation as the CEM server. Once logged in, make sure to add an Administrator Password to secure your system. 4 Click Login. The CEM GUI main window and Advisor opens. For more information about the Advisor window, refer to Help Options.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Starting the CEM GUI Client

69

Figure 20 shows the CEM GUI main window. Figure 20 CEM GUI Main Window

5 If this is the first time you have running the CEM GUI client on the workstations, refer to Provisioning SNMP Devices for information on creating folders and discovering devices. For additional information on users, refer to Provisioning Users. Using a Command Prompt To run the CEM GUI using a command prompt: 1 From a separate command prompt, navigate to the folder where the runGUIClient executable file is located. 2 From the folder containing the runGUIClient executable file, enter the following command and optional parameters (as shown in Table 13): Starting the CEM GUI client from a remote X terminal or emulator causes slow GUI redraw rates. NewNet recommends installing and running the CEM GUI client locally.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

70

Chapter 3: Installation and Initial Setup

runGUIClient [parameters]

Table 13 GUI Login Optional Parameters

Parameter -H<hostname> Description where <hostname> is the name of an individual device to manage. Use this option to force the CEM GUI to constrain the view to the hostname that you enter. -P<password> -S<servername> Default Entire Explorer tree is shown in the CEM GUI main window.

where <password> is the valid password for Blank this user ID. where <servername> is the hostname/ipaddress of the CEM server. Enter localhost if you are running the CEM GUI client on the same workstation as the CEM server. localhost

-U<userID>

where <userID> is a valid user ID.

Administrator

For example:
runGUIClient -S192.1.1.1 -UAdministrator -P12345

If this is the first time running a CEM GUI client, type the User ID Administrator and make sure to add an Administrator Password to secure your system. Initial installation creates the Administrator user account with no password. The Server parameter should be the IP address of the CEM server, or type localhost if you are running the CEM GUI client on the same workstation as the CEM server. The CEM GUI main window and Advisor opens, as shown in Figure 20. For more information about the Advisor window, refer to Help Options. 3 Minimize the command prompt window. CAUTION: Do not close the CEM GUI command prompt window. If you close it, you will lose the session with the CEM GUI. 4 If this is the first time you have started the CEM GUI client, refer to Provisioning SNMP Devices for information on creating folders and discovering devices. For additional information on users, refer to Provisioning Users.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Starting the CEM CLI Client

71

Starting the CEM CLI Client

The CEM CLI client provides a Command Line Interface (CLI) as an alternative to the CEM GUI. Use the same Server Name, User ID, and Password as the CEM GUI client for the CEM CLI client. 1 Start the CEM server. For more information, refer to Starting the CEM Server. 2 From a separate command prompt, navigate to the folder where the runCLIClient executable file is located. 3 From the folder containing the runCLIClient executable file, enter the following command and optional parameters (as shown in Table 14):
runCLIClient [parameters]

Table 14 CLI Client Startup Optional Parameters

Parameter @<scriptname.py> -H<ipaddress> Usage where <scriptname.py> is the name of the python script to execute. where <ipaddress> is the IP address of the device to manage (rather than entire Explorer tree) where <logfile> is the name of the logfile to capture all output Default A python script is not executed. Entire Explorer tree is shown in the CEM CLI list of managed devices. A log files is not created.

-L<logfile> -P<password> -S<servername>

where <password> is the valid password for Blank (same as this user ID. password for CEM GUI) where <servername> is the hostname/address of the CEM server. Enter localhost if you are running the client on the same workstation as the server. localhost

-U<username>

where <username> is a valid user ID.

Administrator

For example:
runCLIClient -S192.1.1.1 -UAdministrator -P12345

After you have entered the login command, the system shows the progress of the login process and a command prompt appears. The CEM CLI command prompt is always the label of the current managed object in the Explorer tree. For example:
workstation>

To access the CLI client console commands available, refer to Displaying CEM CLI Client Console Commands and Command Line Interface Reference. For more information on using the CLI client to create customized scripts, contact your NewNet customer service representative.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

72

Chapter 3: Installation and Initial Setup

Database Configuration Options

CEM uses a relational database. There are two database configuration options available:
n

Embedded Database-NewNet provides a default embedded database for use with lab environments or small deployments. External Database-NewNet allows you to use an external database for larger deployments. You can either install the external database on the CEM server itself or on a dedicated external database server. Before installing the external database, review the minimum hardware requirements. For a list of those requirements, refer to Deploying on a CEM Server and Deploying on a Dedicated Server.

For more information, refer to Embedded and External Database Options.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

PROVISIONING

This chapter contains information used to provision the Common Element Manager (CEM) server, GUI client, and CLI client for performance enhancements. This chapter does not discuss how to initially configure and provision SNMP devices currently discovered in your network (for example, call signaling and media processing). To provision SNMP devices according to your customized needs, refer to the related documentation for that specific product line. However, there are several configuration tabs which are common across all SNMP devices. For a list of those configuration tabs, refer to SNMP Device Common Configuration Tabs. This chapter contains the following topics:
n n n n n n n n n n n n n n n n n n n n n

Customizing the GUI Client Environment Provisioning Background Job Display Provisioning the Printer Page Setup Provisioning Users Provisioning SNMP Devices Provisioning Map/Topology Views Provisioning Table Data Loading Provisioning the Logical Log Size and Log Full Action Provisioning How Often CEM Polls for Operational State Modifying Server Properties Embedded and External Database Options Provisioning CEM Server Redundancy HP OpenView Integration Provisioning SNMP Trap Forwarding Provisioning Memory and Disk Size for Different Network Sizes Provisioning the Display of Non-supported MIB Objects in the CEM GUI Provisioning the Default Refresh Rate for the GUI Client Provisioning the Default Maximum PDU Size for SNMP Device Discovery Provisioning the Maximum PDU Size for SNMP Devices Provisioning Default TCP/IP and UDP Ports Used By CEM Provisioning a Syslog Client
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

74

Chapter 4: Provisioning

Customizing the GUI Client Environment

Use the User Options option from the Tools menu to customize the look and feel of the GUI client, the state icons that appear next to each node in the explorer tree, and the severity icons that appear next to each event in the view All Events windows. To customize the GUI client environment: 1 From the main menu of the CEM main window, select Tools. 2 From the drop-down menu, select User Options. The User Options dialog box opens. 3 From the User Options dialog box, select the Preferences tab. You can also access the User Options dialog box by clicking the User Options button on the CEM window toolbar. For more information, refer to Toolbar. Figure 21 shows the Preferences tab. Figure 21 Preferences Tab

a In the Adviser Pane Preferences section, select the Always show Advisor on startup checkbox. The Advisor window appears on GUI client startup by default. You can easily hide and reopen the Advisor window once the GUI client opens.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Customizing the GUI Client Environment

75

b In the Look and Feel section, select your choice of GUI motif. This setting changes the appearance of the GUI. The default setting is Metal. c In the Background Table Loading section, select how the CEM GUI loads SNMP table data when the table has more rows than can fit on the screen:
n

To load the whole SNMP table at once, select the Load entire table (in background) checkbox. After CEM completely loads the table, this option allows you to scroll through the table without pausing. To load SNMP table data line by line as you scroll down an on-screen table display, deselect the Load entire table (in background) checkbox. With this option CEM loads only the visible rows, but pauses to load additional rows when you scroll down.

This setting is synchronized with the Table loading indicator. For information about the Table loading indicator, refer to Provisioning Table Data Loading. d In the Job Preferences section, select whether jobs are all displayed in a single window or in individual windows.
n

If jobs should be displayed in a single window, check the Display jobs in a single window checkbox. If jobs should be displayed in individual windows, uncheck the Display jobs in a single window checkbox.

For more information refer to Provisioning Background Job Display. e select how the CEM GUI loads SNMP table data when the table has more rows than can fit on the screen:
n

To load the whole SNMP table at once, select the Load entire table (in background) checkbox. After CEM completely loads the table, this option allows you to scroll through the table without pausing. To load SNMP table data line by line as you scroll down an on-screen table display, deselect the Load entire table (in background) checkbox. With this option CEM loads only the visible rows, but pauses to load additional rows when you scroll down.

4 From the User Options dialog box, select the State ICONs tab.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

76

Chapter 4: Provisioning

Figure 22 shows the State ICONs tab. Figure 22 State ICONs tab

a Select the State ICON to show in tree view drop-down list to view the available state type icons. Figure 23 shows the State ICON to show in tree view drop-down list. Figure 23 State ICON to Show in Tree View

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Customizing the GUI Client Environment

77

b Select a state type according to the options shown in Table 15. Table 15 lists the choices for the State Icon to show in tree view drop-down list. Table 15 Monitor State Types
State Type operationalState Description
n n n

enabled disabled degraded idle active busy locked unlocked shutting down

usageState

n n n

administrativeState

n n n

For more information on the state types, see Table 31. If a device is disabled all properties and attributes related to MIB objects are hidden and fewer property tabs are visible from the GUI client. c For each state type you want to change, click the state color. Figure 24 shows how to change a state color. Figure 24 Changing a State Color

click the state color you want to change

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

78

Chapter 4: Provisioning

The Choose a new color dialog box opens. Figure 25 shows the Choose a new color dialog box. Figure 25 State Color Palette

Click Reset to return to the default color. d Use the Swatches, HSB, and RGB tabs to choose the specific color you want. e Select a new color and click OK to save your changes. 5 From the User Options dialog box, select the Event Options tab.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Customizing the GUI Client Environment

79

Figure 26 shows the Event Options tab. Figure 26 Event Options tab

a For each event severity color you want to change, click the severity color's Select button. Click Restore Defaults to reset the colors to the default colors. The Choose a new color dialog box opens. Refer to Figure 25. b Use the Swatches, HSB, and RGB tabs to choose the specific color you want. Click Reset to return to the default color.

c Select a new color and click OK to save your changes. d Repeat step a as needed. When you are finished making changes, click OK. The screen appears different if the Notification package is installed , see Chapter 12.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

80

Chapter 4: Provisioning

Provisioning Background Job Display

CEM can display the progress for a background job in an individual window or in a single window with other background jobs. This section describes both options.
n n

Displaying Jobs Individually Displaying Jobs using the Job Status Window

Displaying Jobs Individually

When single job display is disabled, an individual window opens for each background job. To provision CEM to display jobs individually: 1 From the main menu of the CEM main window, select Tools. 2 From the drop-down menu, select User Options. The User Options dialog box opens. 3 From the User Options dialog box, select the Preferences tab. 4 In the Job Preferences section, uncheck the Display jobs in a single window checkbox. 5 Click OK. When a background job is started, a background job window opens. Figure 27 shows three individually displayed jobs. Figure 27 Multiple Jobs Displayed in Individual Windows

The windows have the following elements:

n n n

The window header lists the command being executed. The job icon displays the job status. The text box lists the job progress messages.

6 Click Close to close the window.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Background Job Display

81

Displaying Jobs using the Job Status Window

When single job display is enabled, background jobs are displayed in a single Job Status window. To provision CEM to display jobs in the Job Status window: 1 From the main menu of the CEM main window, select Tools. 2 From the drop-down menu, select User Options. The User Options dialog box opens. 3 From the User Options dialog box, select the Preferences tab. 4 In the Job Preferences section, check the Display jobs in a single window checkbox. 5 Click OK. The Show Job Status Window button appears on the toolbar. When a background job is started or when the Show Job Status Window button is clicked, the Job Status window opens. Figure 28 shows an example of the Job Status window: Figure 28 Multiple Jobs Displayed in a Single Job Status Window

The left pane lists the jobs in table format and shows the status, name, job type, start time, and end time for each job. The right pane lists the job icon, the status, and the progress messages for the currently selected job. It also contains the Clear and Cancel buttons. 6 From the Filter drop down list, select which types of jobs to view:
n n n n

All Jobs-view all job types. In Progress- jobs currently in progress. Error- jobs that encountered an error and did not complete successfully. Warning- jobs that encountered some condition that is generally considered a warning, but not a complete failure.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

82

Chapter 4: Provisioning

Waiting to be run- The jobs that cannot yet be executed because CEM Server is executing the maximum number of background jobs. Success- jobs that were successfully completed.

7 From the History field, enter or select the maximum number of background jobs to keep in active history. When the current number of background jobs reaches the History value, the oldest completed jobs will be cleared by new jobs. Incomplete jobs cannot be cleared and are not purged. CEM keeps incomplete jobs in the history, even if the number exceeds the History value. 8 If the newest job should be automatically selected in the table, check the Select Newest Job checkbox. 9 The Cancel button is active when the currently selected job is cancelable. Click Cancel to cancel the job. 10 The Clear button is active after the selected job is completes. Click Cancel to remove the selected job from the history table.

Provisioning the Printer Page Setup

Before printing anything from the CEM GUI, provision the printer page setup. For more information about different printing options using CEM, refer to Printing Options. For more information about printing the explorer tree, refer to Printing the CEM GUI Explorer Tree. To provision the printer page setup: 1 On the main menu, select the File menu and then select Page Setup. Figure 29 shows the Page Setup dialog box. Figure 29 Page Setup Dialog Box

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Users

83

2 In the Paper section, select the Size and Source from the drop-down lists. The default for Size is Letter and the default for Source is Automatically Select. 3 In the Orientation section, select either Portrait or Landscape. The default for Orientation is Portrait. 4 In the Margins (inches) section, type the desired margins for the printer page in the Left, Right, Top, and Bottom fields. The default for all margins is one inch. 5 When finished, click OK.

Provisioning Users

CEM gives you the ability to add new CEM GUI and CLI client users. Before adding a new user, you can create logical views to filter and limit the view specific users see from their explorer tree. Once you have created a logical view and a new user, you can also assign a root view to specific users preventing them from accessing SNMP devices not assigned to them. Also, use CEM to customize the password and access rights for each user. CEM provides one default user when initially starting the GUI client for the first time-System Administrator. The System Administrator has full operator privileges and default login parameters. For more information, refer to Starting the CEM GUI Client and Changing User Access Rights. To delete a user, refer to Deleting a User. To see if a user is logged in or not, refer to Monitoring the Status of GUI Elements.

Creating Logical Views

Create logical views to include any managed SNMP device from any of the root folders. For example, you can create a logical view under the main Equipment folder in the explorer tree to quickly access and view a specific group of devices organized by device type, geographical region, and so forth. Also, you can create a logical view and assign it as the root view for a specific user. This is a key security feature. Logical views allow a user to see and manage only those devices in his or her root view. For more information, see Assigning a Root View to a User. To create a logical view: 1 In the explorer tree, right-click the Logical Views root folder. A pop-up menu appears. 2 From the pop-up menu, select New and then select Logical View.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

84

Chapter 4: Provisioning

Figure 30 shows the New dialog box. Figure 30 New Dialog Box

3 Type a label and click OK. 4 Double-click the Logical Views root folder The folder you just created displays as a sub-folder under the Logical Views root folder. 5 Right-click the newly-labeled folder, and select Add from the pop-up menu. Figure 31 shows the Select Tree Nodes dialog box. Figure 31 Select Tree Nodes Dialog Box

6 In the root Equipment folder, navigate to the specific device folder (or bay or rack) you want to use in your new logical view folder (To select more than one device, press and hold the shift key while selecting a range of devices or press and hold the ctrl key while selecting multiple devices).

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Users

85

Figure 32 shows how to browse for a specific device folder. Figure 32 Assigning a Device Folder as a Logical View

browse to the folder you want to use

To create an equipment folder, bay, or rack or discover SNMP devices, refer to Provisioning SNMP Devices. 7 Click OK. Figure 33 shows where CEM displays the new logical view in the explorer tree. Figure 33 New Logical View Folder

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

86

Chapter 4: Provisioning

To remove a logical view, refer to Deleting a Logical View. Creating User Folders Before creating new users, you can create folders to organize the users according to your customized needs. To add a user folder: 1 In the explorer tree, right-click the Users folder. A pop-up menu appears. 2 From the pop-up menu, select New and then select User Folder. Figure 34 shows the New dialog box. Figure 34 New Dialog Box

3 Type the name for this user folder and click OK. In the explorer tree, the new user folder appears as a sub-element under the main Users folder. Creating New Users To create new user: 1 In the explorer tree, right-click the Users folder. A pop-up menu appears. 2 From the pop-up menu, select New and then select User. Figure 35 shows the New user in Users dialog box. Figure 35 New User in Users Dialog Box

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Users

87

3 In the New user in Users dialog box, enter the information as described in Table 16. Table 16 New User Information
Attribute User ID Description Type the ID for this user. You may use any ASCII character, and there are no practical limits on how many characters you may use. The User ID is a case-sensitive parameter. Type the password for this user. You may use any ASCII character, and there are no practical limits on how many characters you may use. The password is case sensitive. NOTE: This is an optional parameter. Re-enter Password User Full Name Type the Password again for security purposes. NOTE: This is an optional parameter. Type the full name for this user. This name appears at the top of the GUI and on the Identification tab when you select a user in the explorer tree. Type the department for this user. This department name appears on the Identification tab when you select a user in the explorer tree. NOTE: This is an optional parameter. Rights Select whether the user has operator or browser rights. An operator has full rights to use all of the CEM capabilities. A browser has much more restricted rights and has essentially read-only capability. From within the CEM GUI, a user with browser rights cannot change any property values, invoke any pop-up menus, or run the CEM CLI client.

Password

Department

4 If desired, click the Optional view root button which allows you to assign the root view for a particular user. See Assigning a Root View to a User for more information. 5 Click OK. In the explorer tree, the new user appears as a sub-element under the Users folder. Assigning a Root View to a User The ability to assign a root view to a user is a security feature which prevents users from accessing devices not in the explorer tree hierarchy of their assigned root view. A user sees the same view of managed devices with each login, and these are the only devices the user is allowed to manage. This includes viewing the status of the devices in the root view and viewing and modifying MIB values. The Administrator can change a root view at any time. The root view can be set to any level of any element in the explorer tree, including a a logical view. The Administrator also can assign a root view when initially creating a new user. For more information, refer to Creating New Users.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

88

Chapter 4: Provisioning

To assign a root view to a user: 1 If the root view will be a logical view, first create the logical view as described in Creating Logical Views. 2 In the explorer tree, select a user under the Users root folder. 3 Right-click the user. A pop-up menu appears. 4 From the pop-up menu, select Root view and then select Assign. The contents of the explorer tree appear in a dialog box. Figure 36 shows the Select a tree node dialog box. Figure 36 Assigning a Root View to a User

5 Navigate through the equipment folders and select the root view for this particular user. 6 Click OK.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Users

89

Exporting and Importing Users

You can export user lists to a plain text file and then import them back into another CEM server instance. This is not a database backup, just a plain text file that can be read by the same CEM server or a different CEM server. For example, this feature allows you to save your list of users, passwords, and user access rights prior to upgrading the CEM server. Exporting Users To export users: 1 In the explorer tree, right-click the Users root folder. A pop-up menu appears. 2 From the pop-up menu, select User and then select Export. Figure 37 shows the Users:Export dialog box. Figure 37 Exporting Users

CEM exports the list of users as a plain text file (user.tsv) into the root directory folder where the CEM software files are located. For example: c:\cem 3 When finished, click Close. 4 If you are going to use this list of users for another CEM server, copy and paste the text file from this workstation into the directory on the other CEM server where the CEM software files are located. Importing CEM Users To import users: 1 Make sure the user.tsv file is saved in the root directory folder where the CEM software files are located. For example: c:\cem 2 In the explorer tree, right-click the Users root folder. A pop-up menu appears.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

90

Chapter 4: Provisioning

3 From the pop-up menu, select User and then select Import. Figure 38 shows the Users:Import dialog box. Figure 38 Importing Users

CEM imports the list of users into the CEM GUI client and creates a new user in the explorer tree for each user found in the user.tsv file. Also, all user access rights and root views are mirrored from the user.tsv file. 4 When finished, click Close. Setting a Login Expiration Date and Time For each user in the explorer tree, you can set a login expiration date. If you set the login expiration date for a particular user, a user will not be able to log into the CEM server after the set date and time. To set a login expiration date and time for a particular user: 1 In the explorer tree, select the desired user. 2 In the right-hand pane of the CEM GUI main window, select Login. 3 Double-click the Expiration Date field and enter the expiration date and time using the following format: mm/dd/yyyy hh:mm For example: 05/16/2003 14:30 (in 24-hour format) 4 Click Save all. CEM alerts the user of the login expiration date starting ten days before the login expires. If the user attempts to log into the CEM server after the expiration date and time, the user receives an error message and is not allowed to access the CEM server.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning SNMP Devices

91

Provisioning SNMP Devices

Use CEM to create SNMP device folders and discover SNMP devices in your existing network. This section does not discuss how to provision SNMP devices currently discovered in your network (for example, provisioning call signaling and media processing). To provision SNMP devices according to your customized needs, refer to the related documentation for that specific product line. Use the explorer tree view when provisioning SNMP devices. Do not use the List view. For more information, refer to Toggling between the Explorer and List View. While performing certain maintenance functions on SNMP devices (for example, upgrading software or removing and replacing cards), you may need to rediscover SNMP devices. For more information, refer to Rediscovering an SNMP Device.

Creating Device Folders

All managed devices are added initially to one or more folders you create in the Equipment root folder. The Equipment folder is the root of all SNMP devices for the CEM GUI. Once you have added a folder under the Equipment main folder and assigned it a label, you can use the discovery feature to add SNMP devices. You can also assign root views (of a specific device folder) to a particular user. For more information, refer to Discovering Single SNMP Devices, Discovering Multiple SNMP Devices, and Assigning a Root View to a User. To create a device folder: 1 In the explorer tree, select the Equipment root folder. 2 Right-click the Equipment folder. A pop-up menu appears. 3 From the pop-up menu, select New and then select Equipment Folder. Figure 39 shows the New dialog box. Figure 39 New Dialog Box

4 Type a label and click OK. The device folder you just created appears as a sub-folder under the Equipment root folder. Now you can add SNMP devices to the folder, or create equipment bays and racks. For more information, refer to Discovering Single SNMP Devices, Discovering Multiple SNMP Devices, and Creating Equipment Bays and Racks.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

92

Chapter 4: Provisioning

Creating Equipment Bays and Racks

Optionally, to organize SNMP devices, you can create virtual equipment bays and racks. Bays and racks are specialized containers you can create in individual sub-folders under the Equipment root folder. Bays contain racks but racks cannot contain bays. Figure 40 shows the relationship between a bay and a rack in the CEM explorer tree. Figure 40 Bays and Racks in CEM

To create an equipment bay or a rack: 1 First, create a device folder under the Equipment root folder. If you do not have one, refer to Creating Device Folders. 2 In the explorer tree, select a sub-folder under the main Equipment folder. Figure 41 shows how to select an equipment folder. Figure 41 Selecting an Equipment Folder

3 Right-click the sub-folder. A pop-up menu appears. 4 From the pop-up menu, select New and then select either Equipment Bay or Equipment Rack.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning SNMP Devices

93

Figure 42 shows the New dialog box. Figure 42 New Dialog Box

5 Type a label and click OK. The bay or rack appears under the equipment sub-folder you created earlier. Now you can add SNMP devices to the bay or rack as described in Discovering Single SNMP Devices and Discovering Multiple SNMP Devices. Or, if you have created a bay you can create one or more subordinate racks under it. Discovering Multiple SNMP Devices The discovery feature allows you to automatically add a large number of managed SNMP devices to a device folder, bay, or rack by entering a range of IP addresses. The discovery executes in the background and displays a status dialog with the IP address and sysObjectID of each discovered device. The target device folder remains locked throughout the entire process. At the end of discovery, a dialog box summarizes how many devices were discovered in the requested range. To discover multiple SNMP devices: 1 In the explorer tree, right-click a device folder, bay, or rack under the Equipment root folder. To create a new device folder, bay, or rack, refer to Creating Device Folders and Creating Equipment Bays and Racks. 2 From the pop-up menu, select Discover and then select Range of SNMP Devices.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

94

Chapter 4: Provisioning

Figure 43 shows the Discovery dialog box. Figure 43 Discovery Dialog Box for SNMP Devices

3 In the Discovery dialog box, enter the appropriate discovery parameters. Table 17 lists the discovery parameters for the device discovery dialog box. Table 17 Discovery Parameters
Parameter Starting IP Address Ending IP Address IP Class Address Checking Subnet Mask Timeout (sec) Retrys SNMP Version Read Community Description The first IP address in the range to be queried. The last IP address in the range to be queried. Make sure that the Ending IP Address is greater than or equal to the Starting IP Address. This parameter is used only during IP range discovery. If you select this parameter (recommended), CEM will automatically skip over network and broadcast addresses based on the subnet mask. The subnet mask for this SNMP device. The SNMP time out, in seconds. The default is 1. The number of times CEM will retry connecting to an SNMP device. The default is 0. The SNMP version number. The SNMP Read Community string for access to the devices. This should match the Read Community string of the devices to be discovered. The SNMP Write Community string. This should match the Write Community string of the devices to be discovered.

Write Community

4 If you are using SNMPv1 or v2c, go to step 12. If you are using v3, continue with step 5.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Provisioning SNMP Devices

95

5 When you select v3 for the SNMP Version, the dialog box changes to reveal three new fields. Figure 44 shows the Discovery dialog box with SNMPv3 options. Figure 44 Dialog Box for SNMPv3 with No Authentication

6 In the Discovery dialog box, enter the appropriate SNMPv3 parameters. Table 18 lists the additional discovery parameters for SNMPv3 with no authentication. Table 18 Additional Discovery Parameters for SNMPv3 with No Authentication
Parameters Context Name Contact Engine ID Description For SNMPv3, leave this field blank. For SNMPv3, enter #.

If you are not using authentication, go to step 12. If you are using authentication, continue with step 7. 7 To use authentication for SNMPv3, select MD5 or SHA from the Authentication drop-down list. The Discovery dialog box changes to reveal three new fields.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

96

Chapter 4: Provisioning

Figure 45 shows the Discovery dialog box with additional SNMPv3 options. Figure 45 Dialog Box for SNMPv3 with Authentication and No Encryption

8 In the Discovery dialog box, enter the appropriate parameters. Table 19 lists the additional discovery parameters for SNMPv3 with authentication and no encryption. Table 19 Additional Parameters for SNMPv3, Authentication and No Encryption
Parameters User Name Password Privacy/Encryption Description Enter the user name. The default is manager for most NewNet SNMP devices. Enter the password. The default is manager for most NewNet SNMP devices. From the drop-down list, select none for no encryption or select CBCDES encryption. Verify that the equipment supports authentication encryption before selecting an encryption type.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning SNMP Devices

97

9 If you are not using encryption, go to step 12. If you are using encryption, continue with step 10. 10 To use encryption for SNMPv3, select CBCDES from the PrivacyEncryption drop-down list. The Discovery dialog box changes to reveal a new field. Figure 46 shows the Discovery dialog box with additional encryption options. Figure 46 Dialog Box for SNMPv3 with Authentication and Encryption

11 In the Discovery dialog box, enter a privacy key in the Privacy Key field. 12 Click OK. The Device Discovery progress dialog box opens and shows the IP address and sysObjectID of each discovered device. Figure 47 shows the SNMP device progress dialog box. Figure 47 Device Discovery Progress Dialog Box

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

98

Chapter 4: Provisioning

The device discovery process may several minutes. You may click Cancel to gracefully stop discovery at any time. At the end of discovery, a dialog box summarizes how many devices were discovered in the requested range. CAUTION: Depending on the number of sub-elements within an SNMP device (for example, cards with multiple spans and DS0s), the sub-element discovery may still be in progress even if the Device Discovery dialog box indicates that the discovery is complete. Make sure an SNMP device and all its sub-elements are completely discovered before attempting to configure the device. Figure 48 shows the SNMP device discovery summary dialog box. Figure 48 Device Discovery Summary Dialog Box

13 When complete, click Close. Discovering Single SNMP Devices The discovery feature also lets you add devices one at a time. To discover multiple SNMP devices, refer to Discovering Multiple SNMP Devices. To discover a single SNMP device: 1 In the explorer tree, right-click an equipment sub-folder, bay, or rack under the Equipment root folder. If you want to create a new folder, rack, or bay, see Creating Device Folders and Creating Equipment Bays and Racks. 2 From the pop-up menu, select Discover or and then select Single SNMP Device.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning SNMP Devices

99

Figure 49 shows the New Device dialog box. Figure 49 New Device Dialog Box

3 In the New Device dialog box, enter the appropriate discovery parameters. Table 20 lists the discovery parameters for the device discovery dialog box: Table 20 Discovery Parameters
Parameter Hostname/IP Address Timeout (sec) Retrys SNMP Version Read Community Description The IP address of the SNMP device to be discovered. The SNMP time out, in seconds. The default is 1. The number of times CEM will retry connecting to an SNMP device. The default is 0. The SNMP version number. The SNMP Read Community string for access to the devices. This should match the Read Community string of the devices to be discovered. The SNMP Write Community string. This should match the Write Community string of the devices to be discovered.

Write Community

4 If you are using SNMPv1 or v2c, go to step 11. If you are using v3, continue with step 5. 5 When you select v3 for the SNMP Version, the dialog box changes to reveal three new fields.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

100

Chapter 4: Provisioning

Figure 50 shows the New device dialog box with SNMPv3 parameters. Figure 50 Dialog Box for SNMPv3 with No Authentication

6 In the New Device dialog box, enter the appropriate SNMPv3 parameters. Table 21 lists the additional discovery parameters for SNMPv3 with no authentication. Table 21 Additional Discovery Parameters for SNMPv3 with No Authentication
Parameter Context Name Contact Engine ID Description For SNMPv3, leave this field blank. For SNMPv3, enter #.

If you are not using authentication, go to step 11. If you are using authentication, continue with step 7. 7 To use authentication for SNMPv3, select MD5 or SHA from the Authentication drop-down list. The New Device dialog box changes to reveal three new fields.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning SNMP Devices

101

Figure 51 shows the New device dialog box with additional SNMPv3 parameters. Figure 51 Dialog Box for SNMPv3 with Authentication and No Encryption

8 In the New Device dialog box, enter the appropriate parameters. Table 22 lists the additional discovery parameters for SNMPv3 with authentication and no encryption. Table 22 Additional Parameters for SNMPv3, Authentication and No Encryption
Parameters User Name Password Privacy/Encryption Description Enter the user name. The default is manager for most NewNet SNMP devices. Enter the password. The default is manager for most NewNet SNMP devices. From the drop-down list, select none for no encryption or select CBCDES encryption. Verify that the equipment supports authentication encryption before selecting an encryption type.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

102

Chapter 4: Provisioning

If you are not using encryption, go to step 11. If you are using encryption, continue with step 9. 9 To use encryption for SNMPv3, select CBCDES from the PrivacyEncryption drop-down list. The Discovery dialog box changes to reveal a new field. Figure 45 shows the Discovery dialog box with additional encryption options. Figure 52 Dialog Box for SNMPv3 with Authentication and Encryption

10 In the Discovery dialog box, enter a privacy key in the Privacy Key field. 11 Click OK. The Device Discovery progress dialog box opens and shows the IP address and sysObjectID of each discovered device.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning SNMP Devices

103

Figure 53 shows the SNMP device progress dialog box. Figure 53 Device Discovery Progress Dialog Box

The device discovery process may take a long time. You may click Cancel to gracefully stop discovery at any time. At the end of discovery, a dialog box summarizes the discovery and displays a Finished icon. Figure 54 shows the SNMP device discovery summary dialog box. Figure 54 Device Discovery Summary Dialog Box

Even after the Finished icon shows, discovery may still be going on at the sub-element level of some of the components of the SNMP device. If this is the case, the Working icon will show next to those components in the explorer tree on the left side of the screen. 12 When complete, click Close.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

104

Chapter 4: Provisioning

Viewing SNMP Device Identification

CEM provides the following information for every discovered SNMP device. To view basic identification information for an SNMP device: 1 From the explorer tree, select the SNMP device as shown: Figure 55 SNMP Device Selection

2 In the right pane of the main window, select the Identification tab. The Properties view changes to show the Identification tab. 3 Use the Identification tab for your customized needs. Table 23 lists the values for the Identification tab. Table 23 Identification Tab Values
Field Class Description Specifies the internal schema className for this object. Schema classNames are CEM internal class names and do not have any relationship to MIB classes. Specifies the fully qualified name of this object. This is the complete path from the root of all objects. Specifies the DNS host name. Specifies the IP address used for all SNMP operations. Specifies the physical location of this equipment. This field usually designates in which equipment folder a particular SNMP device is found. It also can list the chassis location of a particular card or blade. Settings Read-only field

FQN

Read-only field

Hostname IP Address Location

Read-only field xxx.xxx.xxx.xxx string

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning SNMP Devices

105

Table 23 Identification Tab Values (continued)

Field User Label Description Specifies the label assign by the user. Use this field to add a customized name, or label, to a particular SNMP device. Specifies the vendor name of an SNMP device. Settings string

Vendor Version

Read-only field

Specifies the software version of an SNMP device Read-only field

4 To edit a property on the tab, double-click it and select the desired setting. 5 Click Save All. Provisioning Read and Write Community Strings To change read and write community strings for the SNMP manager:

1 From the explorer tree, select the SNMP device. Read and write community strings only affect SNMPv1 and SNMPv2c devices. 2 In the right pane of the main window, select the SNMP Options tab. 3 Double-click the Read Community field, and type the desired read community string. 4 Double-click the Write Community field, and type the desired write community string. 5 Click Save all. Common SNMP Device Configuration Each SNMP device contains basic functionality and statistics derived from standard MIBs (for example, RFC MIBs). These configurables and statistics are considered common across all SNMP devices, not just NewNet-specific devices. For more information on these configurables and statistics, refer to Appendix B, SNMP Device Common Configuration Tabs. You can export SNMP devices, device folders, bays, and racks contained in the Equipment root folder to a plain text file and then import them back into another CEM server instance. This is not a database backup, just a plain text file that can be read by the same CEM server or a different CEM server. For example, this feature allows you to save your list of SNMP devices, device folders, bays, and racks prior to upgrading the CEM server. Exporting SNMP Devices To export SNMP devices and folders from the Equipment root folder: 1 In the explorer tree, right-click the Equipment root folder. A pop-up menu appears. 2 From the pop-up menu, select Devices and then select Export.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

Exporting and Importing SNMP Devices

106

Chapter 4: Provisioning

Figure 56 shows the Equipment:Export dialog box. Figure 56 Exporting Equipment

CEM exports the list of SNMP devices as a plain text file (equipment.tsv) into the root directory folder where the CEM software files are located. For example: c:\cem 3 When finished, click Close. 4 If you are going to use this list of SNMP devices for another CEM server, copy and paste the text file from this workstation into the directory on the other CEM server where the CEM software files are located. Importing SNMP Devices To import SNMP devices and folders into the Equipment root folder: 1 Make sure the equipment.tsv file is saved in the root directory folder where the CEM software files are located. For example: c:\cem 2 In the explorer tree, right-click the Equipment root folder. A pop-up menu appears. 3 From the pop-up menu, select Devices and then select Export. CEM imports the list of SNMP devices into the CEM GUI client and creates a new folder and SNMP device in the explorer tree for each device found in the equipment.tsv file. Also, all community strings and SNMP version parameters are mirrored from the equipment.tsv file. 4 When finished, click Close.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Map/Topology Views

107

Provisioning Map/Topology Views

The Map or topology view consists of a map-style view of the current equipment hierarchy. Provisioning for this view consists with the ability for the operator to manually specify/establish dependent connection between equipment in the containment hierarchy. Selecting the Map tab on the left-hand side of the GUI accesses the Map view: Figure 57 shows the Map tab location. Figure 57 Map Tab

Map View

Like the Explorer and List views, this is an independent view of the Equipment in CEM. A Map view is a specialized view of the equipment containment hierarchy. There is exactly one Map view for each Equipment Folder, Rack or Bay in CEM. The equipment contained in a specific map is the same as the equipment contained in the folder.

n n

Figure 58 shows the relationship between the Wireless equipment folder and its associated Map view. Figure 58 Equipment Folder to Map View Relationship

Notice: In the example, The Wireless folder contains five (5) child folders. These same five child folders are show in the associated Wireless Map.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

108

Chapter 4: Provisioning

The only way to modify the contents of a Map is by changing the contents of the folder in the explorer tree, for example:
n n n n

Moving equipment to a different folder Discovering additional equipment Creating a new folder Deleting equipment or folders

The elements shown on a specific Map are identical to the elements in the Equipment containment hierarchy. They use the same icon, label, and appropriate state icon. The Map view will be identical for all logged in operators. If one operator changes the makeup, background, or the location of an element within a specific Map, other operators will automatically see those same changes. As the individual map element's state changes, it will automatically be updated on the Map view. There is no need to "Refresh" the Map. Map View Components Figure 59 shows the various components that make up the Map view. Figure 59 Map View Components
Map Selection Auto Connect On/Off

Back Button

Map Background

Zoom Control

Map Background Selection

Clear Map Background

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Map/Topology Views

109

Table 24 Map View Components

Component Map Background Back Button Map Selection Zoom Control Map Background Selection Clear Map Background Auto Connect On/Off Description All maps can have an optional background image. In this example, no background has been set Used to back up to the previous Map level Used to select viewing a specific Map Used to zoom in/out Used to select a specific background image Use to remove/clear the current background image, if any Turns the Auto Connect feature on or off for the Map View

Selecting Map Elements Any map element may be selected. When an element is selected, it will be outlined in RED and the properties panel will show all the detail of the selected element's just like selecting any item in the Explorer view. Clicking the right mouse button brings up the usual popup menu for the selected map element. Note: the mouse pointer must be within the area bounded by the RED selection box:. Figure 60 shows the selected Map element popup menu. Figure 60 Map Element Popup Menu

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

110

Chapter 4: Provisioning

Map Background Popup Menu Right-clicking on the map, outside the red selection boundary of any element, displays the popup menu for the map. Figure 61 shows the Map popup menu. Figure 61 Overall Map Popup Menu

This popup menu is the same as if the operator selected the Equipment Folder associated with this Map. Important Note: Using the Map Background popup menu allows the operator to discover and populate additional equipment using the Map view itself. Navigating Folders To open an Equipment Folder, double-click the folder icon. After opening a folder, click the Back Button to return to the original folder.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Map/Topology Views

111

Selecting a Specific Map The Map Selection list will contain a list of all Equipment Folders in the equipment containment tree. To view a specific Map, simply select one from the list. Figure 62 Map Selection

Important Note: The Map Selection list will contain an entry for all Equipment Folders. If there are more than one equipment folder with the same label, they will all be shown. Moving Map Elements Map elements may be moved by simply selecting the item to be moved and dragging it to a new location. While being dragged to a new location, the outline will turn BLUE. Once the mouse button is released, the outline will again turn RED. The location of the map element is the same for all operators. If one operator moves an element, other operators will see the element moved to the new location. Important Note: All map elements are initially positioned in the center of a Map. If a Map is viewed for the first time, all map elements will appear to be on top of one another. The operator should simply move each of them to a specific location on the map. Setting a Map Background Image Use the Map Background selection button to select the appropriate background image for the map. When the button is clicked, a standard File Selection box will be displayed using a GIF and JPG file filter. The operator can navigate to any directory/folder on the GUI Client machine to select the appropriate background image:

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

112

Chapter 4: Provisioning

Figure 63 Standard File Selection Dialog Box

Note that the background image file is selected from the GUI Client machine then transferred to the CEM Server. Hence the background image file is actually stored on the CEM Server and available to all GUI Clients. Important Note: The image file itself may be any size. CEM will automatically resize the background image to fit in the fixed size of the scrollable Map view. It is recommend that the image file itself be close to the 800 x 800 pixel pallet size of the Map View to minimize any distortion. CEM does not include any standard background image files. Most are copyright by the original author and subject to royalty fees.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Map/Topology Views

113

Once a Map Background is selected, the Map View will show the background image. See Figure 64. Figure 64 Map Background

Clearing the Background Image Click the Clear button to clear the background image. Use the Zoom control to zoom in or out of the overall Map view. Working with Static Connections CEM provides the ability to establish a static connection between equipment is to highlight application-level dependencies between equipment. For example:
n

All PDSN cards should be connected to their respective FACN that is routing traffic to it. All Home Agent cards should be connected to their respective AAA/RADIUS servers that they use for authentication and accounting. All NMC cards should be connected to the their respective NTP server.

This static connection is not meant to show physical connections between equipment. By default, the elements on a Map do not show any connections between them. Static connections must be manually established.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

114

Chapter 4: Provisioning

Considerations in Establishing Static Connections Connection relationships should be established between objects to the lowest level of containment as possible. Consider an NMC that might be configured to synchronize its time from an NTP server. The connections is with the NTP Server. But, from which object should the connection be established? We could choose the NMC Card, Chassis, or NewNet SNMP Element. In this example, the connections should be established from the NMC SNMP Agent to the server running the NTP service. Establishing Static Connections Static connections should be established using the Explorer view of CEM. To establish a connection between two elements: 1 Click on the Explorer tab to switch to the Explorer view. 2 Right-click on the desired element and select Static Connections, then select Edit. The Select tree nodes window appears: Figure 65 Select Tree Nodes Window

3 Select the other dependent element. 4 Click OK. Once the OK button is chosen, a dependent static connection is recorded between the two elements.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Map/Topology Views

115

Viewing Static Connections in Explorer View The connections to or from equipment is displayed on the Related property tab in the right-hand pane. Figure 66 Static Connection To or From an Element
.

Viewing Static Connections in Map View The Map view displays static connections with a line. Figure 67 Static Connections Viewed on the Map

In Map view not all elements are displayed. If a static connection is made to or from a lower level elements (subelements), you must select the AutoConnect option. A dotted line is used to show indirect, or aggregate connections to these elements.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

116

Chapter 4: Provisioning

The color of the connecting line will be based on the Operational State of the equipment at both ends of the connection: Table 25 Connection Line Color Code
Color green yellow red State Description Operational state of both ends of the connection is enabled. Operational state of either end of the connection is disabled. Operational state of both ends of the connection is disabled.

Provisioning Table Data Loading

Using the Table loading button on the CEM toolbar (refer to Toolbar), you can select how the CEM GUI loads SNMP table data when the table has more rows than can fit on the screen. Two table loading modes are available to you:
n

Continuously load table data. After CEM completely loads the table, CEM allows you to scroll through the table without pausing Line by line, as you scroll down in a full on-screen table display. CEM loads only the visible rows, but pauses to load additional rows when you scroll down.

The default data loading mode for CEM is line by line table loading. This setting is synchronized with the Background Table Loading setting in the User Options dialog box. Refer to Customizing the GUI Client Environment for information about the User Options dialog box. To change the table data loading from one mode to the other, do one of the following steps: 1 If the Table loading indicator is green: CEM is set to load table data continuously. Click Table loading. The Table loading indicator changes to red, and CEM changes to loading the table data line by line as you scroll down in a full on-screen table display. 2 If the Table loading indicator is red: CEM is set to load table data line by line as you scroll down in a full on-screen table display. Click Table loading. The Table loading indicator changes to green, and CEM changes to loading the table data continuously.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning the Logical Log Size and Log Full Action

117

Provisioning the Logical Log Size and Log Full Action

Logical logs represent a subset of all events stored in the database that share a common categorization. For example, all SNMP traps or all operator audit events. You can view these records from the Event Viewer. For more information, refer to Using the Event and Alarm Viewer. When the number of event records in a logical log reaches the maximum, CEM can either stop logging altogether or wrap the events within the Event Viewer based on the Max Size configuration. To purge all excess event records in the logical log, refer to Purging Log Events.

Viewing the Current Logical Log Settings

To view the current logical log settings: 1 In the explorer tree, select one of the logical logs. 2 In the left-hand pane of the CEM GUI main window, select Configuration. Refer to Figure 68. Figure 68 Logical Log Configuration Tab

3 Click Refresh all. This tab displays the following information:

n n

Current Size - the current number of event records in the logical log. Log Full Action - Whether the log wraps or halts when the Max Size is exceeded. Max Size - The maximum number of records allowed before the Log Full Action is executed. 0 or blank means there is no maximum size.
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

118

Chapter 4: Provisioning

Maximum Record Age - The maximum age records can reach before being purged. If this field is blank or set to zero then there is no maximum record age. Purge after idle - The number of seconds CEM can be idle before the logs are purged. If this field is blank or set to zero then records are not purged when CEM is idle. Purge daily at - The time of day (in 24-hour format) that the purge policy is enforced. If this field is blank there is no daily purge.

To use the Alarm Threshold % feature, you must configure the onThresholdReached script and set it to run according to your customized needs. For more information, contact your NewNet customer service representative. Provisioning the Logical Log Size and Log Full Action To provision the log size and full action for a particular logical log:

1 From the explorer tree, right click one of the logical logs. 2 From the pop-up menu, select Edit Purge Policy. The SNMP Trap Log Purge Policy window appears. Refer to Figure 69. Figure 69 SNMP Trap Log Purge Policy

3 To set a maximum log size, check the Maximum checkbox and enter the number of records the log can hold. The default setting is 100. The maximum size is limited to the underlying database technology being deployed and the amount of free disk space available. To not set a maximum either uncheck the Maximum checkbox or set the field to zero. When purging events, CEM purges all excess events and makes the Current Size equal the Max Size. 4 Select halt or wrap from the drop-down list. This configurable indicates the action to take when the number of event records reaches the maximum, as specified in the Maximum Log Records field. If set to halt, CEM stops all event logging for this logical log. If set to wrap, the Event Viewer will delete the oldest event and insert the most recent event. The size of
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Provisioning How Often CEM Polls for Operational State

119

the logical log will stay consistent with the Max Size field. The default setting is wrap. 5 Click Save all. To configure the purge settings, refer to Purging Log Events.

Provisioning How Often CEM Polls for Operational State

This feature controls how often CEM polls all of the SNMP devices to update and validate the operational state. To provision how often CEM polls for operational state: 1 In the explorer tree, select the CEM server root node. The CEM server is the first node in the explorer tree. Typically, it is the hostname of the workstation where your CEM server resides. 2 In the left-hand pane of the CEM GUI main window, select Configuration. Refer to Figure 70. Figure 70 CEM Root Node Configuration Tab.

3 In the Automatic State Update Interval field, enter the interval, in minutes, between automatic state updates. Set this value to zero (0) to turn off automatic state updates. 4 In the Automatic State Update on Trap field, choose on to allow CEM to poll the state of the specific equipment when a non-informational trap is received from that equipment.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

120

Chapter 4: Provisioning

CAUTION: When changing this value, it is important to remember that the lower the value, the more frequently the SNMP device is polled and the more frequently the device database is updated with status information. If you have a large network, continuously polling all SNMP devices for new events severely impacts the rate at which CEM can log events. Before changing the stateUpdate field, please contact your NewNet customer representative. 5 Click Save all.

Modifying Server Properties

The server.properties file is a text configuration file stored in the CEM server root directory. This file determines many CEM server parameters and behaviors. CEM server reads the information from the server.properties file whenever it starts. To prevent damage or misconfiguration of the server.properties file, never edit this file. Another similar file which can be edited, override.properties, is read after the server.properties file during CEM server startup. Any variables which have been modified are populated in the server.properties file by CEM server. When CEM is installed for the first time, no override.properties file exists. To customize CEM server: 1 Create a text file named override.properties in the new CEM root installation directory. 2 Open server.properties and copy any sections which need to be modified, and paste the variables in the override.properties file. For example, to change the default port used by the CEM FTP Server, paste the following line to the override.properties file:
FtpServer.server.config.port=21

3 Modify the variable as needed. For example, change the port number to 22:
FtpServer.server.config.port=22

4 Save your changes in the override.properties file. 5 Close the server.properties file without making any changes. 6 Start CEM server. When CEM server is started, it reads both the server.properties file and the override.properties file, and automatically updates the server.properties file. Any changes you make in override.properties are kept in that file. In this way, override.properties provides a useful way to track customization to CEM server.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Embedded and External Database Options

121

Embedded and External Database Options

CEM uses a relational database to store device information and present it to system users through the GUI and CLI clients. When you initially discover devices, CEM populates the database; therefore, this allows you to manage each device and its associated MIB attributes without having to rediscover each device. You can also view real-time events and traps which are logged to the database. There are two database configuration options available for you to use:
n

Embedded Databases-NewNet provides an internal, embedded database within CEM. CEM uses this database by default. Embedded databases are used primarily for smaller deployments. External Databases-For larger deployments, NewNet allows you to use an external database from an approved vendor.

Embedded Databases

By default, CEM comes bundled with an internal, embedded database. CEM uses the open source InstantDB as the default embedded database. Features and Benefits Using the internal, embedded database provides the following features and benefits:
n

The embedded database is pre-provisioned and has very little administration overhead. It is easy to use and requires no previous database expertise. The Java Database Connectivity (JDBC) database connection and interface drivers come bundled with CEM. When the CEM server runs, a database instance is run along with it; therefore, there is no need to start, provision, or maintain the database separately from CEM. By default, CEM is pre-configured to use the embedded database upon initial system startup. This features allows you to run CEM out-of-the-box, without any need to provision external applications. CEM provides basic database tools and options, including database backup and export and import routines. The embedded database operates with all supported platforms and no platform-specific administration is necessary.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

122

Chapter 4: Provisioning

Figure 71 shows the location of an embedded database in relationship to the Java Virtual Machine (JVM). Figure 71 Embedded Databases

Limitations InstantDB databases are used primarily to manage a small number of network entities. For larger networks, use an approved external database. For more information, refer to External Databases. If you need help sizing your specific deployment, contact your NewNet customer service representative. Despite its flexibility, InstantDB has specific limitations:
n

InstantDB is a single-user database. InstantDB will not allowexternal SQL/database tools to simultaneously access the database. Neither database replication nor database redundancy is offered with InstantDB. In some situations, you may need to compact the embedded databases in your network. For more information, refer to Compacting Embedded Databases on Server Startup.

Provisioning Embedded Databases By default, CEM is pre-configured to use the embedded InstantDB database. All options are already bundled with the CEM software package and no additional configuration is necessary. If you would like to view default database connection options for the InstantDB database, review the Instant DB section of the server.properties file. CAUTION: Before changing any default database connection option in the Instant DB section of the server.properties file, contact your NewNet customer service representative.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Embedded and External Database Options

123

Maintenance Options The only maintenance options available for InstantDB databases are found from the CEM server command prompt. Use these commands to compact existing databases and to export and import databases. For more information about these commands, refer to Command Line Interface Reference. External Databases For larger networks, NewNet allows you to use an external database from an approved vendor. CEM supports external databases from two vendors:
n n

Oracle MySQL

All other external databases listed in the server.properties file (MS/Access and SQL Server) are not supported for this release. Features and Benefits Using an external database provides the following features and benefits:
n

External databases are customized for a specific platform and optimized to run more efficiently on the platform of choice. External databases are more scalable than embedded databases. It is possible to procure support contracts for the provisioning and maintenance of external databases. External databases normally come with tools and features that you can use to optimize the database usage. Such features include database backup and import and export functions.

n n

Figure 72 shows the location of an external database in relationship to the Java Virtual Machine (JVM). Figure 72 External Databases

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

124

Chapter 4: Provisioning

Deploying on a CEM Server If you deploy an external database on the CEM server itself, use the following minimum hardware requirements, which differ from the original requirements found in Table 7:
n

CPU-If the CPU speed requirements from the external database vendor conflict with the original CEM requirements, use the faster of the two speeds. RAM-Use the summation of memory requirements required for both CEM and the external database, which is provided by the database vendor.

Deploying on a Dedicated Server If you deploy an external database on a dedicated database server, the minimum hardware requirements are determined by the requirements for that specific platform. These requirements are completely independent from the CEM server hardware requirements. If you deploy an external database on a dedicated database server, increased latency in the fulfillment of database requests may occur as a result of network overhead. Provisioning Oracle External Databases CEM uses JDBC database connection and interface drivers to communicate with external databases. JDBC drivers are available from the external database vendor. Usually, JDBC drivers are either bundled as a part of the product or made available from a support website. CEM allows you to deploy either Oracle or MySQL external databases in your network. To use Oracle external databases with CEM: 1 Install the Oracle database according to the installation instructions provided by the vendor. 2 To make sure that CEM can find the correct libraries to load when connecting to the external database, download the JDBC drivers and place them in the following folder on your CEM server: <jre_home>/jre/lib/ext where <jre_home> is the installation location of the JRE (Java Runtime Environment) being used to run CEM. For more information on the correct JRE version to use, refer to Platform and Operating System Requirements. 3 Using the standard Oracle administrative tools, create a new, blank database. Do not provision the external database tables and schemas. When CEM detects a blank database, CEM will automatically create all of the necessary tables and provision them according to your customized needs.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Embedded and External Database Options

125

4 Using the standard Oracle administrative tools, provision a user account on the database for use by the CEM server. For more information on database users, refer to Multiple User Access for External Databases. 5 Copy the Oracle Server section of the server.properties file to the override.properties files (see Modifying Server Properties), and uncomment each section and provision according to your customized needs:
#### Oracle Server ##### DBDriver=oracle.jdbc.driver.OracleDriver DBURL=jdbc:oracle:thin:@<server_name>:<port_number>:<database _name> DBLong=NUMBER DBEmbeddedQuote='' DBFile= DBUserName=<database_username> DBPassword=<database_password>

Table 26 lists the fields in the Oracle Server section of the server.properties file and gives descriptions and default values. Table 26 Oracle Server Section of the server.properties File
Field DBDriver DBURL Description The Java classname of the JDBC driver. The URL used to connect to the database. Each database vendor specifies a unique format for this field. Default oracle.jdbc.driver.OracleDriver jdbc:oracle:thin:@<server_name>: <port_number>:<database_name>

DBLong DBEmbeddedQuote

The SQL data type that can contain NUMBER a long (8-byte) integer. The escape sequence for an embedded single quote character. NOTE: \\ results in a single backslash character. ' ' (two single quote characters)

DBFile

The specific location of the CEM blank database file/directory that contains all data. This is used to compute the database size. NOTE: If you deploy the database on a separate server, you cannot use this option.

DBUserName DBPassword PM.DBURL [optional]

The username used to connect to the database. The password used to connect to the database. URL to connect to a different database for historical data collection. Only used if the optional Historical Data Collection package is installed. Same format as DBURL.

cem cem jdbc:oracle:thin:@<server_name>: <port_number>:<database_name>

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

126

Chapter 4: Provisioning

6 Copy the Instant DB section of the server.properties file to the override.properties file, and comment each field. For example:
#DBUserName=Administrator

7 Save and close the server.properties file. 8 Restart the CEM server. Provisioning MySQL External Databases To use MySQL external databases with CEM: 1 Install the MySQL database according to the installation instructions provided by the vendor. 2 To make sure that CEM can find the correct libraries to load when connecting to the external database, download the JDBC drivers and place them in the following folder on your CEM server:
<jre_home>/jre/lib/ext

where <jre_home> is the installation location of the JRE (Java Runtime Environment) being used to run CEM. For more information on the correct JRE version to use, refer to Platform and Operating System Requirements. 3 Start MySQL. 4 Using the standard Oracle administrative tools, create a new, blank database. For example, if you are using the MySQL console tool, enter:
CREATE DATABASE <database_name>;

where <database_name> is the name of the MySQL database. Do not provision the external database tables and schemas. When CEM detects a blank database, CEM will automatically create all of the necessary tables and provision them according to your customized needs. 5 Create user privileges for the new user account. If a database user has not been created, MySQL creates a new user for you when entering the command in the following example:
GRANT ALL PRIVILEGES ON <database_name>.* to <database_username>'@<cem_server_hostname>' identified by <database_password>';

where <cem_server_hostname> is the DNS lookup name for the CEM server. If the user experiences problems connecting to the database, the command listed above can be repeated and <cem_server_hostname> replaced by the CEM server IP address and netmask. For more information on database users, refer to Multiple User Access for External Databases. For example, 192.168.1.1/255.255.255.0 is an acceptable entry.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Embedded and External Database Options

127

6 Copy the MySQL DB section of the server.properties file to the override.properties file (see Modifying Server Properties), then uncomment each section and provision according to your customized needs:
##### MySQL DB ###### DBDriver=com.mysql.jdbc.Driver DBURL=jdbc:mysql://<hostname>/<database_name> DBLong=BIGINT DBEmbeddedQuote=\\' DBFile=C:\\mysql\\data\\cem DBUserName=<database_username> DBPassword=<database_password>

Table 27 lists the fields in the MySQL DB section of the server.properties file and gives descriptions and default values. Table 27 MySQL DB Section of the server.properties File
Field DBDriver DBURL Description The Java classname of the JDBC driver. Default com.mysql.jdbc.Driver

The URL used to connect to the jdbc:mysql://localhost/cem database. Each database vendor specifies a unique format for a URL. The SQL data type that can contain a long (8-byte) integer. The escape sequence for an embedded single quote character. NOTE: \\ results in a single backslash character. BIGINT \\' (two forward slashes and one single quote)

DBLong DBEmbeddedQuote

DBFile

C:\\mysql\\data\\cem The specific location of the CEM database file/directory that contains all data. This is used to compute the database size. NOTE: If you deploy the database on a separate server, you cannot use this option.

DBUserName DBPassword

The username used to connect to the database. The password used to connect to the database.

cem cem

jdbc:oracle:thin:@<server_name> PM.DBURL [optional] URL to connect to a different :<port_number>:<database_nam database for historical data collection. Only used if the optional e> Historical Data Collection package is installed. Same format as DBURL.

7 Save and close the override.properties file. 8 Restart the CEM server.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

128

Chapter 4: Provisioning

Running Multiple External Databases on a Single Database Server Some external databases allow you to run multiple database instances on the same database server. This can be helpful, especially when a network designer splits the management domain into separate databases, with a separate CEM server managing a different set of SNMP devices (useful for different geographical locations). If you choose to do this, follow these guidelines:
n n

A single CEM server can only connect to a single database instance. CEM servers cannot share database instances. Each CEM server must have exclusive read-write access to a particular database. If you choose to deploy multiple CEM databases on the same database server (for example, CEMDB1 and CEMDB2), only one instance of CEM should ever be connected to any particular database.

Multiple User Access for External Databases Most external database products allow more than one user to simultaneously access a database instance. If you would like to give multiple users read-only access to a database being used by CEM, there is no problem. However, do not allow these users to modify a database being used by CEM. To prevent database corruption, shut down the database before attempting to change any data in the database. External Database Tools and Options If you are using external databases, NewNet does not recommend using the maintenance tools and options bundled with CEM. These option are limited and may not prove to be useful. Instead, use the database tools and options bundles with your external database. For more information, refer to the related documentation for your specific vendor.

Provisioning CEM Server Redundancy

The goal of CEM Redundancy support is to deploy a warm-standby server that can take over all network management capabilities if the primary server fails minimizing (but not eliminating) the amount of database information lost during the switchover. A switchover is the event when the standby server starts providing service because the active server either failed or was taken out of service. Only two servers can be configured as redundant to one another. One CEM Server is the active server while the other is the standby. The active CEM Server actively provides service while the standby CEM server remains inactive until the active server is disabled. The standby server does not communicate with client GUIs or databases while inactive. For more information about CEM server redundancy, refer to CEM Server Redundancy in the Product Overview chapter.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning CEM Server Redundancy

129

To configure redundancy complete the following tasks:

n n n

Verifying CEM Core and Package Version Compatibility Configuring the Redundancy Properties Synchronizing Files

To manually switch from the active to standby server, refer to Performing a Manual Switchover.

Verifying CEM Core and Package Version Compatibility

When running redundant servers, the CEM core build, packages, and package versions MUST be identical on both servers. NewNet does not support running mismatched versions. To verify the core and package version refer to Viewing Software Version and Copyright Information in the Operations chapter. Exception: during an upgrade the servers will temporarily run mismatched versions (while one runs the original core version and the other upgrades to a later version). When the upgraded server comes back online, it will detect that the core versions do not match and will send a warning message to the CEM server console.

Configuring the Redundancy Properties

Provision both CEM servers as redundant to each other. The settings in this section must be provisioned on each server. To configure redundancy: 1 Using a standard text editor, create a new file in the CEM base directory named override.properties. If this file already exists, modify the existing file. 2 Add the redundant.backup property and set it equal to the IP address or hostname of the peer server in the following format address:port. If the port is omitted, CEM assumes the a default port of 1096. For example:
redundant.backup=192.168.10.15:1055

This address must match the value configured in the peer server's redundant.interface property. 3 If this server is multi-homed, add the redundant.interface property and set it equal to the interface address and port this server uses to communicate heartbeats. For example:
redundant.interface=192.168.10.148:1055

If this server is not multihomed then this setting is only required when not using the default UPD port (1096). The default interface address is the same as the ClientInterface. This address must match the value configured in the peer server's redundant.backup property.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

130

Chapter 4: Provisioning

4 Add the redundant.heartbeat.timeout property and set it equal to the number of seconds to wait before declaring that the peer server is down. Configure this property to account for possible transient network connection problems between this CEM server and its peer. The range is from 10 to 30 seconds. This setting is optional. For example:
redundant.heartbeat.timeout=30

This server also has an internal 10-second timer that is used to check when heartbeats have been missed. 5 Save and close the override.properties file. 6 Restart the server. 7 Repeat step 1 through step 6 for the peer server. Make sure to send traps to both servers. Only the active server will process the traps and enter them into the database. If this network uses "trusted" managers", make sure that both CEM servers appear in the trusted manager tables. Synchronizing Files Synchronize or copy the files in the following directories, for both serves, where applicable (not all CEM deployments use all these directories). The CEM server application does not synchronize these folders and files.
n n n n n n n n n n n

<root>/datafiles/... [and all subdirectories] <root>/software_upgrades <root>/map_backgrounds <root>/agw_secondary <root>/historicalDataArchive <root>/arc_filter_files <root>/arc_policy_files <root>/arc_script_files <root>/CDRArchive <root>/configuration_backup <root>/http/reports

Contact your system administrator for file synchronization procedures.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

HP OpenView Integration

131

Performing a Manual Switchover

To force the active server to become the standby, perform one of the following:
n

From the active server's CEM server command prompt, enter the restart command. The active server sends the standby server a shutdown heartbeat. Upon receiving this heartbeat, the standby server assumes the active role. From the standby server's CEM server command prompt, enter the GoActive command. The standby server sends the active server an Active heartbeat. Upon receiving this heartbeat, the active server performs a failsafe shutdown.

HP OpenView Integration

If you already have HP OpenView installed on the workstation housing your CEM server, HP OpenView automatically integrates during CEM package installation. No restart of the CEM server is necessary. The automatic integration process creates a NewNet option under the Misc menu in the HP OpenView window. NewNet devices appear in the Connector category. If you purchase HP OpenView later and want to use HP OpenView with CEM, use the following procedures to manually integrate the two software components. For more information on HP OpenView system requirements, refer to HP OpenView Installation Issues. To start the CEM GUI client using HP OpenView, refer to Starting the CEM GUI Client Using HP OpenView.

Manually Integrating HP OpenView

To manually integrate HP OpenView and CEM: 1 To verify that the HP OpenView daemons are running, execute the ovstatus command from the /opt/OV/bin (default location) folder. If the HP OpenView daemons are not running, execute the ovstart command from the /opt/OV/bin folder (default location) to start them. 2 From the CEM server command prompt, enter the following command from the CEM server command prompt:
hpov_integration

When prompted to enter the path to HPOpenview, enter the directory that contains HPOpenview's bin directory. For example, if HPOpenview is started from /opt/OV/bin, enter /opt/OV. Logs of the integration are located in the ../CEM/hopv/integration/hpov_install.log file. To remove HP OpenView integration, refer to Removing HP OpenView Integration.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

132

Chapter 4: Provisioning

Provisioning HP OpenView to Collect SNMP Traps

If HP OpenView starts after CEM is already running, HP OpenView will not be able to collect traps because the 162 trap port will be controlled by CEM. To enable HP OpenView to collect traps, use one of the following two options: 1 Stop the CEM server, allowing HP OpenView to take control of the 162 trap port. 2 Before starting or restarting the CEM server, disable the receive traps option. a In the CEM root folder, open the server.properties file. b Copy the SNMP Trap Listening section to the override.properties file c Close server.properties. Do not make changes to this file. d Change the value of receiveTraps from yes to no in override.properties. e Save and close the override.properties file. f Restart the server.

Provisioning SNMP Trap Forwarding

You can provision CEM to forward SNMPv1 and SNMPv2c traps to another management station. CEM does not support forwarding traps using SNMPv3 credentials. When forwarding a trap received from a device to another management platform, CEM cannot be allowed to translate between appropriate SNMP protocols. If it received an SNMPv1 trap, it must forward it as an SNMPv1 trap to remain transparent. To provision CEM to forward traps: 1 Using a standard text editor, open the server.properties file. 2 Copy the SNMP Trap Forwarding section to the override.properties file. Refer to Modifying Server Properties. 3 Close the server.properties file without making changes. 4 In the override.properties file, locate the SNMP.forward field and change the SNMP version, host, port, and community string as needed. List each management station in the following format, separated by a comma: SNMP.forward=version:host:port:community

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Memory and Disk Size for Different Network Sizes

133

For parameter definitions, refer to Table 28. Table 28 SNMP.forward Parameters

Parameter version host port community Definition The SNMP version accepted by the management station. The version can be SNMPv1 or SNMPv2 The hostname or IP address of the management station The management station port which receives traps The read community string for the management station Default SNMPv1 162 public

For example: SNMP.forward=SNMPv1:192.168.115.108:162:public, SNMPv2:192.168.10.112:162:public 5 Uncomment the SNMP.forward line. Figure 73 shows how to uncomment the SNMP.forward line. Figure 73 Uncommenting the SNMP.forward Line
remove the pound sign

#SNMP.forward=SNMPv1:192.168.115.108:162:public 6 Save and close the override.properties file. 7 For these changes to take effect, stop and restart the CEM server.

Provisioning Memory and Disk Size for Different Network Sizes

Allocating Memory for Server and Clients

For large networks, additional CPU and RAM capacity will be needed. For more information on CEM server sizing for your specific deployment, please contact your NewNet customer service representative. Java allocates only a small default amount of memory to each application. On most platforms, this number is close to 64 MB. This means that even if your system is configured with more memory, Java will only allocate a maximum of 64 MB for use. If your workstation uses more than the maximum amount of memory, and Out Of Memory error occurs. Individual startup scripts can control the amount of memory allocated to the CEM server and individual CEM clients. Configure the variable MemorySize to make use of as much memory as required by your particular CEM application. Specify the value of RAM to be allocated by the numerical value in MB followed by the letter m. The MemorySize parameter is simply the maximum amount of memory that the Java Virtual Machine (JVM) will request from the host system, and does not guarantee that the host system can actually allocate that amount.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

134

Chapter 4: Provisioning

Example

For example, to allocate 512 MB of RAM, set the value of the MemorySize variable in the script named below as follows: MemorySize=512m.
n

CEM server-runServer on UNIX platforms or runServer.bat on Windows platforms CEM GUI client-runGUIClient on UNIX platforms or runGUIClient.bat on Windows platforms CEM CLI client-runCLIClient on UNIX platforms or runCLIClient.bat on Windows platforms

Provisioning the Display of Non-supported MIB Objects in the CEM GUI

All MIB objects that are not supported by the device are automatically hidden in the GUI client. However, if you prefer to see non-supported MIB objects in the GUI as Not Supported, use this procedure. To provision the CEM GUI client to display non-supported MIB objects: 1 Using a standard text editor, open the client.properties file located in the root CEM directory. 2 Uncomment the showNoSuchName=yes line to enable the GUI client to view non-supported MIB objects. Figure 74 shows how to uncomment the showNoSuchName line. Figure 74 Uncommenting the showNoSuchName Line
remove the pound sign

#showNoSuchName=yes 3 Save and close the client.properties file. 4 For these changes to take effect, stop and restart the CEM GUI client.

Provisioning the Default Refresh Rate for the GUI Client

The refresh rate value for a device visual (the GUI client) is set to 0 by default. The 0 means that the display is not automatically refreshed. If you change this value to any other number, this specifies how frequently the CEM server polls an SNMP device for its device status. You can also provision the default refresh rate by using the device visual. For more information, refer to Viewing Virtual Panel Displays. To provision the default refresh rate for the GUI client: 1 Using a standard text editor, open the client.properties file. 2 Change the value of the mimic.refresh field from 10 to a number based on your customized needs.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning the Default Maximum PDU Size for SNMP Device Discovery

135

CAUTION: When changing this value, it is important to remember that the lower the value, the more frequently the SNMP device is polled and the more frequently the device database is updated with status information. In general, setting this value in the 30 through 60 second range will not significantly impact other operations. Values less than 30 seconds should only be selected in certain trouble locating and clearing cases when the CEM server does not need to perform other operations. For more information, contact your NewNet customer service representative. 3 Uncomment the mimic.refresh line to change the default refresh rate for the GUI client. Figure 75 shows how to uncomment the mimic.refresh line. Figure 75 Uncommenting the mimic.refresh Line
remove the pound sign

#mimic.refresh=120 4 Save and close the client.properties file. 5 For these changes to take effect, stop and restart the CEM GUI client.

Provisioning the Default Maximum PDU Size for SNMP Device Discovery

The SNMP.maxpdu field in the server.properties file sets the default global number of variable bindings per Protocol Data Unit (PDU) that CEM uses when discovering any SNMP device. To change the Maximum PDU Size value for each individual SNMP device, refer to Provisioning the Maximum PDU Size for SNMP Devices. To provision the default maximum PDU size for SNMP device discovery: 1 Using a standard text editor, open the server.properties file. 2 Copy the SNMP PDU size section to the override.properties file. 3 Close the server.properties file without making changes. 4 In the override.properties file, change the value of the SNMP.maxpdu field from 10 to a number based on your customized needs. 5 Uncomment the SNMP.maxpdu line to provision the default maximum PDU size for all SNMP devices. Figure 76 shows how to uncomment the SNMP.maxpdu line. Figure 76 Uncommenting the SNMP.maxpdu Line
remove the pound sign

#SNMP.maxpdu=1 6 Save and close the override.properties file. 7 For these changes to take effect, stop and restart the CEM server.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

136

Chapter 4: Provisioning

Provisioning the Maximum PDU Size for SNMP Devices

The Maximum PDU Size field (located on the SNMP Options tab) sets the number of variable bindings per Protocol Data Unit (PDU) that CEM uses for the selected SNMP device. To provision the default maximum PDU size for the SNMP device: 1 In the explorer tree, select a discovered device. 2 In the right-pane, select the SNMP Options tab. Refer to Figure 77. Figure 77 SNMP Options Tab

3 Click Save all. For more SNMP configuration options, refer to Appendix B.

Provisioning Default TCP/IP and UDP Ports Used By CEM

The CEM server is configured to use various TCP/IP and UDP ports. For a list of the default ports used by CEM, refer to Ports Used by CEM. To provision the default TCP/IP or UDP ports used by CEM server: 1 Using a standard text editor, open the server.properties file. 2 Copy the appropriate TCP/IP or UDP port variables to the override.properties file. 3 Close the server.properties file without making changes. 4 Modify the override.properties file according to your customized needs.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Provisioning Default TCP/IP and UDP Ports Used By CEM

137

Before changing the default ports on the CEM server, make sure there are no port conflicts with another daemon on the server workstation. Table 29 lists the TCP/IP and UDP ports used by CEM and the related section and field in the server.properties file. Table 29 Default TCP/IP and UDP Ports Used by CEM
Port Type FTP Server Port HTTP Port Description CEM-specific FTP daemon. Internal HTTP web server to facilitate GUI Help Panels and server-generated reports. CAUTION: If the HTTP port is not specified, the internal web server does not start. NOTE: In the Internal HTTP Web Server Properties section, you can also provision the HTTP timeout (HTTP.timeout, default is 5 seconds) and how many simultaneous client connection threads are available (HTTP.threads, default is 5). RMI Binding Port RMI Registry / Name Service - used by clients to 1099 (TCP/IP) locate the CEM Server RMI interface NOTE: This RMIBindingName value in the server.properties file must match the RMIBindingName value (default is RMIServer) in the client.properties file. RMI Server Port SNMP Trap Listening Port RMI Server - used by clients to access the CEM 2099 (TCP/IP) Server Used to accept SNMP Traps from network elements. NOTE: In the SNMP Trap Listening section, you can also provision CEM to stop receiving SNMP traps (receiveTraps). By default, CEM receives all SNMP traps. Syslog Server Port CEM-specific syslog daemon. This port is used to receive syslog messages from remote devices on the ManagementInterface interface. For more information, refer to Configuring CEM Server with a Static IP Address. Broadcast change notifications to all logged-in clients. All clients ask the server (through RMI) for this information. NOTE: In the TCP Client Notification Port section, you can also provision the TCP socket buffer size (notification.buffersize, default is 2048) and how often the CEM server periodically polls the state of client connections (clientPollingInterval, default is 10 seconds). XML Port Experimental XML Server interface. 1097 (TCP/IP) Internal XML Server Properties XML.port 514 (TCP/IP) SYSLOG SERVER syslog.server.port 162 (UDP) RMI Server/Access Port SNMP Trap Listening RMIServerPort trapListeningPort RMI registry binding RMIBindingPort Default Port 21 (TCP/IP) 1080 (TCP/IP) Section Field

FTP Server Properties FtpServer.server. config.port Internal HTTP Web Server Properties HTTP.port

TCP Client Negotiation Port

1098 (TCP/IP)

TCP Client Notification notification.port Port

5 For each port you want to enable, copy the line to the override.properties file, then uncomment the line.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

138

Chapter 4: Provisioning

Figure 78 shows how to uncomment one of the lines. Figure 78 Uncommenting the HTTP.port Line
remove the pound sign

#HTTP.port=1081 6 Save and close the override.properties file. 7 For these changes to take effect, stop and restart the CEM server.

Provisioning a Syslog Client

You can provision CEM to send syslog messages to a remote syslog server. CEM can send the messages with or without a timestamp. To provision the CEM server to receive syslog messages, refer to Provisioning Default TCP/IP and UDP Ports Used By CEM. To provision CEM to send messages to a remote syslog server: 1 Using a standard text editor, open the server.properties file. 2 Copy the Syslog Client section to the override.properties file. 3 Close the server.properties file without making changes. 4 In the override.properties file, change the value of the syslog.client.host, syslog.client.port, syslog.client.log and syslog.client.includeDate based on your customized needs. Table 30 lists the syslog client values. Table 30 Syslog Client Parameters
Parameter syslog.client.host syslog.client.port syslog.client.log syslog.client.includeDate Definition Default

The hostname or IP address of the syslog client The syslog client port which receives messages 514 The name of the file to which syslog messages are logged CEMServer

Whether a timestamp is sent with each message yes

5 Uncomment the syslog.client.host line. Figure 79 shows how to uncomment the syslog.client.host line. Figure 79 Uncommenting the syslog.client.host Line
remove the pound sign

#syslog.client.host=192.168.189.45 6 Save and close the override.properties file. 7 For these changes to take effect, stop and restart the CEM server.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

OPERATIONS

This chapter provides information which will help you monitor devices, individual properties, and servers, view audit and server operation logs, create inventory reports for groups of devices, and use various utility features such as the MIB browser, server monitor, and memory monitor. This chapter contains the following topics:
n n n n n n n n n n n n n n n n n n n n n n n n

Viewing Software Version and Copyright Information Toggling between the Explorer and List View Toggling between the Properties and Related View Expanding and Collapsing Elements Executing Commands for Multiple Elements Organizing Elements Monitoring the Status of GUI Elements Broadcasting Messages to Users Viewing Virtual Panel Displays Using the MIB Browser Viewing Numeric Values in Alternative Formats Monitoring Properties Using CEM to Edit Network Device Properties Copying and Pasting Values between Elements Locating Information Using the Find Command Locating Information in MIB Tables Using the Find Button Creating Inventory Reports Opening a Telnet Session Accessing the Web Browser Interface Viewing the Daily Audit Log Viewing FTP Logs Viewing Server Console Logs Printing the CEM GUI Explorer Tree Starting and Stopping CEM Software Components
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

140

Chapter 5: Operations

n n n n n n

Using the Server Monitor to Monitor CEM Server Performance Monitoring CEM Server Memory Monitoring CEM GUI Memory Displaying Server Console Commands Displaying CEM CLI Client Console Commands Logging in as Another User

Viewing Software Version and Copyright Information

You can view CEM core and package version numbers and copyright information using the CEM Graphical User Interface (GUI). To view CEM software version and copyright information: 1 From the menu bar, click Help and select About. Figure 80 shows the About window. Figure 80 Viewing the CEM Software Version

The About window opens and displays the CEM Version and all Installed Packages. 2 When finished, click Close. 3 From the menu bar, click Help and select Copyright.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Viewing GUI and Client Information

141

Figure 81 shows the Copyright window. Figure 81 Viewing Copyright Information

The Copyright window opens and displays copyright information for CEM and other related proprietary products. 4 When finished, click Close.

Viewing GUI and Client Information

You can view information about the CEM client, the client workstation, and the address of the CEM server to which this client is connected using the About GUI menu option. To view GUI and Client information: 1 From the menu bar, click Help and select About GUI. The Help About GUI window appears. This window contains the following information:
n n n n n n

NewNet Common Element Manager GUI client build Workstation Operating System Version The version of Java installed on this workstation The username logged into this workstation's operating system The username logged onto the CEM server The IP address of the CEM server to which this client is connected.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

142

Chapter 5: Operations

Toggling between the Explorer and List View

When the CEM GUI client starts, the Explorer view is the default view for the left-hand pane of the CEM GUI main window. The List view is an optional view which allows you to manage properties and invoke operations in much the same manner as the Explorer view. This includes managing properties and invoking operations using the CEM pop-up menus. However, rather than listing the system in an explorer tree hierarchy, the List view allows you to sort elements by class and optional attribute name and values. Then, you can sort the element information using column headings. For more information about element views, refer to Left-hand Pane Views. To use the List view instead of the Explorer view: 1 In the left-hand pane of the CEM GUI main window, select the List tab. Figure 82 shows the List tab. Figure 82 List Tab

2 At the bottom of the List tab, click Filter.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Toggling between the Explorer and List View

143

Figure 83 shows the Target Filter Selection window. Figure 83 Target Filter Selection Window

Use this filter engine to search for specific devices. For example, you can filter on all Total Control 1000 chassis using the TC1000 Chassis filter. If you want to search all managed objects in the explorer tree, select the All Managed Objects root element. 3 From the All Classes explorer tree, select the element you want to use as your filter. 4 To narrow your search, select a Name and a Value from the Optional Attribute Filter section. 5 Click OK. The filter engine searches for elements based on your query. The filter results appear in the left-hand pane. 6 In the left-hand pane, select the element you want to view. In the right-hand pane, the properties and associated configuration tabs appear for the element selected in the left-hand pane.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

144

Chapter 5: Operations

Figure 84 Selecting an Element in the List View

select an element

Using the List view, you can perform operations on the elements and manage the element properties using most of the same procedures described in this guide.

Toggling between the Properties and Related View

The right-hand pane of the CEM GUI main window has two views to choose between-Properties and Related. The Properties view is the default view for the right-hand pane of the CEM GUI main window. This view contains configuration tabs and MIB tables used for provisioning all elements in the left-hand pane of the CEM GUI main window. The Related view is the optional view which allows you to see the different relationships between related elements in the explorer tree. The most common example of related elements is the relationship between a specific user and the root view assigned to that user. To use the Related view instead of the Properties view: 1 In the right-hand pane of the CEM GUI main window, select the Related tab.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Expanding and Collapsing Elements

145

Figure 85 shows the Related tab. Figure 85 Related Tab

2 Use the Related view to verify the relationship of related objects in the explorer tree. In the example shown in Figure 85, the Related view shows the Initial Root View of user1. In the explorer tree, the Initial Root View is the Equipment folder. Use the Explorer view to locate the Equipment folder. For more information, refer to Toggling between the Explorer and List View.

Expanding and Collapsing Elements

The CEM GUI client gives you three ways to expand and collapse any element containing sub-elements in the explorer tree. If an element is expandable, a special icon precedes the element. Figure 86 shows examples of expandable elements. Figure 86 Expanding and Collapsing Elements

expanding and collapsing elements

Expand and collapse elements in the explorer tree using one of the following options:
n n n

Tree menu option Toolbar Standard double-clicking

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

146

Chapter 5: Operations

Using the Tree Menu Option

To expand and collapse elements using the Tree menu option: 1 In the explorer tree, select the element you want to expand or collapse. 2 From the main menu, select Tree and then select either Expand or Collapse. For more information, refer to Graphical User Interface Basics.

Using the Toolbar

To expand and collapse elements using the toolbar: 1 In the explorer tree, select the element you want to expand or collapse. 2 From the toolbar, click either the Expand button or the Collapse button. For more information, refer to Toolbar.

Using Standard Double-clicking

To expand and collapse elements using standard double-clicking: 1 In the explorer tree, select the element you want to expand or collapse. 2 From the explorer tree, double-click the element you want to expand or collapse. For more information, refer to Graphical User Interface Basics.

Executing Commands for Multiple Elements

Some of the options and commands available from the toolbar and in the pop-up menus can be performed on more than one element at the same time. If you do this, CEM creates separate progress dialog boxes for each element you select from the explorer tree. For example, if you update the state for two SNMP devices, CEM creates two separate progress dialog boxes. For more information, refer to Graphical User Interface Basics. To issue commands on multiple elements: 1 In the explorer tree, hold down the <Shift> key to select a range of devices, or hold down the <Control> key while selecting devices individually. 2 While the elements are selected, select a tool bar or pop-up menu option. Not all toolbar options and pop-up commands can be executed while selecting multiple elements in the explorer tree. This options may not be available for some options and commands.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Organizing Elements

147

Organizing Elements

The CEM GUI lets you move device folders, SNMP devices, bays, and racks in the explorer tree and organize them according to your customized needs. Not all elements in the explorer tree can be moved. The menu option may not be available for some sub-elements. To organize elements according to your customized needs: 1 In the explorer tree, select the element you want to move. You cannot move or change the placement of root folders in the CEM GUI. For more information, refer to Root Folders. 2 Right-click the element, and select Move from the pop-up menu. Figure 87 shows the Select a tree node dialog box, displaying the five root folders. Figure 87 Select a Tree Node Dialog Box

3 Navigate through these folders, select the new location, and click OK. The selected element moves to the new location.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

148

Chapter 5: Operations

Monitoring the Status of GUI Elements

When using the CEM GUI client, each element within CEM is given an administrative, operational, and usage state which is determined by the usage of each element and all associated sub-elements, including devices and users. This is particularly important when monitoring the operational status of SNMP devices. There are three state types, each providing a different level of status information. Table 31 lists the three state types available for most elements. Example 1 Table 31 State Types for Elements
State Type Administrative Description locked, unlocked, shuttingdown The administrative state is set by the network administrator who determines the states of locked, unlocked, or shuttingdown. It has no operational effect on the equipment. Operational enabled, disabled, or degraded The operational state is specific to the element type. For example, the operational state of power supplies in a Total Control 1000 chassis is tied to the SNMP object uchasPwerSupplyOperStatus which returns unknown, bad, good, or empty. These SNMP values are translated into the standard states of enabled, disabled, or degraded. Other devices may have different characteristics, but the common definition of enabled, disabled, or degraded is applied. NOTE: If a device is disabled, all properties and attributes related to MIB objects are hidden and fewer property tabs are visible. Usage idle, active, or busy In the same manner as operational state, the usage state is specific to the device type. However, the state is reflected in CEM as either idle, active, or busy.

You can also check the status of a specific chassis or card using the device visual feature. For more information, refer to Viewing Virtual Panel Displays. Viewing the Status CEM provides three ways to view the operational and usage states for each element in the explorer tree-the State tab, the state icons, and the Monitor State utility. The administrative state is not viewable using the State tab. Using the State Tab To view the operational and usage states using the State tab: 1 In the explorer tree, select an element. 2 On the right-hand pane of the CEM GUI main window, select the State tab. 3 View the Administrative State, Operational State, and Usage State fields. For a detailed definition of each state type, refer to Table 31.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Monitoring the Status of GUI Elements

149

Using the State Icon To view the administrative, operational, and usage states using state icons in the explorer tree: 1 In the explorer tree, select an element. 2 View the Operational State icon next to each element in the explorer tree. Next to each element in the explorer tree, the state of each element is indicated by a single colored square, or state icon. The Operational State icon is the default state icon displayed in the explorer tree. To change the default state icon and associated colors, refer to Customizing the GUI Client Environment. Table 32 lists the three status types and the default color for each type of icon. Table 32 Element Status Color Indications
Status Type Administrative State Default Icon Colors
n n n

locked-red unlocked-green shuttingdown-yellow enabled-green disabled-red degraded-yellow idle-gray active-green busy-yellow

Operational State

n n n

Usage State

n n n

Element status propagates to the top level of the element hierarchy in the explorer tree. For example, a yellow state icon means that an element in the present folder or the sub-folder below it has at least one element or device in the red state. The operational state is updated in an operator-defined interval, or on demand. Using the Web Browser Interface To view the administrative, operational, and usage states using the web browser interface: 1 Use a standard web browser and navigate to the CEM server installation directory. 2 Access the cemServerAddress:port file. where cemServerAddress:port is the IP address of your CEM server and port designates the port number assigned to the internal HTTP web server. The default value is 1080. For more information on port usage, refer to Ports Used by CEM. For example: http://10.1.1.1:1080.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

150

Chapter 5: Operations

Figure 88 shows the web browser access window. Figure 88 Web Browser Access Window

3 Under the Active Management Pages section, click one of the following links:
n

Managed Device Directory-A list of all managed SNMP devices and their status (including all sub-elements). Port Status-A list of all DS0 ports/channels and their status (to refresh the status, click go at the bottom of the page). Current Users-A list of all users and their status.

For example, if you click the Current Users link, the Users window appears showing the name, state, and last login date and time for each CEM user.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Monitoring the Status of GUI Elements

151

Figure 89 shows the status for users using the web browser interface. Figure 89 Viewing User States Using the Web Browser Interface

In the previous example, the status for each user is indicated by the color of each table cell in the User Name column. For a list of colors and their descriptions, refer to Table 32. Using the Monitor State Utility To view the administrative, operational, and usage states using the Monitor State utility: 1 In the explorer tree, select an element. 2 Right-click the element, and select Monitor State from the pop-up menu.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

152

Chapter 5: Operations

Figure 90 shows the Monitor State utility. Figure 90 Accessing the Monitor State Utility

To refresh the status, click Refresh. 3 From the State drop-down list, select a state type (administrativeState, operationalState, and usageState) based on your understanding of the state types. For a detailed definition of each state type, refer to Table 31. 4 To select a class type, click All Stated Managed Objects in the Class field. The classes in the Class list are CEM internal class names and do not have any relationship to MIB classes.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Monitoring the Status of GUI Elements

153

Figure 91 shows the Class selection filter window. Figure 91 Class Selection Filter Window

Use this filter engine to search for specific devices, event records, managed objects, and configuration groups. For example, you can filter on all Total Control 1000 chassis using the TC1000 Chassis filter. If you want to search all managed objects in the explorer tree, select the All Stated Managed Objects root element. 5 Click OK. 6 If this device has sub-elements, select the Detailed tab to reveal the status of all of the sub-elements at the same time. 7 When finished, click Close. Refreshing the Status To update CEM with the current administrative state, operational state, and usage status of the selected element and its sub-elements, use the State command. This command forces CEM to poll the element and any sub-elements to update its state. For more information, refer to the Table 31. To refresh the device state: 1 In the explorer tree, right-click the element you want to update. 2 From the pop-up menu, select State and then select Update. The Update dialog box opens and CEM updates the state. 3 When the Working icon changes to a Finished icon, click Close.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

154

Chapter 5: Operations

Broadcasting Messages to Users

CEM provides a chat function which allows you to broadcast messages to one or multiple users logged into the CEM server. For example, if you plan to stop the CEM server for maintenance purposes, you can broadcast a message to all users letting them know that you are planning to do a routine maintenance check of the CEM server. To broadcast messages to one user:

Sending a Message to One User

1 In the explorer tree, select a user you want to send a message to. 2 Right-click the user and select Send Message. To send a user a message, the user must be logged into the CEM server. If the user is not logged into the CEM server, the Send Message options is unavailable (grayed out). Also, you cannot send a message to yourself. Figure 92 shows the CEM Chat window. Figure 92 CEM Chat Window

3 In the Input Message field, type the message you want to send to the selected user. 4 When finished typing the message, click Send Message. The message appears in the Message Panel section of the CEM Chat window. 5 When finished chatting, click Terminate Chat.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Viewing Virtual Panel Displays

155

Sending a Message to Multiple Users

To broadcast messages to multiple users: 1 In the explorer tree, select the Users root folder. You can also broadcast a message to multiple users by using the broadcast command from the CEM server console. For more information, refer to CEM Server Console. 2 Right-click the Users folder and select Send Message to all. Figure 93 shows the Send Message dialog box. Figure 93 Send Message Dialog Box

3 When finished typing the message, click OK. CEM broadcasts the message in a CEM Chat window to all users in the Users root folder. 4 If one of the users responds to your initial message, reply using the Input Message field to type your response. 5 When finished typing the response, click Send Message. The message appears in the Message Panel section of the CEM Chat window. 6 When finished chatting, click Terminate Chat.

Viewing Virtual Panel Displays

A device visual provides a status-at-a-glance display of a managed chassis or individual card within the chassis. To view a virtual panel display: 1 In the explorer tree, select an SNMP device (a chassis or card). You can also select individual cards instead of an entire chassis. Also, other NewNet SNMP devices which reside on a server (for example, a SIP proxy server or an accounting server) cannot be viewed using this feature. 2 From the CEM window Toolbar, click the Device Visual button. Figure 94 shows the Device Visual button located on the commands Toolbar. Figure 94 Device Visual Button
click the device visual button

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

156

Chapter 5: Operations

A device visual for the selected SNMP device appears. Figure 95 shows the Total Control1000 chassis device visual. Figure 95 Total Control 1000 Chassis Device Visual

3 Check the type and status of a card: a Place the mouse pointer over a card to show a Tool Tip that describes the card type. Figure 96 shows how to view the card type in the device visual. Figure 96 Total Control 2000 Chassis Card Type Device Visual

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using the MIB Browser

157

b View the background color of a card. Table 33 lists the background color indications for the device visual. Table 33 Background Color Indications
Background Color Black Gray Yellow Indicates Card is in normal operational mode. Card was initially discovered, but is now missing. Card is not operational.

c Place your mouse pointer over a card LED (light emitting diode) to see what type of LED it is. d Click the Refresh now button to refresh the visual, or click the Refresh Rate button to set, in seconds, how often the visual refreshes itself. For more information, refer to Provisioning the Default Refresh Rate for the GUI Client.

Using the MIB Browser

CEM contains an internal MIB browser which allows you to get and set Managed Information Base (MIB) values of compiled MIBs that are either distributed with CEM or integrated by NewNet customer service. Some MIB values available in the browser may either be unsupported or simply not available through the GUI client. To start the MIB browser: 1 In the explorer tree, select an SNMP device. 2 Right-click the SNMP device and select Browse MIB from the pop-up menu.

Starting the MIB Browser

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

158

Chapter 5: Operations

Figure 97 shows the Browse MIB selection. Figure 97 Browse MIB Selection

The MIB browser window opens, as shown in Figure 98. Getting and Setting MIB Values To get or set a particular MIB value: 1 In the MIB browser explorer tree, navigate and select a MIB module (for example, SIP-MIB). 2 Navigate to the MIB object level (leaf level). To search for a mib containing a specific text string, click the Find button.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Viewing Numeric Values in Alternative Formats

159

Figure 98 shows the MIB browser explorer tree. Figure 98 MIB browser

3 In the right pane, edit the Name as desired. You can add .index1 [index2] to specify the Get or Set of a table column. 4 Click Get to get the value of the MIB object. 5 Depending on the type of MIB object, edit the Value or Enumeration field as desired. If the field is not editable, the field is unavailable (grayed out). 6 Click Set. 7 From the File menu, click Exit to close the MIB Browser.

Viewing Numeric Values in Alternative Formats

You can display and edit numeric property values in various data formats, including:
n n n n n n

Octet String ASCII characters Integer IP Address Octal Binary

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

160

Chapter 5: Operations

To view numeric values in alternative formats: 1 In the explorer tree, select an element which contains a numeric value. 2 In the right-hand pane, right-click a numeric property. Figure 99 shows how display a numeric property in an alternative format. Figure 99 Displaying an Alternate Data Format

3 Select any one of the individual data formats, or select All Formats to see all the available formats at the same time. The Multi Format Dialog dialog box opens. Figure 100 shows the Multi Format Dialog dialog box. Figure 100 Displaying All of the Data Formats for a Numeric Property

4 If the property you have selected is editable, you may edit the property and click OK. If the property is not editable, the values are unavailable (grayed out).

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Monitoring Properties

161

Monitoring Properties

You can view a dynamic line graph or table to monitor any read-only property in CEM. New data is added to the graph or table continuously according to the poll rate which has a default of five seconds. You can view graphs and tables multiple properties at the same time. To monitor a read-only property: 1 In the explorer tree, select an element which contains a read-only value. 2 Select any read-only property from the right pane of the main CEM window. 3 Right-click the property, and select Monitor from the pop-up menu. A monitor dialog box opens with specific information about the property. Figure 101 shows the property monitor in table view. Figure 101 Property Monitor - Table View

You can display as many property monitors as you want and each property monitor instance can display multiple properties (to add multiple properties to a single monitor instance, refer to Monitoring Additional Attributes). The display will update as often as set by the poll rate. To change the poll rate, refer to Setting the Poll Rate. 4 Click Start to begin monitoring.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

162

Chapter 5: Operations

The data collection starts, based on the poll rate value. While the graphing proceeds, the Start button is replaced by the Stop button. Use the Stop button to interrupt the graphing process. Figure 102 Property Monitor in graph view. Figure 102 Property Monitor - Graph View

5 To change the rate (the default is five seconds), refer to Setting the Poll Rate. 6 Click Close to exit the monitor dialog box. Setting the Poll Rate The poll rate determines how often the property monitor is updated (refreshed). To set the poll rate: 1 Open a monitor for a particular property, as described in Monitoring Properties. 2 Click Poll Rate at the bottom of the monitor dialog box. Figure 103 shows the Polling Rate dialog box. Figure 103 Polling Rate Dialog Box

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Monitoring Properties

163

3 Type a new polling rate, in seconds. 4 Click OK. Monitoring Additional Attributes To monitor multiple attributes in a single property manager instance: 1 Open a monitor for a particular property, as described in Monitoring Properties. 2 Click Attributes. A window appears that lists all the numeric attributes on all the tabs for the currently selected device or folder. Refer to Figure 104. Figure 104 Property Monitor Attributes

3 For each attribute that should be monitored, check the Monitor checkbox. 4 Click OK. The table and graph views now display a row or column for each attribute. Changing the Scope To monitor the same tributaries across multiple devices, change the scope to include the other devices. To change the scope: 1 Open a monitor for a particular property, as described in Monitoring Properties. 2 Click Scope.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

164

Chapter 5: Operations

A window appears that shows the explorer tree nodes. Refer to Figure 105. Figure 105 Property Monitor Scope

3 Select a node that contains the attribute(s) currently selected. This automatically includes any sub-nodes for the node. To select a range of devices/folders, press the Shift key while selecting nodes. To select multiple devices/folders, press the Ctrl key while selecting nodes. 4 Click OK. When monitoring a single attribute across multiple devices, CEM lists the attribute name at the top of the window and the date/time and values in the table or graph. When monitoring multiple devices across multiple devices, CEM lists the date/time at the top of the window and the attribute names and values in the table (graphing is not available).

Using CEM to Edit Network Device Properties

The CEM GUI client lets you configure an individual device or an entire group of devices. To configure an individual device, select a device in the left-hand pane, select a specific tab in the right-hand pane, and then edit the specific property directly. You must double-click a property to change its value and then click Save All to complete the change. Some property changes require a save to NVRAM or EEPROM. For more information about saving and restoring configurations on SNMP devices, refer to the related documentation for that specific product line.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using CEM to Edit Network Device Properties

165

Figure 106 shows how to edit a property in the right-hand pane of the CEM GUI main window. Figure 106 Editing a Property

pull-down menu device with sub-elements

CEM manipulates MIB objects and displays them in the right-hand pane of the CEM GUI in one of two forms:
n n

simple MIB objects table of MIB objects

While deprecated MIB objects are visible as part of normal operation, deprecated MIB objects and the corresponding tables should not be used. A deprecated object in a MIB is still functional, but it will most likely be removed in a future release. To determine if an object is deprecated, refer to the Status field in the Advisor window. For more information, refer to Advisor Window. Editing Simple Properties Most of the time, properties are organized in a simple list on the right-hand pane of the CEM GUI. You can edit any simple MIB object property which has a white background. Properties with gray backgrounds are informational (read-only) properties.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

166

Chapter 5: Operations

Figure 107 show the difference between simple properties. Figure 107 Editing Simple Properties

editable property informational property

To edit a simple property: 1 In the explorer tree, select an element which contains a simple property. 2 In the right-hand pane, find an editable property on a tab and select the property name in the Attribute column (a red border surrounds the selected property). The CEM Advisor displays property information. If the CEM Advisor window is not visible, click the advisor button in the upper right-hand corner of the CEM GUI to open it. For more information, refer to Toolbar. 3 In the field to the right of the property name, double-click the field and edit according to your customized needs. Some simple properties allow you to type numeric values or simple text and others contain a drop-down list of options to choose from. Figure 108 shows how to select simple properties. Figure 108 Selecting Simple Properties

double-click the property field

4 Click Save all. Editing Tabular Properties CEM sometimes organizes simple properties in tabular columns and rows (a MIB table) on the right-hand pane of the CEM GUI main window. You can edit any tabular property which has a white background. Properties with gray backgrounds are informational (read-only) properties. Properties with gray backgrounds and blue text are index values which cannot be changed once the row is created. Each row in a MIB table is identified by one or more unique index values. A MIB table may display no rows at all. In that situation, the table is empty.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using CEM to Edit Network Device Properties

167

Figure 109 shows how to edit tabular properties. Figure 109 Tabular Properties
editable property table index informational property

add a table row

delete a table row

To edit a tabular property: 1 In the explorer tree, select an element which contains a tabular property. 2 In the right-hand pane, select a tab which contains a MIB table. A tab which contains a MIB table has Add and Delete buttons at the bottom of the tab when rows can be added and deleted, as shown in Figure 109. CEM will not allow you to add and delete rows for some MIB tables. 3 At the bottom of the tab, click Add. The Add row to table dialog box opens. 4 Fill in the appropriate information into the dialog box. 5 When finished, click OK. A new row is added to the MIB table. You can change any of the editable (simple) properties after adding the row, as described in Editing Simple Properties. However, you cannot change the informational and index properties once adding the row to the table. 6 If you change any of the simple properties in the table, click Save all at the bottom of the tab.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

168

Chapter 5: Operations

Copying and Pasting Values between Elements

You can copy SNMP values from one element (for example, card or server) to another. These elements must be exactly the same. For example, you cannot copy and paste values between a T1-PRI span and an E1-PRI span. They must both be the same type of span. In the explorer tree, not all elements can values be copied between. If this is the case, you will receive a "No Related Elements Found" error message when attempting to copy and paste values. To copy SNMP values from one element to another: 1 In the explorer tree, select an element to copy values from. 2 On the main menu, select the Configuration menu and then select Copy SNMP values. Instead of using the Configuration menu, you can use the toolbar options to copy and paste values. For more information, refer to Toolbar. 3 Select another element of exactly the same type to paste values to. 4 On the main menu, select the Configuration menu and then select one of the following options:
n n

Paste SNMP values-pastes the SNMP values to the selected elements only Paste SNMP values to all-pastes the SNMP values to the selected element and to any sub-elements which may be present.

The following dialog box opens, showing a list of potential values to change. Figure 110 shows the SNMP Values to Change dialog box. Figure 110 SNMP Values to Change Dialog Box

5 To remove a value from the list, select the value and click Remove. 6 When you are satisfied with the list of values you want to change, click Set. The copied SNMP values are pasted to the selected device. 7 Click Close.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Locating Information Using the Find Command

169

Locating Information Using the Find Command

The Find command lets you search for a string of text that may be part of a CEM Tree Label, Property (field label), or MIB OID. Searches can either include or exclude sub-elements. Instead of using the Find command from an explorer tree node, you can use the Find toolbar option to find specific information or values. For more information, refer to Toolbar. To search for a field or specific MIB object in CEM: 1 In the explorer tree, right-click any element. 2 From the pop-up menu, select Find. Figure 111 shows the Find window. Figure 111 Find Window

3 In the For field, type the specific word, property, or MIB object you are searching for. 4 In the In section, narrow your search by selecting one of the following:
n

Tree Label-The label for a specific sub-element, or tree node (for example, DSP). Property-The name of a specific property or MIB object (for example, echo). MIB OID-The MIB OID for a specific MIB object (for example, 1.3.6.1.4.1.429.1.27.1.1.12).

n n

5 In the From field, select the tree node you want to search. If you want to change the tree node you want to search, click Explore Tree. If not, continue with step 7. The explorer tree window opens and allows you to choose another tree node to search. This allows you to broaden or narrow your search according to your customized needs. For example, if you know that the property you are looking for is on a specific server or card, you can select that specific device instead of an entire folder.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

170

Chapter 5: Operations

Figure 112 shows the explorer tree window. Figure 112 Explorer Tree Window

6 When finished, click OK. 7 If you would like to search in all sub-elements of the selected tree node, select the Include All Subtrees checkbox. 8 After entering your search criteria, click Find now. If any matches are found, the results appear in the Find window. The results have three columns of information available to you:
n

Label-The actual property or MIB object which contains the words entered in the search criteria. Tab-The tab on which this property or MIB object is found. Tree Label-The tree node where this property or MIB object is found.

n n

Figure 113 shows the results from a sample search (searched on the string voip in any property found in the Equipment root folder). Figure 113 Sample Search Using the Find Command

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Locating Information in MIB Tables Using the Find Button

171

9 Review the list of results and double-click the result that best matches your search criteria. The explorer tree changes and takes you directly to the tree node or folder where that property or MIB object is located. 10 When finished with the Find window, click Cancel to return to the CEM GUI main window.

Locating Information in MIB Tables Using the Find Button

When data populates a MIB table within CEM, it either loads continuously or line by line as you scroll down in a full, on-screen table. This is controlled by the Table loading button located on the toolbar. To provision table data loading, refer to Provisioning Table Data Loading. Some tables contain a Find button to search for a specific table entry. The Find button allows you search on table entries based on the index values for that particular table. CEM displays index values in blue text with gray backgrounds. For more information, refer to Editing Tabular Properties. To locate information in MIB tables using the Find button: 1 In the right-hand pane of the CEM GUI main window, locate and select a tab containing a MIB table. If the Find button is available, it will be located in the bottom right-hand corner of the CEM GUI main window. The Find button is only available for some MIB tables. 2 In the bottom right-hand corner of the CEM GUI main window, click Find. The Find row in table dialog box appears. Figure 114 shows the Find row in table dialog box. Figure 114 Finding a Row in a Table

The editable fields for the Find row in table dialog box changes, depending on the index values found in the associated MIB table. You can only search on index values. For example, Figure 114 allows you to search on the index values for LocalAddress and Local Port. 3 In the Find row in table dialog box, type the desired search information in the editable fields or select the desired search information from drop-down lists, and click OK. CEM immediately finds that particular table entry and moves it to the top of the on-screen table.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

172

Chapter 5: Operations

Creating Inventory Reports

You can generate inventory reports for all the SNMP devices within a particular equipment folder. To create an inventory report: 1 In the explorer tree, select an equipment folder, bay, or rack. 2 Right-click the selected element, and select Inventory from the pop-up menu. The inventory report window and a CEM status dialog box open. 3 When the Working icon changes to a Finished icon, click Close on the CEM status dialog box. 4 On the inventory report window, click Print to print the report or Close to close the window. Refer to Figure 115 for more information. Figure 115 Inventory Report

To save the inventory as an .html file for historical purposes, click Save at the bottom of the inventory report window. You can also access inventory reports on the web browser interface. To use the web browser interface, refer to Accessing the Web Browser Interface.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Opening a Telnet Session

173

Opening a Telnet Session

CEM provides a telnet feature that can open a direct telnet session to any device that supports telnet and that the client can access directly. CEM also supports Secure Shell (SSH) telnet connections. Each telnet session is considered a device connection, so the number of telnet sessions allowed is limited to the number of allowed managed devices not already in use by other managed devices. This feature is not available for all packages. To open a telnet session: 1 From a CEM client with telnet capabilities, select the Tools menu. 2 Click Telnet. The Telnet/SSH Target dialog box opens. Figure 116 CEM Telnet Target Dialog Box

3 Enter the IP address or host name with which CEM should open a telnet session, followed by the port (if required). 4 If the device you are accessing requires SSH User Authentication, check the Use SSH checkbox. A Username and Password field appears. Figure 117 CEM Telnet Session with SSH

Enter the user name and password to be used during the SSH authentication process. During authentication, the public key of the host is exchanged with the 5 Click OK.
n

If SSH authentication was not selected, a terminal window opens and the Telnet session typically prompts for a login and password. If the terminal was opened with SSH and this is the first time the client is logging onto the device, or if the public key has changed, the user is prompted to accept the fingerprint from the host. After the fingerprint is accepted the telnet session opens to a command prompt.
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

174

Chapter 5: Operations

If the terminal was opened with SSH and the public key has not changed since the last authentication, the user is not prompted to accept the fingerprint.

6 To close the telnet session, close the telnet window. The telnet session is also shutdown when the client is shutdown.

Accessing the Web Browser Interface

CEM uses a web browser interface to remotely access the state of managed devices and users and to view event logs and related documentation. To access the web browser interface: 1 Use a standard web browser and navigate to the CEM server installation directory. If using Netscape 7.x to access CEM the web browser interface, you may experience security restrictions which prohibit you from accessing the HTTP port. If this occurs, refer to the related documentation for your web browser. 2 Access the cemServerAddress:port file. where cemServerAddress:port is the IP address of your CEM server and port designates the port number assigned to the internal HTTP web server. The default value is 1080. For more information on port usage, refer to Ports Used by CEM. For example: http://10.1.1.1:1080. Figure 118 shows the web browser access window. Figure 118 Web Browser Access Window

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Viewing the Daily Audit Log

175

The web browser interface is divided into several sections of information available for your use:
n

Managed Device Directory-A list of all managed SNMP devices and their status (including all sub-elements). Port Status-A list of all DS0 ports/channels and their status (to refresh the status, click go at the bottom of the page). Current Users-A list of all users and their status. Server Audit Logs-This directory is used to store the following types of event log files:
n

n n

ServerConsoleLog-yyyymmdd.log-These log files are created if the trace.consoleLogging is set to yes in the server.properties file. AuditLog-yyyymmdd.log-These log files are created if the AuditLog field is set to yes in the server.properties file. ftplog/-The log files in this folder contain a detailed list of all FTP activity on the CEM server. Use this log to diagnose file transfer problems between network elements and CEM.

n n

General Help-An HTML version of this document. Readme-A document providing basic installation notes, workstation requirements, and last-minute issues related to CEM.

Viewing the Daily Audit Log

All SNMP trap, security, audit, and syslog event records are saved in the daily audit log file for historical purposes, even if an event was purged from the logical log. The daily audit log is an ASCII-based text file (AuditLog-yyyymmdd.log) which is saved on the CEM server workstation in the <cem_root>/log folder. These log files are created if the AuditLog field is set to yes and uncommented in the server.properties file (See to Modifying Server Properties in Chapter 4). You can view logs using any one of three access options:
n n n

web browser interface CEM GUI main window CEM server /log directory

Use these options to view the daily audit log. CEM creates new daily audit logs every day at 12:00 midnight. Each log includes the date the log was generated. Using the Web Browser Interface You can view the daily audit log by using the web browser interface. For more information, refer to Accessing the Web Browser Interface.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

176

Chapter 5: Operations

Using the CEM GUI Main Menu

You can view the daily audit log by using the CEM GUI main menu. To view the daily audit log from the CEM GUI main menu: 1 From the CEM GUI main menu, select the View menu and then select Log files. Figure 119 shows the log Files window. Figure 119 Log Files Window

2 To view a server console log, click the link for the log you want to view. Figure 125 shows a sample daily audit log file. Figure 120 Sample Daily Audit Log File

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Viewing FTP Logs

177

To save the log as an .html file for historical purposes, click Save at the bottom of the daily audit log window. To print the log to a network printer, click Print at the bottom of the daily audit log window. 3 When you are finished, click Close. Using the Log Directory You can also view the daily audit log from the <cem_root>\log directory located on the CEM server workstation. Simply use a standard text editor to view the server console log ASCII text file.

Viewing FTP Logs

You can view FTP logs using any one of three access options:
n n n

web browser interface CEM GUI main window CEM server /log directory

Using the Web Browser Interface Using the CEM GUI Main Menu

You can view FTP logs by using the web browser interface. For more information, refer to Accessing the Web Browser Interface. You can view FTP logs by using the CEM GUI main menu. To view FTP Logs from the CEM GUI main menu: 1 From the CEM GUI main menu, select the View menu and then select Log files. Figure 121 shows the log Files window. Figure 121 Log Files Window

2 From the log Files window, click ftplog/.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

178

Chapter 5: Operations

Figure 122 shows the FTP files page. Figure 122 FTP Files Page

3 To view the FTP log, click ftp.log. Figure 123 shows a sample FTP log file. Figure 123 Sample FTP Log File

To save the log as an .html file for historical purposes, click Save at the bottom of the FTP log window. To print the log to a network printer, click Print at the bottom of the FTP log window.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Viewing Server Console Logs

179

4 When finished, click Close. Using the Log Directory You can also view FTP logs from the <cem_root>\log\ftplog directory located on the CEM server workstation. Simply use a standard text editor to view the FTP log ASCII text file.

Viewing Server Console Logs

By default, the CEM server creates a daily log which contains a snapshot of everything in the CEM server console command line. CEM creates these log files if the trace.consoleLogging field is set to yes and uncommented in the server.properties file (refer to Modifying Server Properties in Chapter 4). The server console is an ASCII-based text file (ServerConsoleLog-yyyymmdd.log) which is saved on the CEM server workstation in the <cem_root>/log folder. You can view CEM server console logs using any one of three access options:
n n n

web browser interface CEM GUI main window CEM server /log directory

Use these options to view the server console log. CEM creates new server console logs every day at 12:00 midnight. Each log includes the date the log was generated. Using the Web Browser Interface Using the CEM GUI Main Menu You can view server console logs by using the web browser interface. For more information, refer to Accessing the Web Browser Interface. You can view server console logs by using the CEM GUI main menu. To view server console logs from the CEM GUI main menu: 1 From the CEM GUI main menu, select the View menu and then select Log files.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

180

Chapter 5: Operations

Figure 124 shows the log Files window. Figure 124 Log Files Window

2 To view a server console log, click the link for the log you want to view. Figure 125 shows a sample server console log file. Figure 125 Sample Server Console Log File

To save the log as an .html file for historical purposes, click Save at the bottom of the server console log window. To print the log to a network printer, click Print at the bottom of the server console log window. 3 When finished, click Close.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Printing the CEM GUI Explorer Tree

181

Using the Log Directory

You can also view server console logs from the <cem_root>\log directory located on the CEM server workstation. Simply use a standard text editor to view the server console log ASCII text file.

Printing the CEM GUI Explorer Tree

CEM allows you print just the explorer tree for your own customized needs. For more information about different printing options using CEM, refer to Printing Options. To print the CEM GUI explorer tree: 1 Before printing the explorer tree, provision the printer page setup. For more information, refer to Provisioning the Printer Page Setup. 2 From the main menu, select the Tree menu and then select Print Tree. A standard Print dialog box opens. 3 Select the printer you want to print from. 4 Provision the print job according to your customized needs (also, select the number of copies), and click OK.

Starting and Stopping CEM Software Components

Starting the CEM Server

Use the following procedures to start and stop CEM server, GUI client, and CLI client components.

To start the CEM GUI client, refer to Starting the CEM GUI Client. To access the server console commands available, refer to Displaying Server Console Commands.

Starting the CEM Server as a Daemon

You can run the CEM server as a background process, detached from the terminal that launched it, or as a fully-operational daemon. This is especially important on systems that are generally unattended or have no direct terminal interface. In such a state, there is no interactive CEM server command prompt available to the user and all CEM server interaction must take place through the CEM CLI client. The CEM server will, however, continue to log all output to the daily ServerConsoleLog-yyyymmdd.log located in the <cem_root>/log directory. On UNIX platforms, you may tail this file to monitor the server startup progress. When launched as a background process or daemon, the CEM server will still issue its normal startup messages to the console. NewNet recommends that you only run the CEM server as a daemon when there is no expected interaction required with the CEM server command prompt. For example, make sure that you have already entered a valid license so that you do not get prompted for it every time you attempt to start the server in daemon mode.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

182

Chapter 5: Operations

Starting the Server as a UNIX Background Process Run the CEM server as a UNIX background process using the optional -daemon parameter in one of two ways:
n

Run the CEM server as a background process, using the following command: ./runServer -daemon & This will start the CEM server and force the CEM process into the background, returning control of the terminal back to the user. However, shutting down the terminal window will stop the CEM server.

Run the CEM server in a mode where it is detached from the terminal that that it was launched from. Once the CEM server starts (for example, from a remote Telnet window), it is possible to shut down the terminal window (and the Telnet session) and still make sure that the CEM server is running. The standard UNIX nohup command is used to make this possible. To launch the CEM server in this mode, enter the following command from the CEM installation directory: nohup ./runServer -daemon & For both options, the only way to send commands to the CEM server (for example, to stop the server), is to use the CEM CLI client. It is possible to incorporate these startup modes in your system initialization sequence (for example, as part of your bootup rc or init scripts) so that the CEM server starts up every time you reboot your workstation. In this mode, depending on the size of your database, it may take a few minutes for clients to access the CEM server even after your system has come up.

Starting the Server as a Windows 2000 Background Process Run the CEM server as a Windows 2000 background process using one of two ways: The following procedure applies to Windows 2000 platforms only. You may have limited success using other Windows platforms, but NewNet cannot guarantee your success.
n

Create a shortcut to the runServer.bat file in your Programs/Startup folder. This shortcut will allow you to start the CEM server in a command window everytime you log into the system (but not when the system boots). In this mode, the server does not actually start as a background task. It is simply run everytime you log into the system.

NewNet does not recommended this option because if you accidently close the command window, Windows 2000 will force the server to stop.
n

NewNet recommends that you create a Scheduled Task that will run the server in daemon mode when Windows 2000 boots. The scheduled task should have the following properties:

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Starting and Stopping CEM Software Components

183

Run-The command line must include the full path to the runServer.bat file, including the -daemon option. For example: C:\Program Files\CEM\runServer.bat -daemon Start in-Reference the full path of the CEM installation directory. For example: C:\Program Files\CEM Run as-Reference a valid Username for the system. Make sure to set the correct password using the Set password button. Schedule task-should be set to At System Startup. Clear all the options on the Settings tab.

Using this method will run the CEM server every time the system boots, even if no one logs in. The only way to send commands to the CEM server (for example, to stop the CEM server) is to use the CEM CLI client. If CEM is running in the background and the system shuts down, Windows 2000 will force the server to exit. When this happens, CEM will attempt to close its database connection and flush all log files, but there is no guarantee that it will be allowed to. In the daily console log, you will see entries similar to the following: 11/27/2002 14:53:38 (E) ** SERVER PANIC - Attempting to close logs and database connections ** 11/27/2002 14:53:38 (I) FDServerLog:log\AuditLog-20021127.log shutting down... 11/27/2002 14:53:38 (I) ObjectDB: Database connection shutting down... Database fdserver is shutting down... Database fdserver shutdown complete. 11/27/2002 14:53:38 (I) FDNotificationSender: Stop broadcasting server updates This is an indication that Windows 2000 forced the CEM server to stop. Currently, there is no mechanism to prevent this from happening on Windows 2000. To access the server console commands available from a daemon, refer to Displaying Server Console Commands. Stopping the CEM Server To shut down the CEM server, enter one of the following commands from the CEM Server command prompt:
n n n

exit quit stop

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

184

Chapter 5: Operations

Starting the CEM GUI Client

To start the CEM GUI client, refer to Starting the CEM GUI Client in Chapter 3. If you are already logged into the CEM GUI client and you want to log in as another user, select the Log in as another user command from the File menu. The current CEM GUI client session stops and the Login screen appears.

Starting the CEM GUI Client Using HP OpenView

To start the CEM GUI client using HP OpenView:

1 Select the SNMP device you want to view using the CEM GUI. When launching the CEM GUI client from within HP OpenView, the selected device must already be discovered by the CEM server. 2 From the main menu in HP OpenView, select Misc, then select CEM: GUI Client. When the CEM GUI launches, Localhost is the default server. Stopping the CEM GUI Client You can log out of the CEM GUI client in one of two ways:
n n

From the File menu, click Log out. Click the logout and exit button on the CEM GUI Toolbar, as shown in Figure 126.

Figure 126 Stopping the CEM GUI Client

logout and exit

Starting the CEM CLI Client

To start the CEM CLI client, refer to Starting the CEM CLI Client. To access the CLI client console commands available, refer to Displaying CEM CLI Client Console Commands.

Stopping the CEM CLI Client

To shut down the CEM CLI client, enter one of the following commands from the CEM CLI command prompt:
n n n

exit quit stop

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using the Server Monitor to Monitor CEM Server Performance

185

Using the Server Monitor to Monitor CEM Server Performance

The CEM server monitor is a client-side program that connects to a specific CEM server to monitor its key performance parameters. It charts and optionally logs performance data such as transaction, trap, and notification activity for the CEM server. To start the CEM server monitor: 1 Open a command prompt window. Make sure the CEM server is running before using this procedure. 2 Navigate to the directory containing the installed CEM software files. 3 From the command prompt, enter the following command and optional parameters, as shown in Table 34:
runServerMonitor [parameters]

Table 34 lists optional parameters for the runServerMonitor command. Table 34 Optional Parameters for the Server Monitor
Parameter -Sservername -Llogfile Usage Where servername is the hostname or IP address of the CEM server. The default is localhost. Where logfile is the name of the log file to capture all data in Comma Separated Version (CSV) format

Figure 127 shows the CEM Server Monitor window. Figure 127 CEM Server Monitor Window

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

186

Chapter 5: Operations

4 Select the Statistics tab and select any of the CEM server statistics that you want to monitor and graph. 5 At the bottom of the Server Monitor window, click Poll Rate to set the refresh rate for the server monitor. The default is five seconds. 6 Click Start to begin the server monitor. In the field next to each statistic, the Server Monitor window displays the current performance data. Click Pause to pause monitoring and click Continue to resume monitoring. While the server monitor is running, you can check how many Active users are using the CEM server. Refer to Figure 127 for more information. 7 Click Close when you are finished.

Monitoring CEM Server Memory

To monitor the amount of memory the CEM server is using: 1 Start the Server Monitor. For more information, refer to Using the Server Monitor to Monitor CEM Server Performance. 2 From the Server Monitor window, select the Memory tab. 3 Click Start to begin the server monitor. Figure 128 shows the Memory tab. Figure 128 Memory Tab on the CEM Server Monitor

At the left-hand side of the Memory tab, you can monitor the amount of memory available and the amount of memory currently being used. 4 When finished, click Close.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Monitoring CEM GUI Memory

187

Monitoring CEM GUI Memory

To monitor the amount of memory the CEM GUI client is using: 1 Start the CEM GUI client. For more information, refer to Starting the CEM GUI Client. 2 From the CEM GUI main menu, select the Tools menu and then select Memory Monitor. Figure 129 shows the GUIClient Memory Monitor window. Figure 129 GUIClient Memory Monitor

At the left-hand side of the GUIClient Memory Monitor window, you can monitor the amount of memory allocated and the amount of memory currently being used. 3 When finished, click Close.

Displaying Server Console Commands

Although it is not normally necessary to use any of the server commands except the ones listed in Stopping the CEM Server, the server console commands provide a powerful alternative for many system commands. To display the list of available CEM server console commands: 1 Start the CEM server using one of the options listed in Starting and Stopping CEM Software Components. If you start the CEM server as a daemon or background process, there are optional commands available. For more information, refer to Using Daemon-specific Server Console Commands. 2 From the CEM server console, enter ? or help.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

188

Chapter 5: Operations

Figure 130 shows the list of available CEM server console commands. Figure 130 CEM Server Console Commands

For a comprehensive list of all CEM server console commands and their functions, refer to Command Line Interface Reference.

Displaying CEM CLI Client Console Commands

To display the list of available CEM server console commands:

1 Start the CEM CLI client using one of the options listed in Starting and Stopping CEM Software Components. If you start the CEM server as a daemon or background process, refer to Using Daemon-specific Server Console Commands. 2 From the CEM server console, enter ? or help. For a comprehensive list of all CEM CLI client console commands and their functions, refer to Command Line Interface Reference.

Logging in as Another User

To log out of the current session and log in as another user: 1 From the File menu, select Log in as another user. 2 Click Yes to exit this session and log in as another user. CEM closes the session and displays the login window.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

MAINTENANCE

This chapter describes various maintenance tasks for common element manager (CEM). Maintenance procedures are concerned with upgrading or uninstalling applications, rediscovering SNMP devices, and any preventative tasks that maintain the health of your system. This chapter contains the following topics:
n n n n n n n n n n n n n n n n n n n n

Reserving and Unreserving Elements Renaming Elements Resetting User Passwords Removing an Assigned Root View Forcing a Logout Deleting a User Deleting a Logical View Deleting SNMP Devices and Folders Rediscovering an SNMP Device Changing the SNMP Version Managing Logical Logs Using the Event and Alarm Viewer Uninstalling CEM Components Relicensing the CEM Server Upgrading CEM Upgrading from Non-NewNet CEM Upgrading Redundant CEM Servers Importing SDL Files for Device Upgrades Removing HP OpenView Integration Compacting Embedded Databases on Server Startup

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

190

Chapter 6: Maintenance

Reserving and Unreserving Elements

You can reserve an element in the explorer tree so that no one else can perform operations on it or any of its sub-elements. Use this feature before performing maintenance tasks on components within the explorer tree. To reserve an element in the explorer tree: 1 In the explorer tree, right-click an element. 2 From the pop-up menu, select Operator Reserve. Figure 131 shows the explorer tree when an element is locked. Figure 131 Reserving Elements

Reserving an Element

Unreserving an Element

To unreserve an element in the explorer tree: 1 From the explorer tree, right-click the reserved element. 2 From the pop-up menu, select Operator Un-reserve.

Renaming Elements

To change the name of a selected element, use the Rename command. This is particular helpful when renaming a particular SNMP device or user. Not all elements can be renamed. The menu option may not be available. For example, root folders cannot be renamed. For more information, refer to Root Folders. To rename an element in the explorer tree: 1 In the explorer tree, select the element you want to rename. 2 Right-click the element and select Rename from the pop-up menu. Figure 132 shows the Rename dialog box. Figure 132 Rename Dialog Box

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Resetting User Passwords

191

3 Type the new name for the selected element. 4 Click OK.

Resetting User Passwords

User passwords cannot be changed after initial configuration; they can only be reset. To reset a user password: 1 In the explorer tree, select a user under the Users root folder. 2 Right-click the user, and select Reset Password from the pop-up menu. 3 Click Yes to confirm that you want to reset the password. 4 The Password Change dialog box appears. Figure 133 shows the password change dialog box. Figure 133 Password Change Dialog Box

5 Enter the new password in the New Password field and then reenter the password in the Confirm Password field. 6 Click OK. Figure 134 shows the Operation complete dialog box. Figure 134 Operation Complete Dialog Box

7 Click OK. The password is set.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

192

Chapter 6: Maintenance

Changing User Access Rights

CEM supports two classifications of users: operator and browser. An operator has full rights to use all of the CEM capabilities. A browser has much more restricted rights and has essentially read-only capability. From within the CEM GUI, a user with browser rights cannot change any property values, invoke any pop-up menus, or run the CEM CLI client. To assign access right for an existing user: 1 In the explorer tree, select a user under the Users root folder. 2 Select the Identification tab. Figure 135 shows the Identification tab. Figure 135 Changing User Access Rights

3 On the Identification tab, double-click the Rights property and select either browser or operator from the drop-down list. CAUTION: If the only CEM GUI user is the Administrator, and you set the user rights to browser, when you login again as the Administrator, you cannot change the rights back to operator. If this happens, you will have to restart the CEM server with the -DfreshDB=yes option. All data will be lost. 4 you will have to use the CEM server console to change directory (cd) to the administrator object in the explorer tree and issue the set rights operator command. 5 Click Save all. The change will take effect the next time the user logs in.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Removing an Assigned Root View

193

Removing an Assigned Root View

If you have assigned a root view to a particular user, you can remove it by using the Remove command. To remove a user root view: 1 In the explorer tree, select a user under the Users root folder. 2 Right-click the user, select Root view, and then select Remove. The root view is no longer assigned to this user. For more information about logical and root views, refer to Creating Logical Views and Assigning a Root View to a User.

Forcing a Logout

An Administrator can force a user to logout. You can force a logout from either the CEM GUI or from the CEM server command line. This is particularly helpful to use before running maintenance procedures on your network. Before forcing a logout, it might be helpful to broadcast messages to the users you plan on logging out. For more information, refer to Broadcasting Messages to Users. To force a user to logout from the CEM GUI: 1 In the explorer tree, select a user under the Users root folder. 2 Right-click the user, and select Force Logout from the pop-up menu. A message appears letting you know the user has been logged out. 3 Click OK.

From the CEM GUI

From the Command Line

To force a user to logout from the command line: 1 Determine which CEM GUI or CEM CLI clients are logged in by entering the following command:
users

A display like the following shows current users:

User1 (User) at 04/08/2002 10:43:37 IP=192.1.1.1 Port=2089

2 Enter a logout command to log out each user. For example:

logout User1

A confirmation message displays, as shown here:

User1 has been logged out.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

194

Chapter 6: Maintenance

Deleting a User

To delete a user from the explorer tree: 1 In the explorer tree, select a user under the Users root folder. 2 Right-click the user, and select Delete from the pop-up menu. A message appears asking you if you want to delete this user. 3 Click Yes. To add and provision users, refer to Provisioning Users.

Deleting a Logical View

To delete a logical view from the explorer tree: 1 In the explorer tree, double-click the Logical Views root folder. 2 Right-click the logical view you want to delete. 3 From the pop-up menu, select Delete. 4 If you want to delete this logical view, click Yes in the verification dialog box. To add and provision logical views, refer to Creating Logical Views.

Deleting SNMP Devices and Folders

The CEM GUI lets you delete SNMP devices, device folders, bays, and racks from the explorer tree. Not all elements in the explorer tree can be deleted. The menu option may not be available for some sub-elements. To delete an SNMP device or folder: 1 In the explorer tree, select the element you want to delete. You cannot delete root folders in the CEM GUI. For more information, refer to Root Folders. 2 Right-click the element, and select Delete from the pop-up menu. A confirmation dialog box opens and asks if you are sure you want to delete the SNMP device or folder. 3 Click OK to delete the selected element. The selected element and all of its sub-elements, if any, are deleted. For example, if you delete an SNMP device folder, all SNMP devices in that folder are deleted. To add and provision SNMP devices, refer to Provisioning SNMP Devices.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Rediscovering an SNMP Device

195

Rediscovering an SNMP Device

When changing or replacing an SNMP device, or when upgrading software, it is necessary to rediscover the device so that the changes show in the CEM clients. To rediscover an SNMP device: 1 From the explorer tree, right-click an SNMP device. 2 From the pop-up menu, select Rediscover. Figure 136 shows the location of the Rediscover command. Figure 136 Rediscovering an SNMP Device

The rediscover window shows the Working icon during the rediscovery process. The Finished icon appears when the rediscovery process is complete. Figure 137 shows the rediscover finished window. Figure 137 Rediscover Finished Window

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

196

Chapter 6: Maintenance

3 When finished, click Close.

Changing the SNMP Version

The SNMP protocol version CEM uses to communicate with each device is set during device discovery. If the device's software is updated to support a different SNMP version, use this procedure to change the SNMP version setting. To change the SNMP version for the SNMP manager: 1 From the explorer tree, select the SNMP device. 2 In the right pane of the main window, select the SNMP Options tab. 3 Double-click the Protocol Version field. The drop-down list appears. 4 From the drop-down list, select one of the following:
n n n

Select v1 for SNMPv1 only Select v2c for SNMPv2c only. Select v3 for SNMPv3 only.

5 Click Save all.

Managing Logical Logs

Logical logs represent a subset of all events stored in the SQL database that share a common categorization. For example, all SNMP traps or all operator audit events. CEM provides different types of logical logs in the explorer tree:
n

Audit Log-The Audit Log logical log contains events which report all user actions performed from the CEM GUI and CLI clients. This is a comprehensive logical log. Security Log-The Security Log logical log contains events that show which users have accessed the CEM server. SNMP Trap Log-The SNMP Trap Log logical log provides a detailed list of SNMP traps generated by various SNMP devices in the network. Syslog Log-The Syslog Log logical log contains events generated by the Syslog daemon. The Syslog daemon converts all syslog messages received from provisioned SNMP devices into events. The Syslog Log logical log does not appear in the explorer tree until you provision SNMP devices to send syslog messages to the CEM server.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Managing Logical Logs

197

Figure 138 shows the explorer tree location for logical logs. Each logical log is a sub-element of the Logs root folder. Each CEM installation may have a different set of logical logs, depending on the optional packages installed on the CEM server. Figure 138 Logical Logs

logical logs

You can logically view event records associated with each logical log by using the Event Viewer application which comes bundled with CEM. For more information, refer to Using the Event and Alarm Viewer. Using the Event Viewer, you can successfully manage all incoming events for a particular logical log by acknowledging and deleting event records according to your customized needs. For more information, refer to Acknowledging Log Events and Deleting Log Events. The current size of a particular logical log is based on the configuration of several configurables within CEM. For more information, refer to Provisioning the Logical Log Size and Log Full Action. Continuously polling all network devices for new events severely impacts the rate at which CEM can log events. Because of this limitation, the actual number of events (Current Size) in the logical log, as shown in the Event Viewer, may exceed the configured maximum size (Max Size) until either CEM polls for new events during a daily purge or the Purge all command is executed. For more information, refer to Purging Log Events. Purging Log Events CEM does not monitor the logical log size until the log is purged manually or at the scheduled purge time. Because of this, it is possible for the current log size to exceed the set maximum size. If the collection of events contained in a particular logical log (the Current Size) exceeds the Max Size, you can purge excess event records. Purging records makes the Current Size equal the Max Size and halts or wraps based on the configuration of the Log Full Action configurable. For more information, refer to Provisioning the Logical Log Size and Log Full Action. You can configure CEM to automatically purge records on a daily basis, after a configured number of idle seconds, or when records reach a specified age. You can also manually purge excess event records using the Purge now maintenance command.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

198

Chapter 6: Maintenance

Automatically Purging Event Records To provision CEM to automatically purge event records on a daily basis: 1 From the explorer tree, right click one of the logical logs. 2 From the pop-up menu, select Edit Purge Policy. The SNMP Trap Log Purge Policy window appears. Refer to Figure 139. Figure 139 SNMP Trap Log Purge Policy

3 To schedule a log purge to occur at a specific time every day, check the Daily at checkbox and then select or enter an hour and minute (in 24 hour format). 4 To schedule a log purge to occur when the log goes idle (hasn't received any log messages) for a specified number of seconds, check the Continuously after checkbox and then enter the number of seconds the log file must be idle before the log is purged. 5 To purge records that are older than a specified number of days, check the Purge records older than checkbox and then specify the age, in days. 6 Click Save all. You can find an event record of this daily purge in the Server Console Log. For more information, refer to Viewing Server Console Logs. The Maximum log records settings set whether the log wraps around or stops once the set maximum is reached. Refer to Provisioning the Logical Log Size and Log Full Action. Manually Purging Event Records Instead of waiting for the daily purge, you can manually purge events by executing the Purge all maintenance command at any time. To manually purge event records from a logical log: 1 From the explorer tree, double-click the Logs root folder. 2 Right-click a logical log. 3 From the pop-up menu, select Maintenance and then select Purge now. CEM purges all excess event records from the selected logical log based on the configuration of the Max Size and Log Full Action configurables.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Managing Logical Logs

199

Monitoring the Availability of Logical Logs

Each logical log has an additional Availability Status attribute. This is modeled after standards set in ITU X.7xx. Use this field to monitor the status of a logical log. To monitor the availability for a logical log: 1 From the explorer tree, select one of the logical logs. 2 On the right-hand pane, select the State tab. The Availability Status field indicates the operational state of a particular logical log: Table 35 Availability Status for Logical Logs
Status Type available offLine Description The logical log is actively logging all events. The logical log is currently not logging events. CEM has halted event processing based on the Log Full Action configurable. For more information, refer to Provisioning the Logical Log Size and Log Full Action. To restart logging, refer to Restarting Event Logging. failed degraded A problem exists in the database and all logging for this logical log failed. The logical log is actively logging events; however, it has probably reached the maximum number of events as described in Provisioning the Logical Log Size and Log Full Action. The logical log is not logging any events due to reaching the maximum number of events as described in Provisioning the Logical Log Size and Log Full Action.

logFull

Clearing All Event Records

CEM provides a command which clears, or deletes, all event records to the database associated with a particular logical log. To clear all event records in a logical log: 1 From the explorer tree, right-click one of the logical logs. 2 From the pop-up menu, select Clear All Records. CEM clears all existing event records in a particular logical log.

Stopping Event Logging

To stop adding new event records to a logical log: 1 From the explorer tree, double-click the Logs root folder. 2 Right-click one of the logical logs. 3 From the pop-up menu, select Stop Logging. CEM stops event logging for the selected logical log. A red status indicator replaces the green status indicator.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

200

Chapter 6: Maintenance

Restarting Event Logging

To begin adding new event records to a logical log: 1 From the explorer tree, double-click the Logs root folder. 2 Right-click one of the operation logs. 3 From the pop-up menu, select Start Logging. CEM resumes event logging for the selected logical log. A green status indicator replaces the red status indicator.

Using the Event and Alarm Viewer

Launching the Event Viewer

You can view events contained in logical logs using the Event Viewer which is packaged with the CEM GUI. The event viewer can display all events, current alarms, and historic alarms. Launch the Event Viewer by right-clicking any component in the explorer tree, selecting view and then one of the following:
n n

All Events-all current events. Current Alarms *-All current events with a severity of critical, major, minor, or warning. Historical Alarms* - All alarms that have been cleared.

*Current and historical Alarms are only available when using an external database. All Event Viewer windows have the same format and functionality. Also, you can launch multiple Event Viewer windows at the same time. Filter your event search based on which component you select in the explorer tree:
n n

Tree Root-shows all events in the CEM database Logical Log-shows only the events associated with a specific category (for example, all SNMP traps) User-shows all events associated with a specific user Any other selected object-shows all events associated with a selected object in the explorer tree (for example, server, card, chassis, device folder)

n n

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using the Event and Alarm Viewer

201

Viewing Log Events

To view events for logical logs using the Event Viewer: The Log events window opens. Figure 140 shows the Log events window for audit log events. Figure 140 Log Events Window

The left-hand pane of the Event Viewer window lists all events associated with a particular logical log or a particular object. You can customize this display according to your specific needs. For more information, refer to Customizing the Event Viewer Window. 4 On the left-hand pane of the window, select a log event. Details for the selected log appear on the right-hand pane of the Event Viewer window. You can select multiple log events. However, if multiple events are selected, only the details for the first event selected will be shown in the right-hand pane of the Event Viewer. For more information, refer to Selecting Multiple Log Events. To hide details about a particular log event, click Hide details at the bottom of the Event Viewer window. 5 When finished viewing events, click Cancel to close the Event Viewer. Sorting Log Events To sort events, click the column title in the event viewer. If the table can be sorted by the selected column an up or down arrow appears after the column name. An up arrow indicates ascending order while a down arrow indicated descending order. Click the column again to sort in the reverse order. If no arrow appears, the table cannot be sorted by the current column.
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

202

Chapter 6: Maintenance

Selecting Multiple Log Events

To select multiple events using the standard multiple selection keyboard assist: 1 In the Event Viewer window, select one row. 2 Press Shift and click on a different row to select all rows between the currently selected row and the ending row. 3 Press Control and click to randomly select or deselect any number of different rows. Once rows are selected, you can either delete them or acknowledge them. For more information, refer to Deleting Log Events and Acknowledging Log Events.

Customizing the Event Viewer Window

You can customize the Event Viewer window to display the information you want to see in various column and color formats. The selections you customize for the Event Viewer Window are persistent for each CEM user. If the user logs out, the settings are retained. To customize the Event Viewer window: 1 From the Event Viewer window, click Options. The Options window opens. Figure 141 shows the Options window. Figure 141 Options Window for Log Events

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using the Event and Alarm Viewer

203

2 From the Options window, click the Columns tab. The left-hand pane of the Event Viewer window, as shown in Figure 140, provides four default columns of information for each log event: Sev (severity of the event), Ack (acknowledgement of the event), Logged (date and time the event was logged), and Event (description of the event). These four columns are organized on the left-hand pane based on the default configuration. Use the Columns tab to add, remove, and organize additional columns of information, as listed in Table 36, to the event display on the left-hand pane of the Event Viewer window. Table 36 Event Viewer Details
Field Sev Description This field contains icons which represent the severity of the event:
n n n n n n n n

critical-red major-magenta minor-orange warning-blue informational-lightGray indeterminate-darkGray cleared-green unknown-darkGray

These are the default colors for each severity. You can change the colors to fit your customized needs. For more information, refer to Customizing the Event Viewer Window. Ack This field indicates if any user has acknowledged the event. An X displays in the Ack column (on the left-hand pane) if any operator has acknowledged the event. For more information, refer to Acknowledging Log Events. This field indicates the time an event is reported by the device. This is taken directly from an SNMP trap or syslog message. Most events do not populate this field. This field indicates the time CEM logs an event. This field indicates the label of the event. A tooltip is assigned to each event cell that contains the entire label of the event. This field indicates the label of the object identified to be the source of the event. A tooltip is assigned to show the fully-qualified name of the object. This field indicates the IP address of the SNMP device sending the event. For non-SNMP trap and syslog events, this field is blank. This field indicates the label of the user identified to be the source of the event. If no user is associated with the event, this field may be blank. For example, traps have no associated user. This field indicates the label of the log this event was entered into. This field indicates the internal sequential number of the event. CEM allocates a unique number to all events. This field indicates the internal CEM identifier for the type of event. This ID is helpful when creating a custom script that is triggered when this type of event is generated.

Reported (time)

Logged (time) Event Source

Source IP User

Log Number ID

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

204

Chapter 6: Maintenance

Table 36 Event Viewer Details (continued)

Field Description Probable Cause Additional Text Description This field indicates a more detailed description of what the event means (if known). This field indicates the probable cause of the event (if known). Some events may have additional text related to the event.

3 Next to each field on the Columns tab, click the drop-down list and choose the desired order number. A maximum of 14 different fields (or columns of information) are available to add to the Event Viewer window, as shown in Figure 141. This tab is dynamic and the columns are reordered based on your customization. 4 When finished customizing the Options window, click OK. The log events window changes to reflect the new customization. To change the event colors, refer to Customizing the GUI Client Environment in the Provisioning chapter. Configuring Event Logging and Forwarding Filtering Use the Server Configuration option to configure the logging and forwarding of events or event categories. CEM cannot be configured with different logging and forwarding filters for different trap destinations. This option is only available when using an external database.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using the Event and Alarm Viewer

205

To configure the logging and forwarding of events or event categories: 1 From the Tools menu, select Server Configuration. The CEM Server Configuration window appears. Figure 142 CEM Server Configuration Window

The Event column shows all the event categories (identified by a folder icon) and individual events in an expandable tree layout. All events fall into some category. The Log and Forward columns specify the logging and forwarding filter rules of individual events and event categories. The Severity column indicates the event's severity. The severity of each event can be changed (refer to Configuring Event Severity).

2 To filter when the event is logged or forwarded, select an event or a category, double click that row's log or forward column, and then select one of the following:
n

inherit - the event will be logged, or forwarded, based on the setting of the higher level category.
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

206

Chapter 6: Maintenance

always - the event will always be logged, or forwarded, independent of the setting of the higher level category. never - the event will never be logged, or forwarded, independent of the setting of the higher level category.

The color of the individual setting depicts the net affect of the configuration on the individual events and categories.
n n

green - means that the event will be logged, or forwarded red - means that the event will NOT be logged, or forwarded

CEM converts all traps found in the MIBs to events that can be configured to be logged and/or forwarded as necessary. All trap-related events are found under the FDSNMPEvent category. This allows the operator to specify the logging and forwarding filter for an entire set of traps found in a MIB module. Configuring Event Severity Use the Server Configuration option to configure the severity of individual events. Changes made to the severity of an event affect CEM globally, not just the CEM client that made the change. This option is only available when using an external database. To configure the severity of individual events: 1 From the Tools menu, select Server Configuration. The CEM Server Configuration window appears. Refer to Figure 142. 2 To filter when the severity of an event, select an event, double click that row's severity column, and then select one of the following:
n n n n n n n

CRITICAL-most severe alarm MAJOR - a major alarm MINOR-a minor alarm WARNING-a warning INFORMATIONAL-informational CLEARED-clears all previous alarms INDETERMINATE-not sure what the severity is

Any changes to a TRAP severity overrides the severity normally coded in the ASN.1 MIB specifying the trap.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using the Event and Alarm Viewer

207

Exporting Current Events

You can export all the events shown in the event list to a file. To export events: 1 From the Event Viewer window, click Options. The Options window opens. Refer to Figure 141. 2 From the Options window, click the Export tab. Refer to Figure 143. Figure 143 Options Window - Export Events

3 In the Export to file field, enter a file name and browse to the location the file will be saved. 4 To export the information to the selected file, click Export now. 5 Click OK. Refreshing Log Events To view real-time event logging information, click Refresh at the bottom of the Event Viewer window, as shown in Figure 140. To enable auto refresh for event logging, select the Auto Refresh checkbox at the bottom of the Event Viewer window. This disables the Refresh button. If Auto Refresh is selected, the Event Viewer window continuously monitors for any new events generated at the CEM server and updates the list accordingly. Using the Auto Refresh feature during a time of high event rates slows down the CEM GUI. NewNet recommends that you disable the Auto Refresh feature if the event rates are high.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

208

Chapter 6: Maintenance

Acknowledging Log Events

After reviewing events, use the acknowledge feature to mark events you have previously reviewed. This features helps you keep track of old and new events. To acknowledge events from the Event Viewer: 1 In the Event Viewer window, select one or more in the list of events. For more information, refer to Selecting Multiple Log Events. 2 In the details section of the Event Viewer window, select the Acknowledged checkbox. Figure 144 shows the Log Events Window. Figure 144 Log Events Window

Acknowledgment checkbox

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Uninstalling CEM Components

209

All selected events are acknowledged with an X in the left-hand pane (Ack column) of the Event Viewer window. Refer to Figure 145. Figure 145 Acknowledgement of Events

The events you acknowledge in the Event Viewer Window are persistent for each CEM user. If the user logs out, the settings are retained. To un-acknowledge events, select the events and select the Acknowledged checkbox. The X is removed from the Ack column. Deleting Log Events You can delete one or more events from the Event Viewer. From the Event Viewer window, select one or more events (refer to Selecting Multiple Log Events) and click Delete at the bottom of the window.

Uninstalling CEM Components

Using Windows Shortcut Options

You can uninstall CEM software components using either Windows shortcut options or the CEM command prompt. To uninstall CEM software components using Windows shortcut options: 1 Click the Start button, select CEM and click CEM Uninstaller. A command prompt window and the Common Element Manager Uninstaller wizard open. CAUTION: Make sure all CEM GUI and CEM CLI clients are logged off and the CEM server is not running before uninstalling any CEM component. 2 Minimize the command prompt window.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

210

Chapter 6: Maintenance

3 From the Common Element Manager Uninstaller wizard, click Next. 4 Click Next. The Common Element Manager Uninstaller window changes to list all CEM software components installed on your workstation (CEM server, CEM GUI, and CEM CLI). When you uninstall the CEM server, you uninstall both core and package software components. Figure 146 shows the Common Element Manager Uninstaller window. Figure 146 Selecting Components to Uninstall

5 Select the CEM components you want to uninstall and click Next. 6 Click Next. 7 Click Finish. CEM completes the uninstallation process by removing most of the files and directories created by InstallShield during initial installation. If any new files or directories have been created after initial installation, these files and directories are assumed to be user-specific files and will not be removed during an uninstallation. These files may include new CFM files, server console logs, and daily audit logs. If you choose, you can manually delete these files and folders. If you have installed the CEM GUI or CEM CLI clients on different workstations, use this procedure to uninstall those components.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Uninstalling CEM Components

211

Using a Command Prompt

Before uninstalling the CEM server, you must uninstall all individual packages first. Uninstalling CEM Packages CAUTION: If you have installed any packages, you must uninstall all packages before attempting to uninstall the CEM server. To uninstall CEM packages using a command prompt: 1 Determine if any CEM GUI or CEM CLI clients are logged on by entering the following command:
users

A display shows current users. For example:

Administrator (Administrator) at MM/DD/YYYY HH:MM:SS IP=192.1.1.1 Port=2089

2 Enter a logout command to log out each user:

logout Administrator

A confirmation message displays, as shown here:

Administrator has been logged out.

3 From the CEM server command prompt, enter the following command to determine which packages are installed on your workstation:
inventory

The following message displays at the command prompt:

Installed packages: HDV10:Common Element Manager 5115 for HDV 1.0 Version 1.0.7 CORE:Common Element Manager Core Package Version 1.0

CAUTION: The CORE package in the inventory list is not a valid package. Do not try to uninstall the CORE package. 4 Uninstall each package using the following command:
uninstall <package_name>

For example:
uninstall VOIP24

5 You are now ready to uninstall the CEM core itself. For more information, refer to Uninstalling the CEM Core.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

212

Chapter 6: Maintenance

Uninstalling the CEM Core The CEM core can be un-installed only when all clients are logged off. The uninstallation process does not check this, nor will it force the CEM server to be shut down. 1 Determine if any CEM GUI or CEM CLI clients are logged on by entering the following command:
users

A display like the following shows current users:

Administrator (Administrator) at MM/DD/YYYY HH:MM:SS IP=192.1.1.1 Port=2089

CAUTION: Make sure all CEM GUI and CEM CLI clients are logged off and the CEM server is not running before uninstalling the CEM server. 2 Enter a logout command to log out each user, as shown here:
logout Administrator

A confirmation message displays, as shown here:

Administrator has been logged out.

3 Make sure you stop all running instances of the CEM server. 4 From a command prompt, navigate to the main folder where the CEM software files are located. This is typically C:\Program Files\CEM (Windows default installation) or /opt/CEM. 5 Navigate to the uninstall folder. The uninstall folder contains the uninstall.jar executable file. 6 From the uninstall folder, enter the following command:
java -jar uninstall.jar

The Common Element Manager Uninstaller wizard opens. 7 Click Next and then click Next again.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Relicensing the CEM Server

213

The Common Element Manager Uninstaller window changes to list all CEM software components installed on your workstation (CEM server, CEM GUI, and CEM CLI). Figure 147 Selecting Components to Uninstall

8 Select the CEM components you want to uninstall, and click Next. 9 Click Next. 10 Click Finish. CEM completes the uninstallation process by removing most of the files and directories created by InstallShield during initial installation. If any new files or directories have been created after initial installation, these files and directories are assumed to be user-specific files and will not be removed during an uninstallation. These files may include new CFM files, server logs, and audit logs. If you choose, you can manually delete these files and folders. If you have installed the CEM GUI or CEM CLI clients on different workstations, use this procedure to uninstall those components.

Relicensing the CEM Server

Once a license key has been entered and accepted, the CEM server does not request this information in subsequent starts. To force the server to prompt for the license information so that you can enter a different license key (for example, to increase the device limit or extend the expiration date), use the -license command line optional parameter. To use this option, start the CEM server using the following command:
runServer -license

You cannot relicense the CEM server using Windows shortcut options.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

214

Chapter 6: Maintenance

Using this option will force the license prompt to be presented to the user while the server is starting up. The newly entered license key will only be used and stored if it is a valid license key, and the hostname used for generating the license key matches the hostname for the workstation. For more information, refer to Starting the CEM Server.

Upgrading CEM

If you have a previously installed version of CEM and would like to upgrade to a newer version, use the following procedure. To upgrade redundant CEM servers, refer to Upgrading Redundant CEM Servers. The NewNet CEM cannot be installed in the same location as a previous CommWorks branded version of CEM. To upgrade from a CommWorks branded release, refer to Upgrading from Non-NewNet CEM. To upgrade CEM: 1 If the CEM server is running, make sure all users are logged off and stop the server. 2 Replicate any server modifications you made in the original server.properties file to a new override.properties file. a Create a text file named override.properties in the CEM root directory. b Copy any changes you made to variables in the old server.properties file to the new override.properties file. For example, to change the default port used by the CEM FTP Server, paste the following line to the override.properties file: FtpServer.server.config.port=21 and modify the variable with the new port number. When CEM is started, it reads the override.properties file, and automatically updates the new server.properties file. 3 Replicate any changes made in the original client.properties file to the new client.properties file. 4 Install the newer CEM Core software where the CEM server is currently installed. For more information, refer to Installing CEM Software Components. Make sure you install CEM in the existing directory where CEM is currently installed. If you fail to do this, a second copy of CEM will be installed in a different directory, rather than replacing the files in the existing directory. 5 Restart the CEM server. All of the previous settings are imported into the new CEM server database. 6 From the CEM server command prompt, enter the upgrade command:
upgrade packageName

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Upgrading from Non-NewNet CEM

215

where packageName indicates the short name of the previously installed CEM package (for example, VOIP24). Find the name of the package by using the inventory CEM server command. CAUTION: The CORE package in the inventory list is not a valid package. Do not try to upgrade the CORE package. 7 When prompted, enter the full path name of the newer CEM package. Enter the fullPathNameOfPackage.jar. For more information, refer to Starting the CEM Server. 8 When prompted, enter the license key for the specific CEM package. A package cannot be installed without a unique license key. 9 When the process completes, restart the CEM server.

Upgrading from Non-NewNet CEM

Use this section to upgrade from a previous CommWorks branded version of CEM to the current NewNet CEM. The NewNet CEM cannot be installed in the same directory as a previous CommWorks branded version of CEM. To upgrade from a previously installed NewNet version of CEM, refer to Upgrading CEM. If you are using a commercial database such as Oracle or MySql, skip to step 3, otherwise the existing database must be exported and used in the final step of the upgrade. To upgrade to NewNet CEM: 1 Start the currently installed version of CEM. 2 From the CEM Server command prompt, enter the following command:
db export migrate

This exports all information in the database to <oldcemRoot>/db_backup/migrate.tsv 3 If the CEM server is running, make sure all users are logged off and stop the server. 4 Install the newer CEM Core software in a different directory than the directory where the old CEM was installed. For more information, refer to Installing CEM Software Components. 5 Restart the CEM server and re-enter your original server license key. If you are using a commercial database, you may see a variety of warnings about ...No <class name=xxx... Ignore these messages until the final step. 6 Install the NewNet brand CEM Packages. Repeat this step for each package.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

216

Chapter 6: Maintenance

a From the CEM server command prompt, enter the package installation command: install <fullPathNameOfPackage>.jar where <fullPathNameOfPackage.jar> is the path and filename of the package .jar executable file. For example, c:\temp\UP20.jar The following message appears: MM/DD/YYYY HH:MM:SS (I) Please enter your license for package <fullPathNameOfPackage.jar> : b When prompted, enter the license key for the specific CEM package. A package cannot be installed without a unique license key. After initialization, the following message appears: MM/DD/YYYY HH:MM:SS (I) Server needs to be restarted for changes to take effect. Restart (y/n)? c To restart the CEM server, enter y. For installation changes from both .jar executable files to take effect, you must restart the server application. This command only restarts the CEM server application, not the hardware on which the CEM server is installed. After restarting, the server command prompt displays in the CEM Server window. For example: CEMServer#station3> Some older CEM Packages are incompatible with the NewNet brand CEM Server. If you attempt to install an incompatible package, you will see the following message: ******************************************************* * The package is not compatible with this CEM Server. * * Please contact NewNet for an updated release. * ******************************************************* Contact NewNet to make arrangements to obtain the updated version. 7 Stop the server. 8 Replicate any server modifications you made in the original server.properties file to a new override.properties file. a Create a text file named override.properties in the CEM root directory. b Copy any changes you made to variables in the old server.properties file to the new override.properties file. For example, to change the default port used by the CEM FTP Server, paste the following line to the override.properties file: FtpServer.server.config.port=21
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Upgrading Redundant CEM Servers

217

and modify the variable with the new port number. When CEM is started, it reads the override.properties file, and automatically updates the new server.properties file. 9 Replicate any changes made in the original client.properties file to the new client.properties file. 10 If you are using a commercial database, start the server normally, otherwise, do the following: a Manually copy the exported database file from <oldcemRoot>/db_backup/migrate.tsv to <newcemRoot>/db_backup/migrate.tsv b Start the server using the dbmigrate startup option. For example:
runServer -dbmigrate

If you mistakenly install the NewNet brand in the same location as the previous version, CEM detects this situation and displays an error message. CEM automatically exports the old data if you are not using a commercial database. Restart this procedure at step 4. After you are satisfied that the new NewNet CEM is working properly, you can safely uninstall the older version.

Upgrading Redundant CEM Servers

To upgrade redundant CEM servers: 1 Stop the standby server. 2 Upgrade CEM server and the CEM package(s) on the standby server (refer to Upgrading CEM). 3 Restart the standby server and verify that it is in standby mode. 4 Stop the active server. This triggers the standby server to become the active server. 5 Upgrade CEM server and the CEM package(s). Refer to Upgrading CEM. 6 Restart this server (the previously active server that is now inactive). 7 To switch the currently inactive server back to active, from the currently active server's CEM server command prompt, enter the restart command. 8 The inactive server becomes the active server and the active server restarts into standby mode.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

218

Chapter 6: Maintenance

Importing SDL Files for Device Upgrades

You can use CEM to upgrade individual SNMP devices in your network. Before upgrading, import software download (SDL) files from another location into the software_upgrades folder located on the workstation housing the CEM server. To upgrade the software on NewNet SNMP devices (card and server-specific upgrades), refer to product line-specific documentation for detailed information. To import SDL files into the software_upgrades folder: 1 From the menu bar, select File and then select Import SDL Files. Figure 148 shows the Import SDL Files dialog box. Figure 148 Importing SDL Files

2 Use the Look in drop-down list to search for the desired software SDL file. 3 When you find the desired software SDL file, select the file in the file viewer and click Import. CEM imports the SDL file and places it in the software_upgrades folder.

Removing HP OpenView Integration

To remove HP OpenView integration using the command prompt, enter the following command from the CEM server command prompt:
rmov_integration

Logs of the integration removal are located in the .../CEM/hopv/integration/rmov_install.log file.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Compacting Embedded Databases on Server Startup

219

Compacting Embedded Databases on Server Startup

When using the embedded InstantDB database, no database replication or redundancy exists. This is the designed behavior of InstantDB. For more information, refer to Limitations. Since the actual database resides on the same workstation as the CEM server, the InstantDB database can become quite large after prolonged usage (available disk space also becomes significantly smaller), impeding the performance of CEM. If this is the situation, you can provision CEM to either manually compact the database on server startup (one-time event) or automatically compact the database each time the CEM server starts. Compaction helps conserve space and increases server performance. If you feel your network is too large, you may need to use a compatible external database. For more information, refer to External Databases. CAUTION: Depending on the size and configuration of your network, database compaction may take a considerable amount of time. NewNet recommends using the manual compaction option in most cases.

Manually Compacting Databases

To manually compact the InstantDB database on CEM server startup: 1 From a command prompt, navigate to the folder where the FDServer.jar executable file is located. You cannot compact databases using Windows shortcut options. 2 From the folder containing the FDServer.jar executable file, enter the following command:
runServer -compact

The command prompt window displays the progress of the database compaction and the CEM server startup sequence. Automatically Compacting Databases To provision CEM to force an InstantDB database compaction each time the CEM server starts: 1 Before provisioning CEM to force an InstantDB database compaction each time the CEM server starts, check the size of your database to make sure it is within the normal operational range (in accordance with your workstation and network configuration). a In the explorer tree, select the CEM server root node. The CEM server is the first node in the explorer tree. Typically, it is the hostname of the workstation where your CEM server resides. b In the left-hand pane of the CEM GUI main window, select Performance.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

220

Chapter 6: Maintenance

Figure 149 shows the Performance tab. Figure 149 Checking the Database Size

c Check the DB Size (bytes) field for the current size of your database. 2 Using a standard text editor, open the server.properties file. 3 Copy the Persistent DB properties section, and paste it into the override.properties file. Refer to Modifying Server Properties in Chapter 4. 4 Close the server.properties file without making changes. 5 Uncomment the compactOnStartup line. This feature only applies for CEM servers using the embedded, InstantDB database. Figure 150 shows how to uncomment the compactOnStartup line. Figure 150 Uncommenting the compactOnStartup Line
remove the pound sign

#compactOnStartup=yes 6 Save and close the override.properties file. 7 For these changes to take effect, stop and restart the CEM server. When CEM restarts, it will begin database compaction. If you have a lot of SNMP devices in your network, this may take a considerable amount of time. Also, the CEM server is unavailable during the database compaction process.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

TROUBLE LOCATING AND CLEARING

This chapter contains trouble locating and clearing information applicable to common element manager (CEM) installation. This chapter contains the following topics:
n n n n

Recovering from Power Failures Encountering an Unsupported SNMP Device Using the Refresh Button Known Issues

Recovering from Power Failures

After an unexpected power failure, a CEM server may restart in a mode that results in extremely poor performance. Use the following procedure to recover existing database information: This only applies to CEM servers using the default embedded database. 1 When restarting the server after an unexpected power failure, you may see the following message display in the CEM server command prompt window:
Database not shut down cleanly or in use by another program. Set recoveryPolicy=1 for automatic recovery. Note that it is dangerous to proceed if another program is currently accessing this database. Should InstantDB attempt recovery now? (y/n)

2 If you see a similar message, enter y from the command prompt. 3 Watch for any additional messages which may display in the CEM server command prompt window. For example:
Error binding index: AttributesName java.sql.SQLException: Row already exists: Row nnnnn nnnnn nnnnn:name in table Attributes Detected by index AttributesName Index will be dropped from database.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

222

Chapter 7: Trouble Locating and Clearing

4 If you see the "Index will be dropped from database." message, CEM will proceed to automatically reorganize its internal database to recreate the index. This operation can take considerable time, depending on the size of your database.

Encountering an Unsupported SNMP Device

When a bad or unsupported SNMP device is encountered during the discovery process, the bad or unsupported device is flagged as such and any, as yet, undiscovered cards remain undiscovered. In order to finish the discovery process for the rest of the components, you must remove the bad or unsupported device and rediscover the device. To rediscover an unsupported SNMP device: 1 The initial discovery process reveals, in this example, an unsupported card. The unsupported card is identified, as shown in this figure: Figure 151 Unsupported SNMP Device

2 Remove the card flagged as bad or unsupported from the chassis. 3 Rediscover the SNMP device. For more information, refer to Rediscovering an SNMP Device.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Using the Refresh Button

223

Using the Refresh Button

The viewing and monitoring screens described in this guide contain mechanisms like Virtual Front Panel Displays (VFPDs), Refresh buttons, and Status tabs to provide updated information. These screens are not updated, however, when a device is removed or replaced. When a card or server is removed or replaced, close the viewing and monitoring screens and rediscover the SNMP device before reopening the viewing and monitoring screens. For more information on rediscovering an SNMP device, refer to Rediscovering an SNMP Device.

Known Issues
Installation Issues

The following sections contain various known issues with CEM. Issue: On UNIX systems, the CEMSetup.jar cannot be run from the root directory successfully. This is an issue with the Installshield installation program documented as issue Q105633. Workaround: Run CEMSetup.jar from any directory other than the root directory. Issue: On various UNIX systems, both the Server and Client portions of CEM are installed, regardless of which option is chosen during installation. Workaround There is no known workaround. This is an issue with the Installshield installation program. Issue: When CEM server is integrated with HP Openview, it is possible to launch the GUI client from HP Openview. However, if the GUI client was not installed, the GUI will fail to launch. Workaround: Do not attempt to launch the GUI client if it is not installed. Alternatively, install both the server and GUI client. Issue: After upgrading CEM in RedHat Linux 9.0, CEM permissions were not set to executable. Workaround: Manually add the execute permission using these commands:
n

chmod +x runServer chmod +x runGUIClient chmod +x runCLIClient chmod +x runServerMonitor

Issue: After upgrading CEM on RedHat Linux 9.0 it is not possible to upgrade the NEXTGEN package. Workaround: Use this procedure to upgrade the NEXTGEN package after a CEM upgrade on RedHat Linux 9.0: a Execute the inventory command on the CEM Server console.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

224

Chapter 7: Trouble Locating and Clearing

b Make a note of the packages currently installed. c Un-install the CEM core software only d Install the new CEM core software e Upgrade the CEM packages. f Execute the inventory command on the CEM Server console. The new version for the packages appear. g Ensure that the proper permissions are set for CEM executables. Provisioning Issues Issue: CEM does not support Auto-Response. None. This is by design; there is no workaround.

Workaround: Operation Issues

Issue: When CEM is deployed using an Oracle database, NewNet has noticed that the Oracle JDBC Driver has an unusually long timeout period [10-15 minutes] to detect a network connectivity problem between the JDBC Driver and the Oracle Server. While CEM waits for Oracle to either complete the database operation, or timeout, the CEM Server and/or Client will appear to be frozen. If connectivity is restored during this period, all operations complete successfully. Workaround: The system administrator can configure the TCP/IP connection timeout period to better match the performance and reliability of their network but setting TCP/IP low level driver parameters. Solaris: Use: >ndd /dev/tcp tcp_ip_abort_interval timeoutMS

where timeoutMS is timeout period in milliseconds (i.e.: 120000 = 2 minutes). See http://www.sunhelp.org/faq/tcp_faq.html for more information. Windows 2000/NT/XP: An additional registry key and value must be added to the system. Refer to Table 37. Table 37 Windows Registry Additions for TCP/IP Connection Timeout Period
Key Value Type Valid Range Default HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ Tcpip\Parameters\ TcpMaxDataRetransmissions REG_DWORD - Number 0 - 0xFFFFFFFF 5 This parameter controls the number of times TCP will retransmit an individual data segment (non connect segment) before aborting the connection. The retransmission timeout is doubled with each successive retransmission on a connection. It is reset when responses resume. The base timeout value is dynamically determined by the measured round-trip time on the connection.

Description

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Known Issues

225

Access this URL for more information: www.microsoft.com/technet/itsolutions/network/deploy/depovg/tcpip2k.mspx Issue: CEM does not allow a user to SSH onto a device from a GUI client running on a workstation other than the machine the CEM Server is running on. Workaround: Manually copy the <jre>/lib/ext/mindterm.jar file located on the CEM Server to the similar location on any client workstation. Issue: When the CEM GUI client is launched, some Warning messages may appear repeatedly as the login screen is loaded. Workaround: None required. The Warning messages are the result of a known problem in JRE version 1.5 and later. They do not affect product performance in any way. The operator can ignore the Warning messages. Issue: The CEM Refresh button does not update data in 3G reports currently on display. Workaround: None. By design, the CEM Refresh button operates in the same fashion as a web browser refresh button: it only reloads the report page. The CEM Refresh button is not designed to re-generate the entire report and update the data.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

II
Chapter 8 Chapter 9 Chapter 10 Chapter 11 Chapter 12 Chapter 13

USING CEM VALUE-ADDED PACKAGES

Performance and Capacity Manager Advanced Configuration Manager Device Learning Wizard CDR Server CEM Notifications Performance Monitor

PERFORMANCE AND CAPACITY MANAGER

This chapter describes how to use the CEM Performance and Capacity Manager (PCM) value-added package.
n n n n

PCM Overview Installing PCM Working with PCM Data Collection Working with Scheduled Reports

This chapter assumes CEM is installed and configured. For information on installing and configuring CEM, refer to Chapter 3.

PCM Overview

PCM enhances a CEM Server by providing data collection and reporting functionality on any device supported by CEM. PCM allows the user to:
n n n n n n n n n n

Collect and store historical data of any property value represented in CEM Graphically display collected historical numeric and non-numeric data Specify start and end times when this data is collected Indicate threshold levels that trigger events during data collection Forecast when data will reach critical levels Analyze data by hour, day, and week using a graphical representation tool Export raw data for analysis by external applications Establish purge levels to remove older information from a database View real-time data via the Performance Dashboard Monitor Provision and generate custom performance reports at specified repeating intervals

A Data Collector is a scheduled event created and managed in CEM to collect and store information in a database. Any data object recognized in CEM can be tracked and saved into a supported database. An administrator can provision PCM data collection to specify what data to collect, which equipment to collect data from, and how often to collect data (including optional start and stop times).
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

230

Chapter 8: Performance and Capacity Manager

Once Data Collectors are defined, data is continually collected independently of CEM users; an administrator does not have to be actively logged in. The PCM package is installed on a compatible CEM Server, similar to other package upgrades available on a CEM Server. For additional information about working with packages on CEM, refer to the Common Element Manager User Guide.

Installing PCM

A feature key is required to install the CEM PCM package. Refer to Installing a CEM Package in Chapter 3 for the installation procedure. Once installed, the Scheduled Reports folder appears as a sub-folder under the Scheduled Events folder folders in the CEM Explorer tree. Refer to . Figure 152 PCM (Scheduled Events and Scheduled Reports) Icon

Scheduled reports Icon

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

231

Working with PCM Data Collection

This section provides information on adding, configuring, and working with Data Collector scheduled-event information gathered by Performance Capacity Manager (PCM). This section contains the following topics:
n n n n n n n n n n n n n n n n n n n

Adding a Data Collection Folder Adding a Data Collector Labeling a Data Collector Selecting Data Collector Targets Specifying Data Collection Filters Indicating Trigger and Clear Levels Threshold Logs Specifying Start and Stop Times Viewing Data Collector Information Viewing Historical Data Forecasting Exporting Data to CSV Exporting Data to TSV Establishing Purge Policies Forcing Data Collection Enabling and Disabling Data Collectors Editing Data Collector Settings Resetting Counters Deleting Data Collectors

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

232

Chapter 8: Performance and Capacity Manager

Adding a Data Collection Folder

When many Data Collectors are needed for a variety of SNMP objects, add Data Collection Folders to sub-divide Data Collectors by device, location, or another scheme that fits the network. To add a Data Collection folder in the CEM explorer tree: 1 Double-click the Scheduled Events folder. The Data Collectors folder appears. Figure 153 Data Collectors Folder

2 Right-click the Data Collectors folder. 3 From the New menu, select Data Collector Folder. The New Data Collector Folder window appears. Figure 154 New Data Collector Folder Window

4 In the Enter New Label field, enter a name for the Data Collector Folder and click OK. The new Data Collector Folder appears in the CEM explorer tree.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

233

Adding a Data Collector

Data Collectors gather historical performance metrics for devices on a network. When adding a Data Collector, start and end periods are specified, as well as specific threshold levels to trigger events during data collection. Every value available in CEM can be added to a Data Collector. When adding a Data Collector, a wizard is available to guide you through the process. There are two ways to add Data Collectors:
n

Starting at the Scheduled Events Folder-this starts the Data Collector Wizard at the top of the explorer tree. Starting at an Individual Data Field-this starts the Data Collector Wizard at a more precise device field.

Adding a Scheduled Event Data Collector Adding a Data Collector from the Scheduled Events folder launches the Data Collector Wizard with no defined information. You must select which field or fields to collect data from. To add a Data Collector to the Scheduled Event Folder: 1 In the Scheduled Event folder, right-click Data Collectors. 2 From the New menu, select Data Collector. The Data Collector Wizard appears. 3 For information on specific Data Collector options the Wizard offers, refer to the following sections of this guide:
n n n n n

Labeling a Data Collector Selecting Data Collector Targets Specifying Data Collection Filters Indicating Trigger and Clear Levels Specifying Start and Stop Times

Adding a Specific Field Data Collector Adding a Data Collector from a specific field launches the Data Collector Wizard with information on what node in the CEM explorer tree to collect data from. To add a Data Collector for a specific field: 1 In the CEM explorer tree, navigate to a field you wish to track data for. 2 Right-click the field. 3 In the drop-down menu, click New Data Collector.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

234

Chapter 8: Performance and Capacity Manager

Figure 155 Adding a New Data Collector for a Specific Field

The New Data Collector Created window appears. Figure 156 New Data Collector Created Window

4 Click Yes to edit the details of the Data Collector, or click No to add the Data Collector to the table without specifying collection details. When Yes is clicked, the Data Collector Wizard appears. The Data Collector Wizard guides you through optional data collection options, such as
n n n n n

Labeling a Data Collector Selecting Data Collector Targets Specifying Data Collection Filters Indicating Trigger and Clear Levels Specifying Start and Stop Times

For additional information on specific Data Collector options the Wizard offers, refer to the sections listed in this guide.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

235

Labeling a Data Collector

When the Data Collector Wizard launches, choose a Data Collector name to appears in the CEM tree view. To specify a Data Collector Name: 1 Launch the Data Collection Wizard by Adding a Scheduled Event Data Collector or Adding a Specific Field Data Collector. The Data Collector Wizard appears. 2 In the Enter Data Collector Name field, enter a string to represent the Data Collector in CEM. 3 Click Next. To change the Data Collector name once it is established, refer to Editing Data Collector Settings.

Selecting Data Collector Targets

Once the Data Collector Name is set in the Data Collector Wizard, select the different CEM elements to poll for data. One or several data collection targets can be specified. By selecting a folder, all equipment within its sub-folder are automatically included. For example, the same statistic for several supported chassis or cards can be selected to avoid having numerous, similar Data Collectors. To specify single or multiple targets using the Data Collector Wizard: 1 Open the Wizard using the Edit command or by creating a new Data Collector. 2 Navigate to the Data Collector Targets window by clicking Next. Figure 157 Data Collector Targets

3 Click an object to target. Selected objects appear highlighted. Hold the Ctrl key down to select multiple target, or hold the Shift key down to select a range of targets.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

236

Chapter 8: Performance and Capacity Manager

4 Click Next. Specifying Data Collection Filters Data Collection target filters specify the target type to match, and Attribute Filter narrows the target type match to which instance to use. Figure 158 Data Collection Filters

When creating a filter, select a value for a specific attribute selected. When a value is set to X, the Data Collector will not collect the specified value. In the following screen Indicating Trigger and Clear Levels, also select the attribute to filter. Indicating Trigger and Clear Levels Trigger and clear fields establish threshold levels. This provides a visual representation of what has exceeded a defined threshold. Setting Trigger and Clear levels are optional for Data Collectors; data can be collected without setting these levels.
n

Clear Value-when crossed, the Clear value declares a Threshold Cleared event. This field is optional and can be left blank to disable threshold limits. If a value is specified, a value is also required for "Trigger Value". This is normally a numeric value, but can be any ASCII string value to detect a specific non-numeric value. Trigger Value-when crossed, the Trigger Value declares a Threshold Exceeded event. This field is optional and can be left blank to disable threshold limits. If a value is specified, a value is also required for "Cleared Value". This is normally a numeric value, but can be any ASCII string value to detect a specific non-numeric value.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

237

To set Trigger and Clear levels: 1 Open the Wizard by Editing Data Collector Settings or Adding a Data Collector. 2 Navigate to the Attributes to Collect window by clicking Next. Figure 159 Attributes to Collect Window

3 In the Collect column, click the check-box of the attribute to collect. 4 For the selected attribute, click the Trigger field and enter a value. 5 For the selected attribute, click the Clear field and enter a value. 6 When finished, click Next. Some Label entries are marked with an asterisk (*). Entries marked with an asterisk indicate duplicate data elements being collected. Collecting data from tables with a large number of rows increases the amount of time the query takes to execute. To view the established Trigger and Clear values for a attribute, refer to Threshold Tab. Once Trigger and Clear Values are established, CEM uses a visual color-scheme change to indicate when they have been crossed.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

238

Chapter 8: Performance and Capacity Manager

Figure 160 Trigger and Clear Values Crossed

Threshold Logs

When a value crosses a threshold level, an entry is made in the Threshold Event Log. To view Threshold Log information: 1 In the CEM explorer tree, double-click the Logs folder. 2 Right-click the Threshold Log. 3 From the View menu, select Events. The Threshold Log Events window appears. 4 Page through the event logs using the buttons, and adjust the Page Size to change the number of entries displayed. For additional information about using the log event viewer, refer to the Common Element Manager User Guide.

Specifying Start and Stop Times

Start and stop times are used to collect data during certain time frames. When indicating a non-repeating Data Collection event, specify a time in the future to collect data. To specify start and stop times: 1 Open the Wizard by Editing Data Collector Settings or Adding a Data Collector. 2 Navigate to the Schedule Start Time window by clicking Next.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

239

Figure 161 Schedule Start Time Window

3 Select a year, month, day, and 24-hour time for the Data Collector to begin gathering information. 4 Click Next. The Schedule Interval window appears. Figure 162 Schedule Interval Window

5 For the Data Collector to repeat collection at a specified interval, check Enable Repeating Interval. 6 Specify an interval period, from 1 minute to 1 month. 7 Click Next. If Enable Repeating Interval is checked, the Schedule Repeat Until Time window appears. Checking Enable Repeat Until places a limit on the time period data is collected.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

240

Chapter 8: Performance and Capacity Manager

Figure 163 Schedule Repeat Until Time Window

8 Specify the year, month, day, and 24-hour time to stop repeating data collection. To repeat data collection indefinitely, uncheck Enable Repeat Until Time. 9 Click Next. The Enable Data Collector window appears. Figure 164 Enable Data Collector Window

10 Select Enable or Disable and click Finish. If enabled, the Data Collector is immediately effective; if disabled, the Data Collector can be enabled at a later time using the drop-down menu. For additional information, refer to Enabling and Disabling Data Collectors. The new entry is added to the Data Collectors folder.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

241

Viewing Data Collector Information

Information about the Filter, Identification, Schedule, State, and Threshold of a Data Collector is easily visible using CEM. These settings are viewed by clicking on the Scheduled Data Collector or one of the Data Elements it contains. To view Data Collector Information: 1 Double-click the Scheduled Events folder. 2 Double-click the Data Collectors folder. 3 Click one of the Data Collectors. The Properties tab changes to show the tabs associated with the Data Collector. Filter Tab Use the Filter tab to view information on the name, value, and type of a Data Collector. To use the Filter tab: 1 Click the Filter tab. The Properties tab changes to show the Filter tab. Figure 165 Filter Tab

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

242

Chapter 8: Performance and Capacity Manager

2 View the following values. Table 38 Filter Tab

Field Filter Attribute Name Description The label of an attribute whose value must match the 'Filter Attribute value' in order to be include in the scope. This field is optional. The value of the 'Filter Attribute Name' in order to be include in the scope. This field is optional. The type of all children of the scope root for which data will be collected.

Filter Attribute value Target type

Identification Tab To use the Identification tab: 1 Click the Identification tab. The Properties tab changes to show the Identification tab. Figure 166 Identification Tab

2 View the following values. Table 39 Identification Tab

Field Class Description Specifies the internal schema className for this object. Schema classNames are CEM internal class names and do not have any relationship to MIB classes. Specifies the fully qualified name of this object. This is the complete path from the root of all objects. Indicates if the object is reserved by another user.
Part Number D4000-006 Rev A1 January 2011

FQN Reserved
Common Element Manager User Guide

Working with PCM Data Collection

243

Table 39 Identification Tab

Field Reserved By Description Indicates who has reserved the object.

Schedule Tab Use the Schedule tab to view information on scheduled event times of a Data Collector. To use the Schedule tab: 1 Click the Schedule tab. The Properties tab changes to show the Schedule tab. Figure 167 Schedule Tab

2 View the following values: Table 40 Schedule Tab

Attribute Last status Last time run Next scheduled start Description Summary information from the last time this scheduled event ran. Last time this scheduled event was run in mm/dd/yy hh:mm:ss format. Next time this scheduled event is to run in mm/dd/yy hh:mm:ss format. default=0 Settings

Number of time run Number of times this event executed at the scheduled time.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

244

Chapter 8: Performance and Capacity Manager

Table 40 Schedule Tab

Attribute Number of time skipped Description How many times this event was skipped because it was already executing at the scheduled time. Note: if this value increases, the Repeating Interval should be changed to a higher value. Repeating enabled Value of "true" means the scheduled event is repeated, otherwise the scheduled event is not repeated
n n

Settings defaykt=0

true false

default= false Repeating interval Repeating interval units The numeric repeating interval for this scheduled event. The units of measure for the Repeating interval. Integer default=0
n n n n n n

seconds minutes hours days weeks months

default= minutes Scheduled first Scheduled until First time this scheduled event to run in mm/dd/yy hh:mm:ss format. A scheduled event will not run prior to this time. [optional] Time after which this scheduled event will no longer run in mm/dd/yy hh:mm:ss format. A repeating event will not run after this time if specified. Leave blank to repeat forever. Value of "true" means scheduled event stops repeating after last time run, otherwise scheduled event repeats forever.
n n

Scheduled until enabled

true false

default= false

State Tab To use the State tab: 1 Click the State tab. The Properties tab changes to show the State tab.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

245

Figure 168 State Tab

2 View the following values. Table 41 State Tab

Field Administrative State Alarm Status Operational State Description Indicates the desired operational state. Indicates the current alarm status. Indicates the current operational state. If the operational state icons have the following default colors; Green (enabled), Yellow (degraded), Red (disabled) and Magenta if CEM cannot accurately determine the state. Indicates how busy the resource is: idle, active, or busy.

Usage State

Threshold Tab Use the Threshold tab to view information on Data Collector threshold settings. To use the Threshold tab: 1 Click the Threshold tab. The Properties tab changes to show the Threshold tab.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

246

Chapter 8: Performance and Capacity Manager

Figure 169 Threshold Tab

2 View the following values: Table 42 Threshold Tab

Field Cleared Value Description The value which when crossed, will declare a Threshold Cleared event. Leave this value blank to disable threshold limits. If non-blank, a value is also required for Trigger Value. This is normally a numeric value, but can be any ASCII string value to detect a specific non-numeric value. Trigger Value The value which when crossed, will declare a Threshold Exceeded event. Leave this value blank to disable threshold limits. If non-blank, a value is also required for Cleared Value. This is normally a numeric value, but can be any ASCII string value to detect a specific non-numeric value.

Viewing Historical Data

The Historical Data tool is used to graphically represent the data collected by hour, day, or week for a specific element. Historical Data is collected from specific elements in CEM that corresponding Data Collectors have been established for. Right-clicking a Data Collector will not report any collected information-you must select the folder or subfolder location in the CEM tree that information was collected for. To view historical data: 1 Select the folder or subfolder in CEM that contains performance data information.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

247

2 Right-click the folder or element. 3 From the View menu, select Historical Data. If historical data does not exist for the select object, the No Historical Data Window appears. Figure 170 No Historical Data Window

If historical data is available for the selected object, the Historical Data Window appears. Figure 171 Historical Data Window

4 From the Historical Data frame, select an element (or multiple elements) on which to view historical data. Hold the Ctrl key down to select multiple targets, or hold the Shift key down to select a range of targets. 5 From the drop-down menus, select a Value vs. Time graphing scheme. 6 From the drop-down menu, select SUM, AVG, MAX, or MIN, where
n

AVG-average of the information collected SUM-sum of the information collected MIN-find only the minimum values of the data collected
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

248

Chapter 8: Performance and Capacity Manager

MAX-find only the maximum values of the data collected

The type selected graphs the data against the type selected in the Value drop-down menu. 7 To select the point in a time to begin analyzing data, click From. The Choose Starting Date window appears. Figure 172 Choose Starting Date Window

8 Select a year, month, day, and 24-hour value. Click OK. 9 To select a point in time to cease analyzing data, click From. The Choose Ending Date Window appears. Figure 173 Choose Ending Date Window

10 Select a year, month, day, and 24-hour value. Click OK. 11 In the Type drop-down menu, select a graph display-type. Options are:
n

Line Bar Area Stacked Bar

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

Working with PCM Data Collection

249

Stacked Bar 100% Stacked Area Stacked Area 100% Pie

12 Click Update to generate a graph. If historical data does not exist for a selected object, the No Data window appears. If you try to chart data "Hourly" but the actual data samples were not collected continuously at least every hour, the GUI shows an incorrect X-Axis. If you try to chart data "Daily" but the actual data samples were not collected continuously at least every day, the GUI shows an incorrect X-Axis. Forecasting PCM creates graphs based on existing data collected in a database. By examining this data, an estimation can be made on what trend is most likely to occur in a future time frame. To forecast data, create a historical data graph using data collected for a period of time. For example, in a 7-day time frame, plot the sum total on a Rate/hr versus hourly graph. For example, if every Monday-through-Sunday period in a month is graphed for each month of the year collected data exists for, certain days (or certain time-of-day) may historically have a higher traffic load. Based on this, an estimate or forecast can be made on what the upcoming month could look like. Exporting Data to CSV Historical Data information can be exported to Comma Separated Version (.csv) file for backup or analysis by other applications. Exporting Data to CSV saves only the information generated in the current chart. To export data from an external database to a .csv file stored in a specified location: 1 Open the Historical Data window (refer to Viewing Historical Data) for the Data Collector to export to .csv. 2 Select the desired plot information and historical data element. 3 Click Update. 4 Click Save.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

250

Chapter 8: Performance and Capacity Manager

The Save Graph Data window appears. Figure 174 Save Graph Data Window
\

5 Select a location to save, and enter a filename for the .csv file. 6 Click OK. The file is saved in the specified location. Exporting Data to TSV Historical Data information can be exported to Tab Separated Version (.tsv) file for backup or analysis by other applications. To export data to a .tsv file stored in a specified location: 1 Right-click the root Data Collectors folder. Figure 175 Exporting Data to TSV

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

251

2 From the Maintenance menu, select Export Data. The Historical Data Export window appears. Figure 176 Historical Data Export Window

3 Indicate a Time Range of data to export by choosing one of the following:

n n

All data exports all current historical data in the database (DB). All data older than X days exports all historical DB data older than the number of days specified. All data from X to Y exports historical DB data between the dates specified.

4 Select a filename and location for the .tsv file.

n

the Export to file: field recommends the name of the file to be exported. This can be changed as necessary. the Browse... button allows you to choose a specific location to save the file. the clock ICON and Status: field indicate the current progress of the export command. Initially it shows a clock face to indicate it is waiting for you to choose the options. the clock ICON is removed and replaced with a animated working image ICON. the Export and Cancel buttons are remove and replaced by a single Cancel button which allows you to prematurely terminate the exporting of all data. the progress bar is displayed showing a graphical representation of the percentage of process completion. progress status messages are displayed while all data is exported. when finished, the progress status messages displays Done and the Cancel button is replaced by the Close button.

n n

5 Click the Export button to start the process and the following will occur;
n

n n

Or, click the Cancel button to terminate this process. 6 Click the Close button to close the Historical Data Export window.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

252

Chapter 8: Performance and Capacity Manager

Exported Data

The data will be exported in tab-separated-format with the first line containing the name of each column. Each data sample will include:
n n

the fully qualified name of the device/object associated with the sample. the timestamp when the sample was collected in the format yyyy-mm-dd hh:mm:ss. the name of the data sample. the value of the data sample at the time it was collected. an object identifier (OID) is exported for SNMP-based objects, otherwise no OID is exported.

n n n

Figure 177 Exporting Data File Sample Opened with MS Excel

Establishing Purge Policies

Purge policies are used to maintain the amount of historical data collected. Failure to establish purge policies may result in exceeding the disk capacity of the database and cause unexpected behavior on the CEM Server. To set a Purge Policy: 1 Under Scheduled Events, click the Data Collectors folder. The Properties tab changes to display the Identification tab. 2 In the right-hand frame, click the Purge Policy tab.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

253

Figure 178 Purge Policy Tab

3 Configure the following Purge Policy attributes to provision the purge policy. Table 43 Purge Policy Tab
Attribute Archive when purged Description Enables automatic archiving of all historical data that is removed from the database. Each time the historical data is purged, the purged data is archived in a file named HistoricalData-yyyymmdd-hhmm.tsv in the /historicalDataArchive directory on the CEM Server. For additional information, refer to Exporting Data to TSV Delete after (days) The number of days after which all previous historical data is Integer purged. No data is retained prior to this period. This number default=45 must be greater than "SmartPurge after (days)" if "Purge policy" is set to "Smart." Enable daily archive Enables automatic archiving of the previous days historical data at the "Purge Daily" time. If the "Purge Daily" time is blank, this setting has no affect. Daily Archived data is archived in a file named DailyHistoricalData-yyyymmdd-hhmm.tsv in the /historicalDataArchive directory on the CEM Server. Enables automatic purging of the historical data according to the provisioned purge policy. If the "Purge Daily" time is blank, this setting has no affect. The last time the historical data was purged. How many times data was purged either due to automatically purging at the specified time or purged on demand.
n n

Settings
n n

yes no

default=no

yes no

default=no

Enable daily purging

n n

yes no

default=no Last time purged Number of times purged Read-only Read-only

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

254

Chapter 8: Performance and Capacity Manager

Table 43 Purge Policy Tab

Attribute Policy Description The policy used to purge historical data. Standard purges all data older than the 'Delete after (days)'. Settings
n n

Standard Smart

Smart gradually removes data samples between the default= 'SmartPurge after (days)' and 'Delete after (days)'. This has Smart the affect of "thinning" the data over a sliding window of time. Purge daily at (hh:mm:ss) The time of day that the historical data samples should automatically purged in accordance with the provisioned purge policy. Leave blank to never automatically purge, otherwise it must be 24-hour hh:mm:ss format (e.g.: 23:00:00 = 11:00 pm). SmartPurge after (days) The number of days in which to retain all historical data. Data is not purged within this period. This number must be less than or equal to the "Delete after (days)" if "Purge policy" is set to Smart; otherwise it is ignored. hh:mm:ss default= blank

Integer default=30

Purge Data on Demand To purge data on demand (this is not required after Establishing Purge Policies): 1 Right-click the Data Collectors folder. 2 From the Maintenance menu, select Purge Now. The Purge Now window appears. Figure 179 Purge Now Window

3 Click Close. Forcing Data Collection When Data Collectors are added, a Repeating Interval is specified for how often to collect information. However, data can be collected at any time using the Collect Now command. To override the predefined data collection start time and collect data upon demand: 1 Right-click a previously defined Data Collector. 2 From the drop-down menu, click Collect Now. The Collect Now window appears.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Working with PCM Data Collection

255

Figure 180 Collect Now Window

3 When the process is finished, click Close. Depending on the amount of objects being queried, this process may take several minutes. Enabling and Disabling Data Collectors Data Collectors are taken out of service (disabled) prior to Editing Data Collector Settings. Events can be taken out of service (disabled) and returned to service (enable) with the procedures in this section. To disable a Data Collector: 1 Right-click the Data Collector to disable. An in-service Data Collector has a yellow state icon. 2 From the drop-down menu, select Disable. The Data Collector icon changes from yellow to red, signifying it is out of service. When a Data Collector is out of service, the Edit drop-down menu is no longer grayed out and the data collection parameters are editable. To enable a Data Collector: 1 Right-click the Data Collector to enable. An out-of-service Data Collector has a red state icon. 2 From the drop-down menu, select Enable. The Data Collector state icon changes from red to yellow, signifying it is in-service. When a Data Collector is in service, the Edit drop-down menu option is grayed out and data collection are no longer editable. To enable or disable all Data Collectors: 1 Right-click the Data Collectors folder. 2 Click Enable All or Disable All.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

256

Chapter 8: Performance and Capacity Manager

Editing Data Collector Settings

Once a Data Collector exists in CEM, edit the data collector parameters to include more or less detail. To edit an existing Data Collector: 1 Disable the Data Collector-refer to Enabling and Disabling Data Collectors for more information. 2 Right-click the disabled Data Collector. 3 From the drop-down menu, select Edit. The Data Collector Wizard appears. 4 Change any of the existing parameters for the data collection event. Refer to Adding a Data Collector for more information. 5 After changing any information, click Next until the Enable Data Collector window appears. Figure 181 Enable Data Collector

6 Check Enabled. 7 Click Finish. The Data Collector Update window appears. Figure 182 Data Collector Update Window

8 Click Close.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with Scheduled Reports

257

Resetting Counters

Use the Reset Counters command to reset the executed and skipped counters to zero. To reset counters: 1 Right-click the Data Collector to reset. 2 From the drop-down menu, click Reset Counters. The counters for that Data Collector are reset.

Deleting Data Collectors

When a Data Collector is no longer needed, remove it from the CEM explorer tree. To delete a Data Collector: 1 Right-click the Data Collector to remove. 2 From the drop-down menu, select Delete. A verification dialog box appears with the message "Are You Sure?" Figure 183 Verification Dialog Box

3 Click Yes. The Data Collector is removed from the explorer tree.

Working with Scheduled Reports

This section explains the Scheduled Reports feature of PCM and provides procedures for using the various capabilities.
n n

Scheduled Report Overview Scheduled Report Procedures

Scheduled Report Overview

PCM provides the capability to configure and generate customized scheduled tabular or graphical reports that provide performance and capacity metrics. These reports can be customized on a component, chassis, or regional basis, depending on the information required. Scheduled reports can be configured to occur at a specific time, or at recurring intervals. The reports can also be configured so that specific operators can be notified via email that the report is available. They are emailed a URL which the recipient can use to access and view the report. CEM does not perform validation on email address(es) you enter.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

258

Chapter 8: Performance and Capacity Manager

A library of these reports can be created to provide data on any number of a system's key performance indicators. This provides an effective method through which operators can identify and adjust to performance and capacity trends in the network before they adversely affect service. At the scheduled time, CEM performs the operations required to create the report, including:
n

generating the scheduled report in the background and formatting the sections according to the criteria you specified generating the .pdf format report file sending email notifications (if they are configured) making the report available through the CEM web interface

n n n

The generated report also includes the appropriate bookmarks that provide for navigation among the report sections (if included). Scheduled Reports can be created, edited, or deleted as needed. Scheduled Report Format A report consists of two basic elements:
n

Scheduled Report: The Scheduled Report specifies the scope of the report. It includes the component(s) for which data is collected, and includes the repeating time intervals at which the report is generated. Scheduled Report Sections: Report Sections format the type of analysis and reporting metrics you choose for a specific Scheduled Report. This allows the operator to organize each report into logical sections that allow various viewers of the report to quickly isolate information relevant to their area of responsibility and expertise. This simplifies report distribution, as you can create a single report with multiple sections for distribution to a group with a wide variety of responsibilities.

Scheduled Report Section Style When you create report sections, you are asked to make selections that instructs CEM on how to format the analysis of the data. These formats allow the operator to:
n n n

Specify a graphical or tabular format for data presentation Specify the specific time frame over which the data is analyzed Specify if the data will be presented on a per component basis, or if the data will be presented as a composite analysis of multiple components

Samples of tabular and graphical formats are provided in Figure 184 and Figure 185.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Working with Scheduled Reports

259

Scheduled Report Metrics The Scheduled Report Wizard allows you to select only performance and capacity metrics for which data has been collected at some point for the selected component(s). If the performance and capacity metrics you want included in your report are not available for selection, it could be due to a variety of reasons, including:
n n n n

the data collector for the metric is disabled the data collector is enabled but has not yet collected data the data collector for the metric has been purged or deleted the data collector for the metric has not yet been created

To ensure that the desired performance metrics are available for your report, verify that those data collectors are currently configured and enabled in CEM. Refer to Working with PCM Data Collection for the procedures. Figure 184 Sample Scheduled Report: Graphical Format

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

260

Chapter 8: Performance and Capacity Manager

Figure 185 Sample Scheduled Report: Tabular Format

Scheduled Report Procedures

This section provides procedures for the various tasks required to work with scheduled reports in PCM:
n n n n n n n

Creating a Scheduled Report Folder Creating a Scheduled Report Adding a Section to a Scheduled Report Editing a Scheduled Report Deleting a Scheduled Report Generating a Scheduled Report On Demand Customizing the Scheduled Report Logo

Creating a Scheduled Report Folder You can create scheduled report folders to organize all of the scheduled reports you create on CEM. For more detailed information on Scheduled Reports, refer to Scheduled Report Overview. To create a new scheduled report folder: 1 In the CEM Explorer Tree, expand the Scheduled Events directory and select the Scheduled Events folder. 2 Right-click and select New. 3 Select Scheduled Report Folder.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Working with Scheduled Reports

261

4 Enter a name for the new folder. 5 Click OK. The new Scheduled Report folder appears in the Scheduled Events directory. Creating a Scheduled Report For more detailed information on Scheduled Reports, refer to Scheduled Report Overview. To create a new scheduled report in CEM: 1 In the CEM Explorer Tree, select the Scheduled Events folder and right-click. 2 Click New. 3 Click Scheduled Report. The Scheduled Report Wizard Label screen appears. 4 Enter a unique name to identify the new report. 5 Click Next. The Scheduled Report Wizard Report Type screen appears. Figure 186 Scheduled Report Wizard Report Type Screen

6 Select Scheduled Performance Report:Historical Performance and click Next. The Scheduled Report Wizard Report Scope screen appears. 7 Select the component(s) you want designated as the scope of the report and click Next. The Scheduled Report Wizard Starting Time screen appears.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

262

Chapter 8: Performance and Capacity Manager

8 Select the year, month, date, and time (hours:minutes:seconds) that you want PCM to begin generating the report. Then click Next. The Scheduled Report Wizard Reporting Interval screen appears. 9 If you want the report to be repeatedly generated at a specified time interval, click to enable the Enable Repeating Interval checkbox. 10 In the drop-down menu, select the desired repeating interval. The Scheduled Report Wizard Ending Time screen appears. 11 Select the year, month, date, and time (hours:minutes:seconds) that determines when report generation ends. Then click Next. The Scheduled Report Wizard Email Notification screen appears. 12 Enter the email addresses of the people you want to receive the generated report. Press <Enter> to separate multiple addresses. CEM does not perform validation on the email address(es) you enter. 13 Click Finish. The new scheduled report appears as an entry in the Scheduled Reports folder. To add sections to the scheduled report, proceed to Adding a Section to a Scheduled Report. Adding a Section to a Scheduled Report For more details on report sections, refer to Scheduled Report Format. To add a section to a scheduled report. 1 In the CEM Explorer Tree, locate and select the desired Scheduled Report, then right-click. 2 Click New, then click Report Section. The Historical Performance Report Section Wizard appears. 3 Click Next. The Section Title dialog box appears. 4 Enter a section title, then click Next. CEM queries the database for all metrics for which data has been collected. The Select Metrics dialog box appears. 5 Click to place a checkmark in the box next to each metric you want to appear in this report section. If the metric you want to include does not appear in the list, refer to Scheduled Report Metrics for possible explanations. 6 Click Next.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Working with Scheduled Reports

263

The Section Style dialog box appears. 7 Make the entries listed in Table 44. Table 44 Historical Performance Report Section Wizard Report Type Entries
Section Report Field AVG Description In the drop-down menu, select the method you want CEM to use in computing data samples when they are being aggregated into separate metrics.
n

AVG: Computes the average of all values for the defined TIME selection (see below). SUM: Computes the total of all values for the defined TIME value (see below). MIN: Lists only the minimum value for the defined TIME value (see below). MAX: Lists only the maximum value for a selected TIME value (see below).

VALUE

In the drop-down menu, select the method you want CEM to use to determine how to evaluate the data sample's actual value. Options are:
n

VALUE: Use the data samples' numeric value. This options is best for data samples that increase and decrease over time. For example, an SNMP Gauge. Rate/time: These options are best for data sample values that increase continually over time. Since every data sample is time stamped, CEM calculates the Rate at which the value is changing for each sample. Options are: Rate/second Rate/hour Rate/day Rate/week Rate/month

n n n n n

TIME

In the drop-down menu, select the method you want CEM to use group and analyze the data. Typically, this data is plotted across the X-axis of a graph. Options are:
n

Time: Plots each data sample VALUE across the entire time range. Hour, Day, Week, or Month: Samples are collected into unique Hourly, Daily, Weekly or Monthly buckets and the appropriate VALUE is computed and plotted for each Hour, Day, Week or Month across the entire time range. This is similar to the Time choice above as the chart shows how the value is changing across the entire time range. Hour of Day, Day of Week, Week of Month, or Month of Year: Use the Hour, Day, Week or Month each sample is determined. Those samples with the same Hour, Day, Week or Month are collected into separate buckets and the appropriate VALUE is computed for each bucket. This is different from any of the above TIME choices. For example, all samples that have the same Hour of Day (regardless of the date) are collected together.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

264

Chapter 8: Performance and Capacity Manager

Table 44 Historical Performance Report Section Wizard Report Type Entries

Section Format Field Graph Description Specify how to show the results of the analysis. Options are:
n n

Graph: Display the collected report data in graph format. Tabular: Indicates you want the collected data presented in tabular columns.

Bar

If Graph is selected, this drop-down menu allows you to select the type of graph you want to represent the collected report data. Options are:
n n n n n n n

Line Bar Stacked Bar Stacked Bar 100% Area Stacked Area 100% Pie

Decimal Points Time Frame Include metrics from

If you chose Tabular as the Graph type, specify the number of decimal points you want presented in the values collected. Specify the time window used to generate the report. Options are:
n

Past: Use the drop-down menus to specify an immediately preceding time window. For example, include historical data that has been collected in the past 4 hours. Last Complete: Use only complete time buckets. For example, include historical data that was collected in the last complete 2 days. This option is somewhat independent of the time at which the report is actually generated. For example, if a report is run at any time on Thursday, and Last Complete 2 Days is specified, the report only includes data collected on Tuesday and Wednesday.

Multiple Specify how you want CEM to process metrics that may have been collected Device Policy from multiple devices selected in the Scheduled Report Wizard Report Type dialog box. Options are:
n n

Composite: Reports on all metrics from all devices in a single analysis. Individual: Reports on each device individually in separate analyses. Similar sub-sections will be generated for each device that has collected the metric(s) specified for the report section.

8 When you have finished making your entries, click Next. The Historical Performance Report Section Wizard Finished dialog box appears summarizing the details you specified for the Report Section. 9 Review the information listed to verify that it is correct:
n

Click Back to return to any of the Report Section Wizard dialog boxes to make any desired changes. Click Finish to finalize the changes.

The new report section name appears under its parent Scheduled Report.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Working with Scheduled Reports

265

Editing a Scheduled Report For more detailed information on scheduled reports, refer to Scheduled Report Overview. To edit an existing scheduled report: 1 In the CEM Explorer Tree, navigate to the scheduled report you want to edit. 2 Select the report and right-click. 3 Click Edit. The Scheduled Report Wizard appears. 4 You may now edit any or all of the existing settings. The procedure is identical to that provided in Creating a Scheduled Report. Deleting a Scheduled Report For more detailed information on scheduled reports, refer to Scheduled Report Overview. To delete an existing scheduled report: 1 In the CEM Explorer Tree, expand the Scheduled Events folder. 2 Expand the Scheduled Reports folder and select the report you want to delete. 3 Right click and select Delete. A confirmation dialog box appears. 4 Click Yes to delete the report, or click No to cancel the operation. Generating a Scheduled Report On Demand For more detailed information on scheduled reports, refer to Scheduled Report Overview. To generate a scheduled report on demand: 1 In the CEM Explorer Tree, expand the Scheduled Events folder. 2 Expand the Scheduled Reports folder. 3 Select the scheduled report you want to generate and right-click. 4 Click Run now. CEM performs the required operations to collect the data and create the report, including:
n

generating the scheduled report in the background and formatting the sections according to the criteria you specified generating the .pdf format report file sending email notifications (if they are configured) making the report available through the CEM web interface

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

266

Chapter 8: Performance and Capacity Manager

Customizing the Scheduled Report Logo CEM reports are configured with a default cover page logo that the user can substitute with a customized logo. The default logo image is in the root directory of the CEM server. Its exact directory location is:
http/images/UTSlogo.gif

You can change the logo CEM uses for its generated reports by setting a property in the override.properties file. To change the logo image used for generated scheduled reports: 1 Place the logo image you want to used for scheduled reports in the CEM root directory. For example, java_logo.gif. 2 In a text editor, open the override.properties file. 3 In the override.properties file, edit the PCM.report.logo=<logoImageFilePath> property to reflect the filename of the custom image you placed in the CEM root directory. For example:
PCM.report.logo=java_logo.gif

4 Save the edited override.properties file. CEM will now use the new logo image on the generated scheduled reports.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

ADVANCED CONFIGURATION MANAGER

This chapter describes how to install and use the CEM Advanced Configuration Manager (ACM) value-added package.
n n n

ACM Overview Installing ACM ACM Procedures

This chapter assumes CEM is installed and configured. For information on installing and configuring CEM, refer to Chapter 3.

ACM Overview

The Advanced Configuration Management (ACM) value-added package allows the operator to manage the configuration process quickly and efficiently. Using ACM provides these benefits:
n

Automates the application of configured values through the creation, assignment and application of configuration templates. This automation also reduces the possibility of error when configuring multiple components, while simultaneously simplifying corrective actions, when required. Simplifies network configuration management by allowing the import/export and transfer of configuration templates to multiple operators for use as is or for editing. Automates the method operators can use to detect and resolve configuration errors.

Configuration templates are based on the currently loaded packages found in the CEM Server. When a package is upgraded, the corresponding templates automatically support the new properties/MIB structures.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

268

Chapter 9: Advanced Configuration Manager

About Configuration Templates

This section describes the various properties and uses of ACM configuration templates.
n n n n n

Template Creation Template Assignment Template Application Template Import and Export Template Audit Reports

Template Creation Configuration templates are created from any selected piece of equipment currently in the CEM Explorer Tree. When first created, these templates reflect the properties and current running values of the selected equipment. Templates can be created for "types" of equipment or software entities (such as a FACN). Templates are not created for an entire chassis that might contain different types of blades unless the chassis itself has configurable parameters. The individual template properties can be selected to be part of the template. Template properties are restricted to those that can be changed. Read-only properties are not included in a configuration template. A template's properties may include single-value properties, typically SNMP scalars, and tabular properties, typically SNMP tables. In the case of SNMP tables, the template includes ALL rows in that table. There is NO provision for a template to contain a sub-set of individual rows. In addition, SNMP tables that do not adhere to the SNMP practice of using a RowStatus column are NOT included in the template. Configuration templates are objects contained under the Configuration Templates root folder in the CEM Explorer Tree. CEM can manage multiple templates. Templates can be created, edited, or deleted as needed. Also refer to:
n n n

Creating a Configuration Template Editing a Configuration Template Deleting a Configuration Template

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

ACM Overview

269

Template Assignment Once created, a configuration template must be assigned. Assigning a template creates an association between a component and a configuration template. This association is required to:
n

Enable the component to apply a template or templates that force the running equipment configuration to match the configured settings in the template(s). Allow the equipment to produce an audit report. Refer to Template Audit Reports for more information. Allow the import and export of configuration templates as simple ASCII formatted files for exchange between operators.

A template can be assigned to one or more pieces of equipment. A facility is provided to assign a specific template to multiple, similar, pieces of equipment in a single operation. For example: Assigning Component-A template to all Component-A blades found in an Equipment folder. Any single piece of equipment can be assigned to many different templates each associated with different Properties and values. For example, a template might be created for RADIUS Accounting servers and another for basic RP interface parameters. A single component might then be assigned to both templates. CAUTION: In the event that a single piece of equipment is assigned to multiple templates, and those templates include the same properties with different values, the resulting Apply and Audit functions will be unpredictable. Once a template has been assigned to a component:
n

The equipment can apply its template(s) to force its running configuration to match the values in the template(s). Statistics are collected on the total number of success and failures while applying a template to its associated equipment. Enables the equipment to produce an audit report of any differences between its running values and those found in its associated template(s). The operator can view the associations between configuration templates and target components. Select a component or a configuration template in the CEM Explorer Tree and then click the Related tab.

Also refer to Assigning a Configuration Template.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

270

Chapter 9: Advanced Configuration Manager

Template Application Once a configuration template has been created and assigned, it can then be applied to its associated component. The template forces the associated running equipment to match the values in the template(s) that have been applied. During this process, statistics are collected to indicate the total number of successes and failures in applying the template values to the target component. Also refer to Applying a Configuration Template. Template Import and Export Templates can be imported and exported to simple ASCII formatted files for easy transmission via mail or other electronic transfer methods. This provides these benefits:
n

Allows the easy transfer of one or more configuration templates between various operators for application to equipment throughout the network Ensures that various operators can receive identical configuration templates settings designated for their assigned network components Reduces the amount of configuration management required when templates being edited require only minor modifications before being applied to their target component(s)

Also refer to Exporting a Configuration Template and Importing a Configuration Template. Template Audit Reports Once a configuration template has been created, assigned, and applied, CEM then can schedule and generate a configuration audit report. The audit report generates a summary of the differences between the configuration template and the target component's currently running values, if they exist. Only differences are listed -- configuration settings that match do not appear. If no differences are detected between the template and its associated component, the report provides a statement to that effect. This audit report is useful for detecting if a component's configuration has deviated from its associated configuration template since the configuration template was first applied. ACM provides the capability to both generate audit reports on-demand, or at scheduled, repeating intervals. This enables the operator to quickly re-apply the correct configuration template to the target component to restore the proper settings. Also refer to Generating a Configuration Template Audit Report.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Installing ACM

271

Installing ACM

A feature key is required to install the CEM CDR Server package. Refer to Installing a CEM Package in Chapter 3 for the installation procedure. Once installed the ACM icon appears in the CEM Explorer tree. Refer to Figure 187. Figure 187 Advanced Configuration Manager Icon

ACM Procedures

This section provides these ACM procedures:

n n n n n n n

Creating a Configuration Template Assigning a Configuration Template Applying a Configuration Template Exporting a Configuration Template Editing a Configuration Template Deleting a Configuration Template Generating a Configuration Template Audit Report

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

272

Chapter 9: Advanced Configuration Manager

Creating a Configuration Template

For more detailed information related to configuration templates, refer to Template Creation. To create a configuration template: 1 In the CEM Explorer Tree, expand the Template directory. 2 Select the Configuration Templates folder. 3 Right-click and select New. 4 Click Configuration Template to launch the Configuration Template Wizard. 5 Follow the on-screen prompts to perform the four-step process of creating a new configuration template
n

Specifying a template label Specifying the source component for the template Selecting the properties and values for the template Saving the changes

When the process is complete, the new configuration template appears in the Configuration Templates folder. Assigning a Configuration Template For more detailed information related to assigning a configuration template, refer to Template Assignment. To assign a configuration template to a specific component: 1 In the CEM Explorer Tree, expand all the folders in the Template directory. 2 Select the configuration template you want to assign. 3 Click the secondary mouse button. 4 Click Assign to Equipment to launch the Template Assign Wizard. 5 Follow the on-screen prompts to assign the template to the target component. Applying a Configuration Template For more detailed information related to applying a configuration template, refer to Template Application. An association between a configuration template and its target equipment must exist before you can apply the configuration template. Refer to Assigning a Configuration Template and Template Assignment. To apply a configuration template to a component or components: 1 In the CEM Explorer Tree, expand all folders in the Template directory. 2 Select the configuration template you want to assign. 3 Click the secondary mouse button. 4 Click Apply to Equipment.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

ACM Procedures

273

The configuration values are assigned to the target equipment. Exporting a Configuration Template For more detailed information related to exporting configuration templates, refer to Template Import and Export. To export a configuration template: 1 In the CEM Explorer Tree, expand all the directories in the Template folder. 2 Locate and select the configuration template you want to export. 3 Right-click and select export. The Export dialog box appears. 4 Navigate to the location where you want to export the configuration template. 5 Click Export. CEM exports the configuration template and a confirmation dialog box appears listing the directory path to the exported template. 6 Click OK to close the confirmation dialog box. The configuration template is now available to send to other operators via email or other data transfer methods. Importing a Configuration Template For more detailed information related to importing configuration templates, refer to Exporting a Configuration Template. To import a configuration template. 1 In the CEM Explorer Tree, expand all folders in the Template directory. 2 Locate and select the configuration template you want to export. 3 Right-click and select Import. 4 Navigate to the directory location that contains the configuration template you want to import. 5 Select the desired configuration template and click Import. CEM imports the configuration template into the Configuration Templates folder. The configuration template is now available for use in CEM. Editing a Configuration Template To edit an existing configuration template: 1 In the CEM Explorer Tree, expand all the folders in the Template directory. 2 Select the configuration template you want to edit. 3 Right-click and select Edit. The Configuration Template Wizard appears. 4 Follow the on-screen prompts to edit any or all aspects of the selected configuration template.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

274

Chapter 9: Advanced Configuration Manager

Deleting a Configuration Template

To delete a configuration template: 1 In the CEM Explorer Tree, expand all the directories in the Template folder. 2 Locate and select the configuration template you want to delete. 3 Click the secondary mouse button. 4 Click Delete. CEM deletes the selected configuration template.

Generating a Configuration Template Audit Report

For more detailed information related to configuration template audit reports, refer to Template Audit Reports. A configuration audit can be originated from the Template or Equipment folders. Configuration Template audit reports can be generated in two ways:
n n

Generating a Configuration Template Audit Report On-Demand Generating a Scheduled Configuration Template Audit Report

Generating a Configuration Template Audit Report On-Demand To generate a configuration template audit on demand 1 In the CEM Explorer Tree, expand all folders in the Template or Equipment directory. 2 Select the configuration template or component(s) you want to audit. 3 Right-click and make one of the following selections:
n

If you are originating the audit from the Template folder, click Audit Equipment If you are originating the audit from the Equipment folder, click Configuration, then click Audit Equipment.

CEM performs the configuration audit in the background. 4 When the audit is finished, a report appears listing differences in configuration values between the configuration template and its target equipment. A sample of the output is provided in Figure 188. a To save a copy of the report, click Save. b To print a copy of the report, click Print. c Click Close to exit the audit report.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

ACM Procedures

275

Generating a Scheduled Configuration Template Audit Report To generate a scheduled configuration template audit report: 1 In the CEM Explorer Tree, expand the Scheduled Events directory and right-click the Scheduled Reports folder. 2 Click New, then click Scheduled Report. The Scheduled Report Wizard launches. 3 Enter a name for the report, then click Next. 4 In the Report Type dialog box, select Configuration Template:Configuration Template Audit Report. 5 In the Report Scope dialog box, select the component(s) for which you want to generate an audit report. 6 Select the year, month, date, and time (hours:minutes:seconds) that you want PCM to begin generating the report. Then click Next. The Scheduled Report Wizard Reporting Interval screen appears. 7 If you want the report to be repeatedly generated at a specified time interval, click to enable the Enable Repeating Interval checkbox. 8 In the drop-down menu, select the desired repeating interval. The Scheduled Report Wizard Ending Time screen appears. 9 Select the year, month, date, and time (hours:minutes:seconds) that determines when report generation ends. Then click Next. The Scheduled Report Wizard Email Notification screen appears. 10 Enter the email addresses of the people you want to receive the generated report. Press <Enter> to separate multiple addresses. CEM does not perform validation on the email address(es) you enter. 11 Click Finish. The new scheduled report appears as an entry in the Scheduled Reports folder. CEM will generate the specified audit report(s) and provide email notifications (if configured) at the scheduled time. A sample of the report output is provided in Figure 188.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

276

Chapter 9: Advanced Configuration Manager

Figure 188 Sample Configuration Audit Report

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

10

DEVICE LEARNING WIZARD

This chapter describes how to install and use the Device Learning WIzard CEM value added package:
n n n

Device Learning Wizard Overview Installing the Device Learning Wizard Device Learning Wizard Procedures

This chapter assumes CEM is installed and configured. For information on installing and configuring CEM, refer to Chapter 3.

Device Learning Wizard Overview

The CEM Device Learning Wizard provides the operator with the ability to automatically learn how to provide detailed management of any SNMP-manageable network element (NE) beyond simple MIB-II support. The Device Learning Wizard organizes access to a specific device's MIB objects using standard GUI elements such as Tabs, Lists and Tables. It also provides extensive facilities that allow the operator to invoke management functions such as device reboot, configuration uploads and software upgrades. This functionality allows operators to simplify and centralize administration of SNMP manageable devices on the network via CEM.

Example

An example of how an operator might use the Device Learning Wizard follows: 1 A CEM operator deploys SNMP-manageable Power Distribution Units (PDU) throughout the network to remotely control the power feeds to various network elements. 2 The operator uses CEM to import the PDU MIB file into CEM's mib directory. 3 The operator launches the Device Learning Wizard to query one of the PDU devices in the lab. 4 The Device Learning Wizard generates all the code necessary to manage the PDUs through CEM. 5 The operator then uses the standard CEM Device Discovery process to discover all other PDUs that have been deployed in the network.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

278

Chapter 10: Device Learning Wizard

Device Learning Wizard: Process Summary

Before learning a new device, CEM requires a description of the required MIB organization and management function implementation. This information is formally specified in simple ACSII file(s) that are commonly known as a device's Schema. Device Learning Wizard provides the operator with the capability to import ASN.1 MIB files into the CEM Server's proper location. The CEM Device Learning Wizard automatically generates the required Schema files for any SNMP-manageable device by querying the actual device to discover which MIB objects it supports. Once CEM knows which MIB objects the device supports, the Device Learning Wizard can guide the user through a process of organizing the MIB objects for display in CEM. The Device Learning Wizard process includes these tasks and functions:
n n n n n

Entering the target device's address and community string Querying the device type Discovering the MIB objects Viewing the MIB summary Overriding or accepting CEM's recommendations on how to organize the device's read-write MIB objects that are typically associated with configuring the device Overriding or accepting CEM's recommendations on how to organize the device's read-only MIB objects that are typically associated with monitoring the device Overriding or accepting CEM's recommendations on how to organize the device's MIB tables Enabling/disabling which typical management functions are supported by the device Generating the code Finishing the operation to add the new device to the CEM Explorer Tree (refer to Figure 190 for an example)

n n

Additional Process Information Refer to the following information before using the Device Learning Wizard Tab Labels The operator only needs to verify and/or change the Tab label used to show each MIB Table. The Device Learning Wizard automatically creates the appropriate support for adding and deleting rows for a specific table if any of the table column objects have a RowStatus syntax.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Device Learning Wizard Overview

279

Device Query During the query process, CEM tracks and lists the number or Objects Found and the number of Objects Known. Every time the number of unknown objects crosses a multiple of 100, a popup message appears informing you of this fact, and asks for confirmation to continue the process. These pop-up messages are designed to inform the operator that the device appears to support many more MIB objects than are currently known to CEM. If this is the case, the operator should ensure the CEM Server has compiled the proper ASN.1 MIB definition file(s) for the device. Using the Import MIB Files popup menu option assists in placing MIB files in the CEM Server's mib directory. Refer to Importing MIB Files for the procedure. The operator then must perform a manual restart of the CEM Server before continuing with the wizard process. Support for Adding/Deleting Rows The Device Learning Wizard automatically creates the appropriate support for adding and deleting rows for a specific table if any one of the table column objects has a RowStatus syntax. Support for Enabled Commands and Management Functions For user-enabled operational commands, the Device Learning Wizard generates the appropriate support to show the management function in the device's popup menu. In addition, the Device Learning Wizard generates a skeleton script that can be modified to implement the function. The user must modify these scripts in accordance with the device-specific mechanism to perform the associated management functions using the SNMP interface to the device.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

280

Chapter 10: Device Learning Wizard

Installing the Device Learning Wizard

A feature key is required to install the CEM Device Learning Wizard package. Refer to Installing a CEM Package in Chapter 3 for the installation procedure. Once installed, the Device Learning Wizard can be launched by right-clicking anywhere in the Equipment folder in the CEM Explorer Tree and selecting Learn new device. Refer to Figure 189. Figure 189 Accessing the Device Learning Wizard

Device Learning Wizard Procedures

This section provides procedures for using the various capabilities of the Device Learning Wizard.
n n

Learning a New Device Importing MIB Files

Learning a New Device

Before learning a new device, refer to Device Learning Wizard Overview, and Additional Process Information. To learn a new device using the Device Learning Wizard: 1 In the CEM Explorer Tree, select the Equipment folder. 2 Click the secondary mouse button. 3 Click Learn new device. The Learn Device Wizard launches. 4 Follow the on-screen prompts to complete the tasks required to complete the learning process.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Device Learning Wizard Procedures

281

5 Once the device has been learned and the MIB objects organized, restart the CEM server. 6 Use the CEM Discover feature to discover the learned device to add it to the CEM Explorer Tree. Figure 190 Example of Device Added with Device Learning Wizard

Importing MIB Files

For more detailed information, refer to Device Learning Wizard: Process Summary and Additional Process Information. To import MIB files for use with the Device Learning Wizard: 1 In the CEM Explorer Tree, select the highest level folder and right click. 2 Click Import MIB Files. The Import MIB Files dialog box appears. 3 Navigate to the location that contains the MIB files you want to import. 4 Select the desired MIB file(s). 5 Click Import. CEM imports the selected files to the CEM Server mib directory.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

11

CDR SERVER

This chapter describes the CEM Call Detail Record (CDR) Server value-added package.
n n n n n

CDR Server Overview Installing CDR Server Configuring CDR Server Managing CDR Server CDR Server Procedures

This chapter assumes CEM is installed and configured. For information on installing and configuring CEM, refer to Chapter 3.

CDR Server Overview

The CEM CDR Server receives standard RADIUS Accounting-Request messages from any variety of NewNet client components, as well as other proxies such as Highly Available RADIUS Proxy (HARP). CDR Server authenticates the request and provides a valid Accounting-Response back to the client. CAUTION: CDR Server is designed as an analysis tool only. It is not designed as a substitute for the existing billing system.

Retained and Merged CDR Information

CDR Server merges the information received in the Start, Stop and/or Interim accounting messages into a single Call Detail Record (CDR) for each unique call retained in the SQL database. The following key RADIUS accounting information is retained in the CEM CDR Server for each unique call ID:
n n n n n n n

User-Name (e.g.: [email protected]) Framed-IP-Address NAS-IP-Address Calling-Station-ID Called-Station-ID Acct-Termination-Cause Acct-Session-Time

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

284

Chapter 11: CDR Server

n n

Acct-Input-Octets Acct-Output-Octets

CDR Server Tools

CDR Server provides the operator with various tools to analyze retained CDR information.
n n n n n n

CDR Query CDR Plot CDR Watch CDR Analysis Report CDR Purge CDR Export

CDR Query CDR Server provides a query tool that provides CDR information based on a selected user or IMSI string for a configured time-window. This capability allows the operator to perform simple queries to view the CDR detail for a specific User or IMSI. Also refer to Performing a CDR Server Query. CDR Plot CDR Server provides a plotting tool that allows the operator to generate various graphical analyses of the current call data. The CDR plot can be based on a variety of configurables, including:
n

How the data is measured (average of all measurement, maximum of all measurements, the sum of all measurements) What you want CDR server to measure (number of calls, bytes of all calls, duration of calls) How you want CDR server to group the measurements and/or narrow the analysis How you want CDR server to present the data (from highest to lowest, or in a more natural occurring order) The time period from which to draw the CDR data

Also refer to Plotting a CDR.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CDR Server Overview

285

CDR Watch CDR Server allows the operator to perform a CDR watch. This allows the operator to view a call detail record based on user name or IMSI string whenever an Accounting request is received that matches the selection criteria. The resulting CDR lists all of the associated attributes in the Accounting-Request for each unique call. This feature is valuable for viewing live CDR data as calls start and stop. Also refer to Performing a CDR Watch. CDR Analysis Report A CDR Analysis Report can be generated on a periodic basis at specified, repeating time intervals. Operators can also provision the report to notify other personnel via email that the report is available. The compiled report can be viewed via a standard web browser. The CDR Analysis report includes these sections:
n n n

Call Duration Analysis by Domain (refer to Figure 191 for sample output) Busy Hour Analysis by Domain (refer to Figure 192 for sample of the output) Data Throughout Analysis by Domain (refer to Figure 193 for sample output)

Also refer to Creating a Scheduled CDR Analysis Report. Figure 191 CDR Analysis Report Sample Output - Call Duration by Domain

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

286

Chapter 11: CDR Server

Figure 192 CDR Analysis Report Sample Output - Busy Hour Analysis by Domain

Figure 193 CDR Analysis Report Sample Output - Data Throughput by Domain

CDR Purge CDR Server provides a purging feature that allows operators to:
n n

Purge CDRs at a scheduled time each day. Configure a time period (e.g., the number of days) to retain all CDR records before they are purged.

The purge feature is valuable for establishing a policy that prevents the CDR database from exceeding a manageable size.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Installing CDR Server

287

Also refer to Purging CDRs. CDR Export This feature allows the operator to export the raw CDR data collected in the database to the CEM Client workstation for external analysis. CDR Server allows you specify which CDR data to export. The export function does not delete any records from the database. The CDR data is exported to a temporary file on the CEM Server. It then uses FTP to transfer the export file to the client workstation. Also refer to Exporting CDRs.

Installing CDR Server

A feature key is required to install the CEM CDR Server package. Refer to Installing a CEM Package in Chapter 3 for the installation procedure. CAUTION: CDR Server must be deployed on a separate hardware platform to assure maximum performance. CDR Server is NOT supported if it is installed on an existing CEM Server that is used for routine Network Management operations. In addition, CDR Server is supported via the use of external databases only. Once installed, the CDR Server icon appears in the CEM Explorer tree. Refer to Figure 194 Figure 194 CDR Server Icon

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

288

Chapter 11: CDR Server

Configuring CDR Server

After installation, some configuration is required to fully provision the CDR Server for use:
n n n n n n

Configuring the override.properties File Provisioning the NAS Secret Configuring Attribute Retention Configuring the RADIUS Client Provisioning Filters Configuring the RADIUS Client

Configuring the override.properties File

To configure the override.properties file: 1 Navigate to the directory where the RADIUS/CDR server package is installed. 2 Open the override.properties file in a text editor. 3 Add this property to the override.properties file.
load.CDRServer=

4 Refer to Table 45 to set additional properties as required. Table 45 RADIUS/CDR Server Property Settings
Property / Default Value load.CDRServer= radius.authenticate=yes radius.accounting.server.port=1813 Description / Usage Instructs the CEM Server to load the CDR Server Optional. If set to no, no authentication is done on all received packets. Optional. Specifies a different UDP port to receive RADIUS packets.

radius.accounting.server.QueueSize=2000 Optional. The maximum size of the internal queue to process RADIUS packets. Any new RADIUS packets arriving when the current queue size exceeds this number, are silently discarded. radius.accounting.server.Threads=1 Optional. The number of worker threads that process packets in the queue. It is not wise to increase this number to more than 5 times the number of CPUs. Optional. Set to yes to trace every RADIUS packet received. Optional. Set to yes to trace every RADIUS packet received that failed to meet the CEM criteria for processing. Used to provision all known RADIUS clients and their associated secrets. See below. Used to provision which RADIUS Attributes are retained in the database. See below. The Watch capability is implemented by a special TCP connection to the CEM Server. This property allows forcing the CEM server to use a specific TCP port number. If set to 0, CEM uses any available port.
Part Number D4000-006 Rev A1 January 2011

trace.RADIUS=no trace.badRADIUS=no

radius.NAS=ipAddress[:secret][;...] radius.retain = retainedEntry[;retainedEntry]... radius.tap.port=0

Common Element Manager User Guide

Configuring CDR Server

289

Table 45 RADIUS/CDR Server Property Settings

Property / Default Value radius.tap.max=10 radius.ALLOW.domain=filters radius.DENY.domain=filters Description / Usage Limits the maximum number of unique calls to be displayed in the Watch window. The default is 10. Used to apply Domain filters to the Accounting-Requests. See Provisioning Filters below.

Provisioning the NAS Secret

Each RADIUS client that sends RADIUS Accounting packets to CEM must share a RADIUS secret used to authenticate all packet exchanges. The radius.NAS property is a semicolon-separated ordered set of NAS IP Addresses and corresponding secrets. Format
radius.NAS=ipAddress[:secret][;ipAddress[:secret]]...

The IP Address of all received messages must be found by matching some entry in the list. If a match is not found, the message is silently discarded. If an entry does not supply a secret, no authentication is performed and the original authenticator is returned unchanged in the Accounting-Reply message. The ipAddress can contain * in any segment for wildcard match. Wild cards should be placed at the end of the list.

n n

Example:
radius.NAS=149.112.250.*:NewNet

This entry authenticates using 'NewNet' for all messages received from any ipAddress matching 149.112.250.* If this property is not provisioned, the CEM uses *.*.*.* as the default. The default entry specifies that the CDR Server accepts packets from any device without authentication. Configuring Attribute Retention The key RADIUS Accounting attributes (and database column names) that are automatically retained in the database include:
n n n n

User-Name: as userID and Domain Acct-Session-Time: as callDuration Acct-Input-Octets: as bytesRecv Acct-Output-Octets: as bytesSent

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

290

Chapter 11: CDR Server

Wallclock-Timestamp: Used to determine the start, interim and stop timestamps

The radius.retain property (configured in override.properties) is used to configure which additional RADIUS Accounting attributes should be retained in the database. Syntax:
radius.retain = retainedEntry[;retainedEntry]...

Multiple retainedEntrys may be specified separated by a semicolon. The syntax for each retainedEntry is:
radiusAttributeName[(maxSize)]

This is the simplest mechanism to specify which optional attributes should also be retained in the database. The radiusAttributeName must be found in one of the dictionary files. The maxSize is applicable to attributes that are non-numeric in nature. It is used to specify the maximum character size of the value stored in the database. The default size of non-numeric values is 50 characters. Values are stored in a database column whose name is derived from the radiusAttributeName by replacing all '-' characters with '_' characters. For example, Calling-Station-Id would be stored in column Calling_Station_Id. Any numeric attributes that have enumerated values will be decoded to their enumerated string value before being stored in the database. For example, the Acct-Terminate-Cause is defined as an integer, but enumerates each integer value. If the CDR server receives an Acct-Terminate-Cause value of 4, then Idle timeout is stored in the database.
dbColumnName[(maxSize)] = radiusAttributeName[,radiusAttributeName]...

This syntax is used to store any one of the specified radiusAttributeName in a specific database column. It is useful when different attributes may be sent in different RADIUS messages - but they all signify the same basic information. They do not warrant separate database columns. For example, Acct-Terminate-Cause /OR/ 3GPP2-Release-Indicator may be found in a RADIUS message. Both signify the reason for the call termination. To store either value in a single database column, use the syntax:
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Configuring CDR Server

291

Termination = Acct-Terminate-Cause, 3GPP2-Release-Indicator

This command stores either value in a database column named Termination. The default radius.retain configuration is:
radius.retain = Framed-IP-Address \

; NAS-IP-Address \ ; Calling-Station-Id \ ; Termination(30) = ; Mobile-Session-ID \ ; 3GPP2-Correlation-ID \ ; 3GPP2-Serving-PCF \ ; 3GPP2-IP-Technology Acct-Terminate-Cause \ , 3GPP2-Release-Indicator \

The use of '\' characters continues the property values across multiple lines. Changes made to the radius.retain property do not take effect until the CEM Server is restarted. When the CEM Server restarts, it analyzes the current CDR SQL table definition and automatically adds and removes columns as appropriate. You DO NOT need to reload the database or use a database utility to ensure the CDR SQL table is designed correctly.
n

If an attribute/column is dropped, only the values associated with column are lost. All other current CDR data is retained. If an attribute/column is added, all current CDR records inherit a default value for the new column. Numeric attributes have a default value of 0, while non-numeric attributes have a default value of an empty string. If changes are made to the radius.retain property, the CDR Plot tool, CDR Query tool and CDR Export tool automatically adapt to the changes made to the attributes being retained in the database the next time the CEM Server is restarted.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

292

Chapter 11: CDR Server

Provisioning Filters

If necessary, Domain filters may be specified to limit the CDRs that are retained in the database. If no filters are provisioned, all Accounting-Request data will be retained in the database. Any changes made to the filters will take effect the next time the CEM Server is restarted. CEM Supports both an ALLOW and DENY domain filter. Both the ALLOW and DENY filters can specify multiple filter-specifications, each separated by a semicolon. When CEM receives an Accounting-Request message, it first attempts to determine the domain part of the User-Name attribute:
n

If the operator provisions the ALLOW filter, the domain must match at least one of the filter-specifications - otherwise the domain is ignored. If the operator provisions the DENY filter, and the domain part matches any one of the filter-specifications, the request is ignored. If the operator provisions both the ALLOW and DENY filter, CEM first filters CDRs by allowed domains, and then, from the allowed domains, filters denied domains. For example:
radius.ALLOW.domain=newnet* radius.DENY.domain.newnet.chgo.com

In this example, CDR Server first obtains data from all newnet domains (e.g., newnet.chgo.com, newnet.ny.com, etc.). Then CDR Server filters out only the ustar.chgo.com domain from the obtained allowed newnet domains. Each filter-specification is basically a string pattern using one of the forms listed in Table 46. Examples
radius.ALLOW.domain=*newnet* ; *.net

In this example, the filter retains only those records where the domain part contains newnet or ends with .net (unless matching a DENY filter).
radius.DENY.domain=midwest*

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Configuring CDR Server

293

In this example, the filter does not retain records if the domain name starts with midwest. Table 46 Filter Specification String Patterns
String Pattern * *xxx xxx* *xxx* xxx Description Any domain will match. Domains ending with xxx. Domains starting with xxx Domains containing xxx Domains that match xxx exactly.

Configuring the RADIUS Client

Before you can use any of the features of the CDR Server package, you must configure a RADIUS client to send its secondary accounting stream data to the CEM Server. To configure the RADIUS client: 1 In the CEM Explorer Tree locate and select the component you want to configure:
n

Total Control 1000: Select the AAA subfolder in the Security root folder. Total Control 2000: Select at the blade level.

2 Right-click and select RADIUS Accounting. 3 Click Start receiving The client now automatically mirrors all of its RADIUS accounting requests to this CEM Server. The CDR information will then be available for analysis by the various features of CDR Server. The Stop receiving command reverses the operation.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

294

Chapter 11: CDR Server

Managing CDR Server

When you select the CDR Server icon in the CEM Explorer Tree, several tabs appear in the right pane of the main window. These tabs allow you to view and manage various properties that govern the behavior of CDR Server.
n n n

Statistics Tab Purge Policy Tab Configuration Tab

Statistics Tab

The Statistics tab shows the current counters and statistics for the CDR Server. Figure 195 CDR Server Statistics Tab

Table 47 describes the information listed in the Statistics tab. Table 47 CDR Server Statistics Tab Field Descriptions
Field Packets Discarded Description Number of RADIUS packets discarded. Usually because the server was disabled, or the packet was not an Accounting-Request, or could not be authenticated. Number of RADIUS packets not retained after applying the ALLOW and DENY filters. See Filter Provisioning below. Number of RADIUS packets received but could not be processed because of a queue overflow. Number of RADIUS Accounting-Request packets processed Number of RADIUS Accounting-Request packets queued to the processed. Number of RADIUS packets received on the listening port. Number of RADIUS Accounting-Response packets sent in response to one received.

Packets Filtered Packets Overflowed Packets Processed Packets Queued Packets Received Packets Sent

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Managing CDR Server

295

Purge Policy Tab

Use this tab to provision the CDR purge policy. For additional information, refer to CDR Purge. Figure 196 CDR Server Purge Policy Tab

Table 48 describes the Purge Policy Tab configuration fields. Table 48 CDR Server Purge Policy Tab Field Descriptions
Field Archive when purged Description Enables automatic archiving of all RADIUS DB data that is removed from the database. Each time the RADIUS DB is purged, the purged data will be archived in a file named RADIUSData-yyyymmdd-hhmm.tsv in the /historicalDataArchive directory on the CEM Server. The number of days after which all previous RADIUS data will be purged. No data is retained prior to this period. Enables automatic archiving of CDR records that are purged at the Purge daily time. Enables automatic purging of CDR records at the Purge daily time. The last time the RADIUS DB was purged. Total number of times RADIUS data was purged due either to automatically purging at the specified time or purged on demand. The time of day that the RADIUS DB should automatically purge in accordance with the configured purge policy. Leave this field blank to never purge automatically. If enabled, the format for the entry must take this hours:minutes:seconds format: hh:mm:ss

Delete after (days) Enable daily archive Enable daily purging Last time purged Number of times purged Purge daily at

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

296

Chapter 11: CDR Server

Configuration Tab

Use this tab is to provision default values when you configure a RADIUS client to mirror its RADIUS Accounting requests to this CEM Server. If CEM Server redundancy is implemented, each CEM Server should use a different Mirror Group. Also refer to Configuring the RADIUS Client. Figure 197 CDR Server Configuration Tab

CDR Server Procedures

This section provides procedures for the various tasks required to operate CDR Server:
n n n n n n

Performing a CDR Server Query Plotting a CDR Performing a CDR Watch Creating a Scheduled CDR Analysis Report Purging CDRs Exporting CDRs

Performing a CDR Server Query

For more detailed information, refer to CDR Query. To create a CDR Server query: 1 In the CEM Explorer Tree, select CDR Server. 2 Right-click and select CDR Query. The CDR Data Query dialog box appears.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CDR Server Procedures

297

3 Make the entries described in Table 49. Table 49 CDR Data Query Entries
Field User/IMSI Description Click to enable either the User or IMSI radio button. Then enter either the User name or IMSI string. The value entered can use wildcard matching characters:
n n

%: any number of characters _ : a single character 847262%: Any call where the User starts with 847262 and contains any number of trailing characters. %newnet.com: Any User whose id ends with newnet.com.

For example:
n

Note: The IMSI choice is disabled if the Calling-Station-Id attribute is not configured to be retained in the database. From/To Use these menus to narrow the time window of the search to all calls that STARTED between the selected GMT date and time.

4 After making your entries, click Query. 5 CEM lists the results of the query in the dialog box's table. Figure 198 provides an example of the output. Figure 198 CDR Data Query Dialog Box: Sample Output

The query lists a maximum of 50 CDR records matching the selection criteria, even if the selection criteria match more than 50 records. Plotting a CDR For more detailed information, refer to CDR Plot. To plot a CDR: 1 In the CEM Explorer Tree, select CDR Server. 2 Click the secondary mouse button. 3 Click CDR Plot. The CDR Details Analysis dialog box appears.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

298

Chapter 11: CDR Server

4 Make the entries described in Table 50 to format your graphical analysis. Table 50 CDR Details Analysis Dialog Box Field Descriptions
Field COUNT Description In the drop-down menu, select the method you want CEM to use to measure the collected data. Options are:
n n n

COUNT: Count the number within the group. SUM: Provide the sum of the measurements within the group. AVG: Provide the average of all measurements within the group MAX: Provide the maximum of all measurements within the group. MIN: Provide the minimum of all measurements within the group. Calls: Provide the count of all calls in the group Bytes: (Acct_Input_Octets + Acct_Output_Octets) of all calls in the group Duration: Acct_Session_Time of all calls in the group.

CALLS

In the drop-down menu, select what you want CEM to measure:

n n

DOMAIN

In the drop-down menu, select the method CEM will use to group the measurements. the choices available are based on the configured CDR attributes retained in the database. Optional. In the drop-down menu, select how you want CEM to narrow the analysis to CDRs with the selected field equal to a specific value. This menu contains all the names of columns retained in the database. This is used in conjunction with the value described next. Note: When changing this selection, you may notice the GUI hesitating. This is normal while the GUI searches the entire database for all known values for the selected field.

DOMAIN

VALUE Pareto From/To

In the drop-down menu, select the values now available based on your choice in the previous drop-down menu. Click to have the chart show the highest to lowest values. If Pareto is not checked, the values appear in a more natural order. Use these menus to narrow the time window of the data being analyzed.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CDR Server Procedures

299

5 After making your selections, click Update. CDR Server plots the specified CDR information. Figure 199 provides a sample of the output. Figure 199 CDR Server Plot Dialog Box: Sample Output

6 The Plot Page Navigation bar can be used to view different parts of the chart:
n

Moving to next, previous, first, or last page of the chart Changing the page size or the number of bars to show on a page Chart type: Line, Bar or Area.

Performing a CDR Watch

For more detailed information, refer to CDR Watch. To perform a CDR watch: 1 In the CEM Explorer Tree, select CDR Server. 2 Click the secondary mouse button. 3 Click CDR Watch. The CDR RADIUS Watch dialog box appears. 4 Enter the desired the User name or IMSI string in the field provided. 5 Click Connect. CEM lists the CDR information for the selected user/IMSI string. Figure 200 provides a sample of the output.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

300

Chapter 11: CDR Server

Figure 200 CDR RADIUS Watch Dialog Box: Sample Output

Purging CDRs

For more detailed information, refer to CDR Purge and Purge Policy Tab. To purge CDRs: 1 In the CEM Explorer Tree, select CDR Server. 2 Click the secondary mouse button. 3 Click Maintenance 4 Click Purge now. CEM purges the CDR database.

Exporting CDRs

For more detailed information, refer to CDR Export. To export CDRs: 1 In the CEM Explorer Tree, select CDR Server. 2 Click the secondary mouse button. 3 Click Maintenance. 4 Click Export CDRs. The CDR Data Export dialog box appears.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CDR Server Procedures

301

Figure 201 CDR Data Export Dialog Box

5 Make the entries listed in Table 51. Table 51 CDR Data Export Entries
Field Call End Time Range Description Select how you want the exported data filtered. Options are:
n n

All CDRs: Exports all current CDR data in the database. All CDRs older than <n> days: Exports all current CDR data in the database where the call stop time is older than the indicated number of days from the current day. Calls that are in progress are NOT exported. All CDRs from <date> to <date>: Exports all current CDR data in the database where the call stop time is between the two dates. If this option is selected, you can click on a date button to change the date.Calls that are in progress are NOT exported.

Export to file

Click Browse to navigate to and select the desired location to which you want to export the CDR data.

6 Click Export. CEM begins the export operation. Progress status messages are provided during the operation.Click Cancel to terminate the operation. Creating a Scheduled CDR Analysis Report For more detailed information on the CDR Analysis Report, refer to CDR Analysis Report. To create a CDR Analysis Report: 1 In the CEM Explorer Tree, select the Scheduled Events folder and right-click. 2 Click New, then click Scheduled Report. The Scheduled Report Wizard launches. 3 Enter a unique name for the CDR Analysis Report, then click Next. 4 For Report Type, select CDR Server:CDR Analysis, then click Next. 5 For the Report Scope, select the component or components you want the report to include, then click Next.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

302

Chapter 11: CDR Server

6 Specify the time, date, and year you want CEM to begin generating the report, then click Next. 7 If you want CEM to generate the report on a repeating basis, click to place a check mark in the Enable Repeating Interval checkbox. 8 In the drop down menu, select the repeating time interval you want CEM to use in generating the report, then click Next. 9 To enable an ending time for repeated report generation, click to place a check mark in the Enable Ending Time check box. Then specify the time, date, and year you want report generation to end. 10 Click Next. 11 Enter the email address(es) of any personnel you want to notify when the report is generated and available for viewing. Separate multiple email addresses by pressing <Enter>. 12 Click Finish. The report is configured and will begin generating at the specified time.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

12

CEM NOTIFICATIONS

This chapter describes how to install and use the CEM Notifications value-added package.
n n n

CEM Notifications Overview Installing CEM Notifications CEM Notification Procedures

This chapter assumes CEM is installed and configured. For information on installing and configuring CEM, refer to Chapter 3.

CEM Notifications Overview

CEM Notifications provides the capability for the user to notify operators when selected events are detected from various equipment. The notification trigger event can be a single event or trap, or any event or trap defined within a single MIB module of a specific severity. This provides an effective way for various operators to be informed events of varying degrees of severity so that they can prioritize trouble clearing. The Notification Wizard allows the user to provision multiple notifications so that different operators are notified if different events are detected from different equipment. The Wizard also allows operators to edit currently configured notifications. When you edit an existing Notification, the Wizard shows the currently provisioned parameters. A CEM notification can be provisioned in one of these ways:
n

CEM Notification Creation

Notification Methods

Email Notification: An email is sent to a specified address via a POP3 mail server. The email option is not enabled if the CEM Server has not provisioned a SNTP Server using the SMTP.Server property. The operator does not need to be logged in to CEM to receive email notifications. Also refer to Viewing CEM Notification Properties and Relationships and Email Templates. Popup Window: A popup window appears if the user is logged on to the CEM client. Refer to Figure 202 for examples. The popup window can also be provisioned to play a sound. This sound is one that the operator associates with the configured event severity in the User Options dialog box. Also refer to Provisioning Event Sounds. Email and a Popup Window: Email notifications are sent to the designated operators and a popup window appears to those users logged onto CEM.
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

304

Chapter 12: CEM Notifications

Figure 202 CEM Popup Notification Examples

Email Templates If email is selected as a notification method, the operator can select from a set of email templates. CEM Notifications is shipped with a default email template. Operators can modify the default template in a simple text editor to create new templates. All templates must be stored in the schema/standard/notification/ directory with a .notificationTemplate file extension.
n

The default email template communicates the event properties (if applicable) described in Table 52.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Notifications Overview

305

Email notifications may be sent to cell phones or pagers using the service provider's gateway. Refer to Table 53 for examples.

Table 52 Default Email Notification Event Properties

Email Template Property label perceivedSeverity loggingTime eventTime help additionalText probableCause name device ip Description The event's main display label (short description). Severity of the event. Time the event was logged. Time reported by the device (if any) usually sysUpTime. Full description of the event (if any). any additional text of the event (if any). Probably cause of the event (if any). Name of the event, trap, or notification. Name/label of the device/object in the CEM containment generating the event. IP address of the device generating the event (if any).

Table 53 Examples for Sending to Email Notifications to Cell Phones or Pagers

Service Provider Verizon Wireless SBC Email Paging Sprint US Cellular ATT Cingular T-Mobile Nextel Gateway address [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

306

Chapter 12: CEM Notifications

Provisioning Event Sounds Notification popup windows can be provisioned to play an alert sound, as well. These event sounds are configured using the Event Options tab on User Options dialog: Figure 203 Event Options Tab

The Sound buttons are used to select a specific sound file for each severity. The default is None. The current file name that is configured is shown on the button. The Clear All Sounds button resets all sounds to None. When a sound button is chosen, a file selection dialog box appears where you can choose the specific sound file. The sound file is selected from the workstation on which the GUI is running - not the Server. Use the Play button to preview the sound file.

n n

There is no file filter implemented on this selection window. The file types are platform dependent and typically include .WAV .AIFF .AU .MID and .RMF encoded sound files. If a non-sound file is mistakenly selected, no sound plays.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

CEM Notifications Overview

307

Viewing CEM Notification Properties and Relationships

Once created, CEM notifications are formal managed objects found under the Notifications root folder: From this folder, you can view various properties and associations configured for the selected notification. Properties Right click on the configured Notification to display the Properties tab. The Configuration tab on the Properties tab will show the main provisioning details. Refer to Figure 204. These values are all read-only and can only be changed using the Notification Provisioning Wizard. Also refer to Editing a CEM Notification. Attribute Name and Attribute Value are associated with monitoring Attribute Change notifications otherwise the fields are ignored. Figure 204 CEM Notifications Properties Tab

Relationships The Monitor Events from tab on the Related tab lists the scope of the notification references in the explorer tree from which the event must be generated in order to trigger the notification. Refer to Figure 205. Figure 205 Monitor Events from Tab

The Sent to tab on the Related tab lists all of the Users to which a notification can be sent to. Refer to Figure 206.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

308

Chapter 12: CEM Notifications

Figure 206 Sent to Tab

Installing CEM Notifications

A feature key is required to install the CEM Notifications package. Refer to Installing a CEM Package in Chapter 3 for the installation procedure. Once installed, the CEM Notifications icon appears in the CEM Explorer Tree. Refer to Figure 207. Figure 207 CEM Notifications Icon

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Notification Procedures

309

CEM Notification Procedures

This section provides procedures required to work with the various features of CEM Notifications:
n n n

Creating a CEM Notification Editing a CEM Notification Deleting a Notification

Creating a CEM Notification

For more detailed information, refer to CEM Notifications Overview. To create a CEM Notification: 1 In the CEM Explorer Tree, select the Notification folder and right-click. 2 Click New, then click Notification. The Notification Wizard launches. 3 Enter a unique identifying label for this CEM Notification, then click Next. The Select Event Dialog Box appears. 4 Select how you want the notification to be triggered. There are three options:
n

Event Category: The Options panel dynamically changes to allow the selection of a severity filter. Also refer to Figure 208. attributeChange: The Options panel dynamically changes to allow the operator to select a specific Attribute and Value that triggers the notification. Also refer to Figure 209.
n

Attribute Name must be an Attribute/MIB name as seen in the Advisor window. Attribute Value is optional. If specified, the event is triggered only if the attribute's value is changed to that specific value. Otherwise, any change in the attribute's value results in triggering the notification.

Specific Event: There are no additional options available to further filter/specify the notification trigger. Also refer to Figure 210.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

310

Chapter 12: CEM Notifications

Figure 208 CEN Notifications Wizard Select Event Dialog Box: Selecting Event Category

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Notification Procedures

311

Figure 209 CEM Notifications WIzard Select Event Dialog Box: Selecting attributeChange

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

312

Chapter 12: CEM Notifications

Figure 210 CEM Notifications Wizard Select Event Category: Selecting an Event with No Options

5 Click Next. The Select Scope dialog box appears.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM Notification Procedures

313

Figure 211 CEM Notifications Wizard Select Scope Dialog Box

6 Specify the component or components from which the event must originate to trigger the Notification, then click Next. The operator can select a single object, or a folder as the scope. Selecting a folder triggers a notification if the event(s) is detected in any subdirectory of that folder. Select the root to trigger the notification if the event is detected by any object in the containment tree. The Select How dialog box appears. 7 Select how the Notification will be delivered to the User(s). You can click to enable both E-Mail and Popup Window as the method of notification. The Email option is not enabled if the CEM Server has not provisioned a SNTP Server using the SMTP.Server property. For more detailed information on configuring email and popup notifications, refer to Notification Methods, and Viewing CEM Notification Properties and Relationships. 8 Click Next. The Select Users dialog box appears. 9 Specify which users to notify when the configured Notification is triggered. The operator may multi-select any number of specific Users or group of Users in a User folder.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

314

Chapter 12: CEM Notifications

10 Click Next. The Finish dialog box appears. 11 Click to place a check in Enable Notification checkbox to automatically enable this Notification. 12 Click Finish to commit the changes and activate the Notification. Editing a CEM Notification For more detailed information, refer to CEM Notifications Overview. To edit an existing CEM Notification: 1 In the CEM Explorer Tree, expand the Notifications folder. 2 Select the Notification you want to edit and right-click. 3 Click Disable. A Notification must be disabled before it can be edited. 4 With the Notification still selected, right-click. 5 Click Edit. The Notification Wizard launches. 6 Make the desired entries to edit the Notification. The procedure is identical to the one provided in the Creating a CEM Notification procedure. Deleting a Notification For more detailed information, refer to CEM Notifications Overview. To delete a CEM Notification: 1 In the CEM Explorer Tree, expand the Notifications folder. 2 Select the Notification you want to delete and right-click. 3 Click Delete. 4 In the confirmation dialog box, click Yes to delete the notification, or click No to cancel the operation. The Delete Notification dialog box begins the operation and informs you when the deletion is complete. 5 Click Close to return to CEM.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

13

PERFORMANCE MONITOR

This chapter describes how to install and use the CEM Performance Monitor value-added package.
n n n

Performance Monitor Overview Installing Performance Monitor Performance Monitor Procedures

This chapter assumes CEM is installed and configured. For information on installing and configuring CEM, refer to Chapter 3.

Performance Monitor Overview

Performance Monitor allows the operator to view information on configured performance parameters in real-time. This allows operators to observe and quickly isolate suspected network problems as they occur. Performance Monitor profiles are created by the user to monitor a defined object property or set of object properties for various types of components. When you define these properties, you do not create an association with a specific component. This means that saved performance profiles can be used to monitor any component or group of components that make use of the object property or properties defined in the performance profile. Performance Monitor does not require the deployment of a commercial database. Performance Profile Creation Performance profiles can be configured to show multiple performance gauges in a single profile. In addition, multiple profiles can be launched simultaneously for viewing. A performance gauge is tied to a single equipment performanceoriented property that is polled at a specified interval. A sample of a performance profile with three performance gauges is provided in Figure 212.

About Performance Profiles

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

316

Chapter 13: Performance Monitor

Figure 212 Performance Profile with Multiple Gauges

A performance profile can be configured to aggregate performance properties across any level of containment to provide the ability to roll-up performance properties across multiple devices/blades. Performance gauges can be configured as bar or dial types, and automatically adjust to new performance parameters added to equipment. Performance Monitor does not save any monitored values, nor does it monitor any configured thresholds. Performance Profile Management Performance Monitor allows the operator to create, edit, and use performance profiles at any time. Profiles can also be imported and exported as ASCII files for sharing between operators. This can simplify performance management by providing the capability to create a library of performance profiles for sharing between operators across a wide geographic region.

Installing Performance Monitor

Performance Monitor is bundled with the Performance and Capacity Manager (PCM) and Call Detail Record (CDR) Server CEM value-added packages. It is available for use from any location in the CEM Explorer Tree after installation of either of those packages. Once installed, the Performance Monitor can be accessed by selecting any item in the CEM Explorer Tree, right-clicking, and selecting Performance Monitor. Refer to Figure 213.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Performance Monitor Procedures

317

Figure 213 Accessing the Performance Monitor

Performance Monitor Procedures

This section provides procedures for performing the various tasks required to use Performance Monitor
n n n n n n

Creating a Performance Monitor Profile Adding a Gauge to a Performance Monitor Profile Launching a Performance Monitor Profile Exporting a Performance Monitor Profile Importing a Performance Monitor Profile Editing a Performance Monitor Profile

Creating a Performance Monitor Profile

For more detailed information on performance profiles, refer to Performance Profile Creation. To create a Performance Monitor profile: 1 In the CEM Explorer tree, select the component(s) or folder for which you want to create a PDM gauge. 2 Right-click, then click Performance Monitor. The Performance Monitor dialog box appears. The large title just above the bar gauge reflects the name of the component or folder you selected in step 1. 3 Right-click in the Performance Monitor dialog box, then select Properties. The Gauge Properties dialog box appears.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

318

Chapter 13: Performance Monitor

Figure 214 Gauge Properties Dialog Box

4 Make the entries described in Table 54. Table 54 Gauge Properties Entries
Section Graphical Type Field Bar Dial Labels Show Title Show Label Show Value Using Format Entry Click to format the gauge as a vertical multi-segment bar. Click to format the gauge as a speedometer-like dial. Click to enable CEM to display the specified gauge title above the gauge. Click to enable CEM to display the specified gauge label below the gauge. Click to enable CEM to show the current numeric value on the indicator. Click to enable the use the specified format when showing the gauge value. Specified format variables include:
n n n

# - prefix digits blank when 0 0 - prefix digits Anything is displayed literally.

Example: ##,##0/sec

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Performance Monitor Procedures

319

Table 54 Gauge Properties Entries

Section Value Range Field Auto scale maximum value Entry Click to automatically scale the indicator to a maximum value of 1, 5, 10, 50, 100, 500, etc. If not checked, use the specified maximum value. The minimum value is always 0. Warning level Critical level Performance Parameter Object Type Property Click to show the warning level in yellow as the specific percentage of the maximum. Click to show the critical level in red as the specific percentage of the maximum. These are used in conjunction with one another to select the specific performance parameter used.
n

Use Object type Browse... to select the kind of equipment from which to choose the Property (e.g.: PDSN). Use Property Browse... to select the specific performance parameter for the selected Object.

Calculate

In the drop-down menu, select how you want CEM to calculate the selected performance parameter:
n n

Value: Absolute value rate/sec: rate per second between two successively polled values rate/min: rate per minute rate/hour: rate per hour

n n

Aggregate

In the drop-down menu, select how you want CEM to aggregate the individual performance values when more than one equipment element is being polled.
n

Sum: sum of all values obtained from all equipment Average: average of all values obtained from all equipment

5 After making your entries, click OK. You are returned to the Performance Monitor dialog box. Both the Title and Label you created appear on the Performance Monitor gauge. 6 In the Performance Monitor dialog box, click Profile. 7 Click Save As. The Save as dialog box appears. 8 Enter a profile name for the new gauge. 9 Click OK to save the profile. Your profile is saved and available for use at any time.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

320

Chapter 13: Performance Monitor

Launching a Performance Monitor Profile

For more detailed information on performance profiles, refer to Performance Monitor Overview. To launch a saved Performance Monitor profile: 1 In the CEM Explorer Tree, select the component(s) you want the profile to monitor. 2 Click the secondary mouse button. 3 Click Performance Monitor. The Performance Monitor dialog box appears. 4 In the Performance Monitor dialog box, click Profile. 5 Click Open. 6 In the drop-down menu, select the desired Performance Monitor profile. 7 Click OK. The selected Performance Monitor profile opens and begins monitoring the selected component(s).

Adding a Gauge to a Performance Monitor Profile

For more detailed information on performance profiles, refer to Performance Monitor Overview. To add a gauge to an existing Performance Monitor profile: 1 Launch the desired profile. Refer to Launching a Performance Monitor Profile for the procedure, if necessary. 2 Click Profile. 3 Click Add Gauge. A new bar gauge appears on the Performance Monitor Gauge as shown in Figure 215 Figure 215 Adding a Performance Bar Gauge to a Profile

4 On the new bar gauge, right-click.

Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

Performance Monitor Procedures

321

5 Click Properties. The Gauge Properties dialog box appears. 6 Make the desired entries for the new gauge. The entries are described in Table 54. 7 After making your entries, click OK. You are returned to the Performance Monitor dialog box. You newly configured gauge has been added. 8 Repeat step 2 - step 7 to add any additional gauges to the profile. 9 Click Profile, then click Save as. Enter a name for the profile. 10 Click OK. CEM saves the modified profile. Exporting a Performance Monitor Profile For more detailed information on performance profiles, refer to Performance Profile Management. To export a saved Performance Monitor profile: 1 Launch the profile you want to export. Refer to Launching a Performance Monitor Profile. 2 In the Performance Monitor dialog box, click Profile. 3 Click Export. The Export profile dialog box appears. 4 Navigate to the directory to which you want to export the profile. 5 Click Save. The profile is exported to the specified location and now can be sent to another operator by email or other data transfer method. Importing a Performance Monitor Profile For more detailed information on performance profiles, refer to Performance Profile Management. To import a Performance Monitor profile: 1 In the CEM Explorer Tree, select a folder. 2 Click the secondary mouse button. 3 Click Performance Monitor. The Performance Monitor dialog box appears. 4 In the Performance Monitor dialog box, click Profile. 5 Click Import. The Import profile dialog box appears.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

322

Chapter 13: Performance Monitor

6 Navigate to the location where the profile you want to import has been saved. 7 Select the profile name. 8 Click Open. CEM imports the selected profile. 9 Click OK at the confirmation dialog box. The imported profile is now available for use. Editing a Performance Monitor Profile For more detailed information on performance profiles, refer to Performance Profile Management. To edit a Performance Monitor profile: 1 Launch the desired performance monitor profile. Refer to Launching a Performance Monitor Profile for the procedure, if necessary. 2 In the Performance Monitor dialog box, right-click. 3 Click Properties. 4 Make the desired changes to the profile. Refer to Table 54 for details. 5 After making you changes, click OK. 6 In the Performance Monitor dialog box, click Profile. 7 Click Save. CEM saves the edited Performance Monitor profile.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

III
Appendix A Appendix B

APPENDICES

Command Line Interface Reference SNMP Device Common Configuration Tabs

COMMAND LINE INTERFACE REFERENCE

This appendix contains a comprehensive list of all commands used on the common element manager (CEM) server command line interface (CLI) and the CEM CLI client CLI.

CEM Server Console

Table 55 lists the available commands for the CEM server CLI. Table 55 Server Console Commands
Command ? broadcast message db export fileName docSchema exit [/f] find mib objectName help host hostName hpov_integration Function shows help for the server console commands broadcasts a message to all connected clients export the database with fileName document the schema stops the server displays definition of objectName shows help for the server console commands resolve hostName integrate with HP OpenView directory\package.jar For example: c:\cem\TCS47.jar inventory [packageName] logout userID jobs mail recipient property [name [value]] quit [/f] resdiscoverAll restart [/f] rmov_integration set name=value stats stop [/f] uninstall packageName upgrade packagName users display inventory force userID to be logged off list active/queued background jobs send short E-mail test to recipient show/set server property value stops the server rediscovers all equipment restarts the server remove HP OpenView integration set server property value show instrumentation statistics stops the server uninstall a package with packageName upgrade a package with packageName displays list of users logged in

install directory\package.jar install a CEM package from the following path:

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

326

APPENDIX A: COMMAND LINE INTERFACE REFERENCE

Devices and folders are identified on the console by name and by OID (object identifier number). An object is any CEM element. This includes folders, devices, and all log entries. A parent object such as the Logs folder has subordinate child objects, namely Security Log, Audit Log, and SNMP Log. Using Daemon-specific Server Console Commands Use the CEM CLI client to monitor and control a CEM server running as a background daemon. The CLI client sends any command, prefixed with the server keyword, to the CEM server. Table 56 lists some examples. Table 56 CLI Client Commands Used to Control CEM Server
Command server stop /f server restart /f server users Description Forces the CEM server to stop forces the server to restart lists the users that are logged in

For a comprehensive list of CEM CLI client commands, refer to Displaying Server Console Commands When the CLI client forces the CEM server to stop or restart, the CEM CLI detects that the CEM server has stopped and consequently issues a message. For example: user123>server stop /f Signaled server to stop user123>Server signal: The server shutdown. You will have to login again later. This is considered normal operation, indicating that you have successfully stopped the CEM server. You can also use the CLI client to issue one line commands without bringing up an interactive session. For example, to shutdown a server that is running as a daemon or a background process, a user can issue the following command:
runCLIClient server stop /f

This command executes the server stop /f command without starting the CLI client. Use this option to automate server interaction (for example, collecting statistics and issuing commands) or to issue stop commands in system scripts while a system is rebooting or going down.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

CEM CLI Client Console

327

CEM CLI Client Console

If you are running the CEM server as a daemon, this list changes. Table 57 lists the CEM CLI client console commands. Table 57 CEM CLI Client Commands
Command ? db export fileName docSchema exit find mib ojectName help host hostName inventory [packageName] logout userID mail recipient property [name [value]] quit rediscoverAll stats stop users Function shows help for the CEM CLI export the database with fileName document the schema exit the CLI displays definition of objectName shows help for the CEM CLI resolve hostName displays package inventory force userID to be logged off send short e-mail test message to recipient show/set server property value exit the CLI rediscovers all equipment show instrumentation statistics exit the CLI displays a list of users currently logged in

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

SNMP DEVICE COMMON CONFIGURATION TABS

Each SNMP device (and sub-component which contains an SNMP agent) contains basic functionality and statistics derived from standard MIBs (for example, RFC MIBs). Located on tabs on the right-hand pane of the CEM GUI main window, these configurables and statistics are considered common across all SNMP devices, not just NewNet-specific devices. This appendix lists these configurables and statistics common to all SNMP devices and any component containing an SNMP agent. For example, the access router card (ARC) contains an SNMP agent and can be discovered by itself, independent of a network management card (NMC). This appendix contains the following topics (* indicates not applicable for this release.):
n n n n n n n n n n n n n n n n n n n n n

Navigating to the Common Configuration Tabs for an SNMP Device Addressing Information Tab Address Translation Tab Conn Table Tab EGP Tab* ICMP Tab Identification Tab (refer to Viewing SNMP Device Identification) Interfaces Tab IP Tab Neigh Table Tab* NetToMedia Table Tab Routes Tab SNMP Tab SNMP Options Tab SNMP Statistics Tab State Tab (refer to Monitoring the Status of GUI Elements) System Tab TCP Tab TFTP Options Tab UDP Tab UDP Table Tab*
Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

330

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

Navigating to the Common Configuration Tabs for an SNMP Device

To navigate to the common configuration tabs for an SNMP device:

1 In the explorer tree, double-click the Equipment root folder. 2 Double-click the appropriate SNMP device folder. 3 Select the SNMP device. The Properties view changes to show the various configuration tabs for the selected SNMP device. Figure 216 shows the SNMP device level and the related configuration tabs. Figure 216 Configuration Tabs for an SNMP Device

Addressing Information Tab

Use the Addressing Information tab to view various IP address-related information for IP packets, broadcast packets, and SNMP devices. To use the Addressing Information tab: 1 Select the Addressing Information tab. The Properties view changes to show the Addressing Information tab. 2 Use the Addressing Information tab for your customized needs.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Address Translation Tab

331

Table 58 lists the values for the Addressing Information tab. Table 58 Addressing Information Tab Values
Field EntAddr EntBcastAddr Description Specifies the IP address to which this entry's addressing information pertains. Specifies the value of the least-significant bit in the IP broadcast address used for sending datagrams on the interface associated with the IP address of this entry. Specifies the index value which uniquely identifies the interface associated with this entry. Settings Read-only field Read-only field

EntIfIndex EntNetMask

Read-only field

Specifies the subnet mask associated with the IP Read-only field address of this entry. The value of the mask is an IP address with all the network bits set to 1 and all the host bits set to 0. Specifies the size of the largest IP datagram that can still be re-assembled from fragmented IP datagrams received. Read-only field

EntReasmMaxSize

Address Translation Tab

Use the Address Translation tab to view and configure the address translation table properties for a particular interface. To use the Address Translation tab: 1 Select the Address Translation tab. The Properties view changes to show the Address Translation tab. 2 Use the Addressing Translation tab for your customized needs. Table 59 lists the values for the Addressing Translation tab. Table 59 Address Translation Tab Values
Field IfIndex NetAddress PhysAddress Description Specifies the network IP address associated with the physical address of the indicated interface. Settings Read-only field

Identifies the interface for which information is displayed. Read-only field

Specifies the media-dependent (MAC) physical address octet string of the indicated interface. Leave this field blank to disassociate the indicated interface from the specified physical address.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

332

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

Conn Table Tab

Use the Conn Table tab to view and configure TCP and port connection properties for a particular SNMP device. To use the Conn Table tab: 1 Select the Conn Table tab. The Properties view changes to show the Conn Table tab. 2 Use the Conn Table tab for your customized needs. Table 60 lists the values for the Conn Table tab. Table 60 Conn Table Tab Values
Field LocalAddress Description Specifies the local IP address for this TCP connection. To indicate a connection in the listen state which is willing to accept connections for any IP interface associated with the HACN, 0.0.0.0 is used. LocalPort RemAddress RemPort State Specifies the local port number for this TCP connection. Specifies the remote IP address for this TCP connection. Specifies the remote port number for this TCP connection. Specifies the state of this TCP connection. The only value which may be set by a management station is deleteTCB. CEM will return a `badValue' response if any other value is entered. Entering deleteTCB deletes the TCB of the corresponding connection on the managed node, terminating the connection. Read-only field Read-only field Read-only field
n

Settings Read-only field

closed-status message. listen-status message. synSent-status message. synReceived-status message. established-status message. finWait1-status message. finWait2-status message. closeWait-status message. lastAck-status message. closing-status message. timeWait-status message. deleteTCB

3 To edit a property on the tab, double-click it and select the desired setting. 4 To save the changes, click Save All.
Common Element Manager User Guide Part Number D4000-006 Rev A1 January 2011

ICMP Tab

333

ICMP Tab

Use the ICMP tab to view Internet Control Message Protocol (ICMP)-related statistics for the SNMP device. To use the ICMP tab: 1 Select the ICMP tab. The Properties view changes to show the ICMP tab. 2 Use the ICMP tab for your customized needs. Table 61 lists the values for the ICMP tab. Table 61 ICMP Tab Values
Field InAddrMaskReps InAddrMasks InDestUnreachs InEchoReps InEchos InErrors InMsgs Description Settings

Specifies the number of ICMP Address Mask Reply Read-only field messages received. Specifies the number of ICMP Address Mask Request messages received. Specifies the number of ICMP Destination Unreachable messages received. Specifies the number of ICMP Echo Reply messages received. Specifies the number of ICMP Echo Request messages received. Specifies the number of ICMP messages received having ICMP-specific errors. Specifies the total number of ICMP messages received, including messages with ICMP-specific errors. Specifies the number of ICMP Parameter Problem messages received. Specifies the number of ICMP Redirect messages received. Specifies the number of ICMP Source Quench messages received. Specifies the number of ICMP Time Exceeded messages received. Specifies the number of ICMP Timestamp Reply messages received. Read-only field Read-only field Read-only field Read-only field Read-only field Read-only field

InParmProbs InRedirects InSrcQuenchs InTimeExcds InTimestampReps InTimestamps OutAddrMaskReps OutAddrMasks OutDestUnreachs OutEchoReps OutEchos

Read-only field Read-only field Read-only field Read-only field Read-only field

Specifies the number of ICMP Timestamp Request Read-only field messages received. Specifies the number of ICMP Address Mask Reply Read-only field messages sent. Specifies the number of ICMP Address Mask Request messages sent. Specifies the number of ICMP Destination Unreachable messages sent. Specifies the number of ICMP Echo Reply messages sent. Specifies the number of ICMP Echo Request messages sent. Read-only field Read-only field Read-only field Read-only field

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

334

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

Table 61 ICMP Tab Values (continued)

Field OutErrors OutMsgs OutParmProbs OutRedirects Description Specifies the number of ICMP messages not sent due to ICMP-specific problems. Specifies the total number of ICMP messages attempted, including errors. Specifies the number of ICMP Parameter Problem messages sent. Specifies the number of ICMP Redirect messages sent. For a host, this object will always be zero, since hosts do not send Redirect messages. Specifies the number of ICMP Source Quench messages sent. Specifies the number of ICMP Time Exceeded messages sent. Specifies the number of ICMP Timestamp Reply messages sent. Settings Read-only field Read-only field Read-only field Read-only field

OutSrcQuenchs OutTimeExcds OutTimestampReps OutTimestamps

Read-only field Read-only field Read-only field

Specifies the number of ICMP Timestamp Request Read-only field messages sent.

Interfaces Tab

Use the Interfaces tab to view statistical and configuration information for the SNMP device interfaces and to change the administrative status of interfaces. To use the Interfaces tab: 1 Select the Interfaces tab. The Properties view changes to show the Interfaces tab. 2 Use the Interfaces tab for your customized needs. Table 62 lists the values for the Interfaces tab. Table 62 Interfaces Tab Value
Field Index AdminStatus Description Specifies a unique value for each interface. Specifies the desired state of the interface. While in the testing state, no operational packets can be passed. Settings Read-only field
n n n

up down testing

Descr

Specifies a textual string containing information about Read-only field the interface. This string should include the name of the manufacturer, the product name and the version of the hardware interface. Specifies the number of inbound packets which were Read-only field chosen to be discarded even though no errors had been detected to prevent their being delivered to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space. Specifies the number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. Read-only field

InDiscards

InErrors

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Interfaces Tab

335

Table 62 Interfaces Tab Value (continued)

Field InNUcastPkts Description Specifies the number of non-unicast (subnetwork-broadcast or subnetwork-multicast) packets delivered to a higher-layer protocol. Specifies the total number of octets received on the interface, including framing characters. Specifies the number of subnetwork-unicast packets delivered to a higher-layer protocol. Specifies the number of packets received via the interface which were discarded because of an unknown or unsupported protocol. Settings Read-only field

InOctets InUcastPkts InUnknownProtos

Read-only field Read-only field Read-only field

LastChange

Read-only field Specifies the value of sysUpTime at the time the interface entered its current operational state. A value of zero indicates that the current state was entered prior to the last re-initialization of the local network management subsystem. Specifies the size of the largest datagram which can Read-only field be sent/received on the interface, specified in octets. For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface. Specifies the current operational state of the interface. The testing state indicates that no operational packets can be passed. Read-only field

Mtu

OperStatus

OutDiscards

Read-only field Specifies the number of outbound packets which were discarded even though no errors were detected that prevented their transmission. One possible reason for discarding such a packet could be to free up buffer space. Specifies the number of outbound packets that could Read-only field not be transmitted because of errors. Specifies the total number of packets that higher level Read-only field protocols requested be transmitted to a non-unicast (a subnetwork-broadcast or subnetwork-multicast) address, including those that were discarded or not sent. Specifies the total number of octets transmitted out of Read-only field the interface, including framing characters. Specifies the length, in number of packets, of the output packet queue. Read-only field

OutErrors OutNUcastPkts

OutOctets OutQLen OutUcastPkts

Specifies the total number of packets that higher level Read-only field protocols requested be transmitted to a subnetwork-unicast address, including those that were discarded or not sent. Specifies the interface's address at the protocol layer Read-only field immediately `below' the network layer in the protocol stack. A value of zero indicates that the interface does not have an address at that layer (such as a serial line). Read-only field Refers to MIB definitions specific to the particular media being used to realize the interface. For example, if the interface is realized by an ethernet, then the value of this object refers to a document defining objects specific to ethernet. If this information is not present, its value should be set to the OBJECT IDENTIFIER {0 0}.
Common Element Manager User Guide

PhysAddress

Specific

Part Number D4000-006 Rev A1 January 2011

336

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

Table 62 Interfaces Tab Value (continued)

Field Speed Description Settings

Estimates the interface's current bandwidth in bits per Read-only field second. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. Specifies the type of interface, distinguished Read-only field according to the physical/link protocol(s) immediately `below' the network layer in the protocol stack.

Type

3 To edit a property on the tab, double-click it and select the desired setting. 4 To save the changes, click Save All.

IP Tab

Use the IP tab to view statistical information and to configure IP datagram information for the SNMP device. To use the IP tab: 1 Select the IP tab. The Properties view changes to show the IP tab. 2 Use the IP tab for your customized needs. Table 63 lists the values for the IP tab. Table 63 IP Tab Values
Field DefaultTTL Description Specifies the default value inserted into the Time-To-Live (TTL) field of the IP header of datagrams originated at this device, whenever a TTL value is not supplied by the transport layer protocol. Specifies the number of input datagrams received where an attempt was made to find a route to forward them to their final destination. If the device does not act as an IP gateway, this counter only includes those packets which were successfully Source-Routed via the device. Specifies whether the device is acting as an IP gateway and forwarding datagrams not addressed to it. IP gateways forward datagrams while IP hosts do not (except those datagrams source-routed via the host). FragCreates Specifies the number of IP datagram Read-only field fragments that have been generated as a result of fragmentation at this device. Settings integer Default 255

ForwDatagrams

Read-only field

Forwarding

n n

forwarding not-forwarding

***forward ing

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

IP Tab

337

Table 63 IP Tab Values (continued)

Field FragFails Description Settings Default -

Specifies the number of IP datagrams that Read-only field have been discarded because they needed to be fragmented at this entity but could not be, e.g., because their Don't Fragment flag was set. Specifies the number of IP datagrams that Read-only field have been successfully fragmented at this device. Specifies the number of input datagrams Read-only field discarded because the IP address in their IP header's destination field was not a valid address for this device. This count includes invalid addresses and addresses of unsupported IP classes. If the device is not an IP gateway and do not forward datagrams, this counter includes datagrams discarded because the destination address was not a local address.

FragOKs

InAddrErrors

InDelivers

Specifies the total number of input datagrams successfully delivered to IP user-protocols, including ICMP.

Read-only field

InDiscards

Read-only field Specifies the number of input IP datagrams with no problems but that were still discarded (e.g., for lack of buffer space). This counter does not include any datagrams discarded while awaiting re-assembly. Specifies the number of input datagrams discarded due to errors in their IP headers, including bad checksums, version number mismatch, other format errors, time-to-live exceeded, and errors discovered in processing their IP options. Specifies the total number of input datagrams received from interfaces, including those received in error. Read-only field

InHdrErrors

InReceives

Read-only field

InUnknownProtos

Specifies the number of locally-addressed Read-only field datagrams successfully received but discarded because of an unknown or unsupported protocol. Read-only field Specifies the number of output IP datagrams with no problems but that were still discarded (e.g., for lack of buffer space). Note that this counter would include datagrams counted in ipForwDatagrams if any such packets met this criteria.

OutDiscards

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

338

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

Table 63 IP Tab Values (continued)

Field OutNoRoutes Description Settings Default -

Read-only field Specifies the number of IP datagrams discarded because no route could be found to transmit them to their destination. This counter includes any packets counted in ipForwDatagrams which meet this `no-route' criteria. It also includes any datagrams which a host cannot route because all of its default gateways are down. Specifies the total number of IP datagrams which local IP user-protocols (including ICMP) supplied to IP in requests for transmission. This counter does not include any datagrams counted in ipForwDatagrams. Specifies the number of failures detected by the IP re-assembly algorithm. This is not a count of discarded IP fragments since some algorithms can lose track of the number of fragments by combining them as they are received. Specifies the number of IP datagrams successfully re-assembled. Read-only field

OutRequests

ReasmFails

Read-only field

ReasmOKs ReasmReqds

Read-only field

Specifies the number of IP fragments Read-only field received which needed to be reassembled at this device. Read-only field Specifies the maximum number of seconds received fragments are held while they await reassembly at the device. Specifies the number of routing entries discarded, including valid ones. One possible reason for discarding a valid entry is to free buffer space for other routing entries. Read-only field

ReasmTimeout

RoutingDiscards

3 To edit a property on the tab, double-click it and select the desired setting. 4 To save the changes, click Save All.

NetToMedia Table Tab

Use the NetToMedia tab to view and configure mapping information between network and physical media. To use the NetToMedia Table tab: 1 Select the NetToMedia Table tab. The Properties view changes to show the NetToMedia Table tab. 2 Use the NetToMedia Table tab for your customized needs.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

Routes Tab

339

Table 64 lists the values for the NetToMedia Table tab. Table 64 NetToMedia Table Tab Values
Field IfIndex NetAddress Description Specifies the interface for which information is displayed. Specifies the IP address corresponding to the media-dependent `physical' address. Specifies the media-dependent physical address. Specifies the type of mapping used to associate interfaces to devices. Settings Read-only field Read-only field Default -

PhysAddress Type

Read-only field
n n

dynamic

other invalid-disassociates the interface from its mapped device. dynamic static

n n

3 To edit a property on the tab, double-click it and select the desired setting. 4 To save the changes, click Save All.

Routes Tab

Use the Routes tab to add, modify, view, and delete routing entries in the SNMP device routing table. To use the Routes tab: 1 Select the Routes tab. The Properties view changes to show the Routes tab. 2 To add a route, click Add. Figure 217 shows the Add Row to Table dialog box. Figure 217 Routes Add Row to Table Dialog Box

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

340

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

3 Add information to the Routes tab using the Add row to table dialog box. Table 65 lists the values for the Routes tab. Table 65 Routes Add Row to Table Dialog Box Values
Field Dest Description Settings

xxx.xxx.xxx.xxx Specifies the destination IP address of this route. An entry with a value of 0.0.0.0 is considered a default route. Multiple routes to a single destination can appear in the table, but access to such multiple entries is dependent on the table-access mechanisms defined by the network management protocol in use. Specifies the number of seconds since this route was last updated or otherwise determined to be correct. Specifies the index value which uniquely identifies the local interface through which the next hop of this route should be reached. Specifies the subnet mask for the route. For those systems that do not support arbitrary subnet masks, an agent constructs the value of the mask by determining whether the value of the corresponding destination field belongs to a class A, B, or C network, and then using one of the following generic masks:
n n n

Age IfIndex

integer integer

Mask

xxx.xxx.xxx.xxx

255.0.0.0 class A 255.255.0.0 class B 255.255.255.0 class C

If the value of the destination field is 0.0.0.0 (a default route), then the mask value is also 0.0.0.0. All IP routing subsystems implicitly use this mechanism. Metric1 Specifies the primary routing metric for this route. The integer semantics of this metric are determined by the routing-protocol specified in the route's proto field. If this metric is not used, its value should be set to -1. Specifies the alternate routing metric for this route. The integer semantics of this metric are determined by the routing-protocol specified in the route's proto field. If this metric is not used, its value should be set to -1. Specifies the alternate routing metric for this route. The integer semantics of this metric are determined by the routing-protocol specified in the route's proto field. If this metric is not used, its value should be set to -1. Specifies the alternate routing metric for this route. The integer semantics of this metric are determined by the routing-protocol specified in the route's proto field. If this metric is not used, its value should be set to -1. Specifies the alternate routing metric for this route. The integer semantics of this metric are determined by the routing-protocol specified in the route's proto field. If this metric is not used, its value should be set to -1. Specifies the IP address of the next hop of this route. xxx.xxx.xxx.xxx

Metric2

Metric3

Metric4

Metric5

NextHop

4 Click OK.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

SNMP Tab

341

The route added appears as an entry on the Routes tab, with the following additional self-generated values: Table 66 Routes Tab Self-Generated Values
Field Info Description Settings

Read-only field Refers to MIB definitions specific to the particular routing protocol which is responsible for this route, as determined by the value specified in the route's proto field. If this information is not present, its value should be set to the OBJECT IDENTIFIER {0 0}.

Proto

Specifies the routing mechanism via which this route Read-only field was learned. Inclusion of values for gateway routing protocols is not intended to imply that hosts should support those protocols. Specifies the type of route. The values direct and indirect refer to the notion of direct and indirect routing in the IP architecture. Setting this value to invalid disassociates the corresponding route in the routing table.
n n n n

Type

other invalid direct indirect

5 To edit a property on the tab, double-click it and select the desired setting. 6 To save the changes, click Save All.

SNMP Tab

Use the SNMP tab to view SNMP statistical information and to enable or disable authentication-failure traps on the SNMP device. To use the SNMP tab: 1 Select the SNMP tab. The Properties view changes to show the SNMP tab. 2 Use the SNMP tab for your customized needs. Table 67 lists the values for the SNMP tab. Table 67 SNMP Tab Values
Field EnableAuthenTraps Description Enables or disables generating authentication-failure traps by the SNMP Agent. This value overrides any configuration information; as such, it provides a means whereby all authentication-failure traps may be disabled. NOTE: It is strongly recommended that this value be saved to NVRAM so that it remains constant between reinitializations of the network management system. InASNParseErrs Specifies the total number of ASN.1 or BER errors encountered by the SNMP protocol entity when decoding received SNMP messages. Read-only field Settings
n n

enabled disabled

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

342

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

Table 67 SNMP Tab Values (continued)

Field InBadCommunity Names InBadCommunity Uses Description Specifies the total number of SNMP messages delivered to the SNMP protocol entity using an unknown SNMP community name. Specifies the total number of SNMP messages delivered to the SNMP protocol entity which represented an SNMP operation not allowed by the SNMP community named in the message. Settings Read-only field

Read-only field

InBadValues

Specifies the total number of SNMP PDUs delivered Read-only field to the SNMP protocol entity with a value of `badValue' in the error-status field. Specifies the total number of SNMP messages delivered to the SNMP protocol entity for an unsupported SNMP version. Read-only field

InBadVersions

InGenErrs

Specifies the total number of SNMP PDUs delivered Read-only field to the SNMP protocol entity with a value of `genErr' in the error-status field. Specifies the total number of SNMP Get-Next PDUs accepted and processed by the SNMP protocol entity. Specifies the total number of SNMP Get-Request PDUs accepted and processed by the SNMP protocol entity. Specifies the total number of SNMP Get-Response PDUs accepted and processed by the SNMP protocol entity. Read-only field

InGetNexts

InGetRequests

Read-only field

InGetResponses

Read-only field

InNoSuchNames

Specifies the total number of SNMP PDUs delivered Read-only field to the SNMP protocol entity with a value of `noSuchName' in the error-status field. Specifies the total number of messages delivered to the SNMP entity from the transport service. Read-only field

InPkts InReadOnlys

Specifies the total number of valid SNMP PDUs Read-only field delivered to the SNMP protocol entity with a value of `readOnly' in the error-status field. It is a protocol error to generate an SNMP PDU which contains the value `readOnly' in the error-status field. This field is provided only as a means of detecting incorrect implementations of SNMP.

InSetRequests

Specifies the total number of SNMP Set-Request PDUs which have been accepted and processed by the SNMP protocol entity.

Read-only field

InTooBigs

Specifies the total number of SNMP PDUs delivered Read-only field to the SNMP protocol entity with a value of `tooBig' in the error-status field. Specifies the total number of MIB objects Read-only field successfully retrieved by the SNMP protocol entity as the result of receiving valid SNMP Get-Request and Get-Next PDUs. Specifies the total number of MIB objects successfully altered by the SNMP protocol entity as the result of receiving valid SNMP Set-Request PDUs. Read-only field

InTotalReqVars

InTotalSetVars

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

SNMP Options Tab

343

Table 67 SNMP Tab Values (continued)

Field InTraps Description Specifies the total number of SNMP Trap PDUs accepted and processed by the SNMP protocol entity. Settings Read-only field

OutBadValues

Specifies the total number of SNMP PDUs generated Read-only field by the SNMP protocol entity with a value of `badValue' in the error-status field. Specifies the total number of SNMP PDUs generated Read-only field by the SNMP protocol entity with a value of `genErr' in the error-status field. The total number of SNMP Get-Next PDUs generated by the SNMP protocol entity. Specifies the total number of SNMP Get-Request PDUs generated by the SNMP protocol entity. Specifies the total number of SNMP Get-Response PDUs generated by the SNMP protocol entity. Read-only field Read-only field Read-only field

OutGenErrs

OutGetNexts OutGetRequests OutGetResponses OutNoSuchNames

Specifies the total number of SNMP PDUs generated Read-only field by the SNMP protocol entity with a value of `noSuchName' in the error-status field. Specifies the total number of SNMP messages passed from the SNMP protocol entity to the transport service. Specifies the total number of SNMP Set-Request PDUs generated by the SNMP protocol entity. Read-only field

OutPkts

OutSetRequests OutTooBigs

Read-only field

Specifies the total number of SNMP PDUs generated Read-only field by the SNMP protocol entity with a value of `tooBig' in the error-status field. Specifies the total number of SNMP Trap PDUs generated by the SNMP protocol entity. Read-only field

OutTraps

3 To edit a property on the tab, double-click it and select the desired setting. 4 To save the changes, click Save All.

SNMP Options Tab

Use the SNMP Options tab to configure SNMP properties used to communicate with the device. To use the SNMP Options tab: 1 Select the SNMP Options tab. The Properties view changes to show the SNMP Options tab. 2 Use the SNMP Options tab for your customized needs.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

344

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

Table 68 lists the values for the SNMP Options tab. Table 68 SNMP Options Tab Values
Field Maximum PDU Size Description Settings Default 10

integer Specifies the maximum number of variables to put in a single SNMP request. NOTE: Some SNMP agents have problems when requesting more than one variable binding in one PDU and may respond with SNMP errors. ("not supported" appears in the CEM GUI). If this is the case, set this field to 1. If this resolves the problem, you may be able to increase the Maximum PDU Size larger than 1. The more variables in each SNMP request, the more information CEM can transmit and receive, and the faster the communication with the element will appear. NOTE: You can also provision the default maximum PDU size for the discovery of all SNMP devices. For more information, refer to Provisioning the Default Maximum PDU Size for SNMP Device Discovery.

Protocol Version Specifies the SNMP protocol version to use.

v1 v2c v3 alphanumeric string

v1

Read Community Retrys

Specifies the SNMP community for all GET operations. Applies only to SNMP v1 and v2c.

default string is specific to SNMP device 0

Specifies the number of times an SNMP integer operation will be tried before generating an error. Specifies the SNMP timeout amount in seconds. integer

Timeout (sec)

1 default string is specific to SNMP device

Write Community Specifies the SNMP community for all SET alphanumeric string operations. Applies only to SNMP v1 and v2c.

3 To edit a property on the tab, double-click it and select the desired setting. 4 To save the changes, click Save All.

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

SNMP Statistics Tab

345

SNMP Statistics Tab

The SNMP Statistics tab shows statistical information related to SNMP performance on the SNMP device. You can also reset SNMP statistics from this tab. To use the SNMP Statistics tab: 1 Select the SNMP Statistics tab. The Properties view changes to show the SNMP Statistics tab. 2 Use the SNMP Statistics tab for your customized needs. Table 69 lists the values for the SNMP Statistics tab. Table 69 SNMP Statistics Tab Values
Field CurrentMaxPDU Description Current maximum PDU size being used. This may vary as CEM maintains maximum SNMP throughput. Current SNMP timeout value (in milliseconds) being used. This may vary as CEM maintains maximum SNMP throughput. Settings Read-only field

Current Timeout (ms)

Read-only field

Requests accumulated response time (ms) Requests average response time (ms) Requests standard deviation (ms) Samples

Time elapsed (in milliseconds) to receive SNMP Read-only field responses that did not timeout. Average response time (in milliseconds) of all successful SNMP requests. Standard deviation in response time (in milliseconds) of all successful SNMP requests. Total number of SNMP requests, shown in the sliding history window, that CEM made to the device. Setting this to "reset" causes all CEM SNMP statistics to be reset. After resetting the statistics, you must the GUI. Total number of SNMP variables transported in PDUs without timing out. Average response time (in milliseconds) to process an SNMP variable binding. Read-only field Read-only field Read-only field

Statistics

n n

active reset

Variables Variables average response time (ms)

Read-only field Read-only field

System Tab

Use the System tab to set and view system parameters for the SNMP device. To use the System tab: 1 Select the System tab. The Properties view changes to show the System tab. 2 Use the System tab for your customized needs.

Part Number D4000-006 Rev A1 January 2011

Common Element Manager User Guide

346

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

Table 70 lists the values for the System tab. Table 70 System Tab Values
Field Contact Description Description Specifies the contact person for this managed node with information on how to contact this person. Specifies a textual description of the device. This value should include the full name and version identification of the system's hardware type, software operating-system, and networking software. This field can only contain printable ASCII characters. Settings string Read-only field

Location Name

Specifies the physical location of this node (e.g., `telephone string closet, 3rd floor'). Specifies an administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain name. Indicates the vendor's identification of the network management subsystem. Indicates the set of services that this entity offers. Time (to the hundredth of a second) since the network management portion of the system was last re-initialized. string

Object ID Services Uptime

Read-only field Read-only field Read-only field

3 To edit a property on the tab, double-click it and select the desired setting. 4 To save the changes, click Save All.

TCP Tab

Use the TCP tab to view statistical information for TCP connections on the SNMP device. To use the TCP tab: 1 Select the TCP tab. The Properties view changes to show the TCP tab. 2 Use the TCP tab for your customized needs. Table 71 lists the values for the TCP tab. Table 71 TCP Tab Values
Field ActiveOpens Description Settings

Read-only field Specifies the number of times TCP connections made a direct transition to the SYN-SENT state from the CLOSED state. Read-only field Specifies the number of times TCP connections made a direct transition to the CLOSED state from either the SYN-SENT state or the SYN-RCVD state plus the number of times TCP connections made a direct transition to the LISTEN state from the SYN-RCVD state. Specifies the number of TCP connections for which the current state is either ESTABLISHED or CLOSE- WAIT. Read-only field

AttemptFails

CurrEstab

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

TFTP Options Tab

347

Table 71 TCP Tab Values (continued)

Field EstabResets Description Specifies the number of times TCP connections made a direct transition to the CLOSED state from either the ESTABLISHED state or the CLOSE-WAIT state. Specifies the total number of segments received in error. Specifies the total number of segments received, including those received in error. This count includes segments received on currently established connections. Specifies the maximum number of TCP connections the device can support. If the maximum number of connections is dynamic, this object should contain the value -1. Specifies the number of TCP segments sent containing the RST flag. Specifies the total number of segments sent, including those on current connections but excluding those containing only retransmitted octets. Settings Read-only field

InErrs InSegs

Read-only field Read-only field

MaxConn

Read-only field

OutRsts OutSegs

Read-only field Read-only field

PassiveOpens

Specifies the number of times TCP connections made a Read-only field direct transition to the SYN-RCVD state from the LISTEN state. Specifies the total number of segments retransmitted. Specifies the algorithm used to determine the timeout value used for retransmitting unacknowledged octets. Read-only field Read-only field

RetransSegs RtoAlgorithm RtoMax

Specifies the maximum value permitted by a TCP Read-only field implementation for the retransmission timeout, measured in milliseconds. Read-only field Specifies the minimum value permitted by a TCP implementation for the retransmission timeout, measured in milliseconds.

RtoMin

TFTP Options Tab

Use the TFTP tab to configure Trivial File Transfer Protocol (TFTP) options for the SNMP device. To use the TFTP Options tab: 1 Select the TFTP Options tab. The Properties view changes to show the TFTP Options tab. 2 Use the TFTP Options tab for your customized needs. Table 72 lists the values for the TFTP Options tab. Table 72 TFTP Options Tab Values
Field Retrys Timeout (sec) Description Specifies the number of times an TFTP operation will be tried before generating an error. Specifies the TFTP timeout interval in seconds. Settings integer integer Default 10 5

3 To edit a property on the tab, double-click it and select the desired setting. 4 To save the changes, click Save All.
Part Number D4000-006 Rev A1 January 2011 Common Element Manager User Guide

348

APPENDIX B: SNMP DEVICE COMMON CONFIGURATION TABS

UDP Tab

Use the UDP tab to view statistical information for UDP datagrams sent and received by the SNMP device. To use the UDP tab: 1 Select the UDP tab. The Properties view changes to show the UDP tab. 2 Use the UDP tab for your customized needs. Table 73 lists the values for the UDP tab. Table 73 UDP Tab Values
Field InDatagrams InErrors Description Specifies the total number of UDP datagrams delivered to UDP users. Settings Read-only field

Specifies the number of received UDP datagrams that Read-only field could not be delivered for reasons other than the lack of an application at the destination port. Specifies the total number of received UDP datagrams Read-only field for which there was no application at the destination port. Specifies the total number of UDP datagrams sent from this device. Read-only field

NoPorts

OutDatagrams

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

INDEX

A
active state 46 Adding Data Collection Folder 232 Data Collector 233 Scheduled Event Data Collector 233 Specific Field Data Collector 233 Advanced Configuration Manager 267 Applying a Configuration Template 272 Assigning a Configuration Template 272 Deleting a Configuration Template 274 Editing a Configuration Template 273 Exporting Configuration Templates 273 Generating a Template Audit Report 274 Importing a Configuration Template 273 Overview 267 About Configuration Templates 268 advisor 74 advisor window 35 alarm counts GUI 43 alarm events 42 AVG 247

B
background table loading 75 bays and racks 92 benefits, CEM 28 broadcasting messages to users 154

C
CDR Server 283 Configuring 288 Attribute Retention 289 Filters 292 NAS Secret 289 override.properties File 288 RADIUS Client 293 Creating a CDR Analysis Report 301 Exporting CDRs 300 Installing 287 Managing 294 Overview 283 Performing a CDR Server Query 296 Performing a CDR Watch 299 Plotting a CDR 297 Purging CDRs 300 CEM accessing through a firewall 56 benefits 28 default ports 55 definition of class 152 event processing 38
Part Number D4000-006 Rev A1 January 2011

features 27 Find command 169 hardware requirements 49 help options 34 installing 59 NIC requirements 50 overview 27 platform requirements 50 pre-installation 49 printing options 38 read and write community strings 105 software components 29 types of properties 164 upgrading 214 CEM CLI client displaying CLI client console commands 188 initially starting 71 starting 184 stopping 184 CEM GUI basics 29 customizing the environment 74 initially starting 67 using without a monitor 53 CEM GUI client monitoring memory 187 provisioning default refresh rate 134 starting 184 stopping 184 CEM Notifications 303 Creating a CEM Notification 309 Deleting a Notification 314 Editing a CEM Notification 314 Installing 308 Overview 303 CEM Notification Creation 303 Notification Methods 303 Notification Properties and Relationships 307 CEM server displaying server console commands 187 monitoring memory 186 monitoring performance 185 multi-homed support 66 multiple packages 65 relicensing 213 silent installation 61 starting 181 starting as a daemon 181 stopping 183 using daemon-specific console commands 326 CEM server console commands 325 CEMSetup.jar file 60 changing access rights users 192 chat utility 154 Choose Ending Date Window 248

Choose Starting Date Window 248 class, definition in CEM 152 Clear Value 236 clearing event records 199 clearing events automatically 43 clearing traps automatically 43 CLI client console commands 327 client information 141 client.properties mimic.refresh field 134 rmi.binding 137 showNoSuchName field 134 Collect Now Command 254 common configuration tabs for SNMP devices 329 copying and pasting SNMP values 168 copyright, viewing 140 core events 40 customer service contacting 23

D
daily audit log 175 Data Collection Filters 236 Data Collection Folder 232 Data Collector 233, 235 Data Collector Information 241 Data Collector Settings 256 Data Collector Targets 235 Data Collector Wizard 235 Data Collectors 255, 257 Data Collectors Folder 240, 250 database separate 45 synchronized 46 database compaction 219 database options 72 embedded 121 external 123 database, shared 44 Deleting Data Collectors 257 deleting logical view 194 SNMP devices and folders 194 users 194 device folders creating 91 deleting 194 Device Learning Wizard 277 Importing MIB Files 281 Installing 280 Learning a New Device 280 Overview 277 Process Summary 278 Additional Process Information 278 device properties 164 device visual 155
Common Element Manager User Guide

350

Disabling Data Collectors 255 discovering multiple SNMP devices 93 single SNMP devices 98 disk size 133 displaying CLI client console commands 188 server console commands 187

E
Editing Data Collector Settings 256 elements collapsing 145 definition 31 executing commands for multiple elements 146 expanding 145 monitoring the status of GUI elements 148 organizing 147 renaming 190 reserving and unreserving 190 embedded databases definition 121 features and benefits 121 forcing a database compaction on server startup 219 limitations 122 provisioning 122 Enable Data Collector Window 240 Enable Repeating Interval 239 Enabling Data Collectors 255 Establishing Purge Policies 252 Event Colors tab 78 event flow diagram 39 event forward, filtering 204 event Log, filtering 204 event logging 38 restarting 200 stopping 199 event processing 38 event records acknowledging 208 clearing 199 deleting 209 refreshing 207 selecting multiple records 202 sorting 201 viewing 200 event severity, configuring 206 event viewer 43, 202, 207 events, core 40 executing commands for multiple elements 146 expanding and collapsing elements 145 explorer tree, printing 181 Explorer view 31 toggling between the Explorer and List view 142 Exported Data 252 Exporting Data to CSV 249 Data to TSV 250
Common Element Manager User Guide

exporting events 207 SNMP devices 105 users 89 external databases definition 123 deploying on a CEM server 124 deploying on a dedicated server 124 features and benefits 123 multiple user access 128 MySQL 126 Oracle 124 running multiple external databases on a single database server 128 tools and options 128

users 89 Indicating Clear Value 236 Trigger and Clear Levels 236 Trigger Value 236 installation and initial setup 59 installing multiple packages 65 inventory reports 172

K
keys, license 55

L
Labeling Data Collector 235 left-hand pane 32 Properties view 32 Related view 32 license keys 55 Linux platform-related issues 54 resolving remote client login problems 54 List view 31 toggling between the List and Explorer view 142 load table 75 log full action 117 log in as another user 188 logical logs 196 monitoring the availability 199 provisioning the log full action 117 provisioning the size 117 purging log events 197 logical views 32 creating 83 deleting 194 logout, forcing 193 look and feel 75

F
features, CEM 27 Filter Tab 241 filtering event forwarding 204 event log 204 Find command in CEM 169 firewall 56 forcing a logout 193 Forcing Data Collection 254 Forecasting 249 formats for displaying and editing numeric values in CEM 159 FTP logs 177

G
GUI basics 29 GUI environment 74 GUI information 141

H
hardware requirements, CEM 49 help options 34 advisor window 35 Help menu 34 online help 37 tool tips 35 Historical Data 246, 247 Historical Data Export Window 251 Historical Data Window 247 HP OpenView installation issues 56 manually integrating 131 provisioning CEM to collect SNMP traps 132 removing integration 218 starting the CEM GUI client 184 HP-UX platform-related issues 53 resolving out of memory errors 54

M
Map tab 107 map views 32 MAX 248 maximum PDU size 135, 136 memory size 133 menu bar 30 MIB browser 157 MIN 247 monitor scope 163 Monitor State utility 151 monitoring CEM GUI memory 187 CEM server memory 186 numeric properties 161 multi-homed server support 66 multiple packages 65 multiple SNMP devices 93 MySQL databases 126

I
Identification Tab 242 importing SDL files for device upgrades 218 SNMP devices 105

N
NAS 289 NIC requirements 50 No Historical Data Window 247
Part Number D4000-006 Rev A1 January 2011

351

node, definition 31 non-supported MIB objects, displaying 134 numeric properties, monitoring 161 numeric values, displaying and editing in various formats 159

O
obtaining license keys 55 online help 37 operating system requirements 50 Oracle external databases 124 organizing elements 147

P
PDU size 135, 136 Performance and Capacity Manager 229 Installing 230 Overview 229 PCM Data Collection 231 Performance Monitor 315 Adding a Gauge to a Profile 320 Ceating a Performance Monitor Profile 317 Editing a Profile 322 Exporting a Profile 321 Importing a Profile 321 Installing 316 Launching a Profile 320 Overview 315 Performance Profiles 315 platform requirements 50 Poll Rate 162 polling operational state 119 pop-up menus 33 ports provisioning the default ports 136 TCP/IP and UDP 55 power failures 221 pre-installation 49 printer page setup 82 printing options 38 printing, CEM GUI explorer tree 181 product overview 27 properties simple 165 tabular 166 Properties view 32 toggling between the Properties and Related view 144 Purge Policies 252 Purge Policy Tab 252 purging log events 197

selecting a database configuration 44 separate databases 45 shared database 44 startup state 47 state transitions 47 synchronizing files 130 traps 48 upgrading servers 217 Refresh button 223 related documentation 22 Related view 32 toggling between the Related and Properties view 144 relicensing the CEM server 213 renaming elements 190 reports, inventory 172 reserving elements 190 Resetting Counters 257 resetting user passwords 191 restarting event logging 200 RFC MIBs 329 right-hand pane 31 Explorer view 31 List view 31 logical views 32 root folders 32 root view removing 193 users 87 runCLIClient command 71 runServer command 63, 219 optional parameters 63 runServerMonitor 185

S
Save Graph Data Window 250 Schedule Repeat Until Time 239 Schedule Tab 243 Scheduled Event Data Collector 233 Selecting Data Collector Targets 235 server console logs 179 server monitor 185 server redundancy 128 server.properties ClientInterface field 66 ManagementInterface field 67 MySQL DB section 127 Oracle Server section 125 SNMP Trap Listening section 132 SNMP.maxpdu field 135, 136 stateUpdate field 119 TCP/IP and UPD port fields 136 setting user expiration date and time 90 shutdown state 46 silently installing the CEM server 61 single SNMP devices 98 SNMP devices common configuration tabs 329 definition 34 deleting 194 discovering multiple 93 discovering single 98 exporting and importing 105 identification 104 provisioning 91

rediscovering 195 SNMP trap forwarding 132 SNMP version, changing 196 software components 29 software version viewing 140 Solaris copying and pasting across applications 53 platform-related issues 52 running CEM in a single user environment 52 running the CEM server from root accounts 52 setting read-write permissions 52 UNIX filenames 53 using static IP addresses 53 using the CEM GUI client without a monitor 53 Specific Field Data Collector 233 Specifying Data Collection Filters 236 Start and Stop Times 238 standby state 46 Start and Stop Times 238 starting and stopping software components 181 state administrative 148 operational 148 State Update command 153 usage 148 State ICONs tab 75 State Tab 244 status, monitoring for GUI elements 148 stopping event logging 199 SUM 247 synchronized databases 46 syslog Source Identification 42

T
table data loading 116 table loading 75 telnet session 173 SSH support 173 Threshold Logs 238 Threshold Tab 245 timeout state 46 tool tips 35 toolbar 31 trap forwarding 132 Trap Source Identification 42 Trigger and Clear Levels 236 Trigger Value 236

R
racks and bays 92 read and write community strings 105 recovering from power failures 221 rediscovering SNMP devices 195 redundancy 128 CEM core and package version 129 client switchover 48 consistancy check 48 failsafe shutdown 48 manual switchover 131 perceived states 46 properties 129
Part Number D4000-006 Rev A1 January 2011

U
uninstalling CEM 209 unknown state 46 unreserving elements 190 unsupported SNMP devices 222 upgrading CEM 214, 217 user folder, creating 86 users assigning a root view 87 broadcasting messages 154 changing access rights 192
Common Element Manager User Guide

352

creating 86 deleting 194 expiration date and time 90 exporting and importing 89 forcing a logout 193 provisioning 83 removing a root view 193 resetting passwords 191 using CEM GUI client without a monitor 53

V
Value-Added Packages 227 Applying a Configuration Template 272 Assigning a Configuration Template 272 Creating a Configuration Template 272 Exporting Configuration Templates 273 Importing a Configuration Template 273 Installing 271 Overview 267 Performance Capacity Manager 229 Installing 230 Overview 229 Working with Data Collection 231 Working with Scheduled Reports 257 Viewing Data Collector Information 241 Historical Data 246 viewing client information 141 copyright information 140 daily audit log 175 event records 200 FTP logs 177 GUI information 141 server console logs 179 SNMP device identification 104 software version 140 viewing a device visual (mimic) 155

W
web browser interface 174 Windows platform-related issues 53 using Windows filenames 53

Common Element Manager User Guide

Part Number D4000-006 Rev A1 January 2011

NewNet Communication Technologies, LLC 2 Trap Falls Road, Suite 504, Shelton, CT 06484 Tel. +1 203.926.0049 Fax. +1 203.647.0580

Chicago NewNet Communication Technologies Arlington Ridge Office Center 3223 N. Wilke Road Arlington Heights, IL 60004 +1 847.253.9200

India NewNet Techno Engineering India Pvt Ltd G001 Ground Floor, Sigma Soft Tech Park Ramagondanhali Varthur Hobli Bangalore 560066 +91 80 41528312

Romania NewNet Communication Technologies str. Dr. lacob Felix nr. 70 Sector 1 Bucharest Romania

www.newnet.com Part Number D4000-006 Rev A1