Cheetah 5.2 PDF

TAHTM
TECHNOLOGIES
CheetahXD
Broadban d Assurance Platfor m
Users Guide
June 2014
Document # 050-0097
Rev Q
CheetahXD is a trademark of Cheetah Technologies LP

DOCSIS is a registered trademark of Cable Television Laboratories, Inc. Oracle is a registered
trademark of Oracle Corporation and/or its affiliates.
Microsoft Excel is a registered trademark of Microsoft Corporation.

Adobe Acrobat is a registered trademark of Adobe Systems, Inc.
All other trademarks and registered trademarks are the property of their respective owners.
The copyright and trade secret laws of the United States and other countries protect this material. It may
not be reproduced, distributed, or altered in any fashion by any entity, including other Cheetah
Technologies LP business units or divisions, without the expressed written consent of Cheetah
Technologies LP.
This document contains proprietary information that shall be distributed or routed only within Cheetah
Technologies LP and to its authorized clients, except with written permission from Cheetah. Information
contained within this document is subject to change without notice. The appearance of some of the
graphics in the examples presented in this manual may vary slightly to the actual GUI in the software
application.
Document Number: 050-0097 Rev Q (June 2014)
2014 Cheetah Technologies L.P. All Rights Reserved. Proprietary Cheetah Technologies L.P.
and Authorized Clients Only
Table of Contents
1
Preface .......................................................................................................................................... 1
1.1
Purpose and Scope of this Guide .................................................................................................................1
1.2
Related Documentation ...............................................................................................................................1
1.3
Conventions .................................................................................................................................................1
1.3.1
Typographical Conventions .....................................................................................................................1
1.3.2
Keyboard and Menu Conventions ...........................................................................................................2
1.3.3
Symbol Descriptions ................................................................................................................................2
1.3.4
Keyboard Internationalization .................................................................................................................2
1.4
Cheetah Technical Support ..........................................................................................................................2
Introduction .................................................................................................................................. 3
2.1
Industrial Database ......................................................................................................................................4
2.2
Scalability .....................................................................................................................................................4
2.3
Security.........................................................................................................................................................4
2.4
Transponder Auto Discovery........................................................................................................................4
2.5
Integration with Existing Cheetah Software ................................................................................................4
2.6
Advanced Grouping......................................................................................................................................4
2.7
Advanced Alarm Threshold Configuration ...................................................................................................4
2.8
HMS MIB Extension Support Enhanced Alarm Processing ........................................................................5
2.9
Battery Analyst Module ...............................................................................................................................5
2.10
CheetahXD System Architecture ..................................................................................................................5
2.11
CheetahXD System Deployment ..................................................................................................................6
Starting and Stopping CheetahXD .................................................................................................. 7

3.1
Starting/Restarting CheetahXD on a Solaris Server .....................................................................................7
3.2
Stopping CheetahXD on a Solaris Server ......................................................................................................8
3.3
Starting CheetahXD on a Windows Server ...................................................................................................9
3.4
Stopping CheetahXD on a Windows Server ...............................................................................................11
3.5
Restarting CheetahXD on a Windows Server .............................................................................................13
3.6
Authenticating Users Against an External LDAP Directory.........................................................................13
3.7
Configuring Client Machines for Applet Execution ....................................................................................14
Integrating CheetahXD with Existing Cheetah Systems ................................................................ 16

4.1
How CheetahXD Manages HMS, DOCSIS, and CheetahLight Legacy Devices ............................................16
4.2
How CheetahXD Manages CheetahNet Legacy Devices ............................................................................16
i
Document # 050-0097 Rev P
Page 3i
CheetahXD User Guide
4.3
Integrating CheetahXD with CheetahLight/Cheetah DOCSIS .....................................................................16
4.4
Integrating CheetahXD with CheetahNet...................................................................................................17
4.4.1
Creating a CheetahNet Element in CheetahXD .....................................................................................19
4.4.2
Configuring the CheetahNet Network Element .....................................................................................20
4.4.3
Virtual Headend Controller Installation .................................................................................................22
4.4.4
Disabling the AutoDiscover Feature ......................................................................................................22
4.4.5
Reconfiguring a CheetahNet Headend Controller (HEC) .......................................................................23
4.4.6
Creating an Configuring a Virtual Headend Controller (vHEC) ..............................................................23
4.4.7
Creating Proxies .....................................................................................................................................26
4.4.8
Adding a vHEC to CheetahXDs Autodiscovery Queue .........................................................................26
4.4.9
Discovering HMS Devices.......................................................................................................................27
4.4.10
Starting the vHEC...............................................................................................................................28
4.4.11
Provisioning CheetahNet HMS Devices in CheetahXD ......................................................................28
System Setup .............................................................................................................................. 29

5.1
Login Page ..................................................................................................................................................29
5.2
Domain Options .........................................................................................................................................29
5.3
Collapsed Tree Color ..................................................................................................................................30
5.4
Typical System Setup..................................................................................................................................30
5.5
Security Administration..............................................................................................................................31
5.6
Groups ........................................................................................................................................................31
5.6.1
Creating and Removing Groups .............................................................................................................32
5.6.2
Operations and Permissions ..................................................................................................................33
5.6.3
Modifying Groups ..................................................................................................................................35
5.6.4
Scopes ....................................................................................................................................................36
5.7
Users ..........................................................................................................................................................37
5.7.1
Creating Users........................................................................................................................................37
5.7.2
Modifying Users .....................................................................................................................................39
5.7.3
Deleting Users........................................................................................................................................40
5.7.4
Changing User Status .............................................................................................................................40
5.7.5
Terminating User Sessions.....................................................................................................................41
5.8
Discovery Admin ........................................................................................................................................42
5.8.1
Discovery Configurator ..........................................................................................................................42
5.8.2
Discovery Queue ....................................................................................................................................49
5.8.3
Automatic Template Downloads ...........................................................................................................50
Page 4i
5.9
Alert Filtering and Suppression ..................................................................................................................50
5.10
Alert Filters .................................................................................................................................................50
5.10.1
Filter Rules .........................................................................................................................................51
5.10.2
Device Status in Trees .......................................................................................................................51
5.10.3
To Setup an Alert Filter......................................................................................................................51
5.11
Policy Configuration ...................................................................................................................................52
5.12
JMX ALERT Forward Filtering Northbound SNMP Traps .........................................................................53
5.12.1
Alert Forwarding Process ..................................................................................................................53
5.12.2
Steps to Setup JMX Filtering ..............................................................................................................54
5.12.3
Appendix............................................................................................................................................55
Using the Dashboard ................................................................................................................... 56

6.1
6.1.1
Menu Buttons ........................................................................................................................................57
6.1.2
Modules .................................................................................................................................................59
6.2
KPI Scorecard .............................................................................................................................................65
6.2.1
Main Menu ............................................................................................................................................66
6.2.2
Graph Display Area ................................................................................................................................67
6.2.3
Detail Menu ...........................................................................................................................................67
6.2.4
View Graphs...........................................................................................................................................68
6.2.5
View Detailed Graph Information..........................................................................................................68
6.2.6
Change the Device Tree .........................................................................................................................69
6.2.7
Reset the KPI Scorecard Page ................................................................................................................69
6.3
6.3.1
6.4
Dashboard ..................................................................................................................................................56
Outage Analyst ...........................................................................................................................................69

Configuring the Outage Analyst .............................................................................................................70
Outage Analyst Viewer...............................................................................................................................75
The Tree Viewer .......................................................................................................................... 76

7.1
The Tree Viewer Components....................................................................................................................76
7.1.1
The Tree Control Pane ...........................................................................................................................76
7.1.2
The Primary Pane...................................................................................................................................76
7.1.3
The Properties and View Editing Pane...................................................................................................76
7.1.4
The Log Pane..........................................................................................................................................78
7.1.5
The Tree Viewer Tool Buttons ...............................................................................................................78
7.2
7.2.1
Tree Structure, Tree Types, and Tree Elements .........................................................................................79

The Tree Structure Hierarchy ................................................................................................................80
Page 3
7.2.2
The Native Tree View.............................................................................................................................80
7.2.3
The HFC Tree View .................................................................................................................................80
7.2.4
The IP Tree View ....................................................................................................................................80
7.2.5
Accessing Tree Views via the Side Panel................................................................................................80
7.2.6
The Custom Tree View ...........................................................................................................................81
7.2.7
Tree Status Icons....................................................................................................................................81
7.2.8
Tree View Icons......................................................................................................................................82
7.3
7.3.1
Accessing the Local Device Menus from the Tree .................................................................................84
7.3.2
Finding Resources in the Tree................................................................................................................89
7.3.3
Displaying a SubGroup of Tree Elements .............................................................................................90
7.3.4
Creating New Tree Views.......................................................................................................................90
7.3.5
Creating Network Elements ...................................................................................................................93
7.3.6
Deleting Trees or Network Elements .....................................................................................................95
Network Inventory ...................................................................................................................... 97

8.1
Using the Tree Viewer ................................................................................................................................84
Changing the Network Inventory Display ..................................................................................................99
8.1.1
Changing the Network Inventory Layout ...............................................................................................99
8.1.2
Displaying Network Inventory in Full Screen Mode...............................................................................99
8.2
Managing Devices from the Network Inventory Page .............................................................................100
8.3
Polling/Unpolling Devices ........................................................................................................................101
8.3.1
Normal Polling .....................................................................................................................................101
8.3.2
Lock Polling ..........................................................................................................................................101
8.3.3
High Power Polling ...............................................................................................................................101
8.3.4
Turning Polling On and Off...................................................................................................................101
Provisioning Devices.................................................................................................................. 103

9.1
Configuring and Using Templates ............................................................................................................103
9.1.1
General Template Concepts ................................................................................................................104
9.1.2
Viewing, Modifying, and Creating Templates ......................................................................................105
9.1.3
Applying Templates .............................................................................................................................109
9.2
Power Supply Indexing Serially Connected Supplies .............................................................................111
9.3
Generic I/O Setup.....................................................................................................................................112
9.3.1
Analogs Attribute .................................................................................................................................113
9.3.2
Digitals Attribute..................................................................................................................................114
9.4
Configurable Parameters .........................................................................................................................115
Page 4
9.4.1
Information Tab ...................................................................................................................................115
9.4.2
Property Tab ........................................................................................................................................116
9.4.3
Analog Tab ...........................................................................................................................................117
9.4.4
NonAlarmable Analog Tab ..................................................................................................................118
9.4.5
Multi Tab..............................................................................................................................................118
9.4.6
All Attributes Tab .................................................................................................................................119
9.5
Configuring an Individual Device..............................................................................................................119
9.6
Configuring a Virtual Headend Controller ................................................................................................119
9.7
Configuring the CheetahNet Element ......................................................................................................119
9.8
Using the UserDefined Configuration Fields ...........................................................................................120
10
Fault ViewsNotifier ............................................................................................................. 123
10.1
The Default Notifier Page .........................................................................................................................124
10.2
Alerts ........................................................................................................................................................126
10.3
Events .......................................................................................................................................................126
10.4
Notifier Dashboard...................................................................................................................................126
10.5
Displaying a Full Screen Notifier...............................................................................................................127
10.6
Creating a New Alerts View......................................................................................................................127
10.7
Customizing Views ...................................................................................................................................127
10.7.1
Specifying Fields for Views ..............................................................................................................128
10.7.2
Specifying Filters for Views..............................................................................................................131
10.7.3
Layout Selection ..............................................................................................................................137
10.7.4
Find Alert .........................................................................................................................................138
10.7.5
Sound On/Off for Audible Alarms ...................................................................................................139
10.8
The Notifier Dashboard View ...................................................................................................................140
10.9
Testing the Notifier ..................................................................................................................................145
10.10
Local Context Menu .................................................................................................................................145
10.10.1
Displaying Alert or Event Details .....................................................................................................146
10.10.2
Clearing Alarms ...............................................................................................................................147
10.10.3
Acknowledging Alarms ....................................................................................................................147
10.10.4
Deleting Alarms ...............................................................................................................................147
10.10.5
Launching Data Display for Device in Alarm State ..........................................................................148
10.10.6
Launching Device Config for Device in Alarm State.........................................................................148
10.10.7
Cross Navigation ..............................................................................................................................149
10.10.8
Viewing Alarm Events ......................................................................................................................150
Page 5
10.10.9
Implementing and Clearing Quick Filters ........................................................................................150
10.10.10
Related Alerts (Upstream/Downstream Alerts) ..............................................................................151
10.10.11
Map Alert.........................................................................................................................................152
10.10.12
Custom Extensions ..........................................................................................................................152
10.11
Historical Event Processing ......................................................................................................................154
10.12
Current Alerts/Events Reporting ..............................................................................................................155
11
Fault Views Power Outage Monitoring ................................................................................ 157
11.1
Power Outage Alarm Processing ..............................................................................................................157
11.2
Accessing Power Outage Monitoring .......................................................................................................159
11.3
The Power Outage Monitoring Display ....................................................................................................159
11.4
Customizing the Power Outage Monitoring Application .........................................................................160
11.4.1
Specifying Parameters .....................................................................................................................160
11.4.2
Filtering Alerts .................................................................................................................................163
11.5
Local Context Menu .................................................................................................................................164
11.6
Finding Alerts in the Power Outage Monitor ...........................................................................................164
12
Scheduling Data Collection ..................................................................................................... 165
12.1
Opening the Scheduler.............................................................................................................................165
12.2
Creating a Schedule..................................................................................................................................165
12.2.1
Creating a TemplateBased Schedule ..............................................................................................166
12.2.2
Creating a Device Instance Based Schedule ....................................................................................171
12.3
Cloning a Schedule ...................................................................................................................................176
12.4
Viewing Schedules and Results ................................................................................................................176
13
Displaying Data ...................................................................................................................... 179
13.1
Launching CheetahXD Data Display .........................................................................................................179
13.2
Categories of Displayable Data ................................................................................................................180
13.3
Data Display Options ................................................................................................................................181
13.4
Legacy (CheetahNet) Devices Data Display ..............................................................................................183
14
Testing Power Supplies .......................................................................................................... 185
14.1
Creating Test Groups or Test Regions ......................................................................................................186
14.2
Setting Parameters for the Power Supply ................................................................................................186
14.3
Power Supply PreTests............................................................................................................................186
14.4
Background (Automatic) Power Supply Testing .......................................................................................187
14.4.1
14.5
Creating a Background (Automatic) Power Supply Test..................................................................187
OnDemand Power Supply Testing ..........................................................................................................189
Page 6
14.5.1
Battery Analyst Test ........................................................................................................................190
14.5.2
Inverter Test ....................................................................................................................................194
14.5.3
Deep Drain Test ...............................................................................................................................195
14.5.4
Predictive Test .................................................................................................................................197
14.6
Viewing Background (Automatic) Results for Completed Tests...............................................................199
14.6.1
14.7
Viewing Status, Details and Results of Ondemand Tests ........................................................................200
14.7.1
14.8
15
Viewing Background Testing Power Supply Groupings ...................................................................199
Viewing OnDemand Test Status .....................................................................................................200
Excluding a Power Supply from Testing ...................................................................................................202
Paging .................................................................................................................................... 203
15.1
Setting up Paging......................................................................................................................................203
15.1.1
Specify Modem Information ...........................................................................................................204
15.1.2
Configuring an Alphanumeric Pager................................................................................................205
15.1.3
Configuring Email ...........................................................................................................................206
15.1.4
Creating Technicians .......................................................................................................................207
15.1.5
Viewing, Creating, Deleting Technician Schedules ..........................................................................209
15.2
Activating Technicians..............................................................................................................................210
15.3
Update the Paging Server ........................................................................................................................211
15.4
Edit Technician Information .....................................................................................................................212
15.5
Deleting Technicians ................................................................................................................................212
15.6
Security Permissions ................................................................................................................................212
15.7
Paging Technicians Using Device Groups .................................................................................................213
16
Reports .................................................................................................................................. 215
16.1
Report Output Options ............................................................................................................................215
16.2
Accessing Reports ....................................................................................................................................216
16.3
Device Reports .........................................................................................................................................216
16.3.1
Device Configuration Report ...........................................................................................................216
16.3.2
Device Status Report .......................................................................................................................218
16.3.3
Device Inventory by Type Report ....................................................................................................220
16.3.4
Provisioned Transponders Report ...................................................................................................221
16.3.5
Transponder Firmware Report ........................................................................................................221
16.4
Fault Reports ............................................................................................................................................223
16.4.1
Filtering Fault Report Data ..............................................................................................................223
16.4.2
Alert Report by Category .................................................................................................................223
Page
Page77
16.4.3
Alert Listing Report..........................................................................................................................224
16.4.4
Active Alert Status Report by Device...............................................................................................226
16.4.5
Device Dead Report .........................................................................................................................227
16.4.6
Alert Analysis Report .......................................................................................................................228
16.4.7
Power Supply Alert Report ..............................................................................................................230
16.4.8
Power Outage Summary Report......................................................................................................232
16.4.9
Power Outage Detail Report ...........................................................................................................234
16.5
Performance Reports ...............................................................................................................................236
16.5.1
Battery Analyst Report ....................................................................................................................236
16.5.2
Battery Summary Report.................................................................................................................241
16.5.3
Scheduler Report .............................................................................................................................242
16.5.4
Page Alert OnCall Report................................................................................................................244
16.5.5
Power Supply Testable Report ........................................................................................................245
17
Downloading Firmware .......................................................................................................... 246
17.1
Editing the Configuration File (Optional) .................................................................................................246
17.2
Launch Firmware Download ....................................................................................................................247
17.3
Specify Download Options .......................................................................................................................250
17.3.1
Downloading to Headend Controllers .............................................................................................250
17.3.2
Downloading to HMS (NonDOCSIS) Transponders ........................................................................251
17.3.3
Downloading to DOCSIS Transponders ...........................................................................................253
17.4
Download Status ......................................................................................................................................254
17.5
Download Log File ....................................................................................................................................255
17.6
Downloading Firmware to Individual DOCSIS Transponders or Modules from the Tree View ................255
17.6.1
To Download Firmware to a Transponder or Other Supported Device ..........................................255
17.6.2
To Add Firmware to the Server .......................................................................................................256
17.7
Downloading to Motorola GX2 Chassis Modules....................................................................................256
17.7.1
Setup ...............................................................................................................................................256
17.7.2
Downloading GX2 Module Firmware to One Module....................................................................257
17.7.3
Downloading GX2 Module Firmware to Multiple Modules ...........................................................257
17.7.4
Downloading GX2 Module Firmware to all Like Modules in one or Multiple GX2 Chassis ...........258
17.7.5
Troubleshooting ..............................................................................................................................258
18
Using the SNMP Agent to Forward Notifications to ThirdParty Applications .......................... 261
18.1
Editing the CheetahXD Trap Forwarding Table ........................................................................................261
18.2
Trap Message Example ............................................................................................................................263
Page
Page88
18.3
Notification Formats ................................................................................................................................264
18.3.1
Managed Object Notifications.........................................................................................................264
18.3.2
Alert Notifications ...........................................................................................................................265
19
System Administration ........................................................................................................... 267
19.1
Using the Bulk Task Status Page...............................................................................................................270
19.2
See Devices in the Discovery Queue ........................................................................................................271
19.3
Using the Database Backup Page .............................................................................................................272
19.3.1
19.4
Restoring a Database.......................................................................................................................273
Using the System Performance Page .......................................................................................................273
19.4.1
Server Details Tab............................................................................................................................274
19.4.2
Client Details Tab.............................................................................................................................275
19.5
Using the Log Entries Page .......................................................................................................................276
19.6
Using the Log Configuration Page ............................................................................................................277
19.6.1
Open the Logging Configuration Page .............................................................................................277
19.6.2
Editing the Log Settings ...................................................................................................................277
19.7
Using the Logs Monitor Page ...................................................................................................................278
19.8
Setting the Automatic LogOut Time Duration..........................................................................................279
20
Troubleshooting ..................................................................................................................... 280
20.1
CheetahXD Startup Issues ........................................................................................................................280
20.1.1
20.2
CheetahXD Startup Fails After Server Reboot .................................................................................280
Java Conflicts ............................................................................................................................................283
20.2.1
Some CheetahXD Functions Not Accessible ....................................................................................283
20.2.2
CheetahXD and CheetahNet Server Java Conflicts ..........................................................................284
20.2.3
CheetahXD and CheetahNet Client Java Conflicts ...........................................................................285
20.3
Errors Running Reports ............................................................................................................................285
20.4
Access Errors ............................................................................................................................................285
20.5
Database Backup Failures ........................................................................................................................285
20.6
Java Security Warning Dialog Box Appears ..............................................................................................286
20.6.1
Individual Client Machine Settings ..................................................................................................286
20.6.2
Additional Settings ..........................................................................................................................286
21
CheetahXD Utilities ................................................................................................................ 287
21.1
Remote Export Utility...............................................................................................................................287
21.1.1
Command Arguments .....................................................................................................................287
21.1.2
Running the Remote Export Utility..................................................................................................288
Page
Page99
21.1.3
Remote Export Utility Help..............................................................................................................288
21.1.4
Examples..........................................................................................................................................289
21.2
Console Data Display................................................................................................................................290
21.3
Firmware Download .................................................................................................................................291
21.4
Send Event................................................................................................................................................291
21.5
Importing HFC Manager Events into CheetahXD .....................................................................................292
21.5.1
Procedure for Windows ..................................................................................................................292
21.5.2
Procedure for Unix ..........................................................................................................................294
21.6
22
Multiple Device/AlarmDynamic Mapping and Route Calculation............................................................296
QAM Constellation Map ......................................................................................................... 301
22.1
The QAM Constellation Interface.............................................................................................................301
22.2
QAM Interface Variables and Parameters ...............................................................................................302
22.2.1
Device Details ..................................................................................................................................302
22.2.2
Configuration Settings .....................................................................................................................302
22.2.3
Downstream (256 QAM) Frequency and Power .............................................................................303
22.2.4
Upstream Frequency and Power .....................................................................................................303
22.2.5
Downstream Signal Quality .............................................................................................................303
22.2.6
Codeword Error Rate.......................................................................................................................303
22.3
23
Interpreting QAM Constellation Map Data by Visual Inspection .............................................................304
System Setup and Maintenance Recommendations ............................................................... 309
23.1
New CheetahXD Installations ...................................................................................................................309
23.1.1
Configuring CheetahXD to Discover DOCSISBased Elements .........................................................309
23.1.2
Deploying CheetahXD with CheetahNet .........................................................................................310
23.1.3
Deploying CheetahXD with CheetahLight .......................................................................................310
23.1.4
Deploying CheetahXD with CheetahDOCSIS ...................................................................................311
23.2
FineTuning CheetahXD Parameters ........................................................................................................312
23.2.1
System Verification..........................................................................................................................312
23.2.2
Performance Tuning and Configuration ..........................................................................................312
23.3
CheetahXD Bandwidth Information .........................................................................................................314
Appendix A
Supported Motorola GX2 Modules ........................................................................... 316
Appendix B
Supported Cisco Prisma II Modules............................................................................ 317
Page
Page10
10
Page xi

Preface
1
1.1
CheetahXD UserPreface
Guide
Preface
Purpose and Scope of this Guide
This guide contains information on installing, configuring, and using CheetahXD to monitor network devices in a
Broadband Hybrid Fiber/Coax (HFC) distribution system.
1.2
Related Documentation
See the following Cheetah documentation list for related documentation.

Document
Part Number
Installation & User Guide NetMentor Operator Guide

Installation & User Guide NetMentor Administrator Guide
CheetahXD Installation and Upgrade Guide
CMD-P Transponder User Manual
CMD-P+ Transponder User Manual
CMD-E Transponder User Manual
CMD-EL Transponder User Manual (VoIP only)
CMD-N SG4000 Transponder User Manual
CMD-N HLN 3x4x Transponder User Manual
1.3
6510-00-0460
6510-00-0357
050-0096
050-0170
050-0193
050-0102
050-0198
050-0188
050-0185
Conventions
This guide uses the naming conventions and symbols as described in the following tables.
1.3.1
Typographical Conventions
Description
Example
Commands appear in bold typeface.

Switches that you press on a unit appear in SMALL CAPS
TYPEFACE.
On the Status bar, click Start

Press the AUX switch.
Code and output messages appear in courier font.

Text you must enter exactly as shown appears in this courier bold
typeface.
All results okay
Filenames, pathnames and variables appear in italics typeface.
Type the new hostname.
A vertical bar | means or: only one option can appear in a single
command.
platform [a|b|e]
Square brackets [ ] indicate an optional argument.

Slanted brackets < > group required arguments
login [platform name]
Page 1
Type: a:\set.exe in the dialog box
<password>

Preface
1.3.2
CheetahXD UserPreface
Guide
Keyboard and Menu Conventions

Description
1.3.3
Example
A comma indicates consecutive key

strokes.
Press Alt+f,s
A right angle indicates choosing an option

from a menu.
On the menu bar, click Start > Programs
Symbol Descriptions
Icon
1.3.4
Description
NOTE:
IMPORTANT!
Notes indicate related information or tips.

Indicates information that must be understood
before proceeding.
CAUTION!
Indicates a general hazard.
Keyboard Internationalization
Edit the file /CheetahXD/html/EnglishToNative.properties and change the English labels to the appropriate foreign
language equivalents.
1.4
Cheetah Technical Support
If you need assistance or have questions related to the use of this product, contact Cheetah Support at:
1-866-944-1482 cheetahsupport@cheetahtech.com
Cheetah Technologies, L.P.
381 Mansfield Avenue
Pittsburgh, PA 15220
www.cheetahtech.com
Page 2

Introduction
CheetahXDIntroduction
User Guide
Introduction
CheetahXD Multi-Layered Network Assurance Software is a software suite with a complete set of applications for
delivering element/network management system (EMS/NMS) solutions. The system is accessible through standard
web browsers on Windows and Solaris machines.
CheetahXD monitors, manages, and tests Hybrid Management Sub-layer (HMS), Data Over Cable Service Interface
Specification (DOCSIS), and legacy devices in Broadband Hybrid Fiber/Coax (HFC) distribution systems. Using
embedded and external HMS and DOCSIS transponders communicating with headend controllers or Cable Modem
Termination Systems (CMTSs), CheetahXD monitors and tests network devices such as:
Nodes
Generators
Amplifiers
Power Supplies
End-of-line (EL) devices
With a few clicks of the mouse, CheetahXD also provides up-to-date status information on many of its sophisticated
applications, such as:
On-demand testing
Call Scheduler
Send Event information
Enterprise Fault Server (FPS)
Figure 2-1: Cheetah XD Multi-Layered Network Assurance Software Solution
Page 3

Introduction
2.1
User Guide
Industrial Database
CheetahXD utilizes Oracle version 12cR1, a robust database with a proven track record, to protect your investment.
In addition, automated backup capability is available right out of the box.
2.2
Scalability
CheetahXD can support from dozens to thousands of monitored devices. It operates with individual workstations as
well as large client-server installations, and maintains functionality as devices change and systems grow.
2.3
Security
CheetahXD provides individual user accounts with default levels of security (customizable Admin and User
privileges), as well as modifiable default settings.
2.4
Transponder Auto Discovery
When transponders are added to the network, they register themselves with the CMTS or headend controller, and
are automatically added to the CheetahXD database with all available functions fully discovered. After the
registration process is complete, user-definable views can easily be created. These views define the topology views
used to display the newly-discovered devices.
Transponders with IPv4 and IPv6 addresses can be discovered.
2.5
Integration with Existing Cheetah Software
CheetahXD can be integrated with CheetahLight and CheetahNet systems to become the single source for managing
all devices in the network. Procedures for integrating CheetahLight and CheetahNet into CheetahXD allow
CheetahXD to function with managed devices in existing Cheetah systems to:
2.6
Import their device information into CheetahXDs database

Receive and display their alarms and device data
Download firmware, configuration templates, and alarm limits to them
Perform power supply tests
Run reports
Advanced Grouping
CheetahXD offers a flexible mechanism for creating groups of network elements. An easy-to-use graphical user
interface (GUI) is available to manage the grouping functions, using simple drag-and-drop operations.
Basic grouping is provided for:
2.7
Native topology display

IP topology display
FCC topology display
HFC topology display
Region topology display
User-created topology display
Physical display (e.g., all physical connections to the headend or CMTS)
Advanced Alarm Threshold Configuration
Page 4

Introduction
User Guide
You can create configuration templates, choosing between traditional fixed or percentage-based alarm thresholds on
a parameter-by-parameter basis. CheetahXD applies the template to auto-discovered transponders, thus enabling
Page 5

Introduction
User Guide
immediate fault management of new transponders (although individual transponders can still be manually
configured). User-defined priority conditions enable operators to streamline pager and e-mail notification of faults.
2.8
HMS MIB Extension Support Enhanced Alarm Processing
All Cheetah HMS transponders support the Cheetah HMS management information bases (MIBs) and value-added
MIB Extensions. Only CheetahXD is designed to take advantage of these unique MIB extensions, which support
enhanced alarm processing algorithms. Simply put, standard HMS MIBs do not gracefully support oscillating alarm
conditions in real-world environments. The real-life situation occurs when a monitored device has a problem that
causes a value to oscillate between normal and alarm conditions (outside the range covered by the dead band
setting), requiring the HMS transponder to report alarms for every state change. The Cheetah Enhanced Alarm
Processing MIB extensions allow users to configure timing parameters related to alarm generation.
Two configurable parameters are available for both analog and digital states. This can be used to limit or eliminate
nuisance alarms caused by spikes and value oscillations. This logic functions alongside existing analog filtering and
digital signal debouncing, then latches in the worst alarm condition.
2.9
Battery Analyst Module
The automated Battery Analyst Module allows users to automate routine battery drain tests and perform testing on
demand. Tests record battery voltages, output voltage, current, and other parameters. Results are summarized in
reports that reveal trends, which enable targeted maintenance repairs.
2.10
CheetahXD System Architecture
The CheetahXD system design is based on a distributed architecture intended to reduce the amount of data
(communications traffic) required. The distributed architecture and reduced traffic allows for additional speed,
reliability, and scalability of the system.
CheetahXD transponders retain, in flash memory, all information (alarm limits) needed to determine whether a
power supply is operating within normal ranges. Detailed alarm information is reported to CheetahXD via Simple
Network Management Protocol (SNMP) traps in cases where alarms exist. Since SNMP traps do not guarantee
delivery, CheetahXD uses a background synchronization process that continuously checks for lost traps and, if
needed, takes remedial action.
Messages sent to CheetahXD are error messages or responses to an operators request to view an individual
transponder element. All messages sent between the CheetahXD software and DOCSIS transponders are SNMP
messages.
Since the transponders send only alarm messages or data requested by an operator, the amount of traffic on the
network connecting the transponders and CheetahXD is greatly reduced. This limited traffic allows for a faster and
more robust platform. CheetahXD can manage up to 20,000 elements in the network via the Windows 2008 and
Sun Solaris (10 or higher) platforms.
Since all communications between the CheetahXD software and transponders are SNMP messages, the architecture
is open and standards-based. This communications scheme makes all of the plant status and alarm information
available for integration into a higher-level OSS system.
Page 6

Introduction
User Guide
Figure 2-2: CheetahXD System Architecture - Typical HFC Installation

CheetahXD consists of the following five components:
Oracle Software
Oracle Database
CheetahXD Database
CheetahXD Application
PCs running a web browser
These components work together to allow the user to configure and monitor the cable system. They provide
notification of problems reported by transponders, VoIP devices, and headend controllers.
Database tables store the following information:
Configuration data Contains network element (NE) data, alarm limits, and the current status of specified
devices.
Alarm data Lists current alarms of all or selected devices and provides a historical listing of all alarms.
Audit data Tracks changes to parameters and user activity.
Security system data Establishes user name, password, and privilege data for all users.
NOTE:
2.11
Logs are not stored in the database.
CheetahXD System Deployment
A system could be viewed as a single software server accessed by web browsers on multiple PCs, with the software
monitoring transponders deployed throughout the physical network. Each CheetahXD server allows up to 25
simultaneous client connections. The only limiting factor is whether the capacity of the database will enable the total
number of elements to be supported. While there is no hard limit on this, performance slowly decreases as database
size increases. Server database capacity has been tested with up to 20,000 transponders performing well. For
networks that have the potential to grow much larger than this, multiple separate systems should be considered.
Page 7

Introduction
User Guide
CheetahXD Server communicates using standard protocols such as Simple Network Management Protocol (SNMP),
and Transmission Control Protocol/Internet Protocol (TCP/IP). This provides a flexible architecture for deployment.
Page 8
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
Starting and
CheetahXD
Stopping CheetahXD
User Guide
Starting and Stopping CheetahXD
Properly starting and stopping the CheetahXD software avoids potential problems. These problems can arise from
open ports, commands and processes pointing to windows and other processes in unexpected states, and other
miscommunications. Always start and stop the CheetahXD software according to the procedures in this section.
CheetahXD runs as a service on both Windows and Solaris systems. However, CheetahXD must be run manually the
first time, so that the license key can be provided.
For details on installing the CheetahXD software and required licenses, please refer to the latest version of the
CheetahXD Installation Guide (Cheetah part number 050-0096).
3.1
Starting/Restarting CheetahXD on a Solaris Server
The CheetahXD software running on a Solaris server may be restarted by rebooting the server itself as long as the
software has been initially started, and the license information has been correctly entered. However, the Sentinel
license service and the CheetahXD service can be manually restarted as well. The procedure in this section provides
information on how to conduct a manual restart.
NOTE:
The configuration of a Solaris Server is dependent upon the hardware and operating system settings. If the
Solaris Operating System is configured to reboot automatically after a power failure, CheetahXD processes
will start after the OS is running; no special setting is required for CheetahXD.
Some Solaris systems may be headless. The term headless typically refers to a system without graphics capability
(i.e., no monitor) and generally no console or keyboard interface.
NOTE:
On headless servers that have video cards, Cheetah recommends installing a mouse, keyboard, and monitor
prior to installing the CheetahXD software. These devices can be removed after the software is successfully
installed. For servers without video cards, it is necessary to have an X-terminal application, such as Exceed,
installed and running on a separate machine to access the CheetahXD server for installation. Also, the
DISPLAY environment variable may need to be set before starting the actual installation to direct the
launched GUI onto your X-window client. In csh, use the command listed below. The x.x.x.x portion of the
command is the IP address of the X-window client.
# setenv DISPLAY x.x.x.x.:0.0
Manually Starting the CheetahXD Software on a Headless or Non-Headless Solaris Server

1.
2.
3.
4.
5.
6.
Enter the path shown in the following example.

CheetahXD/lm720/bin
Type the command shown below to start the license server.
#./lserv &
If desired, confirm that the license server is running by entering the following command.
ps ef | grep lserv
Next, enter the path shown in the following example.
opt/CheetahXD/bin
Type the following command to start the CheetahXD software.
#./startCheetahXD.sh &
If desired, confirm that the CheetahXD software is running by entering the following command.
ps ef | grep XD
Page 9
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
NOTE:
Starting and
CheetahXD
Stopping CheetahXD
User Guide
If the installer application fails to start, please refer to the CheetahXD Software Installation Failure section.
Page 10
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
3.2
Starting and
CheetahXD
Stopping CheetahXD
User Guide
Stopping CheetahXD on a Solaris Server
The CheetahXD software can be shut down in one of two ways: manually at the server, or through a client machine
using a web browser interface. This section provides information on both procedures.
Manually Shutting Down the CheetahXD Software on a Solaris Server
1.
Enter the path shown in the following example.

/opt/CheetahXD/bin
2. Change to a super-user status.
3. Run the shutdown script by typing the following command. (Note the leading decimal point.)
./Shutdown.sh
4. When the User Name and Password prompts appear, enter the appropriate User Name and Password
information.
Shutting Down the CheetahXD Software on a Solaris Server using a Web Browser
1. Connect to the server running the CheetahXD software using a client machine with a web browser installed, and
log into the CheetahXD system as a user with Admin privileges.
IMPORTANT:
2.
3.
To shut down the CheetahXD software, the operator must log into the system as a user with an Admin
user privilege.
Select the Administration tab.

From the Admin Operations panel, select Shutdown Server.
Figure 3-1: Shutdown Server Link

4. When the shutdown window displays, click Yes.
Forcing Shut Down of CheetahXD Software
1.
Enter ps -ef |grep CheetahXD to see the XD processes

Example:
# ps -ef |grep CheetahXD
root 26598 26548 0 Aug 07 pts/5
0:00 /bin/sh ./startCheetahXD.sh
root 26599 26598 0 Aug 07 pts/5 106:15 ./jre/bin/java -cp .:./classe
s:./classes/WebNMS_jars.jar:./classes/CheetahXD_ja
root 28755 28730 0 11:20:52 pts/7
0:00 grep CheetahXD
2.
Enter kill -9 and the process numbers

Examples:
# kill -9 26598
# kill -9 26599
# ps -ef |grep CheetahXD
Page 11
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
3.3
Starting and
CheetahXD
Stopping CheetahXD
User Guide
Starting CheetahXD on a Windows Server
Starting CheetahXD on a Windows Server

1.
2.
Using the Services feature in Windows, verify that the Sentinel license service is running.
Select Start>Programs>CheetahXD>Start CheetahXD.
The License Agreement window displays, as shown in Figure 3-2.
Figure 3-2: License Agreement Window

3.
Click the License Acceptance checkbox, then click Next.

The Licensee Details window displays, as shown in Figure 3-3.
Figure 3-3: Licensee Details Window
Page 12
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
4.
Starting and
CheetahXD
Stopping CheetahXD
User Guide
Click Browse.
The Select License File window displays, shown in Figure 3-4.
Figure 3-4: Select License File

5.
6.
Navigate to the folder containing the CheetahXD license file. Select the file and then click Open.
Click the Next button in the Licensee Details window.
Each license contains a list of authorized user names. The User Name field displays the default user name from the
list. The user whose name appears in the User Name field will become the registered user assigned to this
installation. To assign a different user name to the field, select the new user name from the drop-down list.
7.
8.
Select a new User Name, if desired.

Click Finish.
A DOS (command) window appears, as shown in Figure 3-5, and lists the CheetahXD primary modules as they
start. After CheetahXD starts successfully, the DOS window displays a line of information containing a server
port number.
IMPORTANT
DO NOT close the DOS window. Closing the DOS window will cause the CheetahXD services to
terminate. If desired, the DOS window can be minimized on the server.
Figure 3-5: Select Start CheetahXD DOS Window
Page 13
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
Starting and
CheetahXD
Stopping CheetahXD
User Guide
The server port number is used by client machines for communications. Once communications have been established
between the server and client(s), operators can begin accessing the CheetahXD software through web browsers
installed on the client machine(s). The DOS window will look similar to the one shown in the previous figure.
Page 14
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
3.4
Starting and
CheetahXD
Stopping CheetahXD
User Guide
Stopping CheetahXD on a Windows Server
CheetahXD software must be shut down before the server is shut down, upgraded, or has other software installed.
CheetahXD software that resides on a Windows system can be shut down locally, on the server where the software
resides, or remotely through a client machines web browser. This section displays both methods.
Stopping CheetahXD on a Windows Server
1.
On the Start Menu, navigate to the CheetahXD folder and select Shutdown CheetahXD.
Select Start > Programs > CheetahXD > Shutdown CheetahXD.
The Shutdown CheetahXD Server window appears, as shown in Figure 3-6. If the port information does not need
to be changed, proceed to Step 6.
NOTE:
If the CheetahXD default port information has not changed, you will not need to change the port information.
Figure 3-6: Shutdown CheetahXD Server Window

2.
Click Settings to change the shutdown type or port number.

Clicking Settings opens the Mode of Shutdown window, as shown in Figure 3-7.
Figure 3-7: Mode of Shutdown Window

If desired, select the shutdown mode, enter the new port number, and click OK to save the changes or Cancel to
close the window without saving the changes.
Page 15
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
3.
Starting and
CheetahXD
Stopping CheetahXD
User Guide
On the Shutdown CheetahXD Server window, enter a password and click OK.
A DOS window will appear and display the CheetahXD processes as they are stopped. The DOS window will look
similar to Figure 3-8.
Figure 3-8: Example DOS Shutdown Window

When the processes have stopped, the Shutdown Status window is displayed. Click OK. CheetahXD is now shut
down.
Shutting Down the CheetahXD Software from a Client Machine
1.
2.
3.
4.
Log into CheetahXD using a web browser on a client machine.

On the CheetahXD main page, select the Administration tab.
In the Admin Operations panel, select Shutdown Server.
After the confirmation window, click Yes to shut down the server.
Page 16
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
3.5
Starting and
CheetahXD
Stopping CheetahXD
User Guide
Restarting CheetahXD on a Windows Server
NOTE:
After a Power Failure, the Oracle processes must be restarted prior to starting CheetahXD.
To restart CheetahXD on a Windows server, navigate to Start > Programs > CheetahXD and select Start CheetahXD.
A DOS window appears, as shown in Figure 3-9, and lists the CheetahXD primary modules as they start.
IMPORTANT!
DO NOT close the DOS window. Closing the window will cause the CheetahXD services to terminate.
If desired, the DOS window can be minimized on the server.
Figure 3-9: CheetahXD DOS Startup Window

After CheetahXD starts successfully, the DOS window displays a line of information containing a server port number.
This port number is used by the client machines for communications. Once communications have been established
between the server and client(s), operators can begin accessing the CheetahXD software through web browsers
installed on the client machine(s).
3.6
Authenticating Users Against an External LDAP Directory
CheetahXD supports two schemes of binding to an LDAP server: User Bind and Anonymous Bind. User binding
requires the creation of a LDAP user account (typically a restricted, read-only account) with an associated user name
and password. The user name and password need to be configured in CheetahXD (please refer to the ldap.conf
example in this section). Anonymous binding does not require a login and/or password. Authentication via LDAP is a
three-step process:
1.
Bind to an LDAP account to be used for the CheetahXD application.
2.
Issue an LDAP search to retrieve the DN to use for CheetahXD user level authentication.
3.
Bind to the CheetahXD login names account.
If the bind in Step 3 succeeds, the CheetahXD user authentication is deemed successful. If any step fails, the
CheetahXD user authentication is deemed unsuccessful.
NOTE:
The password length for all passwords with XD is limited to 8 characters. A 9 character password length for
an LDAP user account will not authenticate with XD. The LDAP user account password must be no more than
8 characters.
Page 17
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
Starting and
CheetahXD
Stopping CheetahXD
User Guide
To Specify an External LDAP Directory for Authenticating Users

1.
2.
Add the file CTLdapAuthentication.jar to the CLASS_PATH of the following files (depending on your platform).
This jar file resides in the <CheetahXD-Home>/classes directory.
In the <CheetahXD-Home>/conf directory, edit the following files:
Edit This File
NmsProcessesBE.conf
clientparameters.conf
Serverparameters.conf
3.
4.
5.
3.7
To Make These Changes
Provide an ARGS entry for the LDAP authentication class under the
parameter
PROCESS
com.adventnet.nms.security.authentication.NmsAuthenticationManager
ARGS AuthenticationImpl
com.Cheetah.cable.ccms.authentication.CTLdapAuthenticationImpl
maximum_allowed_login_failed_count 0
Add the following entry to the end of the ARCHIVE parameter.
../classes/CTLdapAuthentication.jar
Add the following entry.
#Added for LDAP Authentication
CRYPTO_CLASS com.Cheetah.cable.ccms.authentication.CTLdapEncryption
Navigate to the <CheetahXD-Home>/bin directory.

Shut down CheetahXD using the following command:
shutdown.bat/.sh
Start CheetahXD for the first time using the following command:
startCheetahXD.bat/.sh
Configuring Client Machines for Applet Execution
Before using any of the CheetahXD applet applications, such as accessing the Tree Viewer or Network Inventory
applications via a web browser, Cheetah strongly recommends configuring certain parameters on each client
machine.
To obtain the expected results, the client machine must meet the following criteria:
The machine must have Java version 1.6 or newer installed. If you try to access a client machine that does not
have the appropriate version of Java, you will be presented with a link directing you to a location where you can
obtain the required version of software.
The client machine must have a minimum of 256 MB of free memory available after all of the machines
applications have started after a typical boot process. It may be necessary to use a machine with more than the
required minimum of 1GB of total memory to obtain the desired results.
Page 18
CheetahXD
Starting
and User
Stopping
Guide
CheetahXD
Starting and
CheetahXD
Stopping CheetahXD
User Guide
To Configure a Client Machine for Applet Execution

In certain environments, it may become necessary to allocate Java memory for the CheetahXD applets. Only perform
these steps if your client contains less than the recommended specifications, or if there are other applications on the
client machine using java memory.
1.
On the (Windows) client machine, open the Control Panel and double click on the Java list entry.
The Java Control Panel window will open, as shown in Figure 3-10.
Figure 3-10 Java Control Panel Window

2.
On the Java Control Panel, select the Java tab and click View on the Java Applet Runtime Settings Panel.
The Java Runtime Settings window appears, as shown in Figure 3-11.
Figure 3-11: Java Runtime Settings Window

3. Next to the appropriate entry in the Java Runtime Parameters cell, type in -Xmx128m exactly as it appears in
the quotation marks.
4. Click OK to close the window, and then close the Control Panel.
Page 19
System Setup
Integrating CheetahXD with Existing Cheetah Systems
When CheetahXD is installed in a site that already has CheetahNet, CheetahLight, or Cheetah DOCSIS installed, the
browser accessing CheetahXD can become the single source for all Cheetah-managed devices in the network.
Integrating your existing Cheetah software into CheetahXD allows you to manage your entire network from the
browser accessing CheetahXD. Network management functions include:
Connecting to and monitoring all Cheetah-managed devices

Configuring transponders and downloading alarm profiles to transponders
Performing battery tests
Displaying alarms
Cross-navigating from a device in one view to the same device in another view
Displaying device configuration and current data.
An integrated CheetahXD system will automatically discover the addresses of the Cheetah-managed network
elements in the existing CheetahNet, CheetahLight, and Cheetah DOCSIS networks. Transponder names, locations,
and alarm thresholds can be included in the discovery by performing additional procedures.
4.1
How CheetahXD Manages HMS, DOCSIS, and CheetahLight Legacy Devices
CheetahXD directly communicates with CheetahLight headend controllers and Cheetah DOCSIS transponders to
manage HMS, DOCSIS, and CheetahLight legacy devices. CheetahXD communicates with CheetahNet headend
controllers (through CheetahXDs virtual headend controllers or vHECs), to discover/configure/test HMS devices and
receive their alarms.
4.2
How CheetahXD Manages CheetahNet Legacy Devices
CheetahXD manages CheetahNet legacy devices indirectly, communicating with CheetahNet headend controllers to
discover/configure/test these devices and receive their alarms (if CheetahNet is installed on the same machine).
CheetahNet legacy devices (as opposed to CheetahNet HMS devices), cannot be provisioned in CheetahXD because
neither configuration templates nor changes in the Device Configuration module can be downloaded to them from
CheetahXD. When CheetahXD imports legacy devices into its database through integration procedures, the devices
appear in the database as if they are provisioned. This allows CheetahXD to manage some functions of legacy
devices natively, such as displaying battery temperature, voltage, and current, as well as performing battery tests.
For functions such as data display and device configuration, CheetahXD automatically launches the corresponding
CheetahNet operation. However, for CheetahXD to launch a CheetahNet operation, the machine running the
CheetahXD browser must also have the CheetahNet client installed. For information on installing a CheetahNet
client, refer to the latest revision of the Installation & User Guide, NetMentor Administrator Guide (Cheetah part
number 6510-30-0357).
4.3
Integrating CheetahXD with CheetahLight/Cheetah DOCSIS
To integrate CheetahXD with either CheetahLight or Cheetah DOCSIS, CheetahXD must be installed according to the
installation procedure in this manual, and then started. CheetahXD communicates with CheetahLight HECs and
Cheetah DOCSIS transponders and will automatically autodiscover their devices when the discovery operation is
properly configured according to the procedures in this chapter. However, transponder names, locations, and alarm
threshold settings are not included in the discovery process (unless this data is imported during discovery). To import
this data into CheetahXD, see the following procedure.
Page 16
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Import CheetahLight/Cheetah DOCSIS Transponder Names and Locations

1. Ensure CheetahXD is running and that all of the CheetahLight/Cheetah DOCSIS transponders have been
discovered by CheetahXD.
2. In the CheetahLight or Cheetah DOCSIS client, click the Tools menu and select Export. This creates a file in.csv
format, which contains the Media Access Control (MAC) names and addresses of the transponders.
3. Open the installation file \bin\cheetahLightImportData.bat using a text editor.
4. Edit the file to include the location of the .csv file, using Uniform Resource Identifier (URI) file notation. The file
includes a sample of a file location in URI file notation format.
5. Save and close the file.
6. Run the file.
For each transponder specified in the .csv file, the utility updates the location and identification data in the
CheetahXD system. The utility posts messages to the console that detail CheetahXD devices that have been updated,
as well as CheetahXD devices that could not be found. If there are CheetahXD devices that could not be found, run
the import utility again at a later date when more devices have been discovered. Running this utility more than once
has no negative impact on CheetahXD.
Import HMS and CheetahLight Legacy Transponder Threshold Settings During Discovery
1.
2.
Open the installation file \conf\NMSProcessesBE.conf in any text editor.

Find the section that looks like the text below.
PROCESS com.Cheetah.cable.ccms.service.auto-discoveryapi.CTAutodiscoveryAPIBE
_ Process
ARGS
NULL
3.
Edit the entry to look like the following:
PROCESS com.Cheetah.cable.ccms.service.auto-discoveryapi.CTAutodiscoveryAPIBE
_ Process
ARGS
SYSTEMIMPORT true
4.
5.
6.
7.
After the system is fully discovered, shut down CheetahXD.

Open the installation file \conf\NMSProcessesBE.conf in any text editor.
Change the SYSTEMIMPORT argument back to NULL .
Restart CheetahXD.
When all devices have been discovered and configured, simply uninstall CheetahLight or Cheetah DOCSIS.
4.4
Integrating CheetahXD with CheetahNet
CheetahXD communicates with CheetahNet headend controllers through CheetahXDs vHECs. Integrating CheetahXD
with CheetahNet involves initially discovering CheetahNet devices and ensuring their configurations agree in both
systems, and then setting the Discovery Configurator to perform ongoing auto-discovery for devices that may, in the
future, be attached to CheetahNet headend controllers.
CheetahXD can be integrated with CheetahNet in whole or in part, depending on many factors. For example:
The types of CheetahNet devices in the network (HMS and/or legacy devices).
How much CheetahXD control over CheetahNet devices is desired (e.g., see alarms only, see all devices, and/or
configure devices in browser accessing CheetahXD, etc.).
Page 17
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Whether you want all CheetahNet devices accessible through the CheetahXD browser, or wish to move to the
CheetahNet server to perform some functions.
Fully integrating CheetahNet into CheetahXD, and having all of the functions accessible through the browser
accessing CheetahXD, requires the following steps.
CheetahNet and CheetahXD are installed.

A CheetahNet Client is installed on the machine being used to access CheetahXD. For more information please
refer to the latest version of the Installation & User Guide, NetMentor Administrator Guide (Cheetah DOC#
6510-30-0357).
Auto-discovery for HMS devices is turned off in CheetahNet Object Architect. For more information please refer
to the latest version of the Installation & User Guide, NetMentor Operator Guide (Cheetah DOC#
6510-30-0460).
Be certain to make a backup of the CheetahNet database and backups of the /home/EINSTIEN/DATA
directories for each HEC that monitors HMS devices.
CheetahNet HMS devices are removed from the CheetahNet database, but not from CheetahNet HECs. For
more information, please refer to the latest version of the Installation & User Guide, NetMentor Administrator
Guide (Cheetah DOC# 6510-30-0357).
A network element for the CheetahNet system is created and configured in CheetahXD through which the
CheetahNet network of legacy devices will be visible in CheetahXD tree views (see the procedure in this
chapter).
One or more virtual headend controllers (vHECs) are enabled for discovery in CheetahXD and a proxy added for
each CheetahNet HEC whose devices will be accessible by CheetahXD (see the procedures in this chapter).
CheetahXD vHECs are enabled to begin discovering CheetahNet devices.
CheetahNet devices are provisioned in CheetahXD (CheetahXD configuration templates are downloaded to
them).
The CheetahXD Discovery Configurator is modified to control the discovery of new devices that may be added to
CheetahNet HECs in the future.
Each CheetahNet HEC is reconfigured to direct alarms to CheetahXD instead of CheetahNet (see the procedure
in this chapter).
SegSNMP Agent is running on the CheetahNet server to deliver alarms to CheetahXD instantly, without waiting
for CheetahXD to poll CheetahNet. For more information, please refer to the latest version of the Installation &
User Guide, NetMentor Administrator Guide (Cheetah DOC# 6510-30-0357) and the Installation & User Guide,
NetMentor
Operator
Guide
(Cheetah
DOC#
6510-30-0460).
Page 18
CheetahXD
User Guide
System Setup
4.4.1
System
CheetahXD
UserSetup
Guide
Creating a CheetahNet Element in CheetahXD
CheetahXD tree views display natively-managed devices, which are devices that have been auto-discovered and
configured in CheetahXD, including CheetahXD-discovered CheetahNet HMS devices. To display CheetahNet legacy
devices in CheetahXD tree views, create and configure a network element in CheetahXD that represents the existing
CheetahNet network of legacy devices.
For details on using the Tree Viewer, please refer to The Tree Viewer chapter in this manual.
To create a CheetahNet element in CheetahXD
1.
In the Tree Viewer, display the native tree in the View Editing pane.
Use the Tree Name dropdown menu to select native.
2.
Select the native root, and then click the Add New Element button.
The Create New Network Elements window will display, as shown in Figure 4-1.
Figure 4-1: Create New Network Element Window

3. Type a name for the element in the Name field (this is the display name that will show in CheetahXD tree views),
and select the category Legacy System Legacy Application CheetahNet System - None from the Category dropdown menu.
4. Click OK.
Page 19
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
To view the new element, either reload the tree by selecting the Refresh Tree from Database button,
or by swapping the view of the native tree to the Primary pane by selecting the Swap Views button.
The new element will be displayed in the tree, as shown in Figure 4-2.
Figure 4-2: New Network Element

A newly created network element must also be configured as discussed in the following section.
4.4.2
Configuring the CheetahNet Network Element
Newly added network elements are automatically assigned with a standard configuration template. Changes to the
template must be made to ensure proper function of the CheetahNet network element.
Configure the element as follows.
To Configure the CheetahNet Network Element
1. Ensure that the new device is displayed in the native tree and that the native tree view is currently displayed in
the Primary pane.
2. Right-click on the new element in the tree and select Device Configuration.
The network elements Device Configuration page opens.
3. Select the Property tab.
4. Select the expand button to the left of the network element to display the template parameters.
5. Make the following changes:
a. Managed Ensure the checkbox is checked
b. IP Address Type the IP address of the CheetahNet Server
c. Status Polling Enabled Ensure the checkbox is checked
d. Server Name or IP Address Type the name of the CheetahNet Server
e. Server IP Address Type the IP address of the CheetahNet Server
f. Database Server Name or IP Address Type the name of the Database Server (usually the same as the
CheetahNet Server)
g. Database IP Type the IP address of the Database Server (usually the same as the CheetahNet Server)
h. Message Manager IP Address Type the IP address of the CheetahNet Server
i. SEG Server IP Address Type the IP address of the CheetahNet Server.
6. Click Save.
Page 20
CheetahXD
User Guide
System Setup
1.1.1.1
System
CheetahXD
UserSetup
Guide
CheetahXD Devices and Location Information
Most of the pertinent Location information defined in CheetahNet is preserved when imported into XD. The mapping
of fields is below. Note that when any change is made to the location information in the CheetahNet system, that
Location information will be updated in XD on the next System Update cycle. The System Update cycle is defined in
the Device Configuration of the CheetahNet MO in XD. The user always has the option of using the Force System
Update menu item in XD if they do not want to wait for the system to perform the update on its own.
CheetahNet Location Tab Fields
Location
Street Address
Street Address 2
City
State
Zip
Country
Latitude
Longitude
Map X
Map Y
Trunk ID
Distribution ID
Node ID
4.4.2.1
XD Device Configuration Fields
Location
User Field 1
User Field 1 (space separated)
User Field 2
User Field 2
User Field 2
User Field 3
User Field 5
User Field 5
User Field 4
User Field 4
Not Mapped
Not Mapped
Not Mapped
CheetahNet Device and Alarm Synchronization Parameters
The CheetahNet integration was designed to work with the CheetahNet SEGSnmp agent for updating alerts and
synchronizing devices in real time. If you do not have a copy of the SEGSnmp agent application, please contact
Cheetah Support at 1-866-944-1482 or email at cheetahsupport@cheetahtech.com and a copy will be provided to
you.
In addition, a backup process exists for instances where the SEGSnmp agent is not communicating with the
CheetahXD server. Parameters that are accessible from the CheetahNet device Property Page allow for alerts and
devices to be synchronized using batch processes.
NOTE:
The parameters accessible from the CheetahNet device Property Page are relevant only when the SEGSnmp
agent is not communicating, and pertain only to the communications from CheetahNet to CheetahXD.
HINT:
In most cases, the default values will be sufficient for normal operations. However, in situations where a device
is added and deleted intermittently, you may find it very useful to set the Force System Update option to OFF
within the CheetahNet device in the tree. When the Force System Update parameter is set to off, the
CheetahXD system must fetch the latest device and alert updates, thereby synchronizing it with the
CheetahNet system.
Page 21
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Seconds between checks for device updates Specifies how often, in seconds, the system will fetch the device
list from the CheetahNet system. This process is system-resource intensive. Changing the value of this
parameter should be done with care.
Page 22
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Seconds between checks for new alarms Specifies how often, in seconds, the system will look for new alerts.
The system compares the last alert ID in the CheetahXD database to the highest alert ID in the CheetahNet
database. If a difference is found, the system fetches the new alert(s).
Seconds between checks for Alarm Acks Specifies how often, in seconds, the system will check for alerts that
were acknowledged in CheetahNet, but must be updated in CheetahXD. If an alert is acknowledged in
CheetahXD, CheetahNet is updated in real time.
Seconds between checks for Alarm Clears Specifies how often, in seconds, the system will check for alerts
that were cleared in CheetahNet, but must be updated in CheetahXD. If an alert is cleared in CheetahXD,
CheetahNet is updated in real time.
Range of Alarms to check for Alarm Acks Specifies the range of alarms to check. Cheetah recommends leaving
this parameter set to its default value of 500.
4.4.3
Virtual Headend Controller Installation
A virtual headend controller (vHEC) is an element in CheetahXD that translates communications between CheetahXD
and CheetahNet headend controllers. Create a vHEC by installing it from the CheetahXD installation media.
Configure a vHEC with which CheetahXD will communicate by creating a proxy within it for each of the CheetahNet
HECs (and by extension, their child devices).
Starting the vHEC opens a command window to display logging information. The logging information appears only in
this window and is not written anywhere. Logging information is therefore lost if the window is closed or the vHEC is
stopped for any reason. Following the installation procedure is another procedure that sets up a log file to
permanently record vHEC events. Cheetah suggests creating this permanent log file.
Configure a vHEC using the following steps:
1.
2.
3.
4.
5.
6.
Disable HMS Auto-discovery on the CheetahNet System

Reconfigure all of the CheetahNet HECs with targeted HMS devices to point to the vHEC and CheetahXD
Install the vHEC
Create the proxies
Add the vHEC entry in the Discovery Configurator
Turn on the vHEC
It is important to understand that all CheetahNet HMS transponders must reside on one system. An HMS
transponder should never reside on both systems at the same time.
4.4.4
Disabling the AutoDiscover Feature
Follow the procedure outlined below to disable auto-discovery on the CheetahNet server.
Disabling the AutoDiscover Feature
1.
2.
3.
4.
Stop the OA service on the CheetahNet server.

From the CheetahNet server, use a text editor to open the HMS BROADCAST.ini file in
/Acterna/oa_root/ini. Set the CREATEDEVICE flag to off (CREATEDEVICE=OFF). Next, use a semicolon (;) to
change any line that contains modem port information, HEC IP information, or RPS addresses to a comment
line. Save and close the file.
Next, use a text editor to open the launcher properties file in /Acterna/oa_root/properties. Use a semicolon (;)
to change every line of the OA Listener section in the file to a comment. Save and close the file.
Delete the HMS transponder entries from the CheetahNet database only via HEC/DB Sync. This will leave the
.DAT file in the HEC. The .DAT file will be used by the vHEC.
Page 23
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
NOTE: If the automatic leveling feature is to be used, the CheetahNet HEC must use the software version CheetahXD
Build 3 or newer. The CheetahXD Build 3 software is included on the vHEC installation disk.
To have the transponder alert profiles imported into CheetahXD during the automatic discovery process,
theSYSTEMIMPORT flag must be set to true (SYSTEMIMPORT=TRUE) in the NmsProcessesBE.conf file.
4.4.5
Reconfiguring a CheetahNet Headend Controller (HEC)
Each HEC on the CheetahNet system needs to be reconfigured so that it sends its alarms to the vHEC on CheetahXD
system. For additional information, please refer to the latest version of the NetMentor Headend Communications
Controller Installation Guide (Cheetah DOC# 6510-30-0366).
To reconfigure a CheetahNet HEC
1.
2.
3.
4.
Open the hosts file in the CheetahNet HEC using a text editor.
Point the OA listener to the IP address of the CheetahXD vHEC with which it will communicate.
Point the OA_TrapListener to the IP address of the CheetahXD server.
Restart the HEC for the changes to take effect.
4.4.6
Creating an Configuring a Virtual Headend Controller (vHEC)
Create a vHEC in CheetahXD
NOTE: If installing the vHEC on the same server as CheetahXD, edit the file vHEC\conf\vHecConf.xml in Wordpad or a
similar text editor, and change the value of <RunVHECOnXD>false</RunVHECOnXD> to true.
5.
6.
7.
Insert the vHEC installation media into the CD drive.

Migrate to the following path \vHEC Install (Phase 1)\Disk1\InstData\Windows\VM and double-click the file
InstallVHec.exe to begin the installation. The VHec Installer window opens.
Continue through the installation program, clicking Done when finished.
Page 24
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Create a permanent vHEC Log File

1. Open the file vHEC\jre\lib\logging.properties in WordPad or similar text editor.
2. Edit the appropriate lines to direct the logging output to the desired file. The following is an example of the
necessary changes.
############################################################
# Default Logging Configuration File
#
#You can use a different file by specifying a filename
# with the java.util.logging.config.file system property.
# For example java -Djava.util.logging.config.file=myfile
############################################################
############################################################
# Global properties
############################################################
# "handlers" specifies a comma separated list of log Handler

# classes. These handlers will be installed during VM startup.
# Note that these classes must be on the system classpath.
# By default we only configure a ConsoleHandler, which will only
# show messages at the INFO and above levels.
#handlers= java.util.logging.ConsoleHandler
# To also add the FileHandler, use the following line instead.
handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler
# Default global logging level.

# This specifies which kinds of events are logged across
# all loggers. For any given facility this global level
# can be overridden by a facility specific level
# Note that the ConsoleHandler also has a separate level
# setting to limit messages printed to the console.
Page 25
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
.level= INFO
Page 26
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
############################################################
# Handler specific properties.
# Describes specific configuration info for Handlers.
############################################################
# default file output is in user's home directory.

java.util.logging.FileHandler.pattern = vhec.log
java.util.logging.FileHandler.level = INFO java.util.logging.FileHandler.limit
= 50000 java.util.logging.FileHandler.count = 1
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
# Limit the message that are printed on the console to INFO and above.
java.util.logging.ConsoleHandler.level = INFO
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
############################################################
# Facility specific properties.
# Provides extra control for each logger.
############################################################
# For example, set the com.xyz.foo logger to only log SEVERE

# messages:
# com.xyz.foo.level = SEVERE
Page 27
CheetahXD
User Guide
System Setup
4.4.7
System
CheetahXD
UserSetup
Guide
Creating Proxies
Create an HMS Proxy for each CheetahNet HEC that has HMS devices connected to it, and a Legacy Proxy for each
CheetahNet HEC that has legacy CheetahNet devices connected to it.
Proxies can be added to vHECs and activated, using SNMP if you have a MIB browser or another application that can
perform SNMP gets and sets. Otherwise, proxies can be added manually.
Add Proxies Using SNMP
8. Open the MIB browser or other application that performs SNMP gets and sets.
9. Use the addHMSProxy SNMP OID (1.3.6.1.4.1.2082.3.1.1.5.1.0) or the addlegacyproxy SNMP OID
(1.3.6.1.4.1.2082.3.1.1.6.1), depending on which type of proxy (HMS or legacy) you are creating.
10. Set the addHMSProxy or the addlegacyproxy value to the IP address of the CheetahNET HEC that will
communicate with this proxy.
11. Activate the proxy by setting the hmsProxyState OID (1.3.6.1.4.1.2082.3.1.1.5.2.1.2) or the
legacyProxyState OID (1.3.6.1.4.1.2082.3.1.1.6.2.1.2) to a value of 1.
Manually Add Proxies
1. Open the file vhec/conf/vhecconf.xml in WordPad or other similar text editor. This file contains samples of how
to add HMS and legacy proxies to it.
2. Add the proxy element between the <VHecMgr> and the </VHecMgr> tags using the following sample formats.
HMS Proxies - To add and activate an HMS proxy for CN HEC IP 192.9.230.2
<Proxy type="hms" ip="192.9.230.2" state="ON"></Proxy>
Legacy Proxies to add and activate a legacy proxy for CN HEC IP 192.9.230.1
<Proxy type="legacy" ip="192.9.230.1" state="ON"></Proxy>
4.4.8
Adding a vHEC to CheetahXDs Auto-discovery Queue
Follow the procedure outlined below to add the vHEC to CheetahXDs auto-discovery queue.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
On the Administration Page, in the Discovery Admin section, click Discovery Configurator.
Enter the administrative user ID and password and click Connect. The CheetahXD Authentication window opens.
After clicking OK, the Discovery Configurator window opens.
Select the Network Discovery tab, and then select the SNMP checkbox located near the bottom of the window.
Select the SNMP Properties button. The SNMP Properties window will open.
Type vhec into the Community field.
Type 161 into the SNMP Agent Port field.
Click OK.
Click Add on the Discovery Configurator, Network Discovery tab.
Click Apply.
Page 28
CheetahXD
User Guide
System Setup
4.4.9
System
CheetahXD
UserSetup
Guide
Discovering HMS Devices
When a vHEC containing proxies is started, it uses its own auto-discovery process to communicate with CheetahNet
HECs. The parameters set in the Discovery Configurator of CheetahXD have no effect on this initial discovery
process.
Initial discovery through the vHEC gathers the MAC addresses of CheetahNet devices onto the CheetahXD vHEC,
where they remain until CheetahXD polls the vHEC (polling timing is set in CheetahXDs System Setup). When polled,
the MAC addresses in the vHEC(s) are added to the CheetahXD database and the devices are now natively managed
by CheetahXD.
HMS devices that are added to CheetahNet HECs in the future can be auto-discovered by CheetahXD, if parameters
are added to the file vhec/conf/vhecconf.xml to facilitate this.
Configure CheetahXD to Continually AutoDiscover New Devices Added to CheetahNet HECs
22. Turn off /shutdown the vHEC to make the necessary edits.
23. Open the file vhec/conf/vhecconf.xml in WordPad or a similar text editor.
24. For each proxy defined in this file, specify the following auto-discovery parameters:
Modem to poll on the CheetahNet HEC
Discovery is set to ON or OFF
Time interval between discovery operations
Duration of each discovery operation.
For example, to set up auto-discovery on RF modem 1 (RF01) and RF modem 2 (RF02) for an HMS Proxyon
192.9.230.2, the file vhec/conf/vhecconf.xml will have the following entries:
<Proxy type="hms" ip="192.9.230.2" state="ON">
<Auto-discovery>
<PortName>RF01</PortName>
<DiscoveryOnPort>ON</DiscoveryOnPort>
<DiscoveryInterval>120</DiscoveryInterval>
<DiscoveryDuration>1</DiscoveryDuration>
<RpsAddr>1</RpsAddr>**
<RpsAddr>2</RpsAddr>
</Auto-discovery>
<Auto-discovery>
<PortName>RF02</PortName>
<DiscoveryOnPort>ON</DiscoveryOnPort>
<DiscoveryInterval>120</DiscoveryInterval>
<DiscoveryDuration>1</DiscoveryDuration>
<RpsAddr>3</RpsAddr>
</Auto-discovery>
</Proxy>
Page 29
CheetahXD
User Guide
System Setup
4.4.10
System
CheetahXD
UserSetup
Guide
PortName specifies on which RF modem auto-discovery should occur.

DiscoveryOnPort specifies whether auto-discovery is ON or OFF.
DiscoveryInterval specifies how often (in seconds) that discovery should occur.
DiscoveryDuration specifies how long (in seconds) an RF modem listens for transponders to respond after
an auto-discovery message has been broadcasted.
RpsAddr specifies the RPS address to which the transponders are communicating. This tag is not required.
If RPS is not being utilized, Cheetah recommends removing the tag(s).
Starting the vHEC
The vHEC requires exclusive access to port 161, and will not start without it. Other SNMP services and managers
cannot be running on the same machine and cannot use the same port (i.e., port 161). If they are, stop them before
starting the vHEC.
On Windows machines, ensure that the SNMP Service and the SNMP Trap Service are stopped or disabled.
Access the Different Windows Services
25. Open the Windows Services Window
Click Start > Control Panel > Administrative Tools > Services.
On Windows 7, Click Start > Control Panel > System and Security > Administrative Tools > Services.
26. In the Services window, scroll to SNMP Service and SNMP Trap.
27. Select one of the entries and click the Stop the Service link.
28. Repeat with the second SNMP service.
29. The vHEC can be started by either starting its service from the Services window or from the Windows Start
button by entering the path to the vHEC file. The default path is /Program Files/vHEC.
On Solaris machines, the default SNMP Enterprise Master Agent (snmpdx) and the SNMP Enterprise Mapper SubAgent (snmpXdmid) must not be running.
Stop Snmpdx and SnmpXdmid Processes on Solaris Machines
1. Log in as superuser.
2. Type the command ps ef | grep i snmp to identify the process ids (pids) of snmpdx and snmpXdmid.
3. Use the kill command to stop the processes (e.g., kill 9169165, where 169 is the process id of snmpXdmid,
and 165 is the pid of snmpdx).
4. If desired, reconfigure these processes to use a port other than 161 or 162.
5. Log out of the Solaris machine.
6. Start the vHEC by running the startVhec.sh script located under the bin directory of the vHEC. On Solaris
machines, login as root, as you may require access to port 162 if configured for traps.
4.4.11
Provisioning CheetahNet HMS Devices in CheetahXD
When CheetahNet HMS devices are imported into CheetahXD through the initial vHEC discovery process or the
subsequent CheetahXD auto-discovery process, parameters defined for them in CheetahNet are imported with them,
and CheetahXD assigns templates to them based on device type. CheetahXD stores this information in its database.
Nevertheless, the devices are not considered to be provisioned until they have had CheetahXD configuration
templates or Device Configuration changes downloaded to them. For information on provisioning devices, see the
chapter titled Provisioning Devices.
Page 30
CheetahXD
User Guide
System Setup
5
5.1
System
CheetahXD
UserSetup
Guide
System Setup
Login Page
Log into CheetahXD by entering your User Name and Password, and clicking Login.
Figure 5-1: Login Page
5.2
Domain Options
Select the Domain Options page. This page, as shown in Figure 5-2, features color-coded, text-based displays in
multiple configurations, and provides the ability to organize devices. You can select a Tree View (Native, HFC, etc.) to
display a menu tree and expand any device group by clicking the Key icon.
Figure 5-2: CheetahXD Domain Options Page
Page 31
CheetahXD
User Guide
System Setup
5.3
System
CheetahXD
UserSetup
Guide
Collapsed Tree Color
CheetahXD uses color to indicate device alarm status. As illustrated in Figure 5-3, when a topology tree is collapsed,
the highest-level visible device reflects the highest alarm status of any of its child devices; when expanded, the child
device itself reflects its alarm status. This way, alarm states are always visible.
Figure 5-3: Collapsed Topology Tree
5.4
Typical System Setup
A typical CheetahXD system setup includes creating users, groups, and permissions, as well as configuring the
discovery and auto-discovery parameters. These operations can be completed on the Administration page, as shown
in Figure 5-4.
This section will describe the Security Administration and Discovery Administration panels.
Figure 5-4: Administration Page
Page 32
CheetahXD
User Guide
System Setup
5.5
System
CheetahXD
UserSetup
Guide
Security Administration Panel

o User Configuration Create and maintain user information
o Group Configuration Create and maintain group information
Discovery Admin panel
o Discovery ConfiguratorConfigure the discovery and auto-discovery parameters.
o Discovery QueueDisplay all of the active discoveries, the discoveries currently in the queue, and
the discoveries on the waiting list.
Security Administration
System Security consists of specifying the following:
Groups Where administrator specifies permissions

Scopes Where administrator limits permissions to specific tree views
Users Where administrator creates login names and passwords for authorized users.
Managing these aspects in combination allows administrators to ensure that access to CheetahXD is controlled, data
integrity is assured, and system use is properly logged.
The administrator should set up the system security in the following order:
30. Create groups
31. Apply scopes to groups
32. Create users (including specifying the groups to which they belong).
5.6
Groups
A group is a collection of access and function permissions. Creating a group means selecting from a list of specific
permissions that are granted or denied to the group. The group(s) associated with a user name is the mechanism
that determines a users privileges.
To decide what kinds of groups to create, define the types of users for your enterprise according to the functions they
will perform. Create a group for each set of functions. For example:
Administrative or root-level users have full permissions.

Department heads have permission to create users, perform database backups, and configure power supply
testing schedules.
General users can acknowledge and clear alarms and run reports.
Page 33
CheetahXD
User Guide
System Setup
5.6.1
System
CheetahXD
UserSetup
Guide
Creating and Removing Groups
Create a group to define a set of permissions.

Create a Group
33. From the Security Administration panel, click the Group Configuration link.
The Group Configuration window displays, as shown in Figure 5-5.
Figure 5-5: Group Configuration Window

34. Click Add Group.
This opens the Add Group window. This window contains a Group Name field and the Operation Tree Root menu
tree. This menu tree contains all of the available group-related operations and permissions. Click the Plus icon
to expand each set and view the individual permissions and operations for the set.
35. Enter the group name.
Group names should not contain spaces.
36. Scroll through the list until you find the CheetahXD set. Expand this set and choose the desired operations and
permissions by selecting the applicable checkboxes.
Select the checkbox for the overall CheetahXD set to assign all of the permissions and operations for the set.
Selecting any checkbox multiple times toggles the state of the permission among these three options:
a. First Click A checkmark is placed in the checkbox to indicate the function is permitted.
b. Second Click An X is placed in the checkbox to indicate the function is not permitted.
c. Third Click The checkbox is cleared. Functions with cleared checkboxes are considered denied
functions, and will not be permitted for the group.
37. After making your selections, click Save.
The new group will display in the Group Configuration window.
Delete a Group
Delete an individual group by selecting the trashcan icon
in front of the group name.
Delete multiple groups by selecting the checkboxes in front of each desired group name and clicking the Delete
button.
NOTE:
Do not attempt to delete all of the groups at one time.
Page 34
CheetahXD
User Guide
System Setup
5.6.2
System
CheetahXD
UserSetup
Guide
Operations and Permissions
The following sections list the CheetahXD Operations and Permissions by subsections and provide a brief description
of each option.
CheetahXD Administration
CheetahXD AdminView/configure CheetahXD Admin menu

Bulk Property UpdateView/configure the Bulk Property menu option
Bulk Task Status View/initiate the Bulk Task menu option
Bulk Transponder Reset Initiate the resetting of transponders en masse
Firmware Download Admin View/configure and download firmware to transponders
Paging Admin View/configure the paging application
Send Event View/initiate the Send Event menu option
Template Admin View/initiate the Template Admin menu option
Complete View View all menu options on the Administration tab
Alarms
Acknowledge Alarms Acknowledge alarms in the Alarm Viewer

Clear Alarms Clear alarms from the Alarm Viewer
Create Alarm Filter Create alarm filters in the Alarm Viewer and edit Enterprise Fault Server (EFS) definitions
Delete Alarms Delete alarms from the Alarm Viewer
Auto-discovery
Force Rediscover Manually force a rediscovery on a specific device.

Modify Queue Modify (clear) the rediscovery queue(s).
View Queue View the auto-discovery queues.
Battery Admin
Power Outage Monitor View the Power Outage Monitor feature.

Battery Admin Administrator Configure the Battery Analyst and to perform Battery Admin operations.
Battery Admin User Run the on-demand Battery Analyst, the inverter, perform deep drain and predictive tests,
and view reports.
Device Admin
Add Device Add a device from the client tree server.

Control Device Set a device control from the Data Display.
Create CN HMS DeviceCreate CN HMS Device.
Delete Device Delete a device from the client tree viewer or context menus.
Edit CommunityEdit device community data.
Edit Device Modify device configuration information from the device configuration application.
Force Sync Alerts
Maintenance Mode
Read CommunityRead device community data.
Domain Options
FCC Domain
Page 35
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Access FCC Domain

FCC Tree View
Page 36
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
HFC Domain
HFC Power Tracker

HFC Reports View/initiate the HFC Reports menu option.
HFC Scheduling View/initiate the HFC Scheduling menu option.
HFC Tree View View/initiate the HFC Tree Viewer menu option.
QAM Constellation DisplayView QAM Constellation Display.
IP Domain
Access IP Domain View the IP Domain subsection.

IP Configuration View/initiate the IP Configuration menu option.
IP Fault View View/initiate the IP Fault Viewer menu option
IP Reports View/initiate the IP Reports menu option.
IP Tree View View/initiate the IP Tree Viewer menu option.
Tree Views
Tree Views Data Display View/initiate the Data Display menu option.
Tree Views Remove View/initiate the Tree Views Remove menu option.
Tree Views Rename View/initiate the Tree Views Rename menu option.
Faults
Notifier Dashboard View and Access the Notifier Dashboard.
IP Testing
IP Bandwidth Testing
IP Bandwidth Active Tests and Historical View/access the Active Test and Historical information.
IP Bandwidth Test Setup Enable the IP Bandwidth Test application.
VoIP Testing
Cancel Active VoIP Test

Initiate On-demand VoIP Test
View VoIP Test History
VoIP Testing Scheduling
Add VoIP Schedule

Browse, Edit VoIP Schedule
Launch VoIP Scheduler
Remove VoIP Schedule
Network Inventory
Access Network Inventory View/initiate the embedded Network Inventory menu option.
Reporting
Active Alert Status Report View Active Alert Status Report.

Alert Analysis Report View Alert Analysis Report.
Page 37
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Alert Listing Report View Alert Listing Report.

Alert Report by Category View Alert Report by Category.
Page 38
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Battery Analyst Report View Battery Analyst Report

Battery Summary Report View Battery Summary Report Page.
Device Configuration Reports View Device Configuration Reports.
Device Dead Report View Device Dead Report.
Device Inventory by Type View Device Inventory by Type.
Device Status Reports View Device Status Reports.
FCC 24hr Variance Report
FCC Pre-Test Report
Page Alert On-Call Report
Power Supply Alert Report View Power Supply Alert Report.
Power Supply Testable Report
Provisioned Transponders Report View Provisioned Transponders Report.
Scheduler Report View Scheduler Report.
Transponder Firmware Report
Scheduling
Add Schedule Add a schedule using the Scheduler.

Disable/Enable ScheduleDisable/enable scheduler.
Edit Schedule Modify a schedule in the Scheduler.
Remove Schedule Remove a schedule from the Scheduler.
View Schedule Reports Review the results of a schedule.
System Setup
Tree Admin Operation
Create Custom Tree Create a custom tree in the client tree viewer.
Tree Administrator
Assign License Key
5.6.3
Modifying Groups
Use the Group Configuration section to complete any of the following actions:
Add and remove users from a group

Add, modify, or remove operations and permissions
Assign or remove custom view scopes.
For more information about scopes please refer to Section 5.6.4 on page 36 in this chapter.
5.6.3.1
Adding or Modifying Members (Users) from a Group
Add or Remove Members (Users) from Group

3.
4.
5.
6.
7.
Select the Group Configuration link from the Security Administration panel on the Administration page.
On the Group Configuration screen, click on the name of the group you wish to modify.
The Modify Group screen opens.
Select the Members header, expanding the Members section.
Click Assign User.
Highlight one or more user names in the Available Users field. Click the right-facing arrow to add the name(s)
Page 39
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
into the Enrolled Users field. If you are removing a user, highlight one or more names in the Enrolled Users field
Page 40
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
and click the left-facing arrow to move the name(s) into the Available Users field. Click Submit to update the
group.
8. The user and user status information is displayed in the Members section of the Modify Group screen. The
icon represents an active user and an
icon represents an inactive user.
5.6.3.2
Changing Group Operation Settings
Use the Group Configuration page to change the privileges of a user by changing the operation and privilege
configuration of the group assigned to the user.
Change Group Operation Settings
1.
2.
3.
On the Group Configuration page, select a group name to modify.

Click on the Operation Settings header to expand the section.
Click Configure.
The Operations Tree window displays, as shown in Figure 5-6.
Figure 5-6: Operations Tree Window

4. In the Operations Tree window, adjust the operations and privileges as desired. To save the changes press the
Save button, or press the Cancel button to start over. Refer to the Creating and Removing Groups section on
page 32 of this chapter for details on assigning operations.
5.6.4
Scopes
Scopes provide or limit access to specific tree views. Users must be given explicit permission to view these trees by
being assigned to groups that have access to the tree(s). In addition, trees created by the user root are not
automatically visible to all users.
Because the function of a scope is to limit a groups permission, assign and remove scopes when creating or
modifying groups.
NOTE:
The Device Trees scope is the only scope supported at this time.
The Add New Scope feature will be implemented in a future release.
Additional device tree names can be added (enrolled) to the Device Trees scope using the following instructions:
Assign or Remove a Scope
Page 41
CheetahXD
User Guide
System Setup
1.
System
CheetahXD
UserSetup
Guide
On the Modify Group page, click on the Custom View Scope section header to expand the section.
Page 42
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
2. Select the Device Trees options from the Scope Name drop-down list to view the tree names currently assigned
to the group. The enrolled tree names will appear in the Authorized Scopes list.
3. To enroll further tree names to the Device Trees scope, click Assign Scope.
The Modify profile window, as shown in Figure 5-7, will open and display the device tree names available to the
scope and already enrolled to the scope.
Figure 5-7: Modify profile Window

4.
5.
6.
To add a scope, select the desired Available Scope and click the right-facing arrow.
To remove a scope, select the desired Enrolled Scope and click the left-facing arrow.
Click Submit to save the changes or Cancel to close the window without saving the changes.
5.7
Users
A user is a person allowed to access and use CheetahXD. This section describes how to create CheetahXD users.
5.7.1
Creating Users
Users configured on CheetahXD are highly configurable. Permissions may be assigned or denied to users to limit or
enable their exposure to a variety of features and functions on CheetahXD. These permissions are typically assigned
when the user is created, but can be changed at a later time, as well.
NOTE:
The group(s) associated with a user determines a users privileges.
Click the User Configuration icon to access the User Configuration page, as shown in Figure 5-8.
Figure 5-8: User Configuration Page
Add User button Use this button to create individual users.

Add Multiple button Use this button to create multiple (12 maximum) users at one time.
Change Status dropdown menu Use this button to change the status of one or more users.
Delete button Used in conjunction with the checkboxes in the front of the user names, this button is used to
delete users from the system.
Status column Indicates the status of the user. A green icon indicates enabled, a gray icon indicates disabled.
Page 43
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Active column Indicates the active state of the user. A yellow icon indicates active, a gray icon indicates
inactive.
Page 44
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Assign To column Provides access to the function for assigning/removing groups to/from a user.
Operations Info This feature is not supported at this time. Operations and permissions are assigned to users
by associating groups to the users.
Create a Single User

1.
2.
From the Security Administration panel, on the Administration page, click the User Configuration link.
On the User Configuration page, click Add User.
This opens the Add User page, as shown in Figure 5-9.
Figure 5-9: Add User Page

3.
In the Add User window, enter the user name and password information into the appropriate fields.
This data is mandatory.
4. Next, either select a group name from the Available group name section, or create a new group name by
selecting the Add this user to a new group checkbox, and then entering the name in the adjacent field. If you
choose to use the Add this user to a new group feature, the new group will need to be configured at a later time.
The user must have at least one group assigned.
5. Finally, if the password and/or the user account should expire after a predetermined amount of time, select the
Password expires in and/or the Account Expires in checkboxes and enter the time, in days, into the adjacent
field(s).
6. Click Save to add the user name to the system.
Page 45
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Create Multiple Users

Up to 12 unique users may be created using this feature. When users are created using this feature, the password for
each user will be the same as the user name. Changing each users password requires editing each user account at a
later time.
1.
2.
3.
4.
Select the User Configuration link from the Security Administration panel, on the Administration page.
On the User Configuration page, click Add Multiple.
Enter unique names into each user field (i.e., User 1, User 2, etc.).
The user name can contain letters, numbers, underscores, and hyphens. Spaces are not allowed.
Select one or more groups to assign to each user.
Each user must have at least one group assigned. If you wish to assign the same group(s) to each user, select
the Apply selected group to all users checkbox, as shown in Figure 5-10.
Figure 5-10: Add Multiple Users Page

5.
Click Save to add the users to the system.
5.7.2
Modifying Users
Modify a user to change associated groups, passwords, and expiry dates.

Modify a User:
1.
2.
3.
Select a user by clicking on a user name.
To change the user profile information, click the right-hand Edit link, as shown in Figure 5-11.
Figure 5-11: Modify User Page - Edit Link

4. Update user profile information and click Submit to save the changes.
5. Change groups associated with the user, if desired.
a. Expand the Associated Groups section
b. Click Configure Group.
Page 46
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
This opens the Modify profile window.
Page 47
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
c.
6.
Highlight one or more user names in the Available Groups field. Press the right-facing arrow to add the
name(s) into the Enrolled Groups field. If you are removing a group, you would highlight one or more
names in the Enrolled Users window and press the left-facing arrow to move the name(s) into the
Available Groups window. After making the desired change(s), press the Submit button to make the
change.
Choose Permitted Operations to change the permissions and operations assigned to a user. (See Section 5.6.2
for a description of Operations and Permissions.)
5.7.3
Deleting Users
Use the following instructions to delete users:

1.
2. To delete a single user, click the trash can icon

in front of the user name.
3. Delete multiple users by selecting the checkboxes in front of the desired user names, then selecting the Delete
button.
NOTE:
5.7.4
Do not attempt to delete all of the users at one time.

Changing User Status
Change the Status of a User:

1.
2.
3.
Select the User Configuration link from the Security Administration panel on the Administration page.
To change the status of a single user, select the checkbox in front of the user name. Next, click the Change
Status button and select the desired state.
To change the status of multiple users, select each checkbox in front of the desired user names. Next, click the
Change Status button and select the desired state.
NOTE:
Do not attempt to change the state of all the users to Disable at one time.
Figure 5-12: User Configuration Page - Change Status Menu
Page 48
CheetahXD
User Guide
System Setup
5.7.5
System
CheetahXD
UserSetup
Guide
Terminating User Sessions
With the addition of the CheetahKillUser role, administrators now can terminate a session when the upper limit of
licensed users (according to the license key) is met.
TollgradeLoginAction.java allows only one CheetahKillUser role to be assigned in the database.
1. Logged in as administrator, create the user CheetahKillUser by selecting Administration > User Configuration,
and assign Admin access.
Figure 5-13: User Configuration Page

2.
Verify that the user is added to the database.
Figure 5-14: New User in Database

3. When the upper limit of users is met, CheetahKillUser can log into Cheetah XD and terminate any user session
and change the users status to Disable.
Figure 5-15: Terminating a User Session
Page 49
CheetahXD
User Guide
System Setup
5.8
System
CheetahXD
UserSetup
Guide
Discovery Admin
The Discovery Admin panel gives you access to:
The Discovery Configuratorused to configure the discovery and auto-discovery parameters.

Discovery Queuedisplays all of the active discoveries, the discoveries currently in the queue, and the
discoveries on the waiting list.
Figure 5-16: Administration Page - Security Administration Section

The Discovery Configurator is the location where you specify the parameters for CheetahXDs initial auto-discovery
process and ongoing rediscovery process.
CheetahXD can discover devices:
Added to its own (native) network

Added to CheetahNet, CheetahLight, and Cheetah DOCSIS networks when CheetahXD is properly integrated with
these systems (see the chapter titled Integrating CheetahXD with Existing Cheetah Systems).
The CheetahXD discovery process consists of:
Seeing a device in the network that is not in the CheetahXD database (or is in the database, but has been
specified to be rediscovered)
Obtaining the devices MAC or IP address
Determining what kind of device it is (transponder, battery, optical node, etc.)
Selecting the appropriate configuration template for the device type
Writing the device information into the CheetahXD database along with the name of the configuration template
Displaying the device in the CheetahXD Native view (if auto download of the template is used), and in the Not
Provisioned column in the Network Inventory page.
After devices are discovered, the user must provision (configure) them by either downloading the appropriate
template or by accessing the Device Configuration option. For information on provisioning devices, see the chapter
titled Provisioning Devices.
The Discovery Queue is the location where you can see and manage devices in various stages of discovery.
5.8.1
Discovery Configurator
The Discovery Admin panel on the Administration page contains the Discovery Configurator link where you specify
the parameters for CheetahXDs initial auto-discovery process and ongoing rediscovery process.
NOTE: The Discovery Configurator acts as a medium to put the entries in the seed.file, which is the file CheetahXD uses
to perform auto-discovery and rediscovery. All modifications done using the Discovery Configurator affect only the
seed.file. There is no impact on the database.
Parameters in the Discovery Configurator allow CheetahXD to discover:
A single IP Address
Page 50
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
A single network
A range of network or node IP addresses
Page 51
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Additionally, the Discovery Configurator can prevent discovery of specific networks.

To set initial, general auto-discovery parameters:
1.
In the Discovery Admin page, click on the Discovery Configurator link.
Figure 5-17: Administration Page - Discovery Admin Section

2.
Log into the Discovery Configurator.

Enter the appropriate user ID and password, and then press Connect.
The Discovery Configurator opens, displaying the default tab General, shown in Figure 5-18.
NOTE: After making any changes in the Discovery Configurator page, you must apply the changes to the CheetahXD
server before they can take effect. Some of the configuration windows include a Reload button you can click to
apply changes. The bottom of the Discovery Configurator page includes an Apply button for applying changes
made in any Discovery Configurator window to the server.
Figure 5-18: Discovery Configurator - General Tab

3.
Set the options on the General tab, as desired.
Auto Discovery This checkbox turns auto-discovery on and off. By default, the box is unchecked (auto-discovery
is off).
Rediscover Already Discovered Checking this checkbox causes CheetahXD to discover all network elements,
Page 52
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
even those already discovered. By default, this box is unchecked, and the CheetahXD auto-discovery process
only autodiscovers new network elements. Enable this checkbox when discovered devices need to be restored
Page 53
CheetahXD
User Guide
System Setup
4.
System
CheetahXD
UserSetup
Guide
to default parameters. Disable this checkbox to improve system performance by discovering only those devices
that have not yet been discovered.
Discover Local Net Checking this checkbox causes the local network and all of its nodes to be included in the
auto-discovery process. This check box is disabled.
Enable Log Checking this checkbox causes CheetahXD to store detailed debug messages related to autodiscovery in a file called discoveryLogs.txt.
Discovery Interval This text field controls the interval (in minutes) between discovery of networks. The value set
for this parameter affects the performance (CPU utilization and network traffic) of the discovery process.
Click the Initial Parameters button to specify the initial auto-discovery parameters. The values set here
determine the speed of the initial discovery process.
It is not mandatory to set the values for all of the parameters in the Initial Parameters page. When no
parameters are set in the Initial Parameters page, CheetahXD uses the values set for the parameters in the
General tab.
NOTE: None of the values are utilized until a change is made. Once a change is made, all of the field values are applied.
Figure 5-19: Initial Parameters Window

5.
Specify the values for the options on the Initial Parameters page. The following table describes each parameter.
Parameter
Description
Discovery Interval
Interval (in seconds) between the discovery of any two devices in the network. The default
value is 1 second. When initially deploying CheetahXD and all devices need to be
discovered, set this value low. Afterwards, during normal operations, you can change this
value to a higher number so that CheetahXD resources are applied to auto-discovery
operations less often. This leaves CheetahXD resources free for other daily operations.
Rediscovery Interval
Interval (in hours) between polling sweeps of the discovered network(s). Default is 24
hours. If a negative value is specified, it is replaced by 24.
Number of times CheetahXD pings ICMP (Internet Control Message Protocol) devices.
Default is 0 (i.e., retry is performed only once), a setting of 1 causes a retry to be
performed twice. Set this value as low as possible for optimum system performance.
ICMP Ping Retries
Page 54
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Parameter
SNMP Timeout
Description
The maximum time, in seconds, that CheetahXD waits for a response from SNMP devices,
before attempting a retransmission. Default is 1. Raise this value when auto-discovery is
discovering a remote network where the response time could be more.
This value is doubled for each retry, as specified in the
SNMP Retries setting. For example, if SNMP Timeout is set to 5 seconds and SNMP
Retries is set to 3, the first retry will occur in 5 seconds. The second retry will occur in 10
seconds, the third retry in 20 seconds and so on.
Note: This option can also be set in the Network Discovery tab of the Discovery
Configurator. When the options are different, the settings specified there prevail.
SNMP Retries
Number of times CheetahXD pings an SNMP device. Default is 0 (i.e., retry is performed
only once), a setting of 1 causes a retry to be performed twice. Set this value as low as
possible for optimum system performance.
Note: This option can also be set in the Network Discovery tab of the Discovery
Configurator. When the options are different, the settings specified there prevail.
NativePing Timeout
The maximum time, in seconds, that CheetahXD waits for a response from native devices,
before attempting a retransmission. Default is 1 second.
NativePing Retries
Number of times CheetahXD pings native devices. Default is 1 retry.
5.8.1.1
Specifying a Single Node for Discovery
Cheetah recommends using the Network Discovery page because CheetahXD uses the values specified on this page
when performing both auto-discovery and rediscovery. Values specified in the Node Discovery page are used during
initial auto-discovery only.
To specify a node for discovery:
1. Open the Discovery Configurator.
2. Click the Network Discovery tab (to specify a node for both initial auto-discovery and ongoing rediscovery) or the
Node Discovery tab (to verify the Discover checkbox is checked and to specify a node for initial auto-discovery
only).
3. Select the Set of Nodes radio button.
Page 55
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Figure 5-20: Discover Configurator - Network Discovery Tab

4.
5.
6.
7.
8.
Enter the IP address in the IP Address field.

Enter the NetMask in the Net Mask field.
Type the IP address of the single node to be discovered in both the Start IP and End IP fields.
Click Add.
The selected node is added to the scrollable list at the top of the tab.
Click Apply.
The node is included when auto-discovery and/or rediscovery executes.
5.8.1.2
Specifying Networks for Discovery
Your enterprise may include multiple networks, which you may or may not want to include in the CheetahXD
discovery process. CheetahXD allows you to specify which networks, nodes, range of IP addresses, and net masks
are included in the discovery process.
To specify networks for discovery:
1. Open the Discovery Configurator.
2. Click the Network Discovery tab.
3. Set the parameters in this tab according to the network discovery behavior desired, as described in the following
sections.
5.8.1.3
Configuring Discovery of Remote Networks
By default, CheetahXD discovers all networks to which the server running the CheetahXD server is connected. It also
adds any other network that it finds through the router to the topology, but designates that network object as
unmanaged, which means no discovery will occur.
To add a remote network for auto-discovery and rediscovery:
Page 56
CheetahXD
User Guide
System Setup
1.
2.
System
CheetahXD
UserSetup
Guide
Click the Network Discovery tab in the Discovery Configurator and verify it is checked.
Select Discover.
Page 57
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
3. Select Entire Network.

4. Type the network address in the IP Address field.
5. Type the subnet mask of the network in the NetMask field.
6. Click Add. The IP Address and NetMask values are added to the screen with the Discover column enabled
(checked). Discovery of those remote networks is enabled. Multiple networks can be configured by adding more
IPAddress and NetMask values.
5.8.1.4
Discovering a Range of Network IP Addresses
Specify one or more ranges of network IP addresses to be included in auto-discovery and rediscovery.
To discover a range of network IP addresses:
1.
2.
3.
4.
5.
6.
7.
8.
Click the Network Discovery tab in the Discovery Configurator.

Verify the Discover checkbox is checked.
Select Set of Nodes. The Start IP and End IP text boxes are enabled.
Type the network address in the IP Address field.
Type the sub-netmask of the network in NetMask fields.
Enter the starting IP address (of the range of IP addresses to be discovered) in the Start IP field.
Type the ending IP address (of the range of IP addresses to be discovered) in the End IP field.
Click Add. Multiple Range of IP addresses in a single network can also be configured.
NOTE: The range of IP addresses specified here will not be discovered and added if any of the node properties is
specified in the Disallow Criteria. Ensure that the properties of the IP addresses specified here are not specified in
the Disallow Criteria.
5.8.1.5
Discovering a Range of Node IP Addresses
The Discovery Configurator offers two places to specify a range of nodes for discovery:
The Network Discovery page

The Node Discovery page
Cheetah recommends using the Network Discovery page because CheetahXD uses the values specified on this page
when performing both auto-discovery and rediscovery. Values specified in the Node Discovery page are used during
initial auto-discovery only.
Specify one or more ranges of node IP addresses to be included in auto-discovery and rediscovery.
NOTE: Select DHCP: Only when the Start IP and the End IP are given with the DHCP option disabled, will that particular
range of network get discovered. But if Start IP and End IP are specified with DHCP enabled, then the nodes in
that particular range will be discovered as DHCP nodes, and other nodes will also be discovered as Non-DHCP
nodes.
To discover a range of node IP addresses:
1.
2.
3.
4.
5.
6.

Verify Discover is checked.
Click to select Set of Nodes. The Start IP and End IP text boxes are enabled.
Type the network address in the IP Address field.
Type the sub-netmask of the network in NetMask fields.
Enter the starting IP address (of the range of IP addresses to be discovered) in the Start IP field.
Page 58
CheetahXD
User Guide
System Setup
7.
8.
System
CheetahXD
UserSetup
Guide
Type the ending IP address (of the range of IP addresses to be discovered) in the End IP field.
Click Add. A multiple range of IP addresses in a single network can also be configured.
Page 59
CheetahXD
User Guide
System Setup
5.8.1.6
System
CheetahXD
UserSetup
Guide
Performing Network-Specific Discovery of SNMP Devices
The CheetahXD discovery module facilitates discovering SNMP V1 or V2 devices in a specific network or a range of
devices in a network. By default, the discovery engine uses the community string public and the agent port 161 while
discovering SNMP devices. But some devices in the network could use a different port and community.
These procedures cause the discovery engine to discover those SNMP devices in the specified network with the
configured community and port.
NOTE: This option can also be set in the Initial Parameters page. When the options are different, the settings specified
here in the SNMP Properties page prevail.
To discover SNMP (V1 or V2) devices in a particular network:
1.
2.
3.

Select SNMP.
Click SNMP Properties. The SNMP Properties dialog box displays.
Figure 5-21: SNMP Properties Window

4.
5.
6.
7.
Click the V1 or V2 radio button as required. The SNMP Properties tab is enabled.
Type the community of the node in the Community field.
Type the port in the SNMP Agent Port field.
Click OK.
5.8.1.7
Preventing Network Discovery
This procedure prevents a network from being discovered and added to the topology database. Multiple networks
can be prevented by adding more IP addresses and Netmasks.
To prevent the discovery of a specific network
1.
2.
3.

By default, the Discover option is selected. Disable (uncheck) this option.
Click the Apply button to save the configuration.
Page 60
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
This will prevent the network from being discovered and added to the database and tree views. Multiple networks
can be prevented by adding more IP addresses and net masks.
Page 61
CheetahXD
User Guide
System Setup
5.8.1.8
System
CheetahXD
UserSetup
Guide
Deleting Network Entries
Delete a network from the auto-discovery and rediscovery processes by selecting it in the Network Discovery tab of
the Discovery Configurator, and clicking the Delete button. Deleting an entry in the Discovery Configurator does not
delete the network from the database. The network is deleted from the file seed.file. This file stores the autodiscovery and rediscovery parameters you define using the Discovery Configurator. The deleted network will not be
discovered.
Similarly, when CheetahXD performs rediscovery, the deleted network will not be rediscovered unless the database
has been re-initialized.
5.8.1.9
Forcing Rediscovery
When necessary, the operator can force the system to perform a rediscovery.
To force rediscovery:
1. On the Network Discovery tab of the Discovery Configurator, select the network to be rediscovered by clicking on
the network in the list.
2. Click the Force Discovery button.
5.8.1.10 IPv6 Discovery

The Discovery Configurator does not support IPv6 entries. However, if IPv6 discovery is needed, the seed.file file
can be edited. To edit the seed file and enable the discovery of IPv6 devices:
1. Navigate to the CheetahXD\conf directory on the server.
2. Open the seed.file file.
3. At the end of the file (before the "</SEED>" entry) enter the following:
<TO_DISCOVERIPV6>
<UNICAST ADDRESS="2001:100:8f45:3::/64"/>
<UNICAST ADDRESS="2001:100:8f45:1::8f2"/>
</TO_DISCOVERIPV6>
where the "2001:100:8f45:3::/64" entry would enable discovery of all transponders with the prefix length of
2001:100:8f45:3:: and the "2001:100:8f45:1::8f2" entry would enable discovery of a transponder with a
specific IPv6 address. Users can create as many prefix length and/or specific IPv6 address entries as needed.
4. After the file has been edited, save the file and restart the CheetahXD server.
Note: IPv6 discovery is TRAP-based. Sweep discovery CANNOT be performed on IPv6 devices.
5.8.2
Discovery Queue
Click on the Discovery Queue link in the Discovery Admin section on the Administration page.
Figure 5-22: Administration Page - Discovery Admin Section

The queue displays devices in various stages of auto-discovery and allows you to clear the queue, or just clear the
devices still waiting to be auto-discovered.
Page 62
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Figure 5-23: Discovery Queue Page

To clear the queue, click Clear Queue. To clear just the devices still waiting to be auto-discovered, click Clear Wait
List.
5.8.3
Automatic Template Downloads
The automatic download template feature can be configured to automatically download alarm limits to CL legacy
transponders and HMS/DOCSIS transponders at the time the transponder is discovered. The procedure for enabling
this feature is different for each system (i.e., Windows or UNIX). Please contact Cheetah for details on how to enable
this feature.
5.9
Alert Filtering and Suppression
CheetahXD provides the user the ability to suppress alerts. Suppression of alerts can be managed using one of two
different methods:
1. The user has the ability to configure XD to suppress Alerts from being displayed in Notifier using the Alert Filter
feature.
2. Users who are licensed for the JMXAgent (Northbound traps) have the ability to suppress targeted alerts at the
CXD server thereby preventing the alerts from being forwarded.
Note:
Alerts are suppressed. The corresponding Event is still processed and stored and is viewable from the Events
Tab. By suppressing the Alert we are cutting down on unnecessary processing but also keeping history of activity
by storing the associated Event.
5.10
Alert Filters
Cheetah XD provides operators the ability to suppress Alerts from showing up in the Fault Views. While the triggering
event will continue to be logged in the CXD database, the process of turning that Event into a visible Alert can be
suppressed. This operation has security permissions which provide the XD Administrator the ability to enable/disable
this feature for specific users. The related permissions are as follows:
Page 63
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Figure 5-24: Alert Filters
Get Alert Filters - user can launch the Alert Filter GUI but the Load Filter link on the page has been removed
Set Alert Filters - user can launch the Alert Filter GUI but the Add Filter and Save Filter links on the page have
been removed.
Alert Filter - user does not have the ability to open up the Alert Filter GUI.
For users to have all access to the Alert Filter Function, all 3 permissions must be on.
5.10.1
Filter Rules
Alerts can be filtered by any and all of the fields displayed on the page. This includes Source, Severity, Message,
Category, and Entity.
As data is entered into each field, the entries are logically AND-ed together to create the filter. To set up an OR
scenario, you should enter in two separate filters.
A wildcard in the form of an * is utilized. The * can signify one or many characters and can be used at any point in
the string. For example, there are all valid uses of the wildcard:
Source: = DOCSIS_00103f*
Source: = *0966*
Source: = DOCSIS*aabbcc
NOTE: CHEETAHXD MUST BE RESTARTED for any new filter modifications to take effect. BLANK filters cannot be
used. If there is a filter with a name and none of the 5 attribute fields are filled in ALL alerts coming into the system
will be suppressed.
Not all fields need to be utilized; a filter can be set up using only a single field.
New filters have no effect on existing alerts being viewed. Just because a filter is created does not mean it will
clear existing alerts; the new filter will only affect those alerts generated after the XD system has been restarted.
POM alerts are also suppressed if a criterion is met.
5.10.2
Device Status in Trees
GX2 each Module will show the active status even though alerts are suppressed.
Transponders should show green in the tree if the source is to be suppressed, otherwise it will show whatever
status the highest alert severity is.
5.10.3
To Setup an Alert Filter
Page 64
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Navigate to the Administration Tab. Click the Alert Filters link from within the Configurations section of the page.
Page 65
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Figure 5-25: Administration Page - Configurations Section

Click the link to open the Alert Filters page.
5.11
Policy Configuration
CheetahXD includes a default policy configuration that should not be altered.
Figure 5-26: Alert Filters Page

There is a default set of filters that are utilized by CheetahXD (at upper right).
Figure 5-27: Filter Actions Buttons

NOTE:
DO NOT DELETE ANY OF THESE FILTERS. NORMAL ALERT PROCESSING WILL BE AFFECTED.
To add a filter, click Add Filter. The following page displays.
Page 66
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Figure 5-28: New Alert Filter Page
Page 67
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
The data you enter here will be the criteria used to SUPRESS alerts from showing up in the Faults view.
Filter Name Each filter you have must be given a name. Any combination of Numbers, Letters and spaces can
be utilized to create the filter name.
Source This is the CXD system name of the device. This is not the Display Name. The Source name on this
page corresponds to the NAME property for any device in your system.
o Used to filter alerts from a single device (DOCSIS_00103faabbcc)
o Used to filter alerts for all like devices (DOCSIS_00103f*)
Severity This related to the severity value for alerts such as Major, Minor Critical etc
o Used to filter out all Critical alerts
Message This relates to the message column displayed for each alert within the Faults view
o Used to suppress alerts with targeted text in the Message column
Category Really means Application
o Example, HFC, IP etc.
Entity This relates to the Entity field in an alert.
o Use this filter if a targeting Entity string needs to be suppressed from Notifier.
5.12
JMX ALERT Forward Filtering Northbound SNMP Traps
Utilizing JMX ALERT Forward Filtering is a three-step process.

1. The JMX agent must first be licensed. To verify if the Northbound SNMP traps feature has been licensed, open
the CheetahXD_License.xml file and look for this entry:
<Component Name="NorthBound">
<Properties Name="CORBANorthBound" Value="true"/>
<Properties Name="JMXAgent" Value="true"/>
</Component>
2. The V1V2TrapForwardingTable.xml file must be pointing to the third part trap listener. The file is located in
CheetahXD\conf\jmx_agent\conf. For more details refer to the section titled Utilizing the SNMP Agent to
Forward Notifications to Third Party Applications in the User Guide.
3. The filters need to be setup properly for the environment.
Setting up the filters is done using the JmxAlertsFilters_Example.xml file. This file is located in
CheetahXD\conf. The forward filter feature was introduced to suppress ALERTS (not EVENTS) at the CheetahXD
server before they can be forwarded to the 3rd Party Trap listener. There are two types of filters that can be used:
Include Filter This filter is inclusive and only those devices or attributes in the filter will be forwarded.
Users would invoke this filter when then may only be concerned about one or a few devices and would like to
filter out everything else.
Example I only want to see Standby Alerts forwarded.
Exclude Filter This filter is exclusive and only those devices or attributes in the filter will NOT be forwarded.
Users would invoke this filter when all Alerts should be forwarded with the exception of some specific device or
attribute.
Example I want to see all Alerts except for Device XYZ.
5.12.1
Alert Forwarding Process
Page 68
CheetahXD
User Guide
System Setup
System
CheetahXD
UserSetup
Guide
Each Alert generated by CheetahXD follows the same filtering process on its way to the third-party listener. The Alert
is first evaluated by the Include criteria portion of the filter and then passed onto the Exclude criteria portion of the
filter to be evaluated. If the Alert matches any of the Exclude criteria, it is dropped and not forwarded.
Page 69
CheetahXD
User Guide
System Setup
5.12.2
1.
2.
System
CheetahXD
UserSetup
Guide
Steps to Setup JMX Filtering
Make a copy of the example file. The new file must be called JmxAlertFilters.xml.
Open the file for editing. The example file below is a filter that says:
a. Include only those alerts from the device DOCSIS_00103fe2a829 but exclude Alerts from the device if they
are for the Return Laser 4 attribute
<com.tollgrade.cable.ccms.jmxagentutil.CTJMXAlertFilter>
<includeAlertCriteria class="vector">
<com.tollgrade.cable.ccms.devicemodel.hfccommon.CTHFCAlert>
<source>DOCSIS_00103fe2a829</source>
</com.tollgrade.cable.ccms.devicemodel.hfccommon.CTHFCAlert>
</includeAlertCriteria>
<excludeAlertCriteria class="vector">
<source>DOCSIS_00103fe2a829</source>
<alarmingAttachment>Return Laser 4</alarmingAttachment>
</excludeAlertCriteria>
</com.tollgrade.cable.ccms.jmxagentutil.CTJMXAlertFilter>
HINT: Any entry, even a NULL entry, in either section of the filter gets evaluated. If you do not need to use one of the
filter types, it is best to completely remove those entries from the active file. For example if we only want to exclude
alerts from a device with the source name of DOCSIS_00103f112233, the JmxAlertFilters.xml file would look like the
following:
<com.tollgrade.cable.ccms.jmxagentutil.CTJMXAlertFilter>
<excludeAlertCriteria class="vector">
<source>DOCSIS_00103f112233</source>
</excludeAlertCriteria>
NOTE: The JMX Forward Filter features is for Alerts only so system Change Notification will still be forwarded. For
example if a device is added to the exclude portion of the Filter goes into a Time Out state, the Critical Alert will
not be forwarded but the moChangeNotification message will be forwarded.
</com.tollgrade.cable.ccms.jmxagentutil.CTJMXAlertFilter>
Page 70
5.12.3
Using the
System
Dashboard
Setup
Appendix
The following parameters can be used in the JmxAlertFilters.xml file:

id
alarmField1
gatewayPar (Display Name)
alarmField2
modTime
alarmField3
severity
alarmField4
priority
alarmField5
createTime
alarmField6
category
alarmField7
who
alarmField8
attributeName
alarmField9
webNMS
alarmField10
webNMS
stateChangeCount
entity
groupName
source
topLevelPar
deviceCategory
currentValue
limitViolated
alarmingAttachment
Page 71
Using the Dashboard
Using the Dashboard
The Dashboard page on CheetahXD contains three tabs: Dashboard, KPI Scorecard, and Outage Analyst.
6.1
Dashboard
The Dashboard Tab displays a global picture of the system status through a series of configurable modules. Valuable
information about the system is shown through data points on each module.
Figure 6-1: Dashboard Tab

This presentation layer is tied to a user's account and can be configured to display different modules to executives,
managers, engineers, operators, and other user types. However, the standard interface displays the menu buttons
and modules found in the links below:
Page 56
CheetahXD
Using
the Dashboard
User Guide
6.1.1
Using
CheetahXD
the Dashboard
User Guide
Menu Buttons
The Dashboard tabs menu buttons contain module preference-related buttons displayed in orange, and
configuration buttons displayed in blue.
Figure 6-2: Dashboard Tab - Menu Buttons

The module preference buttons include:
Map Preferences
The Map preference button opens the Map Preferences dialog box to configure the possible Domain
and Severity selections of devices displayed in the Map module.
Figure 6-3:Map Preferences Dialog Box

The options on this dialog box include:
Domain Name
Select one domain of devices to be displayed on the map.
o Power
o Optical
o Video
o Network
Severity
Select one or more severities of devices to be displayed on the map.
o
Good
o Minor
o Major
o Critical
o In Standby
Page 57
CheetahXD
Using
the Dashboard
User Guide
Using
CheetahXD
the Dashboard
User Guide
Top Alarm Preferences

The Top Alarm Preferences dialog box configures the Domain and Severity type of the alarms shown in
the Recent Alarms module.
Figure 6-4: Top Alarm Preferences Dialog Box

Select Tree
The Select Tree button opens the Select Tree dialog box which displays the available trees on the
system, and can change the information displayed in every module, restricting the displayed devices to
those assigned to the selected tree.
Figure 6-5: Select Tree Dialog Box
Page 58
CheetahXD
Using
the Dashboard
User Guide
Using
CheetahXD
the Dashboard
User Guide
Tile Select
The Tile Select button opens the Tile Select dialog box, which displays a list of each tile on the
Dashboard, and can hide or display a tile if the checkbox for the tile is selected or not.
Figure 6-6: Tile Select Dialog Box

The tiles listed include:
Map
Provisioned Devices
Top 10 Alarms
Domain Status
Optical Fault
Power Fault
System Health
6.1.2
Modules
The modules displayed on the Dashboard can be configured for each specific logged-in user. For instance, a user
logged as an Administrator could see every module, but a NOC-level user may only see modules configured for the
users group.
The default layout of the Dashboard contains the following modules:
6.1.2.1
Map
The Map module displays the location and status of each device in the network filtered by the selected tree. Hover
over an icon on the map to view the name of the device associated with the icon.
Figure 6-7: Map Module
Page 59
CheetahXD
Using
the Dashboard
User Guide
Using
CheetahXD
the Dashboard
User Guide
Each device is shown on the map in the color corresponding to the devices status. The possible status colors
include:
Red Out of Service
Orange Needs service soon
Yellow Operational, but with minor problems
Green Properly working
Clicking on an icon, or clicking the device listing to the right of the map, will launch a browser window containing the
devices internal web page.
Figure 6-8: Internal Web Page Example

Click and drag the
button onto a desired location on the map to view street-level images of the device location,
or use the + or - buttons to zoom in on the location of a device.
Additionally, click the Satellite button to view the device locations topography from above, or the Map button to view
a map of the device locations.
Page 60
CheetahXD
Using
the Dashboard
User Guide
6.1.2.2
Using
CheetahXD
the Dashboard
User Guide
Provisioned Devices
The Provisioned Devices module displays the number of devices according to their provisioning status, grouped by
device type.
Figure 6-9: Provisioned Devices Module

Hovering over a bar chart will show the number of devices. Chassis, Transponder, and EOL devices are listed as
being the following:
In Sync the data for the device matches the database and template
Not Provisioned the device has no configuration template downloaded
Requires Download the configuration template needs to be downloaded again
Mismatch the device configuration does not match the template
Clicking on any bar chart will launch the Network Inventory applet.
Figure 6-10: Network Inventory Applet

Maximize the Provisioned Devices module by hovering the mouse cursor over the module and selecting the Expand
button.
The Provisioned Devices module will then display as full screen.
Click the Minimize button
to view the Dashboard again.
Page 61
CheetahXD
Using
the Dashboard
User Guide
6.1.2.3
Using
CheetahXD
the Dashboard
User Guide
Recent Alarms
The Recent Alarms module displays the last 10 alarms in the system, up to 6 hours ago.
Figure 6-11: Recent Alarms Module

Clicking on an alarm will open the Notifier Faults applet.
Figure 6-12: Notifier Faults Applet

Maximize the Recent Alarms module by hovering the mouse cursor over the module and selecting the Expand
button.
The Recent Alarms module will then display as full screen.
6.1.2.4
Domain Status
Use the Domain Status module to view statistics of the overall alarm status of each domain in the system, filtered by
the selected tree.
Page 62
CheetahXD
Using
the Dashboard
User Guide
Using
CheetahXD
the Dashboard
User Guide
Figure 6-13: Domain Status Module
Page 63
CheetahXD
Using
the Dashboard
User Guide
Using
CheetahXD
the Dashboard
User Guide
Selecting any of the areas on the graph will open the Domain Details page showing detailed domain information for
the selected subset.
Figure 6-14: Domain Details Page

From this page each of the devices listed can be located on a map by first selecting the device(s) then clicking the
Map Selected Device(s) button. The Mapped Devices page will open.
Use the Mapped Devices page to view directions to the device(s) by selecting each desired device in the Select Route
Points list, and then click the Quickest Route button. The map will update to show a path to the device(s) from the
users location and directions to the device(s) will display in the pane below.
Figure 6-15: Mapped Devices Page
Page 64
CheetahXD
Using
the Dashboard
User Guide
Using
CheetahXD
the Dashboard
User Guide
Maximize the Domain Status module by hovering the mouse cursor over the module and selecting the Expand
button.
The Domain Status module will then display as full screen.
Page 65
Using the Dashboard

CheetahXD
User Guide
6.1.2.5
Using
CheetahXD
the Dashboard
User Guide
Optical Fault
Use the Optical Fault module to view statistics of the overall alarm status of the Optical nodes in the network, filtered
by the selected tree. Hovering over any of the areas on the graph will show the number of alarms. Selecting any of
the areas on the graph will open a secondary window showing detailed device information for the selected subset.
Figure 6-16: Optical Fault Module

Selecting any of the areas on the graph will open the Domain Details page to show detailed domain information for
the selected subset, as shown in Figure 6-14.
Use the Mapped Devices page, as shown in Figure 6-15, to view directions to the device(s) by selecting each desired
device in the Select Route Points list, and then click the Quickest Route button. The map will update to show a path
to the device(s) from the users location and directions to the device(s) will display in the pane below.
Maximize the Optical Fault module by hovering the mouse cursor over the module and selecting the Expand button.
The Optical Fault module will then display as full screen.
6.1.2.6
Power Fault
Use the Power Fault module to view statistics of the overall alarm status of the power supplies in the network,
filtered by the selected tree. Selecting any of the areas on the graph will open a secondary window showing detailed
device information for the selected subset.
Figure 6-17: Power Fault Module

Selecting any of the areas on the graph will open the Domain Details page to show detailed domain information for
the selected subset, as shown in Figure 6-14.
Page 66
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
Page 67
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
Use the Mapped Devices page, shown in Figure 6-15, to view directions to the device(s) by selecting each desired
device in the Select Route Points list, and then click the Quickest Route button. The map will update to show a path
to the device(s) from the users location and directions to the device(s) will display in the pane below.
Maximize the Domain Status module by hovering the mouse cursor over the module and selecting the Expand
button.
The Domain Status module will then display as full screen.
6.1.2.7
System Health
This module displays statistics of the CheetahXD Server host computer. The module initially displays the CPU
Utilization in Percent or the Memory Utilization in Percent. Clicking on the module will open the System/JVM
Performance page to view additional statistics.
6.2
KPI Scorecard
The Key Performance Indicator (KPI) Scorecard page works in conjunction with 3349 transponder firmware 4.7.0
and greater to show a series of informational graphs that depict ongoing system metrics. Data to populate the
graphs is sent daily in the form of SNMP traps from the transponder(s) to all configured trap destinations. This data
can then be viewed by Power Supply Analysis, Standby Time Amount, and other metrics based on the selected time
period.
Figure 6-18: Key Performance Indicator (KPI) Scorecard Page

Note: To prevent unwanted traps, this feature is disabled in the transponder by default. This feature is enabled by setting
the Enable Tracking Traps nominal value to 2 on either the Device Configuration or Template Admin page of the desired
transponder.
The KPI Scorecard page can display information based on both the Power and Optical domains and the desired Tree.
To change the Tree to which the devices are assigned, see the Change the Device Tree section on page 69 for more
information.
The KPI Scorecard page is divided into three primary areas:
Page 68
Using the Dashboard

CheetahXD
User Guide
6.2.1
Using
CheetahXD
the Dashboard
User Guide
Main Menu
The KPI Scorecard page's Main Menu contains the following buttons:
Reset All
Select the Reset All button to return the values of the KPI Scorecard fields to their
original settings.
Get Data
Select the Get Data button to generate the graphs.
Domain Options
Power Displays Power Supply-specific parameters in the Select Metric
drop-down menu.
Optical Displays Fiber Node-specific parameters in the Select Metric dropdown menu.
NOTE: The menu options will change depending on the domain selected.
Select Range
Use this dropdown menu to select data only within a specific date range. Data will
be presented within the following ranges:
Rolling Year Previous 365 days starting with the current date
Rolling Month Previous month starting with the current date
Rolling Week Previous week starting with the current day
3 Months Previous three months
Year To Date Beginning of the calendar year to the present date
Select Metric
Use this dropdown menu to select the Metric used. The metric used is
determined by the domain selected (Power or Optical).
If the Power domain is selected, the following metrics will be available:
PS Voltage Analysis
Voltage input and voltage output of a commercial power supply.
Battery Voltage Analysis

This metric compares battery voltage over time to detect defective or
unstable batteries, or to detect instability in the battery's overall energy
storage.
Power Analysis
Combination of all electrical current used through the power supplys power
insertion
Major/Minor Alarm Counts

Displays the number of times a major or minor power supply alarm has
been generated.
Total Standby Runtime

Time in standby for the power supply over the selected time period.
Standby Event Counts

Amount of standby events during the time period selected.
Page 69
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
If the Optical Domain is selected, the following metrics will be available:
Receiver the Optical Receiver, Optical Amp, or Optical Switch Receiver

power
Return Laser the Return Laser Transmit power
Select Device
Use this menu to display graphs based on a single device or a set of the Worst 8
devices.
6.2.2
Graph Display Area
The Graph Display Area displays the graphs based on the information provided in the main menu. To generate the
graphs, select the Get Data button.
6.2.3
Detail Menu
The Detail Menu area of the KPI Scorecard page displays Graph Type menu options to display Line or Bar graphs and
Sort By options to sort the graphs.
Figure 6-19: Line Graph
Figure 6-20: Bar Graph
Further down the page, the Legend is automatically shown when a user hovers the mouse cursor over a graph. The
Legend displays information identifying the points on the graph.
Figure 6-21: KPI Scorecard Page Legend

NOTE: Clicking on a plot point on the Legend will remove the plot point from the graph. To reset the graph with all of the
plot points again, click the Reset All button followed by the Get Data button.
Page 70
Using the Dashboard

CheetahXD
User Guide
6.2.4
Using
CheetahXD
the Dashboard
User Guide
View Graphs
View graphs on the KPI Scorecard page using the following steps:
1.
Select the desired domain: Power or Optical.
2.
Select the date Range. Options include:
3.
a.
Rolling Year
b.
Rolling Month
c.
Rolling Week
d.
3 Months
e.
Year to Date
Select the desired Metric. Options include:

a.
PS Voltage Analysis
b.
Battery Voltage Analysis
c.
Power Analysis
d.
Major/Minor Alarm Counts
e.
Total Standby Runtime
f.
Standby Event Counts

OR
g.
Receiver
h.
Return Laser
4.
Select a specific device or the Worse 8 selection from the Select Device drop-down menu.
5.
Click Get Data. The graphs will display below the menu bar.
NOTE: If graphs are already displayed on the page, and the Domain, Range, Metric, or Device menus are changed the
graphs will become gray.
6.2.5
View Detailed Graph Information
Each graph may have multiple devices and data points. Each of these data points can be identified on the graph
itself or on the Legend located in the bottom left-hand corner of the KPI Scorecard page.
Identify a Data Point on a Graph On a desired graph, hover the mouse cursor over a data point. An
informational popup will display the data points place on the graph and the date and time of the data point
instance.
Page 71
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
Figure 6-22: Data Point Close-up
Identify Data Points on the Legend Use the Legend to view the devices related to the data points. To view
the devices, hover the mouse over a desired graph. The Legend will automatically display the devices listed
with the identifying colors.
Remove Data Points Plot points on each graph can be removed by clicking the corresponding plot point on
the legend for the graph. To reset the graph with all of the plot points again, click the Reset All button
followed by the Get Data button.
6.2.6
Change the Device Tree
Filter which device information is shown by changing the Device Tree. The Device Tree is changed using the Select
Tree button.
Select the Select Tree button at the top right-hand corner of the page. This opens the Select Tree dialog box. Choose
the desired tree then close the dialog box.
Figure 6-23: Select Tree Dialog Box

The name of the selected tree will appear to the right of the CheetahXD header, the KPI Scorecard page will reset,
and the available devices will be filtered to the selected tree.
6.2.7
Reset the KPI Scorecard Page
Click the Reset All button to clear the displayed graphs and return the selection buttons and drop down menus to
their default settings.
6.3
Outage Analyst
The Outage Analyst is an interactive GIS-based map that displays the overall performance of fiber nodes and any
associated power supplies in the network. The network topology and status is shown with icons displaying the name,
location, and transmission path of each fiber node in the network, along with any associated power supply
connections.
Each icon can represent a headend, hub, GX2, fiber node, or power supply. The shape of the icon depicts the device
type:
Fiber nodes are depicted as diamond-shaped icons
Power Supplies are shown as hexagonal-shaped icons
Headends, hubs, and GX2s are shown as circle-shaped icons
Page 72
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
The color of an icon also depicts the status of the device:
Page 73
Using the Dashboard

CheetahXD
User Guide
Red
Orange
Yellow
Green
Using
CheetahXD
the Dashboard
User Guide
Out of Service
Needs service soon
Operational, but with minor problems
Properly working
NOTE: By design, alarm color alerts do not update immediately. Please allow a few minutes for the alarm color to change.
Transmission paths between the fiber nodes also help to isolate and locate faults in the network. Each transmission
path is depicted as a line between fiber nodes and can be assigned as an upstream or downstream path.
6.3.1
Configuring the Outage Analyst
The Outage Analyst is configured using the Outage Analyst Designer, and can be found by navigating to Domain
Options > HFC Domain > Opt Analyst Design.
Figure 6-24: Outage Analyst Designer

The Outage Analyst Designer is composed of a large map showing the configured devices, buttons to display a help
window and to change the tree associated with the currently displayed network, and two windows on the right side of
the page: the Add Device and Hover window.
The map portion of the Outage Analyst Designer displays a full-screen depiction of the Outage Analyst with each fiber
node displayed as a pink or blue diamond depending on its connection status (connected implies there is a fiber
Page 74
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
node span or power supply connection connecting it to another upstream device). Each power supply is shown as a
pink or blue hexagon and each headend, hub, or GX2 as a grey circle. The relationships between the devices are also
Page 75
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
shown. Upstream fiber span relationships are shown in green and downstream relationships shown in blue. Power
supply connections are shown in dark blue.
Select the Help button to open a Help window. The Help window lists an Icon legend for the designer and basic help
instructions.
Figure 6-25: Help Window

Additional details for each device can be seen in the Hover window. Hover the mouse cursor over the desired device
to display the name and, if applicable, any contained fiber endpoints in the Hover window. The name and GPS
coordinates of the device will also appear above the devices icon.
Figure 6-26: Hover Window

6.3.1.1
Add a Device to the Outage Analyst
1.
Select the tree for the desired network.

Click the Select Tree button, select the desired tree, then click Close. The Outage Analyst Designer will
update to display only the selected trees devices.
2.
Use the map to navigate to the desired location of a new device to be added to the map.
3.
On the desired location, click on the map.
Page 76
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
The Add Device panel will open displaying a list of available devices. Clicking the + or - icons will expand
or collapse device groupings for Headend/Hubs/GX2s, Power Supplies, and Fiber Nodes.
Page 77
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
Figure 6-27: Add Device Panel

4.
Select the radio button for the desired device.
5.
Click Add.
The device icon will appear on the map and the location properties are recorded to the devices device
configuration location field as GPS coordinates.
Figure 6-28: New Device Icon
Figure 6-29: Configuration Location Field

6.3.1.2
Relocate a Device
Devices on the Outage Analyst map can be relocated by clicking and dragging the device to a new place on the map.
The new location information will be recorded in the devices location field as GPS coordinates.
6.3.1.3
Remove a Device
1.
On the Outage Analyst map, select an existing device.

This opens the Edit pane.
2.
Click the red Delete button.

The device will disappear from the map.
Note: Even when a device is removed from the map the devices location information is still saved to the database.
Therefore, if the map is redrawn the device will reappear.
6.3.1.4
Add a Fiber Span Connection between Two Devices
Page 78
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
A Fiber Span connection connects a fiber node to headends, GX2 devices, or other fiber nodes. The Outage Analyst
Designer can be used to create multiple combinations of Fiber Span connections.
Page 79
Using the Dashboard

CheetahXD
User Guide
1.
Using
CheetahXD
the Dashboard
User Guide
On the Outage Analyst Map, select a desired downstream fiber node.

The Edit Downstream Node pane will appear.
Note: Fiber spans are always referenced from the downstream fiber node in the network connection.
2.
Enter the Span Name between the two devices.
3.
Select the radio button of the upstream connecting device.

Note: Use the mouse cursor to hover over the bullet points of the list of devices to locate the device on the
map. The highlighted devices color will temporarily change to yellow.
4.
Select the Fiber Span Type.

Select Upstream To or Downstream From.
5.
Click Next.
If the Upstream To relationship type is selected, the Edit Node pane will display any unassigned Return
Laser endpoints contained within the downstream fiber node that is available to be assigned as an
origination endpoint in the upstream Fiber Span.
If the Downstream From relationship type is selected, the Edit Node pane will display any Outage Receiver
endpoints contained within the downstream fiber node that are available to be assigned as termination
endpoints in the downstream Fiber Span.
6.
Select the desired checkbox(es) of the Return Laser(s) or Outage Receiver(s) endpoints.
7.
Click Save.
The connecting line displaying the Fiber Span between the two nodes will appear on the map in green or
blue depending on the Fiber Span type.
6.3.1.5
Add a Power Connection between a Node and a Power Supply
Power Connections connect power supplies to fiber nodes. Use the Outage Analyst Designer to create Power
Connections between power supplies and fiber nodes.
1.
On the Outage Analyst Map, select a desired Power Supply.

This opens the Edit Power Supply pane.
2.
Enter the Power Connection name between the two devices.
3.
Select the radio button of the fiber node that is powered by the selected power supply.
Note: Use the mouse cursor to hover over the bullet points of the list of fiber nodes to locate the fiber node
on the map. The highlighted fiber nodes color will temporarily change to yellow.
4.
Click Add.
The connecting line displaying the Power Connection between the power supply and node will appear on the
map in dark blue.
6.3.1.6
Edit a Fiber Span or Power Node Connection
Fiber Span or Power Connections can be edited on the Outage Analyst Designer page. Select an existing device to
open the Edit Fiber Span or Power Connection window pane.
Note: If any other page is displayed in the Edit pane, click the Cancel button before selecting the existing device.
If the connection is a Fiber Span, change the Span Name, the transmit/receive endpoints, or both and then click
Save to keep the changes or Cancel to close the pane without saving the changes.
Page 80
Using the Dashboard

CheetahXD
User Guide
Using
CheetahXD
the Dashboard
User Guide
If the connection is a Power Connection, change the Span Name and then Save to keep the changes or Cancel to
close the pane without saving the changes.
6.3.1.7
Remove a Relationship between Two Nodes
1.
Click on the line connecting two nodes.

The Edit Relationship popup window will appear.
2.
Click the red Delete button.

The line connecting the two nodes will disappear from the map.
Page 81
Using the Dashboard

CheetahXD
User Guide
6.4
Using
CheetahXD
the Dashboard
User Guide
Outage Analyst Viewer
The Outage Analyst Viewer displays a graphical map of configured devices within a specific geographic area.
To access and use the Outage Analyst Viewer
1. Navigate to the Dashboard.
2. Navigate to the right side of the Dashboard and click the Outage Analyst Tab (bottom tab located on the
right edge of the screen).
3. Hover over an Item to display the Device Name, Address and IP Address.
4. Click on the desired device/element to display more information, e.g.:
- click on a Span Arrow to display the Span Name and Related Modules
- click on a Power Supply, Node, Hub or Headend icon to open the corresponding informational web page.
NOTE: Refer to Section 6.3.1 for more information on editing/configuring the Outage Analyst Viewer.
Following are the rules for the Outage Analyst alarm displays:
-
If there is a loss of communications with a transponder (ps or node) the downstream icon and span(s) will
be red.
If there are no alarms with the transponders (ps or node) the downstream icon and span(s) will be green.
If there is any major alarm for the power supply the icon and span will be orange.
If there is any minor alarm for the power supply the icon and span will be yellow.
If the Optical Power of all endpoints for a node span is in a major alarm state, the span will be orange.
If the Optical Power of any (but not all) endpoint for a node span is in any alarm state (major or minor), the
span will be yellow.
If the Optical Power off all endpoints for a node span is in a minor alarm state, the span will be yellow.
If there is a mixture of major and minor Optical Power alarms for the endpoints of a span the span will be
yellow.
If there is any minor alarm for the node the downstream icon will be yellow.
Page 82
Using the Dashboard

CheetahXD
User Guide
-
Using
CheetahXD
the Dashboard
User Guide
If there is any major alarm for the node the downstream icon will be orange.
Page 83
The Tree Viewer
The Tree Viewer
CheetahXD displays all managed elements in the physical network using a hierarchical tree format. The Tree Viewer
is the GUI (Graphical User Interface) used by the operator to view and edit network trees.
7.1
The Tree Viewer Components
The Tree Viewer GUI consists of the Tree Control pane, the Primary pane, the Properties/View Editing pane, and the
Log pane. The size of the Primary, Properties/View Editing, and Log panes can be adjusted by using the appropriate
splitter bar. Likewise, these panes can be hidden and revealed by clicking on the appropriate splitter arrow button.
Each pane is discussed in more detail in the sections that follow.
Figure 7-1: Tree Viewer Components

7.1.1
The Tree Control Pane
The Tree Control Pane contains a tree selection drop down box, a tool bar for performing operations on the tree
displayed in the Primary pane, and a counter for keeping track of the number of items in the tree that are selected at
any given time. (See Section 7.1.5 for more information on the tool bar buttons.)
7.1.2
The Primary Pane
The Primary Pane is the main tree display window. The tree displayed in the Primary pane is determined by the tree
name selected in the drop-down box of the Tree Control Pane.
7.1.3
The Properties and View Editing Pane
The Properties and View Editing Pane performs two separate functions:
When the Properties tab is selected, the properties of the device highlighted in the Primary Pane are displayed in
the Properties pane. (The values displayed with blue text represent configurable values. The values displayed with
black text represent non-configurable values.)
When the View Editing tab is selected, the pane becomes an area to create new trees, edit existing trees, or view
a second tree next to the tree displayed in the Primary pane.
The View Editing pane cannot be used to display the same tree that is already being displayed in the Primary pane. If
you select the tree from the View Editing drop-down menu that is already displayed in the Primary pane, you will
receive an error message.
Page 76
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
The following example illustrates the use of the Properties tab. The values displayed with blue text represent
configurable values. The values displayed with black text represent non-configurable values.
Figure 7-2: Tree Viewer - Properties Tab

The following example illustrates one use of the View Editing tab. The View Editing pane cannot be used to display
the same tree already on display in the Primary pane. Viewing, creating, and editing existing trees will be discussed
in greater detail later in this chapter.
NOTE: You cannot view the same tree in the Primary and View Editing panes at the same time.
Page 77
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
Figure 7-3: Tree Viewer - View Editing Tab
Page 78
CheetahXD
The
Tree Viewer
User Guide
7.1.4
CheetahXD
The Tree
UserViewer
Guide
The Log Pane
The Log pane provides the operator with a real time visual feedback loop that displays the activity data being logged
by the system.
7.1.5
The Tree Viewer Tool Buttons
The Tree Viewer GUI has a main tool bar located in the Tree Control Pane, and a mini tool bar that is available only
when the View Editing tab is active. Some of the tool buttons are present on both tool bars, while others are unique
to their specific tool bar. The following table provides a quick reference of each tool button, along with a brief
description of its related function. The table also specifies if the button is unique to one specific tool bar or is
available on both.
Tool Button
Description
Location
Tree Control
View Editing
Pane
Pane
Locates resources within the tree. This feature is discussed

in greater detail in the section entitled Finding Resources in
the Tree, presented later in this chapter.
Yes
Yes
Refreshes the tree from the database. When the system

loads a tree view, it is a static view or snapshot of the
data at that time. Changes that are made to the database
while the view is open will not appear in the tree until the
tree view is manually refreshed. However, alerts (i.e., the
status icon colors) are dynamically updated.
Yes
Yes
Saves the tree visibility state. This saves a visual

representation or snapshot of the tree.
Yes
Yes
Closes the tree view.
Yes
Yes
Sorts the tree alphabetically. Pressing the button a second

time restores the organization back to the original order the
tree had at the time it was loaded.
Yes
No
Stops the alert processing.
Yes
No
Page 79
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
Swaps the tree views. The tree displayed in the Primary

pane will now be displayed in the View Editing Pane and
vice-versa.
Page 80
Yes
No
CheetahXD
The
Tree Viewer
User Guide
Tool Button
7.2
CheetahXD
The Tree
UserViewer
Guide
Description
Location
Tree Control
View Editing
Pane
Pane
Edit the tree. To access this function, the operator must

have the appropriate permission(s) and the tree must
modifiable.
No
Yes
Delete the tree. To access this function, the operator must

have the appropriate permission(s) and the tree must
modifiable.
No
Yes
Add new nodes to the tree. To perform this feature, the

operator must have the appropriate permission(s) and have
access to the native tree. This button's function is discussed
in more detail in the section entitled Creating Network
Elements presented later in this chapter.
No
Yes
Delete nodes from a tree. This buttons function is

discussed in more detail in the section entitled Deleting
Trees or Network Elements presented later in this chapter.
No
Yes
New Tree View. Use this function to create a new, custom

tree. To access this function, the operator must have the
appropriate permission(s). This buttons function is
discussed in more detail in the section entitled Creating
New Tree Views presented later in this chapter.
No
Yes
Tree Structure, Tree Types, and Tree Elements
Every tree, regardless of type, displays the devices or elements it contains according to a predetermined hierarchy.
Each element in the tree is assigned an icon. This icon, which is displayed to the immediate left of the elements
device description, provides the user with a graphical representation of the network element, and makes the tree
elements easy to identify. In addition, when trees are displayed in the Primary pane of the Tree Viewer, CheetahXD
assigns a status icon to each device. This icon, located to the far left of each device, changes color as the devices
status changes. It is dynamically updated by the system, thereby providing the user with a visual indicator of each
devices status in real time.
In situations where elements in the tree contain subordinate or child elements, the status icons provide a rolled
up and rolled down feature. When the branch of a tree contains an element with collapsed child elements
beneath it (i.e., the child elements are not visible), the worst case status of any of the child elements is displayed by
the parent elements status icon. This is considered to be a rolled up status. Conversely, when the same tree
branch is expanded (i.e., the child elements are visible), the status icon of each element displays its own status
(the status is said to be rolled down).
Page 81
The Tree Viewer

CheetahXD
User Guide
7.2.1
CheetahXD
The Tree
UserViewer
Guide
The Tree Structure Hierarchy
Every tree, regardless of type, displays network elements according to the following hierarchy:
Headend Controllers and GX2 shelves
Gateway Objects transponders
Top-level Devices Power Supplies, Fiber Nodes, etc.
Attachments Batteries/Strings (for power supplies)
Attributes Voltage, temperature (for a power supply).
7.2.2
The Native Tree View
The native view (considered the communications, main, or home view) displays all of the managed network
elements, grouped by their communications relationships.
Regardless of where elements are displayed, they always exist in the native view. Deleting an element from the native
view deletes it (and all of its child devices) from all views in which it appears, and also deletes it (and all of its child
devices) from the database! If the element is subsequently autodiscovered, it can be reconfigured and returned to its
previous positions in the tree views. If devices connected to a HEC are deleted, they are deleted from the HECs
memory, as well.
Think of the native view as the representation of the entire database, and all other views as subsets of it.
7.2.3
The HFC Tree View
The HFC (Hybrid Fiber Coaxial) view is a subset of the native view. It displays all headend controllers (HECs) and
virtual headend controllers (vHECs), as well as the associated devices with which they communicate, such as nodes,
amplifiers, power supplies, and generators.
7.2.4
The IP Tree View
The IP View is a subset of the native view and displays all discovered and licensed VoIP transponders and their
devices. The proper license must be installed to access this tree view.
7.2.5
Accessing Tree Views via the Side Panel
Tree views can also be accessed via the Domain Options side panel.
Figure 7-4: Domain Options Side Panel

Under the Tree Views heading are options that apply to each type of tree. Some of these options apply to each tree,
while others are unique to a specific type of tree. The operations and functions of these options are described in
various chapters within this manual. The table that follows lists the option, the tree(s) to which the option applies,
and the name of the chapter that provides the details about the option.
Page 82
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Name of the Option
Applicable Tree Types
Chapter Name Containing Details About the Option
Fault View
HFC and IP
Fault Views Notifier and EFS Notifier
Tree View
HFC and IP
The Tree Viewer
Scheduler
HFC and IP
Scheduling Data Collection
Reports
HFC and IP
Reports
Configuration
IP
IP Domain
7.2.6
The Custom Tree View
The tree-viewer also displays custom tree views that have been created by administrative-level users. For information
on creating custom views, see the section entitled Creating New Tree Views presented later in this chapter.
7.2.7
Tree Status Icons
As mentioned earlier in this section, each element of the tree displayed in the Primary window is assigned a status
indicator icon by the system. The location of the icon is shown in Figure 7-5.
Figure 7-5: Status Indicator Icon

This icon, located to the far left of each device, changes color as the devices status changes. It is dynamically
updated by the system, thereby providing the user with a visual indicator of each devices status in real time. In
situations where elements in the tree contain subordinate or child elements, the status icons provide a rolled
up and rolled down feature. When the branch of a tree contains an element with collapsed child elements
beneath it (i.e., the child elements are not visible), the worst case status of any of the child elements is displayed by
the parent elements status icon. This is considered to be a rolled up status. Conversely, when the same tree
branch is expanded (i.e., the child elements are visible), the status icon of each element displays its own status
(the status is said to be rolled down).
In the two illustrations that follow, the first illustration shows a HEC in the rolled up state. The color of the HECs
status icon is red, indicating either the HEC or one of its child devices has a critical alarm. In the second illustration,
the same HEC is shown in the rolled down state. In this state, the color of its icon is not red, indicating the alarm
was not associated with the HEC, but with one or more of its child devices.
Figure 7-6: HEC Icon - Rolled Up State
Page 83
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Figure 7-7: HEC Icon - Rolled Down State
Page 84
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
The following table lists the different possible status icon colors and the meaning of each color.
7.2.8
Status Icon Color
Description of Status
Green
No Alarm
Purple
Maintenance Mode (polling is turned off)
Yellow
Minor Alarm
Orange
Major Alarm
Gray
Unknown Alarm
Red
Critical Alarm
Tree View Icons
Every tree, regardless of type, displays the devices or elements it contains according to a predetermined hierarchy.
Each element in the tree is assigned an icon. This icon, which is displayed to the immediate left of the elements
device description, provides the user with a graphical representation of the network element, and makes the tree
elements easy to identify.
The following table lists the icons used by CheetahXD, and a description of each icon.
Icon
Definition
root device
autodiscovered DOCSIS device(s) awaiting provisioning
Region
Hub
headend controller (HEC)
HEC modem port
HEC modem transmitter
HEC modem receiver
power supply
battery string
Battery
battery current attribute
HMS transponder | HMS power supply
Page 85
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
legacy fiber node transponder or a fiber node
Page 86
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Icon
Definition
optical receiver
VoIP test point
CMTS
CMTS interface or channel (upstream)
CMTS interface or channel (downstream)
CMTS standard
CMTS MAC interface
CMTS CM
cable modem
CMTS Ethernet interface
CheetahLight power supply
return path switch
CheetahNet system
CheetahNet HEC
CheetahNet legacy device
CheetahNet virtual headend controller (vHEC)
CheetahNet vHEC proxy
CheetahNet shelf module, CheetahNet chassis
CheetahNet amplifier
CheetahNet controller card
CheetahNet switch controller
CheetahNet modulator
CheetahNet demodulator
CheetahNet encoder
CheetahNet decoder
Page 83
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
CheetahNet laser receiver

CheetahNet laser transmitter
Page 84
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Icon
Definition
CheetahNet upconverter
CheetahNet downconverter
CheetahNet power supply
CheetahNet headend power supply
CheetahNet optical switch or unknown device
CheetahNet multi-IO, CheetahLight site monitor
CheetahNet multiplexer
CheetahNet legacy device test point/SM II
A generator
DC power
AC power
The presence of child devices. Click to display the child
devices.
The elements child devices are displayed. Click to
collapse the child device portion of the tree.
HEC Modem
A/B switch
Optical Receiver
SM II
DC power (legacy device)
7.3
Using the Tree Viewer
Using the Tree Viewer, the operator can create new trees, edit and delete existing trees, view two different trees
simultaneously, access local device menus from the tree, and more. This section presents more detailed information
on how to perform the various Tree Viewer functions and utilize the features it provides.
7.3.1
Accessing the Local Device Menus from the Tree
To display an elements local menu, right-click on the entry in the tree:
Page 85
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Figure 7-8: Local Device Menu

The elements local menu displays.
Figure 7-9: Element Local Menu

Different elements display slightly different options on their local menus. Some options, such as the Maintenance
Mode option, must be accessed from submenus.
The following table describes the options on the local menus, what type of element the option applies to, and what
function it performs.
Menu Option
Maintenance Mode Off
Maintenance Mode On
Lock Poll
Applicable Devices
Action
HEC, HMS/DOCSIS, CL, transponder

HEC, HMS/DOCSIS, CL, transponder
Transponders connected to a CL
HEC
Turns polling on.

Turns polling off.
Commands a HEC 360 to poll the
selected transponder. This feature is
useful for limiting the return path
communications to the transponder
so a spectrum analyzer can examine
the return path transmission signal
characteristics.
Page 86
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Menu Option
Applicable Devices
Action
High Power Poll
Transponders connected to a CL
HEC
Assists in isolating forward path

transmission problems. Polls the
selected transponder once at a
higher than normal downstream
power level, for one polling cycle
(including retries). If the transponder
does not detect the HEC 360 at the
normal transmit power level, but
does at the higher power level, this
indicates a forward path problem in
the cable plant. High Power Polling
does not interrupt normal polling and
alarm acquisition.
Cross Navigation
All devices
Device Configuration
All devices
Data Display
Transponders and child devices
Displays the device in other

trees/contexts.
Displays the elements configuration
information from the database.
Launches the Data Display module
in a separate browser tab or window.
Note that the new window is
essentially a pop-up. If your browser
is set to prevent pop-ups, this menu
option will not work.
Configuration Report
Status Report
Quick Alert Report
Download All
HEC, modem, HMS transponder
Download Changes
Download Alert Profile

vHEC
Download Transponder List
HEC
Rediscover
HEC, HMS/ DOCS
View Alerts Embedded
All devices
View Alerts Full Screen
All devices
Page
Page86
86
Produces a report of the elements

configuration information that can
be saved, printed, or exported.
current status that can be saved,
printed, or exported.
current alarm status that can be
saved, printed, or exported.
Performs a download of the current
configuration parameters for all
attributes.
Performs a download of the current
configuration parameters that have
been changed.
Performs a download of
configuration parameters from the
specified template or alert profile.
For HEC 360s, this option downloads
the HECs transponder list from the
database to the HEC in situations
such as when the HEC has been
replaced.
Performs a rediscover of the
element, restoring default
parameters.
Displays the device alerts within the
browser page.
Displays the device alerts without
browser menus, buttons, etc.
The Tree Viewer

CheetahXD
User Guide
Parent Alerts
CheetahXD
The Tree
UserViewer
Guide
All devices
Page
Page87
87
Will display alerts for each device

that is a Parent of the target device
in the selected tree.
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Menu Option
Applicable Devices
Children Alerts
All devices
All Related Alerts
All devices
Force Sync Alerts Now
HMS/DOCSIS transponders
Bulk Property Update
All devices
Reset Transponder
Transponders
7.3.1.1
Action
that is a Child of the target device in
the selected tree.
that is a Parent and Child of the target device in the selected tree.
Allows the operator to synchronize
the alarms present on the device
with the information in the database.
Updates the selected property value
in multiple devices at one time.
Resets the chosen transponder and
all of its children devices.
Related Alerts (Upstream/Downstream)
CheetahXD has added menu options to the Tree Viewer to launch a Notifier display of all alerts upstream or
downstream (separate selections) from a device as defined in a user-selected Tree View. With properly configured
trees, users will be able to see which devices are impacted by a specific alert in a targeted Topology, assisting in the
network troubleshooting effort.
Figure 7-10: View Alerts Menu

1.
2.
From a target device in a custom defined tree right click and select the View Alerts menu option.
There are 3 options related to viewing related alerts.
a. Parent Alerts - Will display alerts for each device that is a Parent of the target device in the selected tree as
well as alerts from the target child
b. Children Alerts - Will display alerts for each device that is a Child of the target device in the selected tree as
well as alerts from the target parent
c. All related Alerts - Will display alerts for each device that is a Parent or Child of the target device in the
selected tree as well as alerts for the target device
3. A filtered Notifier view in a new Tab will be displayed consisting of only those alerts associated with the options
chosen. The example below shows the parent device GX2 10.1.37.203 and the target child device of DOCSIS
00103f05f13e when View Alerts > Parent Alerts option was chosen from the menu.
Page
Page88
88
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Figure 7-11: Parent Device Alert View

7.3.1.2
Using the Bulk Property Update Option
Use the Bulk Property Update option to change a property value in a multitude of devices all at once. This feature will
update a selected device's property value and the same property value (if applicable) of all of its children devices.
This feature can also be performed on multiple devices at one time. In the first example shown below, the chosen
device and all of its children devices (if applicable) will receive the update information. In the second example both
devices and their children devices (if applicable) will receive the update information.
Figure 7-12: One Device Selected
Figure 7-13: Two Devices Selected

To use the Bulk Property Update
1.
2.
Highlight and then right-click on one or more devices in a tree.

From the menu, select the Bulk Property Update option.
This opens the Bulk Property Update window, as shown in Figure 7-14.
Figure 7-14: Bulk Property Update

3.
Select a property value from the drop-down list.
Page
Page89
89
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
4. Enter the value for the property and press Update. The results of the update are displayed in the Bulk Task
Status portion of the software. For details on the Bulk Task Status feature, please refer to the System
Administration chapter in this manual.
Page
Page90
90
The Tree Viewer

CheetahXD
User Guide
7.3.1.3
CheetahXD
The Tree
UserViewer
Guide
Using Force Sync Alerts Now
The Force Sync Alerts Now provides the operator with a way to synchronize the data in the database with the current
values on the device. These actions are particularly useful when troubleshooting a device or when out of sync
conditions may be noticed by the operator.
To use the Force Synch Alerts Now option
1.
From a tree view, right-click a device. On the menu select the Synchronize Alerts option, and then select Force
Sync Alerts Now.
2. The system will update or synchronize the database with the values from the unit. The system will display a
status message once the operation is complete.
7.3.2
Finding Resources in the Tree
The Tree Viewer provides a find feature in both the Primary and View Editing panes. The find feature is invoked
by pressing the Find Resource in Tree tool button.
resources in the tree.
The following procedure outlines the steps for finding
To Find Resources in the Tree

1.
Click the Find Resource in Tree icon.

The Find window appears.
Figure 7-15: Find Window
Text to Find field containing the text used to conduct the search
Property this drop-down box contains a list of device properties that are used to refine the search.
NOTE: If a device is not selected from the tree before the find function is initiated, the Display Name and Name properties
are the only two properties that will appear in the Property drop-down box.
Down option starts the search from the selected item and searches downward, stopping at the first match
Up option starts the search from the selected item and searches upward, stopping at the first match
Select All Down option starts the search from the selected item and searches downward and highlights all
matches in that direction
Select All Up option starts the search from the selected item and searches upward and highlights all
matches in that direction
Select All option highlights all matches in either direction
Use Wildcard option allows for the use of standard wildcard symbols (i.e., *, ?, etc.) when performing a
search
Page
Page91
91
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Match Case option instructs the search mechanism to select items that match the search text and the
case of that text
Page
Page92
92
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
Whole Word Only option instructs the search mechanism to select items that only match the search text
exactly (whole word).
2. Enter search text in the Text to find field.

3. Select a device property from the Property drop-down box. The system will search each device in the tree for the
text value specified in the Text to find field.
4. Choose the search direction option (i.e., up, down, etc.). If you would like to narrow the search, select any of the
other options (use wildcards, match case, or whole word only) accordingly.
5. Press the Find button. The system will highlight the device(s) that match the search criteria you just specified in
the Find window.
7.3.3
Displaying a Sub-Group of Tree Elements
Locating and viewing elements in large trees can be difficult and often involves a large amount of scrolling through
the tree. CheetahXD provides a mechanism for creating a temporary sub-group of elements from the tree in order to
facilitate the viewing of those elements. The following procedure outlines the steps for creating a temporary element
sub-group.
To Display a Sub-Group of Tree Elements
1.
Select two or more elements in the tree.
2.
Click on the Number of Nodes Selected button in the toolbar.

The Items Selected window appears.
Figure 7-16: Items Selected

3. Double-click on any element in the list and the system finds and highlights the element in the tree. By doubleclicking on the elements in the list, you can navigate through the tree quickly. The Item Selected window
remains open until the OK button is pushed.
7.3.4
Creating New Tree Views
Page
Page90
90
The Tree Viewer

CheetahXD
User Guide
CheetahXD
The Tree
UserViewer
Guide
CheetahXD provides every user with the native, FCC, HFC, and IP standard tree views. In addition to the standard
views, users with the appropriate privileges can create custom tree views. Custom tree views provide the user with
the ability to create trees that reflect specific viewing needs, such as by technician or by geographical area. The
following procedure outlines the steps for creating a custom tree view.
Page
Page91
91
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
To Create a New Tree View

1. From the View Editing pane, click on the New Tree View button. The New Tree window appears.
2. In the New Tree window, enter the name for the new tree view in the Name field. This name is combined with the
word root to form the name of the top level tree element. In this example, the name of the top element will be
Example Treeroot. The following restrictions apply to tree names:
3.
4.
The tree view name is mandatory

The maximum length for a name is 50 characters
The first character in the name must be an alpha character
The name may not contain spaces, tabs, carriage returns, line feeds, single or double quotation marks,
commas, periods, pound signs (#), percent signs (%), equals signs (=), forward slashes (/), or colons (:).
If desired, enter a description for the tree in the Description field. This description provides other users with
information they might find useful when editing the tree view in the future. The length of the description is
limited to 250 characters.
Select an owner from the Owner drop-down box.
Figure 7-17: New Tree Window

5.
Click on the New button to create the tree.

The new tree is displayed in the View Editing pane.
Populate your new tree view by copying or moving elements from existing tree views, or by creating new elements.
(Creating new elements using the tree viewer is discussed later in this chapter.)
Moving or copying elements within and among the various tree views does not change any information about the
elements in the database or in their configuration files. The views, therefore, cannot be restored to a default-type
view, should elements be moved to incorrect positions, such as under wrong parent elements.
Many of the actionssuch as using standard Windows <Shift>, <Ctrl>, and click combinationsapply to both the
move and copy operations. However, some subtle differences, and/or restrictions exist when performing a move
verses a copy operation. In general, you will find that you use the copy operation as the primary operation to fill new
tree views. The following lists highlight key items to remember while performing Copy and Move operations.
Key items to remember about performing a Copy or Move operation:
Items can only be moved or copied from trees in the Primary pane to trees in the View Editing pane.
Standard Windows operations (i.e., selecting multiple items using Ctrl, Shift, etc.) apply to either operation.
You cannot move or copy an element to a view that contains an element of the same name.
If you move or copy more than one element in a single drag and drop operation and one of the elements violates
any of the rules in these lists, that element will not be moved or copied, but the remaining elements that do not
violate any rules will be moved or copied.
Page
Page92
92
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
Key items to remember about performing a Move operation:
Page
Page93
93
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
You cannot move an item from any of the standard views (i.e., native, HFC, IP) to any other view. Moving an item
from the native view would alter records in the database and therefore is not allowed.
You can move items from one custom view to another custom view.
Move operations always move an elements entire branch. You can elect to copy an element with or without its
entire branch, but the move operation always moves an elements entire branch.
Key items to remember about performing a Copy operation:
You can copy an element from any of the standard (i.e., native, HFC, IP) or custom views.
You can elect to copy an element with or without its entire branch.
Pressing and holding the <Ctrl>, <Alt>, and <Shift> keys in various combinations while performing the drag and drop
operation results in different behaviors. In general:
The <Ctrl> key copies the dragged element instead of simply moving it.
The <Alt> key makes the dragged element a child of the selected target element, instead of a sibling. The
<Ctrl>, <Alt>, and <Shift> keys can be combined in one drag operation to produce the following results:
-
<Ctrl> + <Alt> Copy (destination child) operation
<Ctrl> + <Shift> Copy branch (destination sibling) operation
<Ctrl> + <Shift> + <Alt> Copy branch (destination child) operation
The mouse cursor changes during the drag operation, combining arrows and plus signs to signify the type of drag
operation you are performing. There are 7 drag-n-drop mouse cursor images:
A down arrow means the dragged element will be a sibling of (next to) the selected element.
A right-facing arrow means the dragged element will be a child of the selected element.
A single plus (+) sign means the drag is a copy operation.
A double plus (++) sign means the drag is a copy operation that is also copying the entire branch.
No plus (+) sign means the drag is a move operation.
The No symbol indicates that the element being dragged cannot be dropped at the cursor position.
Continue selecting, dragging, and dropping elements to create the desired configuration for the new tree view.
Page
Page94
94
CheetahXD
The
Tree Viewer
User Guide
7.3.5
CheetahXD
The Tree
UserViewer
Guide
Creating Network Elements
The auto-discovery and rediscovery processes will automatically add discovered elements to tree views, but
administrative-level users can manually create elements in the native tree view.
To create elements for other tree views, create them first in the native view and then copy them to the desired tree
view.
The operator can create a single new network element or a group of new network elements. Creating a group of new
network elements is called adding network elements in bulk. Both procedures are discussed in this section.
Creating Network Elements in a Tree View
Key items to remember about creating tree elements:
Items can only be created in the native tree view.

This operation must be performed from within the Properties/View Editing pane.
IMPORTANT!
Never create new elements in any tree view other than the native tree view. Always create new
elements in the native tree view and then copy them to other tree views.
1. In the View Editing tab, select the native view. Single-click the element in the tree that the new network
element(s) will be associated with (in a parent-child or sibling relationship).
2.
Click the Add New Node button.

This opens the Network Element(s) window, as shown in Figure 7-18.
Figure 7-18: Create New Network Element(s) Window
Name field containing the text used to define the name of the element(s)
Bulk when checked, the system creates a group of elements in bulk based on the information specified
in the other parameters.
Category drop-down list containing all of the available element types.
Page
Page95
95
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
Location determines if the element(s) will be a child or sibling of the element selected from the tree.
Page
Page96
96
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
Properties mandatory properties are property values that must be filled in by the operator before the
creation process can occur. These properties vary by element type and may not be present for some
element types.
3.
Enter the name of the element in the Name field.

If you are creating a single element, please proceed to Step 6.
4. To create a group of elements in bulk, click on the Bulk checkbox.
5. Specify the number of elements to create by using numbers and/or letters separated by commas and grouped
within a set of braces. This data should immediately follow the name text.
Example: New Name {1, 10}.
The system will create the number of devices indicated by the range, from the first letter or number to the last.
For example, typing {A, Z} will create 26 devices, named A, B, C, and so on. Similarly, typing {3, 6} will create four
devices, named 3, 4, 5, and 6. Figure 7-19 illustrates how the operator would create 10 power supplies as
children under native root.
Figure 7-19: Creating Multiple Network Elements

Once created, the tree will look very similar to Figure 7-20.
Figure 7-20: Multiple Network Elements

Specify as many ranges as desired. For example, typing both {A,Z} and {3,6} will create 104 devices named A3,
A4, A5, A6, B3, B4, B5, B6, and so on.
Everything you type outside the braces will be included in the device names, including spaces. For example,
typing Power Supply {3,6} will create four devices named Power Supply 3, Power Supply 4, Power Supply 5, and
Power Supply 6. Similarly, typing Power Supply {A,Z}#{3,6} will create one hundred and four devices named
Power Supply A#3, Power Supply A#4, Power Supply A#5, Power Supply A#6, Power Supply B#3, Power Supply
B#4, Power Supply B#5, Power Supply B#6, and so on.
To create left zero padding (so devices are named 01, 02, 03 instead of 1, 2, 3), type a zero before the first
number in the range, {01,10} rather than {1,10}. The system determines how many left zeros to use by looking
at how many integers are in the last number in the range. For example, typing {01,10} creates ten devices
named 01, 02, 03 and so on because the last number in the range contains two integers. But typing {01,010}
creates ten devices named 001, 002, 003, and so on, because the last number in this range contains three
integers.
To include the braces in the device name, place them in quotes. For example, typing Power Supply
{A,Z}#{3,6} creates one hundred and four devices named Power Supply {A}#1, Power Supply {A}#2, Power
Supply {A}#3, and so on.
Page
Page97
97
CheetahXD
The
Tree Viewer
User Guide
6.
CheetahXD
The Tree
UserViewer
Guide
Select an element type from the Category field.
Page
Page98
98
CheetahXD
The
Tree Viewer
User Guide
7.
8.
CheetahXD
The Tree
UserViewer
Guide
Select either the As Child of or As sibling of location button.

If any mandatory property parameters appear in the Properties field, fill the appropriate information as required.
The appearance of parameters in this field is determined by the selection made from the Category drop-down
list.
NOTE: Any mandatory property parameter values entered during the bulk creation process will be replicated for every
element created. These values will then have to be changed during the configuration step at the end of this
process.
9. Click OK to create the element.
10. Complete the process by configuring the new network element(s) using the Device Configurator. See section
titled Provisioning Devices for more details.
7.3.6
Deleting Trees or Network Elements
Key items to remember about deleting trees and elements:
When you delete an element from a native view, the element is also deleted from the database! Deleted
elements may be subsequently auto-discovered and can be reconfigured, but it is best to use extreme
caution when deleting elements from the native view.
When you delete an element from the native view, all branches (child devices) of the element are deleted
with it. To save the child devices, move them to another element or folder before deleting the parent
element.
When you delete an element from any view other than the native view, only the element is removed and
only from that view. The child devices remain in the view and the deleted element remains in the native
view.
Deleting elements from views other than the native view removes the element from that tree only. It does
not remove the element from the database.
The operator is not able to delete devices from the FCC, HFC, or IP views.
The standard trees (i.e., native, FCC, HFC and IP) cannot be deleted. Only custom, user-created trees can be
deleted.
Deleting a Tree View

1. In the View Editing pane, select the name of the tree view you wish to delete from the Tree View Name dropdown box.
2. Highlight the tree name in the View Editing pane.
3. Click the Delete Tree button.
The Delete confirmation window appears.
4. Click Yes.
Deleting Network Elements from a Tree View
1.
2.
3.
4.
In the View Editing pane, select the name of the tree view that contains the element you wish to delete from the
Tree View Name drop-down box.
Highlight the element(s) in the View Editing pane.
Click on the Delete Nodes button.
The Delete Network Element(s) confirmation window appears. Click the Yes button.
Page
Page99
99
CheetahXD
The
Tree Viewer
User Guide
CheetahXD
The Tree
UserViewer
Guide
This page intentionally left blank.
Page
Page100
100
CheetahXD
Network
Inventory
User Guide
CheetahXD
NetworkUser
Inventory
Guide
Network Inventory
CheetahXDs Network Inventory module offers the ability to manage the configuration of network devices from a single
location. The Network Inventory page provides both summary and detailed information about the configuration status
of the devices in the network.
To access the Network Inventory page, click Network Inventory at the top of CheetahXD main screen.
Figure 8-1: CheetahXD Menu

Choose a tree view to display in the Network Inventory page by clicking the View Name menu. Selecting Native will
display all managed elements in the network.
Figure 8-2: Tree Selection Drop Down Menu

The Network Inventory page is divided into two sections. The top half of the page summarizes the configuration
status of devices in the chosen network, grouped by device type.
Figure 8-3: Network Inventory Page

The bottom half of the page displays individual information for the device or devices selected in the top section. The
bottom half of the page is explained in greater detail in the sections that follow.
Page
Page101
101
CheetahXD
Network
Inventory
User Guide
CheetahXD
NetworkUser
Inventory
Guide
The columns display the total number of devices in a category (a device type):
Configuration Status
Possible Causes
Not Provisioned these discovered

devices have no configuration
parameters downloaded to them.
CheetahXD automatically associates
configuration templates with devices
it discovers in its network, but only
writes that information to its
database.
Template has not been downloaded

or Device Configuration operation
has been saved but not downloaded.
Devices will only appear in this
column after initial discovery.
Download the appropriate template

to the devices, or configure devices
using the Device Configuration
module and then clicking Save and
Download.
Require Download after these

devices were provisioned, the Device
Configuration module was chosen
from the local context menu, and
even if nothing was ultimately
changed in Device Configuration, the
Save button was clicked.
Device Configuration has been

accessed and the Save button has
been clicked.
Either download a template (either

default or cloned) or download the
Device Configuration from the
devices local context menu and
click the Save and Download button.
Other options include performing a
Download All or Download Changes.
Out of Synch device provisioned,

but device parameters do not agree
with template.
The template was changed or Device

Configuration was changed and the
Save and Download button clicked.
Parameters in the device do not
agree with those in the applied
template.
No remedy is needed. However, if

the intent is to get the device into a
synchronized state, then perform
one of the following options. If the
default template is used for this
device, open Device Configuration
and click Use Template and Save.
Then click Download and Save. If a
cloned template is used for this
device, download it to the device
using the download alert profile
procedure.
No remedy is needed.
Synchronized the data for these

devices agrees with that in the
database and in the template
Remedy
NOTE: With the exception of devices in the Not Provisioned category, there are instances where you may want a specific
device to have configuration parameters different from those in the template, such as temporary situations where
you may be testing limits to decide when or if to modify a template. The remedies above fully synchronize the
devices. Applying the remedies is at the users discretion.
Page
Page102
102
CheetahXD
Network
Inventory
User Guide
8.1
CheetahXD
NetworkUser
Inventory
Guide
Changing the Network Inventory Display
Change the appearance of the Network Inventory page by changing the layout of the items that display and by
displaying the page in full screen mode, which eliminates margins and borders.
NOTE: Changes made to the Network Inventory display persist in server memory only. If the server is restarted, the
Network Inventory displays its default layout.
8.1.1
Changing the Network Inventory Layout
In the Network Inventory page, click Layout Configuration.

The Layout Configuration page displays.
Figure 8-4: Layout Configuration Page

Checked options are those that display in the Network Inventory page.
Display Name name of the device that appears in tree views.

Template Display Name name of the template that appears in Template Administration pages and Device
Configuration pages.
Save Time time and date stamp indicating the last time the devices configuration was saved.
Name name of the device as it appears in the database.
Template Name name of the template that appears in tree views.
Download Time time and date stamp, indicating the last time the template was downloaded to the device.
Click the categories to add or remove the checkmarks to create the desired layout, and then click OK.
8.1.2
Displaying Network Inventory in Full Screen Mode
Full screen mode removes margins and borders so that the Network Inventory page can display more devices with
less scrolling. To access full screen mode, click the Full Screen Mode button at the top right of the page.
Borders and margins are removed, and the Full Screen Mode button changes to Exit Full Screen to allow you to
toggle between full screen and normal screen modes.
Page
Page103
103
CheetahXD
Network
Inventory
User Guide
8.2
CheetahXD
NetworkUser
Inventory
Guide
Managing Devices from the Network Inventory Page
Devices can be fully managed from the Network Inventory page. They can be downloaded to, synchronized and
configured. Also, templates can be configured and applied through the Network Inventory page.
Clicking a number in the summary at the top half of the Network Inventory page displays the individual devices in the
bottom half of the page. For example, in the following graphic, the number 36, representing the number of
transponders that are Not Provisioned, is selected. The 36 transponders not provisioned display in the bottom half of
the page.
Figure 8-5: Displaying Individual Devices

Select one or several devices in the bottom half of the screen and right-click to display the local context menu. When
multiple devices are selected some of the menu options are not available.
Figure 8-6: Device Context Menu
Page
Page104
104
CheetahXD
Network
Inventory
User Guide
CheetahXD
NetworkUser
Inventory
Guide
From here you can configure the device or the template the device is using. For information on configuring devices or
templates, see the chapter titled Provisioning Devices.
Page
Page105
105
CheetahXD
Network
Inventory
User Guide
8.3
CheetahXD
NetworkUser
Inventory
Guide
Polling/Unpolling Devices
Polling is the process by which CheetahXD checks the networks for devices in alarm states.
8.3.1
Normal Polling
Devices are included in the polling process only if they are configured to allow polling. The ability to turn polling on
and off allows for devices that are disabled, undergoing maintenance, or otherwise being taken out of service to be
exempt from CheetahXDs polling process. This improves system performance by allowing CheetahXD to bypass such
devices during polling sweeps.
8.3.2
Lock Polling
An option available for one selected device, lock polling commands a CheetahLight HEC or HEC 360 to poll the
selected transponder. This feature is useful for limiting the return path communications to only the selected
transponder so a spectrum analyzer can examine the return path transmission signal characteristics.
When lock polling is invoked, a page displays allowing a maximum time limit for lock polling to be set.
Figure 8-7: Lock Pull Duration Field

Lock polling remains in effect for the specified amount of time or until it is explicitly cancelled. When lock polling is in
effect, normal alarm acquisition and reporting is suspended. For this reason, the ability to invoke lock polling is a
permission that must be explicitly granted to a user or user group. For more information on permissions, see the
chapter titled System Setup. Start and stop times for lock polling are written to the system log.
8.3.3
High Power Polling
An option available for one selected device, high power polling is used to isolate forward path transmission problems.
The selected transponder is polled once at a higher than normal (approximately 6 dB higher) downstream power
level. This temporary boost in power level persists one polling cycle only (including retries). If a transponder does not
detect the HEC at the normal transmit power level, but does at the higher power level, then there is a forward path
problem in the cable plant. Unlike lock polling, high power polling does not interrupt normal polling and alarm
acquisition.
8.3.4
Turning Polling On and Off
Before a device can have normal polling turned on and off, it must be configured as a managed device. This is a
checkbox on the Property page of the Device Configuration module. The default setting for this parameter is
checked or enabled.
Page
Page106
106
CheetahXD
Network
Inventory
User Guide
CheetahXD
NetworkUser
Inventory
Guide
Figure 8-8: Managed Checkbox
Page
Page107
107
CheetahXD
Network
Inventory
User Guide
CheetahXD
NetworkUser
Inventory
Guide
Not all managed devices have the same polling default value. The default value for transponders and HECs is
enabled. For HEC modems, Cable Modem Termination Systems (CMTS), and Cable Modems (CMs), the default value
is disabled. Managed devices can have polling enabled or disabled in two places:
Via a checkbox in the Property page of the Device Configuration module
Figure 8-9: Status Polling Enabled Checkbox

NOTE: After changing a devices polling value, the change must be saved and downloaded.
Via the devices local context menu.
Figure 8-10: Device Context Menu - Maintenance Mode

NOTE: Maintenance Mode Off turns polling on; Maintenance Mode On turns polling off.
Invoke Lock Polling and High Power Polling via the devices local context menu. For more information on local context
menus, please refer to the section entitled Accessing the Local Device Menus from the Tree which is located in The
Tree Viewer chapter of this manual.
Page
Page108
108
CheetahXD User
Provisioning
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
Provisioning Devices
Cheetah XD interacts with devices by using defined parameters. These parameters include:
Device types
Alarm limits
If the device is testable (for power supplies)
If CheetahXD should poll the device for alarm states and how often.
These parameters are applied during discovery of the device, and are downloaded to the device in the form of a
template. Templates include collections of default configurations for each type of device.
Default configurations specify general information such as communications information (device IP or MAC address)
and alarm limits, all of which is stored on the CheetahXD database.
A device is considered provisioned when the parameters have been downloaded to the device. For information on
finding the provisioning status of devices, see the chapter titled Network Inventory.
A device can become provisioned in one of three ways:
By CheetahXD when the device is auto-discovered (providing automatic download is enabled)

When a user manually downloads an appropriate template to the device
When the user sets the parameters for the device in the Device Configuration module, and downloads the
appropriate parameters to it.
Devices can be provisioned individually or in bulk.
9.1
Configuring and Using Templates
A template is a named set of device-specific configuration parameters that can be automatically or manually
associated with a device in the CheetahXD database. The template must also be downloaded to the device to
complete provisioning. A default template (which exists for each device type) is automatically assigned to any newly
added or discovered device.
The configuration parameters available in templates are the same as those available in the Device Configuration
module, which is used to manually configure individual devices. A template, then, is simply a device configuration
that has been named and saved to be used again. CheetahXD contains default configuration templates for all of the
expected device types that can be used in your network.
After associating a template with a device and downloading it to the device, the device can still be further configured
using the Device Configuration module.
System administrators can specify which default CheetahXD template is to be used for what device type. This usually
occurs during system setup, but can be done anytime.
Additionally, default templates can be modified or cloned, and the clones modified to create completely new
templates with parameters tailored to a specific situation or application. For example, a default template for a
specific power supply can be automatically applied whenever CheetahXD discovers a power supply of that type. The
template can be cloned and modified to include different temperature alarm thresholds for colder (or warmer)
weather, named and saved, and applied to appropriate power supplies at the appropriate times during the year.
Page
Page109
109
CheetahXD User
Provisioning
Devices
Guide
9.1.1
Provisioning
CheetahXD User
Devices
Guide
General Template Concepts
Although the following sections describe in detail how to manage and use templates, a general understanding of the
concepts of using templates is helpful.
When CheetahXD discovers a new network element, it can associate with it the template defined for an element of
that type (fiber node, power supply, etc). This association becomes part of the record in the database for that
element. However, the element is not provisioned (not monitored by CheetahXD according to the parameters in the
template) until the template is actually downloaded to the device.
Since templates can be modified, devices that are provisioned can become out of synch, which means their
templates no longer match the parameters of the templates in the database.
To make you aware of such conditions, CheetahXDs Template Administration pages include colored icons and flags
displayed with network elements to indicate the status of the elements with respect to their templates. This is
discussed in more detail in the chapter titled Network Devices, but briefly mentioned here to help in understanding
templates.
Not Provisioned a red dot icon next to an element in a Template Administration page indicates that the
element has no configuration template downloaded to it.
Require Download a blue dot icon next to an element in a Template Administration page indicates that after
the element was provisioned, the Device Configuration was changed, and the Save button was clicked. It is
important to note that any change or edit, even if nothing was physically changed, moves the device status to
Requires Download. Many pages in Template Administration, Network Inventory, and Reports include a field
called Requires Download. When this field includes a checkmark, it means the same thing as the blue dot
icon.
Out of Synch a yellow dot icon next to an element in a Template Administration page indicates that the device
is provisioned (a template has been downloaded to it), but device parameters do not agree with the applied
template.
Synchronized a green dot icon next to an element in a Template Administration page indicates that the data
for the device agrees with that in the database and in the template.
After modifying a template or device configuration, the following buttons at the bottom of the pages perform the
following actions:
Figure 9-1: Device Configuration Menu
Save and Download click this button to save the changes to the template or device configuration in the
database, and download it to the device.
Reload click this button to abandon changes made, and restore the template or configuration to the last saved
parameters.
Required download all to apply a checkmark in the Requires Download field for all displayed devices.
CheetahXD uses the checkmark in the Requires Download field to determine which elements to include in a
Bulk Download operation.
Use template and Save click this button to apply the template to the selected device, and save the template
changes in the database.
Edit template click this button to make changes to the selected template.
Page
Page110
110
CheetahXD User
Provisioning
Devices
Guide
9.1.2
Provisioning
CheetahXD User
Devices
Guide
Viewing, Modifying, and Creating Templates
The CheetahXD Administration tab includes an icon that opens the Template Administration module where you can
view, modify, and create templates.
View Templates
1.
2.
Click the Administration tab in CheetahXD.

In the CheetahXD Administration section of the Administration tab, click Template Admin.
Figure 9-2: Administration Page CheetahXD Administration Section

3.
To view the templates, scroll through the list.
Figure 9-3: Template List
Page
Page111
111
Provisioning
CheetahXD
User
Devices
Guide
9.1.2.1
Provisioning
CheetahXD User
Devices
Guide
Changing the Template View
You can change what displays in the template viewer.
NOTE: Changes made to the Template Administration pages exist in server memory only. If the server is restarted, the
pages revert back to the default layout.
To change the template viewer display:
1.
View the templates according to the procedure To View Templates in Section 9.1.2.
2. Click the Layout Configuration button.

3. In the Layout Configuration window, click the checkboxes next to the options you want to see in the template
viewer, as shown in the following illustration.
Figure 9-4: Layout Configuration Window

The following is a list of the template and device column options, along with a brief description of each:
Icon displays the icon for the particular device type.

ID displays the template ID number.
Modifier displays the Cheetah personality ID number.
Removable indicates if the template can be deleted.
Display Name displays the name of the template.
Category displays the general classification of device type.
Alarm Profile indicates if the device is using a user-defined profile or a default template.
Save Time displays the time when the last change was made and saved.
Name displays the source name assigned to the device. This name is generated by the system.
Type displays the specific device type.
Cloneable indicates if the device template can be cloned.
Status indicates the device's provisioned state.
Download Time displays the time of the last device download received from the system.
4.
Click OK to modify the layout with the selected options or click Cancel to make no changes to the template
layout.
Page
Page112
112
Provisioning
CheetahXD
User
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
To modify a template:
1. View the templates according to the procedure View Templates in Section 9.1.2.
2. Click the desired template to select it, and either click the Template Configuration button, or right click and
select Template Configuration from the local context menu. The following view displays.
Figure 9-5: Template Configuration Page

3. Select one of the parameter tabs and click on the Plus icon to the left of the template name to expand and view
parameters. Edit the parameters as desired.
Figure 9-6: Template Parameters
Page
Page113
113
Provisioning
CheetahXD
User
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
To clone a template:
NOTE: This procedure only creates a copy of the template from which it was cloned. To modify the new template, select it
from the template list and use the previous procedure - To modify a template.
1.
Display the template (refer to the previous procedure to view templates).
2.
Click the desired template to select it, and either click the Clone button at the top of the list
or right-click and select Clone from the local context menu.
Figure 9-7: Submenu Clone Option

If the Both view is selected, type a name for the new template. By default, the Template Administration page will
automatically reload to include the new template. Leave the Reload after clone checkbox selected since the next
step is to modify the template by selecting it on the template list. Otherwise, the view of the template list will
change and the cloned template can only be viewed by navigating to the Alert Profile or the Both view.
Figure 9-8: Clone Window

3.
Click OK.
The template list reloads and displays the new, unmodified template.
Figure 9-9: New Template in Template List

4. Modify the template using the previous procedure - To modify a template on Page 107.
Page
Page114
114
Provisioning
CheetahXD
User
Devices
Guide
9.1.3
Provisioning
CheetahXD User
Devices
Guide
Applying Templates
Provisioning a device using a template consists of the following:
Associating the template with the device in the CheetahXD database

Downloading the template to the device
When CheetahXD auto-discovers a device, it automatically associates the appropriate template with it and records it
in the database. You can also manually associate templates with devices. (User-created templates, created from
cloned templates, which is explained later in this chapter, must be manually applied to devices.)
You can associate a template to a single child device, or select a top-level or gateway parent device and manually
associate a template to it and to all of its child devices simultaneously. To accomplish that using the following
procedure, simply select the device that is at the desired level.
To associate the default template with a device:
1.
2.
Display the device in any tree view.

Right click on a device in the tree and select Device Configuration
NOTE: The Device Configuration page can also be accessed from the Network Inventory and Template Administration
pages by right-clicking on a device.
Figure 9-10: Device Configuration Page

This page displays the Information tab of the devices configuration. In the upper left corner, the device name
displays along with its child devices below it, or, if this is a child device, its managed parameters display below it.
3. To associate the default template with this device, click the Use Templates and Save button. CheetahXD
associates the correct template for the selected device. This does not save data for child devices. To save child
device data, the child device(s) must be selected.
4. To fully provision the device, download the template to the device.
Page
Page115
115
Provisioning
CheetahXD
User
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
To manually associate a template with a device:

1.
2.
Display the device in any tree.

Right click on an element in the tree, and select Download > Alert Profile from the submenu.
Figure 9-11: Tree Submenu Alert Profile Option

The Download Alert Profile page displays the applicable template.
3.
Select a template by clicking on the radio button to left of the template name.
Figure 9-12: Download Alert Profile Page

4.
Click the Download Limits button.

The Bulk Task Status window appears.
Page
Page116
116
Provisioning
CheetahXD
User
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
Figure 9-13: Bulk Task Status Window

5. The download task should appear in the Active Bulk Tasks section of the window unless the task was completed
before the window opened, in which case the task will be displayed in the Completed Bulk Tasks section of the
window.
6. If desired, you can view details of the task by clicking on the button to the left of the task ID number. For more
details about the Bulk Task Status window, please refer to the appropriate section in the System Administration
chapter of this manual.
9.2
Power Supply Indexing Serially Connected Supplies
Individual templates are created for serially connected power supplies. Each of the Power Supplies will have their
own index as defined by the psDeviceAddress (1.3.6.1.4.1.5591.1.4.2.1.1) MIB point. For example, if two power
supplies are serially connected with the first power supply having a psDeviceAddress of 1 and the second power
supply having a psDeviceAddress of 3, the templates created by CheetahXD will be labeled
*_T_Power_Supply_HMS_Power_Supply_1650_1 and *_T_Power_Supply_HMS_Power_Supply_1650_3
respectively.
Note: This new indexing model is carried through to the children of the Power Supply so objects such as Current Output
and Temperature sensors are indexed per power supply.
Items to be considered:
After an upgrade to CXD v3.3, no change is necessary by the operator as all Power Supply Alert Profiles will
continue to function.
Any new Power Supply discovered after upgrading to CXD v3.3 will be assigned a new template including the
Power Supply index as defined by the psdeviceAdddress MIB point.
Page
Page117
117
Provisioning
CheetahXD
User
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
For operators with serially connected power supplies who want to utilize the new template configuration, perform the
following steps:
Page
Page118
118
Provisioning
CheetahXD
User
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
1. Delete the Power Supply objects from the Native Tree leaving only the Transponder object in the tree. This will
remove all instances of the Power Supply from the Native Tree and any Custom Trees.
2. From the Transponder, Right-click and select the Rediscover option from the common menu.
a. Upon rediscovery
i. The previously used Alert Profile will no longer function
ii. The devices will move to the Not Provisioned column with Network Inventory
3. Upon discovery, new Templates will be created by CheetahXD for the given device types. Edit the template or
Clone new Alert Profiles and edit the values to be downloaded to the Transponders.
a. When editing the templates, update the indexed templates and not the Standard HMS Power Supply
Template.
4. Download the new Alert Profile to the transponder.
5. Any Power Supply MOs that were part of a custom tree can be copied from the HFC Tree back to targeted
Custom Trees.
9.3
Generic I/O Setup
You can setup and monitor the generic I/O on the Cheetah CMD-P+ device by creating a custom template that can
be monitored and controlled through the use of the generic I/O pin connections. Set up the custom template using
the following instructions:
1.
2.
Navigate to the Tree Viewers View Editing Pane, and select the Tree where the P+ device is located
Select the CMD-P+ Transponder device.
3.
Click the Add new nodes button.

This opens the Create new network element(s) window, as shown in Figure 9-14.
Figure 9-14: Create New Network Element Window

4. Scroll through the list and find the appropriate location, i.e., Generic IO HMS Generic IO xx as shown in
Figure 9-14. Make sure to select the number that reflects the correct power supply personality type for that P+
device.
5. Navigate to the Template Administration page.
From the main menu select Administration, and then select Template Admin in the Cheetah XD Administration
section.
Page
Page119
119
Provisioning
CheetahXD
User
Devices
Guide
6.
7.
Provisioning
CheetahXD User
Devices
Guide
Select the Generic IO template.

Ensure the last four digits correspond to the devices power supply personality type.
Page
Page120
120
Provisioning
CheetahXD
User
Devices
Guide
8.
Provisioning
CheetahXD User
Devices
Guide
Right-click on the template and select Generic I/O Configuration.

The Generic IO Config page displays, where the devices IO parameters can be selected.
The Generic IO can include:
Three general purpose digital outputs

Three general purpose digital inputs
Three DC analog inputs
Three AC analog inputs
Some of the generic I/O pin connectors on the discovered devices can be connected to elements such as mat
heaters, contact closures, and other sensors.
To configure the generic I/O, choose either the Analogs or Digitals Attributes button first.
9.3.1
Analogs Attribute
If you choose the Analogs attribute, you can:
Enable/disable each analog parameter

Define a display name for the parameter
Define the units for the analog parameters
Define the scaling and decimal adjustment
Figure 9-15: Generic IO Config Page Analogs Fields
Page
Page121
121
Provisioning
CheetahXD
User
Devices
Guide
9.3.2
Provisioning
CheetahXD User
Devices
Guide
Digitals Attribute
If you choose the Digitals attribute, you will see the screen shown in Figure 9-16.
Figure 9-16: Generic IO Config Page Digitals Fields

For the Digital Input parameters, you can:
Enable/disable each digital input parameter

Associate a digital state name for each of the potential values returned for a particular parameter. For the
Digital Control parameters, you can:
Associate a digital control state name for each of the potential values sent for this particular parameter.
Once the template has been created, name it (preferably choosing a different name from the default template) and
use the bulk download function to download this to multiple devices at one time.
All of the devices to which the template is downloaded should get updated automatically in the runtime and the
database, and will now include the additional created attributes. No auto-discovery of the device should be required
again, and the newly added attributes should be available for viewing and editing in Data Display, Scheduler, and
Device Config.
Page
Page122
122
Provisioning
CheetahXD
User
Devices
Guide
9.4
Provisioning
CheetahXD User
Devices
Guide
Configurable Parameters
Up to eight tab options will display when you select either Device Configuration from a devices local context menu or
Template Configuration from the Template Administration page. Since device parameters vary from one type of a
device to another, the type of device you select determines which tabs are displayed. However, the Information and
Property tabs are always displayed, regardless of device type.
Figure 9-17: Device Configuration Page Menu

From the Device Configuration's main page select a tab and then click on the button to the left of the device you
want to configure.
9.4.1
Information Tab
The following is a list of the Information tabs parameters along with a brief description of each:
Name Source name

Type - Device type
Status Polling Enabled - determines if CheetahXD will poll the device for status information
Last Status Update Time Time and date stamp indicating when the last status update occurred
Last Status Change TimeTime and date stamp indicating when the last status change occurred
Failure Count Number of times attempts to communicate with the device failed
Device Communications Handler Displays the internal class definition of the device
CTTopoObject Type Displays the internal device type definition
Discover State Indicates the discovery state (incomplete or complete) of the device
Is Top Level Container Indicates if the device is a parent
Is Schedulable Indicates if schedules can be created for and applied to the device
Top Level Parent Indicates if the device acts as a parent for other network elements
Gateway Parent Indicates if the device acts as a communications point for other devices
Last Update Time Time and date stamp indicating when the last update occurred
Last Download Time Time and date stamp indicating when the last download occurred
MAC Address MAC address of the device
Device Type Category of the device
Category Displays the general classification of device type
Template Type Type of template used to configure the device
Modifier Displays the Cheetah personality ID
Group Name Displays the internal grouping nomenclature
Application Displays the default domain name in which the device exists
Active Template displays the name of the template/alert profile associated with this device
Page
Page123
123
Provisioning
CheetahXD
User
Devices
Guide
9.4.2
Provisioning
CheetahXD User
Devices
Guide
Property Tab
Figure 9-18: Property Tab

The editable Property tab is the location to specify if the device is to be managed by CheetahXD (included in
CheetahXDs status monitoring function), and to establish the devices polling parameters (if and how often
CheetahXD polls the device for alarm states).
The Property tab also includes the five user-definable fields that can include additional information about the device
such as manufacturing or installation information or other notes and comments about the device. For information on
using these fields, see User-Defined Configuration Fields later in this chapter.
NOTE: This page is not downloaded to the device when downloading Template or Alert profiles.
The following is a list of the Property tab's parameters, along with a brief description of each.
Display Name device display name

Managed determines if the device will be managed by CheetahXD
IP Address the IP address of the device
Netmask the netmask value used to determine a subnet for the device.
Failure Threshold internal value indicating the number of attempts made before determining a
communications failure
Status Polling Interval the frequency, in seconds, at which CheetahXD polls the device for status information.
This applies only when Status Polling is enabled.
User Name a user-defined name for the device
User Comment a user-defined descriptive comment assigned to the device
Protocol Specific Data data pertinent to a particular protocol used by the device
Location a user-defined description of the devices physical (non-network) location
User Field 1-5 areas for additional user-defined information
Community the name of the network community to which the device belongs
Write Community the name of the network write community to which the device belongs
SNMP Port the CheetahXD server port number assigned for SNMP communications
NOTE: Display names for CMTSs and VoIP devices can be up to one hundred (100) characters long including spaces.
Display names for legacy devices (CheetahNet, CheetahLight, and HMS) and DOCSIS transponders can be up to
40 characters long including spaces.
Page
Page124
124
Provisioning
CheetahXD
User
Devices
Guide
9.4.3
Provisioning
CheetahXD User
Devices
Guide
Analog Tab
Figure 9-19: Analog Tab

The Analog tab displays the values of a devices analog attributes. Most of these values can be edited by the user.
Each row lists an attribute name, the units its value represents (i.e., current, voltage, etc.) and four alarm limits (i.e.,
LoLo, Lo, Hi, and HiHi). The values of these attributes are expected to stay within a predetermined range. When
properly configured, alarms are generated any time the values exceed one or more of these ranges.
The following is a list of the Analog tabs parameters, along with a brief description of each.
Units unit value for the parameter (i.e., voltage, current, etc.)
Alarm Limit (LoLo, Lo, Hi, or HiHi) a setpoint or limit value specified by the user that is used for generating
alarms when the parameters actual value exceeds the limit
Enabled enables/disables alarming
Priority assigns a priority level to each alarm, with a level of 1 being the highest or most important priority
Deadband a user-defined value used to create a deadband for values returning from an alarm condition
These values are included in the default CheetahXD templates for applicable devices. These values can be modified
for individual devices, or for all of the devices of the same type at one time. Individual devices should be modified
using the Device Configuration module. Use the Template Admin page to modify the template for a specific device
type, and then apply the change to all of the devices of that type.
Four additional variables are associated with each parameter. These variables (i.e., Decimal Precision, Decimal
Adjust, Protospecific Index, and Requires Download) are internal values and should not be changed by the operator.
Set analog limits using absolute or relative values, according to the following rules:
LoLo value must be less than or equal to the minimum alarm limit for the device, and must be less than the
value set for Lo
Lo value plus the value of the deadband must be less than the value set for Hi
Hi value must be less than the value set for HiHi
HiHi value must be less than or equal to the maximum alarm limit for the device
Deadband cannot be a negative number
Use relative values (expressed as a percentage of the value of the current state of the device) when configuring
analog limits in templates only. CheetahXD converts the percentages to actual values when saving analog limits
based
on
the
actual
values
from
the
transponder
Page
Page125
125
Provisioning
CheetahXD
User
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
Figure 9-20: Transponder Values and Limits

9.4.4
Non-Alarmable Analog Tab
This editable page displays the value of attributes that are required to operate within a predetermined range, but do
not generate an alarm when the value is out of range. An example of a non-alarmable analog parameter is a value
that indicates when an RF Port on a transponder is active or inactive.
This page also displays a checkmark in the Requires Download column when the value displayed for an attribute
does not match the value for that attribute in the database. When this occurs, the template for that device should be
downloaded, or the device should be configured using the Device Configuration module. If the Device Configuration
module is used to edit the attribute, be certain to save the change to the database and download the value.
Four additional variables are associated with each parameter. These variables (i.e., Decimal Precision, Decimal
Adjust, Protospecific Index, and Requires Download) are internal values and should not be changed by the operator.
The following is a list of the Non-alarmable Analog tabs parameters, along with a brief description of each.
Nominal the nominal value for the parameter

9.4.5
Multi Tab
Figure 9-21: Multi Tab

This editable tab displays multi-valued device parameters. An example of multi data is alarm priorities that can be set
to a number between 1 and 99, inclusive. Each value can be independently configured to be either in a disabled or
alarm state. An enumerated parameter generates an alarm if its current value is configured to be an alarm condition.
If the value changes to another value that is also configured to be an alarm, another alarm is generated. A return
occurs when the value changes to a state or value that is configured with the alarm parameter disabled.
Page
Page126
126
Provisioning
CheetahXD
User
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
Two additional variables are associated with each parameter. These variables (i.e., Protospecific Index and Requires
Download) are internal values and should not be changed by the operator.
Page
Page127
127
CheetahXD User
Provisioning
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
The following is a list of the Multi tab's parameters, along with a brief description of each.
Value a value associated with a particular parameter state

Description a text description associated with a particular parameter state
Enabled enables/disables alarming
Severity indicates the level of severity associated with each alarm
Priority assigns a priority level to each alarm with a level of 1 being the highest or most important priority
Nominal the nominal value for the parameter
9.4.6
All Attributes Tab
Figure 9-22: All Attributes Tab

Displays the devices total configuration parameters in one scrollable page.
This page also displays a checkmark in the Requires Download column when the value displayed for an attribute
does not match the value for that attribute in the database. When this occurs, the template for that device should be
downloaded, or the device should be configured using the Device Configuration module. If the Device Configuration
module is used to edit the attribute, be certain to save the change to the database and download the value.
9.5
Configuring an Individual Device
Use CheetahXDs Device Configuration module to change one or more parameters of an individual device.
To display the Device Configuration module:
1.
2.
Display the device in any tree view.

Right-click the device and select Device Configuration.
The Device Configuration module opens to the Information tab.
3. Click the various tabs and modify the fields as desired to create the configuration for this device. For information
on using the tabs, see Section 9.2 earlier in this chapter.
9.6
Configuring a Virtual Headend Controller
Virtual Headend Controllers (vHECs) are used only when integrating CheetahXD into an existing CheetahNet system.
Configuring them consists of defining proxies that represent the CheetahNet headend controllers with which
CheetahXD will communicate. For information on creating and configuring vHECs, see the chapter titled Integrating
CheetahXD with Existing Cheetah Systems.
9.7
Configuring the CheetahNet Element
Page
Page128
128
CheetahXD User
Provisioning
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
The CheetahNet element is user-created in CheetahXD when integrating CheetahNet into CheetahXD. For
information on configuring this element, see the chapter titled Integrating CheetahXD with Existing Cheetah
Systems.
Page
Page129
129
CheetahXD User
Provisioning
Devices
Guide
9.8
Provisioning
CheetahXD User
Devices
Guide
Using the User-Defined Configuration Fields
The Property tab of the Device (and Template) Configurator includes five generic fields for capturing additional device
information such as physical location, manufacturer information, installation dates, or other user- specific information.
When CheetahNet devices are imported into CheetahXD (see Integrating CheetahXD with Existing Cheetah Systems),
CheetahXD uses some of these fields to store device configuration information that was defined
in CheetahNet, but is not represented in the default CheetahNet configuration parameters.
By default, these fields are named User Field 1 through User Field 5, but CheetahXD offers a way to change the field
labels to reflect the information captured.
To access the user-defined configuration fields:
1. Access the Device Configuration or Template Configuration module (see the procedures in this chapter, To
display the Device Configuration module or To modify a template).
2. Click the Property tab.
Figure 9-23: User-Defined Configuration Fields

3.
The user-defined fields display toward the bottom of the page. Scroll down to view them.
NOTE: If CheetahNet devices that have been imported into CheetahXD contained additional configuration notes or
comments, the notes or comments will appear in one or more of these user-defined fields.
Page
Page130
130
CheetahXD User
Provisioning
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
To change the labels on user-defined fields:

1.
Open the text file englishtonative.properties in WordPad or a similar text editor. Find it using the path
c:\cheetahXD\html\EnglishtoNative.properties unless you chose to place this file elsewhere.
Figure 9-24: EnglishToNative.properties File

2. Scroll to the lines depicted by the highlighted areas in Figure 9-24.
3. Edit the text depicted by the highlighted areas to reflect the name(s) you want to give to the user-defined fields,
obeying the following conventions:
4.
5.
Create names with a maximum of 32 characters, including spaces

Only use printable ASCII characters in these field names (no control characters).
Save the file and close it.

Restart the server for the label changes to take effect.
Page
Page131
131
CheetahXD User
Provisioning
Devices
Guide
Provisioning
CheetahXD User
Devices
Guide
Page
Page132
132
CheetahXD
Fault
ViewsNotifier
User Guide
10
CheetahXD
Fault ViewsNotifier
User Guide
Fault ViewsNotifier
Alarms are generated when a fault or failure is detected in a network device. The CheetahXD Fault View displays
current alarms and historical events for discovered and provisioned devices in the HFC and IP domains using
CheetahXDs Notifier application.
Figure 10-1: Faults Page Menu

The Notifier page can be displayed as embedded (the default), or full screen (Notifier Full). A full-screen display is
100 percent resized with no borders, navigation, or status bars to obscure the view. To return to the default view,
choose the Exit Full Screen button.
NOTE: The Power Outage and Power Outage (Full) links are discussed in the chapter titled Fault ViewsPower
Outage Monitoring.
Alarm displays are color-coded to provide a quick indication of alarm severities.
Figure 10-2: Notifier Page
Page
Page133
133
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
The following table identifies the default colors for the different alarm severities.
Alarm Color
Red
Orange
Yellow
Blue
White
Green
Gray
Severity
Critical
Major
Minor
Warning
Info
Clear
Unknown
CheetahXD includes the file severityinfo.conf that allows you to change the colors associated with severities. For
additional information on changing alarm colors, please contact Cheetah Support at 1-866-944-1482 or
cheetahsupport@cheetahtech.com.
Default and customized views allow you to display alert and event information in ways that are most meaningful to
your enterprise.
Local context menus include options for displaying alarm details, acknowledging, clearing and deleting alarms, and
for starting CheetahXD applications such as Data Display and Device Configuration.
The Notifier also allows you to save the currently displayed alerts or events layout. If you log out of CheetahXD and
close the browser, the last saved Notifier layout will display when you next open the browser, log back into
CheetahXD, and click the Faults tab.
10.1
The Default Notifier Page
The default Notifier page, shown in Figure 10-2, includes ten function buttons at the top, as shown in Figure 10-3:
Figure 10-3: Notifier Page Menu
New View Create an additional Alerts view that displays its own tab.
Close View Close a new view tab.
Field Selection Choose the fields to display for an Alerts or Events view.
Filter Selection Specify values for criteria used to filter Alerts or Events.
Layout Selection Choose a previously created and saved display layout.
Find Alert Display a specific alert without having to scroll the list to find it.
CSV Download a .CSV file listing the alerts from the Notifier page.
PDF Download a .PDF file listing the alerts from the Notifier page.
Exit Full Screen When the Notifier is displayed in full screen format, this button is active and can be clicked to
return to regular display mode.
Sound On Select audible alarm tones for one or all levels of alerts.
Server Status Displays the status of each server in a separate window, and is a visual indicator for the servers
heartbeat operation.
About Displays the current version of CheetahXD. A section summarizing the current alarms or events is
illustrated below.
Page
Page134
134
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Figure 10-4: Notifier Page About Section
Information This user-customizable section displays, by default, the server name, the name of a filter assigned
to the display, and a clock that displays the session duration (see Section 9.7 in this chapter for information on
changing this display).
Severity This section lists all alarm severities.
Totals This column lists the total number of alarms per severity.
Percent of Total This column displays the percentage of the total number of alarms that each severity
represents.
Application This section summarizes current alarms by application (HFC, CheetahNet, etc), grouped by colorcoded severity. Only those categories having devices in an alarm state appear in this section. If a category is not
represented here, there are no current alarms associated with any of the devices in that category.
A sample customizable section displays below. It lists the individual alarms or events, color-coded by severity.
Figure 10-5: Notifier Page Current Alarms Section

By default, the following columns display:
Status The status of the alarm, Open or Acknowledged.

ID The identification number of the alarm.
Gateway Parent Displays the name of the devices gateway parent. This value is also known as the Display
Name.
Modified Displays the time of the most recent alert update.
Severity Displays the severity of the alarm.
Priority Displays the priority assigned to the alarm.
Created Displays the date and time the device went into the alarm state.
Application Displays the domain of the device causing the alarm.
Attribute Displays the specific attribute name of the device causing the alarm.
Server displays the server name.
Server IP Displays the servers IP address.
Source Displays the managed object name of the device triggering the alarm.
Page
Page135
135
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Message Displays a brief message regarding the reason for the alarm or event.
See Section 10.7 for information about changing this display.
Page
Page136
136
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
By default, alarms appear in the order retrieved from the database, the most recent alarm at the top. Click any of the
column headers to sort the alarms by a particular category (i.e., status, date modified, etc.). For example, click the
Severity column header to view the devices by alarm severity (i.e., critical, major, etc.). An arrow in the column
header indicates the sort order. The up arrow indicates ascending order:
Click the column header again to toggle the order. A down arrow indicates descending order:
Three default tabs, Alerts, Events, and Notifier Dashboard, display the fault information. These tabs cannot be
deleted.
Figure 10-6: Default Tabs
10.2
Alerts
An Alerts view displays current alarms only. Alarms that have been cleared, deleted, or alarms of unknown status do
not display in an Alerts view. This chapter describes how to create additional Alerts views, and how to customize
columns and filters for them. CheetahXD can initially display up to 10,000 alerts in the Notifier. This default value
can be increased so that the Notifier will display more alerts. However, increasing this value above 10,000 will have
a negative impact on system performance. As the value increases, system performance decreases.
10.3
Events
An event is any type of action that affects a network device, including new, acknowledged, and cleared alarms,
newly-discovered devices, whether device polling (maintenance mode) is turned on or off, etc. It is similar in function
to an activity log in that any activity occurring in a network device is recorded as an event in Network Events. While
there can be many Alerts views, there can be only one Events view.
Because the number of historical events can quickly grow and become time-consuming to gather and display,
(CheetahXD can display an infinite number of events, limited only by the RAM on the browser computer), the Events
page is empty until a filter is applied. This chapter describes how to create and assign filters to display events in the
Events view.
By default, Events are kept in the database for a period of 4 days. This time frame is selected to keep only the recent events available to the Faults GUI while allowing for better performance of the view. All pertinent domain events
older than 4 days are backed up in the CHEETAHXD_HOME\backup\events.
10.4
Notifier Dashboard
The Notifier Dashboard view displays charts and graphs that depict the alerts and events in a visually comprehensive
manner. It is available to licensed users only, and is described later in this chapter.
Page
Page137
137
CheetahXD
Fault
ViewsNotifier
User Guide
10.5
CheetahXD
Fault ViewsNotifier
User Guide
Displaying a Full Screen Notifier
Displaying the Notifier in full-screen format eliminates all browser borders, title bars, and so on. This presents alarm
information and function buttons in as large an area as possible.
To display a full-screen Notifier, click the Notifier (Full) link in the Fault list menu at the left of the page.
To exit from the full-screen display, click the Exit Full Screen button on the Notifier toolbar, which is active once you
are in full-screen mode.
10.6
Creating a New Alerts View
Additional Alerts views allow you to have multiple views, each with specific fields and filtering, which you can access
any time during a session. If you close a view or log out of CheetahXD, the view is removed, although saved filters
can be assigned again to re-create the view, and the layouts can be saved. See the topics Specifying Filters for
Views and Saving, Applying, Deleting Layouts in this chapter.
To create a new Alerts view:
With the Alerts tab open, click the New View button. A new Alerts tab appears on the Notifier and the new Alerts tab
opens.
Figure 10-7: New Alerts Tab

The new Alerts view is the same as the default Alerts view until you modify and/or apply fields and/or filters to the
view. When a filter is assigned to a new view, the label on the tab changes to include the name of the filter. Click
Close View to delete the new view.
Figure 10-8: New Alerts Tab Filter Name
10.7
Customizing Views
Customize the default Alerts view, a user-created Alerts view, and the Events view so that they display the types of
alarms and alarm details that are most meaningful to your organization.
While customizing an Alerts view is optional, customizing the Events view is required. It contains no data until a filter
has been created and assigned. This prevents the potential system resource drain and long waits that can occur as
this historical record of events grows.
Customize Alerts and Events views by specifying:
Fields the categories of information to display in the view

Filters the values of information to display in the view
Page
Page138
138
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
The Notifier also allows you to save the currently displayed alerts or events layout. If you log out of CheetahXD and
close the browser, the saved Notifier layout will display when you next open the browser, log back into CheetahXD,
and click the Faults tab.
The Notifier Dashboard View is not customized with fields and filters, but is viewed instead by clicking on portions of
pie and bar charts, described in detail later in this chapter.
10.7.1
Specifying Fields for Views
One way to customize an Alerts or Events view is to specify the fields (the categories of data) to be displayed in the
Notifier.
NOTE: This operation uses a Java applet. When the Notifier Field Selection window is open, accessing other
CheetahXD functions or other applications on your PC can make the browser appear inoperable. This is normal
Java behavior. To prevent this, always complete your work with the Notifier Field Selection window before
moving on to another operation.
Should the browser appear to be inoperable, minimize all other windows until the Notifier Field Selection window
displays. Alternatively, hold down the <Alt> key and press the <Tab> key to scroll through the running processes.
When the Java (coffee cup) icon is selected, stop pressing the <Tab> key and release the <Alt> key. When the
Notifier Field Selection window becomes active and you can close it, the browser becomes operable again.
To specify fields for views:
1. With the Events view or the desired Alerts view displayed in the Notifier, click the Field Selection button to
modify the fields that will display in the new view. The Notifier Field Selection window displays.
Figure 10-9: Notifier Field Selection Window

The Notifier Field Selection window contains all possible fields that are displayed for alarms. Checked items are
fields that will display in the view. Click the checkboxes to select and deselect fields until the desired
combination is achieved.
Page
Page139
139
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Status Displays the status of the device.

Id Displays the device ID.
Page
Page140
140
CheetahXD
Fault
ViewsNotifier
User Guide
2.
CheetahXD
Fault ViewsNotifier
User Guide
Gateway Parent Displays the name of the devices gateway parent. This value is also known as the
Display Name.
Modified Displays the time of the most recent alert update.
Severity Displays the alert severity value.
Priority Indicates the paging priority.
Created Displays the time the first alert was generated.
Application Displays default domain type.
Ack By Displays the name of the user that acknowledged the alert(s).
Attribute Displays the specific attribute name on the device responsible for generating the device.
Server Displays the server name.
Server IP Displays the servers IP address.
Entity Displays the full description of the device/attribute in alert. This value is comprised of the Source,
Top Level Parent, and Attribute fields.
Group Name Displays the name of the group to which the device belongs.
Source Displays the source name of the device.
Top Level Parent Displays the name of the devices top level parent.
Device Category Displays the name of the device category to which the device belongs.
Current Value Displays the value of the attribute at the time the alarm occurred.
Limit Violated Displays the value of the threshold value that has been violated.
CN Source Displays the device name within the CheetahNet system.
CNSubResource Displays the device sub-resource name within the CheetahNet system.
Alarming Attachment Displays the sub-component which contains the attribute.
Alarm Field 1 through 10 Additional areas or fields for entering user-defined information.
State Change Displays the number of times the attribute has transitioned into and out of the alert state.
Click Update Field Selection to apply the changes to the new view, or click Cancel to close the window without
making any changes.
10.7.1.1 Displaying System Audit Information

Activity / Audit Log Capabilities
CheetahXD has the ability to audit/track certain operator activities. It is tracked as a special event within Notifier
with a Category of Audit. These events are generated automatically by CheetahXD when certain user or system
controlled activities are performed. Some of the commonly audited operations are:
Polling On/Off
Tree addition and deletions
Device and template configuration and downloads
Battery Testing
Automatic synchronization of alerts
CheetahXD shutdown
Information in the event includes User name, operation performed, machine used to trigger the operation, and
other useful data.
To display audit information:
1.
2.
3.
In the Notifier application, select the Events tab. The audit information is only available from the Events page.
Click the Field Selection button.
In the Notifier Field Selection window deselect all of the fields except the User 1 through User 6 fields.
Be certain to select Alarm Fields 1 through 6.
Page
Page141
141
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
These fields display the audit information. Click the Update Field Selection button to submit the changes.
Page
Page142
142
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
NOTE: Deselecting all of the fields other than the User 1 through User 6 fields is not a requirement. However, doing so
presents the audit information in a concise manner, which makes the information easier to view.
4.
Click the Filter Selection button. The Notifier Filter Selection window displays.
Figure 10-10: Notifier Filter Selection Window

5. In the Notifier Selection Window enter the word Audit in the Application field. Next, click in an adjacent field or
press the Enter key to finalize the change made to the Application field. Click on the Assign Filter button to submit
the changes.
IMPORTANT!
After you have made a change to any value field in this window, press the <Enter> key or click another
value field before clicking the Assign Filter or Save Filter button.
6. The Audit information displays.
Figure 10-11: Audit Information

The Audit information is displayed via the Message and User Fields 1 through 6. A list of the fields and a description
of the information each field contains follows.
Message The message associated with the operation that generated the audit.
User Field 1 The user name of the operator that performed the operation.
User Field 2 Name of the operation.
Page
Page143
143
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
User Field 3 The time stamp recorded at the time the operation occurred.
Page
Page144
144
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
User Field 4 Name of the device (if applicable) on which the operation was performed.
User Field 5 Name of the client machine (if available) from which the operation was performed.
User Field 6 Additional message/text information that may be useful to an operator. This field may or may not
contain information in addition to the Message field.
The Audit information can be filtered in the same manner as any other Notifier data.
10.7.2
Specifying Filters for Views
Another way to customize an Alerts or Events view is to specify filters that determine the values of information that
will be displayed.
NOTE:
This operation uses a Java applet. When the Notifier Filter Selection window is open, accessing other
Java behavior. To prevent this, always complete your work with the Notifier Filter Selection window before
Should the browser appear to be inoperable, minimize all other windows until the Notifier Filter Selections
window appears. Alternatively, hold down the <Alt> key and press the Tab key to scroll through the running
processes. When the Java (coffee cup) icon is selected, stop pressing the Tab key and release the Alt key.
When the Notifier Field Selection window becomes active and you can close it, the browser becomes operable
again.
To specify filters for views:

1.
With the Events view or the desired Alerts view displayed in the Notifier, click the Filter Selection button. The
Notifier Filter Selection window displays.
NOTE: All of the field values selected as filtering data will be ANDed together, except for any of the severity field
values. The severity field values will be ORed together with the other filtering data.
The Notifier Selection window offers multiple ways to enter filtering criteria. The categories of filtering criteria
display in the left column of the window, while the values for those categories display in the right column.
At the top of the Notifier Filter Selection window, above the criteria categories, is a drop-down menu that
contains the names of filters already created. See the procedure in this chapter, To apply an existing filter.
2. Select a filter category from the left column, click on its value field in the right column, and select or enter the
desired criteria.
IMPORTANT!
After any change have been made to any value field in this window, press the Enter key or click another
value field before clicking the Assign Filter or Save Filter button!
The options in this window are as follows:
Name A text field that allows you to name the filter you are about to create. Click the mouse in the text field,
delete the text that is there, and type the name of the new filter you are creating.
Status A drop down menu for selecting the alarm status to display.
Page
Page145
145
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Figure 10-12: Notifier Filter Status Option Field
Source A text field for specifying a source-managed object name. Click the text field and type the source name
of the device (as it is specified in the devices configuration name field on the Information Tab). This field accepts
wildcards (example HMS*).
Figure 10-13: Notifier Filter Source Field
Start ID, End ID Text fields for specifying a range of alerts by alert ID number. Click the text fields and type the
start and end alert ID values.
Figure 10-14: Notifier Filter Start ID and End ID Fields
Priority A drop-down menu for specifying an alarm priority. Any alarm with a priority value that is equal to or
more severe than the specified value will be displayed.
Figure 10-15: Notifier Filter Priority Field
Page
Page146
146
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Severity Seven drop-down menus for selecting whether to include alarms of seven severities: critical, major,
minor, warning, information, clear, and unknown. Click each drop-down menu and choose selected to include
alarms of that severity, choose not selected to exclude them from the display.
NOTE:
Alarms of severity Clear, Informational, and Unknown are displayable in the Events view only. When a filter that
includes these three severities is assigned to an Alerts view, the resultant display will not include alarms of
these three severities.
Figure 10-16: Notifier Filter Severity Fields
Tree view A drop-down menu for selecting alarms only from devices that exist in a particular tree view. The
drop-down menu displays CheetahXD tree views, as well as all user-created tree views.
When this value is set to none, the Notifier accepts and displays alarms from all devices, whether monitored by
CheetahXD transponders or not. To filter alarms, click the drop-down menu to the right of Tree view and select a
tree view. The native view displays all CheetahXD-monitored devices.
Figure 10-17: Notifier Filter Tree View Field
Filter Activated This drop-down menu offers another way to display the default view. Click the drop-down menu
and select yes to activate the current filter for the current view, or no to deactivate the filter and display default
alarm parameters.
Figure 10-18: Notifier Filter Filter Activated Field
Page
Page147
147
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Date Range This drop-down menu allows you to specify a range of dates. The default, None, displays all
alarms meeting the criteria of this filter. Click the drop-down menu to select a specific date range.
Figure 10-19: Notifier Filter Date Range Field
Region A drop-down menu for selecting a user-defined region. If you have selected a tree view in the Tree View
section of this window (above) that is subdivided into regions, you can filter alarms to one of those regions by
selecting that region name here.
Be careful to ensure that devices you specify in the Source or Start ID and End ID fields exist in the region you
specify here. If they do not, the Notifier will not be able to display their alarms this filter.
Figure 10-20: Notifier Filter Device Group/(Region) Field
Application A text field for specifying an application, (HFC, CheetahNet, etc).
Figure 10-21: Notifier Filter Application Field
Device Category A text field for specifying the device category (type) such as Transponders, Fiber Nodes,
Power Supplies, etc. The categories specified here must match the categories as specified in the database. The
category of a particular device can be viewed on the Information tab of the Device Configuration page.
Figure 10-22: Notifier Filter Device Category Field
Alarming Attachment A text field for specifying the display name of a specific parent. The Alarming Attachment
is the parent object of a particular attribute in an alarm state.
Page
Page148
148
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Figure 10-23: Notifier Filter Alarming Attachment Field
Page
Page149
149
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Gateway Parent A text field for specifying the display name of a specific device. The Gateway Parent is the
parent device through which all communications occur. An example of a Gateway Parent would be a
transponder or a HEC model 360. The Gateway Parent is identified with the display name of the target device.
The Display Name (Gateway Parent) can be seen on the Property tab of the Device Configuration page.
Figure 10-24: Notifier Filter Gateway Parent Field
Top level Parent A text field for specifying the display name of the object or device connected to the Gateway
Parent. The Top level Parent is the device to which the Gateway Parent is connected.
Figure 10-25: Notifier Filter Top Level Parent Field
Attribute A text field for specifying a devices managed attribute that is actually in the alert state.
Figure 10-26: Notifier Filter Attribute Field
Creation Date A text field for specifying the date an alarm was created. This date must be in the format
MM/DD/YYYY or a validation error will occur when you attempt to save or assign this filter! This relates to the
date displayed in the Created column.
Figure 10-27: Notifier Filter Creation Date Field
Modification Date A text field for specifying a date the system (not a user) modified an alarm (for example,
from a Minor to a Major alarm. This date must be in the format MM/DD/YYYY or a validation error will occur
when you attempt to save or assign this filter! This relates to the date displayed in the Modified column.
Figure 10-28: Notifier Filter Modification Date Field
Page
Page150
150
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
User Field (1 through 10) Text fields the user can create and name to extend the available options for filtering
alarm display data. The alert and event record includes 10 fields that allow the user to apply values here and
then filter alert or event data by those values.
Figure 10-29: Notifier Filter User Fields
From Event Date (MM/DD/YYYY)/To Event Date (MM/DD/YYYY) These two fields work together to provide
event filtering at the server. The date range defaults to one day (beginning at 00:00:00 and ending at 23:59:59
of the specified date). Click either of these date fields and change the dates to change the range of events that
will display.
NOTE:
These two fields apply to events only, and have no affect on alerts when this filter is assigned to an alerts
view.
Figure 10-30: Notifier Filter From Event Date Field
Server Use this field to filter on CheetahXD server names.

Server IP Use this field to filter on server IP addresses.
NOTE:
The Server and Server IP fields are used primarily with an Enterprise Fault Server (EFS) system.
Figure 10-31: Notifier Filter Server IP Field

3. When filter criteria have been specified, click Save Filter. Select the Shared Filter checkbox if the filter is to be
used by multiple users. If the checkbox is deselected only the user who created the filter can view it. Or you can
leave the filter unnamed and click Assign Filter to use the filter temporarily for the current view. A named, saved
filter can be assigned to a view at any time in the future.
Page
Page151
151
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
10.7.2.1 Assigning a Filter to a View

The default filter and any filter you create, name, and save can be applied to the Events view or any Alerts view.
To assign a filter to a view:
1.
2.
With the Events view or the desired Alerts view displayed, click the Filter Selection button. The Notifier Filter
Selection window opens.
Click the drop-down menu below the title bar to display the list of available filters.

3. Click the desired filter to select it.
4. Click the Assign Filter button. The current view refreshes and displays new alarm data, according to the
parameters of the filter. The label on the Alerts or Events tab changes to include the name of the assigned filter,
and CheetahXD retrieves and displays the alarms or events that meet the filter criteria.
10.7.3
Layout Selection
Another way to customize an Alerts or Events view is to click the Layout Selection tab. The Notifier Layout Selection
window displays.
Figure 10-33: Notifier Layout Selection Window

When the Notifier Layout Selection window opens, select either an existing layout from the drop-down menu, or
name and save a new layout. Alerts associated with the selected layout display in the lower portion of the window.
Page
Page152
152
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
10.7.3.1 Saving, Applying, and Deleting Layouts

CheetahXD allows you to save, name, and apply layouts that you may want to use for a view at some future time.
Saving the current layout allows you to log out of CheetahXD and close the browser. When you next open the
browser, log into CheetahXD and display the Notifier. The saved layout appears by default. Applying a layout allows
you to recall a saved layout and apply it to the current view. Deleting a layout removes it from CheetahXD.
NOTE: Only the layout, consisting of the fields and filters applied to the layout, is saved. The data within the layout is not
saved. The data that displays when you open the Notifier is always current.
To access the layout functions, click the Layout Selection button. The Notifier Layout Selection window displays.
NOTE: This operation uses a Java applet. When the Notifier Layout Selection window is open, accessing other
Java behavior. To prevent this, always complete your work with the Notifier Layout Selection window before
Should the browser appear to be inoperable, minimize all other windows until the Notifier Layout Selection
window appears. Alternatively, hold down the <Alt> key and press the <Tab> key to scroll through the running
processes. When the Java (coffee cup) icon is selected, stop pressing the <Tab> key and release the <Alt> key.
When the Notifier Field Selection window becomes active, you may close it. The browser becomes operable
again.
To save a layout, type its name in the text field. Backspace through an existing name in this field to remove it from
the field. This will not remove the existing layout from the list. Click Save Layout.
To apply a saved layout to the current view, click the down arrow, highlight the desired layout and click Select Layout.
To delete a saved layout, click the down arrow, highlight the desired layout, and click Delete Layout.
10.7.4
Find Alert
To search for an alert by its ID number, click on the Find Alert tab. When the Find Alert window displays, enter the
number and click on the Find Alert button.
Figure 10-34: Notifier Find Alert Window

The alert with that ID number will be in focus, as shown in the previous image.
Page
Page153
153
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
You may also click the Alert Source radio button and type an alert source as displayed in the Source column in the
Notifier and then click Find Alert.
Page
Page154
154
CheetahXD
Fault
ViewsNotifier
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
The Notifier scrolls to the specified alert and highlights it. If the Notifier screen is not maximized, you may have to
scroll a bit further down to view the highlighted alert.
Click Cancel or the Close icon (in the upper right corner) to close the window.
10.7.5
Sound On/Off for Audible Alarms
You can configure sound processing for audible alarms when the site administrator has enabled global sound
processing in the configuration xml file in the CheetahXD sounds directory. (Sounds will be disabled if the site
administrator turns off sound processing within this file.)
A set of default sound files are shipped with CheetahXD, but the administrator can add sound files, assigning WAV
(Microsoft) or AU (Sun) sound files to be played for an alert of a specific severity. (A synthesized sound can also be
played as an audible alarm.) To enable an audible alarm for any or all of the alarm levels, select the Sound On/Off
tab. The Notifier Sound Manager window will open. As shown in Figure 10-35, you may select various sounds for the
alarm levels, or leave an alarm state Not Selected. Enable/disable any of the audible alarms by clicking the Enable
box.
Figure 10-35: Notifier Sound Manager Window

The sound configuration consists of:
Audio Clip State: The load state of the specified sound. If a true audio clip, it will denote loaded or load failure. If
synthesized, the sound is produced with an MIDI synthesizer and no actual sound clip is loaded.
Severity: The alert severity associated with the sound.
Audio Clip Name: Name of audio clip that exists on the CheetahXD server in the sounds directory.
Simple Piano Note: An MIDI synthesized sound equivalent to a piano note. When this is selected, the audio clip
name cell is not used.
Enabled: Defines whether this sound is enabled for processing or not. Individual sounds may be enabled or
disabled as desired.
The Sounds Enabled checkbox allows you to enable or disable sound processing for your ID only. This is not a global
state for all users.
Select the Update button when you have configured sound options.
Page
Page155
155
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
The Play Selected Sounds button lets you hear the sound to be sure it plays correctly. To do this:
1. Configure the sounds as desired.
2. Click the Update button to load the sounds from the server. Click Yes in the confirmation dialog box.
3. Click a severity under the Severity column to test. The Play Selected Sound button is enabled.
4. Click the Play Selected Sound button and the sound will play immediately. Ensure that sound playback is
enabled on your workstation and that volume controls are set for sound playback. Select another sound from
the box and click Update again.
NOTE: During an alert storm, where multiple alerts are arriving within seconds of one another, you may not hear each
individual sound. Alerts may be populated before the system has the ability to queue up the proper sound.
Example 1: When clearing multiple alerts at the same time, you will only hear a single sound for that action.
Example 2: If alerts are arriving less than 250 milliseconds apart, not all sounds may be heard. Audible sounds
depend upon a few variables, for example, machine properties and the size of the sound file being played.
10.8
The Notifier Dashboard View
The Notifier Dashboard view displays charts and graphs that depict the alerts and events in a visually comprehensive
manner. It is available to licensed users only. Choose the Notifier Dashboard tab to see the Notifier Dashboard
display.
Figure 10-36: Notifier Dashboard View

The Notifier Dashboard home page displays all alerts/events within the native domain. The primary sub-domains
(Native, HFC, HSD, and IP) are represented by individual pie charts.
The Notifier Dashboard home page contains the following graphs:
Primary sub-domains (Native, HFC, IP) rendered by individual pie charts

Alerts by Category graph that displays the top four device categories, which are sub-divided by alert severity in
a bar chart format
Device-type Pareto chart
24-hour time series chart
Seven-day time series chart.
Page
Page156
156
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
The Pareto chart provides a quality control mechanism that displays faults (in this case alerts or events) by use of a
composite bar chart/line chart, grouped by a pre-designated category. The bars within the chart display descending
Page
Page157
157
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
alert/event totals from left to right. The attached line graph displays alert/event percentages per category,
representative of the bar graph beneath it and totaling 100 percent (far right bar).
Figure 10-37: Device Type Pareto Chart

The number of bars or data points is a configurable parameter within the Pareto options dialog, accessible from the
mini-toolbar (the second button from the left). Each Pareto chart consists of three subcharts that differ in the
grouping category. Reverse-click on a bar in the chart to see the next Pareto subchart in the series, as shown next.
Figure 10-38: Device Type Transponder Chart

The new Pareto chart displays a subset of the alert/events that make up the parent chart. It contains only the
alert/events that generated the selected bar. A new grouping category is used to generate the newly displayed bars
and line graph. The default device-type Pareto chart consists of the following sub-Pareto charts: device type, device,
and measurement parameter.
There are four Pareto charts (selectable from the associated mini-toolbar) that have this drill-down capability. The
charts and their subcategories are as follows:
Device Type: device type, device, measurement parameter

Parameter: measurement parameter, device, device type
Device to Severity: device, severity, measurement parameter
Category to Severity: device type, severity, measurement parameter
All Pareto charts support drill-down to alerts/events by right-clicking the bar. A secondary tab displays the associated
alerts/events. All other Notifier Dashboard charts support drill down by clicking a chart component (such as a bar or
pie chart segment).
All Pareto charts have an associated mini-toolbar consisting of the following buttons:
Left arrow: navigate back from current sub-chart

Dialog with Pencil: set Pareto chart options (Pareto chart type and data points)
Printer: print selected Pareto chart
Magnifying glass with plus: zoom in on chart
Magnifying glass with minus: zoom out on chart
Page
Page158
158
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Large plus sign: expand chart to full screen in new tab.
Page
Page159
159
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Two time-series bar charts display alerts/events over different time intervals. The first displays alerts/events over a
24-hour period (2-hour intervals). The second displays alerts/events over a 7-day period (24-hour interval).
Click a color to view a Notifier Dashboard Alerts list, as follows. A new tab, Notifier Dashboard Alerts, displays for
each alert category that is queried.
Figure 10-39: Notifier Dashboard Alerts Tab

Click the Close View button to close any selected Notifier Dashboard Alerts tab. The trees Notifier Dashboard page
can be displayed by pressing the Trees button on the Notifier Dashboard navigation bar. This page displays minipanels that contain a snapshot of a domain.
The domains that can be displayed are default sub-domains (native, HFC, IP) and user-defined domains. Userdefined domains are defined in the tree applet.
Eight domains can be displayed at one time on a page. The following buttons provide support for displaying domains
that have a total greater than eight:
Select: displays selection dialog of available domains. Only selected domains will be displayed (dialog shown
below)
Forward: display next eight domains in selection list
Back: display previous eight domains in selection list.
If you click Select, the Notifier Dashboard Tree Selection window displays.
Page
Page160
160
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Figure 10-40: Notifier Dashboard Tree Selection Window
Page
Page161
161
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Each domain mini-panel will display only the alert/events that are related to that specific domain. For example, if the
HFC and Native trees are selected, a view such as the following window displays.
Figure 10-41: HFC and Native Alerts and Events

A domain mini-panel consists of a pie chart segmented by severity and the following statistical indicators:
Total managed objects in domain

Percent of system managed objects. Percentage displayed numerically and proportionally
Total domain alerts
Percent of managed objects in alarm state. Percentage displayed numerically and proportionally
Percent of system alerts. Percentage displayed numerically and proportionally.
The plus sign on the top of the mini-window allows for a more detailed view of the selected domain, shown in the
following illustration. When the plus sign is clicked, a new tab is added displaying the following charts:
Device Pareto chart

Category Pareto chart
Alerts by application (top 4)
Alerts by category (top 4)
Previous 24 hours time series
Previous 7 days time series.
Page
Page162
162
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Figure 10-42: HFC Tree View

The Notifier Dashboard can render charts of either current alerts or historical events. The selection is made by
pressing the Alerts button on the Notifier Dashboard navigation bar. A dialog box (shown below) will appear, allowing
the choice of displaying alerts or events.
Figure 10-43: Select Alerts or Events to Display Window

When the Events source is selected and the Select button is pressed, all charts will be cleared and additional Notifier
Dashboard related tabs closed. The Filter Selection Dialog will be automatically displayed to select the desired
events to be retrieved from the database. After setting filter selections, pressing assign filter will retrieve the events
from the database and render the Notifier Dashboard charts. This event retrieval will be used for all associated
charts (home page, tree page, etc.) until another event retrieval is done by accessing the filter selection dialog. The
filter selection dialog is only available for events, not alerts. When in alert mode, all current alerts are used for
rendering.
Page
Page163
163
Fault ViewsNotifier
CheetahXD
User Guide
10.9
CheetahXD
Fault ViewsNotifier
User Guide
Testing the Notifier
Test the Notifier by creating a device event. CheetahXD will send the created event to the Notifier as configured, as if
it were an actual device event.
To create and send an event to the Notifier, click the Send Event icon in the Administration page. The procedure is
described in detail in the chapter titled System Administration.
10.10 Local Context Menu

The local context menu displays when you click to select an alarm entry in the Notifier and right-click the mouse. It
displays as follows.
Figure 10-44: Notifier - Local Context Menu

If no entry is selected in the Notifier, the local menu cannot perform an action. A list of the Local Context menu
options follows, along with a brief description of each option. The options that appear in the menu will vary based on
the type of alert selected.
Detail Displays alarm details.

Clear Clears the alarm.
Acknowledge Acknowledges the alarm.
Delete Deletes the alarm from the display.
Data Display Launches Data Display.
Cheetah Net Data Display Launches the CheetahNet Data Display application. Requires a CheetahNet Client
installed on the target machine.
Device Config Launches Device Configuration.
Cross Navigation Displays the selected element in other contexts, tree views, etc.
View Events Displays the historical events for the selected alert.
Quick Filter By Field Name Creates a quick filter based on the data contained within the field whose name
appears as the Field Name portion of the menu.
Clear Modified Quick Filter (x) Clears the quick filter whose name appears as the Filter Name portion of the
menu. The number in the parentheses indicates the number of active quick filters and is the number of the most
recently created filter.
Clear All Active Quick Filters Clears all of the active quick filters.
Page
Page164
164
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Related Alerts Menu option to view alerts upstream or downstream of a given alert based upon the devices
location in a Tree View.
Page
Page165
165
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Map Alert When valid location information is added in the Location field of the transponder this menu option is
available to see the device location via mapping software.
Custom Extensions Optional menu item that displays a sub-menu of user-specified options (see the Section
10.10.10) CheetahXD/listmenus/NotifierMenuExtensionssample.xml.
The local menu for a status update alarm excludes the Data Display, Device Config, and Cross Navigation options.
10.10.1 Displaying Alert or Event Details

Obtain more information about any entry in the Events or Alerts view.
To display Alert or Event details:
1.
2.
3.
Click the desired entry in the Events or Alerts view to select it.
Right-click to display the local context menu.
Select Detail from the local menu. The Notifier Detail Selection window displays.
Figure 10-45: Notifier Detail Selection Window

An acknowledged alarm includes annotations that CheetahXD adds to the alert. The annotation consists of the
user name of the person acknowledging the alarm as well as the date and time the alarm was acknowledged.
When viewing details for acknowledged alarms, the View Alert Annotations button is active.
Click the View Alert Annotations button to view the annotations. The Alert Annotations window displays.
Page
Page166
166
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Figure 10-46: Alert Annotations Window

10.10.2 Clearing Alarms
Alarms can be cleared from Alerts views only.
To clear an alarm:
1.
2.
3.
Select the desired alarm in an Alerts view.

Right-click to display the local context menu.
Select Clear from the menu.
The entry for the selected alarm is removed from the Alerts view because cleared alarms are not displayed in Alerts
views. In the Events view, the Severity column for the selected alarm changes to clear while the username and date
and time stamp (the annotation) is removed from the alarm. Also, when an alert is manually cleared, an Information
Event is generated. The name of the user responsible for clearing the alert is listed as the source of the event, and
the original alert ID is displayed in the message column.
10.10.3 Acknowledging Alarms

Alarms can be acknowledged from an Alerts view only. When a user acknowledges an alarm, CheetahXD adds an
annotation to the alarm, which includes the user name of the person acknowledging the alarm along with the date
and time the alarm was acknowledged.
NOTE:
When the alarm is cleared or deleted, the alert becomes an event and its annotation is removed.
To acknowledge an alarm:
1.
2.
3.
In an Alerts view, select the desired alarm.

Right click to display the local context menu.
Select Acknowledge from the menu.
The Status column for the selected alarm changes to ack in the Alerts view, and a username and the date and time
stamp (the annotation) is added to the alarm.
NOTE: Groupings of contiguous and noncontiguous alerts can be acknowledged using the Shift and Control (Ctrl) keys,
respectively.
10.10.4 Deleting Alarms
Page
Page167
167
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Alarms can be deleted from Alerts views only.
Page
Page168
168
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
To delete an alarm:
1.
2.
3.
In an Alerts view, select the desired alarm.

Select Delete from the menu.
The entry for the selected alarm is removed from the Alerts view (but still displays in the Events view), and the
username and the date and time stamp (the annotation) is removed from the alarm.
10.10.5 Launching Data Display for Device in Alarm State

To obtain the current data for a local device in either an Events or Alerts view, you can launch the Data Display
directly from the Notifier. However, data that originates from a remote location, such as a Regional Operations
Center (ROC), cannot be viewed in this manner.
To launch Data Display from the Notifier:
1. Select the desired device from an Alerts or Events view.
2. Right-click to display the local context menu.
3. Select Data Display from the menu. The CheetahXD Data Display opens and displays the data for the selected
device.
Figure 10-47: Data Display Page

For more information, see the chapter titled Displaying Data.
10.10.6 Launching Device Config for Device in Alarm State

To obtain configuration data for a device in either an Events or Alerts view, you can launch Device Config directly
from the Notifier.
To launch Device Config from the Notifier:
1.
2.
3.
Select the desired device from an Alerts or Events view.

Select Device Config from the menu.
Page
Page169
169
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
The CheetahXD Device Configuration page opens and displays the configuration data for the selected device.
Click the Plus icon next to the device name to expand and view a list of configuration data.
Page
Page170
170
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide

For more information, see the chapter titled Provisioning Devices.
10.10.7 Cross Navigation

For a device in an alarm state, CheetahXD allows you to visually correlate the device in terms of its various
relationships, such as its power, signal, or IP relationships, to more quickly pinpoint the actual cause of the alarm
state. Cross navigation allows you to see the device in trees that reveal its upstream and downstream devices, its
parent and child devices, and any other type of device relationships for which you have created specific tree views.
Select Cross Navigation from a devices local context menu in a tree view. Other tree views, in which this device
exists, are displayed. You may select any of the tree names in the list.
Figure 10-49: Cross Navigation Page

Select a view and CheetahXD displays the device, highlighted, within that tree view in the Tree Editing pane.
Page
Page171
171
Fault ViewsNotifier
CheetahXD
User Guide
IMPORTANT!
CheetahXD
Fault ViewsNotifier
User Guide
After returning to the Notifier display, click the Refresh link under the View menu at the top of the page
to insure the Notifier display is current!
Page
Page172
172
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
10.10.8 Viewing Alarm Events

To view the historical events for a device in an alarm state, select View Events from the local context menu. All
events, not just alerts, display.
10.10.9 Implementing and Clearing Quick Filters

The quick filter option allows the operator to filter fault data quickly and easily using data within any of the fields.
Click to select a field, right-click to view the menu, and select the Quick Filter By option.
To Implement a Quick Filter:
1. Select the desired field from the Alert or Event details view by first left-clicking on the row containing the field
you wish to use, and then right-clicking on the field to view the menu.
2. From the menu, select the Quick Filter By option from the menu to create the filter. The menu heading will
display the name of the field your mouse is hovering over as part of the option. For example, if you reverse-click
to view the menu over the Status field, the menu option would display Quick Filter By Status.
NOTE: If the selected field has already been used to create an existing (active) quick filter, the menu option will not
be available. The system will not allow the user to create two filters using the same field.
Figure 10-50: Local Context Menu Quick Filter By Option

3. The quick filter data display in the Information section of the Notifier window. If more than one quick filter is
active, the most recently created filter information displays.
Page
Page173
173
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Figure 10-51: Quick Filter Data

To Clear a Quick Filter:
1. Select a field from the Alert or Event details view by first left-clicking on the row containing the field and then
right-clicking on the field to view the menu.
2. Cancel a single (the most recently created filter) by selecting the Clear Status Quick Filter (1) selection from the
menu. The actual menu selection displays the name of the current filter and the number of active filters in the
parentheses. The name and number of filters displayed in the menu will differ based on the actual situation at
the time. To cancel all of the active filters at once, select the Clear All Active Quick Filters menu option.
10.10.10 Related Alerts (Upstream/Downstream Alerts)

With properly configured tree views, operators can see which devices are impacted by a specific alert in a targeted
Topology. Operators can choose to see impacted Parent, children or sibling devices. To access this feature, perform
the following tasks:
1.
2.
Highlight the target alert in the Fault View Tab and right-click to view the Common Menu.
Select Related Alerts option which will display 4 choices:
a. Parent Alerts - Display alerts for each device that is a Parent of the target device for a selected tree.
b. Children Alerts Display alerts for each devices that is a child of the target device for a selected tree.
c. Sibling Alerts Display alerts for each device that is a sibling of the target device for a selected tree.
d. All Display all alerts parent, child or sibling of the target device for a selected tree.
3. After selecting the Related Alert type, the listing of associated Tree Views for the target alert is displayed.
4. Select the Target Tree View to see the alerts for the impacted devices.
5. A filtered Notifier view in a new Tab will be displayed consisting of only those alerts associated with the options
chosen.
Page
Page174
174
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Figure 10-52: Filtered Notifier View

10.10.11 Map Alert
This menu option display on a map the location of the target device based upon the information populated in the
devices Location field (Device Configuration/Property Tab). A device location can be identified by a Street address,
Lat/Long or GPS coordinates. Click to select a device and right-click to view the Common menu. Select Map Alert.
The following view displays.
Figure 10-53: Map Alert

The map displays the physical location of the device. Click Quickest Route to get directions In the Select Route Points
field, click to place the device in focus and click Quickest Route to get directions. Use Ctrl-Click to select multiple
devices.
10.10.12 Custom Extensions

This option contains a sub-menu that users can populate with user-specified commands. These commands can be a
system command or a URL.
The CheetahXD installation places the file notifierMenuExtensionssample.xml in the CheetahXD/listmenus/
directory. To use the custom extension, rename the file notifierMenuExtensions (or open and select File > Save As
and name the file notifierMenuExtensions). When a file with the name notifierMenuExtensions exists in the
CheetahXD/listmenus/ directory, the alerts and events local menu includes the item Custom Extensions.
Page
Page175
175
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
The file notifierMenuExtensionssample.xml includes sample commands to copy, paste and edit to create items on
the submenu of Custom Extensions. When the file is renamed as described in the previous paragraph, the option
Page
Page176
176
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Custom Extensions appears on the alerts and events local menus, and the samples in the file appear as submenu
options. Edit the xml file to create and name your own custom extensions following the examples, and the names of
your custom extensions will appear on the Custom Extension submenu.
To Create Options on the Custom Extensions Sub-Menu:
1.
2.
3.
Open the file notifierMenuExtensionssample.xml in a text editor.

Save it using the name notifierMenuExtensions.xml (to preserve the original sample file).
Following the examples in the file, create your own custom extensions.
An example of a custom extensions definition follows. In the following example:
nametag: specifies the name to be used for the menu item.

sCommand tag: specifies the system command to be issued.
sUrl tag: specifies the URL to be navigated to.
Type tag: specifies the type of menu where 0 = URL and 1 = system command.
<DynamicMenuItems>
<dmItems>
<DynamicMenuItem>
<name>Device Configuration</name>
<sCommand></sCommand>
<sUrl>/navigation/navigation.do?applicationName=/deviceconfig/DeviceConfig.do&
deviceName=${Source}</sUrl>
<type>0</type>
</DynamicMenuItem>
<DynamicMenuItem>
<name>Cheetah</name>
<sCommand></sCommand>
<sUrl>http://www.Cheetah.com</sUrl>
<type>0</type>
</DynamicMenuItem>
<DynamicMenuItem>
<name>Text Editor (Notepad)</name>
<sCommand>notepad</sCommand>
<sUrl></sUrl>
<type>1</type>
</DynamicMenuItem>
</dmItems>
</DynamicMenuItems>
Each menu definition consists for the following xml lines:
<DynamicMenuItem>
<name>Text Editor (Notepad)</name>
<sCommand>notepad</sCommand>
<sUrl></sUrl>
<type>1</type>
</DynamicMenuItem>
Page
Page177
177
Fault ViewsNotifier
CheetahXD
User Guide
10.10.12.1
CheetahXD
Fault ViewsNotifier
User Guide
Dynamic Menu Arguments
URL and command specifications can include arguments. The argument values come from the selected alert/event
from where the pop-up menu was launched.
An argument starts with ${ and ends with }. The middle of the argument specifies the column name to be used. The
column name is case-sensitive. Embedded blanks must be honored. This option allows for the use of any device
property within the user-specified command. As an example, you could add a custom extension which will launch the
transponders webpage by IP Address.
<sUrl>http://${ipAddress}</sUrl>
<type>0 </type>
Sample Supported Properties List Note the property name is case-sensitive and must be used as seen below to
function properly.
name
displayName
type
ipAddress
netmask
userName
commHandler
ctTopoObjectType
userComment
protoSpecificData
topLevelParent
gatewayParent
location
userField1
userField2
userField3
userField4
userField5
community
writeCommunity
macAddress
transponderType
pollInterval
Example: An argument specifying an alert/event source name would be ${Source}. This would be used anywhere
the actual source name would be required in the command or URL. The following URL specification will correctly
launch the device config web application:
<sUrl>/navigation/navigation.do?applicationName=/deviceconfig/DeviceConfig.do&deviceName=${Source}</s
Url>
10.10.12.2
Runtime Requirements
The Notifier uses the XStream library. The xstream-1.0.jar file is downloaded to the client automatically when the
Notifier applet is invoked.
The webnmsNotifier.jar and the xstream-1.0.jar files must be self-signed. The user must accept the signed jars when
prompted. This is only required once for the same signed jar file.
If the user does not accept the self-signed jar files, the Notifier will continue to run, but the dynamic menu
functionality will be disabled.
10.11 Historical Event Processing

This feature allows for the archival of pertinent Events from the CheetahXD system. Every 6 hours, CheetahXD
automatically copies the latest set of Events out of the database and stores them in a daily .csv file located at
CHEETAHXD_HOME\backup\events on the server. The csv file naming convention is Events_YYYY-MM-DD.csv.
The Events can be viewed using any csv editor or can be pulled into the Faults GUI if needed.
Page
Page178
178
Fault ViewsNotifier
CheetahXD
User Guide
IMPORTANT:
CheetahXD
Fault ViewsNotifier
User Guide
These files are never removed from your server by CheetahXD so care must be taken to ensure that
disk space does not become an issue. It is the responsibility of the operator to ensure available space
for the backup process to continue.
Page
Page179
179
Fault ViewsNotifier
CheetahXD
User Guide
NOTE:
CheetahXD
Fault ViewsNotifier
User Guide
If the current days .csv is open for editing, the system will not be allowed to write events to the file. We suggest
that if you want to work with historical events from the current days file, that you copy the data into another file
as to not interrupt the backup process.
This feature is not intended to pull tens of thousands of events back into Notifier that have already been purged out.
If you are trying to trend data or count specific event types, the preferred mechanism would be using the CSV files
directly. Most XD clients will not have enough memory to handle the volume of events that span a period of 5 days or
more.
10.12 Current Alerts/Events Reporting

This feature allows a user to print a listing of current alerts/events to .csv or PDF format by clicking the applicable
button. Any alert or event displayed on the active tab within the Faults screen will be printed to the selected file type.
Figure 10-54: CSV and PDF Buttons

Using the .csv format allows users to output all currently displayed columns within the active tab because of the
space available in a file.
To output the data in a PDF format, only the first 7 or 10 columns in the view will be printed due to space
constraints. The PDF report is printed to an 8.5-by-11 page in a landscape orientation.
Page
Page180
180
Fault ViewsNotifier
CheetahXD
User Guide
CheetahXD
Fault ViewsNotifier
User Guide
Page
Page181
181
CheetahXD
Fault
ViewsUser
Power
Guide Outage Monitoring
11
Fault Views PowerCheetahXD

Outage Monitoring
User Guide
Fault Views Power Outage Monitoring
The Power Outage Monitoring application of CheetahXD actively tracks power supplies affected by a commercial
power outage. The module closely monitors the condition of the effected power supplies batteries to provide a clear
picture of the situation in the field in order to prioritize truck rolls and avoid network outages.
A power supplys ability to remain in standby, operating under its own batteries, is directly related to the reserve
power available in its batteries. Battery reserve power is dependent upon the following:
Battery manufacturing date The older the battery, the shorter the battery reserve power
Battery type (6 Volts, 12 Volts) The batterys discharge rate depends on its voltage and technology
Power supply model Different models offer different battery efficiencies
Current drawn The more current drawn, the shorter the battery reserve power
Temperature The more extreme the temperature (either hot or cold), the shorter the battery reserve power
Power supply history The higher the number of recent outages, the shorter the battery reserve power.
The Power Outage Monitoring module combines information from a power supplys configuration data with real- time
data received from power supply transponders, combined with user-customized parameters, to determine when a
power supply triggers an alert that will be monitored by the Power Outage Monitoring application.
When a power supply toggles between normal and standby status, the Power Outage Monitoring application
aggregates the alarms triggered over a specified time period into a single active alarm, and then displays it.
11.1
Power Outage Alarm Processing
In General the 3 basic steps of Power Outage Monitoring operation are:

1.
When a PS loses commercial power, goes into Standby AND the AC Input Voltage falls below the value set in the
PowerOutageMonitoring_Parameters.xml file, a POM alert is generated. After a cycle you will see:
2.
If commercial power is restored, PS comes out of Standby AND the AC Input Voltage alert clears, you will see:
3.
Standby Status = Standby On

Standby Remaining = Not Available, Unknown, Gathering Data or Actual Time calculation
Standby Status = Normal

Standby Remaining = ----
If Commercial power is restored, PS comes out of Standby BUT the AC Input Voltage alert remains, you will see:
Standby Status = Standby Off

Standby Remaining = Not In Standby
Two CheetahXD services (in addition to the device-configuration information) provide the information to the Power
Outage Monitoring application.
The Battery Administration service and the CTPowerOutageMonitoringProcess service perform the required
processing of input voltage alarms, dynamic determination of duration values, and aggregation of alert information.
From this information, displayed alerts are created, updated, and/or deleted. Consolidating the alert processing
within these services allows the Power Outage application to update in virtually synchronous fashion.
Specifically, the two services provide the following information:
Static device information concerning power supply characteristics (i.e., battery string configurations)
Page
Page182
182
CheetahXD
Fault
ViewsUser
Power

Outage Monitoring
User Guide
Device measurement information concerning total string voltage

An algorithm to determine duration of standby remaining
Page
Page183
183
CheetahXD
Fault
ViewsUser
Power

Outage Monitoring
User Guide
An algorithm to determine potential truck dispatch time

Processing of input voltage drop alarms (the threshold drop is externally parameterized)
Aggregation of input voltage alarm information into a new critical alarm with a predetermined attribute
Additionally, the CTPowerOutageMonitoringProcess:
Traps power supply input voltage drop alerts

Checks for an active critical alert with a predetermined attribute
If one exists, updates outage occurrence count and interval data
If one does not exist, creates new critical alert with associated default values (for example, 24-hour
occurrence count, alarm status, standby status)
Updates active alerts on a periodic cycle
The interval values, current status, and alarm status of each active alert is updated at a predetermined interval
Purges severity alerts after a specified time to live interval has expired (specified in
pomMessageTimeToLiveInHours, described later in this chapter)
Power supplies that have active Power Outage Monitoring alerts are checked after the specified
interval for their status (standby or normal)
If the power supply is not in standby and input voltage has returned to normal, its alert will be
purged from the active alert list when the normal status duration exceeds the time to live interval
(specified in pomMessageTimeToLiveInHours, described later in this chapter).
In General the 3 basic steps of Power Outage Monitoring operation are:

1.
When a PS loses commercial power, goes into Standby AND the AC Input Voltage falls below the value set in the
PowerOutageMonitoring_Parameters.xml file, a POM alert is generated. After a cycle you will see:
2.
If commercial power is restored, PS comes out of Standby AND the AC Input Voltage alert clears, you will see:
3.
Standby Status = Standby On

Standby Remaining = Not Available, Unknown, Gathering Data or Actual Time calculation
Standby Status = Normal

Standby Remaining = ----
If Commercial power is restored, PS comes out of Standby BUT the AC Input Voltage alert remains, you will see:
Standby Status = Standby Off

Standby Remaining = Not In Standby
Page
Page184
184
CheetahXD
Fault
ViewsUser
Power
11.2

Outage Monitoring
User Guide
Accessing Power Outage Monitoring
The Power Outage Monitoring application is a separately licensed application that also requires a valid Battery
Administration license. If no valid licenses exist, or if the Battery Administration service is not running, the system
displays an error when a user clicks a Power Outage link to open the Power Outage Monitor.
The Power Outage Monitoring application is accessible through the Faults tab of CheetahXD.
Figure 11-1: Faults Page Menu

The two Power Outage Monitoring application links (in the menu above) display the application in the regular browser
window (Power Outage), or as a full-screen display [Power Outage (Full)].
11.3
The Power Outage Monitoring Display
The following page displays when selecting the Power Outage link from the Faults page.
Figure 11-2: Power Outage Monitoring Display Page

NOTE:
When displaying as a full screen, the Exit Full Screen button becomes active to allow you to easily exit full
screen mode.
Sortable columns display power supply alert information.
Display Name The display name of the power supplys transponder.

Model The device model type as determined from the model mapping in the englishtonative.properties file.
Battery Config The number of batteries in the power supply as dynamically determined from the power
supplys configuration data and the total string voltage.
Occurrences The number of times a power supplys input voltage has dropped in the last 24 hours
(determined when the alert is first created).
Stand by Status The status of the power supply, either Normal or Standby.
Status Started The time the current status began.
Status Duration The duration since the current status began.
Stand by Remaining Dynamic determination of the remaining standby time of the power supplys batteries.
Dispatch Time System-calculated time for a potential truck roll. The background color of this field changes to
red when the time for a potential truck roll has been reached.
Page
Page185
185
CheetahXD
Fault
ViewsUser
Power

Outage Monitoring
User Guide
POM Severity The highest severity of other alarms triggered for this power supply (or any measurable attribute
other than voltage drop, as specified in the power supplys device configuration).
Page
Page186
186
CheetahXD
Fault
ViewsUser
Power

Outage Monitoring
User Guide
User Field 1 Available for customer use (such as ticket number).

User Field 2 Available for customer use.
User Field 3 Available for customer use.
Location The location of this device as reported by device configuration application.
Message Free form message text that can be user-created and updated (by accessing the Update Message
option from an alerts local context menu). This message is displayed for the alarm in every instance of the
Power Outage Monitoring application that is running.
11.4
Customizing the Power Outage Monitoring Application
Customize the Power Outage Monitoring application to determine how it handles and displays alerts and determines
when to trigger a truck roll.
11.4.1
Specifying Parameters
For an accurate computation of the standby estimate during a commercial outage, it is necessary that the
PowerOutageMonitoring configuration file (under the CheetahXD/conf folder) be configured with the information
about your power supplies and batteries.
There are two types of algorithms that are used for the computation of the standby capacity during commercial
power outage conditions.
1. Predictive computation (PKC): This is more accurate than the LSS method below, and uses detailed information
about the power supply and its batteries. This computation is used for all of the HMS and DOCSIS HMS devices.
2. Least Squared Method (LSS): This is used for all non-HMS power supply types, and as a fallback when PKC
cannot be used.
User field 2 in the POM alert shows the type of algorithm (PKC or LSS) that is being used for the computation of the
standby capacity. User field 3 in the POM alert provides an indication of the reliability of the standby estimate. For
example, if the slope drops off too steeply or too soon, the batteries may not be fully-charged, and we will indicate in
this field that the standby estimate is unreliable.
The POM algorithm has been updated to provide its first Standby Remaining value as close to 10 minutes as possible
based upon the user defined <pomRefreshInterval> value set in the powerOutageMonitoring_Parameters.xml file.
Once the initial value is displayed, the algorithm is then updated based on the <pomRefreshInterval> going forward.
The following table defines the various POM configuration parameters and their description. Open the file
CheetahXD\conf\ PowerOutageMonitoring_Parameter.xml in Notepad or a similar editor to customize the
parameters in the following table. Restart CheetahXD for parameter changes to take effect.
Parameter Name
pomAnalysisCutoffBiasInSeconds
Default Value
Parameter Description
Additional time in seconds to subtract from actual

standby time computed in POM Notifier. Should be zero
by default.
If voltage gets within 3 volts of the cutoff voltage, the
POM shifts to a smaller window size for the Least
Squares calculation (if being used). This makes it
quicker to pick up changes in the slope of the voltage
dropoff.
Unused but needs to be here for backwards
compatibility.
pomCriticalVoltageDifferential
3.0
pomCutoffVoltage12VoltBattery
10.5
Page
Page187
187
CheetahXD
Fault
ViewsUser
Power

Outage Monitoring
User Guide
pomCutoffVoltage6VoltBattery
5.3
Page
Page188
188
Unused but needs to be here for backwards

compatibility.
CheetahXD
Fault
ViewsUser
Power
Parameter Name

Outage Monitoring
User Guide
Default Value
pomCutoffVoltageTable
This is the top level element, below which the various

configurations of power supply types are defined.
entry
The <entry> and </entry> tags hold all information

about a particular power supply modifier. A separate
entry is required for each personality type.
String
Standard
CTPomCutoffVoltages
battAge
battAmpHrRating
battChem
cuttoffVoltage12VoltBattery
Personality of power supply. Standard is used as

default.
Element that holds the power supply and battery
specific information for a particular personality.
Unknown
70
Unknown
10.5
Age of oldest battery in string. Possible choices are:

Unknown
New
6 Months
1 year
1 years
2 years
2 years
3 years
3 years
4 years
4 years
5 years
More than 5 years
Defines the Amp Hr rating of power supply.
Holds the battery chemistry information. Choices are:
Lead
Acid
Gel
Cell
APC
P
Other
12 volt battery cutoff value. This is the finish line on
which the calculations will be based.
cutoffVoltage6VoltBattery
5.3
6 volt battery cutoff value. This is the finish line on

which the calculations will be based.
max2Battery12VLifetimeInHours
1.5
Max lifetime for 2 batteries, 12 volts. Calculation for this

configuration will not exceed this value.
1.0

3.0
Max lifetime for 3 Batteries, 12 volts. Calculation for this

2.0
Max lifetime for 3 batteries, 6 volts. Calculations for this

4.0

Page 161
CheetahXD
Fault
ViewsUser
Power

Outage Monitoring
User Guide
3.0
Page 162

CheetahXD
Fault
ViewsUser
Power
Parameter Name

Outage Monitoring
User Guide
Default Value
maxNBattery12VLifetimeInHours
5.0
Max generic lifetime catch-all for all other 12V battery

configurations.
maxNBattery6VLifetimeInHours
4.0
Max generic lifetime catch-all for all other 6V battery

configurations.
powerSupplyType
pomDefaultDispatchLeadTimeInMinutes
pomDeltaSlope
pomInputVoltagePowerOutageThreshold
Unknown
5
-0.015
0.0
PS Type. Choices are:

Unknown
Alpha AM
Alpha AM2
Alpha XM
Alpha XM2
Alpha/Lectro ZTT
Alpha/Lectro ZTT+
Alpha/Lectro SS
Alpha/Lectro CPR
APC
TSP
Antec/PG
Slug Equisil
Subtract this from standby estimate for dispatching
tech.
Change in slope by this much triggers smaller window
size for least squares calculation.
Input Voltage must drop below this value to trigger POM
Calculation.
omMessageTimeToLiveInHours
POM alert will be deleted from the system after this

number of hours (after restoration of commercial
power).
pomMinWindowSize
20
Minimum window size (number of samples) for

calculations.
pomSeasonalAdjustmentInMinutes
A seasonal or other situational time adjustment that the

application will add to determine a truck roll. A positive
number reduces the dispatch time, while a negative
number increases the time to dispatch.
NOTE:
By using the Device Config application, an operator can set an individual power supplys type, the battery
chemistry, the battery age, and its Ampere hr rating. These parameters, when set, will override the default
configurations set in the POM XML file for this particular power supply device. The Device Config override is
only available for HMS Power Supplies.
Page 163
CheetahXD
Fault
ViewsUser
Power
11.4.2

Outage Monitoring
User Guide
Filtering Alerts
Click the Filter Selection button at the top of the Power Outage Monitoring application to display the Notifier Filter
Selection window.

The Notifier Filter Selection window (refer to the following illustration) is the same filter selection window used by the
Notifier. See the section titled, Specifying Filters for Views in the chapter Fault ViewsNotifier, for more information
on using Filter Selection. Filtering the Power Outage tab of the Notifier is limited to Power Outage Module alerts, and
these filters cannot be saved or shared across views. The filter in the Events tab, however, operates in the same
manner as the default Notifier filter.
Customizable options are as follows.
Source In the Power Outage Monitoring application, the Source is the display name of the power supplys
transponder, rather than the managed object name. Change the Source in this window by clicking the field in the
right column next to Source and typing a display name.
User Field 1 through 3 For adding customer-defined information to an alert such as a ticket number. Data can
also be added to the user fields through the Send Event utility (for more information, see the chapter titled
CheetahXD Utilities).
Although only three user fields in the Notifier Filter Selection window are customizable, the window includes ten
user fields. The Power Outage Monitoring application uses the following seven user fields. Below is a list of the
fields with a brief description of the information displayed in each field.
User Field 4 displays the alarm status.
User Field 5 displays the time before dispatch.
User Field 6 displays the time remaining in standby.
User Field 7 displays the status duration.
User Field 8 displays the status start time.
User Field 9 displays the status (i.e., normal or standby).
User Field 10 displays the input voltage drop occurrence count.
Page 164
CheetahXD
Fault
ViewsUser
Power

Outage Monitoring
User Guide
For more information on accessing and using alert user fields, see the section titled Specifying Filters for Views in
the chapter titled Fault ViewsNotifier.
Page 165
CheetahXD
Fault
ViewsUser
Power
11.5

Outage Monitoring
User Guide
Local Context Menu
Alarms displayed in the Power Outage Monitoring module can be right-clicked to display a local context menu. The
menu contains the same options as in the Notifier local context menus (see the section titled Local Context Menu in
the chapter Fault ViewsNotifier), with the addition of Update Message, where users can add text messages to
alarms in the Power Outage Monitor. Because the source name for Power Outage alarms are handled differently, the
Data Display, Device Configuration, Circuit View, Cross Navigation, and View Events are not available from the Power
Outage tab.
11.6
Finding Alerts in the Power Outage Monitor
The Find Alert button at the top of the Power Outage Monitor allows users to search for alerts by source name or by
an alerts ID number.
Figure 11-4: Find Alert Button

To find a power outage monitor alert:
1.
Click the Find Alert button and the Notifier Find Alert dialog opens, as shown next.
Figure 11-5: Notifier Find Alert Window

2.
3.
Click the radio button next to either Alert ID or Alert Source, and type a value in the Input Search Value field.
Wildcards are allowed.
Click Find Alert and the Power Outage Monitoring module displays the alert or alerts that meet the criteria.
Page 166
CheetahXD User
Scheduling
Data
Guide
Collection
12
Scheduling
CheetahXD
Data Collection
User Guide
Scheduling Data Collection
The Scheduler allows for collecting data on a set of user-specified devices or template attributes. Data can be
collected on-demand or continuously, on a user-specified schedule. Multiple schedules can run simultaneously.
NOTE:
12.1
The Scheduler offers background and on-demand data collection operations. Creating battery test schedules is
a separate operation. For more information on battery test schedules, see the chapter titled Testing Power
Supplies.
Opening the Scheduler
To open the Scheduler:

1. Click the Domain Options tab.
2. Click the HFC Domain option.
3. Click the Scheduling link. Regardless of which domains Scheduling link chosen, schedules may be viewed or
created for devices in either domain.
The Schedule Management page displays and manages existing schedules.
Figure 12-1: Schedule Management Page
12.2
Creating a Schedule
Create a schedule by specifying the device types (Device-Instance-Based schedule) or the templates the devices are
using (Template-Based schedule), and specifying the times the data collection operation will run. Create a schedule
from scratch or clone an existing schedule and modify it to create a new schedule.
Page 165
CheetahXD User
Scheduling
Data
Guide
Collection
12.2.1
Scheduling
CheetahXD
Data Collection
User Guide
Creating a Template-Based Schedule
A Template-Based schedule performs data collection on all managed devices using the templates you select for the
schedule. Selecting templates is similar to selecting devices for a Device-Instance-Based schedule, except after
selecting the devices for the schedule, the Schedule Manager displays the templates used by the devices, and
executes data collection on all managed devices using those templates.
To create a Template-Based Schedule:
1.
2.
Open the Scheduler.

Click the Add New button. The following page displays.
Figure 12-2: Select Schedule Type and Schedule Name Page

3. Click the Template based radio button.
4. Type a name for the schedule in the Schedule Name field. The name cannot begin with a number and must not
contain spaces or special characters.
5. Click Continue. The Schedule Setup page opens to the Templates page.
Figure 12-3: Schedule Setup Page

The Schedule Name and the Schedule Type (Device-Instance-Based or Template-Based), displays at the top of
the page. Three pages allow you to specify the Devices, Attributes, and Timing parameters of the schedule.
Page 166
CheetahXD User
Scheduling
Data
Guide
Collection
6.
Scheduling
CheetahXD
Data Collection
User Guide
Click the Selected Application Filter drop-down menu and select the HFC domain.
Page 167
CheetahXD User
Scheduling
Data
Guide
Collection
7.
Scheduling
CheetahXD
Data Collection
User Guide
The Search Criteria Properties portion of the Devices page allows you to specify the actual criteria for choosing
the devices to be included in the schedule. After making choices, the device search criterion consists of a
minimum of two lines, each of which contains a name, criteria, and a value.
Top Level Category equals <Fiber Node, HEC, Power Supply, etc>.
<Type, Modifier, Display Name> <equals, not equals, starts with, ends with, contains, does not contain> <a
value specific to the Type, Modifier, or Display Name of the Top Level Category device selected in the first line>.
Click the drop-down menu to the right of the Top Level Category line and make a selection.
The Value field is automatically populated with the selection.
Specifying a top level category only, and nothing on the next line, creates a data collection schedule that
includes all managed objects of that category.
Not specifying a top level category still allows you to make choices on the second line that select the managed
objects to be included in the schedule. The available choices are simply not filtered by a top level category.
8. If you are not including all managed objects in the chosen Top Level Category, refine the list by building the
second line of parameters. Click the left-most drop-down menu in the second line and select Type, Modifier, or
Display Name.
9. Click the next drop-down menu and select the criteria; (equals, not equals, starts with, ends with, contains, does
not contain).
10. Click the right drop-down menu in this line and select the desired option. The options available in this dropdown menu change according to which Top Level Category is selected and whether Type, Modifier, or Display
Name was selected in this line.
The Value field on this line is automatically populated with the value selected from the drop-down menu. The
Start Over button clears all fields and allows you to begin again.
The More button creates an additional search criteria line each time it is clicked, to allow you to specify
additional criteria. The More button is invalid when:
The criteria in the last existing row is invalid

All criteria (Category, Type, Modifier, Display Name) are already in use
The Fewer button removes one criteria line each time it is clicked, until only the original two criteria lines display.
11. With the desired criteria specified, click Search. All managed devices in the network meeting the search criteria
display in the Templates page.
Page 168
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
Figure 12-4: Search Results

If the list doesnt contain the expected devices, click Clear Search (beneath the search results listing) and re-enter
search criteria.
12. To include the found devices in the schedule, click their checkboxes. The Category checkbox at the top of the
column selects all displayed devices.
NOTE:
To clear the list of found devices and begin again, click the Add button without checking any checkboxes.
13. Click Add. The Search Results list changes from listing the devices to listing the templates associated with the
devices. The templates are added to the schedule. They remain listed on the Templates page so that you can
remove from the schedule any that were added in error. Note the Add button changes to Remove after the
devices are added to the schedule. Select devices to be removed the same way you selected them to be added.
NOTE:
The Remove button is still active so you can check one or more templates to remove from the schedule, if
desired.
14. Click the Attributes tab.
Page 169
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
Figure 12-5: Schedule Setup Page - Attributes Tab

15. The attributes that appear on the Attributes page are those defined for the devices (in the Device Configurator or
in the template applied to them) specified for the Top Level Category selected. The example in this procedure
used Power Supplies as the Top Level Category. The managed attributes for power supplies in this network are
Analog.
16. Click the checkbox(es) in the Attributes page to have the schedule collect data for the desired measurable
attributes.
17. Click Search. The device(s) added to the schedule that includes the measurable attribute in their configurations
display in the Search Results list.
18. To include the found devices in the schedule, click their checkboxes. The checkbox at the top of the column
selects all displayed devices.
19. Click Add to add only these devices to the schedule. They remain listed on the Attributes page so that you can
remove from the schedule any that were added in error. The Add button changes to Remove after devices are
added to the schedule. Select devices to be removed the same way you selected them to be added.
20. Click the Timing tab. The Timing page opens and displays the One Time page.
Page 170
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
Figure 12-6: Schedule Setup Page Timing Tab

21. Select One Time, Weekly, or Monthly. Complete the following fields. Fields marked with an asterisk are required.
One Time
Schedule Activation Date Click the calendar icon to its right and click on a date.
Remove scheduled data older than The operator can elect to save collected data only for a number of days
before CheetahXD deletes it. This field is not required.
Time Between Samples Type the number of seconds to pause between each sampling. Pausing data
collection sampling prevents the data collection process from monopolizing all of CheetahXDs resources. During
pauses, CheetahXD can execute other, unrelated tasks.
Number of Samples to Collect This drop-down box allows you to specify whether you want the data collection
process to collect a specified number of samples (type the number in the text field to the right) or collect
samples for a specified duration (type the number of minutes in the text field to the right).
Start Hour Type the hour (on a 24-hour hour clock) for the collection process to begin.
Start Minute - Type the minutes (1 59) added to the start hour for the collection process to begin.
Weekly
Schedule Deactivation Date Click the calendar icon to its right and click on a date.
Remove schedule data older than This field is not required, but you can elect to save collected data only for a
number of days before CheetahXD deletes it, or leave the field blank to save all collected data.
Page 171
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
process to collect a specified number of samples (type the number in the text field to the right), or collect
Page 172
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
Default Hour Type the default hour (0 23) the schedule will commence on scheduled days where no start
time is specified (below).
Default Minutes Type the default minutes (0 59) the schedule will commence on scheduled days where no
start time is specified (below).
Click the individual days of the week when this schedule will run. Specify a start hour and minute(s) or use the
defaults specified above. If sampling is to be done at multiple start times in a day, click the Hourly Detail icon for
that day and specify the multiple start times.
Monthly
Schedule Deactivation Date Click the calendar icon to its right and click on a date.
Remove scheduled at older than This field is not required, but you can elect to save collected data only for a
Click the individual days of the month when this schedule will run. Specify a start hour and minute(s) or use the
NOTE:
After making changes to the Timing tab page, it is a good practice to press the Commit Timing Changes button
before leaving the Timing tab page. If the operator leaves the page without pressing the Commit Timing
Changes button, the timing parameters will be ignored.
22. Click Add Schedule. The new schedule displays along with its status.
12.2.2
Creating a Device Instance Based Schedule
Device Instance Based schedules are created by specifying the devices to be included in the schedule, setting
additional device attributes, and then setting the schedule for one time, weekly, or monthly. The Schedule Setup
page can search, find, and display available devices. Multiple devices can be added to each schedule.
Device Instance Based scheduling treats devices from the perspective of a transponder and all devices attached to
it. When a device is returned in a search, the device and its attachments are included. For example, assume a
display name of Battery is used. All power supply transponders and their attachments are returned for power
supplies that contain a Battery attachment.
To create a device instance-based schedule:
1.
2.
3.
4.
5.
Open the Scheduler.

Click the Add New button.
Select the Device Instance based radio button.
Type a name for the schedule in the Schedule Name field (spaces and special characters are not allowed).
Click Continue. The Schedule Setup page opens to the Devices tab page.
Page 173
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
Figure 12-7: Schedule Setup Page Devices Tab

The Schedule Name and the Schedule Type (Device Instance Based or Template Based) is displayed at the top
of the page. Three tab pages allow you to specify the Devices, Attributes, and Timing parameters of the
schedule.
6. Click the Selected Application Filter drop-down menu and select the HFC domain. The Search Criteria Properties
portion of the Devices tab page allows you to specify the actual criteria for choosing the devices to be included in
the schedule. After making choices, the device search criteria consist of a minimum of two lines, each
containing a name, a criterion, and a value.
Top Level Category equals <Fiber node, HEC, Power Supply, etc>.
<Type, Modifier, Display Name> <equals, not equals, starts with, ends with, contains, does not contain> <a value
specific to the Type, Modifier, or Display Name of the Top Level Category device selected in the first line>.
7. Click the drop-down menu at the right end of the Top Level Category line and make a selection. The Value field is
automatically populated with the selection.
Specifying a top level category only, and nothing on the next line, creates a data collection schedule that
includes all managed objects of that category.
Not specifying a top level category still allows you to make choices on the second line, which select the
managed objects to be included in the schedule. The available choices are simply not filtered by a top level
category.
8. If not including all managed objects in the chosen Top Level Category, refine the list by building the second line
of parameters. Click the left-most drop-down menu in the second line and select Type, Modifier, or Display
Name.
Page 174
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
9. Click the next drop-down menu and select the criteria (equals, not equals, starts with, ends with, contains, does
not contain).
Page 175
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
10. Click the right drop-down menu in this line and select the desired option. The options available in this dropdown menu change according to which Top Level Category is selected and whether Type, Modifier, or Display
Name is selected in this line.
The Value field on this line is automatically populated with the value selected from the drop-down menu. The
Start Over button clears all fields and allows you to begin again.
The More button creates an additional search criteria line each time it is clicked to allow you to specify
additional criteria. The More button is invalid when:
The criteria in the last existing row is invalid

All criteria (Category, Type, Modifier, or Display Name) are already in use.
The Fewer button removes one criteria line each time it is clicked, until only the original two criteria lines display.
11. With the desired criteria specified, click Search. All managed devices in the network meeting the search criteria
display in the Devices tab page.
NOTE:
Device-Instance-Based scheduling treats devices from the perspective of a transponder and all devices
attached to it. When a device is returned in a search, the device and its attachments are included. For
example, assume a display name of Battery is used. All power supply transponders and their
attachments are returned for power supplies that contain a Battery attachment.
If the list doesnt contain the expected devices, click Clear Search and check your search criteria.
NOTE:
To clear the list of found devices and begin again, click the Add button without checking any checkboxes.
13. Click Add.

The selected devices are added to the schedule. They remain listed on the Device tab page so that you can
remove from the schedule any that were added in error. Note the Add button changes to Remove after the
devices are added to the schedule. Select devices to be removed the same way you select them to be added.
14. Click the Attributes tab.
15. The attributes that appear on the Attributes tab page are those defined for the devices (in the Device
Configurator or in the template applied to them) specified for the Top Level Category selected. The example in
this procedure used Power Supplies as the Top Level Category. The managed attributes for power supplies in
this network is Analog.
16. Click the checkboxes in the Attributes page to have the schedule collect data for the desired measurable
attributes.
17. Click Search. The devices added to the schedule that include the measurable attribute(s) in their configurations
are displayed.
19. Click Add to add only these devices to the schedule. They remain listed on the Attributes tab page so that you
can remove from the schedule any that were added in error. Note the Add button changes to Remove after the
devices are added to the schedule. Select devices to be removed the same way you select them to be added.
20. Click the Timing tab. The timing tab page opens and displays the One Time tab page.
Page 176
CheetahXD User
Scheduling
Data
Guide
Collection
IMPORTANT!
Scheduling
CheetahXD
Data Collection
User Guide
When the Timing tab page is complete, click Commit Timing Changes before leaving the Timing tab
page.
Leaving the Timing tab page before clicking Commit Timing Changes will result in the timing
parameters being ignored.
Figure 12-8: Schedule Setup Page Timing Tab One Time Tab
21. Select One Time, Weekly, or Monthly. Fields marked with an asterisk are required.
One Time
Schedule Activation Date click the calendar icon to its right and click on a date.
Remove scheduled data older than this field is not required, but you can elect to save collected data only for a
Time Between Samples type the number of seconds to pause between each sampling. Pausing data collection
sampling prevents the data collection process from monopolizing all of CheetahXDs resources. During pauses,
CheetahXD can execute other, unrelated tasks.
Number of Samples to Collect this drop-down box allows you to specify whether you want the data collection
Start Hour type the hour (on a 24-hour clock) for the collection process to begin.
Start Minute - type the minutes (1 59) added to the start hour for the collection process to begin.
Page 177
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
Weekly
Schedule Deactivation Date click the calendar icon to its right and click on a date.
Remove scheduled data older than this field is not required, but you can elect to save collected data only for a
Click the individual days of the week when this schedule will run. Specify a start hour and minute(s) or use the
Monthly
Schedule Deactivation Date click the calendar icon to its right and click on a date.
Remove scheduled at older than this field is not required, but you can elect to save collected data only for a
Click the individual days of the month when this schedule will run. Specify a start hour and minute(s), or use the
IMPORTANT!
When the Timing tab page is complete, click Commit Timing Changes before leaving the Timing tab
page.
Leaving the Timing tab page before clicking Commit Timing Changes will result in the timing
parameters being ignored.
22. Click Add Schedule.

The new schedule displays along with its status, in this case Initial.
Page 178
CheetahXD User
Scheduling
Data
Guide
Collection
12.3
Scheduling
CheetahXD
Data Collection
User Guide
Cloning a Schedule
Create a schedule from another schedule by cloning the original schedule, making changes to it, and saving it under
a new schedule name.
To clone an existing schedule
1.
2.
3.
4.
Open the Scheduler. The Schedule Management page opens and displays the available schedules.
Scroll the list to find the desired schedule, or filter the list if it is large (see procedure above).
Click the Add From link at the right end of the desired schedule.
In the page that displays, type a name for the new schedule.
Note that the type of schedule (Device Instance based or Template based) cannot be changed. The cloned
schedule must be of the same type as the schedule from which is cloned.
5.
Click Continue.
The schedule displays with its existing parameters. Make changes according to the procedures in this chapter
for creating a Device Instance based schedule or a Template based schedule.
12.4
Viewing Schedules and Results
CheetahXDs Reports module includes the Scheduler report, which you can run to view the specifics of a schedule or
the results of a schedule, even if the data collection operation has not yet completed. For more information on
running the Scheduler report, see the chapter titled Reports.
The Schedule Management page also allows you view the specifics of a schedule or the results of a schedule, even if
the data collection operation has not yet completed.
Existing schedules display on the Schedule Management page along with their statuses, which can be Initial,
Running, or Finished.
If the list of existing schedules is extensive, filter the list as follows.
To filter the list of schedules:
1. In the Schedule Management page, click the Schedule Name drop-down box and select the desired schedule
name criteria: starts with, contains, or ends with.
Figure 12-9: Schedule Name Drop Down Menu

2.
3.
Type a value in the text field to the right of the Schedule Name drop-down menu.
Click Apply Filter.
The list of schedules displays only those schedules whose names meet the filtering criteria.
Page 179
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
To view a schedule or the results of a schedule:

1. In the Schedule Management page, scroll the list of schedules (or filter the list) to find the desired schedule.
2. Click the View Schedule link to view the schedule, or the View Results link to view the results. Follow the system
prompts to open a file, if applicable, so you can view the results.
To remove a schedule:
1.
2.
In the Schedule Management page, scroll the list of schedules (or filter the list) to find the desired schedule.
Click the Remove link to remove the schedule.
Page 180
CheetahXD User
Scheduling
Data
Guide
Collection
Scheduling
CheetahXD
Data Collection
User Guide
Page 181
CheetahXD User
Displaying
DataGuide
13
CheetahXD
Displaying
User Guide
Data
Displaying Data
The CheetahXD Data Display feature displays data from managed devices and from the database in real-time
alphanumeric and graphical displays within CheetahXD.
Data can be displayed through:
A devices local context menu from a tree view (discussed in this chapter)
A command line window (discussed in the chapter titled CheetahXD Utilities)
Real-time data represent the actual values collected by CheetahXD at intervals specified in the Data Display Options,
or when executing the Console Data Display.
Displayable data include alarm data, as well as operational, download, and configuration status. Data can be
displayed for:
All managed attributes of HMS and DOCSIS top-level devices (such as a transponder, a HEC, a CMTS, or a power
supply)
One attribute of an HMS or DOCSIS device
CheetahNet devices, if CheetahNet is installed and integrated with CheetahXD
Devices or device attributes can be excluded from the Data Display. Note that devices or attributes excluded from
the Data Display still display in the Notifier whenever they generate alarms (and alarming is enabled).
Within CheetahXD, users can elect to display specific categories of data for multiple devices simultaneously by
launching multiple instances of the Data Display. If battery testing is occurring while the CheetahXD Data Display is
running, the display updates to include the battery testing indicator. For more information, see the chapter titled
Testing Power Supplies.
Because displaying data is resource-intensive, Cheetah recommends using Data Display judiciously to minimize
impact on overall system performance.
13.1
Launching CheetahXD Data Display
The following procedure launches the CheetahXD Data Display. This display can remain open and refresh
automatically every thirty seconds, or at a user-specified interval. See the section titled Data Display Options later in
this chapter for information on setting the refresh rate interval.
NOTE: If your browser has a pop-up blocker, this feature must be turned off in order to see a devices Data Display.
To Launch CheetahXD Data Display:
1.
Right-click on an element in the tree and then select the Data Display option from the local menu.
NOTE:
2.
This is the local menu option for HMS and DOCSIS devices. The local menu for CheetahNet devices includes
an option to launch CheetahNets Data Display. (You must have CheetahNet installed in order to run
CheetahNet Data Display for CheetahNet devices.)
A new window opens and displays the data for the selected device.
Page 182
CheetahXD User
Displaying
DataGuide
CheetahXD
Displaying
User Guide
Data
Figure 13-1: Data Display Page
13.2
Categories of Displayable Data
When you select Data Display from a managed objects local menu, a Data Display page for that object appears.
Links at the top of the page offer different types of data to display, but not all categories apply to all devices.
Different device types are monitored for different attributes. For example, a power supply object may be monitored
for voltage, current and temperature, while a transponder object may be monitored for its craft status or tamper
state.
NOTE:
In Version 2.1 and newer releases, security access, which controls read only or read/write access, is
determined by individual user or group permissions.
The links located in the middle of the page are used to display various groups of parameters and to access display
options. These links are shown in the following graphic:
Figure 13-2: Parameter Links

The left-most item in this list shows which category is currently being displayed. In this case, it is Analog. The
category links that follow are:
Analog Displays the value of an attribute that is required to operate within a predetermined range as set in the
devices configuration, and which causes an alarm when the value is out of range. An example of analog data is
battery voltage. Analog data display consists of the analog attribute name, the actual measurement value, and
the limit values set for the device, and can display in text or graphic format. If the attribute value is in an alarm
state, it will be highlighted in the appropriate alarm-severity color.
Non-Alarmable Analog Displays the value of an attribute as set in the devices configuration, but which does
not cause an alarm when the value is out of range. An example of non-alarmable analog data is whether a
particular RF Port on a node transponder is active or inactive.
Page 183
CheetahXD User
Displaying
DataGuide
CheetahXD
Displaying
User Guide
Data
Controls Displays the actual state of discrete parameters and equipment functions. Also, allows control of
equipment functions. An example of control data is the number of times a power supply has gone into standby.
Page 184
CheetahXD User
Displaying
DataGuide
CheetahXD
Displaying
User Guide
Data
An example of the control function is placing a power supply into standby. The control name describes the
operation of the control.
Multi Displays multi-valued device parameters. An example of multi-data is alarm priorities, which can be set
to a number between 1 and 99, inclusive. Each value can be independently configured to be either in a disabled
state or an alarm state. An enumerated parameter generates an alarm if its current value is configured to be an
alarm condition. If the value changes to another value that is also configured to be an alarm, another alarm is
generated. A return (normal or clear) occurs when the value changes to one that has its associated alarm
disabled.
Digital This category is not currently utilized for any CheetahXD supported devices. This category displays
binary parameters such as ON or OFF, Enabled or Disabled, and so on. A digital parameter generates an alarm
when the value changes to the alarm value, and generates a return when the value changes back. The alarm
value is determined by the definition of the parameter and cannot be configured by the user.
Misc Displays miscellaneous data specific only to the selected device type. An example of Misc data is
information retrieved directly from a transponder (such as model or serial number), instead of from the
database.
Device ID Displays the selected devices identification information as stored in the database. An example of
device ID data is a devices MAC or IP address. Device ID information is gathered during device auto-discovery
and during device configuration. Device ID data displays for all devices.
Additional items at the top of the digital display page are:
Stop stops CheetahXD from gathering data and stops the session on the selected device.
Refresh forces an immediate data collection and resets the automatic data collections interval.
Options click this link to access options you can set for the current data display session. See the following
section, Data Display Options, for more information.
Device Cfg opens the Device Configuration page for the target device.
Refresh inSeconds this value counts down the seconds between each instance of CheetahXD performing a
data collection. The default interval is thirty seconds, but can be reset for the current data display session using
Data Displays Options link.
Real-time data represents the actual values obtained by CheetahXD at intervals specified in the Data Display
Options.
13.3
Data Display Options
Click the Options link at the top of any Data Display page to specify how data is displayed. The following page
displays.
Figure 13-3: Set Data Display Options Page

Click the drop-down menus to set Data Display options.
Page 185
CheetahXD User
Displaying
DataGuide
CheetahXD
Displaying
User Guide
Data
Select Analog Measurement Display Format select how you want to display the data. Options are Text (default),
Roundgauge, and Trendchart:
Page 186
CheetahXD User
Displaying
DataGuide
CheetahXD
Displaying
User Guide
Data
Figure 13-4: Text Display Format
Figure 13-5: Roundguage Display Format
Figure 13-6: Trend Chart Display Format

Set Refresh Interval in Seconds for Current Session Only select the interval at which CheetahXD will collect data
during the current data display session: 15, 30, 45, 60. The default is 30 seconds.
Page 187
CheetahXD User
Displaying
DataGuide
CheetahXD
Displaying
User Guide
Data
Set Pagination Count for Current Session Only select the number of pages you want to have for the current data
display session: 10, 12, 14, 16, 18, 20, 22, 24, 26, 28, 30. The default is 12.
13.4
Legacy (CheetahNet) Devices Data Display
Selecting a legacy (non-HMS) transponder launches the CheetahNet application displaying data using the
CheetahNet Data Display feature. The CheetahNet client must be installed for this feature to operate. Also, if the
operator has Battery Admin privileges and the VHEC proxy is running, the operator will be able to select the native
CheetahXD Data Display. For more information on the CheetahNet data display feature, see the latest version of the
NetMentor User Guide (DOC# 6510-00-0460).
Page 188
CheetahXD User
Displaying
DataGuide
CheetahXD
Displaying
User Guide
Data
Page 189
CheetahXD
Testing
Power
UserSupplies
Guide
14
Testing
CheetahXD
PowerUser
Supplies
Guide
Testing Power Supplies
Testing the power supplies in the network on a regular basis ensures their capacity to support their associated
network devices for the expected length of time during a power interruption. Only users with administrative level
privileges can set up power supply testing parameters. In addition, users must have Battery Analyst Administrator
privileges to access the Battery Global Admin Parameters page, enable and disable the associated functions, set
default test parameters, and run tests on demand. Users with Battery Admin User privileges can access the battery
test results and can run tests on demand, but cannot access the Battery Admin Test Configuration information.
Cheetah XD offers two ways to test power supplies:
Automatically Testing all power supplies on an on-going schedule (also called background testing)
On-demand selecting one power supply for one of the following immediate tests:
- Battery Analyst Test the same type of test as the automatic (background) test, which determines the
general status of power supplies.
- Inverter Test to determine whether a power supply inverter is operational.
- Deep Drain Test to determine the amount of time the power supply can provide power during an actual
outage, and to exercise the batteries for maintenance purposes by fully discharging and then recharging
them.
- Predictive Test to determine the amount of time the power supply can provide power during an actual
outage (the same as a Deep Drain Test), but without performing an actual deep drain on the power supply.
Run automatic and on-demand testing separately or simultaneously.

Power supplies are factory-defined as testable or not. If they are defined as not testable, CheetahXDs Battery Admin
module cannot test them. If they are defined as testable, the user can override that in the devices configuration and
exclude the power supply from automatic testing. See Excluding a Power Supply from Testing later in this chapter.
CheetahXD power supply testing primarily involves voltage testing. When available on power supplies, current and
temperature readings are taken as well, depending on the type of power supply test being run.
Battery voltage tests involve placing power supplies into standby state (simulating an actual power outage) for the
duration specified in the testing schedule. The following is a list of issues to consider when specifying the testing
parameters.
Power supplies in standby state are being drained. Ensure testing times, durations, and intervals do not deplete
power supplies, except during deep drain testing, which requires that the batteries be drained.
Some power supplies are designed to stay in standby mode for a set amount of time, which may be shorter than
the duration you specify in the testing schedule. During background testing, a power supplys test will terminate
according to the power supplys design. CheetahXD will display error messages for power supply attributes that
did not yield enough samples (as defined in the Battery Admin testing configuration). An example would be a
testing configuration that specifies taking three voltage measurements during standby, but only two
measurements were completed before the power supply came out of standby. This can be overridden during an
on-demand deep drain test. Cheetah recommends becoming familiar with the parameters of each type of power
supply before designing test schedules and performing on-demand tests.
Ensure that test schedules allow batteries ample time to recharge between tests.
By default, power supplies are tested one at a time, but a maximum of eight power supplies can be tested
simultaneously.
Non-provisioned power supplies cannot be tested.
Make sure the supplys In Standby Limit is set to a time value that is greater (longer) than the length of the
test time.
Power supplies in the Broadband Power System (BPS) cannot be tested.
Page 190
CheetahXD
Testing
Power
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
Power supplies can be grouped to better facilitate the testing process. By placing power supplies into test
groups (regions), the testing process can be distributed throughout the network, thereby preventing large
sections of one portion of the network from being tested at one time.
14.1
Creating Test Groups or Test Regions
Testing a power supply usually requires placing the supply into standby. Many operators consider it undesirable to
simultaneously place several power supplies that are within close proximity to each other or located on the same
portion of the network into standby mode. A more desirable approach is to distribute the testing of the supplies more
evenly across the entire network. Placing power supplies into Test Groups provides an operator with the ability to
distribute the testing over the entire network because the background testing algorithm will only test one supply from
each region at one time. So, placing groups of supplies into regions prevents the entire group from being tested at
the same time.
To group power supplies, create trees specifically for power supply testing.
1.
2.
3.
4.
5.
Navigate to Domain Options and Select the Native Tree.

Move the tree to the Tree Editing pane by clicking the Swap Views button.
On the Tree Editing pane, select the New Tree View button.
This opens the New Tree window.
Enter a Name and Description for the tree, and then click New.
The tree will be visible in the Tree Editing pane.
Move power supplies into the new tree.
From a tree in the Primary Pane, click and drag each desired power supply to the new tree. To select multiple
power supplies, hold down the <Ctrl> key.
Once the power supplies have been moved into various groups, the testing process can be distributed throughout
the network, preventing large sections of one portion of the network from being tested at the same time.
14.2
Setting Parameters for the Power Supply
To set the parameters for the power supply:

1.
2.
3.
4.
Right-click on the power supply device in the primary tree view and select Device Configuration.
On the Device Configuration page, select the Property tab.
Select the expand button to the left of the device name.
Edit the Power Supply Type, Battery Chemistry Type, Oldest Battery Type, Oldest Battery Age, and Battery Amp Hr
Rating, as desired.
These parameters, when set, will override the default configurations set in the POM XML file for a particular power
supply. Note: The Device Config override is only available for HMS power supplies. Please refer to Chapter 11: Fault
Views Power Outage Monitoring for details on customizing the Power Outage Monitoring application.
14.3
Power Supply Pre-Tests
Before any power supply test executes, the power supply is tested to ensure that the following conditions are met:
The power supply has been provisioned.

Commercial power must be present. If there is an actual power outage and no commercial power is present, the
test will not execute.
The tamper status indicates the housing is closed. In the event the power supply tamper status is disabled or
otherwise not present, this pre-test will not occur and the power supply test will not commence. The tamper
status can be disabled during setup.
Page 191
CheetahXD
Testing
Power
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
Power supplies that were not tested due to a failure in one of these pre-tests will not be tested again until the
automatic testing schedule reaches them again, or until another on-demand test is executed and they pass the pretest.
14.4
Background (Automatic) Power Supply Testing
Automatic power supply tests run in the background according to the parameters you specify in the Battery Analysis
Admin Tool. Create a power supply testing schedule based on one of the following:
Testing all power supplies in the network, regardless of how long it takes.
Specifying the time when the tests should be run, regardless of how many power supplies are tested within that
time frame.
Automatic testing can be enabled and disabled using the Battery Test Config option in the Administration page. Power
supplies that are added, auto-discovered, or deleted after the testing parameters are specified are automatically
included or excluded from subsequent testing, depending on the supplys testability, and/or whether or not they
have been explicitly excluded from testing. For more information on excluding power supplies, refer to Excluding a
Power Supply from Testing later in this chapter.
14.4.1
Creating a Background (Automatic) Power Supply Test
The following procedure explains the parameters involved in creating a background power supply testing schedule.
To Specify Power Supply Testing Parameters:
NOTE:
1.
2.
Only users with Battery Admin Administrative level privileges can specify power supply testing parameters.
Click the Administration tab page.

Click Battery Test Config.
The Battery Analysis Admin Tool displays.
Page 192
CheetahXD
Testing
Power
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
Figure 14-1: Battery Analysis Admin Tool Page
Page 193
CheetahXD
Testing
Power
UserSupplies
Guide
3.
Testing
CheetahXD
PowerUser
Supplies
Guide
Set the following parameters as desired.
Battery Analysis Server Click the drop-down menu and select Enabled (to enable testing to occur) or
Disabled (to prevent testing from occurring).
NOTE:
Check Tamper Switch Status of the tamper switch. The following conditions apply:
Enabled: When tamper is enabled, the Battery Analyst process will not run if the tamper switch is
open.
Disabled: When tamper is disabled, the Battery Analyst process will run regardless of the tamper
switch state.
Testing Time Period Click one of the following radio buttons:
To specify that testing begins at midnight, click the Run Test at Midnight radio button. Testing
begins at midnight and stops when all power supplies have been tested.
To specify a testing start and stop time, click the Run Tests From radio button and click the two
drop-down menus to select a start time and a duration. If all power supplies are not tested during
the allotted time, the testing begins the next time with the first untested power supply.
Do Not Run On Specify the dates and/or days of the week that will be exceptions to the schedule you are
creating. On these dates and/or days, testing will not take place. Type one or more dates in mm/dd/yyyy
format, multiple dates separated by commas, and/or check one or more boxes next to the days of the week.
These days and dates will be exempt from the testing schedule.
Test Start Date (mm/dd/yyyy) Click the calendar icon and select a date for the testing to begin.
Run Test Every If testing on an ongoing basis, click this drop-down menu and select a testing interval from
7 to 365 days.
Number of Parallel Tests Click the drop-down menu and select the number of power supplies to be tested
simultaneously, from one to eight power supplies. This parameter can be used in conjunction with test
regions, so that only one supply per region is tested each time the background test is performed.
Purge Data after Click the drop-down menu and select a length of time to retain power supply test results,
up to a maximum of one year. Results can be exported to other formats, via the Battery Analyst Reports
feature, for saving data beyond one year.
Num of Pre-Std by Meas Click the drop-down menu and select how many measurements (from one to five)
to take on the power supply before it is put into standby.
Num of In-Std of Meas Click the drop-down menu and select how many measurements (from 1 to 30) to
take during the standby period. When setting this parameter, keep in mind that the batteries are being
drained during the standby portion of the test.
A minimum of 10 measurements are required to determine the battery runtime capacity in the
final report.
NOTE:
The Battery Analysis Server parameter must be set to Enabled to allow either automatic or on-demand
power supply testing to execute.
The maximum amount of time a power supply can remain in standby for a test is 60 minutes.
Num of Post-Std by Meas Click the drop-down menu and select how many voltage measurements (from
one to five) to take on the power supply after the standby period.
Time between Meas (min) Click the drop-down menu and select how many minutes (from one to five)
should elapse between each measurement (Pre-Stdby, In-Stdby, and Post-Stdby). When setting this
parameter, keep in mind that batteries are draining during the standby portion of the test.
Page 194
CheetahXD
Testing
Power
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
4. Click the Setup Admin Schedule button. CheetahXD displays a page showing the parameters of the test
schedule, and the estimated number of testable power supplies that will be tested.
Figure 14-2: Battery Test Setup Page

Once the schedule is completed, you can display the Battery Admin page any time, and click the Battery Analysis
Server drop-down menu to enable and disable the automatic testing, as desired.
14.5
On-Demand Power Supply Testing
An on-demand power supply test executes immediately. Results of on-demand tests are available through the ondemand test page and by running the Battery Analyst Report. It is possible to execute an on-demand test without the
background processes collecting data. To execute an on-demand test without the background processes, enable the
Battery Analyst server, then select all of the days in the Do Not Run section.
To Run an On-Demand Power Supply Test:
1.
Ensure that the Battery Analysis Server option is enabled. See Creating a Background (Automatic) Power Supply
Test for information on enabling the Battery Analysis Server option.
2. Display the power supply to be tested in the Tree Viewer (expand the view one level, if necessary, to expose the
icon).
3. Right-click on the power supply to display the local menu.
4. Select the desired on-demand test from the local menu: Battery Analyst, or Battery Tests Inverter Test, Deep
Drain Test, or Predictive Test.
Page 195
Testing Power
CheetahXD
UserSupplies
Guide
14.5.1
Testing
CheetahXD
PowerUser
Supplies
Guide
Battery Analyst Test
This test is the same test that is executed when the background automatic testing is run, except that this test is
created and run on an on-demand basis. The test also allows the user to override some of the default admin
configured parameters.
The following page displays when the Battery Analyst test is selected from the local menu of a testable power supply
in a tree.
Figure 14-3: Battery Analyst Page

NOTE:
The maximum amount of time a power supply can remain in standby for a test is 60 minutes.
Type a name for the test in the Create Battery Test Name text box, up to 200 characters, no special characters or
spaces. Since this is the name that will appear for this test in the Battery Analyst Report (see the chapter titled
Reports for more information), it is helpful to make this name meaningful, perhaps including the test type and/or
date the test is run. Note that the power supply to be tested is displayed in the Device Name text field.
Accept the displayed test configuration parameters, or click the drop-down menus and change them. Click Create BA
Test to run the test.
Battery Analyst Details

Number of Parallel Tests
When Power Supply Test Groups are involved, no more than one power supply will ever be in standby at the same
time within a given group. The exception to the rule is Unassigned Groups. If no groups are defined, the number of
power supplies that will be in standby at the same time is determined by the value given in the Number of Parallel
Tests drop-down box (found on the Battery Analysis Admin Tool page).
Pre-Standby Measurements
The Test Status value for Pre-Standby Measurements will most likely display the value set from the last power supply
test that was run. The Pre-Standby value means nothing as of 2.3.0.16.
Page 196
Testing Power
CheetahXD
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
AC Output Alert
If you receive the error: Exception for tlgdPSATBeginStandbyTest was sending request for property
tlgdPSATBeginStandbyTest: The value given was wrong type or length (.2082.1.3.10.1.1.2.1: ) there are two
possible reasons:
1. The device might be in AC Output Voltage Lo or LoLo alarm, and the power supply will not be tested. If the alert
state happens during a test while device is in standby, the device will NOT come out of Standby. If AC Output
Voltage is Hi or HiHi, the test will run.
2. If the test starts and during the Pre Standby measurements the device generates a Lo or a LoLo AC Output
Voltage alert, the power supply will not be tested and the error message above will be logged.
General Q&A on Battery Analyst
Question
Answer
What constitutes a failure of the BA

report?
Only the Discharge Variance of the Batteries. If one battery fails the
comparison check of its in Standby readings, then the test is deemed to
have failed. The String Variance has no bearing on whether a test fails or
not. In Variance or the Pre Standby and the In Standby measurements
have no bearing on whether a test fails or not.
Will Lectro CPR Power Supplies run in

Battery
Analyst?
What if Standby Test Time in the device
is set to a shorter time frame than the
BA test?
What happens when On Demand BA
test is run for a dead device?
No. The inverter only stays in standby for between 1 and 2 minutes, and
the shortest period of time that a BA test will run keeps the power supply
in standby for a minimum of 2 minutes.
The test runs as expected. This setting has no bearing on a BA Test.
If you delete On Demand Tests from

the Battery Test Page, do the results
get removed from the database?
Are standby counters triggered with BA
Tests?
If polling is OFF, does a BA Test still
run?
Is POM triggered with BA Tests?
Will test run if Output Current reads
0.00?
If the fuse is missing or bad, will a BA
Test run?
If a test starts and then fails, does the
test time get updated?
Can a currently running Background BA
test be stopped?
Will tests run if BA Schedule is
changed?
Tests take a long time to load and will fail immediately after loading. No
data is reported.
Logfile: Exception getting Current Standby State for deadDevice,
tlgdPSATTestStatus was Error sending request for property
tlgdPSATTestStatus:Timed Out Property[TargetHost:172.16.3.115. R
Comm:DOCSIS OIDs: .1.3.6.1.4.1.2082.1.3.10.1.1.4.1],
toStr=com.Cheetah.cable.ccms.devicemodel.commhandler.CTCommHandl
erTimeoutException: Error sending request for property
tlgdPSATTestStatus:Timed Out Property[TargetHost:172.16.3.115 R
Comm:DOCSIS OIDs: .1.3.6.1.4.1.2082.1.3.10.1.1.4.1
Yes.
Yes.
Yes.
No, because a loss of Input Voltage has not been achieved.
Yes.
No, because that generates an Output Voltage alert, and with an Output
Voltage alert the test will not run.
Yes. The failed transponder will not test again until its time to do so.
Yes, by setting the schedule to Disable. You will see a database error in
the BattAdmin log file when there is an attempt to write data to the
database.
Yes.
Page 197
Testing Power
CheetahXD
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
Question
Answer
If the test attempts to start but cannot

because of a Comms issue, tamper
issue, Output Voltage issue, or In
Standby issue, does the Test Time get
deleted?
Yes.
What constitutes a started test?

Will the test run if the Input Voltage is
in a Lo or LoLo alert?
Will Tests run if the Tamper Switch is
open?
If any Pre Standby measurement is recorded.

No. The Input Voltage needs to be over 95 Volts.
If the power supply has a wrong

configuration (like an extra Battery
showing), will the Standby test run?
It depends on the Tamper Switch setting on the BA Admin page. If it is set

to Enabled, then if a Tamper Switch alert is present, a test will not run. If
this setting is set to disabled, then regardless of Tamper status, the test
will run.
Yes, and if all else is OK, the test will complete.
Battery Analyst Testing Status Results

Value
MIB Definition
The test is idle
In Progress
Complete
Abort Standby from

Host
AbortAC Output
Voltage alarm
Meaning
Possible Cause
Remedy
No test has been run

on this device since
the last time it was
reset or since it was
installed.
When the test is
running normally you
will see this value in
the In Standby
portion of the data
gird.
Post test value
showing the device
made it into and out
of standby.
This indicates that
the Power Supply
was taken out of
standby.
Newly installed or a
Reset transponder
will show this state.
N/A
Test is running.
N/A
Successful Test
N/A
Someone took the

power supply out of
standby either
physically or via a
control.
There is a Lo or LoLo
Output Voltage Alert
or a fuse may be bad
or missing, either of
which cause the
power supply to
report No AC Output.
Output Voltage Alert.
Nothing can be done

for the current test.
Before running
another test, verify
that the power
supply is out of
standby.
Correct the Output
Voltage alert.
Fuse may be bad,

missing, or loose.
Fix or replace the

Fuse.
Page 198
Testing Power
CheetahXD
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
Value
MIB Definition
Meaning
AbortPower supply
took itself out of
standby
The power supply

itself didnt like the
fact that it was in
standby, and took
itself out. This could
be caused by several
things.
Possible Cause
Remedy
Weak batteries
Inverter failure
Battery breaker open
Loose battery
connections/corroded
connections
Excess load
10
AbortPower supply
already in standby
11
AbortOutput alarm
91
None
92
None
93
None
Backend Test
Failure Tamper
Switch Open
Battery Admin Setup

has enabled the
Tamper Switch check.
94
None
Backend Test
Failure Input
Voltage too low.
Input Voltage is below

95 Volts.
The power supply

was already in a
standby state when
the test was
scheduled to put it
into standby. The
test recognized that
it was in standby
and stopped.
Power supply output
failure (Alpha
related).
Backend Test
Failure No
Communication
Backend Test
Failure Already in
Standby
Page 193
Power supply was in

standby.
Take load tester out

and verify. May need
to replace one or
more batteries.
Replace inverter.
Check Manufacturer
specs.
Reset the breaker.
Clean and/or tighten
terminal
connections.
Check Output
Current reading. If
high, reduce the
load.
Correct the issue
causing power
supply to be in
standby.
If the power supply

output has failed, it
will trigger the power
supply and stop any
tests.
Loss of RF to
transponder.
N/A
Power Supply was in

standby.
Correct the issue

causing power
supply to be in
standby.
Disable the check
from the Battery
Admin page.
Keep the Tamper
check active, but
resolve the Tamper
Switch issue at the
power supply.
Minimum Voltage of
95 required to run
test.
Restore RF
communications.
Testing Power
CheetahXD
UserSupplies
Guide
14.5.2
Testing
CheetahXD
PowerUser
Supplies
Guide
Inverter Test
The Inverter Test initiates the power supply inverter, placing the power supply in standby for approximately 60
seconds. In tree view, click to select a battery/power source, right-click to view the Common menu and select Battery
Tests > Inverter Test. The following window displays.
Figure 14-4: On Demand Inverter Test Page

Type a name for the test in the Create Inverter Test Name text box, up to 200 characters, with no special characters
or spaces. Since this is the name that will appear for this test in the Battery Analyst Report (see the chapter titled
Click Create Inverter Test to begin the test.
Battery voltages, output currents and temperature readings are collected at the start of the test, and again just
before the inverter is switched back off. The results are stored in the database. An example of the test results report
is shown in the following illustration.
Page 194
Testing Power
CheetahXD
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
Figure 14-5: Battery Inverter Test Report Page
Page 195
Testing Power
CheetahXD
UserSupplies
Guide
14.5.3
Testing
CheetahXD
PowerUser
Supplies
Guide
Deep Drain Test
The deep drain test simulates an actual power outage to determine the length of time the power supply can remain
in standby. This test performs a deep discharge until one of the following user-specified conditions is met:
A minimum battery voltage is reached, generally 10.5 V for a 12 V battery

A minimum input voltage is reached
A maximum test time limit is reached
The following page displays when the Deep Drain Test is selected from the local menu of a testable power supply in a
tree.
Figure 14-6: Deep Drain Test Page

Type a name for the test in the Create Battery Test Name text box, up to 200 characters, no spaces. Since this is the
name that will appear for this test in the Battery Analyst Report (see the chapter titled Reports for more information),
it is helpful to make this name meaningful, perhaps including the test type and/or date the test is run. Note that the
power supply to be tested is displayed in the Device Name text field.
Specify (or accept) the following testing parameters:
Max Test Time (min) the deep drain test will terminate if it is still running when the specified number of
minutes has been reached.
Data Collection Interval (min) This interval specifies how often the test will take battery measurements during
the test.
Reset Stand by Interval (min) Many power supplies are designed to remain in standby for a specific amount of
time when commercial power is present. See the power supply manufacturers documentation for the maximum
test time value. To keep these power supplies in standby for longer, specify a time here, in minutes, which is
less than the power supplys maximum test time value. The test will briefly bring the power supply out of standby
when the specified time is reached, and immediately return it to standby, thereby resetting the power supply
testing time. For example, for a power supply that remains in standby for thirty minutes, set the Reset Standby
Interval to 25. In 25 minutes, while the power supply is still in standby, the test brings the power supply out of
Page 196
Testing Power
CheetahXD
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
standby. After approximately five seconds, the test puts the power supply back into standby, where it will begin
counting its thirty minute standby limit again, or until another 25 minutes has elapsed when the test will again
Page 197
Testing Power
CheetahXD
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
briefly bring it out of standby. It is important to know the standby limits of the power supply being tested to
effectively run the Deep Drain Test.
Because different power supplies possess different rates of response times, a good rule of thumb to follow is to
never set the Standby Interval variable to a value that is evenly divisible by the Data Collection Interval value. For
example, it is not recommended to set the Standby Interval value to 10 and the Data Collection Interval value to
5.
Min. Input Voltage Limit (V) During the test, if the commercial power to the power supply reaches this limit, the
test will terminate.
Min. Battery Voltage Limit (V) During the test, if the battery voltage reaches this limit, the test will terminate.
Click Create Deep Drain Test to begin the test. A sample of a test results report is shown in the following figure.
Figure 14-7: Battery Deep Drain Test Report
Page 198
CheetahXD
Testing
Power
UserSupplies
Guide
14.5.4
Testing
CheetahXD
PowerUser
Supplies
Guide
Predictive Test
The predictive test estimates the standby capacity of a power supply during an actual power outage. It predicts the
likely results of the Deep Drain Test, but without draining the batteries. This test requires knowing the following
parameters of the power supply being tested:
Power supply type

Battery technology
Battery age
Battery Amp-Hr rating
The accuracy of the test is heavily dependent on the values specified; entering incorrect values will likely produce an
inaccurate estimate. The following page displays when the Predictive Test is selected from the local menu of a
testable power supply in a tree.
Figure 14-8: Predictive Test Page

Type a name for the test in the Create Predictive Test Name text box, up to 200 characters, no special characters or
spaces. Since this is the name that will appear for this test in the Battery Analyst Report (see the chapter titled
Specify (or accept) the following testing parameters. The more specific and accurate the parameters, the more
realistic the results of the Predictive test will be.
Power Supply Type - XM, XM2, Lectro ZZT, etc.

Battery Amp Hour Rating (Ah) see the power supply manufacturers documentation for this value.
Battery Type / Technology usually lead-acid but can be gel cell or other type of technology.
Battery Age how long the battery has been installed and operational.
Specify the following test criteria, if desired.
Max Test Time (min) specify how long the test will run and collect sample. The test will terminate when it has
been running for this number of minutes. The default is ten minutes.
Page 197
CheetahXD
Testing
Power
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
Reset Standby Interval (min) Many power supplies are designed to remain in standby for a specific amount of
time, when commercial power is present. See the power supply manufacturers documentation for the maximum
Page 198
CheetahXD
Testing
Power
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
test time value. To keep these power supplies in standby for longer, specify a time, in minutes, that is less than
the power supplys maximum test time value. The test will briefly bring the power supply out of standby when the
specified time is reached and immediately return it to standby, thereby resetting the power supply testing time.
For example, for a power supply that remains in standby for thirty minutes, set the Reset Standby Interval to 25.
In 25 minutes, while the power supply is still in standby, the test brings the power supply out of standby. After
approximately five seconds, the test puts the power supply back into standby, where it will begin counting its
thirty minute standby limit again, or until another 25 minutes has elapsed, when the test will again briefly bring
it out of standby. It is important to know the standby limits of the power supply being tested to effectively run the
Predictive Test.
Min. Battery Voltage Limit (V) During the test, if the battery voltage reaches this limit, the test will terminate.
Click Create Predictive Test to begin the test. A Predictive Test report is shown in Figure 14-9.
Figure 14-9: Battery Predictive Test Report
Page 199
CheetahXD
Testing
Power
UserSupplies
Guide
14.6
Testing
CheetahXD
PowerUser
Supplies
Guide
Viewing Background (Automatic) Results for Completed Tests
View results for background power supply testing by either running a Battery Analyst Report. See the chapter titled
Reports for information on running this report.
14.6.1
Viewing Background Testing Power Supply Groupings
When background test schedules are created, a user with the appropriate permission can specify running one or up
to eight tests simultaneously. For example, in a system with 100 power supplies, a testing schedule configured to
run five tests in parallel will test 20 devices in each of the five threads created for the simultaneous testing.
CheetahXD offers two ways to view which power supplies are grouped for simultaneous testing, and which groups
are currently being tested (on standby). Background testing must be enabled and running to view these groupings.
1.
Through on-demand tests when an on-demand test is successfully created, the following screen displays:
Figure 14-10: Successfully Created Test Page Through On Demand Tests

Click the View all on demand tests status link. The following window displays.
Figure 14-11: Battery Test Schedule Info Page Through On Demand Tests Link
When background testing is enabled and running, the top of this screen displays the power supplies that are
grouped for testing as well as which group is currently being tested (on standby).
Page 200
CheetahXD
Testing
Power
UserSupplies
Guide
2.
Testing
CheetahXD
PowerUser
Supplies
Guide
Through the Battery Tests link under Scheduling in the Domain Options pane at the left of the CheetahXD
window.
Clicking this link displays the following page:
Figure 14-12: Battery Test Schedule Info Page Though Battery Tests Link
When background testing is enabled and running, the top of this screen displays the power supplies that are
grouped for testing, as well as which group is currently being tested (on standby).
14.7
Viewing Status, Details and Results of On-demand Tests
On-demand test information that can be viewed includes:
Status
Details
Results
Date and time of most recent test
14.7.1
Viewing On-Demand Test Status
View on-demand test status from the page that displays as soon as the newly-created test commences, or from the
Device Configuration module. When an on-demand test commences, the following screen displays:
Click the View all on demand tests status link. The following window displays.
The on-demand test details that display include:
Test Name this is the name the user types in the Create [Test Name] field
Test Type this is the type of on-demand test (Battery Test, Inverter Test, Deep Drain Test, Predictive Test)
Test Status this column shows whether the test is running or has completed.
For completed tests, the Test Status column includes two links: View Results and Delete. Click the View Results link
to see the results of the on-demand test.
NOTE:
Tests will remain on this page until they are deleted by clicking the Delete link. On-demand reports can also be
viewed from the Battery Analyst Report link located under the Reports menu.
Test status can also be viewed through the Device Configuration Module. Click the power supplys local context
menu in any tree view (see the chapter titled Tree Viewer for information on displaying a local context menu), and
select Device Configuration.
Page 201
CheetahXD
Testing
Power
UserSupplies
Guide
Testing
CheetahXD
PowerUser
Supplies
Guide
The Information tab page of the Device Configuration includes the following on-demand test parameters, highlighted
in Figure 14-13:
Last date and time the Deep Drain test was run
Status of the last Deep Drain Test
Last date and time the Predictive test was run
Status of the last Predictive test
Last date and time the Inverter test was run
Status of the last Inverter test.
NOTE:
The Battery Analyst test can be run as an on-demand test and as a background, automatic test. This tests
information in the Information tab page, shown in the following figure, is listed in the parameter Previous Power
Supply Test On (directly above the highlighted parameters). This parameter displays the date and time of the
most recent Battery Analyst test, whether it was run from the background process or an on-demand test
request.

The Battery Analyst test can be run as an on-demand test and as a background, automatic test. This tests
information in the Information tab page above is listed in the parameter Previous Power Supply Test On (directly
above the highlighted parameters). This parameter displays the date and time of the most recent Battery Analyst
test, whether it was run from the background process or an on-demand test request.
Page 202
CheetahXD
Testing
Power
UserSupplies
Guide
14.8
Testing
CheetahXD
PowerUser
Supplies
Guide
Excluding a Power Supply from Testing
Both automatic and on-demand power supply tests normally test all testable power supplies. The Device
Configuration module allows you to exclude a specific power supply from testing.
To exclude a testable power supply from testing:
1.
2.
3.
4.
5.
6.
Display the power supply in any tree view (expand the view one level if necessary to expose the icon).
Left click on the device to display the local menu.
Select Device Configuration.
Click the Property tab.
Click on the button to the left of the device name.
Click the checkbox next to Is Power Supply Testing Enabled to remove the checkmark.
Figure 14-14: Is Power Supply Testing Enabled Checkbox

7.
Click Save.
The power supply will not be included in either automatic or on-demand testing.
Page 203

Paging
15
CheetahXD UserPaging
Guide
Paging
CheetahXDs Paging feature can transmit alarms immediately to the appropriate technician via alphanumeric pager
or email.
15.1
Setting up Paging
A paging setup is created per technician, and includes:
Device types for which the technician will be paged

The alarm threshold (the lowest-level severity) that will trigger a page to the technician
The time period during which the technician is available for paging
The method of paging (an alphanumeric pager and/or e-mail)
Specifics of the technicians pager and/or e-mail account
To Set Up Paging:
1.
2.
Click the Administration tab at the top of the page.

Click the Page Alert icon in the CheetahXD Administration menu.
The Page Alert module opens. It consists of five tabs: Technician, Modem, Pager, E-mail, and Common, and
opens with the Technician tab as the default.
Figure 15-1: Page Alert Page

Creating a paging setup involves specifying the paging parameters on the five tab pages in the following order:
Specify the modem information (only when using alphanumeric pagers)

Configure pager and/or e-mail specifics
Create the technicians
Activate the technicians
Update the paging server
Page 204

Paging
15.1.1
Guide
Specify Modem Information
Specifying modem information is required only when using alphanumeric pagers. If technicians in your operation do
not use pagers, skip this section. Click the Modem tab to open the Modem Setup page.
Figure 15-2: Modem Setup Page

NOTE:
These modem settings are for the modem on the PC that is running the server software, which may or may not
be the PC where the editing is being performed.
Comm Port Click the drop-down box and select the desired communications port on which the modem is
located. The paging portion of the software recognizes ports one through four only.
Modem Init String Specify the group of characters used to initialize the modem before dialing. The initialization
string is determined by the modem manufacturer. If the Modem Init String field is blank, the initialization string
defaults to AT.
Modem Dial String Specify the dial command to be sent to the modem. The dial string is determined by the
modem manufacturer. If the Modem Dial String field is blank, the dial string defaults to ATDT.
The Save button saves the current information, but does not update the paging server with the new information.
After making all changes to this and/or any other tab page in Paging Admin, click the Common tab and click the
Save/Update
Paging
Server
button
for
the
changes
to
take
effect!
Page 205

Paging
15.1.2
Guide
Configuring an Alphanumeric Pager
Configuring an alphanumeric pager is optional. If technicians in your operation dont use pagers, skip this section.
Click the Pager tab to open the Pager Setup page.
Figure 15-3: Pager Setup Page
Access Provider Name The technicians pager service displays in this read-only field.
Paging Failure Retry Delay Type the delay time in minutes that the CheetahXD system will wait before trying to
redial a failed pager call.
Hand Shaking Information Click Typical for even parity, 7 data bits, and 1 stop bit. Click Alternate for no parity;
8 data bits, and 1 stop bit.
Access Provider Number Type the telephone number of the access providers paging terminal (do not use
dashes to separate the numbers).
Message Character Limit Type the paging services (access provider) message character limit.
Access Terminal Baud Rate Type the baud rate of the access providers terminal.
Save/Update
Paging
Server
button
for
the
changes
to
take
effect.
Page 206
Paging
CheetahXD
User Guide
15.1.3
Guide
Configuring E-mail
Click the E-mail tab to open the E-mail Setup page.
Figure 15-4: E-mail Setup Page
Email Server Type the name of the technicians e-mail server.

Origination Address type the e-mail address from which the notification message originates. It represents the
from address that appears in the header of an e-mail message.
Test Connection click Save before clicking Test Connection. Test Connection tests the connection to the e-mail
server. After completing a test, the system displays a brief status message indicating the success or failure of
the test.
Save
/
Update
Paging
Server
button
for
the
changes
to
take
effect.
Page 207
Paging
CheetahXD
User Guide
15.1.4
Guide
Creating Technicians
Creating technicians for paging involves:
The notification parameters (how and at what alarm priorities they are to be paged)
The devices they support
To Create a New Technician:

1.
Click New on the Technician Information tab page. The Notification page opens.
Figure 15-5: Notification Page

2. Select the Notification Type, (Pager, E-mail or both), for this technician.
3. Type the technicians name in the Technician Name text box.
4. Click the drop-down box to select the Alarm Priority Threshold. The technician will be notified when an alarm
occurs at this or a higher priority level. Priority levels range from 1, the highest priority, to 99, the lowest priority.
The graphic above shows a priority of 5 selected. This technician will be notified for all alarms of priority 5, 4, 3,
2, and 1.
5. If this technician is to be notified by pager, type the number supplied by your paging provider in the Pager
Number text box (insure the Pager checkbox is checked). If the technician is to be notified by e-mail only, leave
this text box blank (ensure the E-mail checkbox is checked).
6. Click the Access Provider Name drop-down box to select the appropriate pager service. If the technician is to be
notified by e-mail, skip this step.
7. Click the E-mail Server drop-down box and select the technicians e-mail server.
8. Type the technicians e-mail address in the E-mail Address text box.
9. Click Save.
Save/Update
Paging
Server
button
for
the
changes
to
take
effect.
Page 208
Paging
CheetahXD
User Guide
Guide
10. Click the Category/Group Setup tab.
Figure 15-6: Category/Group Setup Tab

11. Scroll the Categories list and select one or more devices for this technician by using Ctrl+Click.
Note that all possible objects within a network appear on the Categories list, whether or not they generate
alarms. Select only those devices that generate alarms in your network, and for which you want this technician
to receive notifications.
12. When the desired devices are selected, click the double right-facing arrow icon to move them to the Selected
Categories List.
13. Click Return. Clicking Return saves the current information, but does not update the paging server with the new
information. After making all changes to this and/or any other tab page in Paging Admin, click the Common tab
and click the Save/Update Paging Server button for the changes to take effect.
Page 209
Paging
CheetahXD
User Guide
15.1.5
Guide
Viewing, Creating, Deleting Technician Schedules
View, create, and delete technician schedules through the Technician Information tab page of the Page Alert module.
To View a Technicians Schedule:
1.
2.
With a technician selected in the Technician Information tab page, click Schedules.
The Schedules page opens.
Figure 15-7: Schedules Page

3. To view a technicians schedule, the start date of the schedule is required. Click the calendar icon below the
Display Schedules for Date field and select the start date. If a technicians schedule with that start date exists, it
displays in the large text box at the top of the page.
A calendar for the current month opens.
4. Click a date to display existing schedules for that date. The four icons at the top of the calendar, on either side
of the month and year display, allow you to select the previous year, the previous month, the next year and the
next month.
To Create a Technicians Schedule:
1.
After selecting a technician on the Technician Information tab page, click Schedules. The Schedules page opens.
NOTE:
When selected, the Display All Dates option displays all of the schedules (both active and inactive) for a
particular technician.
2. Click the List Schedules drop-down box and select Add Schedule.
3. Specify a start time and stop time using the drop-down boxes, and a start date and stop date using the calendar
icons to the right of the Start Date and End Date fields.
4. Click the Update button to save the schedule.
5. Click the Return link.
Page 210
Paging
CheetahXD
User Guide
6.
Guide
Click to select a technician name. Press the arrow button. This will send a page to the technician.
Page 211
Paging
CheetahXD
User Guide
Guide
The Update button saves the current information, but does not update the paging server with the new information.
Save/Update Paging Server button for the changes to take effect.
To Delete a Technicians Schedule:
1.
2.
3.
4.
With a technician selected in the Technician Information tab page, click Schedules.
The Schedules page opens.
Click the List Schedules drop-down box and select Delete Schedule.
Click the Update button to save the schedule.
The Update button saves the current information but does not update the paging server with the new information.
Save/Update Paging Server button for the changes to take effect.
15.2
Activating Technicians
After a technician is created, devices are assigned, and a schedule is created, activate the technician on the
Technician Information page.
To activate a technician:
NOTE:
Before activating or moving a technician to the On Call List, the technician must already have a schedule and at
least one device assigned.
1. Open the Technician Information tab page (this is the default page).
2. Scroll the Master List to find the technician name and single click it to select it.
3. Click the double right-facing arrows to move the selected technician from the Master List to the On Call List. The
technician is now activated to begin receiving alarm notifications according to the technicians paging setup.
NOTE:
To move a technician to the On Call List, the technician must have a device and a schedule already
assigned.
Similarly, to deactivate a technician, select the technicians name in the On Call List and click the double left- facing
arrows to move the technician to the Master List. The technician is now deactivated and will not receive alarm
notifications.
Page 212

Paging
15.3
Guide
Update the Paging Server
Specify paging server attributes using the Common tab in Paging Administration. Paging Server attributes include:
Changes saved on any of the other Paging Administration tab pages

Starting and stopping the paging server
Alarm handling
To update the paging server:

1.
Click the Common tab in Pager Administration.
Figure 15-8: Common Tab

2.
Complete the following fields:
Enable Click this checkbox to start the paging server and activate all paging schedules and parameters. When
this checkbox is unchecked, no paging occurs, whether via alphanumeric pager or email.
Automatic Re-enable Click this checkbox to automatically re-enable the paging server after it has been
disabled due to the Enable checkbox being unchecked. The next option, Re-enable in Minutes, specifies how
many minutes pass before the Enable checkbox is re-checked.
Clicking this checkbox enables the next option which must be specified.
Re-enable In Minutes When the Automatic Re-enable checkbox is checked, specify the number of minutes to
pause before re-enabling the paging server. This is useful to allow time for other areas of the network to recover
before paging resumes.
E-mail Alarm Queue Size Type the number of alarms to hold in the queue for sending to e-mail accounts. Any
alarm that arrives after this number has been exceeded will not trigger a notification, but it will be written to the
log file. The maximum number of alarms the queue will hold is 9999.
Page Alarm Queue Size Type the number of alarms to hold in the queue for sending to pagers. Alarms arriving
Page 213

Paging
Guide
after this number is exceeded do not trigger notifications but are written to the log file. The default size is 5, but
you can specify any number except zero.
Page 214

Paging
Guide
Enable Notification for Clear Events Click in the checkbox to activate. When activated, devices will send an
alarm when the event clears (returns from an alarm state).
Overflow Action Click the checkbox to specify how to handle the notification queue when it is in overflow.
Clicking this checkbox enables the next option.
Automatically Stop Actions For Minutes Check the checkbox to activate, and specify the number of minutes to
suspend the alarming function when it is in an overflow condition. This prevents a device triggering numerous,
similar alarms from overwhelming the notification system.
Refresh Enable Checkbox Use this link to refresh the page with the original values.
Save/Update Paging Server Click this button after making any changes on any of the tab pages in Paging
Administration. The Save button on the tab pages allows you to save your changes and move to other tab pages,
but the changes are not communicated to the paging server until you click this button.
15.4
Edit Technician Information
As technicians, equipment, and responsibilities change, edit the technician information to insure the paging setup is
always accurate, current, and covers the needed dates and times.
To Edit Technician Information:
1.
2.
3.
Display the Page Alert menus Technician Information page.

Scroll the Master List and select the name of the technician to edit.
Click the Edit link at the bottom of the Technician Information page. The Notification page displays, as shown in
Figure 15-5.
This page contains the same fields as when creating a new technician. For information on editing the fields on
this page, see Section 15.1.4.
15.5
Deleting Technicians
Delete a technician when the person will no longer be notified of alarms. When a technician is deleted, all of the
schedules associated with that technician are deleted as well.
To Delete a Technician:
1.
2.
3.
Display the Page Alert menus Technician Information page.

Scroll the Master List and select the name of the technician to delete.
Click the Delete link at the bottom of the Technician Information page.
15.6
Security Permissions
Enabling the Paging Admin permission allows the users within a group to access the Pager Alert link and perform all
of the tasks associated with paging.
To enable the Paging Admin permission:
1.
2.
Navigate to the Security Administration panel and click Group Configuration.

When the Group Configuration display opens, choose a groups Assigned Operations link.
The Operations Tree displays.
3. From the Operations Tree, go to CheetahXD > Administration > CheetahXD Admin and click Paging Admin to
enable it.
Page 215

Paging
15.7
Guide
Paging Technicians Using Device Groups
As its name implies, a Device Group allows operators to arrange devices (such as HECs, transponders, etc.) into
groups. In systems that contain large numbers of devices, an operator can better organize the devices by grouping
them into individual Device Groups. These groups are then moved to custom tree views to organize the system even
further.
Perhaps one of the most significant features of Device Groups is the ability to page one or more technicians based
on Device Groups. Once created, a Device Group can be assigned to one or more technicians within the system.
To add granularity, operators have the flexibility of being able to designate which device categories within the Device
Group will page a particular technician. The next paragraph describes an example to illustrate this point.
You have just created a Device Group called DeviceGroup1 in the Native tree view. You then assigned to the group
several transponders, HECs, and fiber nodes. Next, you go in and assign DeviceGroup1 to Tech A and you designate
Tech A will receive all transponder alarms from DeviceGroup1. You then go in and assign DeviceGroup1 to Tech B
and designate Tech B will receive all of the HEC and fiber node alarms. Now imagine all of the devices in
DeviceGroup1 generate an alarm at approximately the same time. Tech A will receive all of the transponder pages
from DeviceGroup1, while Tech B will receive all of the HEC and fiber node pages.
To Page a Technician-Based on a Device Group:
IMPORTANT!
This section assumes the reader is already familiar and comfortable with creating devices in CheetahXD.
For information on creating and moving/assigning devices using the Tree Viewer, you should read about
and be familiar with the operations explained in the Tree Viewer chapter of this manual.
Device Groups should be used from custom view trees.
1. From the View Editing panel in the Tree Viewer, create a custom view tree.
2. From the View Editing panel in the Tree Viewer, create a device with a Device Grouptype in the Native tree view.
3. Copy the Device Group from the Native view tree to the custom view tree.
4. Place devices into the Device Group by copying the devices from the Native view tree into the Device Group in
the custom view tree. Refer to the Tree Viewer chapter in this manual for information on creating trees, creating
elements, and moving/copying devices to and from trees.
5. At this point, the Device Group exists and it has devices assigned to it. Assign the Device Group to one or more
technicians. From the Administration page in the CheetahXD Administration panel, click the Page Alert icon.
6. Select a technician name from the Master List and click the Edit button.
7. In the Technician Information window, click on the Category/Group Setup tab.
8. Highlight one or more devices in the Categories window. Click the right-facing arrow to add the device(s) into the
Selected Categories window. If you are removing a device, highlight one or more devices in the Selected
Categories window and click the left-facing arrow to move the device(s) into the Categories window. The devices
in the Selected Categories window will be the only devices within the selected Device Groups that will send
pages to this technician.
9. Highlight one or more Device Group names in the Groups window. Click the right-facing arrow to add the
group(s) into the Selected Groups window. If you are removing a group, highlight one or more groups in the
Selected Groups window and click the left-facing arrow to move the group(s) into the Groups window.
10. If some of the devices had been overlooked during the configuration process or possibly added after this phase
of the process, its possible that some of the devices paging may get overlooked. To ensure that all device
paging is accounted for, activate the Selected Devices Not Assigned to a Group option by clicking on the
checkbox next to the option. Any device not assigned to a group will send its pages to this technician.
Page 216

Paging
Guide
Page 217

Reports
16
CheetahXD User
Reports
Guide
Reports
CheetahXD offers the following types of reports for the HFC domain.
Device reports, which include:

Device Configuration Report
Device Status Report
Device Inventory by Type Report
Provisioned Transponders Report
Fault reports, which include:
Alert Report by Category
Alert Listing Report
Active Alert Status Report by Device
Device Dead Report
Alert Analysis Report
Power Supply Alert Report
Power Outage Summary Report
Power Outage Detail Report
Performance reports, which include:
Battery Analyst Report
Battery Summary Report
Scheduler Report
16.1
Report Output Options
By default, all reports output to PDF files so they display perfectly on any platform, on any machine that has Adobe
Acrobat Reader installed. (Adobe Acrobat Reader can be downloaded free from Adobe.com.) When running
these reports, Acrobat displays the File Download window to allow you to choose to Open the report (and view on the
screen), Save the report (to a file), or cancel the operation. Operators using CheetahXD version 2.2 and newer also
have the option of saving reports in comma-separated values (CSV) format.
NOTE:
If you choose to display the report on the screen, you can still save the report using Acrobats Save As option
from the File menu.
The following reports can also output to editable .csv files:

Device Dead Report
Page 218

Reports
CheetahXD User
Reports
Guide
Additionally, the Battery Analyst Report can output to an XML file. Reports can be viewed immediately or saved to a
file.
16.2
Accessing Reports
To access the Reports module:

1.
2.
3.
Click the HFC Domain link in the Domain Options tree to expand it.
Click the Reports link.
The HFC Reports Page lists the available reports.
Figure 16-1: HFC Report Page
16.3
Device Reports
16.3.1
Device Configuration Report
The Device Configuration Report contains the configuration information stored in the database for a selected device.
This report also displays whether or not new alarm threshold values have been specified in the devices
configuration, stored in the database but not yet downloaded to the device. The Requires Download column in the
Device Configuration Report contains a Y if new threshold values need to be downloaded to the device. See the
chapter titled Provisioning Devices for more information on specifying and downloading alarm threshold values.
Display the Device Configuration report using the link under Reports in the Domain Options tree, or directly from the
device in a tree view.
To Display a Device Configuration Report from the Domain Options Tree:
Select the desired type of output format (PDF or CSV), then click the Device Configuration Report link in the HFC
Report Page. The following page appears.
Page 219

Reports
CheetahXD User
Reports
Guide
Figure 16-2: Device Configuration Reports

Select the device for the report one of two ways.
Click the Find by Device Name radio button. Click the drop-down menu next to Display Name and choose one of
the search parameters (starts with, contains, ends with). Type a full or partial device display name. Click Submit.
A list of device names containing the search criteria displays.
Scroll the list and select the desired device, or:
Click the Find by Category radio button. A list of device categories displays.
Figure 16-3: Device Configuration Reports Find by Category Radio Button

Scroll the list and select the desired categories. Click Submit. The devices for the selected categories display.
Select the desired device and click Generate Report. See Section 16.1 for information on handling the report.
Page 220

Reports
CheetahXD User
Reports
Guide
To Display a Device Configuration Report from a Tree:

Display the desired device in a tree view. Right-click the device and from the drop-down menu select Reports >
Configuration Report. A sample Device Configuration Report follows.
Figure 16-4: Device Configuration Report

16.3.2
Device Status Report
The Device Status Report displays the current data for all measured attributes of the device. Display the Device
Status report using the link under Reports in the Domain Options tree or directly from the device in a tree view.
To Display a Device Status Report from the Domain Options Tree:
Select the desired type of output format (PDF or CSV), then click the Device Status Report link in the HFC Report
Page. The following page displays.
Figure 16-5: Device Status Reports Page
Page 221

Reports
CheetahXD User
Reports
Guide
Select the device for the report in one of two ways:
Click the Find by Device Name radio button. Click the drop-down menu next to Display Name and choose one of
the search parameters (starts with, contains, ends with). Type a full or partial device display name. Click Submit.
A list of device names containing the search criteria displays.
Scroll the devices list and click a device to select it, or:
Click the Find by Category radio button. A list of device categories displays.
Scroll through the list and select the desired category. Multiple categories may be selected. Click Submit. The
devices for the selected categories display.
Click the desired device and click Generate Report. See Section 16.1 for information on handling the report.
To Display a Device Status Report from a Tree View:
Display the desired device in a tree view. Right-click on the device and select Reports > Status Report.
Follow the system prompts to produce the report. A sample Device Status Report follows.
Figure 16-6: Device Status Report
Page 222
Reports User Guide

CheetahXD
16.3.3
CheetahXD User
Reports
Guide
The Device Inventory by Type report displays all monitored devices, grouped by device type.
To Display a Device Inventory by Type Report:
Accept the default PDF output file type, or change to the .csv output file type by clicking the down arrow in the Output
column on the Device Inventory Report line.
Click the Device Inventory by Type Report link. Follow the system prompts to produce the report.
A sample of a Device Inventory Report in PDF format follows.
Figure 16-7: Device Inventory by Type Report

You also can output the report to Microsoft Excel (.csv) format.
Page 223
Reports User Guide

CheetahXD
16.3.4
CheetahXD User
Reports
Guide
The Provisioned Transponders Report lists the following information about provisioned transponders:
Display Name
MAC address
IP address
Last download date/time
Last update date/time
The contents of User Fields 1-5
Location
To Display the Provisioned Transponders Report:

Click the Provisioned Transponders Report link and follow system prompts to produce a Provisioned Transponder
Report. A sample report follows.
Figure 16-8: Provisioned Transponders Report

16.3.5
The Transponder Firmware Report is used to view Cheetah device firmware versions in the CheetahXD system. As
devices are discovered into the system, their associated FW versions are added to the database. As new FW is
downloaded to devices, the database is updated to reflect the change. When reports are run, all data presented
comes from the database directly and not from the device.
Firmware versions are gathered from the following OIDS dependent upon device type:
docsDevSWCurrentVers (3348 and 3349 DOCSIS)

commonVendor (Non DOCSIS HMS)
firmwareVersion (CL Legacy devices)
The report displays the following information:
Display Name
IP Address
MAC Address
Device Modifier
Page 224
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Firmware Version
Page 225
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
To Display the Transponder Firmware Report:

Click the Transponder Firmware Report link. The page displays, as shown in Figure 16-9.
Figure 16-9: Transponder Firmware Report Generate Page

Click to select the Device Category, In the Select Device Name Filter fields, click the drop-down list box to select a
search filter and enter additional criteria in the text-entry field, if applicable, click the Device List button to display a
list of devices. Click to select one or more devices (Ctrl+Click). Click the Generate Report Button to produce the
report. Follow the system prompts that display.
Figure 16-10: Transponder Firmware Report
Page 226
Reports User Guide

CheetahXD
16.4
CheetahXD User
Reports
Guide
Fault Reports
Fault reports include:

Device Dead Report
Fault reports are available in PDF or editable .csv output format, and include filters to produce reports containing
specific data types.
16.4.1
Filtering Fault Report Data
With the exception of the Device Dead Report, each fault report link takes you to an intermediary page where you
can specify criteria for filtering the data on the report. If the operator does not specify any filtering criteria, all of the
(unfiltered) available data will be displayed.
Filter alarm reports by specifying:
One or more device categories and/or severities using the standard <Shift>, <Ctrl>, and click combinations
A range of dates by clicking the calendars to the right of the text boxes and selecting a beginning and ending
date (default is the current date).
16.4.2
The Alert Report by Category contains detailed alert information for the selected device types (categories) and
severities, grouped by categories (e.g., all fiber nodes, all power supplies, etc.) for a specified data range.
To Display an Alert Report by Category Report:
column on the Alarm Report line.
Click the Alert Report by Category Link. The Alert Report Filters page displays.
Page 227
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Figure 16-11: Alert Report Filters
Page 228
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Select the desired categories, severities, and date range to filter the report. To specify the date range, click the
calendar icons to the right of the Start Date and End Date fields and select the start and end dates. From the Start
Date drop-down list, select either last modified or created. Selecting the last modified option will display alarms that
were last modified between the specified start- and end-date range. Selecting the created option will display alarms
that were created or recognized for the first time by the system between the specified start- and end-date range.
Click Generate Report and follow the system prompts to produce a report. A sample Alert Report follows.
Figure 16-12: Alert Report

16.4.3
The Alert Listing Report lists the alert information for the selected categories and severities, grouped by severity.
To Display an Alert Listing Report:
column on the Alert Listing Report line Click the Alert Listing Report link. The Alert Listing Report Filters page
displays.
Page 229
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Figure 16-13: Alert Listing Report Filters
Page 230
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Specify the desired categories, severities, and date range to filter the report. To specify the date range, click the
calendar icons to the right of the Start Date and End Date fields, and select the start and end dates. From the Start
Date drop-down list, select either last modified or created. Selecting the last modified option will display alarms that
were last modified between the specified start- and end-date range. Selecting the created option will display alarms
that were created or recognized for the first time by the system between the specified start- and end-date range.
Click Generate Report and follow system prompts to produce the report. A sample Alert Listing Report in PDF format
follows.
Figure 16-14: Alert Listing Report
Page 231
Reports User Guide

CheetahXD
16.4.4
CheetahXD User
Reports
Guide
The Active Alert Status Report by Device lists the currently active alerts for the selected categories and severities.
This report is analogous to the alarms displayed in real-time in the Notifier.
To Display an Active Alert Status Report by Device Report:
column on the Active Alert Status Report by Device line. Click the Active Alert Status Report by Device link. The Active
Alert Status Report Filters page displays.
Figure 16-15: Active Alert Status Report Filters

Select the categories and severities to include. Press Ctrl + Click to specify multiple filters. Click Generate Report and
follow the system prompts to produce the report. A sample Active Alert Status Report in PDF format follows.
Page 232
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Figure 16-16: Active Alert Status Report
Page 233
Reports User Guide

CheetahXD
16.4.5
CheetahXD User
Reports
Guide
Device Dead Report
The Device Dead report lists devices that are either not communicating or are not present in the network.
To Display the Device Dead Report:
Accept the default PDF output file type, or click the down arrow in the Output column on the Device Dead Report line
to change to the .csv output. Click the Device Dead Report link. The following is a sample Device Dead report in PDF
format.
Figure 16-17: Device Dead Report
Page 234
Reports User Guide

CheetahXD
16.4.6
CheetahXD User
Reports
Guide
The Alert Analysis Report displays selected devices having the most numerous repeat alarms. This is a diagnostic
tool that allows users to identify those devices most often generating repeat alarms.
To Display the Alert Analysis Report:
Accept the default PDF output file type, or change to the CSV output file type by clicking the down arrow in the Output
column on the Alert Analysis Report line.
Click the Alert Analysis Report link. The Alert Analysis Report Filters page displays.
Figure 16-18: Alert Analysis Report Filters Page

Specify the criteria to filter the report.
Select Date Range The end date automatically defaults to the current date. Click the calendar icon next to the
Last Modified Start Date field and select a start date.
Include Communication Alerts? This option defaults to excluding communication alerts, which can be both
numerous and unimportant in this context. To include communication alerts, click the All Alerts radio button.
Page 235
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Updated Alerts? The first time a device goes into an alarm state, its alert update count is set to zero. The
count actually keeps track of repeat occurrences so the second time an alert occurs for the device, the count is
incremented (to 1). The Updated Alerts? option defaults to Show Only Updated Alerts to avoid including devices
Page 236
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
with only one occurrence (a count of zero). To include devices with only one occurrence, click the All Alerts radio
button.
Number of Alerts to Return? Specify the top 10, 25 or 50 devices with the most numerous occurrences.
Select Categories Specify at least one device type to include in the report.
Click Generate Report. Follow the system prompts to produce the report. A sample Alert Update Report in PDF format
follows.
Figure 16-19: Alert Analysis Report
Page 237
Reports User Guide

CheetahXD
16.4.7
CheetahXD User
Reports
Guide
The Power Supply Alert Report contains multiple filters that allow you to analyze which alerts were generated on
specific power supplies during a designated time period.
To Display a Power Supply Alert Report:
Accept the default PDF output file type, or change to the CSV output file type by clicking the down arrow in the Output
column on the Power Supply Alert Report line.
Click the Power Supply Alert Report link. The Power Supply Alert Report Filters page displays.
Figure 16-20: Power Supply Alert Report Filters

Build the report by selecting:
One or more power supplies from either the Select Power Supplies list or the Select MAC Addresses list
(selecting from both lists causes the filter to search for power supplies that meet both criteria, which can result
in no power supplies being found)
A date range by clicking the calendar icons to the right of the Start Date and End Date lines
From the Start Date drop-down list, select either last modified or created. Selecting the last modified option will
display alarms that were last modified between the specified start and end date range. Selecting the created
Page 238
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
option will display alarms that were created or recognized for the first time by the system between the specified
start and end date range.
One or more types of alerts from the Select Alarmable Attributes list.
Page 239
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
All filters except begin and end dates accept multiple selections using Ctrl + Click.
Click Generate Report. A sample Power Supply Alert Report in PDF format follows.
Figure 16-21: Power Supply Alert Report
Page 240
Reports User Guide

CheetahXD
16.4.8
CheetahXD User
Reports
Guide
The Power Outage Summary report displays the report criteria on the top row, and then lists the following
information:
Total number of outages

Avg/Min/Max amount of outage time
Note: This amount is only calculated for devices that ended standby mode. If the device was in standby when the report
was generated, the device will not be included in the report.
Number of failures
Percentage of failures
To Display a Power Outage Summary Report:

1.
Navigate to the Domain Options > HFC Domain > Reports page.
2. Under the Fault Reports section, select the Power Outage Summary Report link (CSV is the only available output
file type for this report). The following Power Outage Summary Report Filters page displays.
Figure 16-22: Power Outage Summary Report Filters
Page 241
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
3. Click the Calendar Icons to the right of the Last Modified Start Date and Last Modified End Date lines to specify
a date range.
4. Enter the name of the desired power supply to test in the Display Name Filter box.
Page 242
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
5. Enter the name of the tree on which the desired power supply resides in the Filter By Tree box.
6. Enter the desired Pass/Fail Hour Threshold to test in the Number of Hours box. This is the number of hours the
power supply should last on batteries. Any power supply that lasts less than this will be listed as failed on the
report.
7. Click Generate Report. The report will be downloaded to your computer.
NOTE: Reports will be generated for HMS power supplies only.
Page 243
Reports User Guide

CheetahXD
16.4.9
CheetahXD User
Reports
Guide
The Power Outage Detail report displays the same information as the Power Outage Summary report, but includes
each event (or cleared event) associated with the device during the time period including 10 minutes prior and 10
minutes after the outage.
To Display a Power Outage Detail Report:
1.
Navigate to the Domain Options > HFC Domain > Reports page.
2. Under the Fault Reports section, select the Power Outage Detail Report link (CSV is the only available output file
type for this report). The following Power Outage Detail Report Filters page displays.
Figure 16-23: Power Outage Detail Report Filters

3. Click the calendar icons to the right of the Last Modified Start Date and Last Modified End Date lines to specify a
date range.
4. Enter the name of the desired power supply to test in the Display Name Filter box.
5. Enter the name of the tree on which the desired power supply resides in the Filter By Tree box.
6. Enter the desired Pass/Fail Hour Threshold to test in the Number of Hours box. This is the number of hours the
power supply should last on batteries. Any power supply that lasts less than this will be listed as failed on the
report.
7. Click Generate Report. The report will be downloaded to your computer.
Page 244
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
NOTE: Reports will be generated for HMS power supplies only.
Page 245
Reports User Guide

CheetahXD
16.5
CheetahXD User
Reports
Guide
Performance Reports
Performance reports include the Battery Analyst and Scheduler reports. Security permissions are required to view
some performance reports. If a user without the required permissions attempts to run a Performance Report, an
error will display.
16.5.1
The Battery Analyst Report contains the results from automatic (background) and/or manual (on-demand) power
supply tests (see the chapter titled Testing Power Supplies). Results can be filtered for the report by specifying either
devices or schedule names. Output options are PDF files or editable, tab-delimited text files that can be imported
into other applications.
To see a complete history of a power supplys tests, specify a date range that encompasses the life of the power
supply from its installation to the present.
To Display a Battery Analyst Report by Device(s):
Accept the default PDF output file type or change to the CSV output file type by clicking the down arrow in the Output
column on the Battery Analyst Report line. Click the Battery Analyst Report link in the HFC Reports page. The following
page displays.
Figure 16-24: Battery Analyst Report Setup

Click the Report By Top Level Devices radio button.
Scroll the list in the Select Top Level Devices box and select one or more top-level devices. Use Ctrl + Click to select
multiple devices. Click Submit. The following page displays.
This page displays the power supplies that are children of the top-level devices selected in the previous window. It
also allows you to filter the report data by the following criteria:
Select Date Range Begin and end dates default to todays date. Choose different begin and end dates by
clicking the calendars next to the fields and selecting the dates. To see a complete history of a power supplys
tests, specify a date range that encompasses the life of the power supply from its installation to the present.
Analysis Parameters These options allow you to filter the tests for the report by the test results.
Page 246
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
String Variance is the amount of voltage variance that occurred during the pre-standby portion of the test,
between the battery in the string with the highest voltage and the battery in the string with the lowest voltage.
Battery strings whose battery voltages varied by the specified amount or more during pre-standby
Page 247
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
measurements will be included in the report. To change the default string variance of 0.3, type a new value in
the String Variance text field.
Discharge Variance is the amount of voltage variance that occurred per individual battery over time, during the
test. Batteries whose variance equaled or exceeded the specified value will be included in the report. To change
the default discharge variance of 0.7, type a new value in the Discharge Variance text field.
Exclude Passed Tests allows you to produce a report showing only those power supplies that did not pass. The
default is to include passed tests. Click the Exclude Passed Tests checkbox to eliminate them from the report.
Generate Error Listing Only allows you to produce a report showing only the detailed results of the Power
Supplys that failed a Battery Analyst test. See the end of this section for samples and descriptions of the report
output.
Select Power Supplies This list displays the power supplies that are children of the top-level devices you
selected in the previous page. Scroll the list and select one or more power supplies. Use Ctrl+ Click to select
multiple entries.
Click Generate Report.

To Display a Battery Analyst Report by Schedule Names:
Accept the default PDF output file type, or change to the CSV or XML output file type by clicking the down arrow in the
Output column on the Battery Analyst Report line.
Click the Battery Analyst Report link in the HFC Reports page. The following page displays.
Click the Report by Schedule Names radio button.
Scroll the list in the Select Schedule Names box and select one or more schedules. Use Ctrl + Click to select multiple
entries, if applicable.
Click Generate Report. The following page displays.
Figure 16-25: Analysis Parameters
Select Report Criteria These two options allow you to filter the tests for the report by the test results.
Variance is the amount of voltage variance that occurred per individual battery over time, during the test.
Batteries whose variance equaled or exceeded the specified value will be included in the report. To change the
default discharge variance of 0.7, type a new value in the Discharge Variance text field.
Exclude Passed Tests allows you to produce a report showing only those power supplies that did not pass. The
default is to include passed tests. Click the Exclude Passed Tests checkbox to eliminate them from the report.
Page 248
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Generate Error Listing Only allows you to produce a report showing only the detailed results of the Power
Supplys that failed a Battery Analyst test. See the end of this section for samples and descriptions of the report
output.
Page 249
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Click the Generate Report (PDF) button to produce the report in PDF format.
16.5.1.1 Reading the Battery Analyst Report

A Battery Analyst report in PDF format follows. This report contains several sections that are explained below.
Figure 16-26: Battery Analyst Results

This report contains three main sections.
Overall Results Section
The Overall Results section summarizes the number of testing schedules included, how often the testing schedules
executed, the number of transponders and power supplies tested and the variance criteria specified in the Battery
Admin test setup. A pie chart indicates the relative number of tests still executing, test that have failed, and tests
that have passed.
Individual Test Results Section
The second section of the report displays the results for individual tests. It is an on-demand test and was given that
name at the time the user scheduled and ran the test. The schedule name of the test and results display.
Detailed Results Section
The next section of the report contains detailed information showing the actual variances occurring during stand-by
on individual power supplies. The results are also graphed over time.
Standby Remaining /Battery Configuration/Status
This row in the report header is utilized for those systems which have POM licensed. The requirement for this data to
be displayed is to run a Battery Analyst Test that has a minimum of 10 In-Standby measurements. With 10
Page 250
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
measurements taken, that is enough data to use the POM algorithm and roughly calculate a Standby Remaining
value for your target power supply.
Page 251
Reports User Guide

CheetahXD
CheetahXD User
Reports
Guide
Test Status Values

The third column in the Results data chart is labeled Test Status. This indicates a numeric value mapping to a
specific result. The information below maps the numeric value to the actual result. These values are also printed on
the bottom of each Battery Analyst result for your reference.
The valid states as defined by the MIB are:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
Idle
In Progress
In Progress with abnormal results detected
Complete (normal state after 1)
Complete with abnormal results detected (normal state after 2)
Abort-Host aborted auto-test
Abort-Host force-standby action
Abort-AC Out Voltage alarm
Abort-Power supply itself aborted test
Abort-Power supply already in standby
Abort-Output Alarm Abort (other abort)
Possible status progression paths:
Normally inProgress(2), to complete(4).

Could go inProgress(2), inProgressAbnormal(3), completeAbnormal(5)
InProgress(1), abort(codes 6-11)
NOTE:
Value
For any Pre-Standby measurements, the Test Status value shows the result of the last run Battery Analyst Test.
If no test has been previously run (or the transponder has been rediscovered causing the Test status to be
reset) the status will most likely be 1 (Idle). If a test has been previously run and the transponder has not been
reset, the Test Status value could display any of the Complete or Abort states.
MIB Definition
Meaning
Possible Cause
Remedy
The test is idle
In Progress
When the test is running normally.

You will see this value in the In
Standby portion of the data grid.
Test is Running
N/A
Complete
Post test value showing the device

made it into and out of standby
Successful Test
N/A
Abort Standby
from Host
This indicates that Power Supply

was physically taken out of standby
Somebody took the PS

out of standby either
physically or via a
control
Abort AC Output
Voltage alarm
There is a Lo or LoLo Output Voltage Alert or Fuse may be bad or

missing which cause PS to report
No AC Output
Output Voltage Alert
Nothing can be done

for the current test.
Before running
another test, verify
that the PS is out of
standby.
Correct the Output
Voltage alert
Fuse may be bad or

missing or loose
Fix or replace the

Fuse
Page 252
Reports User Guide

CheetahXD
Value
9
MIB Definition
Abort PS took
itself out of
standby
10
Abort PS already
in standby
11
Abort Output
alarm
91
None
92
None
93
None
94
None
CheetahXD User
Reports
Guide
Meaning
The power supply itself didnt like
the fact it was in standby and took
itself outThis could be a number
of things
The power supply was already in a

standby state when the test was
scheduled to put the PS into standby. The test recognized it was in
standby and stopped
PS Output Failure (Alpha related)
Backend Test Failure No

Communication
Backend Test Failure Already In
Standby
Backend Test Failure Tamper

Switch Open
Backend Test Failure Input Voltage to low
Page 240
Possible Cause
Remedy
Weak Batteries
Take load tester out

and verify. May need
to replace 1 or more
batteries
Inverter failure
Replace Inverter.
Check Manufacturer
specs
Battery Breaker open

Loose battery
connections/corroded
connections
Excess load
Reset the breaker
Power Supply was in

standby
Correct the issue

causing Power
Supply to be in
standby
If the power supply

output has failed, it
will trigger the PS and
stop any tests.
Loss of RF to
transponder
Power Supply was in
standby
Battery Admin Setup

has enabled the
Tamper Switch check
Input Voltage is below
95 volts
Clean and/or tighten

terminal connections
Check Output Current
reading. If high
reduce the load
Restore RF
communications
Correct the issue
causing Power
Supply to be in
standby
Disable the check
from the Battery
Admin page
Keep the Tamper
check active but
need to resolve the
Tam- per Switch
issue at the Power
Supply
Minimum Voltage of
95 required to run
test. Resolve power
issue at Power
Supply

Reports
CheetahXD User
Reports
Guide
Sample Error Listing Report
Figure 16-27: Error Listing Report

16.5.2
Battery Summary Report
The Battery Summary Report provides the ability to display power supply test result summaries in two different
formats. The first format, the Specific Power Supply Summary format, provides all of the test results for one power
supply. The Global Power Supply Summary format provides one test result (the most recent result) for each power
supply in the list. The system generates this report as a tab-delimited file that can be imported into other
applications.
To Display a Battery Summary Report:
Click the Battery Summary Report link in the HFC Reports page. The following page displays.
This page displays the power supplies that are available. It also allows you to filter the report data by the following
criteria:
Select Date Range Begin and end dates default to todays date. Choose different begin and end dates by
clicking the calendars next to the fields and selecting the dates.
Analysis Parameters These options allow you to filter the tests for the report by the test results.
String Variance - The amount of voltage variance that occurred during the pre-standby portion of the test,
between the battery in the string with the highest voltage and the battery in the string with the lowest voltage.
Battery strings whose battery voltages varied by the specified amount or more during pre-standby
measurements will be included in the report. To change the default string variance of 0.3, type a new value in
the String Variance text field.
Exclude Passed Tests - Produces a report showing only those power supplies that did not pass. The default is to
include passed tests. Click the Exclude Passed Tests checkbox to eliminate them from the report.
Page 241

Reports
CheetahXD User
Reports
Guide
Select Report Summary Type These options select the summary type format for the report. If you wish to view
all of the test results for one power supply, click the Specific Power Supply Summary radio button and select a
power supply by highlighting it in the list.
Specific Power Supply Summary - Creates a report that lists all of the test results for the one power supply
selected in the list.
Global Power Supply Summary - Creates a report that lists one the most recent test for all of the power
supplies in the list.
Select Power Supplies Displays the power supplies. Set the Date Range and Analysis Parameters as desired.
To view all of the test results for one power supply, click the Specific Power Supply Summary radio button and select
a power supply by highlighting it in the list.
If you want to view the most recent test result for each power supply in the list, click on the radio button next to the
Global Power Supply Summary variable. This will select the "all" option as illustrated in the following example.
Click Generate Report. A sample of a Battery Summary Report is shown in the following example.
Figure 16-28: Battery Summary Report

This report is just a scaled down version of the detail Battery Analyst Reports. To recognize whether a particular
instance passed or failed, you would look at the Iteration Finished value. A true value indicates that instance of the
BA test had passed and a false value indicates that instance of the report had Failed. If the Iteration Finished value
is false, then a corresponding reason(s), will be documented in the Iteration Fail Reason column.
16.5.3
Scheduler Report
The Scheduler Report can contain information regarding either details or results of selected schedules. The
Scheduler Report displays in PDF format only and is accessed in the Domain Options tree either through the HFC
Domain Reports link, (which displays the HFC Reports Page).
This section discusses accessing the Scheduler Report through the HFC Reports link. For information on accessing
Scheduler Reports through the Scheduling link, see the chapter titled Scheduling Data Collection.
Only users with the View Schedule Reports permission are allowed to access the HFC Reports link.
Page 242

Reports
CheetahXD User
Reports
Guide
To Display the Scheduler Report:

Click the Scheduler Report link on the HFC Reports Page. This link will not be visible if the appropriate permission is
not assigned to the user.
The Select Schedule list displays the available schedules. Click to select one schedule name.
Click the Schedule Info button to produce a report containing information about the selected schedule or click the
Schedule Results button to produce a report containing the results of the selected schedule.
A sample Schedule Info report follows.
Figure 16-29: Schedule Info Report
Page 243

Reports
16.5.4
CheetahXD User
Reports
Guide
The Page Alert On-Call Report allows you to produce a listing of the technician on-call schedules. The data within
these reports can be filtered using the following criteria:
Date range
Technician(s)
Device categories.
To Display the Page Alert On Call Report:

In the HFC Reports page, click the Output drop-down menu to the right of the Page Alert On-Call Report link and
select either PDF or .csv output format.
Click the Page Alert On-Call Report link. The Page Alert On-Call Report Filters page displays.
Figure 16-30: Page Alert On-Call Report Filters

To specify:
A date range, click the calendars to the right of the Scheduled Start Date and Scheduled End Date fields and
select the start and end dates
One or more technicians, click the name(s) in the Available Technicians list, using the standard Shift, Ctrl and
click combinations to select multiple names
One or more device types, click the type(s) in the Select Categories list, using the standard Shift, Ctrl, and click
combinations to select multiple categories. Click Generate Report.
Page 244
Downloading Firmware
Reports
A sample of the Page Alert On-Call Report in PDF format follows.
Figure 16-31: Page Alert On-Call Report

16.5.5
The Power Supply Testable Report (PDF) contains information regarding the selected power supplys last test time
and if testing is disabled/enabled. The CSV version of the data contains the additional information of Battery Test
Groups associated with a device and if a Power Supply is testable or not.
The report can be pre-filtered by either:
Category this report will always be Power Supply

Battery Test Group Allows you to fetch devices associated with a Test Group
Include Non Testable Power Supplies This option is available to view a complete list of your supplies
regardless of testability.
Select the Power Supply by category or Battery Test Group. Select the Filter Device List then one or more power
supplies. Click the Generate Report Button.
Page 245
244
17
CheetahXD transponders and headend controllers are shipped with the latest firmware. When a new firmware
version becomes available, the CheetahXD Firmware Download feature allows you to download it to all appropriate
hardware without having to physically access it in the field.
CheetahXD determines which devices are compatible with the version of firmware being downloaded, and allows you
to accept downloading to only those devices, or to override CheetahXDs determination and force downloading to all
selected devices.
The Download Firmware feature supports firmware downloads to:
Headend controllers (HECs)

HMS (non-DOCSIS) transponders
DOCSIS transponders
Legacy CheetahLight transponders
Other vendors HMS and DOCSIS transponders
Starting in CheetahXD 3.1 support has been added to download firmware to Motorola GX-2 Chassis modules. The GX2 Chassis firmware download function uses a separate download mechanism than the Transponder firmware
download function. GX-2 Chassis modules are downloaded using the Bulk Task functionality built into the CheetahXD
system. For more on how to download firmware to the GX-2 Chassis modules see the following section entitled, To
Download Firmware (Excluding GX-2 Chassis Modules). To view a list of Motorola GX-2 Chassis modules that
CheetahXD supports, see Appendix A: Supported Motorola GX-2 Modules.
To Download Firmware (Excluding GX-2 Chassis Modules):
1.
2.
3.
4.
Edit the configuration file (optional).

Launch Download Firmware and select firmware file to download.
Specify download options.
Click Download.
The Download button changes to Cancel when downloading begins (allowing you to cancel the operation), and the
page displays a Download Status section.
17.1
Editing the Configuration File (Optional)
CheetahXD includes the following configuration file for downloading firmware:

<INSTALL_DIR>/conf/firmwareDownload.properties
The default values in the configuration file specify the storage location for the firmware files. This file may be edited
to specify the SNMP communications properties.
The default maximum number of retries allowed when attempting SNMP communications is three. To change the
default, add the following line to the configuration file:
firmwareDownload.max_retries = n
where n indicates the maximum number of retries allowed.
The default timeout value for SNMP communications is five seconds. To change the default, add the following line to
the configuration file:
firmwareDownload.timeout = n
where n indicates the number of seconds.
Page 246
CheetahXD UserFirmware
Downloading
Guide
IMPORTANT!
17.2
Downloading
CheetahXD User
Firmware
Guide
The CheetahXD server processes must be restarted for changes to this file to take effect.
Launch Firmware Download
After editing the configuration file, launch the Firmware Download feature.
To Launch Firmware Download:
1.
2.
Click the Administration tab.

From the CheetahXD Administration section of the page, click the Firmware Download icon.
The Firmware Download page displays.
Figure 17-1: Firmware Download Page

3. Click the Select File link to display the firmware files available for download. A list of available firmware files
displays.
Figure 17-2: Firmware File Selection Area

CheetahXD obtains the location of the files that appear in this list (found below Server Path: as shown in the
previous illustration) from the firmwareDownload.properties configuration file. See Section 17.1 for more
information.
To specify a different location for this download session, click the Change Path link, specify a different path in the
Firmware Path Selection text box, and click the Select button.
Page 247
Downloading
Guide
Downloading
CheetahXD User
Firmware
Guide
Figure 17-3: Firmware File Selection Area with the Firmware Path Selection Section
NOTE:
The path you specify must be located on the CheetahXD server, and you must know the full path. Browse is
not available for this operation.
4. Scroll the Firmware File Selection list and single-click the desired firmware file. Header information from the
selected file displays in the File Data section.
Figure 17-4: Firmware File Selection Area File Data Section

If valid header data cannot be read from the selected file, the Select button is disabled and the File Data section
displays the invalid or missing data fields.
Page 248
Downloading
Guide
5.
Downloading
CheetahXD User
Firmware
Guide
If the displayed header information is valid, click the Select button in the Firmware Files Section box. The
Firmware Download page displays.
Figure 17-5: Firmware Download Page

6. Specify the download options and click Download. See the next section for information on specifying download
options for each device type.
Page 249
Downloading
Guide
17.3
Downloading
CheetahXD User
Firmware
Guide
Specify Download Options
The Firmware Download page displays download options specific to the type of device to which you are downloading:
a HEC, an HMS (non-DOCSIS) transponder, or a DOCSIS transponder.
Following are the available options for each device type and the effects of choosing or not choosing each one. After
specifying options, click the Download button to begin the download.
17.3.1
Downloading to Headend Controllers
Select a HEC firmware file and click the Select button. The Firmware Download page displays the following options:
Verify Firmware Version When checked, CheetahXD checks each HECs firmware version level against the
version level of the selected firmware file. CheetahXD downloads firmware to only those HECs whose version
level is lower (older), than that of the firmware being downloaded.
When unchecked, firmware version verification is not performed and CheetahXD downloads firmware to all HECs
listed in the database, regardless of firmware version. This option is useful when HEC firmware files are
experiencing problems or when it is desirable to revert to a previous firmware version.
Change Mode Link This option display radio button controls used to select Advanced or Automatic mode.
Mode Automatic When selected, CheetahXD will download the selected firmware file to each HEC in the
system, one HEC at a time. The Controller Identification list contains only one option: All.
Mode: Advanced Advanced mode allows you to select individual HECs to download to and to view the
download history.
Figure 17-6: Advanced Mode
Page 250
Downloading
Guide
Downloading
CheetahXD User
Firmware
Guide
17.3.1.1 Downloading to One HEC

During the procedure to download to headend controllers (see Section 17.3.1), select Advanced mode, click the
Controller Identification list, and select a HEC.
Click Download and continue with the download procedure.
17.3.1.2 Displaying HEC Download History

Advanced mode also allows you to displays a HECs download history. Click the Controller Download History link.
Download history displays on the right side of the page.
Figure 17-7: HEC Download History

Download history consists of:
Last successful download: date of most recent successful download

User: name of user performing most recent successful download
Version: version of firmware most recently downloaded
In the previous graphic, when N / A (not applicable) appears in all of the Download History fields, this is an indication
that no firmware has been downloaded to this HEC since its installation.
17.3.2
Downloading to HMS (Non-DOCSIS) Transponders
Select an HMS (non-DOCSIS) firmware file and then click the Select button. The Firmware Download page displays
the following options:
Verify: Personality When checked, CheetahXD checks each transponders personality against the personality
specified in the selected firmware file. CheetahXD downloads to only those transponders whose personalities
match.
When unchecked, personality verification is not performed and CheetahXD downloads firmware to all
transponders listed in the database, regardless of personality.
Verify: Firmware Version When checked, CheetahXD checks each transponders firmware version against the
version of the selected firmware file. CheetahXD downloads firmware to only those transponders whose version
level is lower (older) than that of the firmware being downloaded.
When unchecked, firmware version level verification is not performed and CheetahXD downloads firmware to all
transponders listed in the database, regardless of firmware version. This option is useful when transponder
firmware files are experiencing problems, or when it is desirable to revert to a previous firmware version level.
Change Mode link This option displays radio button controls used to select Advanced or Automatic mode.
Mode: Automatic Automatic download allows you to select all HMS transponders for all HECs or all HMS
transponders for a specific HEC (transponders must also meet the personality and firmware version options
selected, as described above). The Controller Identification list contains options for selecting all HECs or one
specific HEC.
Mode: Advanced Advanced mode allows you to specify a particular transponder to download to, perform a
broadcast download of the firmware to all HMS transponders simultaneously, and view download history.
Page 251
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
17.3.2.1 Downloading to One HMS Transponder

During the procedure to download to HMS transponders (see Section 17.3.2), select one HMS transponder for
download in either of the following ways:
Typing the MAC address in the Device Address field in hex format, either non-delimited or in two-digit groups
delimited by spaces, colons or hyphens.
Clicking the Select From List button and selecting a MAC address from the Select Device section that appears
(all HMS transponders, regardless of personality, appear in the Select Device list).
Figure 17-8: Select Device Section

17.3.2.2 Broadcast Downloading to All HMS Transponders
Broadcast downloading allows you to select all non-DOCSIS HMS transponders and download firmware to them
simultaneously. Perform broadcast downloading using the Advanced mode (see Mode: Advanced, above). Whether
or not the Verify: Personality radio button is checked, non-DOCSIS HMS transponders will accept only those
broadcasts whose header information contains a personality that matches theirs. All other broadcasts will be ignored
by the transponder.
To broadcast download, type a device address of repeating Fs in the Device Address: field in hex format, either
non-delimited or in two-digit groups delimited by spaces, colons, or hyphens, as shown in Figure 17-9.
Figure 17-9: Device Address Broadcast Downloading to All HMS Transponders
Page 252
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
17.3.2.3 Displaying HMS Transponder Download History

Advanced Mode also allows you to display an HMS transponders download history. Click the Device Download
History link. Download history displays on the right side of the page.

Image: firmware image most recently downloaded; H for high image, L for low image
In the previous graphic, when N / A (not applicable) appears in all of the Download History fields, this is an indication
17.3.3
Downloading to DOCSIS Transponders
Select a DOCSIS firmware file and then click the Select button. The Firmware Download page displays the following
options:
Verify: Personality When checked, CheetahXD checks each transponders personality against the personality
specified in the selected firmware file. CheetahXD downloads to only those transponders whose personalities
match.
When unchecked, personality verification is not performed, and CheetahXD downloads firmware to all
transponders listed in the database, regardless of personality.
Verify: Firmware Version When checked, CheetahXD checks each transponders firmware version against the
version of the selected firmware file. CheetahXD download firmware to only those transponders whose version
level is lower (older), than that of the firmware being downloaded.
When unchecked, firmware version level verification is not performed and CheetahXD downloads firmware to all
transponders listed in the database, regardless of firmware version. This option is useful when transponder
firmware files are experiencing problems, or when it is desirable to revert to a previous firmware version level.
Change Mode link This option displays radio button controls used to select Advanced or Automatic mode.
Mode: Automatic Automatic download allows you to select all transponders for all CMTSs or all transponders for
a specific CMTS (transponders must also meet the personality and firmware version options selected, as
described above). The Controller Identification list contains options for selecting all CMTSs or one specific CMTS.
NOTE:
If a selected CMTS exists in the HFC view, only those discovered transponders that have been associated with
that CMTS are included in the firmware download. If the selected CMTS exists only in the Native view, all
discovered DOCSIS transponders, whether assigned to a CMTS or not, are included in the firmware download
operation. For more information on views, see the chapter titled Tree Views.
Mode: Advanced Advanced mode allows you to specify a particular transponder to download to, and to view
download history.
17.3.3.1 Downloading to One DOCSIS Transponder

During the download procedure (see Section 17.3.3), specify one transponder in either of the following ways:
Typing the IP address in the Device Address field

Clicking the Select From List button and selecting a display name from the Select Device box that appears (all
DOCSIS transponders, regardless of personality, appear in the Select Device list).
Continue with the download procedure.
Page 253
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
17.3.3.2 Displaying DOCSIS Transponder Download History

Advanced Mode also allows you to display a DOCSIS transponders download history. Click the Device Download
History link. Download history displays on the right side of the page.

Image: firmware image most recently downloaded: H for high image, L for low image
In the above graphic, when N / A (not applicable) appears in all of the Download History fields, this is an indication
17.4
Download Status
After clicking the Download button to begin the download, the Download Status information displays. A progress bar
graphically represents the download status of each device included in the download operation. When the operation
is complete for a device, the progress bar is replaced by a string indicating success or failure of the devices
download.
Figure 17-10: Download Status

Download Status information consists of:
Download Status Initializing, Running, Finished

Device Address IP address of each device being downloaded to
Controller Address IP address of each headend controller (or virtual headend controller) being downloaded to
Download Status current state of the download procedure
Image name of the firmware file being downloaded
Total lines number of lines of code in the image file
Progress graphical progress bar indicating percentage of download complete
Page 254
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
When download is complete for all devices, the Download Status line at the top of the page indicates Finished and
each device entry shows its specific status, either Complete for a successful download, or an error condition.
Page 255
Downloading
CheetahXD
UserFirmware
Guide
17.5
Downloading
CheetahXD User
Firmware
Guide
Download Log File
The download log file is stored in

<INSTALL_DIR>/logs
CheetahXD creates a log file of a user specified length (the default is 10,000 lines) and names it
CTFirmwareDownload<index>.txt, where <index> is the number 1.
The log file is appended with entries up to a user-specified number of lines. When that maximum is reached, a new
log file is created and named CTFirmwareDownload<index>.txt, where <index> is the number 2 , and so on.
CheetahXD creates a user-specified number of log files (the default is 10). When the maximum number of files is
reached, CheetahXD deletes the oldest file before creating the new one. To change the default settings, select the
Logs Configurator link from the Server Details menu.
Figure 17-11: GX2 FW File List
17.6
Downloading Firmware to Individual DOCSIS Transponders or Modules from the Tree View
Beginning with version 5.2, CheetahXD Users are able to download firmware directly to individual DOCSIS
Transponders or Modules right from the Tree View.
17.6.1
1.
2.
To Download Firmware to a Transponder or Other Supported Device

From the Tree View, right-click on a device and navigate to Download.
Click Download Generic Firmware.
Page 256
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
Page 257
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
3. On the Generic Firmware Download page, click the Radio Button of the Device Type to download firmware
to.
4. Select the radio button of the Firmware File to download.
5. Click the Download FW button and follow the progress of the download on the bulk task page.
6. The IP address of the CheetahXD server is automatically entered. To change the default, enter the new
address in the TFTP Server IP Address Text Box.
Note: If using a TFTP server other than CheetahXD, the directory structure needs to be the same and the files need to be
placed on the TFTP server being used as well as the CheetahXD\backup\gx2FwFiles\genericFwFiles directory.
17.6.2
1.
To Add Firmware to the Server

Add the update files to the CheetahXD\backup\gx2FwFiles\genericFwFiles directory (creating the
\backup\gx2FwFiles or \genericFwFiles directories if needed).
NOTE: The \backup and any contained folders wont exist if a backup hasnt been executed. The gx2FwFiles folder wont
exist if not previously created to contain GX2 firmware files. The genericFwFiles directory wont exist if this is the first time
the device is being set up.
17.7
Downloading to Motorola GX-2 Chassis Modules
17.7.1
Setup
To download firmware to the GX-2 modules the following setup procedure must be completed:
1.
2.
3.
If running, shutdown the CheetahXD server.

Navigate to the CheetahXD installed directory.
Open the backup directory in the CheetahXD directory.
NOTE:
4.
5.
If the backup directory does not exist it will need to be created with the directory name backup.
Create a directory called gx2FwFiles in the backup directory.

Place all GX-2 Firmware files in the gx2FwFiles directory.
NOTE:
Steps 6-9 only need to be performed if the user wishes to use the CheetahXD Server as the TPTP Server.
If another TFTP Server is already configured, copy the GX-2 Firmware files to the default TFTP directory
and proceed to step 10.
6. Navigate to the conf directory in the CheetahXD installed directory.

7. Open the file entitled NmsProcessesBE.conf with a text editor.
8. Remove the # from in front of the following lines to activate the TFTP process and to set the path of the GX2
firmware files.
PROCESS
com.adventnet.nms.tftp.NmsTftpServer
ARGS
TFTP_ROOT_DIRECTORY /CheetahXD/backup/gx2FwFiles/
NOTE:
The path of the TFTP_ROOT_DIRECTORY may need to be changed to display the full path where CheetahXD
is installed.
For example:
Page 258
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
In a Windows environment if the install path for CheetahXD is C:\Program Files\ then the path would display the
following:
Page 259
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
Program Files/CheetahXD/backup/gx2FwFiles/
In a Unix environment if the install path for CheetahXD is /export/home then the path would display the
following:
/export/home/CheetahXD/backup/gx2FwFiles/
9. Save the altered NmsProcessesBE.conf file.
10. Restart CheetahXD
11. Connect to the Server with a web browser and navigate to a tree view where the GX-2 Chassis(s) are displayed.
12. Right click on the GX-2 chassis icon in the tree
and select Device Configuration.
13. When the Device Configuration page opens click on the Misc tab.
14. When the page changes, find the Control Module and click the + to expand the options (The Control Module
will be the only module with a + next to the icon).
15. Enter the IP address of the CheetahXD server in the TFTP Server text box.
16. Click the Save and Download button.
IMPORTANT!
If a TFTP Server IP address already exists in the GX-2 Control module, it will be overwritten if you click
the Save and Download button.
17. Repeat Steps 12-15 for each additional GX-2 Chassis which will require new firmware updates.
17.7.2
1.
2.
Downloading GX-2 Module Firmware to One Module
Right click on the individual GX-2 module to which the new firmware will be downloaded to and select
Download, and then Download GX2 Firmware.
When the GX2 FW Download Page appears select the firmware file to be downloaded to the module.
NOTE:
If a firmware file(s) cannot be identified for the specific module type selected, all available firmware files will
appear.
3. If it is desired to download firmware to the modules inactive image but to continue operating on the current
active image after the download operation has completed, select the No Reset radio button. If it is desired to
download firmware to the module and to switch to the image that was downloaded after the download operation
has completed, select the Reset Module radio button.
4. Click the Download GX2 FW button to begin the download.
After the Download GX2 FW button is clicked the Bulk Task Status page will appear. This page displays the
firmware download progress. For more information on the Bulk Task Status page see the section entitled, Bulk Task
Status. When the firmware download is complete it will be moved from the Active Bulk Tasks section of the page
to the Completed Bulk Tasks section of the page.
NOTE:
17.7.3
There is a timeout value of 15 minutes for the TFTP file transfer and a timeout value of 30 minutes for the
firmware download to the module.
Downloading GX-2 Module Firmware to Multiple Modules
Although multiple modules can be selected for the firmware download only one module is downloaded at a time.
Once a module has been downloaded the next module in the Bulk Task List is then downloaded.
This continues until all selected modules of the same type have been downloaded.
Page 260
Downloading
CheetahXD
UserFirmware
Guide
1.
2.
Downloading
CheetahXD User
Firmware
Guide
Select the modules it is desired to download firmware to using conventional Windows selection methods.
Right click on any of the selected GX-2 modules and select Download and then Download GX2 Firm- ware.
Page 261
Downloading
CheetahXD
UserFirmware
Guide
3.
Downloading
CheetahXD User
Firmware
Guide
Repeat steps 2-4 of the section entitled, Downloading GX-2 Module Firmware to One Module.
NOTE:
17.7.4
If different module types are selected all firmware files that are compatible with any of the selected module types
will appear on the GX2 FW Download Page. If this occurs, select the firmware file that corresponds with the
module type.
Downloading GX-2 Module Firmware to all Like Modules in one or Multiple GX-2 Chassis
Although multiple modules can be selected for the firmware download only one module is downloaded at a time.
Once one module has been downloaded the next module in the Bulk Task List is then downloaded. This continues
until all selected modules of the same type have been downloaded.
1. Select one or more GX-2 Chassis in the tree.
2. Right click on any of the selected GX-2 Chassis and select Download and then Download GX2 FW Chassis.
3. When the GX2 FW Download Page appears select the firmware file that corresponds with the modules that it is
desired to download.
NOTE:
In the Download GX2 FW Chassis mode all available firmware files will appear.
4. If it is desired to download firmware to the modules inactive image but to continue operating on the current
active image after the download operation has completed, select the No Reset radio button. If it is desired to
download firmware to the module and to switch to the image that was downloaded after the download operation
has completed, select the Reset Module radio button.
5. Click the Download GX2 FW button to begin the download.
After clicking the Download GX2 FW button the Bulk Task Status page displays. This page displays the
firmware download progress. For more information on the Bulk Task Status page see the section entitled, Bulk
Task Status. When the firmware download is complete it will be moved from the Active Bulk Tasks section of
the page to the Completed Bulk Tasks section of the page.
NOTE:
17.7.5
There is a timeout value of 15 minutes for the TFTP file transfer and a timeout value of 30 minutes for the
firmware download to the module.
Troubleshooting
17.7.5.1 Events
Traps are sent from the GX2 Chassis that detail the progress and status of the GX2 Firmware Download process.
These traps are turned into CheetahXD Events by the Fault Processing subsystem and can be tracked through the
Event Tab of the Notifier Faults Viewer application. The events will show up in the Event tab with a Severity field
value of Info and can be identified by the Gateway Parent field value matching the GX2 Chassis Display Name.
The Message field value will give the specific detailed information associated with each Event.
17.7.5.2 Download Log File

The download log information is stored in two files in
<INSTALL_DIR>/logs
CheetahXD creates 2 log files of a user specified length (the default is 10,000 lines) and names them
CTNetworkInventoryAPIBE<index>.txt and CTNIBulkTaskManager<index>.txt where <index> is the number 1.
Page 262
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
Each log file is appended with entries up to a user-specified number of lines. When that maximum is reached, a new
log file is created and named appropriately where <index> is the number 2, and so on.
Page 263
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
CheetahXD creates a user-specified number of log files (the default is 10). When the maximum number of files is
reached, CheetahXD deletes the oldest file before creating the new one. To change the default settings, select the
Logs Configurator link from the Server Details menu.
Page 264
Downloading
CheetahXD
UserFirmware
Guide
Downloading
CheetahXD User
Firmware
Guide
Page 265
CheetahXD
Using
the SNMP
User Guide
Agent to Forward Notifications
Usingtothe
Third-Party
SNMP Agent
Applications
to Forward Notifications to Third-Party
CheetahXD
Applications
User Guide
18
Using the SNMP Agent to Forward Notifications to Third-Party Applications
The SNMP Agent application provides CheetahXD with the capability to forward alerts to one or more third party
applications that can accept SNMP traps. The SNMP Agent is a separate application that requires the appropriate
software license. For more information on obtaining an SNMP Agent license, please contact your Cheetah sales
representative.
The format of the SNMP trap messages are defined by data contained in MIB files that are stored on the CheetahXD
server. The MIB files are not necessary for third party applications, but can be referenced if desired. The following
example provides the default installation location for the MIB files. Be certain to substitute the appropriate drive
letter in the Drive portion in the following example.
C:\CheetahXD\mibs
CheetahXD provided the operator the ability to filter traps being forwarded to the third party application. Refer to
Section 5.10, Alert Filters, for details on how to use the filtering feature.
18.1
Editing the CheetahXD Trap Forwarding Table
The trap forwarding table is an Extensible Markup Language (XML) file called V1V2 Trap Forwarding Table.xml. This
file specifies the host IP addresses on the network that will receive trap messages. Cheetah recommends making a
backup of the default file before making edits to the file.
To edit the CheetahXD Trap Forwarding table:
1. On the CheetahXD server, navigate to the location of the V1V2TrapForwardingTable.xml file. The following
examples list the default installation locations for the Windows and Solaris systems.
Windows: C:\CheetahXD\conf\jmx_agent\conf
Solaris: /opt/CheetahXD/conf/jmx_agent/conf
2.
Open the file V1V2TrapForwardingTable.xml in a text editor. The file contains the following default data:
<?xml version="1.0" encoding="UTF-8" ?>
<Table>
<row>
<column name="managerHost" value="127.0.0.1" />
<column name="managerPort" value="8003" />
<column name="version" value="2" />
<column name="community" value="public" />
<column name="timeOut" value="3200" />
<column name="retries" value="0" />
<column name="rowStatus" value="1" />
</row
</Table>
Page 266
CheetahXD
Using
the SNMP
User Guide
Usingtothe
Third-Party
SNMP Agent
Applications
CheetahXD
Applications
User Guide
3. Change the value of the managerHost entry to the IP address of the targeted northbound machine. If more
than one machine will be receiving traps, duplicate a row block (i.e.; all of the data between and including the
<row> </row) for each additional machine, as shown in the following example. Edit each row block as
appropriate for each machine.
<?xml version="1.0" encoding="UTF-8" ?>
<Table>
<row>
</row
<row>
</row>
</Table>
4.
5.
Change the value of the managerPort entry to that of the targeted machines SNMP port number. This entry
must match the port number defined on the targeted machine for receiving SNMP traps (usually port 162).
The default values of the remaining entries are generally sufficient for most cases, but can be changed as
desired for your environment. The following is a brief definition of each value.
version SNMP protocol version (must be set to the value of 2)
community SNMP trap community string
timeOut SNMP timeout in seconds
retries Number of times to retry when communications fail
rowStatus The status of this conceptual row. Until all instances of all the corresponding columns are
appropriately configured, the value of the corresponding instance of the usmUserStatus column is notReady or
zero (0).
Once all of the edits have been made, save the file. Do not rename the file.
IMPORTANT!
This file is read only once at startup. Anytime this file is changed CheetahXD must be restarted.
Page 267
CheetahXD
Using
the SNMP
User Guide
Usingtothe
Third-Party
SNMP Agent
Applications
CheetahXD
Applications
User Guide
18.2
Trap Message Example
The trap notification OIDs, as of CheetahXD v3.2, match the actual MIB definitions. There is a variation in the OID
sent based on a V1 or a V2 trap. In the CheetahXD implementation the specific trap notification OIDs for V1 traps
are:
Enterprise OID: .1.3.6.1.4.1.2082.3.2.3.8.2
Generic Type: 6
Specific Type: 1
Clear Specific Type: 2
Warning Specific Type:
3
Minor Specific Type: 4
Major Specific Type: 5
Critical
For V2 traps are:

Trap OID: .1.3.6.1.4.1.2082.3.2.3.8.2.1
Clear Trap OID: .1.3.6.1.4.1.2082.3.2.3.8.2.2
- Warning Trap OID:
.1.3.6.1.4.1.2082.3.2.3.8.2.3
Minor Trap OID: .1.3.6.1.4.1.2082.3.2.3.8.2.4
- Major Trap OID:
.1.3.6.1.4.1.2082.3.2.3.8.2.5
Critical
For Notification Traps:
.1.3.6.1.4.1.2082.3.2.2.14.2.1.1 moEnrolNotification
.1.3.6.1.4.1.2082.3.2.2.14.2.2.2 moDeenrolNotification
.1.3.6.1.4.1.2082.3.2.2.14.2.3.3 moAttrChangeNotification
The specific varbinds for each trap are defined in the MIB properties for the
trap notification prefix.
Below is an example of a typical trap message that will be forwarded. It provides a reference as to the type of
bindings available for use with third-party applications.
alertMajorNotification
Message type: Notification (Trap) Protocol version: SNMPv2c
Transport: IP/UDP
Page 268
CheetahXD
Using
the SNMP
User Guide
Usingtothe
Third-Party
SNMP Agent
Applications
CheetahXD
Applications
User Guide
Agent Address: 10.1.37.126 Port: 53859
Page 269
CheetahXD
Using
the SNMP
User Guide
Usingtothe
Third-Party
SNMP Agent
Applications
CheetahXD
Applications
User Guide
Manager Address: 10.1.37.18 Port: 0

Community: public
Bindings (10)
Binding #1: sysUpTime.0 *** (timeticks) 0 days
00h:06m:17s.02th Binding #2: snmpTrapOID.0 *** (oid)
alertMajorNotification Binding #3: sequenceNum ***
(gauge32) 76
Binding #4: alertentity *** (octets)
DOCSIS_00269709c73d_Power_Supply_3:psTotalStringVoltage
[44.4F.43.53.49.53.5F.30.30.32.36.39.37.30.39.63.37.33.64.5F.50.6F.77.65.72.5F.53.
75.70.70.6C.79.5F.33.3A.70.73.54.6F.74.61.6C.53.74.72.69.6E.67.56.6F.6C.74. ...
Binding #5: alertownerName *** (octets) (zero-length) [
(hex)] Binding #6: alertDescription *** (octets) DOCSIS XM2
00269709c73d
Power Supply 3: Current Value = 58.00
Binding #7: alertTimeStamp *** (gauge32) 3227678312
Binding #8: alertNotificationId *** (int32) 252886
Binding #9: alertcategory *** (octets) Power Supply
[50.6F.77.65.72.20.53.75.70.70.6C.79 (hex)]
Binding #10: alertExtraProperties *** (octets)
GatewayDeviceName=DOCSIS XM2 00269709c73d,TopLevelDeviceName=DOCSIS XM2
00269709c73d Power Supply 3
[47.61.74.65.77.61.79.44.65.76.69.63.65.4E.61.6D.65.3D.44.4F.43.53.49.53.20.58.4D.
32.20.30.30.32.36.39. ...
18.3
Notification Formats
The CheetahXD SNMP Agent application forwards managed object notifications and alert notifications. These two
types of notifications are discussed in more detail in the sections that follow.
18.3.1
Managed Object Notifications
The three types of managed object notifications the SNMP Agent forwards on to other machines are listed below,
along with a brief description of each type.
moEnrolNotification This notification is sent when an object has been discovered in a particular Management
Domain.
moDeenrolNotification This notification is sent when an object has been deleted from a particular
Management Domain.
moAttrChangeNotification This notification is sent when there is a change in the value of the Management
Object.
Page 270
CheetahXD
Using
the SNMP
User Guide
Usingtothe
Third-Party
SNMP Agent
Applications
CheetahXD
Applications
User Guide
18.3.2
Alert Notifications
Alert notifications are synchronous messages sent from CheetahXD for various alarm severities. The five types of
alert notifications are listed below, along with a brief description of each type.
alertClearNotification This notification states that one or more previous alerts have been cleared.
alertWarningNotification This notification states that an alert of severity warning has been raised on a
Managed Object.
alertMinorNotification This notification states that an alert of severity minor has been raised on a Managed
Object.
alertMajorNotification This notification states that an alert of severity major has been raised on a Managed
Object.
alertCriticalNotification This notification states that an alert of severity critical has been raised on a
Managed Object.
The following table lists the variable binding values and their descriptions that are used in the alert notification traps.
Variable Binding Number
Description
SysUpTime: This is the amount of time the SNMP Agent application has been
running.
Notification type: This is the notification type (i.e., clear, warning, minor, major, or
critical).
sequenceNum: Specifies the sequence number of the trap. This number starts
from 0 every time the SNMP Agent application is started.
alertEntity: This is a concatenation of the alarming device (Managed Object)

followed by a colon (:), which is then followed by the name of the actual alarming
parameter.
Example: Managed Object Name:fnReturnLaserCurrent
A managed object in the HFC domain may be a battery object, a power supply
object, or a transponder object.
alertOwnerName: Currently a value of Null (unused).
alertDescription: This defines the details of the alert message.
alertTimeStamp: Contains the time stamp of the time that this alert was modified.
alertNotificationId: This is a sequential ID number for each alert. CheetahXD stores

this number.
alertCategory: Defines the category of the alert (i.e., power supply, fiber node, etc.).
10
alertExtraProperties: Contains the name value pair for the Gateway Parent and the
TopLevel Parent of the managed object name in binding 4 (alertEntity). Please refer
to Section 17.3.2.1 for details on the Gateway and Top Level Parent concepts.
Page 271
CheetahXD
Using
the SNMP
User Guide
Usingtothe
Third-Party
SNMP Agent
Applications
CheetahXD
Applications
User Guide
18.3.2.1 Gateway Parent and Top Level Parent Concept Explanation

In the CheetahXD system, any transponder that monitors a power supply or node is seen as a transponder with
multiple subdevices in the native tree view. The following example will use a transponder with the name
HMSTransponder Device 1 to better illustrate the concepts of a Gateway Parent and a Top Level Parent. For the
purposes of this example, the HMS Transponder Device 1 transponder monitors a power supply.
In a collapsed tree view, the transponder would look similar to the following example.
Figure 18-1: Collapsed Tree View

In an expanded tree view, the transponder could look similar to the following example.
Figure 18-2: Expanded Tree View

A Gateway Device is always the addressable element (in this example the transponder). The Top Level Parent is
always the parent of the entity that is currently in the alarm state. In this example, we will use an alarm that was
generated when the Battery Voltage parameter on the HMS Battery Device exceeded its limit. For the alarm
described in this example, the binding 4 (alertEntity) entry would contain the following data:
HMS Battery Device:Battery Voltage
The binding 10 (alertExtraProperties) entry would contain the following data:
GatewayDeviceName=HMS Transponder Device 1, TopLevelDeviceName=HMS Power Supply Device
Page 272
CheetahXD
System
Administration
User Guide
19
System
CheetahXD
Administration
User Guide
System Administration
The Administration page offers access to the CheetahXD administrative and system setup functions. To access the
Administration page, click the Administration tab.
The Administration page displays, as shown in Figure 19-1.
Figure 19-1: Administration Page

The functions on the Administration tab page are arranged in six groups which are also accessible by the six links in
the tree on the left side of the Administration tab page.
Figure 19-2: Administration Page Menu
Page 273
CheetahXD
System
Administration
User Guide
System
CheetahXD
Administration
User Guide
The following table describes the functions of each of the icons on the Administration tab page.
Icon
Description
Battery Test
Opens the Battery Analysis Admin tool, which allows you to perform power supply tests.
For information on using this tool, see the chapter titled Testing Power Supplies.
Page Alert
Opens the Page Alert page, where you can set up technician paging parameters. For
information on using this tool, see the chapter titled Paging.
Firmware Download
Opens the Firmware Download page where you can specify firmware to download to
transponders. For information on using this tool, see the chapter titled Downloading
Firmware.
Send Event
Opens the Send Event Utility where you can test that devices are properly sending events
to the CheetahXD server, which in turn is properly sending them on to the desired
destinations (e.g., the Notifier, the paging system, etc.).
Bulk Task Status
Displays the items in the active, waiting, and completed bulk task queues. The items
displayed here have either had their Download All or Download Changes options selected.
For more information on using this tool, see the chapter titled Provisioning Devices.
Template Administration
This icon opens the Template Administration page where you can administer templates
and user-defined Alert Profiles. For more information on using this tool, see the chapter
titled Provisioning Devices.
Discovery Configurator
This icon opens the Discovery Configurator page where you can view and modify the autodiscovery configuration settings. For more information on using this tool, please refer to
the System Setup chapter in this manual. Cheetah recommends using this interface any
time you make Auto-discovery parameter changes.
Discovery Queue
This icon displays devices in various stages of auto-discovery and allows you to clear the
queue or just clear the devices still waiting to be auto-discovered. For more information
on discovery, see the chapter titled System Setup.
DB Backup
This icon displays the Database Backup page, which is where the operator specifies
database backup parameters and can perform a manual backup. This page does not
include any database restoration capabilities. To restore a CheetahXD database, Cheetah
recommends following the restoration procedure that is appropriate for your system. The
restoration procedures are presented later in this chapter.
Shutdown Server
This icon opens the Shutdown CheetahXD Server page, which allows you to confirm that
you do want to shut down the server. Alternatively, you can shut down the server by
clicking
Start All Programs CheetahXD Shutdown Server.
Page 274
CheetahXD
System
Administration
User Guide
System
CheetahXD
Administration
User Guide
Icon
Description
System Details
This icon opens the System Details page which shows some summary data of various
aspects of the system including Fault Status, Port Details, Discovery Module Details,
Network Discovery Status and Policy Details. This page is purely informational and no
action can be taken from this screen.
System Performance (CheetahXD Server)
This icon opens the System Performance Dashboard (Server Details) page which shows
the status of specific server resource to be used for system diagnostics. Users can
monitor the servers CPU usage, thread count, memory utilization, and event/alert
processing rates.
Server Logs
This icon opens the read-only Index of/logs page, where you can see the following
information about log entries.
Logs Configurator
This icon opens the Log Configuration page where you can specify how events are logged
and retained. CheetahXDs logging capabilities include many text files for logging events
in its various modules.
Logs Monitor
This icon opens the Log Viewer page, where you can view a snapshot of a log file in real
time. The Log Viewer also provides tools for searching through the file and for searching
for specific data within the file. The Spy Log Viewer page is not supported at this time.
User Configuration
This icon opens the portion of the software used to create and maintain user information.
For details on creating and maintaining user information please refer to the System Setup
chapter in this manual.
Group Configuration
This icon opens the portion of the software used to create and maintain group
information. For details on creating and maintaining groups please refer to the System
Setup chapter in this manual.
Alert Filters
This icon opens the Alert Filters page. For details on this page and how to set up Alert
Filters, see Section 5.10, Alert Filters.
Page 269
CheetahXD
System
Administration
User Guide
19.1
System
CheetahXD
Administration
User Guide
Using the Bulk Task Status Page
The Bulk Task Status page displays the items in the active, waiting, and completed bulk task queues. The items
displayed here have either had their Download All or Download Changes options selected. For more information on
using this tool, see the chapter titled Provisioning Devices.
Click the Bulk Task Status icon to open the Bulk Task Status page, as shown in Figure 19-3.
Figure 19-3: Bulk Task Status Page
Id Indicates the ID of the task.

User Indicates the name of the user that initiated the task.
Device Count Indicates the number of devices that the task is acting upon.
Task Type Indicates the type of task being executed.
Task State Indicates the current state of the task.
Time Started Displays the time that the task started.
Time Submitted Displays the time that the task was submitted. This applies only to tasks in the waiting queue.
Priority Displays the priority of the task. Priorities can be adjusted by the operator. This applies only to tasks in
the waiting queue.
% Complete Displays the percentage of the task that is complete. This applies only to tasks in the active
queue.
Estimated Completion Time Displays the estimated completion time for the task. This applies only to tasks in
the active queue.
Time Completed Displays the completion time for the task. This applies only to tasks in the completed queue.
Actions Displays the type of actions associated with a particular task that are available.
The Active Bulk Tasks queue displays the tasks that are currently active. The maximum number of tasks this queue
will hold is 5.
The Waiting Bulk Tasks queue displays the tasks that are in the queue, but are not yet running. When a task is
completed, the system removes it from the Active Bulk Tasks queue and places it into the Completed Bulk Tasks
queue. Then, the task with the highest priority in the Waiting Bulk Tasks queue is moved into the Active Bulk Tasks
queue. When two or more tasks in the Waiting Bulk Tasks queue have the same priority level, the system will give a
higher priority to the task with the earliest task submission time, which is displayed in the Time Submitted parameter
Page 270
CheetahXD
System
Administration
User Guide
System
CheetahXD
Administration
User Guide
tasks can be prioritized by the operator. The task with the lowest low priority number is the highest priority task. In
other words, a priority number of 1 is a higher priority than a priority number of 5.
Page 271
CheetahXD
System
Administration
User Guide
System
CheetahXD
Administration
User Guide
The tasks in the Completed Bulk Tasks queue display the finished status of the task in the Task State parameter.
Each task can be removed or restarted individually, or you can remove all of the tasks at once by pressing the Clear
Completed Tasks button. The maximum number of tasks this queue will hold is 25.
You can view the details of a task by clicking on the button next to the task ID number. The type of details associated
with a typical download task can be seen in Figure 19-4.
Figure 19-4: Completed Bulk Tasks
19.2
1.
See Devices in the Discovery Queue
In the CheetahXD Administration section of the Administration tab page, click Discovery Queue.
The Queue opens.
Figure 19-5: Discovery Queue

2.
To clear the queue, click Clear Queue. To clear just the devices still waiting to be auto-discovered, click Clear
Wait List.
Page 272
CheetahXD
User Guide
19.3
System
CheetahXD
Administration
User Guide
Using the Database Backup Page
The Database Backup page, as shown in Figure 19-6, is where the operator specifies database backup parameters
and can perform a manual backup. This page does not include any database restoration capabilities. To restore a
CheetahXD database, Cheetah recommends following the restoration procedure that is appropriate for your system.
Figure 19-6: Database Backup Page

The Database Backup page controls, parameters, data fields, and their descriptions are listed below.
Refresh Field Displays the amount of time in seconds before the screen is refreshed by the system.
Manual Refresh Use this button to refresh the screen manually.
Daily Backup Enabled When enabled, the system will perform a system backup every day at the
predetermined start time.
Database Backup Execution Hour This value establishes the time at which the daily system backup will begin.
Number of Backups to Archive This attribute specifies the maximum number of backup files to save. After
reaching the limit, the system automatically replaces (overwrites) the oldest file with the latest file.
Save Use this button to save the changes made to the database backup parameters.
Backup Status This portion of the page displays information pertinent to the database backup.
Execute Backup Now Use this button to execute a manual database backup.
These backup procedures back up only the application data necessary to restore the database. Backup procedures
can be scheduled through custom or OS scheduling mechanism. Ensure there is enough disk space in the location or
drive or partition before scheduling a regular backup. Also, ensure there is a cleanup process, such as deleting
backup files older than 6 months.
NOTE:
As best practices indicate, Cheetah recommends that you copy your backup files to another directory or drive
away from where CheetahXD is installed. This will give provide a better opportunity to restore in case of
catastrophic failures to your server.
Page 273
CheetahXD
User Guide
19.3.1
System
CheetahXD
Administration
User Guide
Restoring a Database
To restore the database in Windows:

1.
2.
3.
4.
Shutdown CheetahXD.
On the server where the database is installed, open a DOS window.
Change to the directory CHEETAHXD_HOME\conf\ccms_database\Windows
Type the following command:
cheetahxd_dbimport Auto_CheetahXD_11_22_2010 00_05_05
where Auto_CheetahXD_11_22_2010 00_05_05 is the name of the backup file without the .tar.bz2
extension. The file is located in CHEETAHXD_HOME\Backup.
An import log file is placed in the CHEETAHXD_HOME\backup directory with the file name format:
Auto_CheetahXD_11_22_2010 00_05_05_Imported_11232010.log.
This format implies that a backup file dump from November 22nd, 2010 12:05:05 PM is restored on November
23, 2010.
As the database is being restored, you will see messages output to the screen as it progresses. A message will
be displayed indicating the restore process has completed. Should the database not restore properly, contact
Cheetahs Support Center and provide the latest backup file information.
Restore the Database in Solaris:
IMPORTANT:
To run the Restore program, CheetahXD should be shut down.
Use the following steps to run the database restore utility for CheetahXD on a UNIX system:
5.
6.
Navigate to:
cd CHEETAHXD_HOME/conf/ccms_database/Unix
Run the following command:
./cheetahxd_dbimport.sh Auto_CheetahXD_11_22_2010 00_05_05
This is the name of the backup archive without the .tar.bz2 extension.
An import log file will be placed in the CHEETAHXD_HOME/backup directory with the following file name format:
Auto_CheetahXD_11_22_2010 00_05_05_Imported_11232010.log
This format implies that a backup file dump from November 22nd, 2010 12:05:05 PM is restored on
November 23, 2010.
As the database is being restored, you will see messages output to the screen as it progresses. A message will be
displayed indicating the restore process has completed. Should the database not restore properly, contact Cheetahs
Support Center and provide the latest backup file information.
19.4
Using the System Performance Page
The System Performance page, as shown in Figure 19-7, shows the status of specific server resource to be used for
system diagnostics. Users can monitor the servers CPU usage, thread count, memory utilization, and event/alert
processing rates.
NOTE: If using Solaris as the CheetahXD server and the System Performance graphs do not appear, verify the
Page 273
CheetahXD
User Guide
System
CheetahXD
Administration
User Guide
./startCheetahXD.sh startup script is set to start in Headless mode. Contact Cheetah Support at 1-866-944-1482 or at
cheetahsupport@cheetahtech.com for more information.
Page 274
CheetahXD
User Guide
System
CheetahXD
Administration
User Guide
Figure 19-7: System Performance Page

19.4.1
Server Details Tab
Measurements are taken every 30 seconds and do not interfere with the performance of the system. The
measurements are stored in the database and can be displayed in 1, 7, and 30-day views.
Select the Export JVM Details link to export and save key details of the servers performance, as shown in
Figure 19-8.
Figure 19-8: Export JVM Details

The information here provides another tool for viewing server performance and troubleshooting purposes.
Page 275
CheetahXD
System
Administration
User Guide
System
CheetahXD
Administration
User Guide
To Setup Performance Monitoring:

All of the graphs on the System Performance Dashboard, with the exception of the CPU Utilization, are controlled by a
parameter setting in the startCheetahXD.sh/bin file. The parameter is -Dcom.sun.management.snmp.port=16500.
The CPU Utilization graph uses port 161. If the VHec is not in use then there is no other setup consideration. If the
VHec is setup on your CheetahXD server then the following consideration must be met in order to monitor the CPU
utilization.
Edit the services file and change the standard SNMP port from 161 to 16161 (or some other unassigned port)
o Windows
The Services file is located at C:\WINDOWS\system32\drivers\etc. Edit the file as shown:
snmp
16161/udp
#SNMP
Solaris
Services file is located at /etc/services. Edit the snmpd entry as shown
snmpd
16161/udp
snmp
# SMA snmp daemo
19.4.2
Requires SNMP Service to be running and started on port 16161
The SNMPD process must also be running.
Client Details Tab
The Client Details Tab displays information about the machine on which this function is being executed, and the
CheetahXD server with which it is communicating. It is from this page that other users session can be terminated.
Figure 19-9: Client Details Tab

To Terminate a Client:
The Terminate Client feature is Security controlled so only specified users are allowed to terminate others sessions.
A user cannot terminate his own session.
To terminate a users session the user can click on the x in the right-hand column (if the Terminate Client option is
assigned under the Operations Tree) as shown in Figure 19-10.
Figure 19-10: Terminating a User Session
Page 276
CheetahXD
System
Administration
User Guide
19.5
System
CheetahXD
Administration
User Guide
Using the Log Entries Page
The Log Entries page lists logs for the CheetahXD system, as shown in Figure 19-11.
Figure 19-11: Log Entries Page

Clicking on a log entry in the Name column displays a new browser window containing details about the log entry,
similar to Figure 19-12.
Figure 19-12: Log Entry Details
Page 277
CheetahXD
System
Administration
User Guide
19.6
System
CheetahXD
Administration
User Guide
Using the Log Configuration Page
The Log Configuration page, as shown in Figure 19-13, is used to specify how events are logged and retained.
Cheetah XDs capabilities include many text files for logging events within the various modules.
Figure 19-13: Log Configuration Page

Each file can be configured to specify:
The level of detail included in log entries.

The maximum number of lines allowed in the file (after which the oldest entry is deleted to make room for the
newest entry) refer to section 19.6.2 below
The number of generations of the file that can exist refer to section 19.6.2 below
The maximum number of lines cached refer to section 19.6.2 below
The Spy Configuration page is not supported at this time.
19.6.1
Open the Logging Configuration Page
1.
In the Server Details panel in the Administration page, click the Logs Configurator icon.
The Log Configuration page displays. The Spy Configuration page is not supported at this time.
2. Scroll the list to find the desired logging file and make the changes.
3. After making changes, scroll to the bottom of the list and click Submit to make the specified changes to the log
files.
19.6.2
Click Cancel to return to the System Administration page without making the specified changes
Click Reset to return all the log files to the default parameters.
Editing the Log Settings
The Max Lines/File, File Count and Max Lines Cached log parameters can be edited through the associated
XML file as follows:
Page 278
CheetahXD
System
Administration
User Guide
1.
System
CheetahXD
Administration
User Guide
Navigate to the Conf directory.
Page 279
CheetahXD
System
Administration
User Guide
2.
System
CheetahXD
Administration
User Guide
Edit the log4j.xml file.

Following is a sample log file entry:
<appender class="com.adventnet.management.log.NMSRollingFileAppender"
name="ctautodiscoverylog_file">
<param name="File" value="logs/CTAutodiscoveryLog.txt"/>
<param name="MaxFileSize" value="15MB"/>
<param name="MaxBackupIndex" value="10"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="[%d{dd MMM yyyy
HH:mm:ss:SSS}] %-5c{2}: %m%n"/>
</layout>
</appender>
19.7
Using the Logs Monitor Page
The Logs Monitor page, as shown in Figure 19-14, is used to view a snapshot of a log file in real-time. The Log Viewer
tab also provides tools for searching through the file and for searching for specific data within the file. The Spy Log
Viewer tab is not supported at this time.
Figure 19-14: Logs Monitor Page

View the logs in real-time:
1.
2.
3.
4.
In the Server Details panel in the Administration page, click the Logs Monitor icon.
Select the number of lines (at the end of the file) you wish to review from the Show Last drop-down menu.
Select the name of the file you wish to review from the lines of drop-down list.
Click on the View Logs button to view the lines of data within the file.
5. If desired, search on specific data by invoking the search feature by pressing on the magnifying glass icon
at
the upper right corner of the window.
6. If desired, you can open the viewer in a new window by pressing the maximize icon
at the upper right corner
of the window.
Page 280
19.8
SystemTroubleshooting
Administration
Setting the Automatic LogOut Time Duration
To modify the length of time that a Client User can be logged into a session prior to being logged off, edit the file
listed below, modify the numerical value in the highlighted line, whereas the numerical value will be an actual value
in minutes to define the new desired logout duration.
CheetahXD/WEB-INF/web.xml

<welcome-file-list>
<welcome-file>/webclient/common/html/Login.html</welcome-file>
</welcome-file-list>
<session-config>
<session-timeout>30</session-timeout>
</session-config
Page 281
20
Troubleshooting
Troubleshooting
This chapter offers tips for troubleshooting issues that may arise when installing or running CheetahXD. If you
experience issues not covered in this section, contact Cheetah Support at:
1 - 866 - 944 - 1482
cheetahsupport@cheetahtech.com
20.1
CheetahXD Startup Issues
The following sections help troubleshoot CheetahXD startup issues.
20.1.1
CheetahXD Startup Fails After Server Reboot
After a system reboot of the Windows 2003 server, restarting CheetahXD fails during restart.
In some Windows 2003 Server configurations, Oracle 10g database services do not completely start up after a
system reboot resulting in a failure during CheetahXD start up. The console window will display errors similar to the
following graphic.
Figure 20-1: Oracle Database Errors

This is an Oracle issue and Cheetah recommends two approaches to resolving it.
Edit the listener.ora file (which may resolve the problem on some system configurations).
Start the Oracle 12cR1 database service manually after server reboot, if editing the listener.ora file does not
resolve the problem.
Page 280

Troubleshooting
CheetahXD
Troubleshooting
User Guide
20.1.1.1 Edit the listener.ora File

To edit the listener.ora file:
1.
2.
Open the file oracle\oracxd\NETWORK\ADMIN\listener.ora in any text editor, such as Notepad.

Edit the file according to the before and after examples, below. The lines to add and change are bolded in the
File after edit as shown below.
File before edit

# listener.ora Network Configuration File:
D:\oracle\oracxd\network\admin\listener.ora
# Generated by Oracle configuration tools. SID_LIST_LISTENER =
(SID_LIST = (SID_DESC =
(SID_NAME = PLSExtProc)
(ORACLE_HOME = D:\oracle\oracxd)
(PROGRAM = extproc)
)
)
.
.
.
File after edit
# listener.ora Network Configuration File:
D:\oracle\oracxd\network\admin\listener.ora
# Generated by Oracle configuration tools. SID_LIST_LISTENER =
(SID_LIST = (SID_DESC =
(GLOBAL_DBNAME = webnmsdb) (ORACLE_HOME = D:\oracle\oracxd) (SID_NAME
= webnmsdb)
)
(SID_DESC =
(SID_NAME = PLSExtProc) (ORACLE_HOME = D:\oracle\oracxd) (PROGRAM = extproc)
)
)
Page 281

Troubleshooting
CheetahXD
Troubleshooting
User Guide
20.1.1.2 Starting the Oracle 12cR1 Database Service Manually

If editing the listener.ora file does not resolve the problem, the Oracle 12cR1 database service must be restarted
manually after every server reboot.
Manually Restart the Oracle 12cR1 Database Service
1.
2.
3.
From the Start menu, select Start > Run.

In the Run window, type cmd.
Click OK.
The DOS command window displays.
Figure 20-2: DOS Command Window

4. In the DOS command window, type net stop OracleServiceWEBNMSDB.
5. Press the <Enter> key. The following message displays:
The OracleServiceWEBNMSDB service was stopped successfully
6. Type net start OracleServiceWEBNMSDB.
7. Press the <Enter> key. The following message displays:
The OracleServiceWEBNMSDB service was started successfully
Figure 20-3 shows the user input and the stopped and started messages.
Page 282

Troubleshooting
CheetahXD
Troubleshooting
User Guide
Figure 20-3: Stopped and Started Messages
Page 283

Troubleshooting
CheetahXD
Troubleshooting
User Guide
8. Restart the CheetahXD server application. Figure 20-4 shows a successful CheetahXD server restart.
Figure 20-4: Successful CheetahXD Restart
20.2
Java Conflicts
CheetahXD and CheetahNet use versions of Java that may not be installed or may not be compatible with versions of
Java used, called, or pointed to by other software applications on the same machine. The following sections address
Java issues that can occur.
20.2.1
Some CheetahXD Functions Not Accessible
Some CheetahXD functions (such as the Tree Viewer, some security functions, and other data or logic-heavy
functions), require Java Web Start. Attempts to access one of these functions, either from the CheetahXD server
browser or from a client browser, produce the following error:
Figure 20-5: Java Web Start Error
Page 284

Troubleshooting
CheetahXD
Troubleshooting
User Guide
Click one of the links on this page to download Java Web Start. Install Java Web Start and restart the machine.
Access to all CheetahXD functions from the browser is now enabled, although a password is still required to execute
certain administrative functions.
20.2.2
CheetahXD and CheetahNet Server Java Conflicts
Java conflicts occur when CheetahXD and CheetahNet Server exist on the same machine.
Resolve CheeetahXD/CheetahNet Server Java Conflict:
1.
2.
3.
Upgrade CheetahNet to version 3.2

Edit the CheetahNet jsl.ini file according to the instructions in Cheetahs Product Bulletin # 050-0080, issued
February 2005.
Click Start > Programs > Java Web Start.
This opens the Java Web Start Application Manager, as shown in Figure 20-6.
Figure 20-6: Java Web Start Application Manager

4.
In the Java Web Start Application Manager, click File > Preferences.
This opens the Java Web Start Preferences window, as shown in Figure 20-7.
Page 285

Troubleshooting
CheetahXD
Troubleshooting
User Guide
Figure 20-7: Java Web Start Preferences Window
Page 286

Troubleshooting
5.
6.
7.
CheetahXD
Troubleshooting
User Guide
In the Java Web Start Preferences window, click the Java tab.
Click the checkbox in the Enabled column on the line for Java version 1.3 to uncheck it.
Click OK and close the remaining Java windows.
20.2.3
CheetahXD and CheetahNet Client Java Conflicts
Java conflicts occur when CheetahXD and CheetahNet Client exist on the same machine.
Resolve CheetahXD/CheetahNet Client Java Conflict
1. Upgrade CheetahNet to version 3.2
2. Edit the CheetahNet cssysman.ini file according to the instructions in Cheetahs Product Bulletin # 050-0080,
issued February 2005.
3. Click Start > Programs > Java Web Start.
4. In the Java Web Start Application Manager, click File > Preferences.
5. In the Java Web Start Preferences window, click the Java tab.
6. Click the checkbox in the Enabled column on the line for Java version 1.3 to uncheck it.
7. Click OK and close the remaining Java windows.
20.3
Errors Running Reports
When running CheetahXD on a headless Solaris server, (a server that does not include graphics capability),
graphics drivers for report generation are not loaded during installation. When attempting to run a report, an error
may result. To remedy this problem, see Section 3.1, Restarting CheetahXD on a Solaris Server.
20.4
Access Errors
This section contains solutions for errors encountered when accessing CheetahXD or any of its applications.
Error
Power Outage Monitoring
application fails to start
20.5
Solution
Ensure that CheetahXD has an active Battery Administration license. Ensure that
the Battery Administration service is running. If it is not, restart CheetahXD.
Database Backup Failures
If the Automated or Manual Backups fail to properly backup the database information navigate to the
CheetahXD/logs directory. Each backup attempt is logged to the most recent CTBackup.txt log file. Within the
CTBackup.txt file, a second file will be identified which will show the root cause error.
File Error
Solution
Error running Oracle export
The backup cannot locate the database connection string. Verify the connection
string in CheetahXD\con\database_params.conf is set properly
Error tarring backup set
Hard drive is out of space. Free up space on the drive where backups are stored.
Page 287

Troubleshooting
20.6
CheetahXD
Troubleshooting
User Guide
Java Security Warning Dialog Box Appears
CheetahXD uses Java applets. Although the Java JAR files are signed with trusted certificates, it may be necessary to
modify Java settings to prevent security dialog boxes from appearing when accessing these applets.
20.6.1
Individual Client Machine Settings
Perform the following on each CheetahXD client machine before logging into CheetahXD:
1.
2.
3.
4.
5.
20.6.2
Open Control Panel > Programs > Java and select the General tab.
Click the Settings button under the Temporary Internet Files heading.
Click the Delete Files button.
Select the Cached Applications and Applets and the Installed Applications and Applets checkboxes.
Click OK to exit each of the windows.
Additional Settings
If the security warnings still appear, you might need to additionally change the following Java settings:
20.6.2.1 Change the Mixed Code Setting

1.
Open the Java Control Panel.

Control Panel > Programs > Java
1. On the Advanced tab, find the Mix Code settings and select the Enable hide warning and run with
protections option.
2. Click OK.
20.6.2.2 Add CheetahXD server to the Security Exception List.

1.
2.
3.
4.
5.
6.
Open the Java Control Panel.

Control Panel > Programs > Java
On the Security tab, click the Edit Site List button.
On the Exception Site List window, click the Add button.
In the text input field enter http://xdservername:9090 (where xdservername is the name of the CheetahXD
server) then click Add.
Click Continue.
Click OK twice to exit the windows.
Page 288
CheetahXD User
CheetahXD
Utilities
Guide
21
CheetahXD
CheetahXD
User
Utilities
Guide
CheetahXD Utilities
CheetahXD includes command line utilities that allow users to access and control certain aspects of CheetahXD via a
remote or local command line interface, instead of through the graphical front end of the CheetahXD system.
These utilities include:
Remote Export
Console Data Display
Firmware Download
Send Event
Applying VoIP Licenses to transponders in bulk
The utilities can be run locally, at the CheetahXD server, or remotely, at machines that can access the CheetahXD
server. When running these utilities remotely, Java Runtime Environment version 1.4.2 (or greater) must be running
on the remote machine. In cases where multiple versions of Java are running, ensure that version 1.4.2 (or greater)
is the version used.
21.1
Remote Export Utility
The Remote Export utility can export scheduled measurement data from the CheetahXD database that can be
displayed on the screen or written to a file for use with other applications.
The scheduled measurement data the Remote Export utility exports must have already been collected during a
CheetahXD scheduled measurement collection. For more information on creating and running scheduled data
measurements, see the chapter titled Scheduling Data Collection.
21.1.1
Command Arguments
When running the utility, required arguments include:
hostName The host name or IP address of the CheetahXD server where schedules were created
scheduleName The name of the previously-created schedule containing device and data to export.
deviceName The name of the device from the schedule with data to export.
attributes One or more device attributes that were selected during schedule creation.
If any of the required arguments are missing, the utility displays the argument needed, as in the following example
where the required scheduleName argument is missing.
Figure 21-1: Displaying the Missing Argument

Optional arguments include:
startDate, endDate The starting and ending date/time range that data was collected.
Can be specified as UTC timestamp: 1136091600000 (i.e., Sun Jan 01 00:00:00 EST 2006) or in the
format: yyyy-MM-dd,HH:mm:ss (i.e., 2006-01-01,0:0:0)
If no date range argument is specified, the utility defaults the start date/time to 0 and end date/time to the
current date/time.
Page 289
CheetahXD User
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
outputFilename Full path and filename where export data will reside.
If this argument is not specified, the utility displays the data on the console.
21.1.2
Running the Remote Export Utility
Run the remote export utility either locally (from the CheetahXD server) or remotely (from a machine that can access
the CheetahXD server).
Run the Remote Export Utility from the CheetahXD Server:
1. Open a command window.
2. Change to the classes subdirectory of Cheetahxd.
3. From the Windows or Solaris command prompt, type the following command (Windows or Solaris) to run the
utility:
java jar remoteExport.jar [arguments]
Run the Remote Export Utility from a Remote Machine:

1. Ensure that Java Runtime Environment version 1.4.2 (or greater) is installed and is in the current path of the
machine you will be using to run this utility.
2. Copy or FTP the file remoteExport.jar from the classes subdirectory of the CheetahXD server to the remote
machine.
3. Open a command window in the directory where the file remoteExport.jar has been copied or FTPd.
4. From the command prompt, type the following command (Windows or Solaris) to run the utility:
java jar remoteExport.jar [arguments]
21.1.3
Remote Export Utility Help
The utility includes a help screen that displays if no arguments are specified or if you specify h or -? as the only
argument. The help screen shows the required and optional arguments as in Figure 21-2.
Figure 21-2: Remote Export Utility Help Screen

Page 290
CheetahXD User
CheetahXD
Utilities
Guide
21.1.4
CheetahXD
CheetahXD
User
Utilities
Guide
Examples
The utility also includes examples of commands and arguments that display when you type the command to run the
utility (as in one of the procedures above), followed by the argument examples.
Figure 21-3: Examples of Commands and Arguments

The utility includes built-in argument helpers that can help the user to determine the selection of data to export. To
display these helpers, type the desired argument followed by the value list<argument>. Argument helpers include:
-scheduleName listschedules
-deviceName listdevices
-attributes listattributes
For example, to see the available schedules on CheetahXD server name romulus, type the command to run the
utility (as in one of the procedures above), followed by the argument scheduleName and the value
listschedules.
java jar remoteExport.jar hostname romulus scheduleName listschedules
Page 291
CheetahXD User
CheetahXD
Utilities
Guide
21.2
CheetahXD
CheetahXD
User
Utilities
Guide
Console Data Display
The Console Data Display utility displays data from managed devices and from the database in text snapshots, in
both DOS and Solaris command-line windows. Data can also be displayed through a devices local context menu in a
tree view. For more information on displaying data, see the chapter titled Displaying Data.
The Console Data Display displays all attributes specified in the devices configuration. If battery testing is occurring
when the Console Data Display collects the device information, the battery testing indicator is not included.
Launch Console Data Display
1. Ensure that Java Runtime Environment version 1.4.2 (or greater) is installed on the machine you will be using to
run Data Display.
When CheetahXD is installed, the file ddConsole.jar is placed in the Classes directory on the server where
CheetahXD is installed. To run data display on another machine accessing the CheetahXD server, ensure that
ddConsole.jar is copied or FTPd to that machine.
2. From a command line window (DOS or Solaris), type the following command:
java jar ddConsole.jar <deviceName> <hostname>
where <deviceName> is the managed object name of the device for which you are displaying data, and
<hostname> is the name of the server where CheetahXD is installed.
Sample output from the Console Data Display can be seen in Figure 21-4.
Figure 21-4: Sample Output from the Console Data Display
Page 292
CheetahXD User
CheetahXD
Utilities
Guide
21.3
CheetahXD
CheetahXD
User
Utilities
Guide
Firmware Download
Firmware Download Utility information is available in the following document: HMS Transponder Firmware Download
Utility (DOC# 050-0090).
21.4
Send Event
The Send Event utility is a way to:
Populate the Custom Extensions menu (see Section 10.10: Local Context Menu)
Test the Notifier (see Section 10.9: Testing the Notifier)
The Send Event utility can also be accessed in the Administration tab page of CheetahXD.
Send an Event
1. In the CheetahXD Administration section of the Administration tab page, click Send Event. The Send Event Utility
opens.
Figure 21-5: Send Event Utility Page

2.
Create the type of event you want to send through the CheetahXD system by specifying the following:
Severity Click the drop-down menu and select the desired severity.
Source Type the IP address of the device from which the event will be sent.
Attribute Select the devices managed attribute generating this test event.
Application Category Currently, only events from HFC devices are supported.
Device Category Specify the type of device (power supply, fiber node, etc).
Message Text Type a text message regarding the event.
Group Name This text field is currently not used by CheetahXD.
Page 293
CheetahXD User
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
Top-Level Parent Type the IP address of the devices top-level parent device, which reports to the
transponder (example, for the temperature attribute of a battery, the top-level parent is the power supply).
Gateway Parent Type the IP address of the transponder monitoring the device.
Alarming Attachment Type the display name of the attribute triggering the alarm.
Page 294
CheetahXD User
CheetahXD
Utilities
Guide
21.5
CheetahXD
CheetahXD
User
Utilities
Guide
Entity Type the unique alarm ID (default convention is managed object name:attribute name).
Repetitions Type the number of times you want to send this event.
Interval Type the number of milliseconds to wait between each send operation.
Alternate Severity If yes, the Send Event operation will send both an alarm event and a clear event.
Increment Resource Name If yes, when sending multiple repetitions, CheetahXD will display a serialized
entry for each unique send in the form of: managed object name_n where n is 1 for the first event
send, 2 for the second event send, and so on.
Importing HFC Manager Events into CheetahXD
Starting in CheetahXD 3.1, a tool was added to import alarms/events from a Motorola HFC Manager system.
Depending on date and time, the HFC Manager events will either be imported directly into the CheetahXD database
or exported out to comma separated values (CSV) files. If the events are exported to CSV files, they can always be
viewed from within CheetahXD Notifier by applying a time filter for the time span desired and you would then be
prompted to import from those CSV files. For more on creating filters in Notifier see the section entitled, Specifying
Filters for Views.
Prior to importing the HFC Manager Events into CheetahXD, the mySQL database on the HFC Manager server must
be configured to allow remote access from the CheetahXD server. Log into the Windows HFC Manager Server, and
open a terminal (cmd) window. Set the default directory to the location that contains the mySQL executables and
enter the mySQL database as the root user.
C:> cd c:\HFCMgr\mysql\bin>mysql u root
Then enter the following commands:
mysql>update mysql.db set Host=% where Db=webnmsdb;
mysql>update mysql.user set Host=% where user=root;
mysql>GRANT ALL ON WebNmsDb.* TO root@% IDENTIFIED BY ;
mysql>FLUSH PRIVILEGES;
mysql>exit
21.5.1
Procedure for Windows
From the CheetahXD Server, open a Command Prompt window and navigate to the CheetahXD\bin directory (as
shown below) to enter the command:
migrateHfcMgrUtil
Figure 21-6: HFC Migration Utility

To display more detailed help with descriptions of available arguments, enter the command:
Page 295
CheetahXD User
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
migrateHfcMgrUtil -h
Page 296
CheetahXD User
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
Figure 21-7: HFC Migration Utility Detailed Help with Descriptions

To begin the HFC Mgr Migration using the HFC Mgr defaults (port, schema, user, password) enter the following
command:
migrateHfcMgrUtil -host <host>
Where <host> is the host name or IP address of the HFC Mgr database.
Note: If not using HFC Mgr defaults, those values will need to be passed in as arguments.
migrateHfcMgrUtil -host <host> -port xxx -schema xxx -user xxx -password xxx
Where <host> is the host name or IP address of the HFC Mgr database and each xxx represents the non- default
value that needs to be passed in.
After the migration has started, it will first verify both the HFC Mgr and CheetahXD Databases are accessible.
It will then display status for the events that need to be migrated and how many of the events will be either imported
into CheetahXD or exported to CSV files.
Once the preliminary tasks are complete the actual migration will begin. Status indicators will display the progress of
the migration until complete.
Figure 21-8: HFC Mgr Migration Complete
Page 297
CheetahXD User
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
All events that have been exported to CSV files will be found in c:\CheetahXD\backup\events.
Page 298
CheetahXD User
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
A separate file will be created with all of the events for each day.
Events within CSV files can be viewed with a standard text editor or spreadsheet application that can recognize
comma separated values (CSV) files.
They can also be viewed within CheetahXD Notifier by applying a Date and Time filter in the Events View. For more
information on how to create filters in Notifier, please refer to the section entitled, Specifying Filters for Views.
Once an HFC Manager device is discovered in CheetahXD then those imported events associated with that device
will now be visible for it.
21.5.2
Procedure for Unix
From the CheetahXD Server, open a Terminal window and navigate to the CheetahXD/bin directory (as shown below)
to enter the command:
./migrateHfcMgrUtil.sh
Figure 21-9: HFC Migration Utility on UNIX

To display more detailed help with descriptions of available arguments, you can enter the command:
./migrateHfcMgrUtil.sh -h
To begin the HFC Mgr Migration using the HFC Mgr defaults (port, schema, user, password) enter the following
command:
./migrateHfcMgrUtil.sh -host <host>
Where <host> is the host name or IP address of the HFC Mgr database.
NOTE: If not using HFC Mgr defaults, those values will need to be passed in as arguments:
migrateHfcMgrUtil.sh -host <host> -port xxx -schema xxx -user xxx -password xxx
Where <host> is the host name or IP address of the HFC Mgr database and each xxx represents the non- default
value that needs to be passed in.
Page 299
CheetahXD User
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
After the migration has started, it will first verify both the HFC Mgr and CheetahXD Databases are accessible. It will
then display status for the events that need to be migrated and how many of the events will be either imported into
CheetahXD or exported to CSV files.
Once the preliminary tasks are complete the actual migration will begin. Status indicators will display the progress of
the migration until complete.
Figure 21-10: Migration Complete on UNIX

All events that have been exported to CSV files will be found in CheetahXD/backup/events.
A separate file will be created with all of the events for each day. Events within CSV files can be viewed with a
standard text editor or spreadsheet application that can recognize comma separated values (CSV) files.
They can also be viewed within CheetahXD Notifier by applying a Date and Time filter in the Events View. For more
information on how to create filters in Notifier, please refer to the section entitled, Specifying Filters for Views.
Once an HFC Manager device is discovered in CheetahXD then those imported events associated with that device
will now be visible for it.
Page 300
CheetahXDUser
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
The following table displays how the HFC Manager fields are mapped to CheetahXD fields.
HFC Manager Field
21.6
CheetahXD Field
Time
Created/Modified
Severity
Severity
Source
Source
failureObject
Attribute
Entity
Entity (Source + failureObject from HFC Mgr)
DeviceType
DeviceCategory
Text
Message
Node
Node
DeviceName
Userfield1
ModelNumber
Userfield2
SerialNumber
Userfield3
ChangedValue
Userfield4
TrapIdentifier
Userfield5
Card
Userfield6
Port
Userfield7
Multiple Device/AlarmDynamic Mapping and Route Calculation
CheetahXD allows operators to identify and graph alarm clusters from Tree Views and Notifier by selecting elements
which in turn visually depict alarming devices on a street map. This graphical functionality provides a view of the
offending devices allowing users to quickly ascertain if a system problem is concentrated in a specific node or is
more widespread. With the alarming devices depicted on a map, this new mapping functionality will calculate, for the
Field Engineer, optimized street routes from a default Headend starting point through multiple device locations. This
feature provides the most benefit for customers who have accurate depictions of their network topology within
custom Tree Views. With a proper topology, all devices located under a single Region or Hub can be populated on a
map from a single object in the tree.
The Google Maps API has been integrated for this feature. Google Maps requires the operator to purchase a RightTo-Use License from Google Inc.
To Activate/Update Mapping Software:
1. Navigate to CHEETAHXD_HOME\html\.
2. Open the EnglishToNatve.properties file in a text editor
3. Search for the following string - Mapping messages and defaults. It is located near the bottom of the
file.
4. Uncomment the line item to activate the target mapping application.
Page 301
CheetahXDUser
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
Page 302
CheetahXDUser
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
# Mapping messages and defaults

#
geomap_provider=Google
5. The EnglishToNative.properties file also allows for a default location to be set. To change the default location
edit the following line:
#default headend lat/lng is Pittsburgh
geomap_headendLatLng=(40.44,-80.0)
geomap_defaultZoom=11
geomap_selectRoutePoints=Select Route Points:
geomap_ctrlClick=(Ctrl-Click for multiple selection)
geomap_quickestRoute=Quickest Route
geomap_clearRoute=Clear Route
Use the Alert Mapping Feature:

Each device must have a valid address populated in the Location field found on the Property Tab. The format of the
information required should be the following:
Requires either a valid street address or Lati- tude/Longitude values

Format
381 Mansfield Ave, Pittsburgh PA 15220
Or
(40.421224, -80.052655)
If a Lat/Lng encoding does not exist for a given device, the MapAp will automatically use the Geocoding Service to
generate a Lat/Lng encoding from a valid street address and append it to the end of the Location field.
If an address is incorrectly entered or is unrecognizable, the display on the map will default to the headend location
defined in geomap_headendLatLng= Default Location.
To map devices or alarms, select one or more devices from the Tree View, Network Inventory or Template Admin,
Notifier, or POM and then select Map Location (Map Alert in Notifier/POM) from the right-click pull down menu.
Within Tree Viewer, Network Inventory or Template Admin a Region, Headend, Hub or Group object can be selected
to perform a Map Branch from the pull down menu. This will map all devices within the targeted branch.
Page 303
CheetahXDUser
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
Figure 21-11: Map Alert from Notifier Menu Option

When the map is launched it will display each of the selected devices in their geographic locations, represented by
an alarm icon colored with the highest alarm severity currently associated with the device. Hovering the mouse over
the icon will bring up a popup box that contains the display name and IP address of the device. Clicking on the icon
will display a popup box that contains the device type icon, display name, IP address, and street address.
Figure 21-12: Location Map

To the right of the map is a scrollable selection box that contains the display names of all the devices currently
mapped. If the user selects one or more of the devices and clicks on Quickest Route, the page will show the
quickest route from the default Headend Lat/Lng through all of the selected devices. Clear Route will clear the
route and display the original map.
Page 304
CheetahXDUser
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
Figure 21-13: Map with Routes
Page 305
CheetahXDUser
CheetahXD
Utilities
Guide
CheetahXD
CheetahXD
User
Utilities
Guide
Page 306
CheetahXD
QAM
Constellation
User Guide
Map
22
QAM
CheetahXD
Constellation
User Guide
Map
QAM Constellation Map
The QAM constellation map is useful in diagnosing line problems that might otherwise go undiagnosed. This chapter
outlines how to access CheetahXDs QAM application and provides useful information on how to interpret the
information presented in the QAM map.
22.1
The QAM Constellation Interface
The QAM Constellation Interface is a licensed application that consists of a panel of variables and settings on the left
portion of the screen and the constellation map itself. The interface is accessed via the tree menus. At the device
level, the QAM functionality is only supported by Cheetah products that are based on the eCMM technology.
NOTE: There is the possibility of encountering a known issue when viewing the Constellation page using Internet
Explorer where, after an undetermined amount of time the Constellation map will stop updating and a java
exception will be generated. It is strongly suggested to use another supported browser to not encounter this
problem.
Access the QAM Interface:
1. Select a device from a tree view by highlighting the device.
2. Right-click on the device and select QAM Constellation from the menu. The menu option will display only if the
application has been properly licensed for your CheetahXD system.
3. The QAM Constellation interface displays.
Figure 22-1: QAM Constellation Interface
Page 307
CheetahXD
QAM
Constellation
User Guide
Map
QAM
CheetahXD
Constellation
User Guide
Map
22.2
QAM Interface Variables and Parameters
22.2.1
Device Details
The device details supply the information necessary for identifying the device.
Name Device name.

IP Address IP address of the device performing the test.
MAC Address Media Access Control (MAC) address of the device performing the test.
22.2.2
Configuration Settings
The configuration settings are used to adjust certain aspects of the testing and data display.
QAM Collection Interval The interval at which the device will collect data. Select a value from the drop-down
list, from 1 to 10 seconds.
QAM Retention Count Number of samples the map will retain before refreshing the data in the map. The user
has the option of choosing 5, 10, 15, or 20 samples from the drop-down list.
CER Refresh Interval Enter the Codeword Error Rate (CER) refresh rate. This value (given in seconds) is used to
provide signal quality data (long-term and short-term CER data) that is supplementary to the actual QAM data on
the QAM Constellation page. Ideally, the CER refresh rate should be a whole multiple of the Constellation
Refresh Rate, but is not required. The user has the option of choosing values of 10 to 60 seconds in 10 second
intervals from the drop-down list.
Zoom Level Examine data more closely in the constellation map by clicking on individual quadrants in the map
to magnify the data. This variable determines the extent to which the user can magnify the data. A zoom level of
1 allows the user to concentrate on a single quadrant, while a level of 4 will present the chosen quadrant and
three surrounding quadrants. Please refer to the figures that follow.
Figure 22-2: Zoom Level of 1
Page 308
CheetahXD
QAM
Constellation
User Guide
Map
QAM
CheetahXD
Constellation
User Guide
Map
Figure 22-3: Zoom Level of 4
Suspend Collection Check this box to suspend sampling and uncheck to resume sampling.
22.2.3
Frequency Downstream frequency in MHz.

Power Downstream power in dBmV.
22.2.4
Downstream Signal Quality
RxMER Downstream signal quality. Modulation Error Ratio (SNR); hw/sw: ok 31-40; good 40 and higher. Also,
the background color of this field reflects the range of the value. When the range is within acceptable values the
field background is white; for marginal values the background is yellow; for an unacceptable value range the
background is red.
EVM Downstream signal quality. Error Vector Magnitude (from hardware MER / software MER).
22.2.6
Upstream Frequency and Power
Frequency Upstream frequency MHz.

Power Upstream power dBmV.
22.2.5
Downstream (256 QAM) Frequency and Power
Codeword Error Rate
Long Term Pre-FEC Downstream Signal Quality. Codeword error rate (CER) BEFORE forward error correction is
applied.
Long Term Post-FEC Downstream Signal Quality. Codeword error rate (CER) AFTER forward error correction is
applied. Should be < 9x10E-7. Also, the background color of this field reflects the range of the value. When the
range is within acceptable values the field background is white; for marginal values the background is yellow.
Short Term (Current) Pre-FEC Downstream Signal Quality. Codeword error rate (CER) BEFORE forward error
correction is applied.
Short Term (Current) Post-FEC Downstream Signal Quality. Codeword error rate (CER) AFTER forward error
correction is applied. Should be < 9x10E-7. Also, the background color of this field reflects the range of the
value. When the range is within acceptable values the field background is white; for marginal values the
background is yellow.
Short Term (Previous) Pre-FEC Downstream Signal Quality. Codeword error rate (CER) BEFORE forward error
correction is applied.
Page 309
CheetahXD
QAM
Constellation
User Guide
Map
QAM
CheetahXD
Constellation
User Guide
Map
Short Term (Previous) Post-FEC Downstream Signal Quality. Codeword error rate (CER) AFTER forward error
correction is applied. Should be < 9x10E-7. Also, the background color of this field reflects the range of the
Page 310
CheetahXD
QAM
Constellation
User Guide
Map
QAM
CheetahXD
Constellation
User Guide
Map
value. When the range is within acceptable values the field background is white; for marginal values the
background is yellow.
22.3
Interpreting QAM Constellation Map Data by Visual Inspection
The usefulness of the QAM constellation comes in the ability to recognize common shapes and configurations within
the map. Examples of the data shown in the table below are illustrated in the figures that follow.
Shape
Focus
Impairment
Description
Individual cells
and entire
QAM
constellation
Normal
Dots are centered in the individual QAM quadrants. The QAM

constellation has a uniform square shape.
Individual cells
Low CNR and/or

Low MER
Individual cells of QAM constellation contain a fuzzy and

diffused pattern.
Individual cells
Coherent
Interference
Individual cells of QAM constellation contain diffused hollow

circles or doughnuts. This indicates an interfering carrier and
shows the effect of not allowing the carrier to ever reach the
proper point in the target range.
Individual cells
Gaussian Noise
Individual cells contain a complete and fairly uniform smear up

to all decision boundaries, and is usually caused by improper
system setup, too many amplifiers in a cascade, damaged/
overheated hardware, and/or low power.
Entire QAM
constellation
Phase Noise
QAM constellation consists of smeared, concentric, circular

patterns.
Entire QAM
constellation
Gain
Compression
QAM constellation looks uniformly square, but the outside

corners appear to be smashed toward center of grid
(compression in the RF plant).
Entire QAM
constellation
I-Q Imbalance in
the Modulator
Overall appearance of QAM constellation is rectangular rather

than the desired square shape (square inequality).
Entire QAM
constellation
Quadrature
Distortion
Overall appearance of QAM constellation has a twisted or

skewed parallelogram shape.
Page 311
CheetahXD
QAM
Constellation
User Guide
Map
QAM
CheetahXD
Constellation
User Guide
Map
Figure 22-4: Sample QAM Constellation - Normal Centered Dots (Good Quality)
Figure 22-5: Sample QAM Constellation - Fuzzy (Low CNR and/or Low MER)
Page 312
CheetahXD
QAM
Constellation
User Guide
Map
QAM
CheetahXD
Constellation
User Guide
Map
Figure 22-6: Sample QAM Constellation "Doughnuts" (Coherent Interference)
Figure 22-7: Sample QAM Constellation Gaussian Noise
Page 313
CheetahXD
QAM
Constellation
User Guide
Map
QAM
CheetahXD
Constellation
User Guide
Map
Figure 22-8: Sample QAM Constellation Circular Smear (Phase Noise)
Figure 22-9: Sample QAM Constellation Corners Squeezed to Center (Gain Compression)
Page 314
CheetahXD
QAM
Constellation
User Guide
Map
QAM
CheetahXD
Constellation
User Guide
Map
Figure 22-10: Sample QAM Constellation Rectangular vs. Square (I-Q Imbalance)
Figure 22-11: Sample QAM Constellation Twisted or Skewed (Quadrature Distortion)
Page 315
CheetahXD
System
Setup
User
andGuide
Maintenance Recommendations
23
System Setup and Maintenance

CheetahXD
Recommendations
User Guide
System Setup and Maintenance Recommendations
This chapter provides information that is useful during the process of bringing the CheetahXD system online for the
first time, and also for maintaining or fine tuning an existing system over time.
The information presented in this chapter is intentionally presented at a high level. Therefore, you may need to
research each of the topics in more detail by reviewing the appropriate chapters in this manual.
The maintenance information presented in this chapter should be used as a reference to maintain or fine tune an
existing system over a period of time, as the number of devices in the system increase. The intent is to have the
operator review this information periodically and tweak the system variables as needed to ensure that the system
operates at an optimum performance level.
23.1
New CheetahXD Installations
The details in this section are provided to help ensure a new CheetahXD installation proceeds smoothly. Cheetah
recommends following the steps that apply to your application in the order that they appear.
23.1.1
Configuring CheetahXD to Discover DOCSIS-Based Elements
Before executing the steps in this section, it is assumed that all of the DOCSIS0-based devices in the system have
been configured to forward their traps to the CheetahXD server, and that all of the other configuration parameters
have been set up correctly.
1. Using a client machine and a browser, log in to the CheetahXD machine and create groups, apply scopes to the
groups, and then create users and assign them to the appropriate group(s) to grant users access to the various
CheetahXD applications.
2. From the CheetahXD Administration page, go to the Server Details menu and click on the Logs Configurator icon.
This will enable Debug Logging for the following log files:
CTAuto-discovery
CTSTatusPolling
Alert_audit
CTTreeAPI.
3. Autodiscovering devices: Cheetah recommends discovering 1 device of each targeted device type and
personality in your network, and set up the configuration thresholds for this device type based on your
preferences. Discovery of a single device can be accomplished by configuring your seed file to discover just a
single IP address or a narrow range of IP addresses.
4. Update the default templates for the above discovered device type(s), based on your preferences for limit
thresholds. Update the Status poll interval parameter as well. Refer to Section 23.2 on fine tuning the status poll
parameter, as the number of the elements managed by the system increases.
5. Once satisfied with the above configuration, run a manual backup of the system. Mark this as a baseline version
and save this file. This file will be useful if you need to revert back to a well-defined state in the event any critical
issues arise.
6. Configure your seed file with the other IP addresses and/or network ranges you wish to discover, and turn Autodiscovery ON in the seed file for sweep-based discoveries. Note that if you do not wish to discover your network
elements by performing sweeps, but prefer them to be discovered by way of traps, you may turn Auto-discovery
OFF, but you still need to define the network range in the seed file for these devices.
Page 316
CheetahXD
System
Setup
User
andGuide
23.1.2

CheetahXD
Recommendations
User Guide
Deploying CheetahXD with CheetahNet
In CheetahXD version 2.3 and newer, the CheetahNet legacy elements that are non -HMS based, such as the CMX
based transponders, can only be provisioned using the CheetahNet application. However, the operator can set up
CheetahXD to receive real time alerts from CheetahNet devices, view the CheetahNet devices in the CheetahXD
trees, and run the Battery Analyst application on CheetahNet-based devices. The information that follows lists the
steps necessary for configuring a CheetahNet system in CheetahXD.
1. Use the Tree Viewer application to create a CheetahNet element, and save the element as part of the native
tree.
2. Reference the Property Page in the Device Configuration application to set up the IP address, or addresses of
the machine(s) on which the CheetahNet server, database, and message manager reside. Save this change to
the database.
3. Within a few minutes you should see the CheetahNet-managed devices start to appear as children of the
element you created in Step 1. You may need to refresh the tree view to see the devices.
4. To ensure real time notification of alerts within the CheetahXD Notifier application, it is recommended to install
the SegSNMP agent in CheetahNet and configure it to forward traps to the CheetahXD server. If the SegSNMP
agent is not available, you can specify how often to synchronize data between the CheetahXD and CheetahNet
systems using the Property Page in the Device Configuration application. Cheetah recommends using the
default settings.
5. If HMS transponders are deployed via the CheetahNet Headend controllers (HECs), or if you plan to utilize the
Battery Analyst application on legacy CMX-based power supplies from CheetahXD, the VHEC software must be
installed and operational.
23.1.2.1 Configuring the VHEC Software

1. If you have chosen to install the VHEC software, the VHEC conf file must be configured to manage the various
HECs for which the software will be responsible. In cases where the VHEC software and the CheetahXD server
reside on the same machine, the RunVHECOnXD parameter in the VHEC configuration XML file must be set to
TRUE.
2. If HMS devices are deployed on the CheetahNet HEC, configure the OATrapListener and OAListener entries in
the HEC hosts file to point to the IP address of the machine on which the VHEC software resides.
3. Cheetah recommends deleting all of the HMS devices from the Cheetah Net system, and Auto-discovery should
be disabled in the Cheetah Net system. Be certain to exercise caution and delete the HMS devices from the
CheetahNet database only. DO NOT delete them from the HEC.
4. Reboot the HECs and start the VHEC application.
23.1.2.2 Configuring CheetahXD to Discover the VHEC

1. Once the CheetahNet element has been created as a device in CheetahXD (please refer to Section 23.1.2) and
the VHEC software has been configured, CheetahXD must now be configured to discover the VHEC.
2. Configure the CheetahXD seed file to discover the VHEC after the CheetahNet device has been created in
CheetahXD. If a VHEC is already discovered in CheetahXD prior to adding the CheetahNet elements, Cheetah
recommends deleting the VHEC and then restarting the CheetahXD application, or performing a Force
Rediscover on the existing VHEC.
23.1.3
Deploying CheetahXD with CheetahLight
If you have an existing CheetahLight formerly known as LightHouse) system, the devices that are managed by this
system can be fully migrated over to the CheetahXD platform. It is important to note that you must be running
version 5.x of the Light House HEC software prior to the migration.
It is also important to note that the steps to discover DOCSIS devices are the same as those outlined in Section
Page 317
CheetahXD
System
Setup
User
andGuide

CheetahXD
Recommendations
User Guide
23.1.1. If necessary, perform those steps, and create a backup of the system before proceeding with the process
outlined below.
Page 318
CheetahXD
System
Setup
User
andGuide

CheetahXD
Recommendations
User Guide
23.1.3.1 Migrating CheetahLight Devices into CheetahXD

1.
2.
3.
4.
5.
6.
Configure the CheetahXD seed file for the discovery of the CheetahLight HECs. Also, configure the CheetahLight
HECs to forward their traps to the CheetahXD server.
If you do not want to preserve the alarm limit values that were configured using the CheetahLight system, you
can omit this step. Otherwise, set the System Import parameter in the NMSProcessBE.conf file to TRUE. The
default location of the NMSProcessBE.conf file is in the CheetahXD conf folder. This will ensure that the alarm
limits that were set up in the transponders using CheetahLight are migrated over to CheetahXD. Restart
CheetahXD.
Launch the Template Admin feature. In the CheetahLight HEC Template, ensure the Enable Time Update field is
enabled.
Once all the devices have been discovered and migrated into CheetahXD, you can use the optional export
functionality in CheetahLight to export the device names, MAC addresses, and locations into a CSV file. This file
can then be imported into CheetahXD by using the CheetahLightImportData.bat script. The scripts default
location is in the CheetahXD/bin folder.
After completing the migration and the configuration process on all of the devices in CheetahXD, the
CheetahLight server application can be turned OFF.
Set the System Import parameter to FALSE.
23.1.4
Deploying CheetahXD with CheetahDOCSIS
It is important to note that the steps to discover DOCSIS devices are the same as those outlined in Section 23.1.1.
The steps outlined in the following information present an alternative method for deploying CheetahXD with
CheetahDOCSIS.
1. Configure the CheetahXD seed file for the discovery of the DOCSIS devices by configuring the appropriate
network ranges within the file. The assumption is that all of the DOCSIS-based devices in the system have been
configured to forward their traps to the CheetahXD server, and that all of the other configuration parameters
have been set up correctly.
2. If you do not want to preserve the alarm limit values that were configured using the CheetahDOCSIS system, you
can omit this step. Otherwise, set the System Import parameter in the NMSProcessBE.conf file to TRUE. The
default location of the NMSProcessBE.conf file is in the CheetahXD conf folder. This will ensure that the alarm
limits that were set up in the transponders using CheetahDOCSIS are migrated over to CheetahXD. Restart
CheetahXD.
3. Once all the devices have been discovered and migrated into CheetahXD, you can use the optional export
functionality in CheetahDOCSIS to export the device names, MAC addresses, and locations into a CSV file. This
file can then be imported into CheetahXD by using the CheetahLightImportData.bat script. The scripts default
location is in the CheetahXD/bin folder.
4. After completing the migration and the configuration process on all of the devices in CheetahXD, the
CheetahDOCSIS server application can be turned OFF.
5. Set the System Import parameter to FALSE.
When you have completed the configuration, run a manual backup of the system. Mark this as a baseline version
and save this file. This will be useful if the need arises to revert back to a well-defined state in the event any critical
issues arise.
Page 319
System Setup
CheetahXD
User
andGuide
23.2

CheetahXD
Recommendations
User Guide
Fine-Tuning CheetahXD Parameters
This section deals with information on certain configuration files and parameters that should be updated as the
number and types of the devices managed by the CheetahXD system change over time. This will help to ensure
optimal performance of your CheetahXD system.
23.2.1
System Verification
Periodically check the database backups. Verify that they have been set up correctly and are being created
correctly.
Verify that the counts in the Network Inventory application match the number of devices deployed in the field.
Also, use the Network Inventory application to identify devices that are not provisioned or require downloads,
and provision them as necessary.
Verify that the alert queue is staying clear by using the Fault Status link in the in the Administration tab. A
backed-up queue may not allow for real-time alert notification.
Run periodic reports such as the Alert Audit report, Provisioned transponder report, and Device Dead report.
Save these reports for future comparisons. Analysis of the Device Dead reports may reveal a need to adjust the
polling cycle, which is discussed in the next section.
Using the Template Admin application, Cheetah recommends creating alert profiles that will serve as useful aids
when performing bulk downloads to similar device types.
Cheetah recommends using tree views other than the native tree view, such as the HFC or custom tree views,
for everyday operation. The native view tree is typically very large and will require more time to search and
refresh. Operators can tailor custom tree views to their own viewing needs, and these views will typically be
smaller and more efficient when viewing data.
Cheetah recommends creating custom trees and assigning these trees to users, instead of granting users
permission to access all of the trees in the CheetahXD system. This is more efficient for the users when viewing
data.
As people become more familiar with the CheetahXDs fault application Notifier, they often find that they are
only interested in particular fields of data. In a situation such as this, Cheetah recommends using the
applications field selection, filtering, and layout capabilities to configure the display to suit your viewing
preferences.
As users become more familiar with all of the features and applications available in the CheetahXD software,
periodically review and update the security permissions that have been assigned to the various users and
groups.
23.2.2
Performance Tuning and Configuration
CheetahXD performs a background status poll on managed elements for two main reasons:
The background status poll process in CheetahXD allows the detection and generation of unit timeout alarms for
elements that are not communicating.
The background process serves as a mechanism to re-synchronize alerts for any traps that may have been lost
or not received by CheetahXD.
The rate at which the status polls occur is based on the status poll interval property that can be configured for each
device type. A longer status poll interval implies a longer time to detect unit timeout and resynchronize any lost
traps/alerts. On a heavily loaded system with a large number of devices, configuring the status poll interval with a
small value (i.e., every 2 minutes) puts a heavy load on the CPU, and causes undesirable effects on Auto-discovery,
incoming trap/alert processing, and other applications that require network traffic.
The following table displays the default status poll interval that is recommended, based on the number and type of
the devices in your system.
Page 320
System Setup
CheetahXD
User
andGuide

CheetahXD
Recommendations
User Guide
Apart from tuning the status poll interval parameter, there also exists the ability to define the number of threads
(parallel processes). The following table also recommends the optimal number of threads to configure.
Page 321
System Setup
CheetahXD
User
andGuide

CheetahXD
Recommendations
User Guide
STATUS POLL INTERVAL SETUP MATRIX (seconds)

Number Devices Polled
<1000
<3600
<7200
<10000
<15000
Avg Dev / Thread
333
600
1028
1250
1875
Avg Dev polled/min
180
360
420
480
488
Avg Dev polled/min/thread
32
36
25
23
16
Minutes to complete Poll Cycle
10
18
21
31
Thread Count*
* Thread count is set in Cheetahxd\conf\threads.conf (STATUSPOLL)

** Other changes may need to be made to NMSProcessBEconfiguration file variables based on device count, device
type mix and network efficiency.
Use the information present in the table as a guideline. As the mix of device types in your system vary, you may need
to fine tune the above parameters to optimize your system. For additional information on updating the status poll
interval on multiple devices simultaneously (i.e., in bulk), contact Cheetah Support at 1-866-944-1482 or at
cheetahsupport@cheetahtech.com.
Page 322
System Setup
CheetahXD
User
andGuide
23.3

CheetahXD
Recommendations
User Guide
CheetahXD Bandwidth Information
This information is meant to be used as a guideline as CheetahXD is implemented into a network. Download or
response times are provided for certain user activities as well as bandwidth usage for processing traps and running
some data gathering functionality.
UI Load Up Time
Download Time**
Download
Item
Login Screen
[initial use]
Notifier [initial
use] (includes
AdvenNet)
Notifier
[subsequent
use]
Domain
Options ->
Open Native
Tree- View
IP Domain >Fault View
[initial use]
Network
Inventory
Help Menu
[initial use]
Admin Menu
[initial use]
Add User
Function
System Setup
Funtion [initial
use]
Size***
56K Dial Up
ISDN
T1 1.5
Mbits/sec
Ethernet 10
Mbits/sec
Ethernet 100
Mbits/sec
250KB
36 sec
14 sec
5 sec
4 sec
2 sec
2.3MB
(+1.9MB)
10.25 min
4.25 min
1.25 min
<1.25 min
<.85 min
33KB
8 sec
7 sec
5 sec
5 sec
3 sec
7.5KB
5 sec
2 sec
2 sec
2 sec
2 sec
45KB
35 sec
33 sec
30 sec
30 sec
30 sec
11KB
15 sec
14 sec
5 sec
5 sec
5 sec
490KB
70 sec
30 sec
10 sec
9 sec
8 sec
53KB
8 sec
3 sec
2 sec
2 sec
2 sec
8KB
3 sec
1 sec
1 sec
1 sec
1 sec
16.1MB
41 min***
16 min
4.2 min
<4 min
< 3 min
Using Microsoft Internet Explorer
**
all numbers are approximate and subject to variances in network connection speed, other network traffic,
and individual PC
***
data size and transfer time measured using Net Limiter 2 Pro
****
estimated
Page 323
System Setup
CheetahXD
User
andGuide
1.

CheetahXD
Recommendations
User Guide
Trap-Based Traffic (for alarms):
Each SNMP trap from the transponder to the CXD server is between 150 200 bytes. The total number of
traps depends on the alarm limits and tolerances.
If the limits are tight (narrow range) and the parameter values oscillate, one will get more alarms/clear
traps compared to when the alarm limits are spread over a wider rang.
Example: If a transponder generates 10 alarms a day and there are 200 transponders off a CMTS,
the total network traffic generated over the day will be 200 bytes * 10 * 200
= 400000 (approx 400 K bytes/day).
2.
Traps are one way traffic events that flow from the transponder to the CXD server.
Synchronous Communication (Data Display & Scheduled Measurements):
Data Display or Scheduled Measurements make an outgoing request from the CXD server to the
transponder followed by a response from a transponder that is communicating.
A request/response pair would consist of about 1496 bytes in each direction i.e. approx 3000 bytes
total (3k).
Example: If you leave data display running for 5 minutes with the collection taking place every 30
seconds, there will be a total of 10 request/response pairs that occur over the 5 minutes, each
consuming about 3K bytes.
Page 324
CheetahXD
User Guide
Supported Motorola
GX-2 Modules
Appendix A
Platform
Supported Motorola GX-2 Modules

Model Name
GX2
GX2
GX2
GX2
GX2
GX2-CM100B*
GX2-PSAC10*
GX2-PSDC10*
GX2-LM1000B
GX2-LM1000E
GX2
GX2-LC1000E
GX2
GX2
GX2
GX2-RX200BX2
GX2-RX200BX4
GX2-EM870
GX2
GX2-EM1000
GX2
GX2
GX2-RX1000B
GX2-OA100B13, 16, 18
GX2
Supported Motorola
GX-2User
Modules
CheetahXD
Guide
GX2-OA100B20, 22, 21X2
GX2
GX2
GX2
GX2-RSW1000B
GX2-RSW200B
GX2-DM870
GX2
GX2
GX2-DM200
GX2-DM1000
GX2
GX2
GX2-OSW10B
N2U-OA300
GX2
GX2-DRR-2X
GX2
GX2-DRR-3X
GX2
GX2-DRT-2X
GX2
GX2-DRR-4X
GX2
GX2-DRT-4X
GX2
GX2-DM2000
GX2
GX2
GX2-OA508B21
GX2-RX085BX4
GX2
GX2-EA1000B
GX2
GX2-EA1000C
GX2
GX2-GS1000
GX2
GX2-EML1000
GX2
GX2-DRR-2X-85
GX2-LITE
GX2-HSG-LITE
Rack Mount Optics
N1U-OA500
Rack Mount Optics
N2U-OA300
Product Description
GX2 Chassis Control Module
GX2 AC Power Supply
GX2 DC Power Supply
GX2 1310 nm Transmitter
RoHS Version
GX2 1310 nm eCWDM
Transmitter
GX2 Dual Return Receiver
GX2 Quad Return Receiver
GX2 1550 nm Broadcast
Optical Transmitter
GX2 1550 nm Broadcast
Optical Transmitter
GX2 Forward Path Receiver
GX2 EDFA Optical Amplifiers
(Optical powers 13 dBm, 16
dBm, and 18 dBm)
GX2 EDFA Optical Amplifiers
(Optical powers 20 dBm, 22
dBm, and 21x2 dBm)
GX2 Forward Path RF Switch
GX2 Return Path RF Switch
GX2 Forward Path
Narrowcast Transmitter
GX2 Return Path Transmitter
GX2 Forward Path
Narrowcast Transmitter
GX2 Optical Switch
2RU Erbium Doped Fiber
Amplifier for PON (non-GX2)
GX2 2X Digital Return Path
Receiver
Receiver
Transmitter
Receiver
Transmitter
GX2 Direct Modulation
Transmitter
GX2 EDFA Optical Amplifier
GX2 High Sensitivity Receiver
- 85 MHz
GX2 Electro Absorption
Transmitter - Analog - Rev B
Transmitter - Analog - Rev C
Transmitter - Digital
GX2 External Modulation Lite
Transmitter
GX2 2x85 MHz Digital Return
Receiver
GX2 2RU Chassis (supports 3
single wide GX2 modules)
1RU Erbium Doped Fiber
Amplifier (non-GX2)
2RU PON Erbium Doped
Fiber Amplifier (non-GX2)
Page 316
CheetahXD ver.
Initial Support
Comments
2.4
2.4
2.4
2.4
Integrated
Integrated
Integrated
Integrated
2.4
Integrated
2.4
Integrated
2.4
2.4
Integrated
Integrated
3.1
Integrated
3.1
Integrated
3.1
Integrated
3.1
Integrated
3.1
Integrated
3.1
3.1
Integrated
Integrated
3.1
Integrated
3.1
Integrated
3.1
Integrated
3.1
Integrated
3.1
Integrated
3.2
Integrated
3.1
Integrated
3.2
Integrated
3.2
Integrated
3.2
Integrated
4.1
Integrated
4.1
Integrated
4.1
Integrated
4.1
Integrated
Integrated
Integrated
Integrated
Integrated
3.1
Integrated
3.2
Integrated
3.2
Integrated
CheetahXD
User Guide
Supported Motorola
GX-2 Modules
HMS Transponder
LL-HMS-SG4
Supported Motorola
GX-2User
Modules
CheetahXD
Guide
HMS SG4 Transponder via

LL-HMTS
Page 317
3.1
Integrated
CheetahXD
User Guide
Supported Motorola
GX-2 Modules
Supported Motorola
GX-2User
Modules
CheetahXD
Guide
HMS Transponder
LL-HMS-SG2
HMS Transponder
LL-HMS-SG1
HMS Transponder
GX2
LL-HMTS
GX2-EA1000
GX2
GX2-DUALDRR-2X
GX2
GX2
GX2
GX2
GX2-LM1000S
N2U-OA200
GX2-RX1000
GX2-RFA1000
GX2
GX2-RFA1000B
Appendix B

LL-HMTS
LL-HMTS
HMTS Headend Controller
Transmitter - Analog
Receiver
GX2 1310 Laser Receiver
GX2 Forward Path RF
Amplifier
GX2 Forward Path RF
Amplifier
3.1
Integrated
3.1
Integrated
3.1
Integrated
Integrated
Integrated
Integrated
Integrated
Integrated
Integrated
3.1
Not Verified
Supported Cisco Prisma II Modules

Model Name
Prisma II XD Shelf
Prisma II P2-HD-LN-RXR
Prisma II P2-HD-RXR
Prisma II HDTx
Page 318
CheetahXD ver.
Initial Support
5.2
5.2
5.2
5.2
Index
Index
Changing the Network Inventory layout .........................100
A
Accessing Power Outage monitoring ..............................160
Administration tab functions ..........................................263
Alert Filters .................................................................265
Battery Test Configuration .........................................264
Bulk Task Status ..........................................................264
DB Backup...................................................................264
database restoration ..............................................269
Discovery Configurator ...............................................264
Discovery Queue.........................................................264
Firmware Download ...................................................264
Group Configuration ...................................................265
Logs Configurator .......................................................265
Logs Monitor...............................................................265
Page Alert ...................................................................264
Send Event ..................................................................264
Server Logs .................................................................265
Shutdown Server ........................................................264
System Details ............................................................265
System Performance
client details ...........................................................271
server details ..........................................................270
terminate client ......................................................271
System Performance (CheetahXD Server) ..................265
Template Admin .........................................................264
User Configuration......................................................265
Advanced alarm threshold configuration ...........................4
Advanced grouping .............................................................4
Alert filters ........................................................................51
Device status in trees....................................................52
Filter rules .....................................................................52
Setting up .....................................................................52
Alerts filtering and suppression ........................................51
Applet execution...............................................................14
Authenticating users against LDAP ...................................13
B
Battery Analyst module ......................................................5
Bulk property update ........................................................89
C
Changing the network inventory display ........................100
Page 319
Index
CheetahNet
Adding a vHEC to the autodiscovery queue ................ 26
Configuring an element................................................ 20
Creating a permanent vHEC log file ............................. 24
Creating an element..................................................... 19
Creating proxies for HECs............................................. 26
Creating/configuring a vHEC ........................................ 23
Device and alarm synchronization ............................... 21
Device and location information .................................. 21
Disabling autodiscovery .............................................. 22
Discovering HMS devices ............................................. 27
Provisioning HMS devices in CheetahXD...................... 28
Reconfiguring a HEC ..................................................... 23
Starting the vHEC ......................................................... 28
Virtual headend controller installation ........................ 22
CheetahXD deployment ..................................................... 6
CheetahXD system components ........................................ 6
Configuring clients for Applet execution .......................... 14
Creating network elements in the Tree Viewer ............... 94
Creating new tree views................................................... 91
Custom tree view ............................................................. 82
Customizing Power Outage monitoring ......................... 161
D
Deleting trees or network elements in the Tree Viewer .. 96
Discovery Admin .............................................................. 42
Discovery Configurator ................................................ 43
configuring discovery of remote networks .............. 47
deleting network entries.......................................... 49
discovering a range of IP addresses ......................... 47
discovering a range of node IP addresses ................ 47
Discovery queue ...................................................... 50
forcing rediscovery .................................................. 50
network specific discovery of SNMP devices ........... 48
preventing network discovery ................................. 49
specifying a network ................................................ 46
specifying a node ..................................................... 45
Displaying data ............................................................... 180
Categories .................................................................. 181
Launching the data display......................................... 180
Legacy devices............................................................ 184
Options....................................................................... 182
Displaying network inventory in fullscreen mode......... 100
Displaying subgroups of tree elements ............................ 91
Domain options ................................................................ 29
status display ............................................................... 30
Downloading firmware................................................... 243
Page 320
Index
Broadcast downloading to all HMS transponders ......249

Displaying DOCSIS download history ..........................251
Displaying HEC download history ...............................248
Displaying HMS transponder download history .........250
Downloading to 1 DOCSIS transponder ......................250
Downloading to 1 HEC ................................................248
Downloading to 1 HMS transponder ..........................249
Downloading to DOCSIS transponders .......................250
Downloading to headend controllers .........................247
Downloading to HMC (NonDOCSIS) transponders ....248
Editing the configuration file ......................................243
Launching a download ................................................244
Log file ........................................................................252
Motorola GX2 Chassis
1 module ................................................................253
all like modules.......................................................254
multiple modules....................................................254
setup.......................................................................252
Specifying download options......................................247
Status ..........................................................................251
Troubleshooting .........................................................255
download log file ....................................................255
E
Enhanced alarm processing ................................................5
F
Fault Views Notifier ......................................................124
Creating a new alerts view .........................................128
Dashboard ..................................................................127
Default
Acknowledging alarms............................................148
Clearing alarms .......................................................148
Cross Navigation .....................................................150
Current alerts/events reporting .............................156
Custom extensions .................................................153
dynamic menu arguments..................................155
runtime requirements ........................................155
Customizing views ..................................................128
displaying system audit information ..................130
specifying fields for views ..................................129
Dashboard view ......................................................141
Deleting alarms.......................................................148
Displaying alert or event details .............................147
Find Alert ................................................................139
Historical event processing.....................................155
Launching data displays for devices in alarm .........149
Page 321
Layout selection ..................................................... 138

saving, applying, deleting layouts ...................... 139
Local Context menu ............................................... 146
Map alert ............................................................... 153
Quick Filters
implementing and clearing ................................ 151
Related alerts (upstream/downstream) ................ 152
Sound on/off for audible alarms ............................ 140
Specifying filters for views ..................................... 132
assigning a filter to a view ................................. 138
Testing the Notifier ................................................ 146
Viewing Alarm events ............................................ 151
Displaying a fullscreen Notifier ................................. 128
Fault Views Notifier Alerts view ................................... 127
Fault Views Notifier Events .......................................... 127
Fault Views Notifier page ............................................. 125
Fault Views Power Outage monitoring ........................ 158
Accessing.................................................................... 160
Alarm processing........................................................ 158
Cloning schedules....................................................... 177
Creating a schedule .................................................... 166
Customizing................................................................ 161
Displaying ................................................................... 160
Filtering alerts ............................................................ 164
Finding Alerts ............................................................. 165
Local Context menu ................................................... 165
Opening the scheduler ............................................... 166
Scheduling data collection ......................................... 166
Viewing schedules and results ................................... 177
Finding Power Outage monitoring alerts ....................... 165
Finding resources in the Tree Viewer ............................... 90
Firmware
Downloading .............................................................. 243
Force Sync Alerts Now function ....................................... 90
Forwarding Notfications via SNMP
Notification formats
alert notifications................................................... 261
Forwarding Notifications via SNMP................................ 257
Editing the trap forwarding table ............................... 257
Notification formats ................................................... 260
Gateway parent and toplevel parent.................... 262
Managed object notifications ................................ 260
Trap message example............................................... 259
Launching Device Config for device in alarm ..........149
Index
G
Groups .............................................................................. 31
Modifying ..................................................................... 35
adding and removing members ............................... 35
changing group operation settings .......................... 36
Operations and permissions ........................................ 33
Page 322
Index
CheetahXD
User Guide

Index
Scopes...........................................................................36
Polling/unpolling devices............................................102
high power polling ..................................................102
lock polling .............................................................102
HFC tree view....................................................................81

HMS MIB extension support ...............................................5
I
Integration with Cheetah products.....................................4
CheetahLight/DOCSIS ...................................................16
CheetahNet...................................................................17
existing .........................................................................16
managing legacy devices ..............................................16
IP tree view .......................................................................81
J
JMX ALERT forward filtering Northbound SNMP traps ...54
parameters ...................................................................56
process..........................................................................54
setup .............................................................................55
L
LDAP binding
anonymous ...................................................................13
user ...............................................................................13
Local device menus ...........................................................85
Log pane ...........................................................................79
Logging in ..........................................................................29
M
Managing devices in the Network Inventory page .........101
N
Native tree view................................................................81
Network inventory ............................................................98
Changing the layout....................................................100
Displaying in fullscreen mode....................................100
Managing devices .......................................................101
Page 320
Index
CheetahXD
User Guide

Index
normal polling ........................................................

102 turning polling
on/off............................................. 102
Network Inventory
Changing the display .................................................. 100
Northbound SNMP traps .................................................. 54
Analog tab page ..................................................... 118

Information tab page ............................................. 116
Multitab page ....................................................... 119
Property tab page .................................................. 117
P
Paging ............................................................................. 204
Activating technicians ................................................ 211
Configuring alphanumeric pagers .............................. 206
Configuring email ...................................................... 207
Configuring schedules ................................................ 210
Create a schedule .................................................. 210
Delete a schedule................................................... 211
View a schedule ..................................................... 210
Creating technicians ................................................... 208
Deleting technician information ................................ 213
Editing technician information ................................... 213
Paging technicians using device groups ..................... 214
Security permissions .................................................. 213
Setting up ................................................................... 204
Specifying modem information.................................. 205
Updating the paging server ........................................ 212
Policy configuration.......................................................... 53
Polling/unpolling devices ............................................... 102
High power polling ..................................................... 102
Lock polling ................................................................ 102
Normal polling............................................................ 102
Turning polling on/off ................................................ 102
Power Outage alarm processing .................................... 158
Power Outage monitoring .............................................. 158
Local Context menu ................................................... 165
Power Outage monitoring data collection .....................
166
Power Outage monitoring display.................................. 160
Power Outage monitoring filtering alerts ......................
164
Power Outage monitoring schedule............................... 166
Power Outage monitoring schedule cloning ..................
177
Power Outage monitoring schedule results ................... 177
Power Outage monitoring Scheduler ............................. 166
Primary panel ................................................................... 77
Provisioning devcies
Generic I/O setup ....................................................... 113
Provisioning devices
Applying templates .................................................... 110
Configurable parameters ........................................... 116
All Attributes tab page ........................................... 120
Page 321
Index
CheetahXD
User Guide

Index
Configuring an individual device.................................120

Configuring and using templates ................................104
concepts .................................................................105
Configuring the CheetahNet element.........................120
Configuring vHECs.......................................................120
Generic I/O setup
Analogs attribute ....................................................114
digitals attribute .....................................................115
Power supply indexing................................................112
Userdefined configuration fields ...............................121
viewing, modifying, and creating templates...............106
Viewing, modifying, and creating templates
changing the template view ...................................107
Solaris .............................................................................7
Q
QAM Constellation map..................................................295
Interface .....................................................................295
Interface variables and parameters
configuration settings.............................................296
device details..........................................................296
Interpreting by visual inspection ................................298
R
Reports ...........................................................................216
Accessing ....................................................................217
Alert Analysis Report ..................................................229
Alert Listing Report .....................................................225
Alert Report by Category ............................................224
Alert Status Report by Device .....................................227
Battery Analyst Report ...............................................232
reading ...................................................................235
Battery Summary Report ............................................238
Device Configuration ..................................................217
Device Dead Report ....................................................228
Device Inventory by Type ...........................................221
Device Status ..............................................................219
Fault types ..................................................................224
Filtering Fault Report data ..........................................224
Output options ...........................................................216
Page Alert On Call Report ...........................................241
Performance Reports..................................................232
Power Supply Alert Report .........................................231
Power Supply Testable Report....................................242
Provisioned Transponders ..........................................222
Scheduler Report ........................................................239
Transponder firmware................................................222
Restarting the system
Page 322
Index
CheetahXD
User Guide

Index
Windows ...................................................................... 13
Discovery Configurator ............................................ 43

configuring discovery of remote networks .......... 47
deleting network entries ..................................... 49
Security administration .................................................... 31

Starting and stopping the system....................................... 7
Starting the system
Solaris ............................................................................. 7
Windows ........................................................................ 9
Stopping the system
Solaris ............................................................................. 8
Windows ...................................................................... 11
System administration
DB Backup
database restoration.............................................. 269
System Performance
client details ........................................................... 271
server details.......................................................... 270
System Administration ................................................... 263
Alert Filters................................................................. 265
Battery Test Configuration ......................................... 264
Bulk Task Status ......................................................... 264
DB Backup .................................................................. 264
Discovery Configurator .............................................. 264
Discovery Queue ........................................................ 264
Firmware Download................................................... 264
Group Configuration .................................................. 265
Logs Configurator ....................................................... 265
Logs Monitor .............................................................. 265
Page Alert ................................................................... 264
Send Event ................................................................. 264
Server Logs ................................................................. 265
Shutdown Server ........................................................ 264
System Details ............................................................ 265
System Performance
terminate client ..................................................... 271
System Performance (CheetahXD Server).................. 265
Template Admin......................................................... 264
User Configuration ..................................................... 265
System architecture ........................................................... 5
System deployment............................................................ 6
System setup
Alert filters ................................................................... 51
device status in trees ............................................... 52
filter rules................................................................. 52
setting up ................................................................. 52
Alerts filtering and suppression ................................... 51
Discovery Admin .......................................................... 42
Page 323
Index
CheetahXD
User Guide

Index
discovering a range of node IP addresses ............47

Discovery queue ...................................................50
forcing rediscovery ...............................................50
network specific discovery of SNMP devices .......48
preventing network discovery..............................49
specifying a network ............................................46
specifying a node..................................................45
Discvoery Configurator
discovering a range of IP addresses .....................47
Domain options ............................................................29
Groups ..........................................................................31
creating and removing..............................................32
modifying..................................................................35
adding and removing members ...........................35
changing group operation settings.......................36
Operations and permissions .....................................33
scopes.......................................................................36
JMS ALERT forward filtering Northbound SNMP traps
parameters ...............................................................56
JMX ALERT forward filtering Northbound SNMP traps
..................................................................................54
processing.................................................................54
setup.........................................................................55
Logging in......................................................................29
Policy configuration ......................................................53
Security administration ................................................31
Tree color......................................................................30
Typical...........................................................................30
Users .............................................................................37
changing status.........................................................40
creating.....................................................................37
deleting.....................................................................40
modifying..................................................................39
System setup and maintenance......................................303
New installations ........................................................303
bandwidth information ..........................................308
configurating VHEC software..................................304
configuring VHEC discovery ....................................304
deploying wiith CheetahLight .................................304
deploying with CheetahDOCSIS ..............................305
deploying with CheetahNet....................................304
discovering DOCSISbased elements ......................303
finetuning parameters ..........................................306
migrating CheetahLight devices .............................305
Battery analyst test.....................................................191

Creating a background test.........................................188
T
Testing power supplies ...................................................186
Background tests ........................................................188
Page 324
Index
CheetahXD
User Guide

Index
Creating test groups ................................................... 187

Deep drain test........................................................... 196
Excluding a power supply........................................... 203
Inverter test ............................................................... 195
Ondemand test results ............................................. 201
Ondemand tests........................................................ 190
Predictive test ............................................................ 198
Pretests ..................................................................... 187
Setting parameters..................................................... 187
Viewing automatic results.......................................... 200
Tree Control pane ............................................................ 77
Tree status icons .............................................................. 82
Tree structure hierarchy................................................... 81
Tree view icons................................................................. 83
Tree Viewer ...................................................................... 77
Bulk property update option........................................ 89
Components ................................................................. 77
Log pane................................................................... 79
Primary panel ........................................................... 77
Properties and View editing pane ............................ 77
Tree Control pane .................................................... 77
Tree Viewer tool buttons ......................................... 79
Creating network elements.......................................... 94
Creating new tree views............................................... 91
Custom tree view ......................................................... 82
Deleting tree or network elements .............................. 96
Displaying Subgroups ................................................... 91
Finding resources ......................................................... 90
Force Sync Alerts Now function ................................... 90
HFC tree view ............................................................... 81
IP tree view .................................................................. 81
Local device menus ...................................................... 85
Native tree view ........................................................... 81
Side panel access.......................................................... 81
Tree status icons .......................................................... 82
Tree structure hierarchy .............................................. 81
Tree Structure, types, and elements ............................ 80
Tree view icons ............................................................ 83
Upstream/downstream events .................................... 88
Using ............................................................................ 85
Tree Viewer structure, types, and elements .................... 80
Tree Viewer tool buttons ................................................. 79
Troubleshooting ............................................................. 275
Access errors .............................................................. 280
Database backup errors ............................................. 280
Java conflicts .............................................................. 278
Running reports ......................................................... 280
Startup issues ............................................................. 275
Typical system setup ........................................................ 30
Page 325
Index
CheetahXD
User Guide

Index
U
Upstream/downstream alerts ..........................................88
Users .................................................................................37
Changing status ............................................................40
Creating ........................................................................37
Deleting ........................................................................40
Modifying......................................................................39
Using the Tree Viewer ......................................................85
Utilities............................................................................281
Console Data Display ..................................................284
Page 326
Dynamic Mapping and Route Calculation .................. 290

Firmware Download................................................... 285
Import HFC Manager Events ...................................... 286
Unix ........................................................................ 288
Remote Export ........................................................... 281
Send Event ................................................................. 285
W
What is CheetahXD?........................................................... 3

Cheetah 5.2 PDF

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Cheetah 5.2 PDF

Hochgeladen von

Copyright:

Verfügbare Formate

TAHTM

Broadban d Assurance Platfor m

CheetahXD is a trademark of Cheetah Technologies LP

Microsoft Excel is a registered trademark of Microsoft Corporation.

Purpose and Scope of this Guide .................................................................................................................1

Related Documentation ...............................................................................................................................1

Typographical Conventions .....................................................................................................................1

Keyboard and Menu Conventions ...........................................................................................................2

Symbol Descriptions ................................................................................................................................2

Keyboard Internationalization .................................................................................................................2

Cheetah Technical Support ..........................................................................................................................2

Industrial Database ......................................................................................................................................4

Transponder Auto Discovery........................................................................................................................4

Integration with Existing Cheetah Software ................................................................................................4

Advanced Alarm Threshold Configuration ...................................................................................................4

HMS MIB Extension Support Enhanced Alarm Processing ........................................................................5

Battery Analyst Module ...............................................................................................................................5

CheetahXD System Architecture ..................................................................................................................5

CheetahXD System Deployment ..................................................................................................................6

Starting and Stopping CheetahXD .................................................................................................. 7

Starting/Restarting CheetahXD on a Solaris Server .....................................................................................7

Stopping CheetahXD on a Solaris Server ......................................................................................................8

Starting CheetahXD on a Windows Server ...................................................................................................9

Stopping CheetahXD on a Windows Server ...............................................................................................11

Restarting CheetahXD on a Windows Server .............................................................................................13

Authenticating Users Against an External LDAP Directory.........................................................................13

Configuring Client Machines for Applet Execution ....................................................................................14

Integrating CheetahXD with Existing Cheetah Systems ................................................................ 16

How CheetahXD Manages CheetahNet Legacy Devices ............................................................................16

CheetahXD User Guide

Integrating CheetahXD with CheetahLight/Cheetah DOCSIS .....................................................................16

Integrating CheetahXD with CheetahNet...................................................................................................17

Creating a CheetahNet Element in CheetahXD .....................................................................................19

Configuring the CheetahNet Network Element .....................................................................................20

Virtual Headend Controller Installation .................................................................................................22

Disabling the AutoDiscover Feature ......................................................................................................22

Reconfiguring a CheetahNet Headend Controller (HEC) .......................................................................23

Creating an Configuring a Virtual Headend Controller (vHEC) ..............................................................23

Creating Proxies .....................................................................................................................................26

Adding a vHEC to CheetahXDs Autodiscovery Queue .........................................................................26

Discovering HMS Devices.......................................................................................................................27

Starting the vHEC...............................................................................................................................28

Provisioning CheetahNet HMS Devices in CheetahXD ......................................................................28

System Setup .............................................................................................................................. 29

Login Page ..................................................................................................................................................29

Domain Options .........................................................................................................................................29

Collapsed Tree Color ..................................................................................................................................30

Typical System Setup..................................................................................................................................30

Creating and Removing Groups .............................................................................................................32

Operations and Permissions ..................................................................................................................33

Modifying Groups ..................................................................................................................................35

Modifying Users .....................................................................................................................................39

Changing User Status .............................................................................................................................40

Terminating User Sessions.....................................................................................................................41

Discovery Admin ........................................................................................................................................42

Discovery Configurator ..........................................................................................................................42

Discovery Queue ....................................................................................................................................49

Automatic Template Downloads ...........................................................................................................50

Document # 050-0097 Rev P

CheetahXD User Guide

Alert Filtering and Suppression ..................................................................................................................50

Alert Filters .................................................................................................................................................50

Filter Rules .........................................................................................................................................51