[Title will be auto-generated] by Advantec Distribution

Cambium Wireless Manager User Guide System Release 4.0

Accuracy

While reasonable efforts have been made to assure the accuracy of this document, Cambium Networks assumes no liability resulting from any inaccuracies or omissions in this document, or from use of the information obtained herein. Cambium reserves the right to make changes to any products described herein to improve reliability, function, or design, and reserves the right to revise this document and to make changes from time to time in content hereof with no obligation to notify any person of revisions or changes. Cambium does not assume any liability arising out of the application or use of any product, software, or circuit described herein; neither does it convey license under its patent rights or the rights of others. It is possible that this publication may contain references to, or information about Cambium products (machines and programs), programming, or services that are not announced in your country. Such references or information must not be construed to mean that Cambium intends to announce such Cambium products, programming, or services in your country. Copyrights

This document, Cambium products, and 3rd Party Software products described in this document may include or describe copyrighted Cambium and other 3rd Party supplied computer programs stored in semiconductor memories or other media. Laws in the United States and other countries preserve for Cambium, its licensors, and other 3rd Party supplied software certain exclusive rights for copyrighted material, including the exclusive right to copy, reproduce in any form, distribute and make derivative works of the copyrighted material. Accordingly, any copyrighted material of Cambium, its licensors, or the 3rd Party software supplied material contained in the Cambium products described in this document may not be copied, reproduced, reverse engineered, distributed, merged or modified in any manner without the express written permission of Cambium. Furthermore, the purchase of Cambium products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Cambium or other 3rd Party supplied software, except for the normal non‐exclusive, royalty free license to use that arises by operation of law in the sale of a product. Restrictions

Software and documentation are copyrighted materials. Making unauthorized copies is prohibited by law. No part of the software or documentation may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form or by any means, without prior written permission of Cambium. License Agreements

The software described in this document is the property of Cambium and its licensors. It is furnished by express license agreement only and may be used only in accordance with the terms of such an agreement. See Legal Notices and License Agreements on Page 715. © 2012 Cambium Networks, Inc. All Rights Reserved.

Table of Contents Accuracy...................................................................................................................................... 2 Copyrights ................................................................................................................................... 2 Restrictions ................................................................................................................................. 2 License Agreements.................................................................................................................... 2

About This User Guide ..................................................................................43 1.1

Continuing Features...................................................................................................... 43

1.2

Features New in Release 4.0......................................................................................... 44

1.3

Clarifications ................................................................................................................. 46

1.4

References to Other WM Documents .......................................................................... 46

1.5

Links to Other Important Documents........................................................................... 47

1.6

Feedback on This Guide ................................................................................................ 48

Supported Device Types ................................................................................49 2.1

Cambium Networks Device Types ................................................................................ 49

2.2

Generic Elements (Non‐Cambium Devices).................................................................. 51

2.3

Subordinate WM Servers.............................................................................................. 53

Launching the Client ......................................................................................61 3.1

Dependencies ............................................................................................................... 61

3.2

Corporate Networks ..................................................................................................... 61

3.3

Launch Procedures........................................................................................................ 62

3.4

Configuring the Proxy on the WM Client...................................................................... 65

3.4.1 3.4.2 3.4.3

Setting Proxy Information in the Java Control Panel ............................................................ 66 Setting Proxy Information in the Web Browser .................................................................... 68 Troubleshooting an "Unable to launch the application" Error ............................................. 69

3.5

Configuring Your Password........................................................................................... 72

3.6

Troubleshooting an Unsuccessful Login ....................................................................... 73

Using the Client Window................................................................................75 4.1

Using the Toolbar.......................................................................................................... 75

4.2

Using the Alarm Summary Views.................................................................................. 77

4.3

Using the Status Bar...................................................................................................... 78

4.4

Using the Display Panel................................................................................................. 78

4.5

Using the Menu Bar ...................................................................................................... 79

4.6

Using the Help Menu .................................................................................................... 80

4.6.1 4.6.2 4.6.3

4.7

About Wireless Manager....................................................................................................... 80 Help Contents........................................................................................................................ 85 Diagnostics ............................................................................................................................ 86

Managing Client Windows............................................................................................ 86

4.7.1 4.7.2 4.7.3 4.7.4

4.8

Navigating through Active Windows..................................................................................... 86 Detaching a Window from the Client.................................................................................... 86 Saving Location and Size of Windows ................................................................................... 87 Closing All Open Windows .................................................................................................... 87

Using the Applications Tree .......................................................................................... 87

4.8.1 4.8.2 4.8.3

Custom Views ........................................................................................................................ 90 Frame Operations.................................................................................................................. 92 Administration Tools ............................................................................................................. 92

4.9

Using the Search Utility................................................................................................. 92

4.10

Performing Table View Operations ............................................................................ 102

4.10.1 4.10.2 4.10.3 4.10.4 4.10.5 4.10.6 4.10.7

4.11

Importing Data Files Into WM .................................................................................... 105

4.12

Exporting Data Files From WM................................................................................... 108

4.12.1 4.12.2 4.12.3

4.13

Exporting Device Discovery Information ........................................................................ 109 Exporting User Account Information .............................................................................. 111 Exporting Network Hierarchy Information ..................................................................... 113

Recovering from a Lost Connection to the Server...................................................... 114

Monitoring the System Dashboard.................................................................115 5.1

Dashboard Refreshes.................................................................................................. 115

5.2

Dashboard Display Options ........................................................................................ 116

5.3

Strategic Use of the Dashboard .................................................................................. 118

5.3.1 5.3.2

Navigating Through a Table ............................................................................................ 103 Setting the Page Length for a Table................................................................................ 104 Refreshing the Page View ............................................................................................... 104 Viewing a Range of Table Details.................................................................................... 104 Sorting Table Details ....................................................................................................... 104 Rearranging and Resizing Columns in a Table ................................................................ 105 Viewing Row Details ....................................................................................................... 105

Click‐throughs From the Dashboard ................................................................................... 119 Sortable Table Displays ....................................................................................................... 120

Using an Inventory View ...............................................................................121 6.1 6.1.1 6.1.2

Inventory View Edit Menu Options ............................................................................ 123 Delete Object and Traces .................................................................................................... 123 Clear Alarms ........................................................................................................................ 123

6.1.3 6.1.4

Delete Alarms ...................................................................................................................... 123 Search.................................................................................................................................. 123

6.2

Inventory Custom Views............................................................................................. 126

6.3

Topology Data Exports................................................................................................ 136

6.4

Operations on a Device............................................................................................... 137

6.5

Operations on a Network ........................................................................................... 142

6.5.1 6.5.2 6.5.3 6.5.4

Start/Stop Discovery ........................................................................................................... 142 Status Update for the Network ........................................................................................... 143 Delete Object and Traces of the Network........................................................................... 143 Credential Manager for the Network.................................................................................. 143

Using the Physical Map ................................................................................145 7.1

Importing the Geo‐locations....................................................................................... 145

7.2

Importing Addresses................................................................................................... 148

7.3

Displaying the Physical Map ....................................................................................... 150

7.3.1 7.3.2

Available Formats for Online Maps..................................................................................... 151 Format of Offline Maps ....................................................................................................... 151

7.4

Generating a Physical Map View of an Element Selected in the Inventory View ...... 154

7.5

Viewing Collocated and Proximal Elements ............................................................... 155

7.6

Panning ....................................................................................................................... 159

7.7

Jumping to a Different Position in a Physical Map ..................................................... 160

7.8

Refreshing a Physical Map .......................................................................................... 160

7.9

Setting Physical Map Options ..................................................................................... 161

7.9.1 7.9.2 7.9.3 7.9.4 7.9.5

7.10

Selecting Links, Coverage, and Standards Types to Display on a Map Type ....................... 161 Using the RSSI Auto‐Threshold Feature .............................................................................. 169 Filtering the Icons to Display by Current Alarm Level ......................................................... 169 Setting Whether Elements Appear Based on Zoom............................................................ 170 Using or Hiding Other Physical Map Overlays..................................................................... 171

Viewing Details in the Physical Map ........................................................................... 174

7.10.1 7.10.2 7.10.3 7.10.4

Accessing Data for a Device in the Physical Map............................................................ 174 Accessing the Geolocation of a Selected Point or Device in the Physical Map .............. 179 Accessing the Street View of a Selected Point or Device in the Physical Map ............... 180 Accessing a Physical Map Device in Other Management Views..................................... 181

7.11

Importing a BroadbandPlanner Prediction................................................................. 182

7.12

Changing the Geolocation for a Device ...................................................................... 182

7.13

Checking the Log of a Physical Map............................................................................ 184

7.14

Exporting a Map.......................................................................................................... 184

7.15

Exporting Devices to BroadbandPlanner .................................................................... 190

7.16

Exporting the Network into XML ................................................................................ 191

7.17

Exporting Locations for Use in a Child WM ................................................................ 192

7.18

Notices Regarding Physical Maps ............................................................................... 192

Viewing Information About a Specific Device ..................................................195 8.1 8.1.1 8.1.2

Updating Status on Demand ............................................................................................... 195 Adjusting the Status Polling Intervals.................................................................................. 195

8.2

Viewing Basic Properties............................................................................................. 198

8.3

Viewing Component Properties.................................................................................. 200

8.4

Viewing Events for a Device........................................................................................ 201

8.5

Viewing Alarms for a Device ....................................................................................... 202

8.6

Viewing Performance Data for a Device..................................................................... 203

8.7

Viewing the Dashboard for a Device .......................................................................... 204

8.7.1 8.7.2 8.7.3

8.8 8.8.1 8.8.2 8.8.3 8.8.4

8.9

Updating the Status of a Device or a Network ........................................................... 195

Examples of Network Element Dashboards ........................................................................ 204 Features of Network Element Dashboards ......................................................................... 219 Interactive Components of Network Element Dashboards ................................................ 221

Viewing a Device Summary Report............................................................................. 223 Running a Device Summary Report on Demand ................................................................. 223 Running a Device Summary Report on a Schedule ............................................................. 226 Saving a Device Summary Report........................................................................................ 226 Deleting a Device Summary Report .................................................................................... 227

Finding the Customer Assigned to the Device............................................................ 227

Performing Other Operations on Devices .......................................................229 9.1

Keeping Device Identifiers Unique ............................................................................. 229

9.2

Managing or Unmanaging a Device............................................................................ 229

9.3

Pinging a Device .......................................................................................................... 230

9.4

Dropping a Subscriber Session.................................................................................... 232

9.5

Checking Relationships Presumed Based On Geo‐locations ...................................... 232

9.6

Removing a Relationship ............................................................................................ 233

9.7

Adding Relationships Among Devices......................................................................... 234

9.7.1 9.7.2

9.8 9.8.1

Defining a Larger Extended Family...................................................................................... 234 Adding a Single Relationship ............................................................................................... 235

Importing a Customer Contact Database ................................................................... 238 Preparing the Customer Contact Data for Import .............................................................. 238

9.8.2

Importing Customer Contact Data ...................................................................................... 240

9.9

Assigning a Customer to a Device............................................................................... 242

9.10

Editing or Removing a Customer Record.................................................................... 246

9.11

Sending an Email Notification to a Customer............................................................. 247

9.12

Refreshing Device Data............................................................................................... 248

9.13

Setting WM Credentials for a Group of Selected Devices .......................................... 248

9.14

Configuring a Device ................................................................................................... 250

9.15

Syncing the SNMP String in WM with the SNMP String in a Device........................... 250

9.16

Using the Link Capacity Test Utility ............................................................................ 250

9.16.1 9.16.2 9.16.3

9.17

Launching a Link Capacity Test ....................................................................................... 250 Interpreting Link Capacity Test Results........................................................................... 253 Errors in the Link Capacity Test Feature ......................................................................... 254

Using the Spectrum Analyzer Utility........................................................................... 254

9.17.1 9.17.2 9.17.3

Launching Spectrum Analyzer......................................................................................... 254 Interpreting Spectrum Analyzer Results ......................................................................... 256 Errors in the Spectrum Analyzer Feature........................................................................ 257

9.18

Accessing the Web Interface of a Device ................................................................... 257

9.19

Deleting an Object and Traces.................................................................................... 261

9.20

Using the Bandwidth and Authentication Manager (BAM) Subsystem ..................... 262

9.20.1 9.20.2 9.20.3

Managing Authentication ............................................................................................... 264 Managing Bandwidth...................................................................................................... 266 Managing VLANs ............................................................................................................. 274

9.21

Running a User‐defined Script .................................................................................... 282

9.22

Uploading RADIUS AAA Certificates ........................................................................... 284

9.23

Upgrading Devices On Demand.................................................................................. 287

9.23.1 9.23.2 9.23.3 9.23.4 9.23.5

Launching the Software Upgrade Interface.................................................................... 287 Configuring the PMP/PTP Software Upgrade ................................................................. 288 Launching the On‐Demand Software Upgrade............................................................... 297 Reviewing the Relevant Post‐Upgrade Information About the Device(s) ...................... 297 Resetting Location Attributes for PTP 300 and PTP 500 Devices ................................... 297

Creating and Using Device Groups.............................................................299

10.1

Creating a Dynamic Device Group .............................................................................. 305

10.2

Modifying a Dynamic Device Group ........................................................................... 308

10.3

Creating a Static Device Group ................................................................................... 309

10.4

Adding Devices to a Static Device Group.................................................................... 314

10.5

Removing Devices from a Static Device Group .......................................................... 315

10.6

Adding or Removing Columns in a Device Group Window ........................................ 317

10.7

Using a Device Group.................................................................................................. 318

10.8

Removing a Device Group........................................................................................... 319

Obtaining Device Configuration Information ................................................321

11.1

Adjusting Configuration Polling Intervals ................................................................... 321

11.1.1 11.1.2

11.2

Creating and Using Device Configuration Reports ..................................................... 323

11.2.1 11.2.2 11.2.3 11.2.4 11.2.5 11.2.6 11.2.7 11.2.8 11.2.9

11.3

Importing Configuration Report Templates.................................................................... 324 Accessing a Predefined Report on Configured Values.................................................... 325 Creating a Configuration Report..................................................................................... 326 Running a Configuration Report ..................................................................................... 331 Finding a Configuration Report Template ...................................................................... 334 Editing a Configuration Report Template ....................................................................... 335 Exporting a Configuration Report Template................................................................... 337 Exporting All Configuration Report Templates ............................................................... 337 Deleting a Configuration Report ..................................................................................... 337

Using Configuration Summary Reports ...................................................................... 339

11.3.1 11.3.2

Disabling Configuration Polling....................................................................................... 321 Setting Intervals for a Small Network ............................................................................. 321

Using a Configuration Summary Report as Preconfigured ............................................. 342 Customizing a Configuration Summary Report .............................................................. 343

Monitoring Faults .....................................................................................345

12.1

Working with Events................................................................................................... 345

12.1.1 12.1.2 12.1.3 12.1.4 12.1.5 12.1.6 12.1.7 12.1.8 12.1.9 12.1.10

12.2

Viewing All Events for a Specific Device ......................................................................... 346 Viewing All Events in the System .................................................................................... 347 Interpreting Event Messages .......................................................................................... 348 Viewing Event Details ..................................................................................................... 350 Finding an Event.............................................................................................................. 353 Viewing Related Alarms .................................................................................................. 354 Viewing All Events Related to Discovery......................................................................... 354 Defining an Events Custom View .................................................................................... 356 Exporting Events to a CSV File ........................................................................................ 362 Printing Events ................................................................................................................ 363

Handling Alarms.......................................................................................................... 364

12.2.1 12.2.2 12.2.3 12.2.4

Viewing All Alarms for a Specific Device ......................................................................... 364 Viewing All Alarms in the System ................................................................................... 365 Viewing Alarm Details ..................................................................................................... 366 Searching Alarms ............................................................................................................ 368

12.2.5 12.2.6 12.2.7 12.2.8 12.2.9 12.2.10 12.2.11 12.2.12 12.2.13 12.2.14 12.2.15

Viewing Related Events................................................................................................... 368 Picking Up / Unpicking an Alarm..................................................................................... 368 Adding Comments to an Alarm....................................................................................... 370 Viewing Alarm History .................................................................................................... 371 Viewing Both Annotation and History of an Alarm ........................................................ 371 Defining an Alarms Custom View.................................................................................... 372 Saving Alarms.................................................................................................................. 376 Exporting Alarms............................................................................................................. 377 Printing Alarms................................................................................................................ 377 Clearing an Alarm............................................................................................................ 377 Deleting an Alarm ........................................................................................................... 377

Monitoring Performance ...........................................................................379

13.1

Adjusting the Performance Polling Intervals .............................................................. 379

13.2

List of Available Performance Statistics (Configured Collection) ............................... 382

13.3

Performance Data Viewing Alternatives .................................................................... 384

13.3.1 13.3.2

13.4

Using System Reports ................................................................................................. 388

13.4.1 13.4.2 13.4.3

13.5

Viewing a Current Performance Statistic........................................................................ 385 Viewing a Collected Performance Statistic ..................................................................... 386 Importing System Reports .............................................................................................. 396 Using a System Report As Preconfigured ....................................................................... 396 Customizing a System Report ......................................................................................... 397

Launching an Operator‐defined Report...................................................................... 397

Administering Discovery ...........................................................................399

14.1

Importing Device Discovery Information.................................................................... 399

14.2

Using the Discovery Configurator............................................................................... 400

14.2.1 14.2.2 14.2.3 14.2.4 14.2.5

Opening the Discovery Configurator .............................................................................. 401 Discovering Mixed Networks .......................................................................................... 402 Configuring General Automatic Discovery...................................................................... 402 Configuring Criteria‐based Automatic Discovery............................................................ 428 Closing the Discovery Configurator ................................................................................ 432

14.3

Configuring Manual Discovery.................................................................................... 432

14.4

Stages of Discovery ..................................................................................................... 432

14.5

Viewing the Discovery Log .......................................................................................... 433

Administering Wireless Manager Security ....................................................435

15.1

Importing User Account Information ......................................................................... 437

15.2

Managing Users .......................................................................................................... 438

15.2.1 15.2.2 15.2.3 15.2.4 15.2.5 15.2.6 15.2.7

15.3

Managing Groups........................................................................................................ 455

15.3.1 15.3.2 15.3.3 15.3.4 15.3.5

15.4

Adding Groups ................................................................................................................ 456 Assigning Users to Groups .............................................................................................. 458 Deleting Users from Groups ........................................................................................... 459 Using Custom View Scopes ............................................................................................. 459 Deleting a Group............................................................................................................. 466

Managing Operations ................................................................................................. 467

15.4.1 15.4.2 15.4.3 15.4.4 15.4.5 15.4.6 15.4.7 15.4.8 15.4.9 15.4.10 15.4.11 15.4.12 15.4.13 15.4.14 15.4.15 15.4.16 15.4.17

15.5

Limiting a User to Read Only .......................................................................................... 438 Adding a User.................................................................................................................. 439 Changing a User Profile................................................................................................... 445 Assigning Groups to a User ............................................................................................. 447 Changing a User Password.............................................................................................. 448 Deleting a User................................................................................................................ 449 Using Audit Trails ............................................................................................................ 450

Default Operations.......................................................................................................... 468 Configuration .................................................................................................................. 469 Events.............................................................................................................................. 470 Policy............................................................................................................................... 470 Poll Filters........................................................................................................................ 471 Polling Object.................................................................................................................. 471 Polling Units .................................................................................................................... 472 Provisioning..................................................................................................................... 472 Administrative Operation ............................................................................................... 473 Reports............................................................................................................................ 477 Threshold Object............................................................................................................. 477 Topology ......................................................................................................................... 478 Trap Parsers and Filters .................................................................................................. 479 Alerts............................................................................................................................... 479 Task Scheduler Operation............................................................................................... 481 Device Tools .................................................................................................................... 481 Ultralight Client Support ................................................................................................. 481

Assigning Operations .................................................................................................. 482

15.5.1 15.5.2

Assigning Permitted Operations for a Group.................................................................. 482 Assigning Permitted Operations for a User .................................................................... 484

15.6

Adding Operations ...................................................................................................... 484

15.7

Deleting Operations.................................................................................................... 486

16 16.1

Administering Fault Management ...............................................................489 Administering Trap Parsers......................................................................................... 489

16.1.1 16.1.2 16.1.3 16.1.4 16.1.5 16.1.6

16.2

Using Event Parsers .................................................................................................... 499

16.2.1 16.2.2 16.2.3 16.2.4 16.2.5 16.2.6 16.2.7

16.3

Opening the Alarm Filter Configuration Tool ................................................................. 525 Adding an Alarm Filter .................................................................................................... 526 Reordering the Alarm Filter Configuration List............................................................... 531 Loading an Alarm Filter................................................................................................... 532 Modifying an Alarm Filter ............................................................................................... 532 Deleting an Alarm Filter .................................................................................................. 533

Performing Alarm Operations..................................................................................... 534

16.5.1 16.5.2

16.6

Opening the Event Filter Configuration Tool .................................................................. 510 Adding an Event Filter..................................................................................................... 510 Reordering the Event Filter Configuration List ............................................................... 522 Loading an Event Filter ................................................................................................... 522 Modifying an Event Filter................................................................................................ 523 Deleting an Event Filter................................................................................................... 524

Using Alarm Filters...................................................................................................... 524

16.4.1 16.4.2 16.4.3 16.4.4 16.4.5 16.4.6

16.5

Opening the Event Parser Configuration Tool ................................................................ 500 Adding an Event Parser................................................................................................... 500 Reordering the Configured Event Parser List.................................................................. 505 Loading an Event Parser from a Parser File .................................................................... 506 Modifying an Event Parser.............................................................................................. 506 Saving an Event Parser.................................................................................................... 508 Deleting an Event Parser................................................................................................. 508

Using Event Filters ...................................................................................................... 509

16.3.1 16.3.2 16.3.3 16.3.4 16.3.5 16.3.6

16.4

Opening the Trap Parser Configuration Tool.................................................................. 490 Adding a Trap Parser....................................................................................................... 491 Reordering the Configured Trap Parser List ................................................................... 497 Viewing Trap Parser Details ............................................................................................ 497 Modifying Trap Parsers ................................................................................................... 498 Deleting a Trap Parser..................................................................................................... 499

Deleting an Alarm ........................................................................................................... 534 Grouping Triggered Alarms............................................................................................. 535

Assigning Fault Management Privileges ..................................................................... 535

Administering Performance Management.....................................................543

17.1

Data Collection............................................................................................................ 543

17.1.1 17.1.2 17.1.3 17.1.4

Elements Involved in Data Collection ............................................................................. 544 Data Collection Process .................................................................................................. 545 Creating a Polling Object................................................................................................. 546 Modifying a Polling Object.............................................................................................. 555

17.1.5

17.2

Administering Individual Statistics.............................................................................. 559

17.2.1 17.2.2 17.2.3 17.2.4

17.3

Adding a Statistic ............................................................................................................ 559 Finding a Statistic ............................................................................................................ 565 Modifying a Statistic ....................................................................................................... 566 Deleting a Statistic .......................................................................................................... 567

Administering Extended PolledData........................................................................... 568

17.3.1 17.3.2

17.4

Deleting a Polling Object................................................................................................. 558

Modifying Extended PolledData ..................................................................................... 568 Factors for Whether a Statistic is Polled......................................................................... 569

Associating Thresholds With Statistics and Network Elements ................................. 569

17.4.1 17.4.2 17.4.3 17.4.4 17.4.5 17.4.6 17.4.7 17.4.8 17.4.9 17.4.10 17.4.11

Adding a Threshold ......................................................................................................... 571 Preparing to Map a Threshold ........................................................................................ 577 Mapping a Threshold for an Individual Device ............................................................... 578 Associating a Threshold with a Statistic for an Individual Device................................... 580 Mapping a Threshold for a Specific Type Device ............................................................ 582 Mapping a Threshold for a Device Type ......................................................................... 583 Associating One or More Thresholds with a Polling Object for a Device Type............... 584 Modifying a Threshold .................................................................................................... 589 Deleting a Threshold....................................................................................................... 590 Example Strategy for Choosing and Applying Thresholds .............................................. 591 Interpreting Messages on Multiple Thresholds for a Single Statistic ............................. 592

17.5

Defining a Performance Custom View........................................................................ 592

17.6

Optimizing Performance Data Storage ....................................................................... 600

Administering a Policy ..............................................................................603

18.1

Adding a Policy............................................................................................................ 606

18.2

Scheduling a Policy...................................................................................................... 607

18.3

Updating a Policy ........................................................................................................ 608

18.4

Refreshing the Policies................................................................................................ 608

18.5

Executing a Policy ....................................................................................................... 608

18.6

Stopping a Policy......................................................................................................... 609

18.7

Deleting a Policy.......................................................................................................... 610

Configuring Network Elements...................................................................611

19.1

Using the Configure Device Command....................................................................... 611

19.2

Using Configuration Templates .................................................................................. 618

19.2.1 19.2.2

Importing a Configuration Template .............................................................................. 618 Pushing Values from a Prestructured Configuration Template...................................... 619

19.2.3 19.2.4 19.2.5 19.2.6 19.2.7 19.2.8 19.2.9 19.2.10

Creating a Configuration Template................................................................................. 621 Applying a Configuration Template ................................................................................ 626 Finding a Configuration Template .................................................................................. 628 Editing a Configuration Template ................................................................................... 629 Pushing Configuration Values Upon Discovery............................................................... 631 Exporting a Configuration Template............................................................................... 633 Exporting All Configuration Templates ........................................................................... 634 Deleting a Configuration Template................................................................................. 634

19.3

Cloning a Device Configuration................................................................................... 635

19.4

Launching BAM ........................................................................................................... 640

19.5

Using Certain Device Type‐specific Configuration Dialogs ......................................... 641

19.5.1

Configuring an EtherWAN Switch ................................................................................... 641

Scheduling a One-Time or Periodic Task.....................................................647

20.1

Schedulable Tasks ....................................................................................................... 647

20.2

Launching the Task Scheduler .................................................................................... 652

20.3

Defining the Task to Perform...................................................................................... 653

20.4

Viewing Configured Tasks ........................................................................................... 673

20.5

Editing the Definition of a Configured Task................................................................ 677

20.6

Rescheduling or Triggering a Scheduled Task............................................................. 677

20.7

Pausing or Resuming a Scheduled Task ...................................................................... 678

20.8

Retaining or Removing a Scheduled Task................................................................... 678

20.9

Stopping a Running Task............................................................................................. 679

Broadcasting a Message ............................................................................681

Administering Wireless Manager ................................................................683

22.1

Terminating a Client Session....................................................................................... 683

22.2

Using the WM Administrator Tool.............................................................................. 683

22.2.1 22.2.2 22.2.3 22.2.4 22.2.5 22.2.6 22.2.7

22.3

Using the WM Server Panel ............................................................................................ 684 Configuring the BAM Panel............................................................................................. 685 Configuring the Database Panel ..................................................................................... 686 Using the Licensing Panel ............................................................................................... 687 Configuring the NBI Panel............................................................................................... 690 Using the Offline Physical Map Panel ............................................................................. 691 Configuring the Email Configuration Panel..................................................................... 693

Configuring Log Settings ............................................................................................. 694

22.3.1 22.3.2

Opening the Log File Configuration Tool ........................................................................ 694 Adding Log Files .............................................................................................................. 696

22.3.3 22.3.4 22.3.5 22.3.6

Viewing Details of Log Files............................................................................................. 696 Modifying Log File Settings ............................................................................................. 697 Using Debug Mode ......................................................................................................... 701 Logging JVM Monitoring Details ..................................................................................... 702

Monitoring WM and Its Networks Through Wireless Manager Ultralight..........703

23.1

Accessing Wireless Manager Ultralight ...................................................................... 703

23.2

Using the What's Up Web Page .................................................................................. 704

23.3

Using the Summary View............................................................................................ 708

23.4

Using the Inventory View in Wireless Manager Ultralight ......................................... 711

23.5

Using the Alarms View in Wireless Manager Ultralight ............................................. 712

23.6

Using the Events View in Wireless Manager Ultralight .............................................. 713

23.7

Using the Customer Info View in Wireless Manager Ultralight.................................. 714

23.8

Using the Logs View in Wireless Manager Ultralight.................................................. 714

23.9

Terminating the Wireless Manager Ultralight Session............................................... 714

Legal Notices and License Agreements .................................................................715 CAMBIUM NETWORKS, LTD END USER LICENSE AGREEMENT............................................... 715 CAMBIUM PUBLICLY AVAILABLE SOFTWARE LEGAL NOTICES AND END USER LICENSE AGREEMENTS FOR PUBLICLY AVAILABLE SOFTWARE ............................................................ 720 Software Included by Cambium.............................................................................................. 721 Packages That Use Apache License Version 2.0 ..................................................................... 725 THIRD PARTY PUBLICLY AVAILABLE SOFTWARE LEGAL NOTICES AND END USER LICENSE AGREEMENTS FOR PUBLICLY AVAILABLE SOFTWARE ............................................................ 729 Software Included by Commercial Third Party Software ....................................................... 730 Packages That Use GNU Lesser General Public License Version 2.1 ...................................... 736 Packages That Use Apache Software License Version 1.1...................................................... 744

Glossary ...........................................................................................................747 Technical Support..............................................................................................749 Running the Customer Support Tool ...................................................................................... 749 Options for Running the Support Tool ............................................................................................. 749 Populating the Fields of the Customer Support Tool Window ........................................................ 751

Viewing and Saving Files That are Useful for Support............................................................ 757 Contacting Support Representatives...................................................................................... 758

Index................................................................................................................761

List of Figures Figure 1: Server disk free space monitoring window for a child WM element .......................................... 54 Figure 2: Disk usage monitoring window for a child WM element ............................................................ 54 Figure 3: Disk I/O monitoring window for a child WM element................................................................. 55 Figure 4: Database disk usage monitoring window for a child WM element............................................. 55 Figure 5: Memory utilization monitoring window for a child WM element............................................... 56 Figure 6: Database disk free space monitoring window for a child WM element ..................................... 56 Figure 7: CPU utilization monitoring window for a child WM element...................................................... 57 Figure 8: Element Properties for a subordinate WM server, General tab.................................................. 58 Figure 9: Element Properties for a subordinate WM server, SNMP tab..................................................... 58 Figure 10: Element Properties for a subordinate WM server, Monitoring tab .......................................... 59 Figure 11: Element Properties for a subordinate WM server, Relationship tab ........................................ 59 Figure 12: Web page for WM Web Start client invoke (LoginPage.do) ...................................................... 62 Figure 13: WM Authentication dialog......................................................................................................... 63 Figure 14: WM Authentication advanced options...................................................................................... 64 Figure 15: WM application initial view ....................................................................................................... 65 Figure 16: Possible relationships between client and server ..................................................................... 65 Figure 17: Java Control Panel, General tab................................................................................................. 66 Figure 18: Network Settings window in Java Control Panel ....................................................................... 67 Figure 19: Advanced Network Settings window in Java Control Panel ...................................................... 67 Figure 20: Network tab in Firefox Options window.................................................................................... 68 Figure 21: Connection Settings window in Firefox ..................................................................................... 69 Figure 22: General tab of Java Control Panel.............................................................................................. 70 Figure 23: Temporary Files Settings window in Java Control Panel ........................................................... 71 Figure 24: Delete Temporary Files window in Java Control Panel............................................................. 71 Figure 25: Password Confirmation window................................................................................................ 72 Figure 26: PasswordConfigurator dialog..................................................................................................... 73 Figure 27: Client window, example............................................................................................................. 75 Figure 28: Toolbar when Dashboard is displayed ....................................................................................... 76 Figure 29: Toolbar when Network Events are displayed ............................................................................ 76 Figure 30: Toolbar when Alarms are displayed .......................................................................................... 76 Figure 31: Toolbar when Configured Collection is displayed...................................................................... 76

Figure 32: Toolbar when Templates view is displayed ............................................................................... 76 Figure 33: Toolbar when Inventory view is displayed ................................................................................ 76 Figure 34: Toolbar when Reports are displayed ......................................................................................... 76 Figure 35: Toolbar when Scheduled Tasks are displayed ........................................................................... 76 Figure 36: Toolbar when Policies view is displayed .................................................................................... 76 Figure 37: Alarm summary views................................................................................................................ 77 Figure 38: View of devices under Warning ................................................................................................. 78 Figure 39: Severe alarm counts .................................................................................................................. 78 Figure 40: About window, License tab........................................................................................................ 80 Figure 41: License Manager web interface................................................................................................. 81 Figure 42: Change Password panel, License Manager Administrator Tool ................................................ 82 Figure 43: About window, Device Details tab............................................................................................. 83 Figure 44: About window, Client Details tab .............................................................................................. 84 Figure 45: About window, Supported Device Templates tab ..................................................................... 85 Figure 46: Expanded view of the Applications tree .................................................................................... 89 Figure 47: Example parent custom view with child view............................................................................ 91 Figure 48: Custom view nodes in Applications tree.................................................................................... 91 Figure 49: Search results for input Statistic Name contents ...................................................................... 94 Figure 50: Search results for input Message contents ............................................................................... 95 Figure 51: Search results for input Source contents................................................................................... 96 Figure 52: Search results for input network Name (ID) .............................................................................. 96 Figure 53: Search results for input IP Address contents............................................................................. 97 Figure 54: Search results for input Alarm Message contents ..................................................................... 98 Figure 55: Search results for input Device Name contents ........................................................................ 98 Figure 56: Search results for input Location contents ................................................................................ 99 Figure 57: Search results for input Name (ID) contents ............................................................................. 99 Figure 58: Search results for input Device Group Name contents ........................................................... 100 Figure 59: Search results for input Address1 contents............................................................................. 100 Figure 60: Alarms table view..................................................................................................................... 103 Figure 61: Select operation window ......................................................................................................... 107 Figure 62: Import information windows................................................................................................... 107 Figure 63: Select file window .................................................................................................................... 108 Figure 64: Dashboard Alarms by Severity display..................................................................................... 116

Figure 65: Dashboard Alarms by Device Type display .............................................................................. 116 Figure 66: Dashboard Recent Alarms display ........................................................................................... 116 Figure 67: Dashboard Alarms by Message display.................................................................................... 117 Figure 68: Dashboard Device Counts display............................................................................................ 117 Figure 69: Dashboard Help display, Useful Links and License tabs........................................................... 117 Figure 70: Dashboard Help display, Device Details and Settings tabs ...................................................... 118 Figure 71: Clear Alarms Included .............................................................................................................. 118 Figure 72: Clear Alarms Hidden ................................................................................................................ 118 Figure 73: Inventory view ......................................................................................................................... 121 Figure 74: Device types list in Applications tree, example ....................................................................... 122 Figure 75: Alarms Search dialog, sort options .......................................................................................... 124 Figure 76: Alarms Search dialog, input options ........................................................................................ 124 Figure 77: Alarms Search dialog, More options........................................................................................ 125 Figure 78: Alarms Search operation, alarms returned, example.............................................................. 125 Figure 79: Properties tab for an inventory custom view, first form ......................................................... 127 Figure 80: Properties tab for an inventory custom view, second form .................................................... 128 Figure 81: Properties tab for an inventory custom view, third form........................................................ 129 Figure 82: Properties tab for an inventory custom view, fourth form ..................................................... 130 Figure 83: Properties tab for an inventory custom view, fifth form......................................................... 131 Figure 84: Additional custom view criteria dialog, Properties tab ........................................................... 132 Figure 85: Criteria dialog with three properties ....................................................................................... 133 Figure 86: Select Table Columns dialog for inventory custom view ......................................................... 134 Figure 87: User defined table columns window for inventory custom view............................................ 134 Figure 88: Tree Node Properties tab for inventory custom view ............................................................. 135 Figure 89: Export Data dialog.................................................................................................................... 136 Figure 90: Right‐click options common for all elements .......................................................................... 137 Figure 91: Configuration Control dialog for PMP 320 AP ......................................................................... 140 Figure 92: Configure Mode dialog for PMP 320 AP, default values.......................................................... 140 Figure 93: Configure Mode dialog for PMP 320 AP, Mode BW selections ............................................... 141 Figure 94: Configure Mode dialog for PMP 320 AP, Mode Ratio selections ............................................ 141 Figure 95: Configure Mode dialog for PMP 320 AP, Mode Map selections ............................................. 141 Figure 96: Networks panel view ............................................................................................................... 142 Figure 97: Geo‐location Import window................................................................................................... 147

Figure 98: Import CSV File of Geo‐Locations window............................................................................... 147 Figure 99: Location Import from Address CSV.......................................................................................... 149 Figure 100: Offline map, midwestern USA ............................................................................................... 152 Figure 101: Offline map, northeastern Illinois.......................................................................................... 152 Figure 102: Offline map, network at a plus zoom factor .......................................................................... 153 Figure 103: Offline map, network at a minus zoom factor....................................................................... 153 Figure 104: Physical map: collapsed instance of device collocation ........................................................ 155 Figure 105: Physical map: expanded instance of device collocation........................................................ 156 Figure 106: Refresh and centering options for a physical map ................................................................ 161 Figure 107: All reliability links selected for physical map ......................................................................... 164 Figure 108: Good reliability links filtered out ........................................................................................... 165 Figure 109: Good reliability links persistently filtered out from previous physical map setting.............. 166 Figure 110: Physical map: further zooming required for viewing more devices ...................................... 166 Figure 111: Physical map: All Links, No Coverage, All Air Standards, Map............................................... 167 Figure 112: Physical map: All Links, No Coverage, All Air Standards, Hybrid ........................................... 167 Figure 113: Physical map: Logical Links, No Coverage, All Air Standards, Terrain.................................... 168 Figure 114: Device data pop‐up, Main tab ............................................................................................... 175 Figure 115: Device data pop‐up, Radios tab ............................................................................................. 175 Figure 116: Device data pop‐up, Links tab, scrolling required ................................................................. 176 Figure 117: Path Profile............................................................................................................................. 177 Figure 118: Device data pop‐up, Manage tab, scrolling required ............................................................ 178 Figure 119: Device data pop‐up, Manage tab for a PTP device................................................................ 179 Figure 120: Question mark representing device of unknown type .......................................................... 179 Figure 121: Import BroadbandPlanner Prediction dialog......................................................................... 182 Figure 122: Physical map Log window, opened........................................................................................ 184 Figure 123: Exported physical map in Google Earth application, zoomed in ........................................... 186 Figure 124: Exported physical map in Google Earth application, zoomed out......................................... 187 Figure 125: Places box with Network Elements node expanded ............................................................. 188 Figure 126: Radio(s) link to information about the element .................................................................... 188 Figure 127: Information about the element in Google Earth ................................................................... 189 Figure 128: Places box with links node expanded .................................................................................... 189 Figure 129: Link information in Google Earth view .................................................................................. 190 Figure 130: Polling Configuration dialog, Status Polling tab..................................................................... 196

Figure 131: Configure Specific Type Polling dialog for status polling ....................................................... 197 Figure 132: Element Properties, General tab ........................................................................................... 198 Figure 133: Element Properties, SNMP tab .............................................................................................. 199 Figure 134: Element Properties, Monitoring tab ...................................................................................... 199 Figure 135: Element Properties, Relationship tab .................................................................................... 200 Figure 136: Show Components panel ....................................................................................................... 200 Figure 137: Component Properties window............................................................................................. 201 Figure 138: Network Events view for a single device ............................................................................... 202 Figure 139: Alarms view for a single device.............................................................................................. 202 Figure 140: Performance data Configured Collection view for a single device ........................................ 203 Figure 141: Dashboard format for PMP AP .............................................................................................. 205 Figure 142: Dashboard format for PMP SM.............................................................................................. 206 Figure 143: Dashboard format for PMP 320 AP ....................................................................................... 207 Figure 144: Dashboard format for PMP 320 CPE...................................................................................... 208 Figure 145: Dashboard format for PMP OFDM AP ................................................................................... 209 Figure 146: Dashboard format for PMP OFDM SM .................................................................................. 210 Figure 147: Dashboard format for PMP BHM........................................................................................... 211 Figure 148: Dashboard format for PMP BHS ............................................................................................ 212 Figure 149: Dashboard format for PTP 500 Master.................................................................................. 213 Figure 150: Dashboard format for PTP 800 Slave..................................................................................... 214 Figure 151: Dashboard format for CMM3 ................................................................................................ 215 Figure 152: Dashboard format for CMM4 ................................................................................................ 215 Figure 153: Dashboard format for 14‐Port Switch ................................................................................... 216 Figure 154: Dashboard format for Generic Element ................................................................................ 216 Figure 155: Dashboard format for Extreme Switch .................................................................................. 217 Figure 156: Dashboard format for RAD Switch......................................................................................... 217 Figure 157: Dashboard for a child WM element....................................................................................... 218 Figure 158: Dashboard panels without data............................................................................................. 221 Figure 159: Collected statistics window for GPS Satellites Tracked ......................................................... 222 Figure 160: Device summary report for a PMP 430 SM ........................................................................... 224 Figure 161: Device summary report for a child WM element .................................................................. 225 Figure 162: Report Results window .......................................................................................................... 226 Figure 163: Customer Contact Management window.............................................................................. 227

Figure 164: Pinging Components window, success .................................................................................. 231 Figure 165: Pinging Components window, skipped for unmanaged component .................................... 231 Figure 166: Drop Subscriber Session window for a PMP AP..................................................................... 232 Figure 167: Drop Subscriber Session for Name (ID).................................................................................. 232 Figure 168: Remove Relationship option in Extended Family window .................................................... 233 Figure 169: Remove relationship pop‐up warning ................................................................................... 234 Figure 170: Add Relationship Between Elements dialog, both devices identified ................................... 235 Figure 171: Add Relationship Between Elements dialog, one device identified ...................................... 236 Figure 172: Logical link displayed ............................................................................................................. 237 Figure 173: Circular reference error ......................................................................................................... 237 Figure 174: Select operation window ....................................................................................................... 240 Figure 175: Import Customer Contact Information window .................................................................... 241 Figure 176: Customer Contact Management window.............................................................................. 242 Figure 177: Customer Information dialog................................................................................................. 243 Figure 178: Credential Manager dialog..................................................................................................... 249 Figure 179: Link Capacity Test results window ......................................................................................... 253 Figure 180: Spectrum Analyzer window for a PMP 320 AP ...................................................................... 255 Figure 181: Spectrum Analyzer window for a PMP SM ............................................................................ 256 Figure 182: Device web page URL............................................................................................................. 257 Figure 183: Enhanced Security Configuration warning............................................................................. 258 Figure 184: Trusted sites window ............................................................................................................. 258 Figure 185: Initial web page of Subscriber Module .................................................................................. 259 Figure 186: Management home web page of a PMP Subscriber Module................................................ 260 Figure 187: Full management interface web page of PMP Subscriber Module ....................................... 261 Figure 188: Confirmation message for Delete Object and Traces operation ........................................... 262 Figure 189: Apply template dialog, imported AP templates .................................................................... 265 Figure 190: Define Configurations tab...................................................................................................... 268 Figure 191: Configuration Parameter Selection dialog for a service plan ................................................ 269 Figure 192: Configurable parameters in a service plan ............................................................................ 269 Figure 193: Confirm Update window for bandwidth service plan............................................................ 270 Figure 194: Updating Configuration window for a new service plan ....................................................... 271 Figure 195: Task Attributes window for a service plan............................................................................. 272 Figure 196: Configure Element(s) window for applying a service plan .................................................... 273

Figure 197: Configuration Parameter Selection dialog for a VLAN profile ............................................... 276 Figure 198: Configurable parameters in a VLAN profile ........................................................................... 277 Figure 199: Edit VLAN Membership dialog ............................................................................................... 278 Figure 200: Add Entry window.................................................................................................................. 278 Figure 201: Confirm Update window for VLAN profile............................................................................. 279 Figure 202: Updating Configuration window for VLAN profile................................................................. 279 Figure 203: Task Attributes window for applying a VLAN profile ............................................................. 280 Figure 204: Configure Element(s) dialog for applying a VLAN profile ...................................................... 281 Figure 205: Details for a User Script task.................................................................................................. 283 Figure 206: Schedulable Script Results window, example........................................................................ 284 Figure 207: Upload AAA Certificate dialog, initial view ............................................................................ 285 Figure 208: Upload AAA Certificate dialog, Delete Existing Certificate selected...................................... 286 Figure 209: Software Upgrade dialog ....................................................................................................... 288 Figure 210: Selected for upgrade tab ....................................................................................................... 289 Figure 211: SM Autoupdate Configuration tab......................................................................................... 290 Figure 212: HPAP Channel Bandwidth tab................................................................................................ 292 Figure 213: Package Manager dialog, no packages .................................................................................. 296 Figure 214: Package Manager dialog, packages added ............................................................................ 296 Figure 215: Add Device window for Static Selection of a device group ................................................... 299 Figure 216: Create Device Group conditions for basic Dynamic Selection of a device group.................. 300 Figure 217: Name selections for Add Advanced Criteria of a dynamic device group............................... 301 Figure 218: Device Group Details tab of the Create Device Group dialog................................................ 305 Figure 219: Devices tab of the Create Device Group dialog ..................................................................... 306 Figure 220: Devices Preview window ....................................................................................................... 307 Figure 221: Device Groups window .......................................................................................................... 307 Figure 222: Device Group Details tab of Edit Device Group dialog .......................................................... 308 Figure 223: Devices tab of Edit Device Group dialog................................................................................ 309 Figure 224: Add to Device Groups window .............................................................................................. 310 Figure 225: Devices tab of Create Device Group dialog ........................................................................... 311 Figure 226: Add Device window ............................................................................................................... 312 Figure 227: Devices selected to add ......................................................................................................... 312 Figure 228: Devices added to Devices Selected block .............................................................................. 313 Figure 229: Add to Device Groups window .............................................................................................. 314

Figure 230: Scheduled Tasks window ....................................................................................................... 319 Figure 231: Delete Group option for a device group................................................................................ 319 Figure 232: Polling Configuration dialog, Configuration Polling tab......................................................... 321 Figure 233: Configure Specific Type Polling dialog for configuration polling ........................................... 322 Figure 234: Execute Configuration Report Template panel ..................................................................... 325 Figure 235: Create Configuration Report Template dialog launched from Inventory.............................. 327 Figure 236: Create Configuration Report Template dialog launched from Applications tree.................. 328 Figure 237: Success for a create report .................................................................................................... 329 Figure 238: Select Configuration Report Data window ............................................................................ 329 Figure 239: Configuration Report View window....................................................................................... 329 Figure 240: Execute Report window......................................................................................................... 330 Figure 241: Execute Configuration Report window.................................................................................. 332 Figure 242: Search window for configuration report template criteria ................................................... 335 Figure 243: Edit Configuration Report Template window ........................................................................ 335 Figure 244: Delete Report window ........................................................................................................... 338 Figure 245: Delete Report window, reports contents .............................................................................. 338 Figure 246: System Reports view.............................................................................................................. 342 Figure 247: SM QOS Summary.................................................................................................................. 343 Figure 248: Network Events view, one device (Source) ........................................................................... 346 Figure 249: Network Events view, all Sources .......................................................................................... 347 Figure 250: Event Details window ............................................................................................................ 351 Figure 251: Search window for event criteria........................................................................................... 353 Figure 252: Discovery Events view............................................................................................................ 355 Figure 253: Event filter custom view criteria dialog, Properties tab ........................................................ 356 Figure 254: Additional custom view criteria dialog, Properties tab ......................................................... 359 Figure 255: Criteria dialog with three properties ..................................................................................... 360 Figure 256: Select Table Columns dialog for event filter view ................................................................. 360 Figure 257: User defined table columns window ..................................................................................... 361 Figure 258: Tree Node Properties tab for event filter custom view......................................................... 361 Figure 259: Export Data dialog.................................................................................................................. 363 Figure 260: Alarms view, one device (IPAddress) ..................................................................................... 365 Figure 261: Alarms view, all devices (all IPAddresses).............................................................................. 366 Figure 262: Alarms details window........................................................................................................... 367

Figure 263: Owner and Annotation in Alarm detail.................................................................................. 369 Figure 264: Alarm filter custom view criteria, Properties tab .................................................................. 372 Figure 265: Select Table Columns dialog for alarm filter view ................................................................. 375 Figure 266: Tree Node Properties tab for alarm filter custom view......................................................... 376 Figure 267: Polling Configuration dialog, Performance Polling tab.......................................................... 379 Figure 268: Configure Specific Type Polling dialog for performance polling............................................ 381 Figure 269: Configured Collection panel................................................................................................... 382 Figure 270: Current statistics window ...................................................................................................... 385 Figure 271: Collected statistics window, line graph ................................................................................. 387 Figure 272: Collected statistics window, bar graph .................................................................................. 388 Figure 273: Inventory Summary report .................................................................................................... 393 Figure 274: Device Uptime report ............................................................................................................ 394 Figure 275: Discovery Configurator, General tab ..................................................................................... 401 Figure 276: Confirmation for deselection of AutoDiscovery .................................................................... 402 Figure 277: Initial Parameters contents from the Discovery Configurator............................................... 405 Figure 278: Rediscovery Scheduler dialog ................................................................................................ 407 Figure 279: Rediscovery Scheduler, Specific Dates................................................................................... 408 Figure 280: Rediscovery Scheduler, Days of Week ................................................................................... 409 Figure 281: Discovery Configurator, Protocol tab .................................................................................... 411 Figure 282: SNMP Properties selected from the Protocol tab ................................................................. 411 Figure 283: Discovery Configurator, Network Discovery tab ................................................................... 415 Figure 284: Snmp Properties window for network discovery .................................................................. 417 Figure 285: SNMP V3 Properties tab ........................................................................................................ 419 Figure 286: Snmp V3 Properties window, General tab............................................................................. 419 Figure 287: Snmp V3 Properties window, Security tab ............................................................................ 420 Figure 288: Discovery Configurator, Node Discovery tab......................................................................... 422 Figure 289: Disabling discovery for a listed device ................................................................................... 426 Figure 290: Criteria tab, disallow discovery for type SUN and name A .................................................... 427 Figure 291: Discovery Configurator, Criteria tab ...................................................................................... 429 Figure 292: Criteria tab, allow discovery for specific name and OID........................................................ 430 Figure 293: Criteria tab, allow discovery for only SNMP nodes ............................................................... 431 Figure 294: Discovery Log ......................................................................................................................... 433 Figure 295: Failure events in the Discovery Log ....................................................................................... 433

Figure 296: Initial Security Administration Tool Screen............................................................................ 436 Figure 297: User Administration wizard, User Description panel............................................................. 440 Figure 298: User Administration wizard, account and password expiry .................................................. 441 Figure 299: User Administration wizard, permissions .............................................................................. 442 Figure 300: Assign Permissions dialog ...................................................................................................... 444 Figure 301: Security administration tabs .................................................................................................. 446 Figure 302: User Profile tab ...................................................................................................................... 446 Figure 303: User Profile dialog.................................................................................................................. 447 Figure 304: Select Groups window ........................................................................................................... 448 Figure 305: Change Password dialog ........................................................................................................ 449 Figure 306: Warning for user deletion...................................................................................................... 450 Figure 307: Auth Audit screen .................................................................................................................. 452 Figure 308: Search dialog for audit trails .................................................................................................. 454 Figure 309: AlertAudit window, with properties of an audit trail ............................................................ 455 Figure 310: Groups Wizard, Group Description panel .............................................................................. 457 Figure 311: Groups Wizard, Operations Tree ........................................................................................... 457 Figure 312: Select Users window .............................................................................................................. 458 Figure 313: Scope Settings dialog ............................................................................................................. 461 Figure 314: Select AuthorizedScopes window.......................................................................................... 464 Figure 315: AuthorizedScopes for CV panel ............................................................................................. 465 Figure 316: Warning for authorized scope deletion ................................................................................. 466 Figure 317: Warning for group deletion ................................................................................................... 466 Figure 318: Operation Tree nodes showing default user permissions ..................................................... 468 Figure 319: Operations For Group panel .................................................................................................. 482 Figure 320: Assign Permissions dialog ...................................................................................................... 483 Figure 321: Operations dialog................................................................................................................... 485 Figure 322: Warning for operation deletion............................................................................................. 487 Figure 323: Trap Parser Configuration tool .............................................................................................. 490 Figure 324: Trap Parser Configuration window, Add Trap Parser operation ........................................... 491 Figure 325: Trap Parser Configuration dialog, Event User Properties ...................................................... 497 Figure 326: Event User Properties dialog ................................................................................................. 498 Figure 327: Event Parser Configuration tool............................................................................................. 500 Figure 328: Specify User properties and Trap based Criterias dialog....................................................... 505

Figure 329: Load Event Parsers From File dialog ...................................................................................... 506 Figure 330: Save Event Parser To File dialog ............................................................................................ 508 Figure 331: Event Filters dialog................................................................................................................. 510 Figure 332: Match criteria Properties dialog ............................................................................................ 511 Figure 333: Suppress Action dialog........................................................................................................... 514 Figure 334: Run Command Action dialog ................................................................................................. 515 Figure 335: Send Trap Action dialog ......................................................................................................... 517 Figure 336: Variable Binding List dialog.................................................................................................... 518 Figure 337: Send Email Action dialog........................................................................................................ 519 Figure 338: Authentication Information dialog ........................................................................................ 521 Figure 339: Filter Details dialog ................................................................................................................ 522 Figure 340: Alert Filters dialog .................................................................................................................. 525 Figure 341: Alert Filters dialog, example added ....................................................................................... 528 Figure 342: Match criteria Properties dialog ............................................................................................ 529 Figure 343: More Properties dialog .......................................................................................................... 530 Figure 344: Filter Details dialog ................................................................................................................ 532 Figure 345: Poll Details dialog, General Properties frame........................................................................ 547 Figure 346: Poll Details, Managed Object match criteria ......................................................................... 548 Figure 347: Poll Details, Data Configuration parameters ......................................................................... 550 Figure 348: Polled Details dialog, General Properties frame, active fields............................................... 556 Figure 349: Poll Details dialog, Data Configuration panel ........................................................................ 557 Figure 350: Poll Details dialog for Delete Polling Object operation ......................................................... 558 Figure 351: Confirm Deletion pop‐up ....................................................................................................... 559 Figure 352: DataCollection Detailed Properties dialog, first form............................................................ 560 Figure 353: DataCollection Detailed Properties dialog, second form....................................................... 563 Figure 354: Search window for statistic criteria ....................................................................................... 566 Figure 355: DataCollection Detailed Properties dialog for Modify Statistic operation ............................ 567 Figure 356: Thresholds and Associations dialog ....................................................................................... 572 Figure 357: Thresholds Properties dialog, long tab .................................................................................. 573 Figure 358: Threshold Properties dialog, string tab.................................................................................. 574 Figure 359: Threshold Properties dialog, percentage tab ........................................................................ 575 Figure 360: New association row added to Thresholds and Associations interface ................................ 578 Figure 361: Search Devices dialog............................................................................................................. 578

Figure 362: DataCollection Detailed Properties dialog, first set of properties......................................... 580 Figure 363: DataCollection Detailed Properties, second set of properties .............................................. 581 Figure 364: Data Collection Detailed Properties, third set of values........................................................ 582 Figure 365:Search specific type dialog, specific type selected ................................................................. 583 Figure 366: Search specific type dialog, device type selected.................................................................. 584 Figure 367: Poll Details dialog................................................................................................................... 585 Figure 368: Poll Details dialog, Data Configuration panel with read‐only fields ...................................... 586 Figure 369: Poll Details dialog, Data Configuration panel with read‐write fields..................................... 588 Figure 370: Poll Details dialog, General Properties panel ........................................................................ 589 Figure 371: Threshold Properties dialog for Modify operation ................................................................ 590 Figure 372: Threshold Properties dialog for Delete operation................................................................. 591 Figure 373: Performance custom view criteria, Properties tab, first form............................................... 593 Figure 374: Performance custom view criteria, Properties tab, second form.......................................... 595 Figure 375: Performance custom view criteria, Properties tab, third form ............................................. 597 Figure 376: Select Table Columns dialog for performance filter view...................................................... 599 Figure 377: Tree Node Properties tab for performance filter custom view ............................................. 600 Figure 378: AlarmClearingPolicy ............................................................................................................... 603 Figure 379: EscalationPolicy...................................................................................................................... 604 Figure 380: Policies panel ......................................................................................................................... 606 Figure 381: AddPolicy Details window...................................................................................................... 606 Figure 382: Policy Scheduler window ....................................................................................................... 607 Figure 383: Object Details window for policy update............................................................................... 608 Figure 384: Execute policy confirmation pop‐up...................................................................................... 609 Figure 385: List background for policies under execution........................................................................ 609 Figure 386: Stop Policy confirmation pop‐up ........................................................................................... 609 Figure 387: Configuration Group, PMP SM device ................................................................................... 612 Figure 388: Configuration Group, PMP BHM device ................................................................................ 613 Figure 389: Configuration Group, PMP 320 CPE....................................................................................... 614 Figure 390: Configuration Group, PTP 800 Slave ...................................................................................... 615 Figure 391: Configuration groups for a child WM .................................................................................... 616 Figure 392: Configuration Group attributes – IP ...................................................................................... 617 Figure 393: Apply Template dialog, 5.4‐GHz OFDM BHM device ............................................................. 619 Figure 394: Select Import Files browser for configuration templates...................................................... 621

Figure 395: Create Configuration Template example, PMP OFDM SM with RF tooltip ........................... 622 Figure 396: Create Configuration Template dialog, parameter selected via Jump To, but Include not checked.................................................................................................................................. 624 Figure 397: Create Configuration Template dialog, parameter selected and Include checked ............... 625 Figure 398: Apply Template window ........................................................................................................ 626 Figure 399: Modify Values dialog.............................................................................................................. 627 Figure 400: Devices tab............................................................................................................................. 628 Figure 401: Search window for configuration template criteria .............................................................. 629 Figure 402: Edit Template dialog for editing ............................................................................................ 630 Figure 403: Default Configuration Template Mapping dialog .................................................................. 631 Figure 404: Delete Template window....................................................................................................... 634 Figure 405: Warning pop‐up for Delete template operation ................................................................... 634 Figure 406: Clone Device dialog................................................................................................................ 635 Figure 407: Clone Device dialog, table of attributes and values .............................................................. 637 Figure 408: Select Task Type dialog .......................................................................................................... 652 Figure 409: Create Schedule Task dialog for all tasks except Configuration and Reports........................ 653 Figure 410: Create Schedule Task dialog for a Configuration or Reports task, Schedule tab................... 654 Figure 411: Create Schedule Task dialog for a Configuration or Reports task, Devices tab..................... 655 Figure 412: Add Device window ............................................................................................................... 656 Figure 413: Device Groups window .......................................................................................................... 657 Figure 414: Individual devices selected for removal ................................................................................ 658 Figure 415: Specific Type drop‐down list for Basic Dynamic Selection .................................................... 659 Figure 416: Configuration Attribute drop‐down list for Basic Dynamic Selection.................................... 660 Figure 417: Performance Attribute drop‐down list for Basic Dynamic Selection..................................... 661 Figure 418: Add Advanced Criteria window, ready for Device Properties selections .............................. 662 Figure 419: Add Advanced Criteria window, selectable Device Properties.............................................. 663 Figure 420: Add Advanced Criteria window, Configuration Attributes for a subset of Specific Types .... 664 Figure 421: Create Schedule Task window, Details tab listing configuration templates.......................... 665 Figure 422: Create Schedule Task window, Details tab open to a configuration template ..................... 666 Figure 423: Create Schedule Task dialog, Schedule tab for non‐recurring task ....................................... 668 Figure 424: Create Schedule Task dialog, Schedule tab for a minute‐based task .................................... 669 Figure 425: Create Schedule Task dialog, Schedule tab for an hourly task .............................................. 670 Figure 426: Create Schedule Task dialog, Schedule tab for a daily task ................................................... 671

Figure 427: Create Schedule Task dialog, Schedule tab for a weekly task ............................................... 672 Figure 428: Create Schedule Task dialog, Schedule tab for a monthly task ............................................. 673 Figure 429: Scheduled Tasks view for SYSTEM‐owned tasks.................................................................... 674 Figure 430: Scheduled Tasks view for user‐owned tasks.......................................................................... 675 Figure 431: Edit Scheduled Task dialog..................................................................................................... 675 Figure 432: Results tab for a scheduled task ............................................................................................ 676 Figure 433: Report Result window for report task execution .................................................................. 676 Figure 434: Options for an Active task...................................................................................................... 677 Figure 435: Paused task in Scheduled Task table view ............................................................................. 678 Figure 436: Mark for Clean Up option in Schedule tab for tasks.............................................................. 678 Figure 437: Options for an Inactive task ................................................................................................... 679 Figure 438: Broadcast Message dialog ..................................................................................................... 681 Figure 439: Clients' Details window.......................................................................................................... 683 Figure 440: WM Server panel of WM Administrator Tool........................................................................ 684 Figure 441: BAM panel of WM Administrator Tool .................................................................................. 685 Figure 442: Database panel of WM Administrator Tool........................................................................... 686 Figure 443: Licensing panel of WM Administrator Tool ........................................................................... 687 Figure 444: Upload License File dialog...................................................................................................... 688 Figure 445: License Manager Status display window ............................................................................... 689 Figure 446: NBI panel of WM Administrator Tool, active SNMP V3 settings ........................................... 690 Figure 447: NBI panel of WM Administrator Tool, active SNMP V1/V2 settings ..................................... 691 Figure 448: Offline Physical Map panel of WM Administrator Tool ......................................................... 692 Figure 449: Email Configuration panel of WM Administrator Tool .......................................................... 693 Figure 450: Logging Configuration panel .................................................................................................. 695 Figure 451: Viewing the Log Details dialog ............................................................................................... 697 Figure 452: Logging configuration window, Log Settings, first frame ...................................................... 698 Figure 453: Logging configuration window, Log Settings, second frame ................................................. 700 Figure 454: Collected statistics window with JVM monitoring history plotted........................................ 702 Figure 455: Login web page of Wireless Manager Ultralight.................................................................... 703 Figure 456: What's Up web page .............................................................................................................. 704 Figure 457: SM Device‐specific web page, top ......................................................................................... 706 Figure 458: Device‐specific web page, middle.......................................................................................... 707 Figure 459: Summary View in Wireless Manager Ultralight..................................................................... 708

Figure 460: Alarms (Major) web page in Wireless Manager Ultralight .................................................... 709 Figure 461: Events (Critical) web page in Wireless Manager Ultralight ................................................... 709 Figure 462: Individual device block in Wireless Manager Ultralight ........................................................ 709 Figure 463: Inventory view in Wireless Manager Ultralight ..................................................................... 711 Figure 464: Alarms (All) view in Wireless Manager Ultralight .................................................................. 712 Figure 465: Events (All) view in Wireless Manager Ultralight................................................................... 713 Figure 466: Logs available from Wireless Manager Ultralight.................................................................. 714 Figure 467: Support Tool Options window ............................................................................................... 750 Figure 468: Customer Support Tool dialog, General Information tab ...................................................... 751 Figure 469: Choose a File window for additional files to send to Customer Support .............................. 754 Figure 470: Customer Support Tool dialog, Devices tab with Add selected............................................. 756 Figure 471: Saved Support Files window .................................................................................................. 758

List of Tables Table 1: Structured information resources per general device type.......................................................... 49 Table 2: Troubleshooting client login issues ............................................................................................... 73 Table 3: Common toolbar options .............................................................................................................. 77 Table 4: Applications tree nodes ................................................................................................................ 87 Table 5: Input string vs. result types for Search utility ............................................................................... 93 Table 6: Table navigation buttons ............................................................................................................ 103 Table 7: Tree node properties for event filter view.................................................................................. 135 Table 8: References for common command options................................................................................ 138 Table 9: References for special command options................................................................................... 139 Table 10: Command options from a network element dashboard .......................................................... 219 Table 11: When BAM changes for subscribers are effective .................................................................... 264 Table 12: Bandwidth and VLAN element attributes ................................................................................. 266 Table 13: How VLAN settings are applied to an SM.................................................................................. 275 Table 14: Configuration Summary reports ............................................................................................... 339 Table 15: Preconfigured event messages and their severities ................................................................. 348 Table 16: General discovery events .......................................................................................................... 348 Table 17: Multi‐agent discovery events.................................................................................................... 350 Table 18: Single‐agent discovery event .................................................................................................... 350 Table 19: File import event ....................................................................................................................... 350 Table 20: Event details .............................................................................................................................. 351 Table 21: Event filter custom view criteria fields...................................................................................... 357 Table 22: Wild card characters for criteria fields...................................................................................... 358 Table 23: Tree node properties for event filter view................................................................................ 362 Table 24: Alarm details properties............................................................................................................ 367 Table 25: Alarm filter custom view criteria fields ..................................................................................... 373 Table 26: Configured Collection properties .............................................................................................. 383 Table 27: Differentiating Current and Historical Data .............................................................................. 384 Table 28: Alternatives for viewing the values of a statistic ...................................................................... 384 Table 29: Possible messages in a current performance data graph ......................................................... 386 Table 30: Possible messages for a Collected statistics window................................................................ 387 Table 31: AP performance reports............................................................................................................ 389

Table 32: PMP 320 AP performance reports ............................................................................................ 389 Table 33: SM performance reports........................................................................................................... 390 Table 34: PMP 320 CPE performance reports .......................................................................................... 391 Table 35: PMP Backhaul performance reports ......................................................................................... 392 Table 36: PTP performance reports .......................................................................................................... 392 Table 37: Format for device discovery information import...................................................................... 399 Table 38: Initial discovery parameters...................................................................................................... 406 Table 39: Discovery interval parameters .................................................................................................. 410 Table 40: SNMP configuration parameters............................................................................................... 412 Table 41: User icons .................................................................................................................................. 436 Table 42: Format for user account information import............................................................................ 437 Table 43: Audit entries for user activity events ........................................................................................ 453 Table 44: Authorized Custom View Scopes value operators .................................................................... 462 Table 45: Configuration options ............................................................................................................... 469 Table 46: Events options........................................................................................................................... 470 Table 47: Policy options ............................................................................................................................ 470 Table 48: Poll Filters options..................................................................................................................... 471 Table 49: Polling Object options ............................................................................................................... 471 Table 50: Polling Units options ................................................................................................................. 472 Table 51: Provisioning options.................................................................................................................. 472 Table 52: Administrative Operation, Services options ............................................................................. 473 Table 53: Administrative Operation, Security options.............................................................................. 475 Table 54: Other Administrative Operations options................................................................................. 476 Table 55: Configuration Reports options .................................................................................................. 477 Table 56: Threshold Object options.......................................................................................................... 477 Table 57: Topology options....................................................................................................................... 478 Table 58: Trap Parsers and Filters options................................................................................................ 479 Table 59: Alerts options ............................................................................................................................ 480 Table 60: Task Scheduler Operation options ............................................................................................ 481 Table 61: Device Tools options ................................................................................................................. 481 Table 62: Trap Parser Configuration fields ............................................................................................... 492 Table 63: Trap Protocol Data Unit fields................................................................................................... 494 Table 64: Event Parser fields..................................................................................................................... 501

Table 65: Event properties........................................................................................................................ 503 Table 66: Match Criteria fields.................................................................................................................. 511 Table 67: Match Criteria fields, Advanced dialog fields............................................................................ 511 Table 68: Suppress Action Details dialog fields ........................................................................................ 514 Table 69: Run Command Notification dialog fields .................................................................................. 515 Table 70: Send Trap Action dialog fields................................................................................................... 517 Table 71: Send Email Action Details dialog fields ..................................................................................... 519 Table 72: Email alert message properties................................................................................................. 526 Table 73: Alarm Match Criteria fields ....................................................................................................... 529 Table 74: Match criteria Properties fields................................................................................................. 529 Table 75: Common parameters ................................................................................................................ 551 Table 76: Common Data Identifier properties.......................................................................................... 552 Table 77: DataCollection Detailed Properties fields, first form ................................................................ 560 Table 78: DataCollection Detailed Properties fields, second form ........................................................... 563 Table 79: How many and what type of threshold to add ......................................................................... 570 Table 80: Ways to associate statistics with thresholds............................................................................. 570 Table 81: Data collection Threshold indicators ........................................................................................ 571 Table 82: Threshold Properties fields ....................................................................................................... 575 Table 83: Performance custom view criteria fields, first form ................................................................. 593 Table 84: Performance custom view criteria fields, second form ............................................................ 595 Table 85: Performance custom view criteria fields, third form................................................................ 597 Table 86: Configurable task prerequisites, requirements, and options ................................................... 648 Table 87: Options for scheduling of tasks................................................................................................. 667 Table 88: Log Settings panel fields, first frame......................................................................................... 699 Table 89: Log Settings panel fields, second frame.................................................................................... 700 Table 90: Support Detail levels ................................................................................................................. 753

List of Procedures Procedure 1: To launch WM ....................................................................................................................... 62 Procedure 2: To configure your password prior to client connection........................................................ 72 Procedure 3: To reconfigure your password .............................................................................................. 73 Procedure 4: To view a range of details ................................................................................................... 104 Procedure 5: To export device discovery information ............................................................................. 109 Procedure 6: To export user account information ................................................................................... 111 Procedure 7: To export network hierarchy information .......................................................................... 113 Procedure 8: To export topology data...................................................................................................... 136 Procedure 9: To view an Inventory element in the context of a physical map ........................................ 154 Procedure 10: To view an element in a cluster ........................................................................................ 156 Procedure 11: To view linked elements within the same physical map................................................... 157 Procedure 12: To export a physical map .................................................................................................. 185 Procedure 13: To set status polling for a specific device type.................................................................. 196 Procedure 14: To view device details ....................................................................................................... 198 Procedure 15: To view component details ............................................................................................... 200 Procedure 16: To view events generated for a device ............................................................................. 201 Procedure 17: To view alarms generated for a device ............................................................................. 202 Procedure 18: To view performance data of a device.............................................................................. 203 Procedure 19: To import a customer contact database ........................................................................... 240 Procedure 20: To compose a customer‐device(s) record......................................................................... 242 Procedure 21: To edit a customer‐device(s) record ................................................................................. 246 Procedure 22: To set credentials for a selected group of devices............................................................ 249 Procedure 23: To perform a link capacity test in an SM........................................................................... 250 Procedure 24: To use the Spectrum Analyzer feature.............................................................................. 254 Procedure 25: To open a device web interface ........................................................................................ 257 Procedure 26: To delete a device and all information about it ................................................................ 262 Procedure 27: To configure APs for authentication management........................................................... 264 Procedure 28: To define a service plan..................................................................................................... 268 Procedure 29: To apply a service plan ...................................................................................................... 271 Procedure 30: To update a service plan ................................................................................................... 273 Procedure 31: To remove a bandwidth service plan association ............................................................. 274

Procedure 32: To remove a service plan .................................................................................................. 274 Procedure 33: To define a VLAN profile ................................................................................................... 276 Procedure 34: To apply a VLAN profile ..................................................................................................... 279 Procedure 35: To update a VLAN profile .................................................................................................. 281 Procedure 36: To remove a VLAN profile association .............................................................................. 282 Procedure 37: To remove a VLAN profile ................................................................................................. 282 Procedure 38: To upload a AAA certificate............................................................................................... 285 Procedure 39: To create a dynamic device group .................................................................................... 305 Procedure 40: To modify a dynamic device group ................................................................................... 308 Procedure 41: To create a static device group ......................................................................................... 309 Procedure 42: To add one or more devices to an existing device group ................................................. 314 Procedure 43: To remove a device from a device group.......................................................................... 315 Procedure 44: To remove a device group................................................................................................. 319 Procedure 45: To set configuration polling for a specific device type...................................................... 322 Procedure 46: To import configuration report templates........................................................................ 324 Procedure 47: To access a configuration report template ....................................................................... 325 Procedure 48: To create a configuration report....................................................................................... 326 Procedure 49: To run a configuration report............................................................................................ 332 Procedure 50: To find a configuration report template ........................................................................... 334 Procedure 51: To edit a configuration report........................................................................................... 335 Procedure 52: To export a single configuration report template............................................................. 337 Procedure 53: To export all configuration report templates.................................................................... 337 Procedure 54: To delete a configuration report....................................................................................... 337 Procedure 55: To view event details......................................................................................................... 350 Procedure 56: To find an event ................................................................................................................ 353 Procedure 57: To view other events that have the same Failure Object ................................................. 354 Procedure 58: To export events................................................................................................................ 363 Procedure 59: To print events to the server printer................................................................................. 363 Procedure 60: To view alarm details ........................................................................................................ 366 Procedure 61: To view related events ...................................................................................................... 368 Procedure 62: To pick up an alarm from the Alarms view ....................................................................... 368 Procedure 63: To pick up an alarm from the Alarms details dialog ......................................................... 369 Procedure 64: To unpick an alarm from the Alarms view ........................................................................ 369

Procedure 65: To unpick an alarm from the Alarm details dialog ............................................................ 369 Procedure 66: To add comments to an alarm .......................................................................................... 370 Procedure 67: To view the history of an alarm......................................................................................... 371 Procedure 68: To view both annotation and history of an alarm............................................................. 371 Procedure 69: To clear a triggered alarm ................................................................................................. 377 Procedure 70: To set performance polling of a specific device type for its extraneous values ............... 380 Procedure 71: To view performance data collection details .................................................................... 382 Procedure 72: To import system reports.................................................................................................. 396 Procedure 73: To invoke the Discovery Configurator............................................................................... 401 Procedure 74: To disable auto‐discovery ................................................................................................. 402 Procedure 75: To rediscover previously discovered nodes ...................................................................... 403 Procedure 76: To prevent local network discovery .................................................................................. 403 Procedure 77: To set the discovery interval ............................................................................................. 404 Procedure 78: To set initial discovery parameters ................................................................................... 405 Procedure 79: To set the rediscovery at Regular Interval ........................................................................ 407 Procedure 80: To set rediscovery on specific dates ................................................................................. 408 Procedure 81: To set rediscovery on specific days ................................................................................... 409 Procedure 82: To configure SNMP Properties .......................................................................................... 411 Procedure 83: To configure discovery for a network of devices set to allow SNMPv1 and v3 access..... 413 Procedure 84: To configure discovery for a network of devices set to allow only SNMPv3 access......... 413 Procedure 85: To enable discovery of remote networks ......................................................................... 415 Procedure 86: To discover only a range of addresses in a network ......................................................... 416 Procedure 87: To enable DHCP support ................................................................................................... 416 Procedure 88: To discover SNMPv1 or v2c devices in a network............................................................. 417 Procedure 89: To discover SNMPv3 devices in a network........................................................................ 418 Procedure 90: To set a network‐specific SNMPv3 configuration for discovery ....................................... 420 Procedure 91: To configure discovery of a specific IP address................................................................. 422 Procedure 92: To discover nodes where LocalNet is disabled ................................................................. 423 Procedure 93: To discover SNMP devices with specific community and port ......................................... 423 Procedure 94: To discover specific SNMPv3 devices................................................................................ 424 Procedure 95: To set a device‐specific SNMPv3 configuration for discovery .......................................... 424 Procedure 96: To prevent the discovery of a specific network ................................................................ 425 Procedure 97: To prevent the discovery of an unlisted device ................................................................ 426

Procedure 98: To prevent the discovery of a listed device ...................................................................... 426 Procedure 99: To disallow discovery where type is SUN and name is A (example) ................................. 427 Procedure 100: To discover devices with specific properties................................................................... 429 Procedure 101: To discover only SNMP nodes ......................................................................................... 430 Procedure 102: To discover only the object corresponding to a specific IP............................................. 431 Procedure 103: To launch the Security Administration tool .................................................................... 435 Procedure 104: To add a new user ........................................................................................................... 439 Procedure 105: To change a user profile.................................................................................................. 445 Procedure 106: To assign groups to a user............................................................................................... 447 Procedure 107: To change a user password ............................................................................................. 448 Procedure 108: To delete a user............................................................................................................... 450 Procedure 109: To view audit trails of all users........................................................................................ 451 Procedure 110: To view audit trails of a single user................................................................................. 453 Procedure 111: To add a group ................................................................................................................ 456 Procedure 112: To assign a user to a group.............................................................................................. 458 Procedure 113: To delete a user from a group......................................................................................... 459 Procedure 114: To add a custom view scope ........................................................................................... 460 Procedure 115: To assign an authorized custom view scope ................................................................... 463 Procedure 116: To remove an authorized custom view scope ................................................................ 464 Procedure 117: To change the properties of an authorized scope .......................................................... 465 Procedure 118: To delete an authorized custom view scope................................................................... 465 Procedure 119: To delete a group ............................................................................................................ 466 Procedure 120: To assign operations for a group..................................................................................... 482 Procedure 121: To assign permitted operations for a user...................................................................... 484 Procedure 122: To add an operation ........................................................................................................ 485 Procedure 123: To delete an operation.................................................................................................... 486 Procedure 124: To open the Trap Parser Configuration tool ................................................................... 490 Procedure 125: To add a Trap Parser ....................................................................................................... 491 Procedure 126: To reorder the Configured Trap Parser List..................................................................... 497 Procedure 127: To view details of a Trap Parser ...................................................................................... 497 Procedure 128: To modify a Trap Parser .................................................................................................. 498 Procedure 129: To delete a Trap Parser ................................................................................................... 499 Procedure 130: To open the Event Parser Configuration tool.................................................................. 500

Procedure 131: To add an Event Parser.................................................................................................... 500 Procedure 132: To reorder the Configured Event Parser List................................................................... 505 Procedure 133: To load an Event Parser file............................................................................................. 506 Procedure 134: To modify an Event Parser .............................................................................................. 507 Procedure 135: To save an Event Parser file ............................................................................................ 508 Procedure 136: To delete an Event Parser ............................................................................................... 508 Procedure 137: To open the Event Filters dialog...................................................................................... 510 Procedure 138: To add an Event Filter—Criteria Phase ........................................................................... 510 Procedure 139: To add an Event Filter—Additional Criteria Phase.......................................................... 512 Procedure 140: To add an Event Filter—Notification Phase .................................................................... 513 Procedure 141: To add a varbind.............................................................................................................. 518 Procedure 142: To modify a varbind ........................................................................................................ 518 Procedure 143: To reorder the Event Filter list ........................................................................................ 522 Procedure 144: To load an Event Filter file............................................................................................... 522 Procedure 145: To modify the match criteria of an Event Filter .............................................................. 523 Procedure 146: To modify the notifications in an Event Filter ................................................................. 523 Procedure 147: To delete an event filter.................................................................................................. 524 Procedure 148: To delete a filter notification........................................................................................... 524 Procedure 149: To open the Alarm Filter Configuration Tool .................................................................. 525 Procedure 150: To add an Alarm Filter, example steps............................................................................ 526 Procedure 151: To add an Alarm Filter, criteria phase ............................................................................. 528 Procedure 152: To add an Alarm Filter, additional criteria phase............................................................ 530 Procedure 153: To add an Alarm Filter, notifications phase .................................................................... 531 Procedure 154: To reorder the Alert Filters ............................................................................................. 531 Procedure 155: To load an Alert Filter file................................................................................................ 532 Procedure 156: To modify the match criteria for an Alarm Filter ............................................................ 532 Procedure 157: To modify the notifications for an Alarm Filter............................................................... 533 Procedure 158: To delete an alarm filter.................................................................................................. 533 Procedure 159: To delete a filter notification........................................................................................... 533 Procedure 160: To delete a triggered alarm............................................................................................. 534 Procedure 161: To assign fault management privileges (example case).................................................. 535 Procedure 162: To create a Polling Object ............................................................................................... 546 Procedure 163: To specify a match criteria via Managed Object properties ........................................... 549

Procedure 164: To modify a Polling Object .............................................................................................. 555 Procedure 165: To delete a Polling Object ............................................................................................... 558 Procedure 166: To add statistics at runtime............................................................................................. 559 Procedure 167: To find a statistic ............................................................................................................. 566 Procedure 168: To modify an existing Statistic......................................................................................... 566 Procedure 169: To delete a Statistic ......................................................................................................... 568 Procedure 170: To modify the properties of Extended PolledData ......................................................... 568 Procedure 171: To add a threshold .......................................................................................................... 571 Procedure 172: To prepare to map a threshold ....................................................................................... 577 Procedure 173: To map a threshold for an individual device................................................................... 578 Procedure 174: To add thresholds to a statistic ....................................................................................... 580 Procedure 175: To map a threshold for a specific type device ................................................................ 582 Procedure 176: To map a threshold for a device type ............................................................................. 583 Procedure 177: To associate thresholds with a Polling Object for a device type..................................... 584 Procedure 178: To modify a threshold ..................................................................................................... 589 Procedure 179: To delete a threshold ...................................................................................................... 590 Procedure 180: To create a threshold for a device .................................................................................. 591 Procedure 181: To schedule a policy ........................................................................................................ 607 Procedure 182: To update a policy ........................................................................................................... 608 Procedure 183: To configure a device ...................................................................................................... 611 Procedure 184: To import a configuration template................................................................................ 619 Procedure 185: To import configuration templates ................................................................................. 620 Procedure 186: To create a configuration template ................................................................................ 621 Procedure 187: To apply an existing configuration template .................................................................. 626 Procedure 188: To find a configuration template .................................................................................... 628 Procedure 189: To edit a configuration template .................................................................................... 629 Procedure 190: To set up automatic configuration upon discovery ........................................................ 631 Procedure 191: To export a configuration template ................................................................................ 633 Procedure 192: To export all configuration templates............................................................................. 634 Procedure 193: To delete a configuration template ................................................................................ 634 Procedure 194: To clone a device configuration ...................................................................................... 635 Procedure 195: Launching a BAM session ................................................................................................ 640 Procedure 196: To launch Task Scheduler................................................................................................ 652

Procedure 197: To define a Configuration task ........................................................................................ 653 Procedure 198: To view configured tasks................................................................................................. 674 Procedure 199: To view results of last execution of a task ...................................................................... 675 Procedure 200: To edit a task definition................................................................................................... 677 Procedure 201: To reschedule a task execution....................................................................................... 677 Procedure 202: To pause a task................................................................................................................ 678 Procedure 203: To resume a task ............................................................................................................. 678 Procedure 204: To cancel automatic deletion of a task ........................................................................... 679 Procedure 205: To delete a task ............................................................................................................... 679 Procedure 206: To stop a task .................................................................................................................. 679 Procedure 207: To Broadcast a message.................................................................................................. 681 Procedure 208: To reconfigure offline physical map images in WM........................................................ 692 Procedure 209: To configure server and admin email settings ................................................................ 694 Procedure 210: To open the Log File Configuration tool.......................................................................... 694 Procedure 211: To view log file details ..................................................................................................... 696 Procedure 212: To modify log file details ................................................................................................. 697 Procedure 213: To log in to the Wireless Manager Ultralight .................................................................. 703

WM Release 4.0 User Guide

Issue 3 May 2012

About This User Guide This Cambium Wireless Manager Release 4.0 User Guide describes and provides procedures for operations in the Wireless Manager (WM) client interface for Release 4.0. If you are a client administrator or user, use the user guide. Only authorized users can log into a WM client and access specific features, based on assigned user privileges. Contact your system administrator for help with your authorized user privileges. Device‐specific information is provided in the documents that support the devices. This includes definitions for configurable attributes. However, this WM user guide describes how to 1.

compose a configuration template, assuming that you know what attributes and values you want to configure

use WM to push those values to the elements.

All information pertaining to operations on the client (those operations that are authorized or disallowed by the Operation Tree) is provided in this user guide, regardless of the permission required to perform them. This construction for this user guide allows client administrators to use the whole book and all of its cross‐references, whether these link to complex and restricted operations or to simple operations that are universally permitted across the operating staff. At the same time, users with relatively low permissions can view procedures that only client administrators can execute. The rich security features of WM make this a practical design for the user guide. As you acquaint yourself with the table of contents of the user guide, you will see section titles transition from having words like using and monitoring to having words like administering and managing. Given the complexity of user and group account provisioning (in the Operation Tree) and the varied tacks that operators may take in their WM security designs, no attempt is made to clearly partition the user guide where everything situated after a partition applies to only client administrators.

1.1

Continuing Features Release 4.0 continues full configuration and ongoing management capabilities for the range of products that are listed under Cambium Networks Device Types on Page 49 and for non‐Cambium devices for which operators create their own valid device definition templates. It also collects and displays events and alarms for the Cambium Point‐to‐Point (PTP) and Point‐to‐Multipoint (PMP) products, thus providing a consolidated view of the status of the Cambium networks in a single screen. WM Release 4.0 continues the capability to overlay network elements onto an embedded Google map. Maps like this allow you to visualize and analyze a wide range of crucial information, including connectivity between nodes, link quality, range, and device and network availability. These graphical representations help you quickly see network status, identify any problems, and assess the severity of impact they will have on the network and its users. This release has also kept stride with changes in device templates for elements that it has supported and with new templates for elements that are introduced since the last release.

Issue 3 May 2012

WM Release 4.0 User Guide

This document is intended to support only Release 4.0 of WM. All information pertaining to operations on the client (those operations that are authorized or disallowed by the Operation Tree), are described here in the user guide, regardless of the permission required to perform them. important ........... The installation tool for the WM server deposits an issue of the Cambium Wireless Manager Release 4.0 Server Administration Guide and the Cambium Wireless Manager Release 4.0 User Guide into the ...server/help directory on the WM server. These documents are placeholders. Immediately after your server installation is completed, visit http://www.cambiumnetworks.com/support/planning/index.php?cat=1&type=0. If a later iteration of either or both of these documents is present there, download it and delete the superseded book. Throughout the life of Release 4.0, this web site will always contain the latest supporting documents. Whenever the issue number available at this site is greater than what you currently have, you need to download the replacement.

1.2

Features New in Release 4.0 Release 4.0 introduces the following features: 

a user interface for cloning device configurations with values, from either a selected device or the database, either pushed to destination devices of the same device type or saved to a template you will later push to them, without touching attributes that should be excluded from cloning; for example, without −

those that are not readable from the source, such as keys and passwords.

−

others that could fail the operation, such as Device Region Code and Device Default Reset.

−

optionally, those that should in most cases remain unique, such as IP, DHCP, NAT, and bridge mode attributes.

See Cloning a Device Configuration on Page 635. 

a system‐configured view of events that are related to discovery. See Viewing All Events Related to Discovery on Page 354.



device type graphical summary reports. See



−

Table 32: PMP 320 AP performance reports on Page 389

−

Table 34: PMP 320 CPE performance reports on Page 391

−

Table 31: AP performance reports on Page 389

−

Table 35: PMP Backhaul performance reports on Page 392

−

Table 33: SM performance reports on Page 390

−

Table 33: SM performance reports on Page 390

−

Table 36: PTP performance reports on Page 392

support for multiple default configuration templates per device type to be applied during discovery. See Pushing Configuration Values Upon Discovery on Page 631.

WM Release 4.0 User Guide 

Issue 3 May 2012

added support for −

PTP 250 Master and Slave as read‐only elements

−

PTP 300, PTP 500, and PTP 800 Master and Slave as Version 05‐00. See the caveat in Clarifications on Page 46.

−

PTP 400 Master and Slave as Version 09‐01.

−

more attributes of the Extreme Switch.

−

PMP 320 Release e2.3. For the AP, this includes 

Network Configuration attributes for SNMP version (v1/2c or v3), web access security (HTTPS or HTTP), and serial interface (CLI or uGPS).



read‐only attributes for GPS location, the active service flow count, and the frequency range and restriction mode of the AP.



performance tables for UL and DL MCS counters of registered CPE's MCS and HARQ stats.



a frame utilization table used by the native Frame Utilization tool in WM but hidden from user configuration templates.



updates to the Upload AAA Certificate utility, tables for user management and trap destinations, and the Slots Measurement, MAC Version, backoff values (for DL, UL, and ECINER), Sync Source, Selected DL/UL Ratio, and Sync Status attributes.



commands that Save Configuration Command, Reboot Device, Clear [service flow] Counters, and Clear [MCS] Statistics.



introduction of performance statistics for the following data: ‐ received/transmit data rate ‐ received IP packets with and without VLAN tag ‐ received non‐IP packets with and without VLAN tag ‐ received packets classified and unclassified ‐ DL and UL MCS state of each registered CPE ‐ antenna method of each registered CPE.



elimination of the need for operators to have their own physical map licenses. This is reflected in About License Tab on Page 80.



a means to terminate a rogue or runaway client session while other concurrent sessions continue. See Terminating a Client Session on Page 683.



changes in the integrated software upgrade utility. See −

Upgrading Devices On Demand on Page 287.

−

Setting the General Configuration on Page 289.

−

Setting the SM Autoupdate Configuration on Page 290.



synchronization functions (buttons) added to the WM Server panel of the WM Administrator Tool to launch removal of all events, alarms, and traps in process, while leaving all elements' statistics untouched. See Using the WM Server Panel on Page 684.



removal of trap port configurability and trap parser interfaces.



removal of the System Administration web interface.

Issue 3 May 2012

1.3

WM Release 4.0 User Guide

Clarifications New OIDs are implemented in v05‐00 for PTP 300 and PTP 500 location attributes. See Resetting Location Attributes for PTP 300 and PTP 500 Devices on Page 297. The order in which user permissions are set determine which permissions are allowed and which are disallowed. Also, the system does not warn the administrator who configures multiple group memberships for a user when those groups have differing sets of permissions. An important admonishment has been added to Administering Wireless Manager Security on Page 435, describing these scenarios.

1.4

References to Other WM Documents If you are a client administrator or user, use this user guide. All information pertaining to the WM server file system is presented for the server administrator in 



Cambium Wireless Manager 4.0 Quick Start Guide, which documents −

the system requirements

−

the procedure for a fresh installation

−

client device setup

−

SNMP broadcast toggling

−

starting and stopping the WM service

−

launching the client

−

setting up, monitoring, and troubleshooting initial discovery

−

licensing WM software and the physical map

Cambium Wireless Manager Release 4.0 Server Administration Guide, which documents −

port usage

−

database administration

−

server‐side adjustments for 

discovery



fault management



performance management



security management



physical map features

−

server logs

−

licensing and upgrading WM software

−

backing up the system

−

using the MIB browser

For high‐level descriptions of new features included in the initial distribution of Release 4.0, or for all disclosures about features that this distribution supports, see the Cambium Wireless Manager Release 4.0 Release Notes. If you are a server administrator, use the Cambium Wireless Manager Release 4.0 Server Administration Guide.

WM Release 4.0 User Guide

Issue 3 May 2012

For BAM feature integration, see the following documentation:

1.5



Cambium Wireless Manager 4.0 Quick Start Guide



Cambium Wireless Manager Release 4.0 Server Administration Guide



Using the Bandwidth and Authentication Manager (BAM) Subsystem on Page 262

Links to Other Important Documents For links to important documents about supported network elements, visit the following web pages: 

PTP device and PTP LINKPlanner user guides and release notes at http://www.cambiumnetworks.com/support/ptp/software/index.php?tag=linkplanner



PMP device user guides, release notes, and MIBs at http://www.cambiumnetworks.com/support/pmp/software/index.php



a wide range of PMP 320 device documents at http://www.cambiumnetworks.com/support/pmp/software/index.php



CMM user guides and release notes at http://www.cambiumnetworks.com/support/pmp/software/index.php

For links to important documents about management tools, visit the following web pages: 

Wireless Manager guides, release notes, and service pack notes at http://www.cambiumnetworks.com/support/planning/index.php?cat=1&type=0



Cambium Network Updater Tool (CNUT) on‐line help file and release notes at http://www.cambiumnetworks.com/support/planning/index.php?cat=3&type=0



Prizm guides, release notes, and its SDK at http://www.cambiumnetworks.com/support/planning/index.php?cat=2&type=0

For links to network element features and specifications, visit the following web pages. 



Cambium PTP: −

the portfolio at http://www.cambiumnetworks.com/solutions/ptp_overview.php

−

PTP 100 at http://www.cambiumnetworks.com/solutions/products.php?id=ptp100

−

PTP 200 at http://www.cambiumnetworks.com/solutions/products.php?id=ptp200

−

PTP 300 at http://www.cambiumnetworks.com/solutions/products.php?id=ptp300

−

PTP 500 at http://www.cambiumnetworks.com/solutions/products.php?id=ptp500

−

PTP 600 at http://www.cambiumnetworks.com/solutions/products.php?id=ptp600

−

PTP 800 at http://www.cambiumnetworks.com/solutions/products.php?id=ptp800

−

Cambium Networks LINKPlanner at http://www.cambiumnetworks.com/solutions/products.php?id=linkplanner

Cambium PMP: −

the portfolio at http://www.cambiumnetworks.com/solutions/pmp_overview.php

−

PMP 100 at http://www.cambiumnetworks.com/solutions/products.php?id=pmp100

−

PMP 320 at http://www.cambiumnetworks.com/solutions/products.php?id=pmp320

−

PMP 400 at http://www.cambiumnetworks.com/solutions/products.php?id=pmp400

−

PMP 430 at http://www.cambiumnetworks.com/solutions/products.php?id=pmp430

−

PMP 450 at http://www.cambiumnetworks.com/solutions/products.php?id=pmp450

Issue 3 May 2012

WM Release 4.0 User Guide

For declarations of conformity for individual network elements in their various frequency band ranges, see http://www.cambiumnetworks.com/doc.php.

1.6

Feedback on This Guide We encourage feedback on our documentation, including 

An opinion on the structure or content of the documents.



a notification to us about a deficiency in accuracy or completeness.



any other comment you have.

Please send your feedback to support@cambiumnetworks.com.

WM Release 4.0 User Guide

Issue 3 May 2012

Supported Device Types

2.1

Cambium Networks Device Types The Cambium Wireless Manager Release Notes for Release 4.0 provides the complete list of the device types that this release supports, correlated to their firmware version(s) supported and their device template file names. WM supports each of these device types with a network elements dashboard (see Viewing the Dashboard for a Device on Page 204) and most with structured information resources as indicated in Table 1.

Table 1: Structured information resources per general device type Predefined Structured Information Resource

General Device Type PMP

PTP

Documented In

Generic

AP Bridge Table Summary1



Table 31: AP performance reports on Page 389

AP Ethernet Statistics1



Table 31: AP performance reports on Page 389

AP General Status1



Table 31: AP performance reports on Page 389

AP QoS Summary1



Table 14: Configuration Summary reports on Page 339

AP Radio Statistics1



Table 31: AP performance reports on Page 389

AP Session Table Summary1



Table 31: AP performance reports on Page 389

AP Top 25 Report1



Table 31: AP performance reports on Page 389

AP VLAN Configuration Summary1



Table 14: Configuration Summary reports on Page 339

Configured values report template



Accessing a Predefined Report on Configured Values on Page 325

Default configuration values push template



Pushing Values from a Prestructured Configuration Template on Page 619

Device definition template



Server administration guide

PMP 320 AP Ethernet Statistics1



Table 32: PMP 320 AP performance reports on Page 389

Issue 3 May 2012 Predefined Structured Information Resource

WM Release 4.0 User Guide

General Device Type PMP

PTP

Documented In

Generic

PMP 320 AP General Status1



Table 32: PMP 320 AP performance reports on Page 389

PMP 320 AP Graphical Summary Report1



Table 32: PMP 320 AP performance reports on Page 389

PMP 320 AP QoS Summary1



Table 14: Configuration Summary reports on Page 339

PMP 320 AP Radio Statistics1



Table 32: PMP 320 AP performance reports on Page 389

PMP 320 AP Service Flow Summary1



Table 14: Configuration Summary reports on Page 339

PMP 320 AP Top 25 Report1



Table 32: PMP 320 AP performance reports on Page 389

PMP 320 CPE Ethernet Statistics1



Table 34: PMP 320 CPE performance reports on Page 391

PMP 320 CPE General Status1



Table 34: PMP 320 CPE performance reports on Page 391

PMP 320 CPE Graphical Summary Report1



Table 34: PMP 320 CPE performance reports on Page 391

PMP 320 CPE Radio Statistics1



Table 34: PMP 320 CPE performance reports on Page 391

PMP 320 CPE Service Flow Summary1



Table 14: Configuration Summary reports on Page 339

PMP 320 CPE Top 25 Report1



Table 34: PMP 320 CPE performance reports on Page 391

PMP AP Graphical Summary Report1



Table 31: AP performance reports on Page 389

PMP Backhaul Bridge Table Summary1



Table 35: PMP Backhaul performance reports on Page 392

PMP Backhaul Ethernet Statistics1



Table 35: PMP Backhaul performance reports on Page 392

PMP Backhaul General Status1



Table 35: PMP Backhaul performance reports on Page 392

PMP Backhaul Graphical Summary Report1



Table 35: PMP Backhaul performance reports on Page 392

PMP Backhaul Radio Statistics1



Table 35: PMP Backhaul performance reports on Page 392

WM Release 4.0 User Guide

Predefined Structured Information Resource

Issue 3 May 2012 General Device Type PMP

PTP

Documented In

Generic

PMP Backhaul Top 25 Report1



Table 35: PMP Backhaul performance reports on Page 392

PMP Backhaul VLAN Configuration Summary1



Table 14: Configuration Summary reports on Page 339

PMP FSK SM Graphical Summary Report1



Table 33: SM performance reports on Page 390

PMP OFDM SM Graphical Summary Report1



Table 33: SM performance reports on Page 390

PTP 800 Bridge Configuration Summary1



Table 14: Configuration Summary reports on Page 339

PTP Ethernet Statistics1



Table 36: PTP performance reports on Page 392

PTP General Status1



Table 36: PTP performance reports on Page 392

PTP Graphical Summary Report1



Table 36: PTP performance reports on Page 392

PTP Radio Statistics1



Table 36: PTP performance reports on Page 392

PTP Top 25 Report1



Table 36: PTP performance reports on Page 392

PTP VLAN Configuration Summary1



Table 14: Configuration Summary reports on Page 339

SM Bridge Table Summary1



Table 33: SM performance reports on Page 390

SM Ethernet Statistics1



Table 33: SM performance reports on Page 390

SM General Status1



Table 33: SM performance reports on Page 390

SM QoS Summary1



Table 14: Configuration Summary reports on Page 339

SM Radio Statistics1



Table 33: SM performance reports on Page 390

Issue 3 May 2012

WM Release 4.0 User Guide

Predefined Structured Information Resource

General Device Type PMP

PTP

Documented In

Generic

SM Top 25 Report1



Table 33: SM performance reports on Page 390

SM VLAN Configuration Summary1



Table 14: Configuration Summary reports on Page 339

NOTES: 1.

2.2

Optionally loaded into the client application by the network operator.

Generic Elements (Non-Cambium Devices) WM discovers as a generic element any SNMP‐enabled 1 non‐Cambium device for which no valid device definition template exists. This is distinguished from a Cambium devices, for which a device definition template is part of the WM software distribution, and from any third‐party devices 2 for which the operator has created a valid device definition template. However, generic element discovery depends also on the following workaround. Check to see whether WM has discovered all of the generic devices in the network. For any that WM did not discover, the server administration guide provides a workaround procedure. The result is that WM succeeds in discovering all generic elements in your network. However, WM will use the MAC address as the Name (ID) of any that support and properly implement DHCP. A generic device that WM discovers counts against the node limit in the WMEMSPack license. For a generic device, WM performs the following element management functions:

1 2



discovery regardless of SNMP version (v1, v2c, or v3)



configuration of name, location, contact information, and device description and the following geo‐location attributes: −

latitude

−

longitude

−

height above the ground



collection and display of operational state performance statistics (number of ports, in‐ and out‐octets, and in‐ and out‐errors)



collection and processing of cold start, link up, link down, and authentication failure traps



representation with the generic device icon ( −

the physical map

−

the Inventory

−

the Applications tree

−

viewers for alarms and events

) in

Supporting RFC1213‐MIB. Cisco Router and Cisco Switch are third‐party devices for which the WM distribution provides valid device definition templates.

WM Release 4.0 User Guide

Issue 3 May 2012

WM also allows them to be members of user‐defined device groups. WM keeps their IP addresses and for each, provides a dashboard (as it does for Cambium device types) to display current alarms and events with some configured attributes and statistics. For WM to manage a device, it must be able to find the MAC address of that device so, during rediscovery, WM 1.

probes the ipAddr MIB table for the index to check in the ifTable.

queries the ifTable index to get the MAC address.

However, if this process fails, then 

WM fails to discover the device.



if the device already exists in database, WM moves it to the Unmanaged state and throws an event to report it.

Some generic SNMP devices do not fully support the ifaddr and ipaddr MIB tables. Allowing WM to manage such a device requires the creation of a device template that explicitly supports it. Before you attempt to create a template for it, request assistance from Cambium Networks support by calling the appropriate phone number listed at http://www.cambiumnetworks.com/support/technical.php or submitting your question in the form provided at that web site. Meanwhile, you may leave the device in this state for historical purposes (to preserve statistics, for example) or delete it from the Inventory via the Delete Object and Traces command option (see Deleting an Object and Traces on Page 261).

2.3

Subordinate WM Servers The WM server can act as a Manager of Managers (MoM) when one or more other WM servers are within its network. In this role, it aggregates the information that it receives from subordinate (child) WM servers and facilitates the management of a very large network. Specifically, the MoM server 

discovers the subordinate server.



pushes configurations to it. See Figure 391: Configuration groups for a child WM on Page 616.



provides a configuration report about it. See Creating and Using Device Configuration Reports on Page 323.



encapsulates its status in a network element dashboard. See Figure 157: Dashboard for a child WM element on Page 218.



receives and processes its traps and alarms.



provides a device summary report for it. See Figure 161: Device summary report for a child WM element on Page 225.

Issue 3 May 2012

WM Release 4.0 User Guide 

represents it in the Inventory and Applications tree.



represents it by position in the physical map.

A client session in the subordinate server provides its own statistics from the set that it sends to the MoM via the properly configured northbound interface (NBI). To see these statistics from the MoM, you can 1.

right‐click on the subordinate server in the Inventory and select LaunchClient (or press Ctrl+W).

authenticate into the client.

from the main menu, select HelpDiagnosticsServer Health Diagnostics.

The WM Monitoring window opens and provides time‐based plots for each of the following statistics:



server disk free space



disk usage



disk I/O



database disk usage



memory utilization



database disk free space



CPU utilization.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 1: Server disk free space monitoring window for a child WM element

Figure 2: Disk usage monitoring window for a child WM element

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 3: Disk I/O monitoring window for a child WM element

Figure 4: Database disk usage monitoring window for a child WM element

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 5: Memory utilization monitoring window for a child WM element

Figure 6: Database disk free space monitoring window for a child WM element

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 7: CPU utilization monitoring window for a child WM element

If you wish, you can keep open an instance of the Collected statistics window for each statistic you want to monitor for as long as the client session remains open. In the MoM client, subordinate server Element Properties are available from a right‐click on that server. See Figure 8, Figure 9, Figure 10, and Figure 11 below.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 8: Element Properties for a subordinate WM server, General tab

Figure 9: Element Properties for a subordinate WM server, SNMP tab

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 10: Element Properties for a subordinate WM server, Monitoring tab

Figure 11: Element Properties for a subordinate WM server, Relationship tab

WM Release 4.0 User Guide

Issue 3 May 2012

Launching the Client The WM client accesses information from the WM server and displays it graphically. You can browse through the discovered devices in your network, view network and device information, monitor their performance, and identify faults in the network.

3.1

Dependencies The WM client application supports the 32‐bit platform of either of the following operating systems: 

Windows 7 Professional, 32‐bit.



Windows Server 2008 R2 Enterprise



Red Hat Enterprise Linux Version 5.5 ES, 32‐bit.

The client is launched using the Java Web Start Application Manager. The client requires Java 1.6, which is satisfied as follows: 

Where Java 1.4.2 or later is present in the client device, WM automatically installs Java 1.6.



Where 1.4.2 or later is not present, you must install Java 6 and then launch the client, which will then use Java Web Start to install itself.

The client‐related jar files are downloaded when the client connects to the server for the first time. Every subsequent time the client connects to the same server, WM verifies these downloaded files for updates. This client device also requires 

15 MB storage space.



a high‐speed link of at least 1 Mbps. (Slower connection speed causes slow startup and the possibility of other problems after startup.)



screen resolution setting of 1024 x 768.



either −

Mozilla Firefox 3, if the client is on a Linux or a Windows device

−

MS‐Internet Explorer 7, if the client is on a Windows device

Communications between the server and client require that two port assignments (for NMSSocketPort and NMS_FE_SECONDARY_PORT) are made in the server file system after WM installation or upgrade. These assignments are documented in the quick start guide and the server administration guide.

3.2

Corporate Networks Connections between the client and server are supported across 

a corporate firewall, presuming that the required ports are configured to be open on the WM server device.



a virtual private network (VPN), but with a significant, noticeable reduction in system performance possible.



a network address translation (NAT) server.

Issue 3 May 2012

3.3

WM Release 4.0 User Guide

Launch Procedures To launch the WM client, perform the following steps.

Procedure 1: To launch WM 1.

Launch the supported browser.

Connect to http://WM_Server_IP_Address:9090.

Figure 12: Web page for WM Web Start client invoke (LoginPage.do)

Click Launch WM Client. If JNLP is already properly associated with Java Web Start Launcher (javaws), then a pop‐up window suggests the file to open, as shown below. In this case, click OK to let the launch proceed.

WM Release 4.0 User Guide

Issue 3 May 2012

If it is not, then the pop‐up window includes a Browse button, as shown below.

If the association has not been made with javaws from Java version 1.2.2 or later, create that association wherever it is installed on the client device.

If a Warning – Security window pops up, indicating that the digital signature of the application cannot be verified, select the Always trust content from this publisher check box.

Click the Run button.

On the WM Authentication panel, type in the User ID (possibly root) and Password (possibly public).

note ............. The root/public combination is the default administrator account in WM. This account may have been reconfigured during the WM software installation. To find out what account to use for your initial launch of the client, check with the administrator on the WM server device or the technician who installed the software. At the same time, verify that the WM server is using the default port (9090).

Figure 13: WM Authentication dialog

If you need to change default settings such as port, language, or country, click the Advanced button.

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 14: WM Authentication advanced options

The default port is 9090. 9.

If the port to which the WM Server is listening has been configured as any other port, specify the configured port number in the Port field.

10. Select the language and country of your preference from Language and Country drop‐down boxes respectively. If your client does not support the chosen language, then English is the default language. The Show Console option is selected by default and cannot be deselected. 11. Click Connect. The WM application should now launch successfully.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 15: WM application initial view

3.4

Configuring the Proxy on the WM Client note ............. If the WM client does not currently require a proxy server for access to the Internet, ignore this section.

Where a proxy server is used for access to the Internet, some issues must be addressed so that the Physical Map feature and the client/server connection will function properly. The following illustration differentiates the two cases for the relationship between the WM server and client.

Figure 16: Possible relationships between client and server

Issue 3 May 2012

WM Release 4.0 User Guide

The illustration on the right, where the same device runs both the client and server, is the case where you want to launch the client immediately after installing the WM software. This case requires that all of these instructions are followed. You must enter the information described in this section into both the Java Control Panel and your web browser.

3.4.1

Setting Proxy Information in the Java Control Panel To set the required information in the Java Control panel, perform the following steps on each device where a WM client will be used: 1.

Launch the Java Control Panel as follows: ◦

In Windows, select StartSettingsControl PanelJava.

◦

In Linux, enter /usr/local/cambium/wm/jre/bin/jcontrol.

Figure 17: Java Control Panel, General tab

In the General tab, click the Network Settings button. The Network Settings dialog opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 18: Network Settings window in Java Control Panel

Select Use proxy server.

In the text boxes, type in the address and port of your proxy server.

Select Bypass proxy server for local addresses.

Click the Advanced button. The Advanced Network Settings window opens.

Figure 19: Advanced Network Settings window in Java Control Panel

Enter the IP address or subnet mask that matches the address(es) of your server.

note ............. For help with this step, contact your network administrator.

Issue 3 May 2012

3.4.2

WM Release 4.0 User Guide

Setting Proxy Information in the Web Browser Use the following Firefox Version 3 example procedure as a general primer to configure your browser for proxy information. 1.

Launch the browser.

Select ToolsOptions.

From the icon array at the top, click Advanced.

Figure 20: Network tab in Firefox Options window

In the Network tab, click the Settings button of the Connection section. The Connection Settings window opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 21: Connection Settings window in Firefox

note ............. Typically, the next step is not required, because the proxy is already configured. If it were not, then Firefox would not have been previously able to access the Internet.

Select Manual proxy configuration and set the HTTP Proxy and Port consistent with the settings in the Java Control Panel.

In the No proxy for field, enter the IP address or subnet mask that matches that of the WM server.

note.............. This should match what is configured in the Java Control Panel, but may differ in format (for CIDR, for example). In the example shown above, the computer will not look to the proxy for any IP address that matches 10.x.x.x.

3.4.3

Troubleshooting an "Unable to launch the application" Error You may see the following error:

Issue 3 May 2012

WM Release 4.0 User Guide

If you see this error 1.

ensure that the instructions in the two preceding sections (for configuring the Java Control Panel and your browser) have been properly followed.

flush the Java file cache as follows: a.

Launch the Java Control Panel as follows: 

In Windows, select StartSettingsControl PanelJava.



In Linux, enter /usr/local/cambium/wm/jre/bin/jcontrol.

In the General tab, click the Settings button of the Temporary Internet Files section.

Figure 22: General tab of Java Control Panel

The Temporary Files Settings window opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 23: Temporary Files Settings window in Java Control Panel

Click the Delete Files button.

Figure 24: Delete Temporary Files window in Java Control Panel

In the warning window, select both Applications and Applets and Trace and Log Files.

Click the OK button.

Retry a launch of the WM client.

Issue 3 May 2012

3.5

WM Release 4.0 User Guide

Configuring Your Password If a Password Confirmation dialog is displayed as shown in Figure 25 when you log on to the client for the first time, use Procedure 2 to authenticate.

Figure 25: Password Confirmation window

Procedure 2: To configure your password prior to client connection

In the Password Confirmation dialog box, click Configure.

In the Type new password field, type in the password that you were assigned to use.

In the Confirm new password field, re‐type the same password.

In the Password expiry duration field, type the number of days you want your password to be valid. If no value or zero is entered in this field, then the password never expires.

Click Connect. The new password is now assigned to you, and you will be connected to the client. Use this new password for future logins.

WM Release 4.0 User Guide

Issue 3 May 2012

To change your current WM client password and/or the duration of the period after which your password will expire, use the Password Configurator as follows.

Procedure 3: To reconfigure your password 1.

After having logged on to the client, select ToolsAdministrationChange Password from the main menu. The Password Configurator dialog box is displayed.

Figure 26: PasswordConfigurator dialog

3.6

Enter the new password in the New Password field.

Re‐enter the same password in the Confirm Password field.

Enter the number of days you want your password to be valid in Password expiry duration. If no value or zero is entered in this field, then the password never expires.

Click OK. The new password will be assigned to you. You need to enter this new password for future logins.

Troubleshooting an Unsuccessful Login The following table lists the messages that are displayed in certain situations during the login process.

Table 2: Troubleshooting client login issues Message

Reason

You are logged in for the first time, would you like to reuse the existing password or configure a new password?

This pop‐up message is displayed when you log on to the client for the first time (only if this has been enabled by your administrator).

Remedy

Use Procedure 2 on Page 72.

Issue 3 May 2012

WM Release 4.0 User Guide

Message

Reason

Your password has expired. Would you like to reuse the old password Your password has expired. or configure a New password?

This User account has Expired. Please contact the Administrator for further details

This User account is Disabled. Please contact the Administrator for further details

Your user account has expired. The user account is created by your system administrator.

Remedy Either set a new password or retain the old password. To keep the same password for the same expiration period, click Reuse. To enter a new password and reset the expiration period, click Configure and use Procedure 2 on Page 72. If you do not have the permission to set your password, contact your system administrator. Contact your system administrator to renew your user account.

Your user account has been disabled by your system administrator. Contact your system administrator to Also, if your consecutive login attempts fail for a certain number enable your user account. of retries (number is configured by the administrator), the user account is automatically disabled.

WM Release 4.0 User Guide

Issue 3 May 2012

Using the Client Window The client window provides the following context‐sensitive components: 

a main menu at the top of the main window



a toolbar composed of icons beneath the main menu



an Applications tree that lists in hierarchy the various WM modules in the upper left side of the main window



an Alarm Summary View in the lower left side of the main window



a view frame that can contain a map or a view on the right side of the main window.

Figure 27: Client window, example

4.1

Using the Toolbar The Toolbar displays a collection of actions, commands, and control functions. It is located beneath the menu bar and supports various tools for different modules of WM. The Toolbar is useful for displaying frequently used components. A tool tip identifying supported operations is provided for each tool. The following figures illustrate how the set of toolbar selections varies from one module to another. For example, the Fault Management module has additional toolbar options, such as Add Custom View and Modify Custom View.

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 28: Toolbar when Dashboard is displayed

Figure 29: Toolbar when Network Events are displayed

Figure 30: Toolbar when Alarms are displayed

Figure 31: Toolbar when Configured Collection is displayed

Figure 32: Toolbar when Templates view is displayed

Figure 33: Toolbar when Inventory view is displayed

Figure 34: Toolbar when Reports are displayed

Figure 35: Toolbar when Scheduled Tasks are displayed

Figure 36: Toolbar when Policies view is displayed

Some toolbar options are common for all views in the client. Others depend on module functions. The following options are available for all the views in the client.

WM Release 4.0 User Guide

Issue 3 May 2012

Table 3: Common toolbar options Go Back to Previous Go Forward to Next Detach Current Window Help

To hide or show the toolbar, scroll over the vertical line on the left side of the toolbar to activate the Hide Toolbar tool tip and click to execute the command or toggle the Show Toolbar command from the window menu.

4.2

Using the Alarm Summary Views In addition, the default construction of the client window includes Device Status and Severe Alarms views, displayed in the lower left corner of the WM client window, beneath the Applications tree. These provide a summary of all the alarms tracked by WM. The Device Status panel shows the alarm count of each category from Critical to Clear. This panel is automatically refreshed when events are generated. Use the buttons at the top of the panel to display 

Severity against number of devices view



Severity alone in a pie chart view

Figure 37: Alarm summary views

This panel is updated automatically and the counts can be seen at all times, not depending on what is in the view frame. You can view all the devices under a specific severity of alarm. In the severity against number of devices view of the Device Status panel, click either the severity or the bar associated with the severity (or click the severity box in the Severe Alarms panel. For example, if you want to view all the Major alarms, click the Major box under Severe Alarms. Regardless of what views or open or what view is on top, WM launches an Inventory view with only those devices that are under an alarm of the selected severity. 77

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 38: View of devices under Warning

note ............. To return to a full Inventory view after the slim view of only those devices under a particular alarm severity, click the Show All button.

The Severe Alarms panel displays the counts in only the Critical, Major, and Minor severity. When no alarms are present in a severity, WM displays its count against a grey background. When alarms are present, the count displays against the coded color of the severity: red for Critical, orange for Major, and Yellow for Minor. This panel never displays alarms of lesser severity.

Figure 39: Severe alarm counts

Discovering alarms occur during the discovery process, where nodes are added to the WM inventory of managed objects. The client provides more detailed alarms and device information in its system dashboard, which is described under Monitoring the System Dashboard on Page 115.

4.3

Using the Status Bar The Status Bar at the bottom of the screen indicates the status of the ongoing process. For example it displays Done if all the data is loaded or loading... if the process is still not complete.

4.4

Using the Display Panel The display panel is on the right‐side of client and appears as a window within the main window. This panel is shown when a tree node is selected. For example, if you click Fault ManagementEvents on the tree, then the Events display opens in the right side panel.

WM Release 4.0 User Guide

4.5

Issue 3 May 2012

Using the Menu Bar The menu bar is located at the top of the Display area. Select a menu and choose a command to perform a desired function. Certain menu bar drop‐down menus (File, Tools, Window, and Help) are common for all views in the client. The set of active menu bar menus differs as follows for various views. Views of the following types have 



no Edit menu: −

Dashboard

−

Physical Map

−

System Reports

−

Reports Results

−

Scheduled Tasks

no View menu: −



Scheduled Tasks

no Actions menu: −

Dashboard

−

System Reports

−

Reports Results

all menu bar menus: −

Inventory

−

Network Events

−

Alarms

−

Configuration Templates

−

Configuration Report Templates

−

Configured Collection

−

Policies

Issue 3 May 2012

4.6 4.6.1

WM Release 4.0 User Guide

Using the Help Menu About Wireless Manager The main menu selection HelpAbout Wireless Manager displays the About panel, which includes tabs that display details about licenses, SNMP agents, the WM client application, and defined device templates.

Figure 40: About window, License tab

About License Tab This tab provides current totals of used ( ), available ( ), and used+available ( ) licenses for each license type. Since License Manager is configured as part of WM installation and upgrade procedures, and since the purchased licenses are deployed into the file system in the WM server, the Wireless Manager Release 4.0 Server Administration Guide provides the full details on how the licensing scheme works in this release. However, the WM client application cautions users in the client application when a license deficiency seems to be approaching. A WM server checks out one count of the license specified in the WMEMSPack license whenever a device (other than a PMP Series SM or PTP Series Slave) is discovered and managed by WM. When the number of checked out license counts at the license server reaches 90% of the total license counts, WM opens a modal dialog window to users in current

WM Release 4.0 User Guide

Issue 3 May 2012

sessions and to users who users who are launching the client application, warning that more WMEMSPack license capacity will be required. When the number exceeds the total of licenses, no license will be made available for check out until a licensed device is deleted from a network and thereby forfeits the license that had been allocated by License Manager to it. When you click on the Manage Licenses button, WM prompts you to enter the Login Name and Password that WM uses for its own access to the License Manager server (by way of the licensing web server). If you enter these correctly (consistent with how they were saved in the Administrator Tool on the server), then a web browser is spawned, open to the web interface of License Manager.

Figure 41: License Manager web interface

Changing Your Account Parameters for Tool Access The License Manager Administrator Tool allows you to change how you authenticate to get access through the web server to the tool. You may want to periodically do this for security. To do so, access the tool, then click the Password button in the License Manager panel. An example of the resulting Change Password panel is shown in Figure 42.

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 42: Change Password panel, License Manager Administrator Tool

note ............. The License Manager area of the Administrator Tool is not capable of prompting for, storing, or implementing account changes for the License Manager Administrator Tool users.

Your new user name and password should be ones that are easy for you to recall. Assistance for forgotten user names and passwords is not available. As you type in your old, new, and confirmed new passwords, asterisks represent the characters. When you are satisfied with the new account information, check the Synchronize password and configuration to redundant servers check box and click the Save Changes button. After you have reset the password but before you use the License Manager Administrator Tool web site, you must click the link for Licensing Configuration, then change the password for the local server and click the Save Changes button. Similarly, before you use the server Administrator Tool for license administration, your server administrator must reset the Password field in the License File Data panel of the WM Server Administrator Tool, and then click the Save Configuration button.

WM Release 4.0 User Guide

Issue 3 May 2012

About Device Details The count that the device details tab provides represents the total number of agents across all network elements that are currently under WM management.

Figure 43: About window, Device Details tab

Each agent of a multi‐agent generic device is counted as one instance in the agent count.

Issue 3 May 2012

WM Release 4.0 User Guide

About Client Details The information that the Client Details tab displays information that is designed for technical support purposes and not intended for operator use, except when it is requested by a Cambium Networks customer support representative.

Figure 44: About window, Client Details tab

About Supported Device Templates The Supported Device Templates tab provides the names of all device types that WM supports and of the templates that make some of the operations in support of them possible. These templates should not be confused with either



configuration templates, which push values of configurable attributes to managed elements



configuration report templates, which retrieve, format, and display attribute values from either the database or the device(s).

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 45: About window, Supported Device Templates tab

By contrast, the device templates define the devices in such a way that WM is able to distinguish, among other factors

4.6.2



the element type from other element types during discovery



the firmware version loaded in the element



the icon by which to represent the element in the WM user interface



the name by which to identify it in various views



the performance data statistics to query from it



the configuration data that is appropriate to push to it



the air standard that applies to it, for radios in the physical map.

Help Contents The main menu selection HelpHelp Contents provides links to the index of on‐line help topics and this user guide, the server administration guide, and the technical support web page.

Issue 3 May 2012

4.6.3

WM Release 4.0 User Guide

Diagnostics The main menu selection HelpDiagnostics provides links to

4.7 4.7.1



the customer support tool (see Running the Customer Support Tool on Page 749)



JVM monitoring details (see Logging JVM Monitoring Details on Page 702).

Managing Client Windows Navigating through Active Windows When many windows are open in the display panel, you can move forward to the next active screen or move back to the previous one. 

To move back to the previous window, from the File menu, choose Back or click (Go Back to Previous) on the toolbar, or press Ctrl+Shift+B.



4.7.2

To move to the next window, from File menu, choose Forward or click Next) on the toolbar, or press Ctrl+Shift+F.

(Go Forward to

Detaching a Window from the Client The following views can be detached from the display panel of the client for viewing as a separate window: 

system dashboard



physical map



Inventory view, including custom views and the inventories of a device groups



Alarms view



Network Events view



Configured Collection



Scheduled Tasks



Policies

To detach a window, perform any of the following steps: 

Right‐click on the node in the Applications tree and select DetachDetach from the drop‐ down list of options.



Click



Press Ctrl+Shift+T.

(Detach Current Window) on the toolbar.

To re‐attach a window into the view panel, click the right corner of the detached window.

close window button in the upper

WM Release 4.0 User Guide

Issue 3 May 2012

tip ................ Position the detached window far enough from its docked position that you can easily distinguish that it is undocked. Otherwise, you might inadvertently close a view that you intended to only reattach.

4.7.3

Saving Location and Size of Windows When you rearrange and resize windows, you need to save them to retain the same location and size. To save location and size after rearranging and resizing windows, select WindowSave Location and Size. You will be able to see the retained location and size when you reopen the client.

4.7.4

Closing All Open Windows To close all the open windows, perform any of the following procedures.

4.8



Select FileClose All.



Press Ctrl+Shift+O.

Using the Applications Tree The Applications tree pane located on the left side of the client displays a set of hierarchical data representing the current network configuration. At the top of the tree is the physical map. Some nodes of the Applications tree are available permanently (by default) in the client, and others are dynamically added. Each node is selectable, each parent node is expandable and collapsible, and each ultimate child node determines the view that is displayed in the right (opposite panel) of the main client view. The following nodes compose the Applications tree.

Table 4: Applications tree nodes Parent Node

Default Child Nodes

Described Under

Dashboard

none

Monitoring the System Dashboard on Page 115

Physical Map

none

Using the Physical Map on Page 145

one for each device type present in the network, represented by its icon and its textual string Inventory

Using an Inventory View on Page 121

a device type selection for Networks a device type selection for Device Groups

Creating and Using Device Groups on Page 299

Issue 3 May 2012

WM Release 4.0 User Guide

Parent Node

Default Child Nodes

Described Under

one for Network Events

Working with Events on Page 345

one for Alarms

Handling Alarm on Page 364

one for Configuration Templates

Using Configuration Templates on Page 618

Fault Management

Configuration

one for Configuration Report Templates

one for Audit

Importing Configuration Report Templates on Page 324 Exporting All Configuration Report Templates on Page 337 Table 45: Configuration options on Page 469 Using System Reports on Page 388

Viewing a Device Summary Report on none (use parent node for viewing and running the Page 223 available reports) Launching an Operator‐defined Report on Page 397 System Reports

Saving a Device Summary Report on Page 226

one for Report Results

Deleting a Device Summary Report on Page 227 Using a Configuration Summary Report as Preconfigured on Page 342 Using a System Report As Preconfigured on Page 396

Performance

one for Configured Collection

Monitoring Performance on Page 379

one for each defined Scheduled Task

Scheduling a One‐Time or Periodic Task on Page 647

one for Policies

Administering a Policy on Page 603

Administration

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 46: Expanded view of the Applications tree

Issue 3 May 2012

WM Release 4.0 User Guide

The fundamental element in the tree is a node that represents a data item in the given hierarchical set. The root node is the top node of the hierarchical data. Nodes inside the root nodes are called child nodes. Nodes that contain no child nodes are called leaf nodes. When you select a particular node, the corresponding panel is displayed on the right side of the display panel. A series of drop‐down menus is available by selecting nodes in the Applications tree. Select a device, then right click to display the drop‐down menu. The following sections explain the available menu commands. note ............. The deepest branches of the Inventory tree list links as NameID Links under the higher branch of their device type. The longest NameID supported for this list is 100 characters. Any device whose NameID is longer is not listed among the Links list.

Table view refers to the display panel on the right side of the client. For instance, clicking on Alarms node under the Fault Management node displays a panel on the right side that shows a table containing details of the generated alarms. Common right‐click menu options are available for several of the Applications Tree nodes.

4.8.1

Custom Views A custom view is a tailored view that can be created for viewing a subset of data that satisfies specific criteria. A search operation can be performed to locate a specific element, but a custom view would be useful to locate a set of elements that satisfy a certain set of criteria. Custom views can be created in an Events, Alarms, Configured Collection, or Inventory view. Network maps can also be created and modified using the Custom Views menu. The option to create a custom view is available based on user privileges. Contact your system administrator to determine your user privileges. You can configure an unlimited number of custom views of events, alarms, and or performance statistics. These views are filters. They are not static, but rather are updated as new events, alarms, or statistic values (respectively) becomes available to the system, even as you are examining the view.

Adding a Custom View When any non‐map view is the front window in the view frame, you have the option to add a new custom view of your own definition. From the main menu, select ViewCustom ViewsAdd Custom View. The type of criteria dialog that WM opens for you to configure depends on the type of view that is in front in the view frame: 

To add a custom events view filter, see Defining an Events Custom View on Page 356.



To add a custom alarms view filter, see Defining an Alarms Custom View on Page 372.



To add a custom performance view filter, see Defining a Performance Custom View on Page 592.



To add a custom inventory view filter, see Inventory Custom Views on Page 126.

When you add a custom view, the name of the view (a link to it) is placed into the Applications tree. Each other view that you create in the same module (Network Events, Alarms, or Configured Collection) can be either a direct child of the module link or a child (filter) of another custom view that was user‐created, as Alarms 12 is in the following example.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 47: Example parent custom view with child view

Modifying a Custom View You can modify any of your defined custom views as follows. To do so, click on the link to the custom view in the Applications tree as shown below.

Figure 48: Custom view nodes in Applications tree

WM opens the filter criteria window that you populated when you originally added the view (or that you last modified). Make whatever changes you wish to the values of the various properties. When you are entirely finished reconfiguring the view filter and/or its appearance in the Applications tree, click the Apply Filter button to modify the stored view filter.

Renaming a Custom View At any time, you can rename a custom view. To do so, right‐click on the link to the custom view in the Applications tree, then select ViewCustom ViewsRename Custom View from the main menu. In the Applications tree, the name of your custom view is enclosed in an edit box. Change the name as you wish, then press your Enter ( ) key to end the edit session.

Resizing Columns in a Custom View Custom view support resizing of their columns (for example, so that you can view all of the data without scrolling). To resize a column, position the mouse cursor over the right border of the column head, left‐click and hold down the button, and drag the border. You can save the resized structure so that when you reopen the view, the columns will be of their current width. To do so, do all of the resizing that you intend to do, then right‐click on the view name in the Applications tree and select Save Custom View State from the drop‐down list of options. If you do not execute this option, the view will reopen with the default column widths next time.

Issue 3 May 2012

WM Release 4.0 User Guide

Custom views also support reordering their columns. To do so, position the mouse cursor anywhere in the column head, left click and hold down the button, and drag the entire column. The rearrangement will last as long as the view remains open, even when it has no longer been the front in the view frame. However, the rearrangement will not be saved, even if you execute the Save Custom View State option. The view will revert to the column arrangement that was configured when the view was created.

Removing a Custom View To remove a custom view, click on the link to the custom view in the Applications tree, then select ViewCustom ViewsRemove Custom View from the main menu. This does not cause WM to drop elements that were contained in the view, but it does remove the view from both the Applications tree and WM memory. So, if you ever want to re‐establish this view, you must specify all of its criteria over again through the Add Custom View option. important ........... Removing a custom view automatically removes all child custom views, if the one you are removing is a parent view. For example, removing Alarms 1 will automatically remove Alarms 12 in the example branch shown in Figure 47 on Page 91.

4.8.2

Frame Operations Common Frame Operations for Back, Forward, Detach and Close Frame support navigation through the view panels.

4.8.3

Administration Tools The Administration Tools branch of the Applications tree provides access to the area in which a user who has a sufficient level of privilege can administer policies. These operations are described under

4.9



Administering a Policy on Page 603



Scheduling a One‐Time or Periodic Task on Page 647.

Using the Search Utility Above the Applications tree in the left panel of the main client window, a Search utility returns matching results from various data fields in WM.

WM Release 4.0 User Guide

Issue 3 May 2012

WM looks for matches between the input string and the contents of various data fields in the database. Table 5 lists these fields against the types of results that WM will return for them.

Table 5: Input string vs. result types for Search utility

Network Events

Networks

Alarms

Customer Contact

Example

Device Groups

Networks

Statistic Name Data Identifier

Statistics

Configured Collection

Events

Data Field

Alarms

View

Typical Returned Results

Devices

Input String



Figure

Page

Figure 49

Message



Figure 50

Source IP Address



Figure 51

Figure 52

Name (ID) IP Address



Source IP Address



Figure 53

Alarm Message



Figure 54

Figure 55

Figure 56

Figure 57

Figure 58

100

Figure 59

100

Device Name Location



Name (ID) IP Address



Inventory

Device Groups

Device Group Name

Customer Contact Management

Customer Name Customer Type Address 1 Address 2 City State Zip Country Email Home Phone Work Phone Mobile Phone Pager Devices



Issue 3 May 2012

WM Release 4.0 User Guide

The following example figures are referenced in Table 5 above.

Figure 49: Search results for input Statistic Name contents

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 50: Search results for input Message contents

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 51: Search results for input Source contents

Figure 52: Search results for input network Name (ID)

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 53: Search results for input IP Address contents

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 54: Search results for input Alarm Message contents

Figure 55: Search results for input Device Name contents

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 56: Search results for input Location contents

note ............. In the above example, BOST Lab is part of the configured Location contents and is also coincidentally part of the name of a defined device group.

Figure 57: Search results for input Name (ID) contents

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 58: Search results for input Device Group Name contents

Figure 59: Search results for input Address1 contents Each listed item in a results group provides a mouse hover tooltip that includes preselected detail about the item.

The group titles of returned results contain links to further information: 

100

Clicking on the

plus leaves the group expanded and collapses the other groups.

WM Release 4.0 User Guide

Issue 3 May 2012



Clicking on the



Clicking on the number in parentheses opens a view of the results group in the view panel.



Clicking on the magnifying glass associated with a results group opens a Search window that accepts multiple criteria and operates as described under Search on Page 123:

minus sign expands all of the results groups.

−

If the results group is Devices, then the criteria for a narrower search are

−

If the results group is Alarms, then the criteria for a narrower search are

101

Issue 3 May 2012

WM Release 4.0 User Guide −

If the results group is Events, then the criteria for a narrower search are

−

If the results group is Statistics, then the criteria for a narrower search are

note ............. The Device Groups and Customer results groups do not contain an icon with which to launch a narrower search (do not support advanced search).

4.10

Performing Table View Operations Table View refers to the display panel that you can view on the right side of the client. For instance, clicking on Alarms node under Fault Management node displays a panel on the right side that shows a table containing details of the generated alarms.

102

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 60: Alarms table view

The table views are available in only Fault Management, Network Events, and Configured Collection modules, and they differ from module to module.

4.10.1

Navigating Through a Table The four navigator buttons, First Page, Previous Page, Next Page, and Last Page are located at the top of each table. The purpose of these buttons is detailed in the following table.

Table 6: Table navigation buttons Button

First Page

Purpose To view the first segment, based on current sorting scheme, of the list of entries that are stored in the database. For example, if the table is sorted in the order of most recent items first, then First Page shows the segment of newest items.

Previous Page To view the previously viewed segment of the data retrieved from the database.

103

Issue 3 May 2012

WM Release 4.0 User Guide

Button

Purpose

To view the next segment, based on current sorting scheme, of the data retrieved from the database.

Last Page

To view the last segment, based on current sorting scheme, of the list of entries that are stored in the database. For example, if the table is sorted in the order of most recent items first, then Last Page shows the segment of oldest items.

4.10.2

Setting the Page Length for a Table The greater the set page length, the more data is retrieved from the WM server, and thus the slower its response will be. To display only a certain number of rows per page, select the value from the Page Length drop‐down list. Settable increments are 50, 100, 250, 500, 1000, 2500, 5000, 10000, 25000, and 50000.

4.10.3

Refreshing the Page View To refresh the page view, perform any of the following procedures.

4.10.4



Right‐click a row and click Refresh.



Select ViewRefresh.



Press F5.

Viewing a Range of Table Details Procedure 4: To view a range of details

4.10.5

In the Displaying field, enter the starting range number.

In the to field, enter the ending range number.

Press Enter.

Sorting Table Details You can sort the data in a table based on the column type and the details can be viewed either in ascending or descending order. The type of sorting (ascending or descending) is indicated by arrows. A simple click on the column header does the sorting, i.e., the complete data will be sorted. Subsequent click on the same header sorts the data in ascending order (if it were sorted in descending before). There are two types of sorting: 

104

Server‐side sorting: Server‐side sorting sorts all data in the WM Server and is not restricted to the data available in the client. For example, if there are 100 events in the WM Server and only 50 are displayed in the Page View of the table, a server‐side sorting sorts the complete

WM Release 4.0 User Guide

Issue 3 May 2012

set of 100 events and not just the 50 events. For server‐side sorting, click the column header. Subsequent click on the same column header sorts the data in ascending order (if it were sorted in descending before). The sort indicators for server‐side sorting for ascending and and , respectively. descending are 

4.10.6

Client‐side sorting: Client‐side sorting sorts data displayed only in the client. For example, if there are 50 alarms in the WM Server and only 25 are displayed in the Page View of the table (25 per page), a client‐side sorting sorts only 25 alarms and not the 50 alarms in the WM Server. For client‐side sorting, press the Ctrl button and click the column header. Subsequent click on the same header sorts the data in ascending order (if it were sorted in descending before). The sort indicator for client‐side sorting for ascending and descending are and , respectively.

Rearranging and Resizing Columns in a Table For easy view of the data, rearrange the columns by just dragging the column header and moving it to the desired place in the table. You may find it helpful to view a some of the data at closer position. To resize the column header, drag the right‐side edge of a column. tip ................ When performing the rearrangement and resizing, the table remains the same only until the client is closed. When it is reopened, the settings would be lost. To retain the same size of columns, you should save the style by selecting the main menu item ViewCustom ViewsSave Custom View State or right-clicking on the node in tree and selecting Custom ViewsSave Custom View State or pressing Ctrl+S. important .......... When saving a custom view, ONLY the resizing is saved, and any rearrangement is not saved, and the custom view is displayed in the default order.

4.10.7

Viewing Row Details To view details or object properties of each row in a table, perform any of the following procedures: 

Double‐click a row in any view, including a Configured Collection.



Press Alt+D in an Events, Alarms, or Inventory view.



Right‐click a row in an Events or an Alarms view and click Details.

A dialog box is displayed with specific details about the selected row.

4.11

Importing Data Files Into WM WM provides a utility to import CSV files (or, in a lone instance, a text file) that WM will use for 

device discovery information

This operation requires permissions in TopologyAdd Node and Add Network. See Figure 300: Assign Permissions dialog on Page 444.

105

Issue 3 May 2012

WM Release 4.0 User Guide 

user account information

This operation requires permissions in User AdministrationAdd Users and Assign User To Group. See Figure 300: Assign Permissions dialog on Page 444. 

customer contact information

This operation requires operation permissions in Administrative OperationEmail Configuration. The only supported delimiter in the CSV files is comma. However, for any instance of a literal comma in a data field, the comma must be enclosed in two of a consistently used escape character type. The client refers to such a character as a Text Qualifier. The types allowed are double quote and single quote (apostrophe). Two examples of the supported use of a text qualifier for any of these CSV files are as follows: 12345,Chris Brown","Sean Brown,home,123 Main,Mount,WY,USA,csb@wyi.com,4061234567,,,,0a 00 3e 30 2d e4 12345,Chris Brown','Sean Brown,home,123 Main,Mount,WY,USA,csb@wyi.com,4061234567,,,,0a 00 3e 30 2d e4 Within a column, the supported delimiter between multiple entries is semicolon. For specific information on preparing each type of file data for import, see the following other sections of this user guide: 

Importing Device Discovery Information on Page 399



Importing User Account Information on Page 437



Importing a Customer Contact Database on Page 238

All of these options are available from the main menu by selecting ToolsImport and Export. The client responds to this selection by opening the Select operation window.

106

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 61: Select operation window

Select the desired import option radio button, then click the Next button. The Import window opens.

Figure 62: Import information windows

For Text Qualifier, select the escape character that the CSV file you are about to import uses consistently, if any. Then click the

button. The Select CSV file window opens.

107

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 63: Select file window

Browse to and select the file to import. Back in the previous window, click the Next button. If the import succeeds, then the system responds with a Results window message similar to the following:

4.12

Exporting Data Files From WM note ............. The following operations require permission in TopologyModify Object ExportTopology Data. See Figure 300: Assign Permissions dialog on Page 444.

108

WM Release 4.0 User Guide

Issue 3 May 2012

WM provides a utility to export CSV (comma‐separated values) files that another system or another instance of WM will use for

4.12.1



device discovery information (see Exporting Device Discovery Information, next)



user account information (see Exporting User Account Information on Page 111)



network hierarchy information (see Exporting Network Hierarchy Information on Page 113)

Exporting Device Discovery Information To export a CSV file of device discovery information, perform the following steps.

Procedure 5: To export device discovery information 1.

From the main menu, select ToolsImport and Export. The Select operation window opens.

Select the Export device discovery information radio button.

Click the Next button. The Export device discovery information window opens.

109

Issue 3 May 2012

110

WM Release 4.0 User Guide

Check the check box(es) of all of the types of discovery information you want included in the file for export.

Click the Next button. The Export device discovery information window changes to include the following fields.

Leave the Text Qualifier selection of double quote.

button. Click the The Select directory to store exported file window opens.

Browse to and select the directory. The path to the selected directory populates the path text field.

Click the Next button. The Export device discovery information‐ Results window opens with a confirmation of the export:

WM Release 4.0 User Guide

Issue 3 May 2012

10. Click the Finish button. The exported file is formatted according to the rules described in Table 37 on Page 399 and is written to the file name DeviceDiscoveryInformation_UniqueIdentifier.csv in your selected directory.

4.12.2

Exporting User Account Information This operation requires operation permissions in User AdministrationGet List of Users. See Figure 300: Assign Permissions dialog on Page 444. To export a CSV file of user account information, perform the following steps.

Procedure 6: To export user account information 1.

From the main menu, select ToolsImport and Export. The Select operation window opens.

111

Issue 3 May 2012

112

WM Release 4.0 User Guide

Select the Export user account information radio button.

Click the Next button. The Export user account information window opens.

Leave the Text Qualifier selection of double quote.

button. Click the The Select directory to store exported file window opens.

Browse to and select the directory. The path to the selected directory populates the path text field.

Click the Next button. The Export user account information‐ Results window opens with a confirmation of the export:

WM Release 4.0 User Guide

4.12.3

Issue 3 May 2012

Exporting Network Hierarchy Information To export a CSV file of network hierarchy information, perform the following steps.

Procedure 7: To export network hierarchy information 1.

From the main menu, select ToolsImport and Export. The Select operation window opens.

Select the Export network hierarchy information radio button.

Click the Next button. The Export network hierarchy window opens.

Leave the Text Qualifier selection of double quote.

button. Click the The Select directory to store exported file window opens.

113

Issue 3 May 2012

WM Release 4.0 User Guide

Browse to and select the directory. The path to the selected directory populates the path text field.

Click the Next button. The Export user account information‐ Results window opens with a confirmation of the export:

This exported file consists of only two columns of data:

4.13



Name, whose value in each row is the Name (ID) of the child element in a parent‐child relationship



Parent, whose value in each row is the Name (ID) of the parent element of that child.

Recovering from a Lost Connection to the Server While you use the client application, if the WM server goes down or you otherwise lose connection to the server, a pop‐up confirmation asks whether you want to exit the client. If you click the Yes button, then the client session closes. If you click the No button, the session remains up. However, some operations in it may indefinitely freeze, including the Discovery Configurator. Any problems of this kind are resolved when you exit and then re‐launch the client.

114

WM Release 4.0 User Guide

Issue 3 May 2012

Monitoring the System Dashboard At the top of the list of links in the Applications tree is Dashboard, which puts six contiguous system‐ configured displays on top in the view panel: 

Alarms by Severity, viewable as a pie chart or bar chart



Alarms by Device Type, viewable as a bar chart or table



Recent Alarms, viewable as a pie chart, bar chart, or table



Alarms by Message, viewable as a bar chart or table



Device Counts, viewable as a bar chart or table



Help, with the following tabs: −

Useful Links. By default, these open the browser to the release‐specific user guide or server administration guide. (The Help Index link opens a page that provides links to these guides.)

−

License. This tab provides the same summary information that the License tab of the About window provides. See About License Tab on Page 80.

−

Device Details. This tab provides the same summary information that the Device Details tab of the About window provides. See About Device Details on Page 83.

−

Settings. This tab provides the option to remove from the dashboard view all alarms of the severity Clear. Thus, for practical purposes, checking the Hide clear alarms check box in the Settings tab transforms the entire dashboard into a troubleshooting panel. Unchecking it returns the dashboard to a display of network health.

The dashboard opens by default the first time the client is launched. Each pie chart (click ) provides a complete representation. Each bar chart (click ) whose content is too large to fit in a single page continues across pages that are linked by and buttons. Each table (click ) whose content is too large continues in its vertical dimension by a scroll bar.

5.1

Dashboard Refreshes No action is required to update the data or the graphical representations. The dashboard automatically refreshes when the client is launched, whenever the client receives a notification from the server (except that each alarm is represented only once regardless of repeated instances), and once daily in addition to those occasions. The only exception is that, when the client receives a notification within three seconds of the last, it delays the dashboard update until three seconds have elapsed since its last update. However, you can refresh the entire dashboard at any time by clicking the Settings tab of the Help display and clicking the Refresh Dashboard button. The primary sort order for each of the pie, bar, and table displays is severity. The secondary is count.

115

Issue 3 May 2012

5.2

WM Release 4.0 User Guide

Dashboard Display Options Figure 64: Dashboard Alarms by Severity display

Figure 65: Dashboard Alarms by Device Type display

Figure 66: Dashboard Recent Alarms display

116

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 67: Dashboard Alarms by Message display

Figure 68: Dashboard Device Counts display

Figure 69: Dashboard Help display, Useful Links and License tabs

117

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 70: Dashboard Help display, Device Details and Settings tabs

Figure 71: Clear Alarms Included

Figure 72: Clear Alarms Hidden

One of the convenient aspects of the network health preference (clear alarms included) is the ability to monitor the process of successful discovery by tracking the Discovering alarms in the Alarms by Severity display. If you hide clear alarms, then these Discovering alarms are among those that are not shown. You may prefer to display the Clear alarms until discovery has concluded and then hide them.

5.3

Strategic Use of the Dashboard As with most of the more important view panels in WM, you can detach the dashboard from the view panel by clicking in the contextual menu of icons and drag it to somewhere else on the desktop. This allows you to continually monitor its displays while you work in other view panels. While the window is detached, if you click elsewhere in the client interface, the detached dashboard disappears and remains gone (even if you minimize the other view), but reappears in its detached position if you click the Dashboard link in the Applications tree. When you want to return the dashboard to the view panel, click the close window icon in the upper right corner of the dashboard window. A higher‐level alternative to the dashboard is the combination of the Device Status and Severe Alarms display beneath the Applications tree. See Using the Alarm Summary Views on Page 77. This display persists through any succession of views in the view panel to its right. Changes that you see in it may encourage you to view the greater detail that the dashboard presents.

118

WM Release 4.0 User Guide

5.3.1

Issue 3 May 2012

Click-throughs From the Dashboard The data representations in the dashboard are interactive for click‐throughs to other views that then open in the view panel. The view that opens depends as follows on the display component that you click:

In this display…

Alarms by Severity

Alarms by Device Type

Recent Alarms

if you click this…

this view opens…

and consists of…

pie section, bar, or label of a severity

Alarms

alarms of that severity in the network

bar or length of bar, label of a severity, or cell in a severity column

Alarms

alarms of that severity in devices of that device type

label of a device type

Alarms

alarms of all severities in that device type

pie section, bar, label of a severity, or cell in the Severity column

Alarms

alarms of that severity in the network within the last hour

cell in the Date column

Alarms

alarms that occurred in the network at that second

cell in the Message column

Alarms

alarms whose messages match within the last hour in the network

bar label or bar

Alarms

alarms whose messages match in the network and/or the trap/error message thrown

cell in the Severity column

Alarms

alarms of that severity in the network

cell in the Alarms column

Alarms

alarms whose message and severity match the message/severity that this cell tallies

cell in the Message column

Alarms

alarms whose messages match in the network

bar or length of bar, or cell in a severity column

Inventory

devices that are of the device type and are under an alarm of that severity

label of a device type

Inventory

devices that are of the device type

cell in the Count column

Inventory

devices that are tallied in that cell

Alarms by Message

Device Counts

The basis of these displays is with one exception the data that the client received in its last refresh. The exception is that the Recent Alarms display retains each alarm for one hour. Mouse‐overs on bars of a bar chart briefly open a tool‐tip that provides the exact number in the category.

119

Issue 3 May 2012

5.3.2

WM Release 4.0 User Guide

Sortable Table Displays The table displays are not sortable for Alarms by Device Type and Device Counts, but are sortable for Recent Alarms and Alarms by Message. One click of the column header sorts all of the table data by the entries in that column. Another click of it sorts by that column, but in reverse order. For example, the default order for Recent Alarms is most‐to‐least recent, based on the entry in the Data column (which includes both date and time). If you want to see all instances of a particular message in contiguous rows, you would sort the Message column and scroll to the set of those messages.

120

WM Release 4.0 User Guide

Issue 3 May 2012

Using an Inventory View WM opens to the Inventory view. When any other view is in front in the view frame, you can bring this view to the front by clicking on the Inventory node in the Applications tree. The table in the Inventory panel provides a list of data and status for all devices that WM has successfully discovered.

Figure 73: Inventory view

For each element, the Status column entry indicates one of the following: 

the highest severity current alarm against each device, the discovery status

121

Issue 3 May 2012

WM Release 4.0 User Guide 

the discovery status (which takes precedence over the alarm severity if a device is being discovered)



the management status if a device is unmanaged.

Possible values are Critical, Major, Minor, Warning, Discovering, Degraded, and Clear. Devices may show the status Discovering long after the Event viewer includes the event Discovery finished for the device. This is because the Status value in an Inventory view is intended to remain Discovering until deep discovery has concluded for the device. See Stages of Discovery on Page 432. For the Inventory branch, the Applications tree includes, after Networks, a list of selectable device types by which you can access an Inventory view that consists of only devices whose type(s) is selected (highlighted).

Figure 74: Device types list in Applications tree, example

122

WM Release 4.0 User Guide

Issue 3 May 2012

The fundamental element in the tree is a node that represents a data item in the given hierarchy. Before the first‐ever discovery is performed in WM, no device types are listed. This is because the list intends to reflect only discovered device types and, therefore, gets the device type names from the Discovery module. After a device type is added to the list, WM never removes it from the list, even in the unlikely event that you are no longer managing any devices of a given type in WM.

6.1

Inventory View Edit Menu Options The Inventory view supports options for the Edit menu on the dynamic menu bar.

6.1.1

Delete Object and Traces This selection, also available via Ctrl+D, removes the selected (highlighted) device from the database as well as from all views in the client. important ........... This command is not undoable and can have unwanted consequences. See Deleting an Object and Traces on Page 261.

6.1.2

Clear Alarms Some of the alarms that are generated in the network are automatically cleared during runtime. You can also clear an alarm manually when it has been resolved or if it is inconsequential. Depending on the alarm settings, the agent sends an alarm notification only when there is a crisis and does not send notifications when that crisis is resolved. In such a scenario, you can manually clear the alarm.

6.1.3

Delete Alarms Use this option to manually delete an alarm when you feel the alarm is not significant or the alarm has been cleared. By default, cleared alarms are automatically deleted after 24 hours.

6.1.4

Search Use the Search dialog box to look for alarms associated with the search criteria you define.

123

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 75: Alarms Search dialog, sort options

You can also access this utility by pressing Ctrl+F.

Figure 76: Alarms Search dialog, input options

The More button allows you to search by two criteria, both of which must be met or either of which must be met in the alarms that the search returns.

124

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 77: Alarms Search dialog, More options

Figure 78: Alarms Search operation, alarms returned, example

To include the children of matching elements in the Inventory, check the Include Child Agents check box. To add criteria that may narrow the list of matches, click the More button and in the next set of fields, define the additional criteria. Repeat this until all of your criteria are established. Then click the Search button.

125

Issue 3 May 2012

6.2

WM Release 4.0 User Guide

Inventory Custom Views You can configure an unlimited number of inventory custom views. These views are filters. As with the base view that was open when the Add Custom View operation was launched, these are not static, but rather are updated as new information becomes available, even while you are examining the view. For example, when the status of a device changes, the new status is shown in the Status column for that device. Whenever the front view in the frame is an inventory view, WM opens a Show Objects with these Properties dialog in response to selection of ViewCustom ViewsAdd Custom View from the main menu. The properties are initially populated with the values of the base view. In the case of an inventory custom view, the Properties tab consists of two forms, connected by Next and Previous buttons.

126

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 79: Properties tab for an inventory custom view, first form

Since this form is a filter, if you do not supply or select a value for a field, the system does not narrow the list of devices that it shows when you open the custom view. Click the Next button to advance to the second form of the Properties tab.

127

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 80: Properties tab for an inventory custom view, second form

Click the Next button to advance to the third form of the Properties tab.

128

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 81: Properties tab for an inventory custom view, third form

Click the Next button to advance to the fourth form of the Properties tab.

129

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 82: Properties tab for an inventory custom view, fourth form

Click the Next button to advance to the fifth form of the Properties tab.

130

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 83: Properties tab for an inventory custom view, fifth form

The final form includes an Additional Criteria button.

131

Issue 3 May 2012

WM Release 4.0 User Guide

If you click this button, WM opens an additional criteria dialog.

Figure 84: Additional custom view criteria dialog, Properties tab

The More button in this window adds a single Property Name/Match Criteria correlated pair of fields each time you click it. To add three pairs, for example, click the More button three times.

132

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 85: Criteria dialog with three properties

The Fewer button removes a pair. To specify what columns your new custom view should include, click the Select Props To View button. tip ................ To add vertical scrolling that you can view and check any available property that is not in the view when this dialog opens, resize the dialog window.

133

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 86: Select Table Columns dialog for inventory custom view

note ............. These fields are read-write as well as selectable. However, you cannot reorder the columns by overwriting the default contents of their text boxes. Moreover, the system will determine the initial column arrangement regardless of the order that you see here. In the actual view, you will be able to rearrange columns for only the current view session.

To specify more columns, click the Additional table columns button.

Figure 87: User defined table columns window for inventory custom view

134

WM Release 4.0 User Guide

Issue 3 May 2012

The More, Fewer, and Remove buttons in this window work the same as in the Criteria Dialog window above. The Display Name and Property Name entries add the property to the list of selectable columns in the previous dialog. A check in the associated check box adds the property as a column to the custom Inventory view. When you are satisfied with the construction of your table, click OK in these table columns windows. Back in the Show object with these Properties window, click the Tree Node Properties tab.

Figure 88: Tree Node Properties tab for inventory custom view

The meanings of these fields are as follows.

Table 7: Tree node properties for event filter view Field

Description

Frame Title

Specify the name to be displayed on the title bar of the custom view.

Menu File Name

Specify the panel‐specific menu file name. If this field is left blank, the default menu is displayed.

Icon File

Specify the icon name (in the WM_ Home/images directory) to use for the custom view. This icon is visible in the tree as well as in the title bar of the custom view.

135

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description

Tree Popup Specify the file name of the menu used to display a contextual menu for the new custom Menu view node in the Navigation tree. Node Index

Specify the position of the custom view in relation to previously added views. If this field is left blank, the view will be appended to the end of the current list of custom views.

When you are satisfied with the view filter that you have constructed, click the Apply Filter button. See also the following other sections of this guide:

6.3



Modifying a Custom View on Page 91



Renaming a Custom View on Page 91



Resizing Columns in a Custom View on Page 91



Removing a Custom View on Page 92

Topology Data Exports WM allows you to export either 

all of the data from the Inventory



only the data of the current scrollable Inventory page.

Procedure 8: To export topology data 1.

Have the desired Inventory view on top in the view panel.

Either ◦

from the main menu, select ActionsExport Topology Data.

◦

press Ctrl+Shift+E.

The Export Data dialog box is displayed.

Figure 89: Export Data dialog

Select the desired option from the radio buttons: Export Entire Custom View Data or Export Displayed Data (only the data that the current Page Length setting of the view frame is allowing into the current display).

Enter the file name in File name field.

Click Export. A status message is displayed.

The exported custom view data file is saved in the WM_ Home/images directory.

136

WM Release 4.0 User Guide

6.4

Issue 3 May 2012

Operations on a Device The Inventory view panel supports right‐click menu options. Right click on an entry in the table to display the drop‐down list of options that are available at that time or for the currently selected (highlighted) network elements. The top‐level selections in these right‐click menus are an identical list of options for all of the various devices. Beneath the top level, some braches are device specific as follows: 

For only PMP AP and SM devices (including OFDM but not PMP 320), the Launch branch includes a link that opens a client session in BAM, the server that processes authentication attempts from SMs and manages their bandwidth service plans and VLAN profiles.



For only high‐speed PTP backhaul master and slave devices that support it, the Launch branch includes a link that launches the PTP LinkPlanner tool.



For only child WMs, the Launch branch includes



−

a link to Client, which opens a WM client session into the child WM.

−

no link to [the device] WebPage like every other element has.

For generic elements (see Generic Elements (Non‐Cambium Devices) on Page 51 for the definition of this device type), the Launch branch is absent.

The options that are available for all elements through their right‐click menu are as shown in Figure 90.

Figure 90: Right-click options common for all elements

137

Issue 3 May 2012

WM Release 4.0 User Guide

Table 8: References for common command options Command Option

138

See Section Titled

Page

Add Relationship

Adding Relationships Among Devices

234

Add to Device Group

Creating a Static Device Group or Adding Devices to a Static Device Group

309 314

Alarms

Viewing Alarms for a Device

202

Apply Template

Applying a Configuration Template

626

Children

Adding Relationships Among Devices

234

Clone Device

Cloning a Device Configuration

635

Components

Viewing Component Properties

200

Configure Device

Using the Configure Device Command

611

Credential Manager

Setting WM Credentials for a Group of Selected Devices

248

Create Report

Creating a Configuration Report

326

Create Template

Creating a Configuration Template

621

Customer Contact Detail

Finding the Customer Assigned to the Device

227

Dashboard

Viewing the Dashboard for a Device

204

Delete Object and Traces

Deleting an Object and Traces

261

Delete Report

Deleting a Configuration Report

337

Delete Template

Deleting a Configuration Template

634

Device Group Membership

Creating and Using Device Groups

299

Device Summary Report

Viewing a Device Summary Report

223

Edit Report

Editing a Configuration Report Template

335

Edit Template

Editing a Configuration Template

629

Element Properties

Viewing Basic Properties

198

Events

Viewing Events for a Device

201

Extended Family

Adding Relationships Among Devices

234

Install Software Upgrades, PMP, PTP, CMM

For PMP, PTP, or CMM devices: Upgrading Devices On Demand, Scheduling a One‐Time or Periodic Task

287 647

Manage Device

Managing or Unmanaging a Device

229

Physical Map

Using the Physical Map

145

Ping Device

Pinging a Device

230

WM Release 4.0 User Guide

Issue 3 May 2012

Command Option

See Section Titled

Page

Reboot Device

Using the Configure Device Command

611

Refresh Stored Data

Refreshing Device Data

248

Run Report

Running a Configuration Report

331

Set Location in Physical Map

Changing the Geolocation for a Device

182

Statistics

Viewing Performance Data for a Device

203

Unmanage Device

Managing or Unmanaging a Device

229

Update Status

Updating the Status of a Device or a Network

195

WebPage

Accessing the Web Interface of a Device

257

Table 9: References for special command options Command Option

See

Page

BAM

Launching BAM

640

Configuration Control

PMP 320 device documentation set and Figure 91

140

Configure Mode

PMP 320 device documentation set and Figure 92

140

PTP LinkPlanner

High‐speed PTP backhaul device documentation set

139

Issue 3 May 2012

WM Release 4.0 User Guide

When the right‐clicked element is a PMP 320 AP, the drop‐down menu includes the following additional options: 

ToolsSpectrum Analyzer. This option is described under Using the Spectrum Analyzer Utility on Page 254.



ToolsConfiguration Control. This option launches the following dialog.

Figure 91: Configuration Control dialog for PMP 320 AP



ToolsConfigure Mode. This option launches the Configure Mode dialog, with the following mode options.

Figure 92: Configure Mode dialog for PMP 320 AP, default values

140

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 93: Configure Mode dialog for PMP 320 AP, Mode BW selections

Figure 94: Configure Mode dialog for PMP 320 AP, Mode Ratio selections

Figure 95: Configure Mode dialog for PMP 320 AP, Mode Map selections

When the right‐clicked element is a PMP 320 CPE, the drop‐down menu includes the option ToolsUpload AAA Certificate to CPE. This option is described under Uploading RADIUS AAA Certificates on Page 284. When the right‐clicked element is a PMP AP, the drop‐down menu includes the following additional options: 

ToolsDrop Subscriber Session. This option is described under Dropping a Subscriber Session on Page 232.



ToolsSpectrum Analyzer. This option, although available in the drop‐down list of commands, is not supported for the PMP AP. Selection of this option spawns the error This operation is not supported for the selected device.



ToolsUpload AAA Certificate to SM. This option is described under Uploading RADIUS AAA Certificates on Page 284.

When the right‐clicked element is a PMP SM, the drop‐down menu includes the following additional options: 

ToolsDrop Subscriber Session. This option is described under Dropping a Subscriber Session on Page 232.



ToolsLink Capacity Test. This option is described under Using the Link Capacity Test Utility on Page 250.



ToolsSpectrum Analyzer. This option is described under Using the Spectrum Analyzer Utility on Page 254.



ToolsUpload AAA Certificate to SM. This option is described under Uploading RADIUS AAA Certificates on Page 284.

141

Issue 3 May 2012

6.5

WM Release 4.0 User Guide

Operations on a Network To see a list of all currently managed networks, click on Networks beneath Inventory in the Applications tree.

Figure 96: Networks panel view

When you right‐click on a network in the list, WM opens a drop‐down list of command options that you can execute upon the selected network. These options are as follows:

6.5.1

Start/Stop Discovery In the Networks panel of the Inventory view, the right‐click menu provides options to Start Discovery and Stop Discovery. When you select Stop Discovery, the discovery process will be halted, but some time may be required for all discovery‐related activities on the selected network to end. This is because WM will continue to try to discover elements that responded to previous messages, even though it ceases sending new discovery‐related messages. For example, preventing discovery of elements that already responded to a broadcast discovery message is not possible.

142

WM Release 4.0 User Guide

Issue 3 May 2012

Stop Discovery also prevents future rediscovery for the selected network, even though rediscovery may be scheduled via the Discovery Configurator (as it is by default every 48 hours). If Stop Discovery is selected, rediscovery is also prevented when WM is stopped and then started, though by default a rediscovery cycle is initiated on WM startup. Select Start Discovery to initiate discovery for the selected network, according to the parameters that are currently set for it in the Discovery Configurator. The results will be displayed in Status column of the Inventory view table. When you select Start Discovery, the chosen network is also eligible for any scheduled rediscovery cycles in the future. A common method for provoking WM into executing a discovery cycle for a network that is not undergoing discovery is to stop and then start discovery for that network.

6.5.2

Status Update for the Network If you select the right‐click Update Status option over a network name, WM performs a status poll on the devices and, if the status poll fails, throws a Major severity alarm indicating that the device is unreachable.

6.5.3

Delete Object and Traces of the Network This selection removes the selected (highlighted) network from the client as well as from the database. important ........... This command is not undoable and can have unwanted consequences. See Deleting an Object and Traces on Page 261.

6.5.4

Credential Manager for the Network If you select the right‐click Update Status option over a network name, WM opens the Credential Manager interface, which allows you to set SNMP and/or Telnet/FTP authentication credentials for the WM to use for its access to each element in that network. See Setting WM Credentials for a Group of Selected Devices on Page 248.

143

WM Release 4.0 User Guide

Issue 3 May 2012

Using the Physical Map WM automatically discovers devices and their logical relations in the network and graphically represents them in the physical map, which is a representation of their physical setting. A click on an element in the physical map opens a small summary window of details such as device status, radio information, and link performance. By design, the physical map represents devices whose 

device type template files were distributed by the installation tool. Additionally, you can represent any other device with a single user‐configurable icon. In this case, the pop‐up window described under Viewing Details on Page 174 contains only device name, its IP address, basic ManagedObject or SnmpNode data, and links to the Inventory view and Fault Management views. It contains no transmitted power level value, operating channel, or other device‐specific information. The map includes parent‐child relationship pointers for these devices based on what type of link they are capable of supporting, but does not include their coverage contours.



device type template is stored on the WM server. In the unlikely case that your server administrator deleted a device type template file after installation because your network did not contain any elements of that device type, and you later add them to your network, your server administrator can replace the missing template, and then the physical map will display those new devices.



whose location coordinates are known to WM. See the following section, Importing the Geo‐ locations on Page 145.

To view the physical map, you can

7.1



right‐click on a device in the Inventory view and select Physical Map from the drop‐down list.



right‐click in a number of contexts to select Physical Map from the drop‐down list. See Displaying the Physical Map on Page 150.

Importing the Geo-locations The geo‐location import feature allows for the import of a comma‐separated‐value (.csv) geo‐location file. This feature is always available, regardless of the client user interface context, and always has the same effect. It does not depend on or apply to currently displayed view. The most common use of the CSV location import is to initialize network element geo‐locations after full discovery of the network. The location import does not create network element entries in Wireless Manager; it only updates the geo‐location of already‐discovered network elements. Often the location import is the only practical way to update the network element geo‐locations, since most devices do not have GPS data and there are usually too many elements to manually update the geo‐ location of each element. Once each device has a geo‐location, WM will plot it in the physical map.

145

Issue 3 May 2012

WM Release 4.0 User Guide

To access the location import feature, from the main menu, select ToolsPhysical MapGeo‐location Import (CSV). This opens a file selection dialog for browsing to select a comma‐separated‐value plain text file. The file must be in the format specified below, including a header and one line per node, where each device line specifies in four columns 1.

the Device Name exactly as displayed in the left column of the Inventory view

its latitude in decimal degrees, where negative numbers indicate west latitude

its longitude in decimal degrees, where negative numbers indicate west south longitude

its height in meters with respect to the ground, as opposed to altitude with respect to sea level

The format of the file is as follows: Version: <version> Create Date: <MM/DD/YYYY HH:MM TimeZone> name, Latitude, Longitude, Height_Above_Ground name, Latitude, Longitude, Height_Above_Ground

Blank spaces in the CSV file are ignored, except in the name field. The name must be in the exact format and syntax that WM uses. No conversion or normalization is performed, except that a colon‐ segmented MAC address is converted, if necessary, to match a MAC address syntax that is known to WM. For example, where WM uses the MAC address as the name, if the MAC address in the WM name field appears as 00 05 12 0C 09 1B, but the MAC address in the CSV file appears as 00:05:12:0C:09:1B (with colons), then the location import feature converts the imported MAC address to match the known MAC address. CSV files can be saved to CSV directly from Microsoft Excel™ and other spreadsheet programs by selecting Save As and choosing the CSV format, accepting any resulting warnings about loss of full spreadsheet functionality. The following is a typical file for a system that uses the MAC address as the network element name: Version: 1 Create Date: 1/24/2008 04 05 13 0C 09 1B, 25.743199, -84.365451, 20 04 05 13 0F 00 ED, 25.745674, -84.36471, 20 04 05 13 0F 01 3E, 25.748955, -84.363566, 20 04 19 59 B4 94 24, 25.750265, -84.360474, 20 04 00 9E 03 7B 50, 25.746677, -84.35942, 20 04 00 9E 03 7B B5, 25.749446, -84.366381, 20 important ........... The import operation discards the top two lines of the file, even if they contain geolocation record formats. Ensure that your geo-location records begin in the third row of data.

When you select ToolsPhysical MapGeo‐location Import (CSV), WM opens the Geo‐location Import window. note ............. The file for import must be accessible to the file system of the client device.

146

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 97: Geo-location Import window

ellipsis button and browse to the proper path. Select the file and click the Open button. Click the Then, back in the Geo‐location import window 

if you want the import operation to occur once and now, click the Run Now button. The GUI includes a progress indicator and buttons that allow you to start, stop, and pause the import operation.

Figure 98: Import CSV File of Geo-Locations window

◦

if you prefer instead to delay the import operation or set it up to repeat, click the Run Later button. The Create Schedule Task dialog opens to its Schedule tab.

147

Issue 3 May 2012

WM Release 4.0 User Guide

For information on how to set the fields of the Schedule tab, see Table 87: Options for scheduling of tasks on Page 667. After setting the schedule for the import task, click the Details tab only if you want to browse to change the file to be imported. If you want the task to import the file that you selected from the Geo‐location Import window, click Save in the Create Schedule Task window. If parsing errors are found (for example, a field with improper characters), a note is placed at the top of the Results section. Invalid values or rows with missing fields are noted on a per‐row basis. If a name does not match that of any discovered node in WM, then the geo‐location information is ignored, and a notice for that node appears in the Results report.

7.2

Importing Addresses You can import a properly formatted file that correlates devices to their height values and street addresses. To access the location import feature, from the main menu, select ToolsPhysical MapAddress Import (CSV). This opens a file selection dialog for browsing to select a comma‐separated‐value plain text file. The file must be in the format specified below, including a header and one line per node, where each device line specifies in three columns:

148

the Device Name exactly as displayed in the left column of the Inventory view

its height in meters with respect to the ground, as opposed to altitude with respect to sea level

its address

WM Release 4.0 User Guide

Issue 3 May 2012

The format of the file is as follows: Version:version Create Date: date Device Name, Height, Address Device Name, Height, Address Device Name, Height, Address

Blank spaces in the CSV file are ignored, except in the name field. The Device Name must be in the exact format and syntax that WM uses. No conversion or normalization is performed, except that a colon‐segmented MAC address is converted, if necessary, to match a MAC address syntax that is known to WM. For example, where WM uses the MAC address as the Device Name, if the MAC address in the WM name field appears as 00 05 12 0C 09 1B, but the MAC address in the CSV file appears as 00:05:12:0C:09:1B (with colons), then the address import feature converts the imported MAC address to match the known MAC address. To the right of the comma that separates the Height column from the Address column, additional commas (which are typical in addresses) are ignored. Any address format that Google supports is also supported by the address import tool and the physical map. CSV files can be saved to CSV directly from Microsoft Excel™ and other spreadsheet programs by selecting Save As and choosing the CSV format, accepting any resulting warnings about loss of full spreadsheet functionality. The following is a typical file for a system that uses the MAC address as the network element name: Version:1 Create Date: 2/4/2008 0A 0A 0A 0A 0A 0F, 6.0961913,Marysol Trail, Cedar Park, TX 0A 0A 0A 0A 0A 0E,6.1564272,123 Main Street, Linden, TX 0A 0A 0A 0A 0A 0B,6.0859231,46 W. Hwy US 183, Tanner, TX important ........... The import operation discards the top two lines of the file, even if they contain address record formats. Ensure that your address records begin in the third row of data.

When you select ToolsPhysical MapAddress Import (CSV), WM opens the Location Import from Address CSV window. note ............. The file for import must be accessible to the file system of the client device.

Figure 99: Location Import from Address CSV

Click the button.

ellipsis button and browse to the proper path. Select the file and click the Import

149

Issue 3 May 2012

7.3

WM Release 4.0 User Guide

Displaying the Physical Map Command options to bring the physical map to the front of the view frame are available throughout the WM user interface: 

In the following areas, if you right‐click on an element, Go ToPhysical Map is an option in the resulting drop‐down list of options and opens with the target element in its center: −

a Network Events view, where the element is identified by the Source by default

−

an Alarms view, where the element is identified by the Failure Object by default

−

an Inventory view, where the element is identified by both its MAC Address, Device Name, and IP Address by default, except the Networks view and Reports views



In the Applications tree, if you right‐click on the Physical Map branch and select ActionsLoad Online/Offline Map, then the selected map type opens.



In the main menu, if you select ToolsPhysical MapLoad Online/Offline Map, then the selected map type opens.

note ............. If you ever encounter an AJAX request timed out error displayed on the physical map, this could be the result of network traffic too high, WM server too busy, or inability of the physical map to respond quickly enough to update requests from your client.

The physical map displays information that it harvests from core management systems within WM, such as performance data or configuration properties. As a result, the physical map may sometimes noticeably lag behind these core systems. For example, you may view a performance data statistic in the performance data Configured Collection view (an example is shown in Figure 269 on Page 382), and then observe that the value in the physical map is sometime later updated to match what you saw in the Configured Collection. This behavior is designed, so that updates in the physical map do not interfere with WM core data gathering and processing. In typical networks, the delay may be imperceptible but, especially while WM is initially discovering thousands of devices in a very large network, the physical map may display the updated information only after minutes or even hours have elapsed. The physical map can be

150



only online: a Google map, licensed and downloaded upon client demand



only offline: tiles loaded into a GeoServer Map Tile Server that is either local or remote to the WM server



either online or offline, where both are available.

WM Release 4.0 User Guide

7.3.1

Issue 3 May 2012

Available Formats for Online Maps A Google physical map is a representation of physical setting expressed as a satellite view, a geographic map with roadways and other prominent features, or a hybrid of both, or a topographic map of the terrain. In any Google map, a menu of map types is either present or available for display, depending on the setting of the WindowMap Type Control option in the main menu of the physical map. See Map Type Control on Page 172. For differentiation between the Google map and the GeoServer map, this guide and the WM client refer to the Google map as the online map. The online map is launched in any of the ways listed in Displaying the Physical Map on Page 150. However, in the cases where the command option is generic (Physical Map), WM opens the offline map instead, if that was the last map that was previously open. Certain features are unique to the online map. These are listed as unavailable in the next section, Format of Offline Maps.

7.3.2

Format of Offline Maps A GeoServer physical map is a static set of tiles downloaded to and available from the Geoserver, whose access from the client is configured in the administration tool. (See Using the Offline Physical Map Panel on Page 691.) For differentiation between the Google map and the GeoServer map, this guide and the WM client refer to the Geoserver map as the offline map. The user experience in this map is identical to that in the online map, except that the following features are never available in the offline map: 

Link profile. See Figure 117: Path Profile on Page 177.



Google search. See Google Search Bar on Page 171.



Show address. See Current Location on Page 173.



Street view. See Accessing the Street View of a Selected Point or Device in the Physical Map on Page 180.



Device repositioning through drag/drop. See Changing the Geolocation for a Device on Page 182.

The predominance of figures in this section that show examples of the physical map are taken from the online map. The following are examples of the offline map, whose features include graphical representations of prominent waterways and densely populated areas. Be aware that your offline maps may vary in appearance from these examples, since your WM server administrator has the flexibility to collect and load into the Geoserver the offline image layers from any of ten different data source types.

151

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 100: Offline map, midwestern USA

Figure 101: Offline map, northeastern Illinois

152

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 102: Offline map, network at a plus zoom factor

Figure 103: Offline map, network at a minus zoom factor

153

Issue 3 May 2012

WM Release 4.0 User Guide

The offline map is launched in any of the ways listed in Displaying the Physical Map on Page 150. However, in the cases where the command option is generic (Physical Map), WM opens the online map instead, if that was the last map that was previously open.

7.4

Generating a Physical Map View of an Element Selected in the Inventory View This section describes how to proceed from viewing an element in the Inventory view to viewing in the physical map in the context of a cluster of elements (where the zoom level causes proximal elements to be obscured by an element icon) or in the context of links in which the element is involved.

Procedure 9: To view an Inventory element in the context of a physical map

154

In the Inventory view, right‐click the element that you want to view in a physical map.

From the drop‐down list of options, select Go ToPhysical Map.

WM Release 4.0 User Guide

Issue 3 May 2012

note ............. The MapCenter selection from the main physical map menu may zoom out to the most negative level of zoom.

7.5

Viewing Collocated and Proximal Elements In some cases, either the level of zoom hides elements beneath other elements in the downloaded physical map or element representations are partially overlaid by the representations of others. This can particularly occur in the following situations: 

where a cluster of PMP APs are collocated with a CMM and a PTP slave device



where only one tower or otherwise high‐elevation venue is available in the area for effective RF communications

Figure 104: Physical map: collapsed instance of device collocation

155

Issue 3 May 2012

WM Release 4.0 User Guide

In the example case above, the PTP master is collocated with a PMP AP that has good links to three PMP SMs. Since the AP is not viewable at any zoom level, the icon pile is represented by a plus sign (). A click on the top icon in the icon pile expands the view to include the cluster that had been represented by the icon with the plus sign.

Figure 105: Physical map: expanded instance of device collocation

Procedure 10: To view an element in a cluster 1.

If the element is part of cluster that cannot be displayed (non‐displayed members of the cluster are represented by +) because of the immediate zoom level, then ◦

to briefly see all other members, either −

click on the +

−

right‐click on the element and select Expand Cluster from the drop‐down list of options.

All members of the cluster, but not necessarily all of the elements to which they currently link, are briefly displayed at the current zoom level. The expansion of the cluster is fleeting. For example, the cluster is collapsed upon the next mouse movement.

156

WM Release 4.0 User Guide ◦

Issue 3 May 2012 to continuously view the other members, from the main Physical Maps menu, select OptionsDisable auto close on clustered elements

and then repeat the steps from the first bullet. If this is checked, the user must click in an unused portion of the map to close expanded clusters. If this is unchecked, expanded clusters close when the mouse cursor moves outside the bounds of the cluster. To view all of the elements that are in link with the selected element, perform the following steps.

Procedure 11: To view linked elements within the same physical map 1.

Use the vertical + / ̶ bar to zoom out.

If all linked elements are not displayed yet, zoom out again as many times as necessary to get them into the map.

157

Issue 3 May 2012

WM Release 4.0 User Guide note ............. The MapCenter selection from the main physical map menu may zoom out to the most negative level of zoom.

158

WM Release 4.0 User Guide

Issue 3 May 2012

note ............. It may be helpful to detach and enlarge the Physical Map, re-center the map, and/or collapse the selections panel to the right of the map. Also, enlarge the confines of the physical map to the extent possible.

7.6

Panning The client keeps data ready for an additional area that surrounds the devices that are currently visible in the physical map. This additional area makes other currently non‐visible elements available to the map as you pan (click and drag to move the focal point). The physical map then displays link lines and coverage contours that are associated with the original devices, even when they link to devices that may be not currently visible in the map. If you pan beyond the edge of the original physical map, then the devices that link to them may become visible, even when the original devices are no longer visible. If a network element is far enough way from the bounds of the original physical map, then its coverage contours are not visible, even if they would actually extend in to the currently visible area. It is also possible that the physical map loses sight of, or is unable to pan widely enough to find, some of the elements that are involved in links with visible elements. This is a limitation of map panning, not of the WM physical map.

159

Issue 3 May 2012

7.7

WM Release 4.0 User Guide

Jumping to a Different Position in a Physical Map From any display of the physical map, you can jump to coordinates that you specify. To do so, right‐ click in the map and select MapShow Address from the drop‐down list of options.

When the map repaints, click on the Enter a new lat/long link and modify the coordinates in the resulting Input dialog.

Click OK. The map jumps to and renders the address of the coordinates that you specified.

7.8

Refreshing a Physical Map The physical map includes the MapRefresh option from the main menu of the map. If the quality of a link changed since the map was last launched, then the color of the line that represents the link will change when you select this option. Following an idle period that is set in the configuration file, the map will automatically be refreshed. The Map menu also includes the Center option, which both zooms out and positions the center of the map at the geographic center of the network that is being viewed.

160

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 106: Refresh and centering options for a physical map

7.9 7.9.1

Setting Physical Map Options Selecting Links, Coverage, and Standards Types to Display on a Map Type As a user, you may select 

one of the following from the link drop‐down list as a type for Link Metric:

For Custom Selection, an Edit Custom link appears: If you click on this link, the custom set of options open as a list that overlays the map:

161

Issue 3 May 2012

WM Release 4.0 User Guide



one of the following from the Air Standard drop‐down list as a type of air interface representation: −

one of the combined types:

−

any from a list that WM bases upon the currently managed elements; for example:

162

WM Release 4.0 User Guide 

Issue 3 May 2012

one of the following options for Coverage representation:

The RSSI Contours option for Coverage displays the contours according to the following color scheme, which is present for reference in the Legend panel at the bottom of the selection frame to the right of the physical map:



one of the following Map options as a type for map background

If you choose no filtering (All Links, No Coverage, All Air Standards), then the physical map uses its own generic color scheme and its own generic legend. Otherwise, the physical map may use other colors and the legend is specific to your selections. Links are represented as lines with a white arrow (chevron) pointing away from the parent element and toward the child. The Legend Filter feature allows you to select the desired quality levels (——— for Poor, ——— for Okay, ——— for Good) of links to display—all, some, or none.

You can set your map to display only a single type of link representation at a time, if you wish: RSSI, Data Rate, Path Metric, RSSI Auto‐Threshold, Jitter, or Logical Links. For each except Logical Links, the quality assessment that the display represents is a relative statement about the particular measure of link quality. For example, if you select Link Data Rate, then the line color summarizes the effectiveness of the link with respect to only the rate at which data travels in the link. If you select RSSI Auto‐Threshold, then the line color indicates received signal expectations derived from a standard error algorithm, as described under Using the RSSI Auto‐Threshold Feature on Page 169.

163

Issue 3 May 2012

WM Release 4.0 User Guide

If the last poll of either of the devices in a link was unsuccessful, then the color of the link between them is red (until the alert for that poll has been cleared). Otherwise, these link colors are based on performance data that is currently in the database and are not intended to reflect the status of either or both devices. (The icon associated with a device in the Inventory view reflects its status.) If logical links are the only known link data for a pair of nodes, or if only logical links are being displayed, they are by default black, and their colors, like that of any other map element, are user‐configurable.

Figure 107: All reliability links selected for physical map

164

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 108: Good reliability links filtered out

If a color is filtered out of the view, a link may disappear and reappear as it experiences better or worse link quality. There is no provision to apply this feature to some links and not apply it to others. If you disable the display for one or more link quality level(s) in a physical map, then you must remember to reintroduce the level(s)—check its link type check box—in any subsequent map where you want lines for links of those quality levels to be painted. The persistence of the filter is shown in the following capture, which was taken of a new map launched before any new change was made in the legend filter.

165

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 109: Good reliability links persistently filtered out from previous physical map setting

When additional elements that exist within the currently mapped area can be seen only by zooming in, the map includes a magnifying glass symbol:

Figure 110: Physical map: further zooming required for viewing more devices

166

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 111: Physical map: All Links, No Coverage, All Air Standards, Map

Figure 112: Physical map: All Links, No Coverage, All Air Standards, Hybrid

167

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 113: Physical map: Logical Links, No Coverage, All Air Standards, Terrain

The main menu of the physical map frame includes the OptionsAdjust contour transparency selection. When you select this option, WM opens an Input window for configuring a percentage.

A higher percentage makes features underneath the contours more visible or legible.

168

WM Release 4.0 User Guide

7.9.2

Issue 3 May 2012

Using the RSSI Auto-Threshold Feature As the first dash list on Page 161 implies, you can set your map to display only a single type of link representation at a time, if you wish: RSSI, Data Rate, Path Metric, RSSI Auto‐Threshold, Jitter, Status Poll State, or Logical Links. RSSI (Radio Signal Strength Indicator) is a relative measure of the strength of a received signal. If you select RSSI Auto‐Threshold from among the specific link type representations, then WM applies a standard error algorithm with current and historical RSSI data (derives recurrence relations) to characterize link reliability into color coding as follows: 

Poor (———) represents greater than 95% likelihood that the current RSSI of the link significantly differs from historical RSSI values.



Okay (———) represents 90 to 95% likelihood that the current RSSI of the link significantly differs from historical RSSI values.



Good (———) represents less than 90% likelihood that the current RSSI of the link significantly differs from historical RSSI values.

Depending on how long the physical map has been displayed, it may be advisable to refresh the RSSI data that the map uses. Select the option ToolsPhysical MapReset Historical RSSI Data from the main WM menu.

7.9.3

Filtering the Icons to Display by Current Alarm Level Both the physical map menu and the element status bar overlay allow you to exclude from display the icons of elements whose current alarm level(s) you deselect. You can exclude or reintroduce them as follows: 

To hide all element icons, in the main menu of the physical map frame, select (check) Status FilterHide All Status Levels.



To selectively exclude elements of one or more status levels, either −

click to uncheck the status level from the Status Filter menu (shown above). For example, to hide the icons of elements whose alarm status is Clear, uncheck Status FilterClear.

−

click Hide for the status level(s) in the Status menu of the Legend panel in the lower right corner of the map.

169

Issue 3 May 2012

WM Release 4.0 User Guide

Both the Status Filter menu and the Status menu reflect changes made in the other. To reintroduce the icons of elements whose alarm status is currently deselected, use either menu.

7.9.4

Setting Whether Elements Appear Based on Zoom The main menu of the physical map includes the OptionsIcons always respect zoom level selection.

If this is checked, equipment is filtered by the zoom level as defined in the configuration file. For example, zooming out to the furthest setting may result in only PTP elements showing. If this in unchecked, the map shows as much equipment as possible, except for equipment that would result in the configured limit being exceeded. For example, if the configured limit is 100, and 1 PTP, 99 PMP devices, and 2 CMM4 devices are present, then the CMM4 devices are not displayed unless the WM server administrator edits the OakleafConfig.xml file to include a zoom level of greater than 100 (in the maxNumDevices tag).

170

WM Release 4.0 User Guide

7.9.5

Issue 3 May 2012

Using or Hiding Other Physical Map Overlays The Window submenu of the main physical map menu contains toggles that keep or hide several other overlays.

note ............. Although no device search utility is present in the physical map, you can often use the Search feature in the client to get a physical map link to a particular device. See Using the Search Utility on Page 92.

Google Search Bar The Google Search Bar allows you to enter a partial or entire string from an address, zip code, phone number, or comma‐space separated latitude/longitude known to Google Maps and click the associated Search button.

The system prints the list of matches above the search box and the map re‐centers onto the location of the top match in the list.

171

Issue 3 May 2012

WM Release 4.0 User Guide

You can then click on any other match to have the map re‐center once again, this time on the location of the target of your click. For any match, the system provides a cloud that contains the name, address, phone number, latitude, and longitude (to the extent that these are known) of matching entity.

Map Type Control The WindowMap Type Control option allows you to hide or reinstate the Map drop‐down menu that overlays the physical map in the far upper right corner.

This menu controls whether the physical map backdrop for the network portion being viewed is a Google map, a photo taken from a satellite, a topographic representation of altitude differences within the area of the map, or the topographic representation with streets and highways overlaying the area (Hybrid). To see examples of these backdrops, see the figures included in Selecting Links, Coverage, and Standards Types to Display on a Map Type on Page 161.

172

WM Release 4.0 User Guide

Issue 3 May 2012

If you hide (uncheck) these filter menus from overlay in the physical map, you can reinstate them at any time by checking the WindowMap Type Control option.

Zoom Control The WindowZoom Control option allows you to hide or reinstate both the zoom control (the vertical, incremented bar) and the re‐center control in the upper left corner of the physical map. These two controls are inseparable. Re‐center control. Clicking on the arrows, clockwise from top, re‐centers the map to the north, east, south or west. Clicking on the hand symbol re‐centers the map on its previous center.

This scale zooms the map in (+) or out (‐) by a single increment when you click the plus or minus sign or by single or multiple increments when you click a hash in the scale.

If you hide (uncheck) these controls from overlay in the physical map, you can reinstate them at any time by checking the WindowZoom Control option. Alternative means are also provided for re‐centering the map and for zooming: 

To re‐center the map at a point within the current physical map display, right click on that point and select Center from the resulting drop‐down list of options.



To zoom in to the fullest extent on any point within the current physical map display, right click on that point and select Zoom from the resulting drop‐down list of options. This both re‐centers and zooms the map in a single repaint operation.

Current Location The WindowCurrent Location option allows you to prevent (unchecked) the Current Location bar

from popping up (for example, whenever you click in the physical map or when you right‐click on an element in the map and select MapShow Address) or permit it to pop up (checked). If you prevent it from popping up, you can reinstate it at any time by checking the WindowCurrent Location option.

173

Issue 3 May 2012

WM Release 4.0 User Guide

Map Scale The WindowMap Scale option allows you to hide or reinstate the scale indicator in the far bottom right corner of the physical map.

If you hide this indicator, you can reinstate it at any time by checking the WindowMap Scale option.

Lat/Long Display If the WindowLat/Long Display option is checked, the map display includes an overlay with the running coordinates above which the mouse cursor travels and hovers.

If this is unchecked, the coordinates are not shown.

7.10

Viewing Details in the Physical Map note ............. Many of the options described in this section provide performance statistics for an element. Depending on how long the physical map has been displayed, it may be advisable to refresh the data that the map uses. You can do so by selecting the option ToolsPhysical MapsRefresh Physical Map Data from the main WM menu. When you do, the system may require as much as five minutes to reflect the latest changes. During this wait, selecting MapRefresh from the menu bar of the physical map may shorten the time required to reflect them.

7.10.1

Accessing Data for a Device in the Physical Map In addition to representing a node by a symbol and graphically representing its links and contours, the physical map launches a pop‐up when you click on any node. This pop‐up provides basic information about the node and information about its radios and links. You can also launch this pop‐up through a right‐click on the device icon followed by selection of Open from the resulting drop‐down list of options.

174

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 114: Device data pop-up, Main tab

Figure 115: Device data pop-up, Radios tab

175

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 116: Device data pop-up, Links tab, scrolling required

176

WM Release 4.0 User Guide

Issue 3 May 2012

For some data, a Plot link is provided to open the Collected statistics window and graph the collected statistics. (See Viewing a Collected Performance Statistic on Page 386.) The statistics for which this convenience is provided depends on device type as follows: 

For an AP or SM, the Links tab provides links to plot dBm and Jitter.

note ............. Color coding (for example, ) summarizes Jitter by the following arbitrary standards: ≤ 4 is Good (green), >4≤8 is Okay (yellow), >8 is Bad (red).



For an SM, the Radios tab provides a link to plot Rx Power.



For an AP, the Radios tab provides no link to plot Tx Power.



For a PTP device −

−

the Radios tab provides links for plotting 

Frequency



Data Rate



Tx Power



Rx Power

the Links tab provides links for plotting 

Mbps



dBm

The Links tab includes Status Poll State, whose associated box color represents whether the last poll of the devices succeeded ( ) or failed ( ). This item includes an associated Show link, which when clicked opens the Alarms view of the device to display the time stamp of an unsuccessful poll among other events that generated alarms and that thus may suggest reasons why the poll did not succeed. Where topographic information from the United States Geological Survey (USGS) is available, the path Profile link opens a representation of the linear heights plot for the center of the RF beam against the varying heights of the terrain that lies between two linked devices.

Figure 117: Path Profile

177

Issue 3 May 2012

WM Release 4.0 User Guide

Where the topographic information is not available, an error indicates so. Where applicable, the tabbed pop‐up also provides click‐through links to launch 

the management web interface (device settings) of the device. See Figure 182 on Page 257.



an Alarms view that lists the alarms, including those of Clear status, generated for only that device. See Figure 139 on Page 202.



the network element dashboard for the device. See Viewing the Dashboard for a Device on Page 204.



a Network Events view that lists the events generated for only that device. See Figure 138 on Page 202.



an Inventory view that lists default Inventory information about that device.



the Configured Collection of performance statistics for that device. See Figure 140 on Page 203.

Figure 118: Device data pop-up, Manage tab, scrolling required

178

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 119: Device data pop-up, Manage tab for a PTP device

The Manage tab for a PTP device includes a link (shown above) that launches the PTP LINKPlanner tool. For any device whose air interface standard is unknown to WM, the physical map represents the device with a question mark.

Figure 120: Question mark representing device of unknown type

7.10.2

Accessing the Geolocation of a Selected Point or Device in the Physical Map To find the geolocation for any point in a physical map, right‐click on that point and then select Show Address from the drop‐down list of options.

179

Issue 3 May 2012

WM Release 4.0 User Guide

To find the geolocation for any device in a physical map, right‐click on the device and then select MapShow Address from the drop‐down list of options.

7.10.3

Accessing the Street View of a Selected Point or Device in the Physical Map To open a street‐level view of any point in the physical map, right‐click on that point and then select Street View from the drop‐down list of options.

Where a street view is available, Adobe Flash Player will launch the view.

To open a street‐level view of any device in the physical map, right‐click on the device and then select MapStreet View from the drop‐down list of options.

180

WM Release 4.0 User Guide

Issue 3 May 2012

Where a street view is available, Adobe Flash Player will launch the view.

7.10.4

Accessing a Physical Map Device in Other Management Views You can quickly jump from viewing a device in a physical map to viewing its records in any of the following other management views. Access is through a right‐click on the device and then selection of the intermediate menu item Manage in the resulting drop‐down list of options.



Select Alarms to see all of its current alarms in the Alarms viewer. See Figure 139 on Page 202.



Select Events to see all of its current events in the Network Events viewer. See Figure 138 on Page 202.



Select Inventory to see the element isolated in a table of Inventory columns.

181

Issue 3 May 2012

7.11

WM Release 4.0 User Guide

Importing a BroadbandPlanner Prediction The ToolsPhysical MapMap Import/ExportImport BroadbandPlanner Prediction option from the main menu allows you to bring into the physical map the CSV‐formatted output from the BroadbandPlanner tool. When you execute this option, WM opens a file browser window.

Figure 121: Import BroadbandPlanner Prediction dialog

browse button. Browse to and select the CSV file from the tool's export, then click the Click the Import button.

7.12

Changing the Geolocation for a Device To change the geolocation records in WM for any device in a physical map, either 

click, drag, and drop the device icon.



right‐click on the device in the physical map and then select Change Location from the drop‐ down list of options.

Select Change Location.

A map tack centers on the original location and a pop‐up cloud describes options for changing the records.

You can also raise the Change Location cloud options from the Inventory. Right‐click on the device. In the drop‐down list of command options, select Set Location in Physical Map.

182

WM Release 4.0 User Guide

Issue 3 May 2012

Right‐click the element icon and select Set Location.

Wait for the records to be updated and the icon to be moved.

Click at the new location to fix the map tack and then click the Save button.

Confirm that the map reflects the new location and note whether the location configured in the element is updated to match the new location configured in the WM database.

183

Issue 3 May 2012

7.13

WM Release 4.0 User Guide

Checking the Log of a Physical Map The main menu of the physical log includes the OptionsToggle Log Window selection.

This alternately opens and closes the Log Window, which contains messages about map activity that can be useful for troubleshooting.

Figure 122: Physical map Log window, opened

7.14

Exporting a Map The tools menu allows you to

184



export the physical map as a kml file.



store it for viewing in Google Earth.



export the devices from the map to the BroadbandPlanner tool.



export the network from the map into the XML format.



export a location file for use in a child WM.

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 12: To export a physical map 1.

To optionally refresh the map before saving it, select MapRefresh from the physical map menu.

From the main WM menu, select ToolsPhysical MapMap Import/ExportGenerate KML Export.

Select the Save File radio button and click OK.

Modify the file name from its default (WM_export.kml).

Click the Save button.

To optionally view the exported file, select ToolsPhysical MapMap Import/ExportView KML Export.

note ............. The response to this option is identical to the response to Generate KML Export.

Select the Open with radio button, and click OK.

note ............. The web browser handles this request in the manner in which it is configured to handle kml files. It may prompt about whether to open or save the file, open a file browser that prompts for a destination path and file name, or open a view of the map in the Google Earth web site.

If necessary, specify Google Earth as the helper application.

185

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 123: Exported physical map in Google Earth application, zoomed in

186

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 124: Exported physical map in Google Earth application, zoomed out

In the Places box in the left panel of their site, scroll down to Temporary Places.

10. Under Temporary Places in the hierarchy, right‐click on the file WMS_export.kml that is associated with the latest date and time. 11. From the drop‐down list of options, select Save to My Places. 12. To rename the file a.

right‐click the file name and select Rename from the drop‐down list.

overwrite WMS_export with a unique name for the file.

click in a blank area to save the new file name and exit the name editing text box.

13. To view information about the mapped elements a.

expand the kml file node in the Places box and expand the Network Elements node beneath it.

187

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 125: Places box with Network Elements node expanded

to see further information about a particular element, click the element node.

Figure 126: Radio(s) link to information about the element

188

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 127: Information about the element in Google Earth

scroll to view information about rest of the elements.

14. To view information about the links a.

expand Latest Links and its child nodes.

Figure 128: Places box with links node expanded

click on the node associated with the OTA link.

189

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 129: Link information in Google Earth view

15. To save the map of network elements to a compressed (kmz) file a.

right‐click the Network Elements node and select Save As from the drop‐down list.

browse to and select the folder in which you want to save the map.

back in the Save file window, click the Save button.

16. To attach a kmz file of the network elements map to new email, right‐click the Network Elements node and select Email from the drop‐down list. 17. To save the map of links a.

right‐click the links node and select Save As from the drop‐down list.

browse to and select the folder in which you want to save the map.

back in the Save file window, click the Save button.

18. To attach a kmz file of the links to new email, right‐click the links node and select Email from the drop‐down list.

7.15

Exporting Devices to BroadbandPlanner To export devices from the physical map into a text file that Broadband Planner can import and use, select ToolsPhysical MapMap Import/ExportExport Equipment to BroadbandPlanner from the main menu of the WM client application. The Choose file name and location for export dialog opens. (Location in the context of this window title means file system path.)

190

WM Release 4.0 User Guide

Issue 3 May 2012

Browse to and select the repository from which you will want to send/transfer the text file to the tool.

7.16

Exporting the Network into XML To export the network from the physical map into an XML file for use in another system such as a child WM, select ToolsPhysical MapMap Import/ExportExport Network to XML from the main menu of the WM client application. The Choose XML file name and location for export dialog opens. (Location in the context of this window title means file system path.)

Browse to and select the repository from which you will want to send/transfer the XML file to the other system.

191

Issue 3 May 2012

7.17

WM Release 4.0 User Guide

Exporting Locations for Use in a Child WM To export the device locations from the physical map into a CSV file for use in a child WM, select ToolsPhysical MapMap Import/ExportExport WM Location Import File from the main menu of the WM client application. The Choose CSV file name and location for export dialog opens. (Location in the context of this window title means file system path.)

Browse to and select the repository from which you will want to send/transfer the CSV file to the other system.

7.18

Notices Regarding Physical Maps On rare occasions, WM will returns a warning to the top of the map, and the flag to the far right in the main physical map menu bar, when you try to display a representation that cannot be displayed in a physical map; for example

The following are other examples:

192



if WM has no configured location for the device that was selected when you launched the physical map



if you select a set of devices that are so far apart that, at the required zoom level, the devices would be invisible

WM Release 4.0 User Guide 

Issue 3 May 2012

if the zoom level that would be required for the map to include all alarms (the normal approach for WM in ordering the tile from the map server for download) is not possible

The physical map may occasionally display the error: AJAX requested time out... This indicates that either network traffic is high or the WM server is especially busy and not responding quickly enough to requests that the client is making for updates in the physical map.

193

WM Release 4.0 User Guide

Issue 3 May 2012

Viewing Information About a Specific Device

8.1

Updating the Status of a Device or a Network The status of a device or the network itself is automatically updated on a regular interval via the process of status polling. By default, WM automatically checks and monitors the connection and network status for a device every 15 minutes and displays the current status in the client. The mechanism of status polling can be global or be set to specific for each device type but, in general, it is a request for the device to respond. If the device responds, it is considered reachable and its status is unchanged. If it does not respond, an unreachable alarm is thrown, and the status of the device becomes Major. You can work from default status polling information, force status polling (see Updating Status on Demand below), or reconfigure how WM performs status polling (see Adjusting the Status Polling Intervals on Page 195).

8.1.1

Updating Status on Demand By selecting the Update Status option from the device‐specific menu, you manually update the status. For example, if WM polls the status of a router every 900 seconds, and you want to know the latest status of that router without waiting until the next polling cycle occurs, use this option. This makes the latest status information for the device available to both the client and the database.

8.1.2

Adjusting the Status Polling Intervals Each statistic (for example, the number of bytes that have been received on a wireless interface) represents one characteristic or attribute of the device at a particular time. From the main menu, the ToolsPolling Configuration opens the Polling Configuration dialog to its Performance Polling tab. When this dialog opens, click the Status Polling tab.

195

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 130: Polling Configuration dialog, Status Polling tab

WM inherits the single global performance polling configuration for every device type from the value of the GlobalStatusPollingInterval tag in the file .../wm/server/conf/WibbWMSConfiguration.xml in the WM server file system. The initial (installed) value of this tag is 15 minutes. If you wish, you can leave this configuration in force by not using this tab. This tab in the client interface allows you to override those configurations by setting the status polling via SNMP queries to 

occur (Enable Polling Status checked).



not occur (Enable Polling Status unchecked).



not occur for device types that you specify, and occur for all other device types. (See Procedure 13 below.)



occur at the Global Polling Interval for all devices types.



occur at intervals that you set (Polling Interval in Minutes) for each device type that you deliberately Add for status polling interval configuration, and occur at the Global Polling Interval for device types that you do not Add. (See Procedure 13 below.)

To set some or all device types that you specify to be polled for status at a rate different from the Global Polling Interval, perform the following steps.

Procedure 13: To set status polling for a specific device type 1.

196

Click the Add button associated with the Specific Type Based Polling Configuration block of the Polling Configuration dialog. The Configure Specific Type Polling dialog opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 131: Configure Specific Type Polling dialog for status polling

In the Specific Type field, use the drop‐down list to select the device type.

If you want to disable polling for the device type that you selected, uncheck the Enable Polling check box.

If you want polling of your selected device type to occur at an interval that differs from the Global Polling Interval in the previous dialog, type the number of Minutes into the Polling Interval text box or use the drop‐down list to change from Minutes to Hours type the number of hours into the text box. The following rules apply to resetting polling intervals:



The smallest accepted polling interval is 1 minute.



The largest accepted polling interval is 24 hours (1440 minutes).

When you are finished either disabling polling or specially setting the polling interval for the selected device type, click the OK button. The device type with its newly set polling status (disabled or special interval) is displayed in the Specific Device Type Polling Configuration block of the Polling Configuration dialog.

note ............. If you attempted to apply an illegal interval, the client throws a pop-up error.

for a value too small:

for a value too large:

note ............. If you attempted to apply an interval identical to the global polling settings, the client asks for confirmation.

197

Issue 3 May 2012

WM Release 4.0 User Guide

8.2

Back in the Polling Confirmation dialog, you can use ◦

the Remove button to return a highlighted device type to global polling treatment

◦

the Modify button to change the settings (in a dialog like that shown in Figure 268 above, but with the device type preselected and not changeable) that you previously made by the procedure.

◦

the Reset to Defaults button to restore all polling intervals for all device types to the value of the GlobalStatusPollingInterval tag in the file .../WM/server/conf/WibbWMSConfiguration.xml in the WM server file system.

Viewing Basic Properties Procedure 14: To view device details 1.

In the Inventory view, right‐click the target device.

From the drop‐down list of options, select Element Properties. The Element Properties dialog opens with the network/device properties.

Figure 132: Element Properties, General tab

198

To view the SNMP properties of the device, click SNMP in the left panel.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 133: Element Properties, SNMP tab

To view details of WM monitoring the device, click Monitoring in the left panel.

Figure 134: Element Properties, Monitoring tab

199

Issue 3 May 2012

WM Release 4.0 User Guide

To view relationships that have been detected for the device, click Relationship in the left panel.

Figure 135: Element Properties, Relationship tab

8.3

Viewing Component Properties Use the Components option in the device‐specific menu to display the components for the selected device. For multi‐agent devices, information about both the agent representing the radio and the agent representing the host will be displayed.

Procedure 15: To view component details 1.

In the Inventory view, right‐click the target device.

From the drop‐down list of options, select Components.

Figure 136: Show Components panel

200

WM Release 4.0 User Guide

Issue 3 May 2012

To view the properties that WM is currently storing for the device ◦

select a component from the table in the Show Components window.

◦

click the Properties button.

To view current properties, click the Update Status button. note ............. This is the way to view the status from multiple SNMP agents. By contrast, using the rightclick option and selecting Update Status from the drop-down list of options results in a status update of only the agent for the radio.

Figure 137: Component Properties window

8.4

Change any of the read‐write properties that you want to update.

To save the properties that you are viewing, click the Save to database button.

Viewing Events for a Device Procedure 16: To view events generated for a device 1.

In the Inventory view, right‐click the target device.

From the drop‐down list of options, select Go ToEvents.

The Network Events Viewer is displayed, which shows all the events for only that device.

201

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 138: Network Events view for a single device

For more information on Network Events Viewer, refer to Viewing All Events on Page 347.

8.5

Viewing Alarms for a Device Procedure 17: To view alarms generated for a device 1.

In the Inventory view, right‐click the target device.

From the drop‐down list of options, select Go ToAlarms.

The Alarms view is displayed, showing all the alarms that are generated for only that device. An example of the Alarms view for a single element in as follows.

Figure 139: Alarms view for a single device

202

WM Release 4.0 User Guide

8.6

Issue 3 May 2012

Viewing Performance Data for a Device Procedure 18: To view performance data of a device 1.

In the Inventory view, right‐click the device.

From the drop‐down list of options, select Go ToStatistics.

The performance data Configured Collection view is displayed. The performance data is not intended to reflect the status of the device. The icon associated with a device in the Inventory view reflect its status.

Figure 140: Performance data Configured Collection view for a single device

For information on the Configured Collection view, refer to List of Available Performance Statistics (Configured Collection) on Page 382.

203

Issue 3 May 2012

8.7

WM Release 4.0 User Guide

Viewing the Dashboard for a Device For each device of a supported device type, the WM client displays upon demand a module of text and graphics that summarizes the status based on retrieved performance data, configuration properties, events, alarms, status, and basic managed object properties. Access to this dashboard is by any of the following means: 

a double click on the device in the Inventory



a right‐click on the device in the Inventory and then selection of Dashboard from the resulting drop‐down list of options



a click on the device in the physical map and then a click on the Dashboard link in the Manage tab of the data pop‐up window

The dashboards vary in format somewhat, from one device type to another, but only to the extent that the sets of data that they make available to WM differ. The client does not limit the number of network element dashboard windows that you can simultaneously have open (except only one per device) and allows you to independently move or reduce each of them. Immediately beneath the menu bar, each network element dashboard contains a status bar whose color, as well as text, indicates the current status of the element with its Device Name and Name (ID).

8.7.1

Examples of Network Element Dashboards Examples of network element dashboards are shown in

204



Figure 141: Dashboard format for PMP AP on Page 205



Figure 142: Dashboard format for PMP SM on Page 206



Figure 143: Dashboard format for PMP 320 AP on Page 207



Figure 144: Dashboard format for PMP 320 CPE on Page 208



Figure 145: Dashboard format for PMP OFDM AP on Page 209



Figure 146: Dashboard format for PMP OFDM SM on Page 210



Figure 147: Dashboard format for PMP BHM on Page 211



Figure 148: Dashboard format for PMP BHS on Page 212



Figure 149: Dashboard format for PTP 500 Master on Page 213



Figure 150: Dashboard format for PTP 800 Slave on Page 214



Figure 151: Dashboard format for CMM3 on Page 215



Figure 152: Dashboard format for CMM4 on Page 215



Figure 153: Dashboard format for 14‐Port Switch on Page 216



Figure 154: Dashboard format for Generic Element on Page 216



Figure 155: Dashboard format for Extreme Switch on Page 217



Figure 156: Dashboard format for RAD Switch on Page 217



Figure 157: Dashboard for a child WM element on Page 218

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 141: Dashboard format for PMP AP

205

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 142: Dashboard format for PMP SM

206

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 143: Dashboard format for PMP 320 AP

207

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 144: Dashboard format for PMP 320 CPE

208

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 145: Dashboard format for PMP OFDM AP

209

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 146: Dashboard format for PMP OFDM SM

210

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 147: Dashboard format for PMP BHM

211

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 148: Dashboard format for PMP BHS

212

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 149: Dashboard format for PTP 500 Master

213

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 150: Dashboard format for PTP 800 Slave

214

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 151: Dashboard format for CMM3

Figure 152: Dashboard format for CMM4

215

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 153: Dashboard format for 14-Port Switch

Figure 154: Dashboard format for Generic Element

216

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 155: Dashboard format for Extreme Switch

Figure 156: Dashboard format for RAD Switch

217

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 157: Dashboard for a child WM element

218

WM Release 4.0 User Guide

8.7.2

Issue 3 May 2012

Features of Network Element Dashboards Each network element dashboard window includes a series of icons in the upper right corner and a variety of options available from the menu bar in the upper left corner. Clicking on these icons or making a selection from the dashboard menu has the following results.

Table 10: Command options from a network element dashboard Icon

Menu Item

Result

ViewPhysical Map

opens the physical map and zooms to the device. See Accessing Data for a Device in the Physical Map on Page 174.

ViewInventory

opens an Inventory viewer that contains only this device.

ViewLogical HierarchyExtended Family

opens an Extended family for Device Name graphical view that includes all members of parent‐child relationships, the set of which includes the device whose dashboard you are viewing. These are logical relationships that either the operator configured (see Adding Relationships Among Devices on Page 234) or WM inferred, based on their geo‐locations and device types (see Checking Relationships Presumed Based On Geo‐locations on Page 232).

ViewLogical HierarchyChildren

opens an Inventory view that includes all devices to which the device whose dashboard you are viewing is configured as the parent. These are logical relationships that either the operator configured (see Adding Relationships Among Devices on Page 234) or WM inferred, based on their geo‐locations and device types (see Checking Relationships Presumed Based On Geo‐locations on Page 232).

ViewStatistics

opens a Configured Collection viewer that contains statistics for only this device. See Figure 140 on Page 203.

ViewAlarms

opens an Alarms viewer that displays only alarms that are associated with the device whose dashboard you are viewing. See Figure 139 on Page 202.

ViewEvents

opens a Network Events viewer that displays only events that are associated with this device. See Figure 248 on Page 346. polls the individual device for its latest data and updates the dashboard when it receives that data. If you do not use this option, then the data in a dashboard refreshes in the amount of time required for the server to detect a change and the client to reflect the changed information that it receives from the server.

ViewComponents

opens a Show Components window that includes the MAC and IP addresses, SNMP version, and up time for each agent in this device. See Figure 136 on Page 200.

LaunchWebPage

opens a Web Page URL window with an OK button that provides HTTP access to the management web page of this device. See Figure 182 on Page 257.

219

Issue 3 May 2012 Icon

220

WM Release 4.0 User Guide

Menu Item

Result

ConfigurationConfigure Device

opens the Edit Device Name dialog to the Configuration Groups for which WM can push values to the device. See Using the Configure Device Command on Page 611.

ConfigurationConfiguration TemplatesApply Template

opens an Apply Template dialog to the names and associated descriptions and versions of all configuration templates that have been imported or created and are proper for the device type of the device. See Pushing Values from a Prestructured Configuration Template on Page 619 and Applying a Configuration Template on Page 626.

ConfigurationConfiguration TemplatesCreate Template

opens a Create Template dialog that displays all of the configurable attributes for which WM can push values to the device, and for each an option to include or exclude it from the template being created. See Creating a Configuration Template on Page 621.

ConfigurationConfiguration TemplatesEdit Template

opens an Edit Template dialog that displays all of the configurable attributes for which WM can push values to the device, and for each an option to include or exclude it from the template being created. See Editing a Configuration Template on Page 629,

ConfigurationConfiguration TemplatesDelete Template

opens a Delete Template dialog to the names and associated descriptions and device types of all configuration templates that have been imported or created and are proper for the device type of the device. See Deleting a Configuration Template on Page 634.

ReportsDevice Summary Report

opens a preconfigured report, formatted in blocks for Current Alarms, Last 10 Events, Configuration Data, and Performance Data of the device. See Viewing a Device Summary Report on Page 223.

ReportsConfiguration ReportsRun Report

opens an Execute Configuration Report dialog to the names and associated descriptions and device types of all configuration reports that have been imported or created and are proper for the device type of the device. See Running a Configuration Report on Page 331.

ReportsConfiguration ReportsCreate Report

opens a Create Report dialog that displays all of the configurable attributes for which WM can push values to the device, and for each an option to include or exclude it from the report being created. See Creating a Configuration Report on Page 326.

ReportsConfiguration ReportsEdit Report

ReportsConfiguration ReportsDelete Report

opens an Delete Report dialog to the names and associated descriptions and device types of all configuration reports that have been imported or created and are proper for the device type of the device. See Deleting a Configuration Report on Page 337.

WM Release 4.0 User Guide

Icon

Menu Item

Issue 3 May 2012 Result

KinParent

opens a network element dashboard view that includes the devices to which the one whose dashboard you are viewing is configured as the child. This is a logical relationship that either the operator configured (see Adding Relationships Among Devices on Page 234) or WM inferred, based on their geo‐locations and device types (see Checking Relationships Presumed Based On Geo‐locations on Page 232). If a dashboard view of the parent device is already open, then it closes and reopens with current data from the database.

KinChildrenChild

opens a network element dashboard view that includes all devices to which the device whose dashboard you are viewing is configured as the parent. These are logical relationships that either the operator configured (see Adding Relationships Among Devices on Page 234) or WM inferred, based on their geo‐locations and device types (see Checking Relationships Presumed Based On Geo‐locations on Page 232). If a dashboard view of the child device is already open, then it closes and reopens with current data from the database.

If the database contains no value for one or more of the statistics that the dashboard is preset to display for the device type, then the panel displays the message No value to plot. If the specific device type does not support responding to SNMP get queries for the statistic that the panel would otherwise display for the device type, then the panel displays the message Unable to read from device. Examples of these cases are shown in Figure 158.

Figure 158: Dashboard panels without data

8.7.3

Interactive Components of Network Element Dashboards The tabular data, graphical representations, and underscored text within a dashboard are links as well. For example, if you 

double click in a row of the Alarms table, then an Alarms view opens to only that alarm.



double click in a row of the Events table, then a Network Events view opens to only that event.



double click in a row of the Session Table of a PMP AP or PTP master dashboard, then the dashboard of the in‐session SM that you clicked on opens.



click on a line graph (such as Registered SM Count for a PMP AP or PTP master, Radio Power Level for a PMP SM, or Port‐N statistic for a CMM4 Switch) or other statistical representation (such as the thermometer in a Temperature panel, then a Collected statistics for Device Name window opens. Although it opens to a line graph of the same statistic, the Time of Collection in this window is initially 24 hours and adjustable to today, the last one week, or

221

Issue 3 May 2012

WM Release 4.0 User Guide

any custom time frame that you configure in this window. You can also change the graph type to any option listed in Table 28 on Page 384. This view supports zooming, auto‐ranging, printing, and saving as a PNG file. These options are available through a right‐click anywhere in the graph area. (see Viewing a Collected Performance Statistic on Page 386). 

click on GPS Satellites Tracked or GPS Satellites Visible for a CMM, then a Collected statistics for Device Name window opens. In this case, it contains a line graph that is convertible to a different time frame or different graph type or table, as described immediately above and shown below.

Figure 159: Collected statistics window for GPS Satellites Tracked

222



click on Wired Link Status, then a Collected statistics for Device Name window opens. In this case, it contains only a table view that plots the Time of Collection against the Ethernet status (Up or Down) that the device detected at that time.



click on Number of Ports for a generic element or any of the following links for a child WM element, then the Collected statistics window is fully convertible, as described for Registered SM Count above: −

Number of Managed Objects

−

Number of Networks

−

Number of Nodes

−

Event Count

−

Alert Count

−

Free Memory

WM Release 4.0 User Guide

8.8

Issue 3 May 2012

Viewing a Device Summary Report WM provides a preconfigured report for any device that you select from the Inventory view. Each is formatted in blocks for 

Current Alarms



Last 10 Events



Configuration Data



Performance Data

By default, device summary reports are accessible to every user. This access continues unless the administrator removes the permission for a specific user. Despite permissions settings, user access to device summary reports may also be limited by custom view scopes to which the user is assigned. WM does not filter out any of the configuration or performance data or process any into summary data, but instead simply delivers the values from the response that the device sends to the query. These reports are available on demand as preconfigured (as described in the next section). They are also available through scheduled tasks. See Scheduling a One‐Time or Periodic Task on Page 647.

8.8.1

Running a Device Summary Report on Demand From any Inventory view, you can launch a report of this type by right‐clicking in the row of the target device and selecting ReportsDevice Summary Report. An HTML window opens to the entire report.

223

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 160: Device summary report for a PMP 430 SM

224

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 161: Device summary report for a child WM element

225

Issue 3 May 2012

WM Release 4.0 User Guide

The report delivers the SNMP data in raw values. For example, the table expresses enabled/disabled flags as integers.

8.8.2

Running a Device Summary Report on a Schedule Running a device summary report is a schedulable task in the WM client. See Scheduling a One‐Time or Periodic Task on Page 647.

8.8.3

Saving a Device Summary Report As soon as you launch a device summary report, WM automatically saves it into a repository that contains in list from all previously launched reports that have not been deleted from the list. You can access this repository by selecting System ReportsReport Results from the Applications Tree. This list is sortable by any of its columns: 

Result File Name (in the format ReportName_SequentiallyAssignedReportNumber, so that within each alpha sort of report name, the order is chronological)



User (who launched the report)



Time (date and time)



Report Name



Report Type

Figure 162: Report Results window

Since the reports in the list are not searchable, and since the list of stored reports tends to grow over time, sorting is useful. Secondary sorting is achievable by sorting the secondary sort column first, then the primary sort column. To view an individual report in the Report Results view, right click on the target report and select View Report. This opens the report in the exact format and window size that the report opened in when you originally launched it. note ............. When the system assigns the name to a device summary report, the name does not inherit the Name (ID) or Device Name of the subject device, and the Search function in the client does not search the contents of the Report Results repository. So, as you are reviewing a report that you may want to later easily retrieve, you should copy or print the contents as follows.

226

WM Release 4.0 User Guide

Issue 3 May 2012

As with the system reports that WM formats into vertical blocks, the report dialog does not include an export option. However, to dump a portion (such as the contents of a block) of the HTML data that the report returns to a file type that an another application can read or a script can use, you can mark the portion of interest and copy it out. This could be especially useful for portions that are not the subject of any reports that you can launch via System Reports. (See Using Configuration Summary Reports on Page 339.) You can reshape the HTML window, but not manually resize its columns or sort by their content. However, you can export the entire report as CSV for use in another application or Print the entire report on any networked printer.

8.8.4

Deleting a Device Summary Report To permanently remove a device summary report, open the list of available report results by selecting System ReportsReport Results from the Applications Tree. Right‐click on the report that you want to remove, and select Delete Report.

8.9

Finding the Customer Assigned to the Device The Inventory view provides a command option to immediately retrieve the full set of contact data for a customer who is assigned to (associated with) a particular device. The access to this information is through a right‐click on the target device and selection of Customer Contact Detail from the drop‐ down list of options. In the case where no customer has been assigned to the device yet, the system respond with the following message:

If you click Yes, then a Customer Contact Management opens and displays a list of all customer‐ device assignments that exist in the database.

Figure 163: Customer Contact Management window

If no record exists yet, then the Assign To and View Detail buttons are inactive, and the only operation that this window permits is to Close it. If any record already exists, then the Assign To and View Detail buttons in this window are active. If you want to add the device to a listed customer record, click to highlight the row of the customer, then click the Assign To button. The target device is assigned to the selected customer.

227

WM Release 4.0 User Guide

Issue 3 May 2012

Performing Other Operations on Devices

9.1

Keeping Device Identifiers Unique To avoid confusion in the client application and problems in device discovery, it is imperative to avoid assigning the same value to certain device attributes of more than one managed device; for example 

Device Name should be unique, so that records that you view apply to only the device whose records you want to view



IP Address must be unique, so that WM internal operations keyed to device IP address, as well as user operations, are not subject to corrupt or mottled data. To keep them unique, ensure −

that authorized users avoid redundant IP address assignment

−

DHCP, where deployed, is configured to avoid it as well.

This is also a hazard when you replace one device with another, unless the device being replaced is removed from the network first. If you find more than one managed device that each has the same IP address, set all but one of them to Unmanaged (as described in the following section) until they can be assigned unique addresses of their own.

9.2

Managing or Unmanaging a Device WM manages all network elements that it discovers for which licenses are available, including third‐ party devices for which operators create device definition templates and even generic devices. To free up a node license for a currently unmanaged element, it may be desirable to Unmanage another. The newly unmanaged element continues to be present in the Inventory and physical map, but its color indicator is gray until it is moved back to the Manage state, at which point its color indicator returns to that of its highest current alert. Other differences between managed and unmanaged devices are as follows: 

for managed devices, WM does status and performance data polling, detects faults, and performs auto rediscovery and therefore detects configuration changes that may have been made from a source other than WM. It also can push configurable attribute values to managed devices and displays the current performance of their links.



for unmanaged devices, WM does no status or performance data polling and performs no fault detection or auto rediscovery, during which changes that may have been made from a source other than WM could have been detected. It ignores the unmanaged devices from any scheduled tasks and does not push configurable attribute values to unmanaged devices or display the performance of their links. WM ignores traps sent from the agent(s) of unmanaged devices. However, WM retains performance data that it collected for the device during the time that is was in the managed state in anticipation of its return to that state.

229

Issue 3 May 2012

WM Release 4.0 User Guide

In an Inventory view of devices, select the Manage or Unmanage command option from the right‐ click drop‐down menu to change the management status of a selected device. The client GUI responds as follows to each attempt to change the network element state of a device: When you move a device from Manage to Unmanage 

A confirmation pop‐up message asks you to confirm the switch. To proceed, click the Yes button. To leave the device in the managed state, click the No button.



WM adds an event of Info severity to the Event Viewer.



The audit log records the state change against the user account.



The color indicator for the device changes to gray.



The license that License Manager had allocated to the device will become available for a device that you move into the managed state.

When you move a device from Unmanage to Manage

9.3



A confirmation pop‐up message asks you to confirm the switch. To proceed, click the Yes button. To leave the device in the unmanaged state, click the No button.



If License Manager cannot allocate a license to the device, then WM adds to the appropriate logs errors to indicate that the switch failed.



WM adds an event of Info severity to the Event Viewer, indicating either the success or the failure of the switch.



The color indicator for the device returns to that of the highest current associated alert.



The device is among the affected devices for each task that was previously scheduled for it.

Pinging a Device The Ping Device command is available from all right‐click device menus. This command option causes WM to ping the selected (highlighted) device(s) and to open a Pinging Components window that displays the results of the ping. In this window, a returned message of Request Timed out or Destination Host Unreachable indicates the current IP address of the device was not found. If any of the selected devices is currently configured as unmanaged, then WM displays an Unmanaged Component message. An example of these messages is shown in Figure 164.

230

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 164: Pinging Components window, success

Figure 165: Pinging Components window, skipped for unmanaged component

For a ping failure, the Pinging Components window indicates in red font Request timed out and 100% loss. If you want to repeat the ping to check for consistent results, click Clear before you click Ping Again. This clears the contents of the window, which are not automatically cleared before the next ping is triggered from the same window. Without clicking Clear again first, you cannot be confident that you are seeing the results of the second ping rather than the results of the first.

231

Issue 3 May 2012

9.4

WM Release 4.0 User Guide

Dropping a Subscriber Session WM allows you to drop the session of (unregister) a PMP SM from the Inventory view. The target device may be either the currently highlighted SM or the one that you select after invoking this feature from its PMP AP. A right‐click on either such device provides the ToolsDrop Subscriber Session command option for this purpose. When the right‐clicked element is a PMP AP, the Drop Subscriber Session for Name (ID) window opens and presents a drop‐down list of the PMP SMs that are currently registered in that AP.

Figure 166: Drop Subscriber Session window for a PMP AP

When the right‐clicked element is a PMP SM, the Drop Subscriber Session for Name (ID) window opens with the Name(ID) of the target device in gray and unalterable. If the Name (ID) is other than that of the device whose session you want to drop, cancel this window and right‐click the target device to invoke the feature again.

Figure 167: Drop Subscriber Session for Name (ID)

In either case, if you click the OK button in this window, WM sends the appropriate message to terminate the session of the PMP SM whose Name (ID) is displayed at that time.

9.5

Checking Relationships Presumed Based On Geo-locations Based on comparisons of certain settings in device templates on the server and the geo‐locations defined for devices in your network, the discovery engine in WM presumes logical relationships among devices and displays these. The presumptions are made whenever both

232



the geo‐locations lie within template‐defined positions (tolerances) that establish four corners of a rectangle



the devices are of device types that together have a presumable hierarchical relationship (would constitute an extended family).

WM Release 4.0 User Guide

Issue 3 May 2012

Per device type, the tolerances can be either the defaults that the device template has defined or new ones that the server administrator has edited into the device template. Users requesting tolerance edits and administrators who edit device templates should keep in mind that the edits apply to all devices of the device type until further edits are made. An example of such a family is provided under Defining a Larger Extended Family on Page 234. Since these automatically established relationships are presumed based on numbers, not on detected communications among them, some may not reflect communications flow among the devices. Do a periodic inspection of logical relationships by right‐clicking on devices and selecting Go ToLogical HierarchyExtended Family from the drop‐down list of options. Then

9.6



to expand an extended family, see Adding a Single Relationship on Page 235 and Defining a Larger Extended Family on Page 234.



to edit devices out of an extended family, see Removing a Relationship (the next section).

Removing a Relationship Some relationships that WM automatically establishes may be incorrect in the context of data flow in your network or of how you wish to see the hierarchy of your network expressed. Based on device type and geo‐location, WM automatically establishes a relationship with a PTP device as the parent of a proximal CMM device. The example provided under Defining a Larger Extended Family on Page 234 includes a wired link that defies this default treatment. You can remove a relationship by removing an element from it. In an Inventory view, right‐click on the element you want to remove from the relationship and select the drop‐down option Go ToLogical HierarchyExtended Family. Then in the Extended Family for DeviceName logical graphic window, right‐click the link line and select Remove Relationship.

Figure 168: Remove Relationship option in Extended Family window

The system uses a Warning pop‐up message to ask for confirmation.

233

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 169: Remove relationship pop-up warning

When you click OK to accept the proposed action and dismiss this window, WM 

removes the relationship.



returns a success message.

9.7

Adding Relationships Among Devices

9.7.1

Defining a Larger Extended Family WM allows you to add relationships such that a logical connection extends as far as five hops above and five hops beneath an element. All of the related elements constitute an extended family, for the purpose of the user interface and its menu operations. An example of an extended family that is useful to define (in parent‐to‐child order) is 1.

a CMM that provides timing to a PTP master at the POP at the top of a double backhaul‐hop configuration (master>slave>slave>master at cluster)

a PTP master at the POP in a double backhaul‐hop configuration

a PTP slave connected by Ethernet to another slave in a double backhaul‐hop configuration

a PTP slave (either as above or at the POP in a more typical configuration)

its PTP master

the CMM that provides timing to the PTP master and the APs at the cluster

an AP connected to the CMM

the SMs in the sector of the AP.

a Remote AP connected by Ethernet to one of those SMs

10. the SMs in the sector of the Remote AP Hops

234

Notes

From

For this Ethernet connection, WM may create a juxtaposed parent‐child relationship (in the automatic link that it detects between these devices), which you may wish to correct.

For this RF connection, WM does not create a parent‐child relationship (automatic link).

WM Release 4.0 User Guide

Issue 3 May 2012

Hops

9.7.2

Notes

From

For this Ethernet connection, WM does not create a parent‐child relationship (automatic link).

For this RF connection, WM does not create a parent‐child relationship.

For these connections, WM correctly creates the parent‐child relationships in these links, which it automatically detects.

For this Ethernet connection, WM does not create a parent‐child relationship.

For these connections, WM correctly creates the parent‐child relationship.

Adding a Single Relationship All right‐click device menus include an Add Relationship option. This command creates a logical relationship (logical link) between two elements, but is not selectable when no elements are selected. If you select this option 

when there are more than two elements selected, the system displays the following message.



when two elements are selected, the system opens an Add Relationship Between Elements window that is already populated with the two devices and includes a Parent of/Child of toggle.

Figure 170: Add Relationship Between Elements dialog, both devices identified

For convenience, you can use a Find button in this window to identify a different device in either or both positions.

235

Issue 3 May 2012

WM Release 4.0 User Guide 

when one element is selected, the system opens an Add Relationship Between Elements window that names the selected device as Device 1 and includes the Find option described above.

Figure 171: Add Relationship Between Elements dialog, one device identified

The Find option opens a Search Device dialog common throughout the client. The search results are absent of returns that are outside of any custom view scope defined for the user. In the context of the dialog prompt, Name (ID) means MAC address.

When you select the other target device for the relationship, it becomes Device 2, as shown in Figure 170. When a device relationship has been created

236



the system returns a confirmation:



the Inventory branch of the Applications tree reflects the relationship (Links). The Links view will open in the right panel if you double‐click the Links branch in the Applications tree, and

WM Release 4.0 User Guide

Issue 3 May 2012

as in any Inventory view while the relationship remains, the relationship is graphically represented in a pop‐up window if you right‐click the device and select the option Go ToLogical HierarchyExtended Family:

Figure 172: Logical link displayed

Similarly, the relationship is graphically represented in a pop‐up window if you right‐clicked the parent device and selected the option Go ToLogical HierarchyChildren. If the system returns the following error, this indicates that you attempted to add a relationship that would reverse the parent‐child roles of an already‐defined relationship.

Figure 173: Circular reference error

If you attempt to add a relationship that already exists, the system throws the following error:

237

Issue 3 May 2012

9.8

WM Release 4.0 User Guide

Importing a Customer Contact Database WM allows the operator to associate customer information with the managed end‐user elements. This facilitates sending email to customers about the service they receive. These can be groups or individuals whom you select in the Customer Contact Detail window or whose assigned elements you select in an Inventory view. The behavior of the email commands is to send to only selected customers in Customer Contact Detail database (window) and send to all customers who are assigned to the selected element(s) in the Inventory view. You can add customer records in either or both of two ways: 

Import them from an external database. See Preparing the Customer Contact Data for Import (next) and Importing Customer Contact Data on Page 240. Be aware that these operations combined overwrite the entire pre‐existing customer database, including all of its element MAC addresses.



Compose the record in WM. See Assigning a Customer to a Device on Page 242. This operation allows the user to essentially edit the individual record and even leave fields null.

The customer database in WM also facilitates correlation of data in WM with data in external management, billing, and other operations systems. If you choose to periodically import customer contact information from an authoritative external source, use restrictive permissions for the Email Configuration node of the Administrative Operation branch in the Permissions tree hierarchy. See Assigning Operations on Page 482.

9.8.1

Preparing the Customer Contact Data for Import The WM import operation for customer contact data supports a comma‐separated values (.csv) file in which all of the following headings and some or all of these fields are populated for each customer you want included in the contact database: 1. Unique ID ≤128 characters

6. City ≤128 characters

11. Home Phone ≤20 characters

2. Customer Name ≤128 characters

7. State ≤50 characters

12. Work Phone ≤20 characters

3. Customer Type ≤128 characters

8. Zip ≤12 characters

13. Mobile Phone ≤20 characters

4. Address1 ≤128 characters

9. Country ≤50 characters

14. Pager ≤20 characters

5. Address2 ≤128 characters

10. Email ≤128 characters

15. MAC Address ≤128 characters

The user has the discretion of how to populate these fields. For example, the Customer Type field may be populated by Residential or Commercial, or by any other set of values. Each line stores the data for one device‐customer association.

238

WM Release 4.0 User Guide

Issue 3 May 2012

The population rules are as follows: 

The headings in the above syntax must occupy the first row of the .csv file.



A comma must not be used within a values field (because the comma is the field delimiter), except where every literal‐intended comma in the entire CSV file is surrounded by the same escape character pair (text qualifier): either a pair of " double quotes or a pair of ' single quotes (apostrophe, ASCII char 39 Dec or 27 Hex). Choose only one as the text qualifier and do not use the other for the same purpose.



All of the fields are strings.



Except for MAC Address (the 15th field), no requirements are placed on the format of the text in a field.



The MAC Address entry can be in any of the following standard formats:



−

0A:00:3E:30:01:B8

−

0A-00-3E-30-01-B8

−

0A003E3001B8

A Unique ID value cannot be used for more than one customer. For a customer who has more than one radio, repeat the Unique ID value in one row per additional radio (MAC address). You do not need to repeat the other data associated with the customer—Customer Name through Pager. (Blank fields in the successive rows of the same import operation do not cause WM to ignore or erase the populated values of those fields from previous rows that have the same unique id value. However, an import of a customer record overwrites the MAC address associations.) When you trigger an email message, WM avoids sending more than one copy of the message to any customer, regardless of the number of assets that are associated with the Unique ID of the customer. EXAMPLE: Customer ABC has two SMs with MAC Addresses 0A:00:3E:00:00:0A and 0A:00:3E:00:00:0B. Customer DEF has only one SM with MAC Address 0A:00:3E:00:00:0C. Their rows in the import file should look like this. Unique Id,Customer Name,...,MAC Address 1,ABC,...,0A:00:3E:00:00:0A 1,,...,0A:00:3E:00:00:0B 2,DEF,...,0A:00:3E:00:00:0C

Thus, the Unique Id value must be unique per customer, not per row.



For a radio that is shared by more than one customer, enter each customer on an individual row with a unique ID in the Unique ID field, but with the same MAC address in their MAC Address fields. WM then allows you to trigger an email message to all customers who are associated with that MAC address.



WM supports and accepts data from optional fields that you enter as additional columns in your external database. WM adds these fields and their values to only the Customer Contact Management window.

239

Issue 3 May 2012

9.8.2

WM Release 4.0 User Guide

Importing Customer Contact Data The client provides a command option to import a customer contact database that is formatted as described under Preparing the Customer Contact Data for Import on Page 238. To import the database, perform the following steps.

Procedure 19: To import a customer contact database 1.

Regardless of the type of view that is active in the view panel, select ToolsImport and Export from the main menu. The Select operation window opens

Figure 174: Select operation window

240

Click to select the Import Customer Contact Information radio button.

Click Next. The Import Customer Contact Information window opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 175: Import Customer Contact Information window

associated with Text Qualifier.

Click the down arrow

Select the escape character that your CSV file uses to surround commas that are part of the data (that are not intended as delimiters).

note ............. Keep in mind that WM will not print any instances of the selected escape character into any customer record as a literal character.

Browse to and select the CSV file that contains the properly formatted data.

In any subsequent import of a .csv file into WM, overwriting a record or adding a new record occurs on a whole record‐by‐whole record basis as follows: 

WM overwrites the contact data for any customer whose unique id identically matches the unique id in a previously stored record.



WM accepts the contact data for any customer whose unique id was not previously stored.



WM keeps the contact data for any customer whose unique id was previously stored and is not included in the current import.

Each MAC address represents a radio device. When you import customer contact data, WM attempts to associate the customer with the devices by MAC Address, but only where WM already manages the device. For any device that WM does not already manage, you must associate the device to its MAC address in the WM GUI. See Assigning a Customer to a Device (below). An import file must exist within file browser range of the client when the import operation is invoked. To perform the import operation, see Importing Data Files Into WM on Page 105. As soon as the operation is executed in the client, user account management under the imported user configuration begins.

241

Issue 3 May 2012

9.9

WM Release 4.0 User Guide

Assigning a Customer to a Device You can add a record for an individual customer in either or both of two ways: 

import it alone or among other records that you are adding. See the sections that immediately precede this one, beginning on Page 238. This operation overwrites the entire pre‐existing customer record, including all of its associated element MAC addresses.



compose the record in the WM GUI. For a new customer, this operation adds the customer with all of the associated elements to the database. To compose a new record, perform the following steps.

Procedure 20: To compose a customer-device(s) record 1.

Regardless of the view that is active in the view panel, select ToolsCustomer Contact Management from the main menu. The Customer Contact Management window opens.

Figure 176: Customer Contact Management window

242

Click the Add button. The Customer Information dialog opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 177: Customer Information dialog

In the left panel of this dialog, populate the Customer Information text fields.

note ............. What you type into the Email text box becomes the addressee of email that WM will set up for you to send to the customer from the sender address specified in your SMTP configuration, whenever you click the Email button with one or more rows selected in the Customer Contact Management window.

243

Issue 3 May 2012

244

WM Release 4.0 User Guide

In the right panel of this dialog, click the Add button. A window opens for specifying one or more devices.

In the Devices tab of the window that opens, the device selection process is identical to that process for defining a scheduled task. For reference, see Procedure 197: To define a Configuration task on Page 653.

Specify all devices that you want to assign to this customer.

WM Release 4.0 User Guide

Issue 3 May 2012

Click OK. The Network Elements panel lists the selected device(s).

When you are finished specifying the customer‐element association(s), click OK. The record is added to the Customer Contact Management table view.

If the actual location of the device(s) is the same as the address you typed in for the customer, optionally check the Update Device Location check box.

This feature writes the contents of the customer address into the Site Location field(s) stored in the device. 10. Click OK. The record is added to the Customer Contact Management window.

245

Issue 3 May 2012

WM Release 4.0 User Guide

11. To add another customer, click the Add button and repeat these steps. 12. If you see that a correction needs to be made in a record, either double click the row or click the Edit button for access to the text fields. 13. Click the Close button.

9.10

Editing or Removing a Customer Record For a customer who is already in the database, this operation allows you to edit the record and even leave fields null. To edit an existing record, perform the following steps.

Procedure 21: To edit a customer-device(s) record 1.

In the Inventory view, right‐click the target device.

From the drop‐down list of options, select Customer Contact Detail. If no existing record is associated with this device, then the system returns a message asking whether you want to add one.

If this occurs, use the section Assigning a Customer to a Device (above) to add the proper record. If an existing record matches this device, then a Customer Information window opens, populated with the data that WM stores about its customer.

246

WM Release 4.0 User Guide

9.11

Issue 3 May 2012

Use the text fields in the left panel or the options via the right panel to adjust or remove the record.

Sending an Email Notification to a Customer WM sets up email composition for notifications to one or more customers for any purpose, such as marketing higher tiers of service, announcing price changes or anticipated outages, or confirming updates to account information. In the main menu, select ToolsCustomer Contact Management. In the Customer Contact Management window, click to highlight all intended recipients of an email message, then click the Email button.

The Compose Email composition window opens, populated with 

the recipients in the To line



the sending address (from you SMTP configuration) in the From line.

247

Issue 3 May 2012

WM Release 4.0 User Guide

Compose the Subject and body of the email, then click the Send button.

9.12

Refreshing Device Data In the Inventory view, the right‐click command option Refresh Stored Data forces WM to perform a rediscovery of the currently selected device(s). As in auto rediscovery

9.13



WM retains the performance data, alarms, and events that relate to the element and erases only the previous configuration data for it, which WM replaces with the response about the current configuration.



the Refresh Stored Data command also rebuilds the automatically determined logical links for the selected device.

Setting WM Credentials for a Group of Selected Devices WM provides a single, efficient operation to set any, some, or all of the following device credentials that it uses for authenticating itself in each device among a currently selected set: 

Read Community



Write Community



Telnet/FTP Login ID



Telnet/FTP Password

Keep in mind that this operation does not also write new values for these credentials into the target devices, but rather only configures WM to use their new values. The user of this feature must be authorized in the Permissions tree at Device ToolsCredential Manager. As an authorized user, you can access this feature in any of three ways: 

from the network updater interface (via Install Software Upgrades)



from the tools menu (via ToolsCredential Manager from the main menu), where devices currently selected in the Inventory are not inherited as initial target devices.



from the Customer Support Tool dialog (via the Credential Manager button in the Devices tab), where devices selected by the Add or the Load From Group operation before clicking the button are inherited as initial target devices.

How you raise Credential Manager determines whether the Add/Remove Devices options (Add, Remove, and Load From Group) are included in the Credential Manager dialog. These are not included if you raise Credential Manager from a Software Upgrade or Customer Support Tool dialog.

248

WM Release 4.0 User Guide

Issue 3 May 2012

To use Credential Manager, perform the following steps.

Procedure 22: To set credentials for a selected group of devices 1.

Launch the feature in any of the three ways noted above. The Credential Manager dialog opens.

Figure 178: Credential Manager dialog

In the Devices Selected frame, optionally check the check box for Show Password to display in plain text the Telnet/FTP Passwords that WM currently uses to authenticate itself in the listed devices.

Use Ctrl+click to highlight all devices whose Credentials you want to identically reset.

In the Credentials frame, check the checkbox for each credential that you want to identically reset.

In the associated text box(es), type in the new value(s) of the credentials(s).

Click the button between the frames of this dialog. The column entries of the Devices Selected frame display the new value(s).

To confirm that all the values that the columns of the Devices Selected frame display will succeed in authenticating WM to those devices, click the Verify Credentials button. RESULT: WM returns a success (row painted green) or failure (row painted red) indication for each element that was selected for the verify operation. For any element whose Read Community verify failed, the operation skipped the Write Community verify and indicates failure.

To enforce the new value(s), click the Apply button.

249

Issue 3 May 2012

WM Release 4.0 User Guide

9.14

If you have additional new values to configure for any of the devices in the list a.

uncheck the check box of any credential that you do not want to configure in this next operation.

repeat Steps 4 through 8.

Configuring a Device This command option is available for a device in the Inventory view. This feature is described under Using the Configure Device Command on Page 611.

9.15

Syncing the SNMP String in WM with the SNMP String in a Device Ensure that the value configured for Write Community in the Managed Object Properties that WM stores (Figure 133 on Page 199) identically matches the SNMP Community Write string in the device, regardless of whether the current value derives from factory configuration of the device, from an edit in the management HTTP interface to the device, or from a configuration push made by a template from WM.

9.16

Using the Link Capacity Test Utility A Link Capacity Test allows you to measure the throughput and efficiency of the RF link between two devices. Many factors, including packet length, affect throughput. WM provides the capability to perform a Link Capacity Test on PMP APs and SMs, when you specify the SM, either as the right‐click device in the Inventory view from which the test is launched or as selected by either its LUID or its Name (ID), if the test interface is launched from a right‐click on an AP in the Inventory view. This feature includes both the launch of the functionality in these devices and GUI features that are similar to how the web‐based management interfaces of these devices provide their options and display their results. The Link Capacity Test dialog contains a settable Packet Length with the range 64 to 1522 bytes. This allows you to compare throughput levels that result from various packet sizes.

9.16.1

Launching a Link Capacity Test To launch a test, perform the following steps.

Procedure 23: To perform a link capacity test in an SM

250

In an Inventory view, right‐click either the target SM or the AP to which it is registered.

In the resulting drop‐down list of options, select ToolsLink Capacity Test. WM opens a Link Capacity Test dialog whose operation depends on whether the feature was launched from a selected SM or AP.

WM Release 4.0 User Guide

Issue 3 May 2012

If the selected device was an SM, then the dialog resembles the following:

The Current Subscriber Module value is gray and fixed to Name (ID) and LUID of the SM that you preselected.

251

Issue 3 May 2012

WM Release 4.0 User Guide

If instead you preselected an AP, then the dialog resembles the following:

In this case, the dialog allows you to select any of the AP's registered SMs from the drop‐ down list for Current Subscriber Module.

252

If you preselected an AP, select the SM whose link to the AP you want to test.

For Duration, either leave 2 or overwrite it with the number of seconds (up to 10) for the test to last.

For Packet Length, either leave 1522 or overwrite it with the number of bytes (down to 64) for the packet size to send in the test.

Click the Start Test button. After performing the test and assembling the data that the test generated (this could be several seconds longer than the test itself), WM repaints the Link Capacity Test window to deliver the data and present the opportunity to test the link again, this time with a different packet size, for example, if you wish.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 179: Link Capacity Test results window

9.16.2

Interpreting Link Capacity Test Results The key fields in the test results are 

Downlink Rate and Uplink Rate, expressed in bits per second



Downlink Efficiency and Uplink Efficiency, expressed as a percentage.

note ............. In the results, interpret Downlink and Uplink as directions from the perspective of the AP, even if the link capacity test was launched with the SM selected.

A link is acceptable only if the efficiencies of the link test are greater than 90% in both the uplink and downlink direction, except during 2X or 3X operation (see the PMP user guide for further guidance). Whenever you install a new link, execute a link test to ensure that the efficiencies are within recommended guidelines. The AP downlink data percentage, slot settings, other traffic in the sector, and the quality of the RF environment all affect throughput. However, a Maximum Information Rate (MIR) throttle or cap on the SM does not affect throughput.

253

Issue 3 May 2012

9.16.3

WM Release 4.0 User Guide

Errors in the Link Capacity Test Feature If you launch the feature by the right‐click of an SM that is currently not registered to any AP, then WM returns the error This SM is not registered to an AP. Unable to test. If you launch the feature by the right‐click of an AP that currently has no registered SMs, then WM returns the error No SMs registered to AP. Unable to test.

9.17

Using the Spectrum Analyzer Utility Whether maintaining or growing your network, you may encounter new RF traffic that can interfere with your current or planned equipment. Regularly measuring RF transmissions over a period of time and retrieving records of the RF environment help you to recognize and react to changes. WM provides the capability to 

launch the Spectrum Analyzer feature in any OFDM or FSK PMP SM or any PMP 320 AP.



view the graphic display of the frequency and power level of all detectable signals within, just above, or just below the frequency band range of the target device as soon as the Duration that you specify for the sampling has elapsed.

important ........... When you launch the Spectrum Analyzer from a PMP SM, the target SM enters a scan mode and drops any RF connection it had.

Good practice is to vary the days and times when you analyze the spectrum in an area, since the RF environment can change throughout the day or throughout the week. note ............. In both an FSK and an OFDM SM, the built-in spectrum analyzer feature measures the detected peak power level. This is consistent with the received Power Level that various tabs in the web-based management interface of an FSK radio reports. However, it is inconsistent with received Power Level indications in the management interface of an OFDM radio, which use the Power Level parameter to report the detected average.

Although the spectrum analyzer functionality can be very useful as a tool for troubleshooting and RF planning, but is not intended to replicate the accuracy and programmability of a high‐end spectrum analyzer, which you may sometime need for other purposes.

9.17.1

Launching Spectrum Analyzer To launch this feature, perform the following steps.

Procedure 24: To use the Spectrum Analyzer feature

254

In an Inventory view, right‐click on the target device.

From the drop‐down list of command options, select ToolsSpectrum Analyzer. The Spectrum Analyzer window opens.

WM Release 4.0 User Guide

Issue 3 May 2012

note ............. If this feature was launched from a target PMP SM, the Current Subscriber Module field is grey, and its drop-down selector is not available. If it was launched from a PMP 320 AP, then the drop-down list is similarly inactive and displays in gray the Name (ID) of the target PMP 320 AP.

For the Duration field, either leave 10 seconds as the duration or highlight 10 and type in the number of seconds (1000 or fewer) for which you want the analysis performed.

Click the Start Remote Spectrum Analysis button.

Wait beyond the length of time that you specified for Duration.

Figure 180: Spectrum Analyzer window for a PMP 320 AP

255

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 181: Spectrum Analyzer window for a PMP SM

note ............. the first painting of results may display bars for fewer than all frequencies, especially in bands with a large number of center channels, like the 5.4-GHz band.

9.17.2

Optionally, click the Start Remote Spectrum Analysis button again. It is reasonable to expect that the resulting graph will represent the entire spectrum this time.

Interpreting Spectrum Analyzer Results Colors in the display have the following meanings:

256



Green bars show the most recent measurements.



Yellow ticks show the maximum measurements from the current spectrum analysis session.



Red ticks show measurements of −40 dBm or stronger.

WM Release 4.0 User Guide

9.17.3

Issue 3 May 2012

Errors in the Spectrum Analyzer Feature Although the right‐click menu for OFDM and FSK PMP APs include the ToolsSpectrum Analyzer command option, WM does not support it, and returns the following error when this option is selected: This operation is not supported for the selected device.

9.18

Accessing the Web Interface of a Device This section describes how to access the management interface of a device. The example procedure for the LaunchWebPage command in the following subsection uses a PMP SM as the target device. It is generally advisable to use WM to push configurable values to a device and use the web interface of the device to only occasionally, or when doubt is cast by a message in the log, visit the device to check on the success of configuration attempts from WM. Similarly, it is generally advisable to use WM to push values to PTP devices and visit their interfaces for troubleshooting. Documentation on logging into those devices is provided in the device documentation set. The Inventory view supports the right‐click LaunchWebPage command utility for access to the management web page of a highlighted device. You can use this utility to 

perform device configuration tasks that are not available in WM because of limitations that the SNMP interface of the device has.



verify device configuration against what WM reports about the device.

Procedure 25: To open a device web interface 1.

In the Inventory view, right‐click the device whose web interface you want to open.

From the drop‐down list of options, select LaunchWebPage. The home page of the device web interface opens.

Figure 182: Device web page URL

note ............. This dialog is populated with a default selection (Device Home Page) and includes a drop-down selection for a blank dialog box into which you can type any other URL. The blank box is provided because a selected device (depending on device type) may have more than one URL and because, in some cases, the computer on which you are running the WM client may not have direct access to the IP address that WM uses to communicate with the device. For this latter case, you may need to type a different IP address (known to you outside of WM) into the blank dialog box. For devices that support access via either http or https, these protocols are separately selectable in the drop-down list.

257

Issue 3 May 2012

WM Release 4.0 User Guide

Either leave Device Home Page selected or type an IP address into the blank dialog box. If the site was already listed as trusted, then the management home web page opens. If not, then an Enhanced Security Configuration warning window opens.

Figure 183: Enhanced Security Configuration warning

To add the web interface of the selected device to the list of trusted sites, click Add. A trusted sites window opens.

Figure 184: Trusted sites window

Click Add. At this point it may appear that the connection is hanging, when it is not. Proceed to the next step.

Click Close. If the IP address being used is correct, a browser window opens to a blank screen with the text Press Here to Continue.

258

WM Release 4.0 User Guide

Issue 3 May 2012

Click the word Here. The appearance of the following window depends on the device type. The remainder of this example uses an SM device URL.

Figure 185: Initial web page of Subscriber Module

If the initial page includes To Proceed, press, click the word here beneath those words. The management home page opens.

259

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 186: Management home web page of a PMP Subscriber Module

Browser controls are in effect and determine features such as font size in the web page. Be aware that, if you change any controls, those controls will remain in effect in the browser as you access other sites from your computer. The management interface demands a login using a valid configured user name and password to see any information above the basics displayed in the General tab or to configure any parameters. 9.

To authenticate in the device interface, enter the Username and Password of an account that is already authorized for the management interface to the device, then click Login.

note ............. If you click the bottom edge of the Username dialog box, the interface present a dropdown list of configured usernames to select from.

If the login succeeds, the management interface opens to the full array of left‐panel links and top tabs for access to parameters and statistics.

260

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 187: Full management interface web page of PMP Subscriber Module

The management home page opens. Refer to the device documentation set (typically, the device type‐specific user guide) for information about the configurable parameters and read‐only statistics to which you now have access. 10. When you are finished with your session in the interface, click Logoff. This prevents rogue access to the interface.

9.19

Deleting an Object and Traces Network elements that do not need to be managed can be deleted from the client as well as from the database. Based on your user privileges, you may have the option of deleting only a few network elements or a complete network. The primary reason to delete a device is to free up a slot in the node count of your WM license so that another device can be discovered and managed. important ........... The Delete Object and Traces option deletes the symbol and the object associated with that symbol from the database. If you do this, you will permanently lose all historical performance data and other information about the device. If you later want to resume managing the device, you will need to discover it again.

261

Issue 3 May 2012

WM Release 4.0 User Guide

Procedure 26: To delete a device and all information about it 1.

In the Inventory view, right‐click the target device.

From the drop‐down list of options, select Delete Object and Traces. Since you are asking for data to be removed, a pop‐up asks for confirmation.

Figure 188: Confirmation message for Delete Object and Traces operation

If you want to proceed with the data removal, click Yes.

The device will be deleted from the client as well as from the database.

9.20

Using the Bandwidth and Authentication Manager (BAM) Subsystem The BAM operations include and are limited to managing authentication and defining and applying bandwidth service plans and VLAN profiles for provisioned elements. Unlike configuration templates that you can create in WM to push bandwidth and VLAN values to elements, service plans and VLAN profiles in BAM are long‐term associations with the elements. When a service plan or VLAN profile is modified, the change is automatically applied to all elements that have the association. A further distinction is that SNMP‐applied values for bandwidth and VLAN require a reboot of the element in order to take effect; BAM‐applied plans and profiles immediately take effect. Whether the values that are sent by BAM in its proprietary protocol or by WM in SNMP are adopted for the elements depends on a setting in the AP. The AP contains a Configuration Source parameter, the value of which you could set on an AP‐by‐AP basis in the General tab of the Configuration web page in the direct management interface to AP. However, setting this on an AP‐by‐AP basis allows for possible error in consistency. If you use BAM for authentication, bandwidth, and VLAN settings, then this parameter must be set identically to the value BAM in all of the APs that are under WM management. Best practice is to use a configuration template to push the value BAM to all APs. important ........... If you are not using BAM, then this setting in all of the APs under WM management should be SM.

Where BAM is used 

SMs will derive values for the following parameters 3 from BAM, presuming that you configure them in the user interface of BAM: −

all MIR settings: 

Sustained Uplink Data Rate



Uplink Burst Allocation

This list of parameters applies to SMs in which hardware scheduling is enabled. Older SMs in which software scheduling is enabled do not accept values for the Hi Priority Channel parameter or any of the CIR parameters.

262

WM Release 4.0 User Guide

−



Issue 3 May 2012 

Sustained Downlink Data Rate



Downlink Burst Allocation

all SM VLAN settings: 

Dynamic Learning



Allow Only Tagged Frames



VLAN Aging Timeout



Untagged Ingress VID



Management VID



VLAN Membership

−

the Hi Priority Channel setting

−

all CIR settings 

Low Priority Uplink CIR



Low Priority Downlink CIR



Hi Priority Uplink CIR



Hi Priority Downlink CIR

APs will ignore, and therefore SMs will not see, any values that WM directly sends via an element configuration template for these parameters, as long as you have Configuration Source in the AP set to BAM.

Where the Configuration Source parameter in the AP is set to BAM, the SM stores a value for the Dynamic Learning VLAN parameter that differs from its factory default. When BAM does not send VLAN values (because VLAN Enable is set to No in BAM), the SM 

uses the stored Disable value for Dynamic Learning.



shows the following in the VLAN Configuration web page: −

either Enable or Disable as the value of the Dynamic Learning parameter.

−

Allow Learning : No under Active Configuration.

If you use BAM, it is imperative that you use WM 4 to set the following values in your managed PMP elements: 

Configuration Source in all APs to BAM



Authentication Mode in all APs (in whose sectors you want to impose authentication upon the SMs that attempt to register) to Authentication Required



SM Management VID Pass‐through in all APs to Disable



SM Management VID Pass‐through in all SMs to Disable

In its authentication functionality, BAM is unable to distinguish an element as a master or a slave until the slave element attempts to register in the master. If you want to pre‐provision slave elements by entering their MAC addresses before they are deployed, take special care to not enter the MAC address of any AP. Doing so would result in their being misrepresented in network views (although it would not adversely affect how WM handles registration attempts). When BAM is licensed and in place as a subsystem of WM, access to BAM is by right‐clicking on any AP in a WM view and selecting LaunchBAM from the resulting drop‐down list of options. 4

As stated earlier in this section, these are settable in the direct management interface of each element, but to avoid error, push these four values out using element configuration templates in WM.

263

Issue 3 May 2012

9.20.1

WM Release 4.0 User Guide

Managing Authentication You can configure APs in the network to require the SMs in their sectors to authenticate before they register in the APs.

AP Authentication Setup Setting up an AP element for authentication includes identifying one to five authentication servers by their IP addresses. The AP ignores any drop session request, or service plan or VLAN profile change, sent from an IP address that is not in its list of authentication servers. For this reason 

do not insert only some authentication server IP address(es) into some APs and only others into other APs, which you may have been inclined to do for load balancing.



ensure that the server in which you execute the operation is in the list of authentication servers in all APs.

Whether the server in which you make an SM management change is in the list in the AP determines when that change becomes effective, as described in Table 11.

Table 11: When BAM changes for subscribers are effective Effect of the Change Operation Performed in the Server

Delete a BAM‐managed SM that is currently on the network Change value of any attribute in a service plan or a VLAN profile Apply a different service plan or VLAN profile

If Server Is Listed in the AP

If Server Is Not Listed in the AP

Causes the current SM session to drop.

Session remains up until SM reboots or re‐registers.

New attribute values are effective immediately.

Old attribute values remain effective until SM reboots or re‐registers.

In a single window, you can configure any or all APs in a network to require or cease to require authentication. To do so, perform the following steps. note ............. This procedure presumes that the authentication settings template has been imported into the client application. If it has not, see Procedure 185: To import configuration templates on Page 620.

Procedure 27: To configure APs for authentication management

264

In an Inventory view, click to highlight one or more APs.

Right‐click one of the highlighted APs and select Configuration TemplatesApply template from the drop‐down list of command options. The Apply template dialog opens. An example is shown in Figure 189.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 189: Apply template dialog, imported AP templates

To configure authentication in a PMP 100 AP, click to highlight the Canopy AP;AP/ULAP Authentication Settings template.

If the values in this template are known to be as desired, click the Apply Now button. To view, verify, or change the values that this template will push to the AP(s), or to schedule a time and date for the push a.

click the Modify Values button.

note.............. If any preselected devices are incompatible with the selected template, WM pops up a warning message as follows:

..................... If all are compatible, the it opens the Modify Values dialog directly.

265

Issue 3 May 2012

WM Release 4.0 User Guide

Check the check box of Reboot required.

note ............. This feature supports the inherent interdependencies among configurable attributes. For example, if you set Network NTP Enable to Enabled, then Get NTP Server From DHCP is automatically set to Disabled; if you set Network IP Access Filter to Disabled, then Network Allowed IP Access 1 to 3 become not configurable.

For Authentication Mode (Attribute column), select Authentication Enabled (Value column).

For Device Configuration Source, select BAM.

For Authentication Server 1, 2, and 3, enter the dotted IP address of each of the BAM servers.

important ........... Ensure that these addresses are in the accessible range for the AP(s). For a PMP 100 AP that is running Release 9.5 or later, if one or two more Authentication Servers are to be configured (for a total of four or five), a new template is required. See Creating a Configuration Template on Page 621.

In the On Failure block, check the check box of Continue with Next Device.

For the template to retain these values until/unless it is modified again, click the Save button.

To push this set of values now to the selected AP(s), click the Apply Now button. To schedule a task of pushing these values, click the Apply Later button.

note ............. A case where you should later disable authentication is whenever all authentication servers whose IP addresses are listed in this window will be removed from service (for example, for a software update).

If you checked Reboot Network Elements after update, then your configuration changes immediately take effect. If you did not, then your changes are delayed until the next reboot of the AP(s).

9.20.2

Managing Bandwidth BAM manages authentication, bandwidth provisioning, and the VLAN profiles of SMs. For each BAM parameter, the corresponding attribute and function in WM are identified Table 12.

Table 12: Bandwidth and VLAN element attributes BAM Parameter

WM Attribute

Function in WM

Authentication Key

The hexadecimal string stored in both the database and the subscriber radio. This string is 32 or fewer characters, prepended with zeros if needed when the system reads it. The radio interface contains a toggle to Use This Key or Use Default Key.

Sustained Uplink Data Rate

Bandwidth Uplink Sustained Rate

The rate that the subscriber radio(s) are replenished with credits for transmission. This imposes no restriction on the uplink.

Sustained Downlink Data Rate

Bandwidth Downlink Sustained Rate

The rate at which the AP should be replenished with credits (tokens) for transmission to the subscriber radio(s). This imposes no restriction on the uplink.

266

WM Release 4.0 User Guide

BAM Parameter

Issue 3 May 2012

WM Attribute

Function in WM

Uplink Burst Allocation

Bandwidth Uplink Burst Allocation

The maximum amount of data to allow the subscriber radio to transmit before being recharged at the Sustained Uplink Data Rate with credits to transmit more.

Downlink Burst Allocation

Bandwidth Downlink Burst Allocation

The maximum amount of data to allow the AP to transmit to the subscriber radio(s) before the AP is replenished at the Sustained Downlink Data Rate with transmission credits.

Allow Higher Bandwidth

Bandwidth Allow License Use

Toggles whether BAM should ask License Manager for Cap 2 licenses for the selected subscriber radio(s), to the extent that the licenses are available.

Low Priority Uplink CIR

Bandwidth Low Priority Uplink CIR

The committed information rate for transmissions from the selected subscriber radio(s) on the low‐priority channel.

Low Priority Downlink CIR

Bandwidth Low Priority Downlink CIR

The committed information rate for AP transmissions to the selected subscriber radio(s) on the low‐priority channel.

Is High Priority Channel Enabled

Bandwidth High Priority Channel Enable

Toggles whether the high‐priority channel is enabled for all subscriber radios that are configured to the particular service plan.

High Priority Uplink CIR

Bandwidth High Priority Uplink CIR

The committed information rate for transmissions from the selected subscriber radio(s) on the high‐priority channel.

High Priority Downlink CIR

Bandwidth High Priority Downlink CIR

The committed information rate for AP transmissions to the selected subscriber radio(s) on the high‐priority channel.

Is CIR Feature Enabled

NONE1

Is Dynamic Learning Allowed

VLAN Dynamic Learning

Toggles whether the subscriber radio(s) to which the profile is applied should (Enabled) or should not (Disabled) add to the VID table the VLAN IDs of upstream frames, which enter the subscriber radio(s) through the wired Ethernet interface.

Are Tagged Only Frames Allowed

VLAN Allow Only Tagged Frames

The type of arriving frames that the subscriber radio(s) to which the profile is applied should tag, using the VLAN ID that is stored in the Untagged Ingress VID parameter.

VLAN Ageing Timeout

VLAN Aging Timeout

How long the subscriber radio(s) to which the profile is applied should keep dynamically learned VLAN IDs.

Untagged Ingress VID

VLAN Untagged Ingress VID

The VLAN ID that the subscriber radio(s) to which the profile is applied should use to tag frames that arrive at the subscriber radio(s) untagged.

Management VID

VLAN Management VID

The VLAN ID that the subscriber radio(s) to which the profile is applied should share with the AP.

Is VLAN Feature Enabled

VLAN Enable

Toggles whether BAM sends to the selected subscriber radio(s) the VLAN feature values from the particular profile.

267

Issue 3 May 2012

WM Release 4.0 User Guide

BAM Parameter VLAN Ids

WM Attribute

Function in WM

VLAN Membership

All IDs of the VLANs in which the selected subscriber radio(s) should be considered a member.

NOTES: To have the BAM effect of the Is CIR Feature Enabled parameter set to No, you can set the Bandwidth Low Priority Uplink CIR and Bandwidth Low Priority Downlink CIR attributes to 0 and set the High Priority Channel Enable to Disabled.

Managing Bandwidth by Service Plans One important distinction in how BAM and WM send values is the capability in WM to avoid sending/overwriting a value for an attribute while sending values for the others. In BAM by contrast, you needed to send all or none of the values in a set. WM allows you to be entirely selective. To avoid sending an attribute value, leave the contents of the value in WM null (backspace over the default value, if necessary). To overwrite the attribute value to null, type in a forward space as you compose or update the service plan. To configure any of the MIR and CIR attributes, you can 

configure them as you would any other set of configurable attributes, by defining and applying a configuration template. This approach is good for an adjustment to an individual subscriber radio, for example.



set up a service plan to be applied to a group of subscriber radios that you designate. This approach is good for establishing tiered levels of service and −

adjusting those tiers over time to have bandwidth automatically added to each.

−

protecting your set values from being overwritten by values in a configuration template.

The following table indicates the conditions under which BAM applies to an SM values from either a bandwidth service plan or a custom configuration template. To define a service plan, perform the following steps.

Procedure 28: To define a service plan 1.

From the main menu, select NetworkDefine Configurations. BAM opens the Define Configurations tab, shown in Figure 190.

Figure 190: Define Configurations tab

268

WM Release 4.0 User Guide

Issue 3 May 2012

Select EditAdd a ConfigurationBandwidth Service Plan. BAM opens the Configuration Parameter Selection window, shown in Figure 191.

note ............. The menu path that this window displays indicates where you will find this service plan when you want to apply it to selected subscriber radio(s).

Figure 191: Configuration Parameter Selection dialog for a service plan

For Name, type in a designation that you will associate with the level of service that you will later define.

For Category, optionally type in a category in which BAM should show this service plan as being sorted.

note ............. The category can be multilevel, in order of higher to lower, with semicolons delimiting between the levels. This is similar to inputting the submenu hierarchy for saved view criteria.

When you are satisfied with your entries, click OK. The configurable bandwidth parameters appear with their default values in the Define Configurations tab, shown in Figure 192.

Figure 192: Configurable parameters in a service plan

269

Issue 3 May 2012

WM Release 4.0 User Guide

For Bandwidth Allow License Use, if you want BAM to ask License Manager for Cap 2 licenses for SMs that are configured to this service plan, select Enabled.

For Bandwidth Uplink Sustained Rate, type in the rate at which to replenish the selected subscriber radio(s) with credits for transmission.

For Bandwidth Uplink Burst Allocation, type in the maximum amount of data to allow the selected subscriber radio(s) to transmit before being recharged with credits to transmit more at the Bandwidth Uplink Sustained Rate.

For Bandwidth Downlink Sustained Rate, type in the rate at which the AP should be replenished with credits (tokens) for transmission to the selected subscriber radio(s).

10. For Bandwidth Downlink Burst Allocation, type in the maximum amount of data to allow the AP to transmit to the selected subscriber radio(s) before the AP is replenished with transmission credits at the Bandwidth Downlink Sustained Rate. 11. For Bandwidth Low Priority Uplink CIR, type in the desired committed information rate for transmissions on the low‐priority channel by the selected subscriber radio(s). 12. For Bandwidth Low Priority Downlink CIR, type in the desired committed information rate for AP transmissions on the low‐priority channel to the selected subscriber radio(s). 13. For Bandwidth High Priority Channel Enable, if you want the high‐priority channel enabled for all subscriber radios that are configured to the particular service plan, select Enabled. 14. For Bandwidth High Priority Uplink CIR, type in the committed information rate for subscriber radio transmissions on the high‐priority channel. 15. For Bandwidth High Priority Downlink CIR, type in the committed information rate for AP transmissions to the subscriber radio(s) on the high‐priority channel. 16. When you are satisfied with the profile, click the Save Changes button. BAM opens the Confirm Update window, shown in Figure 193.

Figure 193: Confirm Update window for bandwidth service plan

17. If you want the subscriber radio(s) to immediately reboot after the values in this window are written to them, check Reboot Network Elements after update. important ........... A reboot or re-registration is not required for pushing the bandwidth values for these attributes to an element, only if the server in which you are making these changes is listed as an authentication server in the AP. This is because BAM uses a special protocol, not SNMP, to push these values from either a service plan or a custom configuration template. However, you will not see SNMP attribute values change for the element. Once you have associated a service plan with an element, no parameter for which the service plan imposes a value can have its value overwritten by a custom configuration template.

If you want to reboot at a later time to apply the changes, leave this box unchecked. 18. Click OK. BAM opens the Updating Configuration window, where it documents the associated events. An example of this window is shown in Figure 194.

270

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 194: Updating Configuration window for a new service plan

The service plan is now available to apply to selected elements. You can close this window without consequence. To apply a defined service plan, perform the following steps.

Procedure 29: To apply a service plan 1.

In a network view, select the subscriber radio(s) in one of the three following ways: ◦

Highlight a single element.

◦

Check the boxes of multiple elements.

◦

Highlight an element under which you want the service plan applied to all subscriber radio(s).

From the main menu, select EditConfigureBandwidth Service PlanServicePlanName. BAM opens a Task Attributes window, shown in Figure 195.

271

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 195: Task Attributes window for a service plan

Click the Elements tab.

If you selected the element(s) for which you want to configure bandwidth settings, check Selected Network Elements. If you selected an element under which you want to configure the bandwidth settings of all subscriber radio(s), check Selected Network Branches.

Click the General tab.

If you want the element(s) to immediately reboot after the values in this window are written to them, check Reboot Network Elements after update.

important ........... Reboot or re-registration is not required for pushing the bandwidth values for the attributes to an element, only if the server in which you are making these changes is listed as an authentication server in the AP. This is because BAM uses a special protocol, not SNMP, to push these values from either a service plan or a custom configuration template. However, you will not see SNMP attribute values change for the element. Once you have associated a service plan with an element, no parameter for which the service plan imposes a value can have its value overwritten by a custom configuration template.

If you want to reboot at a later time to apply the changes, leave this box unchecked. 7.

272

Click the Run Now button.

WM Release 4.0 User Guide

Issue 3 May 2012

If you selected Reboot Network Elements after update, the elements are rebooted, and the changes are activated. If you did not select that option, the changes are not activated until the elements are later rebooted. In either case, BAM opens a Configure Element(s) window, where it documents the associated events. An example of this window is shown in Figure 196.

Figure 196: Configure Element(s) window for applying a service plan

You can close this window without consequence. 8.

If intended licensed upgrades are failing to occur as a result of the service plan being applied, repeat this procedure but, as you do, set the attribute Bandwidth Allow License Use in the General tab to Enabled.

To modify the definition of an existing service plan, perform the following steps.

Procedure 30: To update a service plan 1.

From the main menu, select NetworkDefine Configurations. BAM opens the Define Configurations tab, shown in Figure 190 on Page 268.

In the left pane, select (highlight) the service plan that you want to update. BAM opens the service plan in the right pane.

Change the values of any attribute(s) as desired.

note ............. For the meanings of the various attributes, see Procedure 28 on Page 268.

When you are satisfied with the changes, click Save Changes. BAM opens the Confirm Update window. An example of this window is shown in Figure 193 on Page 270.

If you want the element(s) to immediately reboot after the values in this window are written to them, check Reboot Network Elements after update.

important ........... Reboot or re-registration is not required for pushing the bandwidth values for the attributes shown in Figure 174 to an element, only if the server in which you are making these changes is listed as an authentication server in the AP. This is because BAM uses a special protocol, not SNMP, to push these values from either a service plan or a custom configuration template. However, you will not see SNMP attribute values change for the element. Once you have associated a service plan with an element, no parameter for which the service plan imposes a value can have its value overwritten by a custom configuration template.

If you want to reboot at a later time to apply the changes, leave this box unchecked.

273

Issue 3 May 2012

WM Release 4.0 User Guide

Click OK. BAM opens an Updating Configuration window, where it documents the associated events. You can close this window without consequence.

At any time, you can dissociate an element or group of elements from a service plan. To do so, perform the following steps.

Procedure 31: To remove a bandwidth service plan association 1. 2.

In a Network Browser view, select the elements for which you want to cancel the service plan association. From the main menu, select EditConfigureBandwidth Service PlanRemove Bandwidth Service Plan Association.

In the Define Networks tab, this option is available at EditNetwork Element OperationsConfigureBandwidth Service Plan. The element retains the last bandwidth values that were applied by the service plan, but no future changes in the service plan will change the bandwidth values in the element. If you ever want to completely remove a service plan from BAM, perform the following steps.

Procedure 32: To remove a service plan

9.20.3

From the main menu, select NetworkDefine Configurations. BAM opens the Define Configurations tab, shown in Figure 190 on Page 268.

In the left pane, select (highlight) the service plan that you want to delete. BAM opens the service plan in the right pane.

From the main menu, select EditDelete the Configuration.

Managing VLANs One important distinction in how BAM and WM send values is the capability in WM to avoid sending/overwriting a value for an attribute while sending values for the others. In BAM by contrast, you send all or none of the values in a set. WM allows you to be entirely selective. To avoid sending an attribute value, leave the contents of the value in WM null (backspace over the default value, if necessary). To overwrite the attribute value to null, type in a forward space as you compose or update the VLAN profile. To configure any of the VLAN attributes, you can

274



configure them as you would any other set of configurable attributes, by defining and applying a configuration template. This approach is good for an adjustment to an individual SM, for example.



use BAM to set up a VLAN profile to be applied to a group of SMs that you designate. This approach is good for establishing VLANs and protecting your set values from being overwritten by values in a configuration template.

WM Release 4.0 User Guide

Issue 3 May 2012

At any time, you can dissociate an element or group of elements from a VLAN profile. The element retains the last VLAN values that were applied by the profile, but no future changes in the profile will change the VLAN values in the element. Similarly, if you remove a VLAN profile, the elements to which the profile was currently applied retain the values until or unless those are changed by a custom configuration template or another VLAN profile that is applied to them. The following caveats apply to managing VLANs from WM: 

VLAN must be enabled in the AP. Otherwise, applying a VLAN profile or setting VLAN values from a custom configuration template has no effect.



In a VLAN profile, the VLAN Enable attribute is ignored unless the SM authenticated through the BAM subsystem.



If VLAN Enable is set to Enabled in a VLAN profile or in a custom configuration template, and you switch this attribute to Disabled, this action does not turn off the VLAN feature in the subscriber radio. To do so, you must reboot the element and allow it to re‐authenticate, at which time BAM ceases to send the VLAN values that are stored in the profile or configuration.



When you apply VLAN values, what set of values become effective depends on how the subscriber radio entered the network, as described in Table 13.

Table 13: How VLAN settings are applied to an SM Entry into the Network

Updated VLAN Settings From

Immediate

Through Protocol

Requires Reboot

Entered via BAM

BAM VLAN profile

Yes

Proprietary

Later re‐entered through AP that does not require authentication

Configuration Source set in new AP

Yes

SNMP

Entered without BAM authentication

WM VLAN attributes

SNMP

Yes

Re‐entered via BAM

BAM VLAN profile that initially matches the original settings

Yes

Proprietary

Corrective Action Re‐apply the VLAN profile (this time via SNMP). This will 2 require a reboot.

Remember that the original values remain in the subscriber radio, even if BAM later manages it with new values.

NOTES: 1. In this case, the PMP SM re‐entered the network by registering in a new AP. 2. If this action is unacceptable for your network, either −

initially apply all VLAN profiles to only elements that are behind non‐authenticating APs. This may require that you temporarily disable authentication in some APs, reboot them, apply the profile, re‐enable authentication in them, and reboot them again. Then the subscriber radios will store the values that they received from WM through SNMP.

−

deploy a sufficient number of BAM packs licenses so that all of your APs hold them.

275

Issue 3 May 2012

WM Release 4.0 User Guide

When you apply a VLAN profile, BAM computes bandwidth based on both the values stored in the relational database and the number of SM bandwidth licenses, and sends the bandwidth service plan along with the VLAN profile to the subscriber radio(s). Operators who use only a relational database (not RADIUS also) find that the bandwidth values applied are as expected. However, operators who use both a relational database and RADIUS can sometimes find unexpected—and far from desired—values applied. This can occur in the following sequence: 1.

The relational database is storing the values from the last previous authentication.

The operator changes the values in RADIUS, but does not reboot the involved SM.

The operator applies a VLAN profile to the element.

BAM computes bandwidth for the element, based on the original values (from Step 1), not the new values (from Step 2).

BAM sends the desired VLAN profile and bandwidth service plan, which is based on outdated RADIUS input, to the element.

WM cannot poll the RADIUS server to detect whether any change has been made since the last authentication. By either of the following means, you can ensure that outdated input is never used in the bandwidth calculation: 

Discontinue using RADIUS.



Reboot the involved element(s) soon after every change in RADIUS.

For each BAM parameter, the corresponding attribute and function in WM are identified in Table 12 on Page 266. To define a VLAN profile, perform the following steps.

Procedure 33: To define a VLAN profile 1.

From the main menu, select NetworkDefine Configurations. BAM opens the Define Configurations tab, shown in Figure 190 on Page 268.

Select EditAdd a ConfigurationVLAN Profile. BAM opens the Configuration Parameter Selection window, shown in Figure 197.

note ............. The menu path that this window displays indicates where you will find this profile when you want to apply the profile to selected elements.

Figure 197: Configuration Parameter Selection dialog for a VLAN profile

276

For Name, type in a designation that you will associate with the VLAN profile that you will later define.

For Category, optionally type in a category in which WM should show this VLAN profile as being sorted.

WM Release 4.0 User Guide

Issue 3 May 2012

When you are satisfied with your entries, click OK. The configurable bandwidth parameters appear with their default values in the Define Configurations tab, shown in Figure 198.

Figure 198: Configurable parameters in a VLAN profile

For VLAN Enable, specify whether BAM should (Enabled) or should not (Disabled) send to the selected subscriber radio(s) the VLAN feature values from the particular profile.

For VLAN Dynamic Learning, specify whether the element(s) to which the profile is applied should (Enabled) or should not (Disabled) add to the VID table the VLAN IDs of upstream frames, which enter the subscriber radio through the wired Ethernet interface.

For VLAN Allow Only Tagged Frames, select the type of arriving frames that the subscriber radio(s) to which the profile is applied should tag, using the VLAN ID that is stored in the Untagged Ingress VID parameter.

For VLAN Aging Timeout, specify how long in minutes the subscriber radio(s) to which the profile is applied should keep dynamically learned VLAN IDs.

10. For VLAN Management VID, type in the VLAN ID that the subscriber radio(s) to which the profile is applied should share with the AP. 11. For VLAN Untagged Ingress VID, type in the VLAN ID that the subscriber radio(s) to which the profile is applied should use to tag frames that arrive at the element(s) untagged. 12. For VLAN Membership, click the … ellipsis button. BAM opens the Edit VLAN Membership window. An example of this window is shown in Figure 199.

277

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 199: Edit VLAN Membership dialog

13. Click the Add Item button. BAM opens the Add Entry window, shown in Figure 200.

Figure 200: Add Entry window

14. For each VLAN in which you want the subscriber radio(s) that have this VLAN profile to be member(s), type in the VLAN ID and click OK. The Add Entry window is removed and the Edit VLAN Membership dialog displays all current entries. note ............. Some limitations govern how many VLANs in which BAM can assign membership for the element. The number of digits that WM handles, or the number of characters that the database stores, for this attribute may be limited. However, handling and storage capabilities are sufficient for even the most complex of networks. Entries of 255 or fewer characters are supported. Larger entries can result in the BAM subsystem applying incorrect VLAN IDs.

15. If any ID was mistakenly entered, highlight the entry and click the Remove Item button. 16. When you are finished adding VLAN membership IDs, click OK in the Edit VLAN Membership window. The membership IDs for this profile are listed in the profile pane as display‐only data opposite VLAN Membership. 17. If you need to make further edits to VLAN membership, click the repeat the above steps.

…

18. When you are satisfied with the profile, click the Save Changes button. BAM opens the Confirm Update window, shown in Figure 201.

278

ellipsis button and

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 201: Confirm Update window for VLAN profile

19. If you want the element(s) to immediately reboot after the values in this window are written to them, check Reboot Network Elements after update. important ........... Reboot or re-registration is not required for pushing the VLAN values for the attributes to an element, only if the server in which you are making these changes is listed as an authentication server in the subscriber radio. This is because BAM uses a special protocol, not SNMP, to push these values from either a VLAN profile or a custom configuration template. However, you will not see SNMP attribute values change for the element. Once you have associated a VLAN profile with an element, no parameter for which the profile imposes a value can have its value overwritten by a custom configuration template.

If you want to reboot at a later time to apply the changes, leave this box unchecked. 20. Click OK. BAM opens the Updating Configuration window, where it documents the associated events. An example of this window is shown in Figure 202.

Figure 202: Updating Configuration window for VLAN profile

The profile is now available to apply to selected elements. You can close this window without consequence. To apply a defined VLAN profile, perform the following steps.

Procedure 34: To apply a VLAN profile 1.

In a network view, select the subscriber radio(s) in one of the three following ways: ◦

Highlight a single element.

◦

Check the boxes of multiple elements.

◦

Highlight an element under which you want the VLAN profile applied to all subscriber radios.

From the main menu, select EditConfigureVLAN ProfileVLANProfileName. BAM opens a Task Attributes window, shown in Figure 203.

279

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 203: Task Attributes window for applying a VLAN profile

Click the Elements tab.

If you selected the element(s) to which you want to apply the VLAN profile, check Selected Network Elements. If you selected an element under which you want the VLAN profile to apply to all subscriber radios, check Selected Network Branches.

Click the General tab.

If you want the element(s) to immediately reboot after the VLAN profile is associated with them, check Reboot Network Elements after update.

important ........... Reboot or re-registration is not required for pushing the VLAN values for the attributes to an element, only if the server in which you are making these changes is listed as an authentication server in the subscriber radio. This is because BAM uses a special protocol, not SNMP, to push these values from either a VLAN profile or a custom configuration template. However, you will not see SNMP attribute values change for the element. Once you have associated a VLAN profile with an element, no parameter for which the profile imposes a value can have its value overwritten by a custom configuration template.

If you want to reboot at a later time to apply the changes, leave this box unchecked. 7.

280

Click the Run Now button. BAM opens a Configure Element(s) window, shown in Figure 204.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 204: Configure Element(s) dialog for applying a VLAN profile

You can close this window without consequence. To modify the definition of an existing VLAN profile, perform the following steps.

Procedure 35: To update a VLAN profile 1.

From the main menu, select NetworkDefine Configurations. BAM opens the Define Configurations tab. An example of this tab is shown in Figure 190 on Page 268.

In the left pane, select (highlight) the VLAN profile that you want to update. BAM opens the Configuration Parameter Selection window, shown in Figure 197 on Page 276.

Change the values of any attribute(s) as desired. For the meanings of the various attributes, see Procedure 33: To define a VLAN profile on Page 276.

important ........... For the VLAN Membership attribute, if you remove all IDs, BAM does not send this change to the subscriber radio in run time. If you want the radio to immediately be a member of no VLANs, remove all IDs and then directly reboot the element. (Checking Reboot Network Elements after update will not work because BAM does not consider a change in VLAN membership as requiring a reboot.)

When you are satisfied with the changes, click Save Changes. BAM opens the Confirm Update window, shown in Figure 201 on Page 279.

If you want the element(s) to immediately reboot after the values in this window are written to them, check Reboot Network Elements after update.

If you want to reboot at a later time to apply the changes, leave this box unchecked. 6.

Click OK. BAM opens the Updating Configuration window, where it documents the associated events.

You can close this window without consequence.

281

Issue 3 May 2012

WM Release 4.0 User Guide

At any time, you can dissociate an element or group of elements from a VLAN profile. To do so, perform the following steps.

Procedure 36: To remove a VLAN profile association 1.

In a Network Browser view, select the elements for which you want to cancel the VLAN profile association.

From the main menu, select EditConfigureVLAN ProfileRemove VLAN Profile Association. In the Define Networks tab, this option is available at EditNetwork Element OperationsConfigureVLAN Profile.

The element retains the last VLAN values that were applied by the VLAN profile, but no future changes in the VLAN profile will change the VLAN values in the element. If you ever want to completely remove a VLAN profile from BAM, perform the following steps.

Procedure 37: To remove a VLAN profile 1.

From the main menu, select NetworkDefine Configurations. BAM opens the Define Configurations tab, shown in Figure 190 on Page 268.

In the left pane, select (highlight) the VLAN profile that you want to delete. BAM opens the VLAN profile in the right pane.

From the main menu, select EditDelete the Configuration.

The element retains the last VLAN values that were applied by the profile.

9.21

Running a User-defined Script WM allows users for whom Task Scheduler OperationCreate User Script Task is provisioned in the Permissions tree to point to a locally defined script and launch it, either on demand or as a scheduled task. In either case, this requires configuring the task. See Schedulable Tasks on Page 647. This feature also requires that the script exists on the server and has its mode set to executable. To authorize this feature for a user, see Task Scheduler Operation on Page 481. The Details pane of the Create Schedule Task dialog for this task type allows the user to 

select the script from a list of the files that are mounted in the UserScripts directory.



optionally type arguments into the Enter arguments (optional) text box.



launch the script on demand by clicking the Run now button or set the script to run on the specified schedule by clicking the Save button and configuring the Schedule tab.

When User Script is the selection from the Select Task Type window, WM opens a Create Schedule Task interface whose Details tab is as follows.

282

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 205: Details for a User Script task

When scripts are present under Script Name, you can click to highlight the target script, optionally type in associated arguments for the execution, and then either 

click the Run now button to launch the execution.



click the Save button to set the script to launch as configured in the Schedule tab of this window.

If no scripts are present in the directory, then WM returns the following error as a pop‐up message:

To view the results of an executed script, use Procedure 199: To view results of last execution of a task on Page 675.

283

Issue 3 May 2012

WM Release 4.0 User Guide

A typical results display for a successful user script execution is as follows.

Figure 206: Schedulable Script Results window, example

9.22

Uploading RADIUS AAA Certificates note ............. This operation requires the specific permission Upload AAA Certificate. This is a selectable permission under Configuration in the Permissions tree hierarchy.

PMP SMs and PMP 320 CPE devices support RADIUS authentication per RFC1422 by associating a .pem file with the device. This file is the SSL public key of a certificate recognized by a configured AAA (authentication, authorization, and accounting) server. WM provides certificate management with its capability to 

browse to the target certificate file.



remove the existing certificate(s) so that no conflict results from applying the new certificate.



pace the rate of certificate updates to control their volume of traffic.

The command option to launch this feature is specific to the target device type. If both one or more PMP CPE device(s) and one or more PMP SM(s) are selected, then the Tools submenu is not present upon right‐click. The command options are available in an Inventory view as follows: 

For the PMP CPE device type, highlight the target device(s), right‐click, and then select ToolsUpload AAA Certificate to CPE from the drop‐down list of options.



For the PMP SM device type, highlight the target device(s), right‐click, and then select ToolsUpload AAA Certificate to SM from the drop‐down list of options.

The result of either option is the same: WM opens the Upload AAA Certificate dialog.

284

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 207: Upload AAA Certificate dialog, initial view

To configure this dialog, perform the following steps.

Procedure 38: To upload a AAA certificate 1.

Refer to the user guide that documents the device type.

Copy the target certificate file to within file browsing reach of the client device.

Determine whether all of the currently highlighted devices share the same login and password for management access to the device.

Determine whether and how many certificates are currently applied to the highlighted devices.

Consider the current traffic load in the network and in the highlighted devices.

For Max Concurrent Updates, establish the maximum as a number that is fewer than 21.

Click the Browse button.

Browse to and select the target certificate file.

285

Issue 3 May 2012

WM Release 4.0 User Guide

If any certificates are already applied to any of the highlighted devices, perform the following steps: a.

Check to check the check box associated with Delete Existing Certificate. The specific Delete options become active.

Figure 208: Upload AAA Certificate dialog, Delete Existing Certificate selected

Click to select the appropriate radio button for Delete Certificate 1, Delete Certificate 2, or Delete Both.

note ............. If certificates are at capacity in the target device, then the device response to the upload attempt depends on the device type. If the target device was a PMP 320 CPE, then the uploaded certificate replaces one of the existing certificates. If it was a PMP SM, then the rejects the upload attempt.

10. For Selected Devices Login ID, type into the text box the management login that is common among all of the highlighted devices. 11. For Selected Devices Password, type into the text box the management password that is common among all of the highlighted devices. 12. Click the Upload button. 13. When the system returns the success message, click the Close button to exit this dialog. important ........... If the target device was a PMP 320 CPE, then the uploaded certificate is immediately effective. If it was a PMP SM, then the certificate will not be effective until the next reboot of the SM.

286

WM Release 4.0 User Guide

9.23

Issue 3 May 2012

Upgrading Devices On Demand note ............. Interpret all references to upgrades in this section to apply to downgrades as well. Since all upgrade packages ultimately outlive their immediate usefulness, when they do they should be stored as potential downgrade packages for instances in which you want to retreat to a previous release.

WM supports both on‐demand and scheduled software upgrades, which push software (images), and firmware (logic), and boot file packages to supported Cambium Networks devices. These devices include 

PMP devices in FSK and OFDM series



backhaul devices in PMP and PTP series



CMMmicro



CMM4, but not its integrated switch

The success of each upgrade requires that 

all of the appropriate upgrade packages have already been downloaded to the client device from −

http://www.cambiumnetworks.com/support/pmp/software/index.php for PMP and/or CMM devices

−

http://www.cambiumnetworks.com/support/ptp/software/index.php for PTP devices.

and then uploaded from the client into its application. 

you have System Administration‐level privileges.



your client device has connectivity with the WM server device.



the WM server device could successfully ping the IP addresses of the devices that you intend to upgrade.



you perform each of the steps that follow within this section.

You can and typically will upgrade the devices in your network as a scheduled task instead of an on‐ demand launch. Scheduling allows you to run this operation without immediate staff involvement during periods when network traffic is least intensive. Although this section presumes an on‐demand launch, its instructions and descriptions are essential to orderly and efficient upgrades via schedules tasks and are not reiterated where those tasks are described (Scheduling a One‐Time or Periodic Task on Page 647). So, you will need to refer to this section as well.

9.23.1

Launching the Software Upgrade Interface When you right‐click on a device and select ToolsInstall Software Upgrades, the Software Upgrade dialog opens. important ........... Multiple instances of the Software Upgrade dialog open if you select the Install Software Upgrades option more than once. Be sure to not launch an additional dialog if an instance of it is already open. To configure the upgrade of more than one device, even from disparate specific types, highlight them all in the Inventory view before you select the Install Software Upgrades option.

287

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 209: Software Upgrade dialog

Each of these dialog tabs includes several file transfer options and requires authentication that gives WM permission to overwrite the software image, and firmware logic, and/or boot file that currently resides in the target device(s).

9.23.2

Configuring the PMP/PTP Software Upgrade The upgrade configuration consists of five user operations:

288



Reviewing the Relevant Pre‐Upgrade Information About the Device(s), described on Page 289.



Setting the General Configuration, described on Page 289.



Setting the SM Autoupdate Configuration, described on Page 290.



Authenticating WM into the Device(s), described on Page 295.



Selecting the Software and Firmware Packages to Apply, described on Page 295.

WM Release 4.0 User Guide

Issue 3 May 2012

Reviewing the Relevant Pre-Upgrade Information About the Device(s) The bottom panel includes a tab (Selected for upgrade) that initially displays some relevant information about the pre‐selected device(s): Device Name, Agent, Hops, and Status. To display the remainder of the relevant information as well, click the Probe button. The information is completed for all of the listed devices.

Figure 210: Selected for upgrade tab

As with other tables in the WM client views, you can click and drag a column border to make the column wider or narrower. To remove a device from the list, highlight it and then click the Remove button. This bottom panel also includes a tab (Upgrade complete) that ultimately displays all of the known relevant information about the device after the upgrade has occurred. If any of the devices that the Selected for upgrade tab is listing are already at their latest versions, then you can move them by highlighting and click the Move to complete button. This can be more practical than the Remove operation, since the former ultimately results in them being displayed among the devices that operate on the latest available versions, whereas Remove leaves them unaccounted for with respect to using the Upgrade complete tab for tracking the current upgrade effort.

Setting the General Configuration The Use Passive FTP for Transferring Files to Network Elements option activates passive FTP for all devices. For APs other than the PMP 320 AP, the SM Autoupdate feature causes an AP to 

examine the software and FPGA versions on each of its SMs



command those SMs that require an upgrade to perform one.

In this command, the AP directs the SM to a source for the latest software and firmware: either the AP or a TFTP server on the WM server device and within network reach of the WM server. In sectors where SM Autoupdate is not enabled, each SM must have a valid assigned IP address in order for WM to effect the upgrade. Where it is enabled, the AP acts as a virtual proxy for the upgrade. Moreover, SM Autoupdate speeds the process of upgrading a network, while not preventing an administrator from upgrading individual devices through direct IP access to them. WM initiates and terminates the SM Autoupdate mode within APs by using a UDP command. This mode remains active only until either 

a user with System Administration privileges disables it, manually or in another UDP command)



the AP reboots.

For security, an AP can accept this command from only one IP address, which is specified in the configuration of the AP. For convenience, WM automatically forces this setting in the APs to the IP address of the WM server.

289

Issue 3 May 2012

WM Release 4.0 User Guide

If the Use https option is checked, then the PMP SM(s) will use a local HTTP server to access the software, boot, and FPGA image files. This works with the Use CNUT HTTP Server as File Server option described under Setting the SM Autoupdate Configuration on Page 290. If the Enable SM Autoupdate When an Access Point is Updated option is checked, then WM automatically enables SM Autoupdate on all selected APs after the direct element updates are completed. Using this option saves the user from having to separately turn on SM Autoupdate. By waiting to enable SM Autoupdate until after all selected network elements (including SMs) have been directly updated, WM avoids problems that can occur when the SM Autoupdate feature is simultaneously enabled at multiple levels of the network hierarchy. Cambium Networks delivers software images in two platform formats (big Endian and little Endian formats) to support two different CPUs running on the radios. At any given time, an AP can push the software images for only one of these platforms. Where an AP must upgrade SMs of both CPU formats, WM automatically monitors the progress of SM Autoupdate within the sector and switches the images and instructions after having pushed the image format of the majority of SMs in the sector.

Setting the SM Autoupdate Configuration The SM Autoupdate Configuration block allows you to specify whether the SMs should get their upgrade files from their APs or another server. If the SMs are configured for Public Accessibility, Use TFTP File Server on the WM Server or Use CNUT HTTP Server as File Server can a better option than Use Access Point as File Server for two reasons: 

Either of these options offloads processing from the APs.



This increases the number of simultaneous upgrades.

Figure 211: SM Autoupdate Configuration tab

When an AP is used as a file server, only 4 SMs associated with a particular AP can perform concurrent upgrades. When another server is used, 20 SMs per AP can perform concurrent upgrades.

290

WM Release 4.0 User Guide

Issue 3 May 2012

Various firmware packages may be required, depending on whether the platform revision is P7/P8/P9, P10, or P11, and an AP can hold only one set of firmware packages at a time. Because of this, WM switches the package on the AP from one to another to ensure that all SMs on the sector get upgraded. The upgrade package attempts to determine which image is best to load onto the AP first during the SM Autoupdate sequence, but if it cannot, then it will use the top‐to‐bottom order of SM types that are listed in the box beneath the Use Access Point as File Server option. To optimize the upgrade performance on a sector, this list includes the option to Move Up or Move Down an SM Type and thereby reorder the updates by SM type. However, if you are upgrading a network of only one SM firmware type, and you see a delay in Autoupdate commencing on your network, you can switch this option setting to try to expedite it. The file server selections compare as follows: 

to have the APs serve the upgrade files (Use Access Point as File Server). This typically is the least favorable option, since the other options offload processing from the APs and support a greater number of simultaneous SM updates in the network. When an AP is used as a file server, only 4 SMs associated with a particular AP can perform concurrent upgrades. The update process uses the order specified under Auto Update SM Type for all devices that are flagged for updating. Update progress is monitored by FTP messaging.



to use the local TFTP server. Devices that are running a release earlier than 12.0 support this option and WM uses this option to push their image files. Unlike in the standalone Network Updater tool, the Use TFTP File Server on the WM server option does not require the operator to configure an IP address for the TFTP server and the root directory where it will store the files for the SMs to pull. WM automatically configures these when this option is selected. Progress of the software upgrades is monitored by FTP messaging. When the TFTP server is used, as many as 20 SMs per AP can perform concurrent upgrades.



to allow WM to act as an HTTP/HTTPS server. The Use CNUT HTTP Server as File Server option configures the software upgrade utility to allow devices to pull their image files from the HTTP/HTTPS server and to monitor upgrade status via SNMP messages. It also uses the configured Auto Update SM Type order. Release 12.0 and later devices support this option.

For the Use Access Point as File Server and Use CNUT HTTP Server as File Server options, a check box is available for Order By SM Number. If you check this check box, WM counts the number of registered SMs of each Autoupdate SM Type (how many P7/P8/P9, how many P10, and how many P11), and first updates the all of the type with the most, then all of the type with the second‐most, and then all of the type with the least, ignoring the vertical order specified in the Autoupdate SM Type block. If you leave this box unchecked, it uses the order in the block.

Using the HPAP Channel Bandwidth Feature note ............. Channel Bandwidth applies to only PMP 430 Series High-performance AP (HPAP) in Release 10.2 or later and the registered SMs in its sector.

This feature makes settable 

a specific channel bandwidth to instruct the HPAP to switch its operation to, based on its current channel bandwidth.



whether to proceed with or abandon the channel bandwidth switching operation in the case where the HPAP has at least one currently registered SM.

291

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 212: HPAP Channel Bandwidth tab

Improper use of this tab can result in SMs dropping their connections to the HPAP and not being able to reconnect: 

The PMP 430 Series SM that operates on Release 10.0 or 10.1.1 cannot communicate with an AP that operates on Release 10.2 or later. So, under no circumstances should you upgrade any PMP 430 Series AP to Release 10.2 or later until all of its SMs have first been upgraded to that release.



Similarly, a Release 10.2 or later HPAP that is set to a channel bandwidth that differs from that of its SMs cannot communicate with its SMs. So, the desired channel bandwidth should never be set in the HPAP until it is set in all of the SMs in the sector.



In the case where you want to downgrade a sector from Release 10.2 or later to Release 10.1 or 10.0, you must first change the sector to the 10‐MHz channel bandwidth (SMs first) and then downgrade all of the SMs before you downgrade the HPAP.

However, inherent in a sector of any considerable size is the fact that, at any given time (when you would like to cut over to the new release or later to the new channel bandwidth), some of the SMs are likely to be out of service (powered down by the end user or encountering transient RF problems, for example). To avoid or minimize trouble, you can 1.

use WM to identify the out‐of‐service SMs by their red icon color.

use WM to display the correlated customer contact information.

ask the end customer to attempt to re‐establish the link before you proceed with the operation that has the hazard of stranding SMs.

Proper use of this tab is as sequenced in the following example. The goal in this example case is to have an entire PMP 430 HPAP tower linked at 20‐MHz channel bandwidth, and no SMs that are unable to reconnect to the HPAP in case they go out of service for some reason after successful connection at that size of channel:

292

Plan your upgrade session to occur at a date and time when historical data suggests that the fewest SMs are not in service.

When the date and time arrive, send a blast to all customers, urging them to keep their sessions up.

WM Release 4.0 User Guide

Issue 3 May 2012

Use alternative means to ask customers whose SMs are out of session to attempt to reconnect the RF link.

In an Inventory view, highlight all APs of the tower.

Right‐click among the highlighted APs and select ToolsInstall Software Upgrades.

Using Selecting the Software and Firmware Packages to Apply on Page 295 for the Select Packages operation, check only the upgrade package for Release 10.2 or later (in AES or DES) and uncheck any others that are checked in the Package List.

In the SM Autoupdate Configuration tab, click the Enable button for Enable/Disable APs for SM Autoupdate. All of the registered SMs in the sector are upgraded to Release 10.2 and then drop their registrations to the AP.

When all in‐session SMs have been upgraded, make another attempt to get any that are still running the old release upgraded.

important ........... Any that you still cannot upgrade will require a truck roll before they will be able to reconnect to the HPAP.

In the SM Autoupdate Configuration tab, click the Disable button for Enable/Disable APs for SM Autoupdate.

10. In the Selected for Upgrade tab, click the Start button. The APs are upgraded to Release 10.2 as HPAPs, and then all of the upgraded SMs re‐register into their HPAPs. 11. Wait until all of the upgraded SMs have re‐registered. 12. Click the HPAP Channel Bandwidth tab. 13. Use this tab to set the Target Bandwidth to 20 MHz for the Current Bandwidth. Click in the Target Bandwidth column at the proper row to expose the drop‐down selection list. 14. In the Channel Bandwidth Switch Mode block of this tab, select Switch Channel Bandwidth Even if SMs are Present. 15. Click the SM Autoupdate Configuration tab. 16. Click the Autoupdate SM Channel Bandwidth button. The channel bandwidth of all connected SMs is changed to 20 MHz, and they drop their connections to their HPAPs. 17. In the SM Autoupdate Configuration tab, click the Disable button for Enable/Disable APs for SM Autoupdate. 18. In the Selected for Upgrade tab, click the Start button. The channel bandwidth of the HPAPs is changed to 20 MHz, and all sectors of the tower are operational when all of the SMs have re‐registered following the reboot, except for those SMs that were not in session during both the upgrade and the channel bandwidth change, and consequently will require a truck roll. In a second example that follows here, the goal is to downgrade an entire PMP 430 HPAP tower from Release 10.2 or later to Release 10.1.1, and have no SMs that are unable to reconnect to the HPAP: 1.

Plan your downgrade session to occur at a date and time when historical data suggests that the fewest SMs are not in service.

When the date and time arrive, send a blast to all customers, urging them to keep their sessions up.

Use alternative means to ask customers whose SMs are out of session to attempt to reconnect the RF link. 293

Issue 3 May 2012

WM Release 4.0 User Guide

In an Inventory view, highlight all HPAPs of the tower.

Using Selecting the Software and Firmware Packages to Apply on Page 295 for the Select Packages operation, check only the package on which all HPAPs of the tower and all of the SMs in their sectors currently operate and uncheck any others that are checked in the Package List.

In the HPAP Channel Bandwidth tab, click in the Target Bandwidth column at the 5.0 (MHz) Current Bandwidth row to expose the drop‐down selection list, and select 10.0 (MHz) for Target Bandwidth.

Click in the Target Bandwidth column at the 10.0 (MHz) Current Bandwidth row to expose the drop‐down selection list, and select 10.0 (MHz) for Target Bandwidth.

Click in the Target Bandwidth column at the 20.0 (MHz) Current Bandwidth row to expose the drop‐down selection list and select 10.0 (MHz) for Target Bandwidth.

Click the SM Autoupdate Configuration tab.

10. Click the Autoupdate SM Channel Bandwidth button. The channel bandwidth is changed to 10.0 MHz in the SMs. note ............. When this occurs, connection between the HPAPs and these SMs is dropped, except where the HPAPs were already operating in 10-MHz channel bandwidth.

11. When all in‐session SMs have been reconfigured to 10‐MHz operation, make another attempt to get any that are still operating in either the 5‐ or the 20‐MHz channel bandwidth reconfigured to 10 MHz. important ........... Any that you still cannot reconfigure to 10 MHz will require a truck roll before they will be able to reconnect to the HPAP.

12. Click the Disable button. 13. Click the Start button. The channel bandwidth is changed to 10.0 MHz in the APs. 14. Allow sufficient time for the SMs whose connections were dropped to re‐register in their APs after the reboot. 15. Using Selecting the Software and Firmware Packages to Apply on Page 295 for the Select Packages operation, check only the CANOPY101_1_Downgrade_OFDM_AESorDES.pkg3 package and uncheck any others that are checked in the Package List. 16. In the SM Autoupdate Configuration tab, click the Enable button for Enable/Disable APs for SM Autoupdate. Only the registered SMs (not the HPAPs also) are downgraded to Release 10.1.1. They will drop their connections to the HPAPs and be unable to re‐register. 17. In the SM Autoupdate Configuration tab, click the Disable button for Enable/Disable APs for SM Autoupdate. 18. In the Selected for Upgrade tab, click the Start button. This time, the HPAPs are downgraded to Release 10.1.1. The SM connections will drop and then be re‐established after the reboot, at which point all sectors of the tower will be operating on Release 10.1.1, except for those SMs that were not in session during both the channel bandwidth change and the downgrade, and consequently will require a truck roll.

294

WM Release 4.0 User Guide

Issue 3 May 2012

Authenticating WM into the Device(s) If no Telnet/FTP Login ID is configured in the Credential Manager (see Setting WM Credentials for a Group of Selected Devices on Page 248), then WM uses root to authenticate into elements for an upgrade via TFTP server. When no Telnet/FTP Password is configured, WM uses a null password. These are also the default user name and password for PMP and PTP elements, with the exception of PMP 320 devices. If either or both of these are configured in the set of elements selected for the upgrade, then their reconfigured values must be configured into these fields of Credential Manager for the elements to allow WM to force the upgrade in them via TFTP. Ensure that device selection is complete in the Selected for upgrade tab. Then click the Apply settings button. If the PMP/PTP tab content is consistent and complete, then WM accepts the authentication strings.

Selecting the Software and Firmware Packages to Apply note ............. Use of the upgrades feature requires ConfigurationInstall Software Upgrades allowed in the Permissions tree hierarchy.

Click the Select Packages button. WM 

begins scanning and preparing to load the package files that are in the appropriate directory on the server.



opens for the interim the pop‐up message Manually added packages are being added into the database. Please try again later. This pop‐up remains open until you dismiss it.

After the scanning and loading process is complete, the Package Manager dialog will not open. Repeat the Select Packages command option (and the pop‐up dismissal, as needed) until the WM opens the Package Manager dialog with packages populated, presuming that there is at least one in that server directory. If none exist there, then the dialog opens with no files initially listed under Package Name.

295

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 213: Package Manager dialog, no packages

Regardless of whether packages from the server loaded, you can optionally click the Add button and then browse to and select any package file from anywhere in the client file system. Repeat this as many times as required to upload all the packages from the client to the WM server. Each uploaded package is then available for any client to use for upgrades, until and unless it is removed by a client, as described below. Whenever the Select Packages command option is invoked, any file (in the Tftp directory of the server) that was not previously loaded into Package Manager is loaded into it.

Figure 214: Package Manager dialog, packages added

296

WM Release 4.0 User Guide

Issue 3 May 2012

The Package Info panel in the lower portion of this window provides a summary of information about the currently highlighted single package. At any time, you can check the check box of a package and click the Remove button. This both removes the package from the Package List and deletes the package from the server. Before performing the upgrade operation, WM examines each checked package and uses only the top‐most acceptable package. To save some of the time that WM would spend examining packages, you can alter the order of the packages in Package Manager by using the Move Up and Move Down buttons, which move the currently highlighted package.

9.23.3

Launching the On-Demand Software Upgrade Ensure that the information is complete and appropriate in the PMP/PTP tab. Then click the Start button. If no package has been checked in the Package List, then WM throws a specific error to that effect. Otherwise, WM begins the configured upgrade(s). During the process, if you see a need to stop it, click the Abort button.

9.23.4

Reviewing the Relevant Post-Upgrade Information About the Device(s) After performing an upgrade, WM

9.23.5



moves the successfully upgraded device to the Upgrade complete tab in the lower panel and updates its Status and version(s) columns.



leaves the device whose upgrade failed, so that it is there for further upgrade attempts.

Resetting Location Attributes for PTP 300 and PTP 500 Devices When devices of these types are upgraded to their v05‐00 release, any values previously configured by CSV import of their Latitude, Longitude, and Height above Ground attributes for these devices are lost, because the OIDs associated with these attributes have changed. The workaround is for operators to configure these as fully supported attributes after the upgrades to v05‐00.

297

WM Release 4.0 User Guide

Issue 3 May 2012

10 Creating and Using Device Groups The Device Group feature enables you to define a static or dynamic logical group of two or more devices and assign a group name. Several WM operations may be performed on device groups, such as Apply template and Run report. The Applications tree lists each configured group under the category Device Groups. There is no limit to the number of device groups to which a device can belong. A static group membership will always consist of the same devices, except those that you specifically add to the group or specifically remove from it. Specifically, in this context, means that you mark the Name (ID) of the target device(s) by highlight and then click the buttons (Add or Remove, and then Update) to execute the addition or removal.

Figure 215: Add Device window for Static Selection of a device group

A dynamic group membership can automatically change as its devices cease to match its criteria or other polled devices now do, but its set of criteria for membership will not change, except if you deliberately alter the set of criteria by selecting other conditions.

299

Issue 3 May 2012

WM Release 4.0 User Guide

After a group has been defined, it cannot be transformed into the other group type. For example, if you think you will need to manually add or manually exclude one or more devices from a group in the future, you should define it using the Static Selection option. If you want the membership of the new group to flex with polling results, then you should define it using the Dynamic Selection option. In a dynamic group definition, you select whether the definition will be 

Basic, which can apply to only the following criteria: −

one required Specific Type—device specific type; for example, PMP.SM(v11.0)

−

zero or one Configuration Attribute with an associated operator and value to filter devices of the device specific type

−

zero or one Performance Attribute with an associated operator and value to filter devices of the device specific type.

Figure 216: Create Device Group conditions for basic Dynamic Selection of a device group



Advanced, which can apply to the following criteria: −

300

one or more values for any or all of the following Device Properties: 

Device Type—for example, PMP.SM



IP Address



Managed



Name (ID)



SNMP Read Community



SNMP V3 Context Name

WM Release 4.0 User Guide

Issue 3 May 2012 

SNMP V3 User Name



SNMP Version



Write Community



Specific Type—device specific type; for example, PMP.SM(v11.0)



Status



Sys OID

−

zero or more Configuration Attributes, each with an associated operator and value to filter devices of the Device Type or Specific Type, only if one or more Device Type or Specific Type has been specified under Device Properties

−

zero or more Performance Attributes, each with an associated operator and value to filter devices of the Device Type, only if a Device Type has been specified under Device Properties.

Figure 217: Name selections for Add Advanced Criteria of a dynamic device group

301

Issue 3 May 2012

WM Release 4.0 User Guide

In Device Properties for an Advanced Dynamic Selection 

the Specific Type is limited to all or fewer of the specific types that fall within the selection(s) made for Device Type. For example, if you select PMP.AP and PMP.SM for Device Type…

and then select Specific Type from the drop‐down list of remaining Device Properties, the selectable values include only the specific types within PMP.AP and PMP.SM:



302

Device Type is unavailable among the Device Properties if you specify Specific Type before you attempt to select Device Type.

WM Release 4.0 User Guide

Issue 3 May 2012

For Configuration Attributes or Performance Attributes, the Add Advanced Criteria interface allows you to select from either 

a list of all attributes that the full set of selected Specific Types or Device Types share in common:



a list of all attributes that are valid in common for only some of the Device Types or Specific Types that the device group comprises:

303

Issue 3 May 2012

WM Release 4.0 User Guide

This flexibility effectively allows you to define a group that will always be composed of all of certain types of devices and a subset of devices of other types. If you toggle back and forth, trying to decide whether to define a group by Basic or Advanced dynamic criteria, your changes in the dialog are retained until you click the Update button. If this occurs while the Basic criteria are displayed, then the conditions defined by Advanced criteria are discarded and will not apply to the dynamic group membership. Similarly, if you toggle back and forth between Static Selection and Dynamic Selection, your changes are retained until the Update. You can invoke the Device Group feature in any of the following ways: 

by selecting ToolsManage Device Groups from the main menu. This allows you to create a new device group or edit or delete an existing one.



by right‐clicking on the name of an existing device group under InventoryDevice Groups in the Applications tree. This allows you to



−

monitor an Inventory view of these members in either the view panel or a separate window (Detach).

−

Apply template or Run report, as stated above.

−

launch a physical map that comprises the members of the device group.

−

edit or delete the specific device group.

by right‐clicking on a device in an Inventory view and selecting −

Add To Device Group. This allows you to add the device to an existing device group or create a new one.

−

Device Group Membership. If the device already belongs to one or more device groups, this allows you to 

view the names of the device group(s) to which it belongs.



remove it from membership in one, some, or all of them.

note ............. If multiple devices are highlighted before the right-click, then the membership list that results is a list of only those device groups in which all of the highlighted devices are members.

304

WM Release 4.0 User Guide

10.1

Issue 3 May 2012

Creating a Dynamic Device Group To create a dynamic device group, perform the following steps.

Procedure 39: To create a dynamic device group 1.

In the Applications tree, right‐click InventoryDevice Groups.

From the drop‐down list of options, select Create Device Groups.

Figure 218: Device Group Details tab of the Create Device Group dialog

In the Device Group Details tab of the Create Device Group dialog, type a Name for the new group.

Type an optional Description that will help you and others remember how this group is constituted.

If you want other users to be able to see and use this device group, check the Public check box.

Click the Devices tab.

305

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 219: Devices tab of the Create Device Group dialog

306

Using the guidance under Creating and Using Device Groups on Page 299, decide whether you want this group to have a Basic or an Advanced definition.

Using the available options, specify the Basic or Advanced criteria for dynamic group membership.

Optionally click the Preview button to see the list of devices that would become current members of the new group.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 220: Devices Preview window

10. Inspect the list of devices in the Devices Preview window to ensure that the membership would be as intended. note ............. Although you can click to highlight one or more devices in this window, no options are available to exercise on these previewed devices.

11. Click OK to dismiss the Devices Preview window. 12. If you are satisfied with the criteria, click the Create button. RESULT: The Device Groups window displays all currently defined groups, indicating the user who create the group, the date on which that occurred, and whether the group is Static or Dynamic.

Figure 221: Device Groups window

For any Dynamic group type, when a new device is polled and matches the dynamic criteria, the new device becomes a member of the device group. When an existing device is polled and no longer matches the criteria, the existing device is dropped from membership in the device group. When a non‐member device is polled and matches the criteria, it is added to the device group. In the Applications tree and elsewhere in the WM client application, the icon each Dynamic group.

is associated with

307

Issue 3 May 2012

10.2

WM Release 4.0 User Guide

Modifying a Dynamic Device Group To change the criteria for an existing Dynamic group, perform the following steps.

Procedure 40: To modify a dynamic device group 1.

In the Applications tree, select InventoryDevice Groups.

Right‐click the device group name.

Select Device Group OperationsModify Group.

Figure 222: Device Group Details tab of Edit Device Group dialog

308

In the Device Group Details tab, change the Name, Description, or Public access as desired.

Click the Devices tab.

Using the guidance under Creating and Using Device Groups on Page 299, decide whether you want this change to be a Basic or an Advanced definition.

Using the available options, modify the Basic or Advanced criteria for dynamic group membership.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 223: Devices tab of Edit Device Group dialog

Optionally click the Preview button to see the list of devices that would become current members of the changed group definition. (See Figure 220 on Page 307.)

Inspect the list of devices in the Devices Preview window to ensure that the membership would be as intended.

10. Click OK to dismiss the Devices Preview window. 11. If the membership reflects your intent, click the Update button.

10.3

Creating a Static Device Group To create a static device group, perform the following steps.

Procedure 41: To create a static device group 1.

If all devices of a particular device type are intended members of the new device group, perform the following steps: a.

Click the Device Type column in the Inventory view.

In the Inventory view, click to highlight the target devices.

Right‐click one of the highlighted devices.

From the drop‐down list of options, select Add to Device Group. The Add to Device Groups window opens.

309

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 224: Add to Device Groups window

e. 2.

310

Click the Create Group button. The Create Device Group dialog opens.

If you did not begin this procedure with Step 1, right‐click the Device Groups tree node under Inventory and select Create Device Groups from the drop‐down list of options. The Create Device Group dialog opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 225: Devices tab of Create Device Group dialog

In the Device Group Details tab, compose a Name for the group and a Description that will help you and others remember what this group represents.

To allow other users to access the device group, select the Public check box.

Click the Devices tab.

Click the Static Selection radio button.

If you began this procedure with Step 1, move the Create Device Group window so that you can see the Name (ID) entry of most or all of the devices that you had selected in the Inventory view.

Click the Add button. The Add Device window opens.

311

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 226: Add Device window

Ctrl+click to highlight the Name (ID) of each device you want in the device group.

Figure 227: Devices selected to add

10. Click the Add button. All of those devices are added to the Devices Selected block of the Create Device Group window.

312

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 228: Devices added to Devices Selected block

11. Click the Create button. The device group is added to the Applications tree, and the devices that were selected belong to the device group. (You do not need to add them in a separate operation.)

In the Applications tree and elsewhere in the WM client application, the icon each static group.

is associated with

313

Issue 3 May 2012

10.4

WM Release 4.0 User Guide

Adding Devices to a Static Device Group Procedure 42: To add one or more devices to an existing device group 1.

In the Inventory view, click to highlight the device(s) that you want to add.

Right‐click one of the selected devices and select Add To Device Group. The Device Groups window opens, listing all of the existing device groups.

Figure 229: Add to Device Groups window

314

Click to highlight the device group.

Click the Add To Group button.

WM Release 4.0 User Guide

10.5

Issue 3 May 2012

Removing Devices from a Static Device Group Procedure 43: To remove a device from a device group Either perform this set of steps: 1.

In the Inventory view, right‐click the specific device group.

From the drop‐down list of options, select Device Group OperationsModify Group.

The Edit Device Group dialog opens to its Device Group Details tab. 3.

Click the Devices tab.

In the Devices Selected block, click to highlight the device that you want to remove from the device group.

315

Issue 3 May 2012

WM Release 4.0 User Guide

Click the Remove button. An alert asks for confirmation.

Confirm the removal by clicking the Yes button. The Devices Selected block of the Edit Device Group dialog displays the list of devices that remain in the device group.

or perform this set of steps: 1.

In the Inventory view, right‐click the device you want to remove from the device group.

From the drop‐down list of command options, select Device Group Membership.

In the resulting Device Group Membership For Selected Device(s) window, click to highlight the correct device group in the list.

important ........... This window does not expand the device group to display its members. Ensure that the target device is in fact the one that is highlighted in the Inventory view that the Device Group Membership For Selected Device(s) window overlays (shown below).

316

Click the Remove From Group button. An alert asks for confirmation.

Confirm the removal by clicking the Yes button. The Devices Selected block of the Edit Device Group dialog displays the list of devices that remain in the device group.

WM Release 4.0 User Guide

10.6

Issue 3 May 2012

Adding or Removing Columns in a Device Group Window

317

Issue 3 May 2012

10.7

WM Release 4.0 User Guide

Using a Device Group When you right‐click the name of the device group in the Applications tree, an Inventory view populated with only the members of that device group opens, and so does a drop‐down list that provides the following options:

318



Physical Map. This option displays a new instance of the physical map comprised by the members of this device group.



Modify Group. This option allows you to change the name or description of the device group, its access (Public or not), and allows you to add new devices or remove any member devices.



Delete Group. This option allows you to delete the entire device group and all of its memberships in a single operation.



Columns To View. This option opens the Select Table Columns window. See Figure 86: Select Table Columns dialog for inventory custom view on Page 134.



Configuration TemplatesApply template or Delete template. See Using Configuration Templates on Page 618.



ReportsConfiguration ReportsRun report or Delete Report. This option allows you to execute any previously created report. See Running a Configuration Report on Page 331 or Deleting a Configuration Report on Page 337.



DetachDetach. This option allows you to handle the device group Inventory as a separate window, independent of the view panel in the client.

WM Release 4.0 User Guide

10.8

Issue 3 May 2012

Removing a Device Group To delete a device group, perform the following steps.

Procedure 44: To remove a device group 1.

In the Applications tree, select AdministrationScheduled Tasks.

Figure 230: Scheduled Tasks window

In the User field at the top of the Scheduled Tasks window, use the drop‐down list to select your user name.

Wait until the table contents are refreshed.

If any listed task is scheduled against the device group that you intend to delete, edit or delete the task.

In the User field at the top of the Scheduled Tasks window, use the drop‐down list to select All.

Use a vertical scroll to scan the list for other tasks that are scheduled against the device group that you intend to delete.

For any that you find, alert the owner about your intention.

In the Applications tree, select InventoryDevice Groups.

In the Device Groups window, right‐click the row of the device group that want to delete.

Figure 231: Delete Group option for a device group

10. From the drop‐down list of options, select Delete Group. RESULT: The systems asks for confirmation.

319

Issue 3 May 2012

WM Release 4.0 User Guide

11. If you want to proceed with the deletion, click the Yes button. If you have any doubt and want to see the definition of the group first a.

click the No button.

in the Device Groups window, right‐click the row of the device group.

from the drop‐down list of options, select Modify Group.

examine the definition of the group.

if you want to proceed with the deletion 1) click the Cancel button. 2) repeat Steps 9 through 11.

320

WM Release 4.0 User Guide

Issue 3 May 2012

11 Obtaining Device Configuration Information By default, WM collects polled configuration values from managed elements on a regular basis. This basis is operator configurable (see Adjusting Configuration Polling Intervals below). WM also collects this type of information on demand (see Creating and Using Device Configuration Reports on Page 323).

11.1 11.1.1

Adjusting Configuration Polling Intervals Disabling Configuration Polling Configuration polling consumes significant server resources and burdens the network with arguably unneeded overhead traffic. Rediscovery captures the attribute values. So, separately polling for them is a redundant exercise. Where server resources and network traffic are of little concern, such as in a small network, the information under Setting Intervals for a Small Network provides guidance for adjusting the interval(s) at which WM will poll its devices for their attribute values. However, the general recommendation for most networks and strong recommendation for large networks is to disable configuration polling altogether. To disable it, from the main menu, select ToolsPolling Configuration and uncheck the Enable Configuration Polling check box. A server restart is not needed to enforce this change.

11.1.2

Setting Intervals for a Small Network From the main menu, the ToolsPolling Configuration opens the Polling Configuration dialog to its Performance Polling tab. When this dialog opens, click the Configuration Polling tab.

321

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 232: Polling Configuration dialog, Configuration Polling tab

WM inherits the single global configuration polling setup for every device type from the value of the GlobalConfigPollingInterval tag in the file .../WM/server/conf/WibbWMSConfiguration.xml in the WM server file system. The initial (installed) value of this tag is 12 hours. If you wish, you can

leave this configuration in force by not using this tab. This tab in the client interface allows you to override those configurations by setting the configuration polling via SNMP queries to 

occur (Enable Polling Status checked).



not occur (Enable Polling Status unchecked).



not occur for device types that you specify, and occur for all other device types. (See Procedure 45 below.)



occur at the Global Polling Interval for all devices types.



occur at intervals that you set (Polling Interval in Hours) for each device type that you deliberately Add for configuration polling interval setup, and occur at the Global Polling Interval for device types that you do not Add. (See Procedure 45 below.)

To set some or all device types that you specify to be polled for configuration values at a rate different from the Global Polling Interval, perform the following steps.

322

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 45: To set configuration polling for a specific device type 1.

Click the Add button associated with the Specific Type Based Polling Configuration block of the Polling Configuration dialog. The Configure Specific Type Polling dialog opens.

Figure 233: Configure Specific Type Polling dialog for configuration polling

In the Specific Type field, use the drop‐down list to select the device type.

If you want to disable polling for the device type that you selected, uncheck the Enable Polling check box.

If you want polling of your selected device type to occur at an interval that differs from the Global Polling Interval in the previous dialog, type the number of Hours into the Polling Interval text box. The following rules apply to resetting polling intervals:



The smallest accepted polling interval is 1 hour.



The largest accepted polling interval is 24 hours (1440 minutes).

note ............. If you attempted to apply an illegal interval, the client throws a pop-up error.

for a value too small:

for a value too large:

note ............. If you attempted to apply an interval identical to the global polling settings, the client asks for confirmation.

323

Issue 3 May 2012

WM Release 4.0 User Guide

11.2

Back in the Polling Confirmation dialog, you can use ◦

the Remove button to return a highlighted device type to global polling treatment

◦

the Modify button to change the settings (in a dialog like that shown in Figure 268 above, but with the device type preselected and not changeable) that you previously made by the procedure.

◦

the Reset to Defaults button to restore all polling intervals for all device types to the value of the GlobalConfigPollingInterval tag in the file .../WM/server/conf/WibbWMSConfiguration.xml in the WM server file system.

Creating and Using Device Configuration Reports Reports allow you to select and view configuration parameters of discovered devices. These reports are a complement to the configuration features of WM (the Configure Device command and the configuration template features). You can use reports to verify the configuration of a device. Since these reports are about configuration parameters, they differ from performance data reports, which are described elsewhere in this guide. Some configuration parameters are not configurable (are read‐only). These parameters are not visible when you are configuring a device, but are available as part of a configuration parameter report. They are configuration parameters in that, during discovery and rediscovery, WM polls them from the device along with other configuration parameters. They are separate and different from performance data parameters, which WM polls during the more‐frequent performance data polling cycles and which retain historical values. Command options allow you to 

run any of a set of predefined reports



create a custom report



edit a configuration report



save that report as a template to use for configuring other custom reports



run that report upon command



ultimately remove reports that no longer serve their original purposes.

These command options are available through both the device‐specific menu and a right‐click on the target device in the Inventory view.

324

WM Release 4.0 User Guide

11.2.1

Issue 3 May 2012

Importing Configuration Report Templates To import these configuration report templates, perform the following steps.

Procedure 46: To import configuration report templates 1.

In the Applications Tree, expand the Configuration node.

Right‐click the Configuration Report Templates sub‐node.

Select Template OperationsImport Report Template(s).

Browse to the target path where the configuration templates exist within reach of the client. (See the path quoted above, if you are browsing in the server file system.)

Use

◦

Ctrl+click to individually select a set of templates.

◦

Shift+click to individually select the first and last of a set of templates that are sequentially displayed in the browser, then Ctrl+click to subtract any from in between.

◦

Click to select a single template.

After you have highlighted (selected) all of the desired template files, click the Open button.

All of the imported files will be available to any user from the Configuration Report Templates dialog upon right‐click of an element and selection of ReportsConfiguration ReportsRun Report from the drop‐down list of command options.

11.2.2

Accessing a Predefined Report on Configured Values For each supported device, WM includes a set of predefined templates that display the current values (on demand) of the configurable parameters in the selected elements. The Inventory view provides access for running these preconfigured reports.

Procedure 47: To access a configuration report template 1.

Right‐click to select the element from an Inventory view.

Select ReportsConfiguration ReportsRun Report from the resulting drop‐down list of options.

325

Issue 3 May 2012

WM Release 4.0 User Guide

The Execute Configuration Report Template panel opens in the right frame, listing all of the imported reports for this device type.

Figure 234: Execute Configuration Report Template panel

Imported, in this context, means all of those xml templates that were deliberately copied into the user interface by the operator in the utility of the client application. Since the import requires a browse of the file system on the client device, the templates must be accessible to browsing in one of the following ways: 

The client device is local to the server device. In this case, the templates are available at ...Cambium/WM/server/Default Templates/Report Templates/ (the path is in the

server file system). 

The client device is remote from the server device, but either −

a network connection, authenticated where required, exists between the client and the server file system, and the operator uses that connection to browse in it.

−

the operator has copied the template files from the remote path quoted above to a path in the client file system and browses to this local path.

No setting exists for automatically importing the predefined templates that support only the device types present in your network or the larger group that support all possible device types. To import these configuration report templates, see Importing Configuration Report Template on Page 324.

11.2.3

Creating a Configuration Report You can create a custom report by using a template to include the various device configuration parameters whose values you want to be able to view. The report creation process begins with selecting one or more devices. Since you can later run the report against any other device(s), user‐ defined device group, or all devices of a certain device type 5, the individual device that you have selected when you launch the configuration report creation utility is unimportant.

This would involve sorting the Inventory view by the Device Type column, and then using Shift+Click on the first and last listed among that particular device group, then right‐clicking on one of the selected devices and selecting Configuration ReportsRun Report.

326

WM Release 4.0 User Guide

Issue 3 May 2012

The device type is important, since the set of parameters that you can choose from in building the report is limited to those that the device type of the selected device supports. For this reason, a report can be run against only devices that have the same device type that the report was created against.

Procedure 48: To create a configuration report 1.

Invoke the configuration report creation utility in either of the following ways. ◦

From the Inventory as follows: a)

In the Inventory, right‐click on a device of the target type.

b) From the resulting drop‐down list of options, select ReportsConfiguration ReportsCreate Report. The Create Configuration Report Template dialog opens, listing all of the available device configuration parameters that WM supports for the target device type, each selectable within an expandable and contractible category or as an individual parameter.

Figure 235: Create Configuration Report Template dialog launched from Inventory

◦

From the Applications tree as follows: a)

In the Inventory, click to highlight a device of the target type.

b) In the Applications tree, click to expand the Configuration node.

327

Issue 3 May 2012

WM Release 4.0 User Guide

Right‐click the Configuration Report Templates sub‐node. The Configuration Report Templates panel opens, listing all previously imported and all previously created templates. This list is filtered on the basis of agent type.

d) From the drop‐down list of options, select Template OperationsCreate Report Template. The Create Configuration Report Template dialog opens with Device Type initially set to the highest alpha‐sort device type. The associated down‐arrow opens a list of all selectable agents (device types).

Figure 236: Create Configuration Report Template dialog launched from Applications tree

e) Use the down‐arrow to select the target Device Type. The dialog populates with all of the available device configuration parameters that WM supports for the target device type, each selectable within an expandable and contractible category or as an individual parameter.

328

For convenience, optionally use the Jump To drop‐down list to select one configurable parameter. The branch of the configurable attribute hierarchy expands.

Expand additional portions as you wish.

WM Release 4.0 User Guide

Issue 3 May 2012

Compose a Template name that will help you distinguish this report template in the future.

Compose a Template description that summarizes the purpose of the report.

In the Include column, select (check the check box of) each parameter and/or category of parameters that you want included in the report.

note ............. In the example shown in Figure 235 above, all of the parameters in the Maximum Information Rate category are automatically selected because Maximum Information Rate is selected. important ........... Although you can later choose the devices to run the report against and run the report multiple times as you select different sets of devices, you will not be able to change what fields the report includes. To see a different set of fields, you must create a different new report. Thus, it is important to ensure that you have selected all of the desired fields before you click the Create button.

Click the Create button. The system confirms that the report has been created.

Figure 237: Success for a create report

Click Yes. The Select Configuration Report Data window opens.

Figure 238: Select Configuration Report Data window

If you want WM to query the values from the database, leave Database selected for Source data from. If you want WM to poll the values from the device(s) against which the report runs, select Device.

10. Click the Run Report button.

329

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 239: Configuration Report View window

Some delay may occur, during which WM obtains the values, and then the system opens a Configuration Report View window, which includes ◦

the parameters that you selected for the report and the values of those parameters for the device(s) against which you created the report.

◦

options to change the source (to Database or Device for Execute this report from) and/or collect the data for a different set of devices (Add Devices), in case you want to Re‐Run Report.

◦

options to process the data for viewing: −

an Export utility to send the current format of the parameters and values from the report to a comma‐separated values (.csv) file.

−

a Print utility to send only the data through a print driver of your choice.

−

a Details view, which is especially useful where the report includes many columns, since it formats the data such that information hidden by the constraints of the table view is revealed.

330

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 240: Execute Report window

provides an Export utility to send the details format to a CSV file.

provides a Print utility to sent the details format through a print driver of your choice.

331

Issue 3 May 2012

11.2.4

WM Release 4.0 User Guide

Running a Configuration Report To run an element configuration report from the latest data available, either polled from the device(s) at the moment when you run the report or queried from the database (updated in the last previous discovery 6 or configuration polling 7), perform the following steps.

Procedure 49: To run a configuration report 1.

In the Inventory view, select all devices that you want included in the report.

note ............. Although more devices of more than one specific type are selectable, and selecting them would return a list of reports that together apply to all of them, the report selection window will allow you to select only one report to execute.

To specify more than one device before you launch Run Report, use any of the following means: ◦

select a contiguous set of rows by holding down the Shift key and clicking on the first and last row to be deleted.

Shift 

◦

select multiple individual rows by holding down the Ctrl key and clicking on each of them.

Ctrl

◦

6 7

in the Applications tree, expand Device Groups and right‐click on a device group.

Right‐click on one of the selected devices.

From the drop‐down list of options, select ReportsConfiguration ReportsRun Report. The system opens an Execute Report window, which lists all currently defined reports.

Initial discovery (see Configuring Initial Discovery on Page 404) or rediscovery (see Scheduling Rediscovery on Page 406). See Adjusting Configuration Polling Intervals on Page 321.

332

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 241: Execute Configuration Report window

In the list, click to highlight the desired type of report.

Optionally, switch the source of report data (to query the Database or poll the Device).

To optionally change the set of devices for which values will be retrieved, perform the following steps: a.

Click the Add Devices button. The Add Devices dialog opens.

To add the members of a Device Group, perform the following steps: 1) Click the Load From Group button. The Device Groups window opens and lists all of the currently defined Device Groups. 2) Scroll and click, Ctrl+click, or Shift+click to highlight the row(s) of the one or more desired Device Group Names.

333

Issue 3 May 2012

WM Release 4.0 User Guide

3) Click the Load button. The individual devices that are members of the selected Device Groups are loaded into the Devices Selected block of the Add Devices dialog. c.

To specify individual devices by their Name (ID)s, perform the following steps: 1) Click the Add button. The Add Device window opens, listing all of the currently managed devices. 2) Scroll and click, Ctrl+click, or Shift+click to highlight the row(s) of the one or more desired individual devices. 3) Click the Add button. The selected devices are added into the Devices Selected block of the Add Devices dialog.

Click OK.

Back in the Execute Configuration Report window, click the Execute button. WM runs the report and opens the Configuration Report View window.

For the meaning and usage of the options in this window, see Procedure 48: To create a configuration report, where these are already described around Figure 239 on Page 329. note ............. If the agent in any device from an Add Devices operation does not support one or more fo the OIDs being polled for the report data, then the client returns the following type of error.

11.2.5

When you are finished, dismiss the Execute Report window.

Finding a Configuration Report Template The client includes a utility for quickly finding a configuration report template based on strings that constitute a portion of or the entire template name, template description, or the device type that the template supports.

334

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 50: To find a configuration report template 1.

In the Applications tree, click on ConfigurationConfiguration Report Templates. This opens a Configuration Report Templates view in the right panel, listing all that are currently defined.

From the main menu, select EditSearch. A special Search window opens to configure for matches against any of the tabular data that WM is displaying in the Configuration Report Templates window, including that which is viewable only by scrolling.

Figure 242: Search window for configuration report template criteria

The operation of this window is consistent with how the several other Search windows in the client operate. For an example, see Search on Page 123. Keep in mind that the scope of the search is the contents of the table, not the contents of all configuration report template files (not attributes).

11.2.6

Editing a Configuration Report Template To change the set of parameters for which a configuration report will retrieve values, perform the following steps.

Procedure 51: To edit a configuration report 1.

In the Inventory, right‐click on a device.

From the list of drop‐down options, select ReportsConfiguration ReportsEdit Report. The client opens the Execute Configuration Report window to a table view of the available report templates.

335

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 243: Edit Configuration Report Template window

Click to highlight the report that you want to edit.

Click OK. The client reopens the Execute Configuration Report window to a table view of the full list of parameters whose values can be retrieved for a device of the type that you right‐clicked.

note ............. You cannot change the Template name, but you can change the Template description to better reflect the purpose that you intend for the template after editing it. If you want to make changes that together would render the original name confusing or inappropriate, create a new template instead of editing this one.

336

Check the Include box for each parameter you want to add to the template and uncheck it for each that you want to remove. The Reset button removes all checks from the check boxes in the Include column.

When you are satisfied with the set of checked parameters, click the Save button. The client confirms that the changes are saved.

WM Release 4.0 User Guide

11.2.7

Issue 3 May 2012

To optionally run the edited report, see Running a Configuration Report below.

Exporting a Configuration Report Template It is possible to export a template that you created on this system to another location. You can use this function to either store a backup copy in a safe folder or share with another WM system.

Procedure 52: To export a single configuration report template

11.2.8

In the Applications tree, click on ConfigurationConfiguration Report Templates. The full list of all existing templates opens in the view panel.

In the view panel, right‐click on the template that you want to export and select Export template. The Select Template Export Folder window opens.

Browse to and double‐click on the destination folder.

Click the Export To Folder button.

Exporting All Configuration Report Templates It is possible to export all templates that you created on this system to another location in a single operation. You can use this function to either store backup copies in a safe folder or share with another WM system.

Procedure 53: To export all configuration report templates 1.

In the Applications tree, right‐click on ConfigurationConfiguration Report Templates. This open the Reports view in the view frame, where all defined reports are listed.

From the drop‐down list of options, select Template OperationsExport All Report Template(s). The Select Template Export Folder window opens.

Browse to and double‐click on the folder where you want to store the report templates.

Click the Export To Folder button.

337

Issue 3 May 2012

11.2.9

WM Release 4.0 User Guide

Deleting a Configuration Report To remove a report that no longer servers its original purpose, perform the following steps.

Procedure 54: To delete a configuration report 1.

In the Inventory view, click on a device of the type to which the target report applies.

From the drop‐down list of command options, select ReportsConfiguration ReportsDelete Report. The Delete Configuration Report Template window opens, listing all currently defined reports.

Figure 244: Delete Report window

338

Select the report template that you want to delete.

If you want to review the contents of the report template before deleting it, click View. The Delete Report window displays a view of the report contents.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 245: Delete Report window, reports contents

When you have confirmed the target report is the one to be deleted, click Delete. The system returns a warning message:

Click Yes to confirm the deletion.

339

Issue 3 May 2012

11.3

WM Release 4.0 User Guide

Using Configuration Summary Reports WM includes various reports that are each preconfigured to deliver current values of important sets of configuration attributes in all devices of a particular category. The types and scopes of these reports are as follows.

Table 14: Configuration Summary reports System Report Name

Attribute Values Reported

AP QOS Summary

Device ID, Device Name Uplink Sustained Rate, Downlink Sustained Rate , Uplink Burst Allocation , Downlink Burst Allocation , Downlink Rate, Broadcast Downlink CIR

AP VLAN Configuration Summary

Device ID, Device Name Enabled, Local Setting Enabled , Allow Only Tagged Frames , Dynamic Learning , Ageing Timeout , Management VID

PMP 320 AP QOS Summary

Index, Service Class Name, MIR, Min Reserved Rate, Tolerated Jitter, Max Latency, UL Schedule Type, Data Delivery Type, Unsolicited Grant Interval, Unsolicited Poll Interval

PMP 320 AP Service Flow Summary

SM MAC, SF Index, Direction, QoS Profile ID, Classification Rule ID

PMP 320 CPE Service Flow Summary

SFID, CID, BCID Type , State, Direction , Enabled , Scheduling, Max Rate (bps), ARQ Enable , HARQ Enable, Rules

PMP Backhaul VLAN Configuration Summary

Device ID, Device Name Enabled, Local Setting Enabled, Allow Only Tagged Frames, Dynamic Learning, Ageing Timeout , Management VID

PTP 800 Bridge Configuration Summary

Device ID, Device Name Queue Mapping Bridge, Queue Mapping GARP, Queue Mapping Table Entry Count, Local Packet Filtering

PTP VLAN Configuration Summary

Device ID , Device Name Enabled, Management Priority, Allow Only Tagged Frames, Management VID

SM QOS Summary

Device ID, Device Name Uplink Sustained Rate, Downlink Sustained Rate, Uplink Burst Allocation, Downlink Burst Allocation , Broadcast MIR, High Priority Channel Enabled, High Priority Uplink CIR, High Priority Downlink CIR, Low Priority Uplink CIR, Low Priority Downlink CIR

SM VLAN Configuration Summary

Device ID , Device Name Allow Only Tagged Frames, Dynamic Learning , Ageing Timeout, Management VID, SM Management Pass‐through VID, Untagged Ingress VID

340

WM Release 4.0 User Guide

Issue 3 May 2012

By default, configuration summary reports are accessible to every user. This access continues unless the administrator removes the permission for a specific user. As shown below in a portion of the Permissions tree hierarchy, permissions for configuration summary reports are individually assignable per report as well as categorically assignable.

note ............. Access to these reports require that they are imported into a client that is networked to the WM server file system.

341

Issue 3 May 2012

11.3.1

WM Release 4.0 User Guide

Using a Configuration Summary Report as Preconfigured To access any of these reports, select System Reports from the Applications tree. This opens the System Reports view in the view panel (Figure 246).

Figure 246: System Reports view

To open the desired report, either double‐click in the row or right‐click in it and select Execute Report. When you do, the report opens as HTML content.

342

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 247: SM QOS Summary

You can reshape the HTML window, but not manually resize its columns or sort by their content. However, you can export the entire report as CSV for use in another application or Print the entire report on any networked printer. Running a device summary report is a schedulable task in the WM client. See Scheduling a One‐Time or Periodic Task on Page 647. As soon as you launch a configuration summary report, WM automatically saves it into a repository that contains in list from all previously launched reports that have not been deleted from the list. You can access this repository by selecting System ReportsReport Results from the Applications Tree. This list is sortable by any of its columns: 

Result File Name (in the format ReportName_SequentiallyAssignedReportNumber, so that within each alpha sort of report name, the order is chronological)



User (who launched the report)



Time (date and time)



Report Name



Report Type

See Figure 162 on Page 226. Since the reports in the list are not searchable, and since the list of stored reports tends to grow over time, sorting is useful. Secondary sorting is achievable by sorting the secondary sort column first, then the primary sort column. To view an individual report in the Report Results view, right click on the target report and select View Report. This opens the report in the exact format and window size that the report opened in when you originally launched it.

11.3.2

Customizing a Configuration Summary Report As preconfigured, each configuration summary report runs on all devices of a category. You can customize a configuration summary report to run on a subset of those devices if you set the report as a scheduled task and filter that task for devices and optionally for their configuration and performance values. See Table 86: Configurable task prerequisites, requirements, and options on Page 648.

343

WM Release 4.0 User Guide

Issue 3 May 2012

12 Monitoring Faults An event is an occurrence that is generated due to a device trap or internal WM operations and is logged in a historical database. Events can indicate progress of background processes such as discovery or problems that arise in WM or in a managed device. Most events are associated with a particular managed device, which the event refers to as the Failure Object, but some are generic. Events are logged and documented in the historical view titled Network Events. An alarm is generated when an event with Status (severity) of Critical, Major, Minor, or Warning occurs. An alarm has the same severity as the event that generated it. An alarm persists until it is cleared and then subsequently is purged from the database. An alarm that is not cleared remains in the database and continues to be listed in the alarms view unless it is individually deleted by a user. An alarms is cleared when a new event occurs that has both 

the same failure object as the alarm



a status value clear.

An alarms can also be cleared manually by the operator. The AlarmClearingPolicy automatically clears a select group of alarms that have an AlarmClear value of 3 after a configurable aging period, whose default is seven days. (See Administering a Policy on Page 603.) By default, cleared alarms are deleted after 24 hours. This is configurable in the server file system. Events are deleted from the database by an event aging policy after a configured period. The deletion period is set using the CLEAN_EVENT_INTERVAL parameter for the EventMgr process, specified in NmsProcessesBE.conf file in the WM server. The default is seven days. Events are deleted regardless of their status after the aging period. Only alarms are kept, due to their status as explained in the previous paragraph. The status of a device matches the severity of its most severe alarm. The Alarms view lists all selectable active (not yet cleared) alarms. Thus, the Alarms view is current, whereas the Network Events view is historical. Both views are dynamic—updated as new events/alarms are generated. Events particular to discovery processes are logged and documented in the historical view titled Discovery Events. See Viewing All Events Related to Discovery on Page 354.

12.1

Working with Events The Network Events view can present events in either of two ways: 

only those events that are associated with a specific device.



all events, including device events for all devices.

345

Issue 3 May 2012

12.1.1

WM Release 4.0 User Guide

Viewing All Events for a Specific Device You can launch the Network Events view to include only events that are associated with a specific device in either of the following ways: 

In a Inventory view, right‐click the target device and select Go ToEvents from the drop‐ down list of options.



In the physical map, click the target device, click the Manage tab, and then click the Go to Events link in that tab.

While viewing the events of a specific device, to switch to viewing all events in the system, click the Show All button in the upper right corner of the view frame. To view the details or alarms that are associated with an individual event, see Viewing Event Details on Page 350.

Figure 248: Network Events view, one device (Source)

346

WM Release 4.0 User Guide

12.1.2

Issue 3 May 2012

Viewing All Events in the System To view all events that have been generated in the system and not yet cleared, select Fault ManagementNetwork Events from the Applications tree. The unfiltered Network Events view displays in the view frame.

Figure 249: Network Events view, all Sources

While viewing the full set of events, you can click on any column heading to sort or reverse sort the events by the data in that column. Typical table view operations apply to this view. To view the details or alarms that are associated with an individual event, see Viewing Event Details on Page 350.

347

Issue 3 May 2012

WM Release 4.0 User Guide

12.1.3

Interpreting Event Messages The following table lists various default messages generated by WM (without any configuration) along with their severities and their significance.

Table 15: Preconfigured event messages and their severities Message

Signifies

Severity

Network added to database

Network Addition

Info

Node Added to Database

Node Addition

Info

Interface Added to Database

Interface Addition

Info

Port Object Added to Database

Port Addition

Info

Port Added in disable state

Port Failure

Major

At least one node in this network is in failure state

Network Failure

Major

No nodes failed in this network

Network Clear

Clear

This probably means one or more interfaces have failed

Status Poll failed (Node Failure)

Major

Status Poll failed

Status Poll failed (Interface Failure)

Major

No failures in this node

Status Poll Clear (Node Clear)

Clear

Interface clear

Status Poll Clear (Interface Clear)

Clear

Discovery Events Discovery event messages are available in the Network Events view among the other network event messages. The Discovery module in WM may generate any of the following events.

Table 16: General discovery events Event

Meaning

Discovery started

discovery has begun for the device.

attribute(s) were not read due to time out error

means that SNMP GET timeouts resulted in some configuration attributes not being read during discovery. This could mean that communication with the device is not consistent, or the device’s agent is not responding consistently, some OIDs being requested are not supported by the device, etc.

CLEAR ‐ all attributes that timed out were read successfully

indicates that after reading attributes failed due to timeout error (see other event above), a later attempt to read the attributes succeeded, and all configuration data has been read for the device.

348

WM Release 4.0 User Guide

Issue 3 May 2012

Event

Meaning

not added since the AdventNet license limit is exceeded

means that a node was initially discovered but then discarded due to the fact that the node limit for the WM license in use was already reached. To remedy the situation, one can obtain a license with a higher node count and then rediscover.

Configuration differences detected during rediscovery

only seen during rediscovery of an already‐discovered device – indicates that the configuration of the rediscovered device does not match what the database showed as being the configuration prior to rediscovery. Generally this will happen when the configuration of the device is changed outside of WM, e.g. via the device URL.

applied profile

only during initial discovery, indicates that a configuration template was applied as a profile upon completion of discovery. This happens only when WM has been explicitly set up to apply a template for a specific device type upon initial discovery.

No empty sysName

the check for an empty sysName property (device name) during discovery has passed.

No duplicate sysName

the check for a sysName property (device name) that's already in use has passed.

No special characters in sysName

the check for a sysName property (device name) that has special characters in it has found none.

Changed sysName of <device name> from <old sysName> to <new sysName>. Please update the device accordingly.

the sysName was changed because it is a duplicate of one already in use. Duplicates get a suffix added to them to make them unique. To make the sysName on the device match the altered name WM has stored, it is necessary to use either the configuration feature in WM or the device's own management URL to change the sysName on the device. The sysName must be unique in WM. When it is not unique, WM assigns a provisional sysName that is stored in only WM, not also in the device. Whenever WM rediscovers or refreshes the configuration for the device that has a provisional sysName, it will throw this error again, since the response from the device will not match it. To suppress this error, the operator must use the direct management interface of the device to write this provisional, or any other unique, sysName into the device.

Removed special characters from sysName of <mac address>. Please update the device accordingly.

the sysName was changed due to special characters, which have been removed. To make the sysName on the device match the altered name WM has stored, it is necessary to use either the configuration feature in WM or the device's own management URL to change the sysName on the device.

Changed sysName of <device name> to <new sysName>. Please update the device accordingly.

this means that the sysName property was changed due to having been null (empty). To make the sysName on the device match the altered name WM has stored, it is necessary to use either the configuration feature in WM or the device's own management URL to change the sysName on the device.

349

Issue 3 May 2012

WM Release 4.0 User Guide

Table 17: Multi-agent discovery events Event

Meaning

Complete discovery of multi‐agent device

all NEs have been successfully resolved (linked) into a multi‐agent device. Indicates successful completion of multi‐agent discovery for one multi‐agent device and all of its component NEs.

Incomplete discovery of multi‐ agent device

generated for an NE when it is properly part of a multi‐agent device, but was not successfully resolved into a multi‐agent device during discovery. This event will always be generated at least once for each multi‐agent device in the ordinary course of events, since one agent is always discovered before the others, and therefore has no way to resolve into a combined multi‐agent device. As a result of this event, which is a Major alarm, the NE will go into Major status, but that status should clear once other components of the multi‐agent device are discovered and they are all resolved into a multi‐agent device.

Table 18: Single-agent discovery event Event

Meaning

Discovery finished

discovery has been successfully completed for a single‐agent device.

In addition to these event messages, certain more specific discovery‐related events are listed in the Discovery Events view. See Viewing All Events Related to Discovery on Page 354.

CSV File Import Events WM may generate the following event for an import of a geo‐location file.

Table 19: File import event Event

Meaning

modified the location information for device

generated during a CSV location file import, indicating that the location of a device was changed by the import.

12.1.4

Viewing Event Details Event details provide information on each of the properties of an event.

Procedure 55: To view event details

350

In the Applications tree, select Fault ManagementNetwork Events.

Right‐click to highlight the row that contains the event whose details you want to view.

From the drop‐down list of options, select Event Details. An Event Details window opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 250: Event Details window

The field of this window are described in Table 20.

Table 20: Event details Property

Description

Index

Specifies a unique ID created for each of the events that are generated.

Severity

Specifies the severity of the event, such as Critical, Major, Minor, Clear, Warning, Info.

Message

Specifies the message associated with the event.

Category

Specifies the category to which the event belongs. Example: Topology.

Domain

Specifies the domain‐specific information which is based on physical location, functional categorization, or logical categorization of the source of the event.

Network

Specifies the network to which the event belongs to.

Node

Specifies the node to which the event belongs to. For example, if the event is for an interface, the node value is specified as interface parent node.

Failure Object

Specifies the specific entity (in the source) that has failed and is primarily responsible for the event. See Failure Object on Page 352.

351

Issue 3 May 2012

WM Release 4.0 User Guide

Property

Description

Source

Specifies the exact source (network, node name, interface) of the event.

Help URL

Specifies the URL for locating the help documentation on clicking the Help button in the same dialog box.

Date/Time

Specifies the date and time when the event was generated.

GroupName

Specifies the group name to which the event belongs.

AlarmClear

If the value is 3, then this alarm is eligible to be cleared by the AlarmClearingPolicy. Any other value is ignored.

SourceIP

Specifies the IP address of the element that generated the event.

Failure Object The failure object of an event is a correlation field that indicates that events are related. Most often, the failure object identifies a network element and includes a label that indicates the kind of event. This provides linkage between events for the same network element and events for the same problem. A failure object contains but is not limited to the identifier (WM name) of the network element that was affected by the event, except in the case of an event that is triggered before the element is fully discovered. In this case, the failure object may contain a string from another field, a field whose contents WM was able to read before the discovery halted. Yet another string is sometimes prepended or appended to the other contents of a failure object. For example, if the event occurred during discovery of a node whose IP address is 10.24.1.1, then the failure object may be Disc‐ 10.24.1.1. A failure object correlates events, and this results in WM suppressing events to avoid multiple copies for the same event in the same network element. If you create a failure object for a trap parser, select a value unused by other events, so that their clear events and alarms do not affect how the incoming trap is handled. You can view failure objects in either the Network Events view or the Alarms view. You can also see it, among other fields, when you right‐click on an event or alarm and select Details from the drop‐down list of options. Be aware that a clear event will clear the associated alarm on the network element, meaning the alarm that bears the same failure object.

352

WM Release 4.0 User Guide

12.1.5

Issue 3 May 2012

Finding an Event The search option is useful when you are looking for events associated with a particular network element. This search operation is performed in the database and is not restricted to only the events that are currently listed in the Network Events view. Searchable criteria are severity, source (Name (ID of the device), date, message, and IP address of the device.

Procedure 56: To find an event 1.

Open the Event Viewer.

Perform any of the following:

◦

From Edit menu, select Search.

◦

From the toolbar, click

◦

Press Ctrl+F.

Find button.

The Search dialog box is displayed.

Figure 251: Search window for event criteria

If you want to perform a search operation that satisfies any of the matching criteria that you specify, uncheck Match All of the Above Criteria. If you need all the matching criteria to be satisfied, leave Match All of the Above Criteria checked.

To add criteria, click the More button.

For each criterion, click the down arrow associated with Severity and select from among the following properties:

◦

Severity

◦

Source

◦

Date

◦

Message

◦

IPAddress

For each criterion, type a search expression into the text box.

353

Issue 3 May 2012

12.1.6

WM Release 4.0 User Guide

For each of these text entries, click the down arrow associated with starts with.

When you are finished setting the criteria for the search, click the Search button to launch it. The Network Events view is filtered to only those that satisfy the search criteria.

Viewing Related Alarms Since Failure Object is not one of the properties that the Search utility supports, this procedure is needed for finding all events that have the same Failure Object. This is the best way to determine what alarm was cleared by a clear event, or what clear event cleared an alarm.

Procedure 57: To view other events that have the same Failure Object

12.1.7

Open the Network Events view.

Click a row whereby you select an event.

Perform any of the following procedures. ◦

From View menu, choose Alarms.

◦

Right‐click the row and choose Alarms.

◦

Press Ctrl+L.

The Alarms view opens with only the alarms that have the same Failure Object as the selected event does.

Right‐click on one of the listed alarms.

From the drop‐down list of options, select Events.

The Network Events view opens with all events that have the same Failure Object as the alarm does.

Viewing All Events Related to Discovery The Network Events node of the Applications tree open a view of all network events, only some of which are related to discovery, and these events are generalized as listed in the following tables under the section Interpreting Event Messages on Page 348. Typically, the messages associated with these events provide information about the results of discovery attempts but not about the causes of failed discovery events: 

Table 16: General discovery events on Page 348



Table 17: Multi‐agent discovery events on Page 350



Table 18: Single‐agent discovery event on Page 350

Beneath the Network Events node, WM provides the node Discovery Events, which opens a view of only events that are related to discovery attempts. An example of this view is shown in Figure 252.

354

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 252: Discovery Events view

Throughout normal operations, this view includes 



events that are regularly thrown to the discoveryLogs.txt file (and to the Discovery Log panel in the Discovery Configurator), plus irregular events such as −

ICMP Ping failed for device

−

SNMP Ping failed for device

−

No parent node present for Ifc

specific irregular events such as failures that occur −

in querying a device.

−

when an unsupported device type is encountered.

−

during rediscovery 

for a database‐related reason.



because of device type changes made while this process is running.

The privilege to view the Discovery Events table is not limited to administrator‐level users, but it is subject to custom view scope configuration. See Using Custom View Scopes on Page 459. As with the set of Network Events, the set of Discovery Events become the input data for the operations 

ActionsExport Events. See Exporting Events to a CSV File on Page 362.



ActionsPrint. See Printing Events on Page 363.

355

Issue 3 May 2012

12.1.8

WM Release 4.0 User Guide

Defining an Events Custom View You can configure an unlimited number of custom views of events. These views are filters. They are not static, but rather are updated as new events are generated in the system, even while you are examining the view. In the Applications tree, each custom view will be either 

a direct child of the Network Events view. For example, by beginning the view creation process with the default Network Events view in front, you can create a child view that displays events in only one specific network.



the child of a child view. For example, by beginning the view creation process with that example (one network) view in front, you can create a child view that displays only critical events in that network.

Another useful custom view would be to populate the Failure Object match field with the expression Disc* so that the view is limited to all discovery‐related events. Whenever the front view in the frame is a Network Events view, WM opens an event filter criteria dialog in response to selection of ViewCustom ViewsAdd Custom View from the main menu.

Figure 253: Event filter custom view criteria dialog, Properties tab

356

WM Release 4.0 User Guide

Issue 3 May 2012

The meanings of these fields are as follows.

Table 21: Event filter custom view criteria fields Field

Description

Filter View Name

Specify name for the custom view you are creating or modifying. If no value is specified in this field, the custom views are created with default values, such as Network Events0, Network Events1, Network Events2.

ParentName

Severity

Choose the parent tree node under which your custom view has to be placed in the tree from the drop‐down box. The criteria set for the parent custom view will be automatically used for child custom view. Hence, it is enough to specify only additional criteria for the child custom view. Choose the severity of the event based on which you need to filter events in your custom view from the editable drop‐down box. For multiple severities, type the severity as comma separated values. For example, Major,Info. Specify all or part of a message associated with the events you want to view.

Message

Example: If the message is specified as Interface failure. Status poll failed., then only events with this message are displayed in the custom view.

Category

Specify the category of the events you want to view. For example, Topology.

Domain

Specify the domain name of the events to be displayed in this view. The domain‐specific information is based on physical location, or functional categorization, or logical categorization of the source of the event.

Network

Specify the network to which the source of the event belongs.

Node

Specify the name of the node based on which the events are to be filtered.

Failed Object

Specify the name of the failed entity (that is primarily responsible for the event) based on which the events are to be filtered.

Source

Specify the source of the event based on which the events are to be filtered.

From Date/Time

The events occurred after the time specified in this field [Month, Date, Year, Hour, Min, Sec, AM/PM] are displayed in the custom view.

To Date/Time

The events occurred up to the time specified in this field [Month, Date, Year, Hour, Min, Sec, AM/PM] are displayed in the custom view.

357

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description Specify age of the event based on which the events are to be filtered. Age of an event denotes the time lapsed since the last modification of the event in the Web NMS system. By default, the value specified is Any, whereby events of all age is displayed. Other options are: minutes, hours, days, today, and, yesterday.

Event Age

Example: Age in hrs > 1 displays all the events that are less than an hour old. After this custom view is created, the events are dynamically added to the view as they satisfy the criteria of being less than an hour old. In this case, the old events remain in the view. If you require to delete the old events and need to view only those currently satisfying the criteria, set the minutes in which the custom view should be refreshed in Refresh period in minutes (by default, it is set as 1 minute). On setting this, the server sends data automatically at the time interval specified.

These fields supports wild card characters as follows:

Table 22: Wild card characters for criteria fields Character

Description Matches zero or more characters.

Examples: To view all objects that begin with test, enter test*. To view all objects that end with com, enter *com. Filters the search through the NOT operator. Examples:

To view all objects that do not begin with test, enter !test*. To view all alarms except alarms with Critical and Major severity, enter either !war*,!cle* or !warning,!clear.

Separates multiple criteria for the same property. ,

Example: To view objects named mems‐server1, mems‐server2, and mems‐server3, enter mems-server1,mems-server2,mems-server3. Returns objects where a single value matches many patterns.

Example: To find all objects whose names begin with abc and end with xyz, enter abc*&&*xyz*.

358

WM Release 4.0 User Guide

Character

Issue 3 May 2012 Description

Escapes the special meaning of the character that follows. The character that follows is then literal in the search string. Example: To find a,b, enter a\,b. Separates values that constitute a range.

Example: To find object names with a poll interval value in the range of 300 to 305, enter <between> 300 and 305. Enter the smaller number first. Values including and between the two numbers are returned.

NOTES: Most of the properties listed while adding a custom view are string based. Additionally, properties to be specified as Boolean are given in drop‐down box with values all, true, and false. Selecting all removes the property from consideration. Selecting true or false yields the expected behavior. For string‐based properties, the string value is absolutely matched. For example, the string Router matches only the exact word. Words like Status and Severity are also treated as strings. For a filter of Alarms with severity critical, enter crit*. In Alarms and Events views, filtering based on time can be done by specifying the starting time and the ending time. Leave blank any field this is part of the filter criteria but not to be considered. The time required for filtering varies because it depends on the number of objects/elements, the complexity of the criteria, and the mode of storage. Custom views continue to be updated and navigable for additions/deletions until you close your session. You can either save your views or remove them.

Event and Alarm filter criteria dialogs include an Additional Criteria button. If you click this button, WM opens an additional criteria dialog. See Figure 254.

Figure 254: Additional custom view criteria dialog, Properties tab

The More button in this window adds a single Property Name/Match Criteria correlated pair of fields each time you click it. To add three pairs, for example, click the More button three times.

359

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 255: Criteria dialog with three properties

The Fewer button removes a pair. To specify what columns your new custom view should include, click the Select Props To View button.

Figure 256: Select Table Columns dialog for event filter view

To specify more columns, click the Additional table columns button.

360

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 257: User defined table columns window

The More, Fewer, and Remove buttons in this window work the same as in the Criteria Dialog window above. When you are satisfied with the construction of your table, click OK in these table columns windows. Back in the Show object with these Properties window, click the Tree Node Properties tab.

Figure 258: Tree Node Properties tab for event filter custom view

361

Issue 3 May 2012

WM Release 4.0 User Guide

The meanings of these fields are as follows.

Table 23: Tree node properties for event filter view Field

Description

Frame Title

Specify the name to be displayed on the title bar of the custom view.

Menu File Name

Specify the panel‐specific menu file name. If this field is left blank, the default menu is displayed.

Icon File

Specify the icon name (in WM_ Home/images directory) to use for the custom view. This icon is visible in the tree as well as in the title bar of the custom view.

Table Popup Menu

Specify the file name of the menu used to display a contextual menu for the objects displayed in the table of the new custom view.

Tree Popup Menu

Specify the file name of the menu used to display a contextual menu for the new custom view node in the Navigation tree.

Node Index

Specify the position of the custom view in relation to previously added views. If this field is left blank, the view will be appended to the end of the current list of custom views.

When you are satisfied with the view filter that you have constructed, click the Apply Filter button. See also the following other sections of this guide:

12.1.9



Modifying a Custom View on Page 91



Renaming a Custom View on Page 91



Resizing Columns in a Custom View on Page 91



Removing a Custom View on Page 92

Exporting Events to a CSV File The Export Events option can be used to save the Event Custom View data as a CSV (comma‐ separated values) file in the WM server. An option is provided to export either

362



all of the data that marches the Custom View criteria



only the data of the current scrollable Custom View page.

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 58: To export events 1.

Either ◦

from the main menu, select ActionsExport Events.

◦

press Ctrl+Shift+E.

The Export Data dialog box is displayed.

Figure 259: Export Data dialog

Select the desired option from the radio buttons: Export Entire Custom View Data or Export Displayed Data.

Enter the file name in File name field.

Click Export. A status message is displayed. The exported custom view data file is saved in the WM_Home/server directory, as shown in the following example from MS‐Excel.

12.1.10

Printing Events If a printer is both connected to the WM server device and configured in WM for printing, then you can send the currently viewed list of events to that printer from the client.

Procedure 59: To print events to the server printer 1.

Perform any of the following: ◦

From the main menu, select ActionsPrint.

◦

In the toolbar, click the

◦

Press Ctrl+P.

Print button.

363

Issue 3 May 2012

WM Release 4.0 User Guide

If the system returns either the following error or a TimedOutException, inform the administrator of the WM server file system:

tip ................ You can customize the Event Viewer by adding or removing columns using the Custom View options, order the events by sorting, or by creating new custom views. See also Resizing Columns in a Custom View no Page 91. After customization, you may want to use the print option to get a printed version of your customized view.

12.2

Handling Alarms The Alarms view can present alarms in either of two ways: 

only those alarms that are associated with a specific device.



all alarms, including device alarms for all devices.

Alarms views include an Owner column. For any picked alarm, the owner is shown. For any unpicked alarm, there is no entry in this column. So, a glance down, or a sort of, this column reveals the alarms that still require at least initial attention (picking). See Picking Up / Unpicking an Alarm on Page 368. note ............. To limit the number of minor alarms for Authentication failure triggered by rediscovery with multiple default read community strings, see the workarounds described in Table 40: SNMP configuration parameters on Page 412.

12.2.1

Viewing All Alarms for a Specific Device To view only alarms that are associated with the specific device, you can either 

364

type a distinctive portion of the IP address into the Search text box above the Applications tree. In the Results tab, click the number link (2 in the example below) next to the Alarms heading:

WM Release 4.0 User Guide



Issue 3 May 2012

right‐click the device and select Go ToAlarms. In either case, an Alarms view opens to the alarms of only that device.

Figure 260: Alarms view, one device (IPAddress)

In a more circuitous flow that can be advantageous, you can select Go ToPhysical Map instead. In the map, where you can see from icon colors the health of devices that are in link with the target device, right‐click the target and select ManageAlarms. While viewing the alarms of a specific device, to switch to viewing all alarms in the system, click the Show All button in the upper right corner of the view frame. To view the details or events that are associated with an individual alarm, see Viewing Related Events on Page 368.

12.2.2

Viewing All Alarms in the System To view all alarms that have been generated in the system, select Fault ManagementAlarms from the Applications tree. The unfiltered Alarms view displays in the view frame.

365

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 261: Alarms view, all devices (all IPAddresses)

While viewing the full set of alarms, you can click on any column heading to sort or reverse sort the events by the data in that column. Typical table view operations apply to this view. To view the details or events that are associated with an individual alarm, see Viewing Related Events on Page 368.

12.2.3

Viewing Alarm Details Alarm details provide information on each of the properties of an alarm.

Procedure 60: To view alarm details 1.

Open the Alarms view.

Perform any of the following: ◦

Click a row in the table and from the main menu, select Alarm Details.

◦

Right‐click a row in the table and select Details from the drop‐down list of options.

◦

Click a row in the table and press Alt+D.

◦

Double‐click a row in the table.

The Alarms details for Source window opens, displaying all information that is currently available about the alarm.

366

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 262: Alarms details window

For information on each of the properties explained in this dialog box, refer to Table 24.

Table 24: Alarm details properties Property

Description

Message

Specifies the message associated with the alarm.

Failure object

Specifies the specific entity (in the source) that has failed and is primarily responsible for the alarm.

Source

Specifies the source of the alarm.

Owner

Specifies the owner associated with the alarm.

Category

Specifies the category to which the alarm belongs.

Created

Specifies the date and time when the alarm was created.

Modified

Specifies the date and time when the alarm was last modified.

Group

Specifies the group name to which the alarm belongs.

367

Issue 3 May 2012

WM Release 4.0 User Guide

Property

Description

Severity

Specifies the current severity of the alarm, such as Critical, Major, Minor, Warning.

Previous severity

Specifies the previous severity of the alarm. For example, if the alarm is of Clear severity, this value might be Major, indicating that a Clear event was associated with and cleared an earlier Major alarm.

Other alarms in this group

Specifies other alarms belonging to the same group. Double‐click alarms in this field to view its details.

tip ................ To instantly update the alarm details, click the Refresh button in this window.

12.2.4

Searching Alarms The procedure to search alarms is the same as explained in Finding an Event on Page 353.

12.2.5

Viewing Related Events Procedure 61: To view related events 1.

Perform any of the following: ◦

From the main menu, select ViewGo ToEvents.

◦

Right‐click the row and select Go ToEvents from the drop‐down list.

◦

Click the target alarm and press Ctrl+E.

A Network Events view opens with only events that have the same Failure Object as the selected alarm.

12.2.6

Picking Up / Unpicking an Alarm Pick Up is a mechanism that helps in assigning a particular alarm/fault of a device to a work group or user. When an alarm is picked up, but not cleared, it indicates that work on resolving the alarm is in progress but not yet completed. It is also possible to Unpick an Alarm that has already been assigned to a user or work group. An alarm annotation entry is entered with the name of the user who has picked up or unpicked the alarm and the time it was performed.

Procedure 62: To pick up an alarm from the Alarms view

368

Click the row to select the alarm.

From the main menu, select EditPick Up / UnPick, or press Ctrl+U. The alarm sorts to the bottom of the Alarms view list and has your username in its Owner column entry.

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 63: To pick up an alarm from the Alarms details dialog 1.

Click the row to select the alarm.

From the main menu, select ViewAlarm Details, or press Alt+D. The Alarms details for Source dialog opens.

Click the Pick Up button. The Owner box in the window is populated with your username and the Annotations box includes a comment for Picked up, with the associated date and time and your username.

Figure 263: Owner and Annotation in Alarm detail

Procedure 64: To unpick an alarm from the Alarms view important ........... In the first step, ensure that you select the intended alarm and that it has already been picked up.

Click the row to select the alarm.

From the main menu, select EditPick Up / UnPick, or press Ctrl+U.

Procedure 65: To unpick an alarm from the Alarm details dialog 1.

Click the row to select the alarm.

From the main menu, select ViewAlarm Details, or press Alt+D. The Alarm details for Source dialog opens.

369

Issue 3 May 2012

WM Release 4.0 User Guide

12.2.7

Click the UnPick button. Your username is removed from the Owner box in the window, and a comment for Unpicked is added to the Annotations box, with the associated date and time and your username.

Adding Comments to an Alarm It is important to track any action you have taken to fix an alarm or any new information you have gathered about the alarm. You can use the Annotate option to add notes to the alarm for future reference. For example, you can enter the solution for a problem that you resolved, using the Annotate option. This may enable other users to solve the same problem in the future with less effort, after having read your annotation, or may be used to review the remedy applied to the alarm.

Procedure 66: To add comments to an alarm 1.

Click a row whereby you select the alarm.

From the main menu, select ViewAlarm Details, or press Alt+D. The Alarm details for Source window opens.

important ........... Review the alarm to ensure that it is the intended alarm.

Click Annotate button. The SMF Add Notes Dialog opens.

Type your comments into the text field.

Click the Update button. You can view your comment in the read‐only Annotations field back in the Alarm details for Source window.

370

WM Release 4.0 User Guide

12.2.8

Issue 3 May 2012

Viewing Alarm History The history of an alarm provides complete information on its status, for example including when it was added and updated. When an alarm is generated, the Alarms view displays the current status of the alarm. When the problem that led to the alarm has been fixed, an alarm with clear severity updates the one with greater severity.

Procedure 67: To view the history of an alarm 1.

Click the row to select the alarm.

From the main menu, select ViewAlarm Details, or press Alt+D. The Alarm details for Source dialog opens.

Click the View History button. The Annotations for this alarm box converts to the History for this alarm box, which displays the history of that alarm, from first last alarm (for example, the time at which the problem occurred, the fix time, and severity change). This is the history of events that led to the current status of the alarm. Keep in mind that a clear event will clear an alarm only if its Failure Object matches.

12.2.9

Viewing Both Annotation and History of an Alarm Procedure 68: To view both annotation and history of an alarm 1.

Click the row to select the alarm.

From the main menu, select ViewAlarm Details, or press Alt+D. The Alarm details for Source dialog opens.

Click the Merge button. The bottom box converts to the Merged history and annotations for this alarm box.

371

Issue 3 May 2012

12.2.10

WM Release 4.0 User Guide

Defining an Alarms Custom View You can configure an unlimited number of custom views of alarms. These views are filters. They are not static, but rather are updated as new alarms are generated in the system, even while you are examining the view. Whenever the front view in the frame is Alarms, WM opens an alarm filter criteria dialog in response to selection of ViewCustom ViewsAdd Custom View from the main menu. See Figure 264.

Figure 264: Alarm filter custom view criteria, Properties tab

372

WM Release 4.0 User Guide

Issue 3 May 2012

The meanings of these fields are as follows.

Table 25: Alarm filter custom view criteria fields Field

Description

Filter View Name

Specify name for the custom view you are creating or modifying. If no value is specified in this field, default values, such as Alarms0, Alarms1, Alarms2 are created. Choose the parent tree node under which your custom view has to be placed in the tree from the drop‐down box.

ParentName

Severity

Previous severity

The criteria set for the parent custom view will be automatically used for child custom view. Hence, it is enough to specify only additional criteria for the child custom view. Choose the severity of the alarm based on which you need to filter alarms in your custom view from the editable drop‐down box. tip…………………For multiple severities, type the severity as comma separated values. For example, Major,Minor.

In the drop‐down list, choose the previous severity of the alarms you want to view from the editable drop‐down box. For example, if you want to view alarms that were previously minor and then became critical, select Minor is this field. tip…………………For multiple severities, type the severity as comma separated values. For example, Major,Minor.

Specify the name of the owner with whom the alarm is associated.

Owner

tip…………………To create a custom view for alarms that are un-owned by any user, set the value as null. For multiple owners, specify owner names as comma separated values.

Example: If the value is set as "Ed", then only the alarms owned by "Ed" are displayed in the custom view. Category

Specify the category of the alarms you want to view. For example, Topology. Specify the group based on which the alarms are to be filtered.

Group

Message

Example: If the group is specified as it‐test, then only alarms forming a part of this group id are displayed in custom view. Specify all or part of a message associated with the alarms you want to view in the created custom view. Example: If the message is specified as Node Clear., then only alarms with this message are displayed in the custom view.

Failure Object

Specify the name of the failed entity (that is primarily responsible for the alarm) based on which the alarms are to be filtered.

Source

Specify the source of the alarm based on which the alarms are to be filtered.

From Date/Time (modified)

The alarms modified after the time specified in this field [Month, Date, Year, Hour, Min, Sec, AM/PM] are displayed in the custom view.

373

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description

To Date/Time (modified)

The alarms modified up to the time specified in this field [Month, Date, Year, Hour, Min, Sec, AM/PM] are displayed in the custom view.

From Date/Time (created)

The alarms generated after the time specified in this field [Month, Date, Year, Hour, Min, Sec, AM/PM] are displayed in the custom view.

To Date/Time (created)

The alarms generated up to the time specified in this field [Month, Date, Year, Hour, Min, Sec, AM/PM] are displayed in the custom view. Choose the mode in which you need to group the alarms in a custom view from the drop‐down box. 

max – the alarms of maximum severity are grouped and displayed at the beginning of the list.



latest – the newest alarms are grouped and displayed at the beginning of the list.



none – the alarms are not grouped.

GroupViewMode

Specify age of the alarm based on which the alarms are to be filtered. Age of an alarm denotes the time lapsed since the last modification of the alarm in the Web NMS system. By default, the value specified is Any, whereby alarms of all age is displayed. Other options are: minutes, hours, days, today, and, yesterday. Alarm age (modified time)

Example: Age in hrs > 1 displays all the alarms that are less than an hour old. After this custom view is created, the alarms are dynamically added to the view as they satisfy the criteria of being less than an hour old. In this case, the old alarms remain in the view. If you require to delete the old alarms and need to view only those currently satisfying the criteria, set the minutes in which the custom view should be refreshed in Refresh period in minutes (by default, it is set as 1 minute). On setting this, the server sends data automatically at the time interval specified.

Event and Alarm filter criteria dialogs include an Additional Criteria button. If you click this button, WM opens an additional criteria dialog. See Figure 254 on Page 359. The More button in this window adds a single Property Name/Match Criteria correlated pair of fields each time you click it. To add three pairs, for example, click the More button three times. The Fewer button removes a pair. To specify what columns your new custom view should include, click the Select Props To View button.

374

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 265: Select Table Columns dialog for alarm filter view

To specify more columns, click the Additional table columns button. The More, Fewer, and Remove buttons in the resulting User defined table columns window work the same as in the Criteria Dialog window. When you are satisfied with the construction of your table, click OK in these table columns windows. Back in the Show object with these Properties window, click the Tree Node Properties tab.

375

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 266: Tree Node Properties tab for alarm filter custom view

The meaning of these fields are the same as those described in Table 23: Tree node properties for event filter view on Page 362. When you are satisfied with the view filter that you have constructed, click the Apply Filter button. See also the following other sections of this guide:

12.2.11



Modifying a Custom View on Page 91



Renaming a Custom View on Page 91



Resizing Columns in a Custom View on Page 91



Removing a Custom View on Page 92

Saving Alarms The procedure to save alarms is the same as explained in Exporting Events to a CSV File on Page 362.

376

WM Release 4.0 User Guide

12.2.12

Issue 3 May 2012

Exporting Alarms The procedure to export alarms is the same as explained in Exporting Events on Page 362.

12.2.13

Printing Alarms The procedure to print alarms is the same as explained in Printing Events on Page 363.

12.2.14

Clearing an Alarm Some alarms automatically clear when the condition that caused the alarm ends (for example, when a device was temporarily off‐line due to a power outage, but power is now restored and the unreachable condition clears without intervention. Other alarms require manual clearing. Clearing these may indicate that work has been done, that diagnostics have been performed, or that the condition that caused the alarm is deemed inconsequential. For example, sometimes the agent sends a trap when there is a crisis and does not send a trap when that crisis is resolved. In this scenario, you may want to clear the alarm.

Procedure 69: To clear a triggered alarm

12.2.15

In the Applications tree, select Fault ManagementAlarms.

In the Alarms view, click to highlight the alarm that you want to clear.

From the main menu, select EditClear, or press Ctrl+L.

Deleting an Alarm See Deleting an Alarm on Page 534.

377

WM Release 4.0 User Guide

Issue 3 May 2012

13 Monitoring Performance WM monitors the performance of your network by periodically collecting performance data based on various factors, such as number of bytes of data received/sent over a period by a particular interface of a device and the current bandwidth in bits per second for the interface. After discovery, WM begins to collect data from each of the devices in the network and add it to the database. From that point forward, data collection occurs on a configured, regular basis. (See the next section.) WM refers to the performance data collected from a device in the network as statistics. You can view performance data using not only the table format in the view frame, but also graphs and reports. The set of performance data statistics that WM collects for a device is determined during discovery by the device definition template for the device type. This template file resides in the WM server file system. Practically all performance statistics available from each device are collected by default.

13.1

Adjusting the Performance Polling Intervals From the main menu, the ToolsPolling Configuration opens the Polling Configuration dialog to its Performance Polling tab.

Figure 267: Polling Configuration dialog, Performance Polling tab

379

Issue 3 May 2012

WM Release 4.0 User Guide

To avoid polling traffic congestion throughout the network, WM 

defaults to a 15‐minute SNMP statistics polling interval to get values that the network element‐level dashboard and the physical map require, but disables performance polling for all other attributes (Others).



has an initial configured interval of 12 hours for Others, for all and for each specific device type.

If you wish, you can leave this configuration in force by not using this tab in the client interface. However, this tab allows you to set performance polling of some or all of these other attributes to 

occur for all device types (Enable checked for Others in this tab). This setting can cause congestion, especially in large networks, so is not recommended as a permanent configuration.



not occur for any device types (Enable returned to unchecked for Others in this tab).



occur at a user‐configured interval for each specific device types whose Others box is checked in a Configure Specific Type Polling dialog (See Procedure 70 below.)

important ........... If you manage a number of devices that approaches the maximum WM inventory count, do not reduce polling intervals from their default values, and consider increasing the intervals for Dashboard and PhysicalMap polling.

If you enable Others, then WM will allow you to optionally disable polling for PhysicalMap or Reports but will not allow you to disable polling for Dashboard. If you attempt to do so, the client returns the following error:

To set some or all device types that you specify to be polled for values that the network element‐level dashboard and the physical map do not require, perform the following steps.

Procedure 70: To set performance polling of a specific device type for its extraneous values 1.

380

Click the Add button associated with the Specific Type Based Polling Configuration block of the Polling Configuration dialog. The Configure Specific Type Polling dialog opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 268: Configure Specific Type Polling dialog for performance polling

In the Specific Type field, use the drop‐down list to select the specific device type.

If you want to disable any polling group (Dashboard, Reports, PhysicalMap, or Others) for the device type that you selected, uncheck the Enable check box.

If you want polling of your selected device type for any polling group to occur at an interval that differs from the current setting, check the Enable check box if it is not already checked, double‐click the Interval field, type the number of minutes or hours into the Interval text box, and use the Unit drop‐down list as needed to select Minutes or Hours. The following rules apply to resetting polling intervals:



The smallest accepted polling interval is 1 minute.



The largest accepted polling interval is 24 hours (1440 minutes).

When you are finished either disabling polling or specially setting the polling interval for the selected device type, click the OK button. The device type with its newly set polling status (disabled or special interval) is displayed in the Specific Type Based Polling Configuration block of the Polling Configuration dialog.

note ............. If you attempted to apply an illegal interval, the client throws a pop-up error.

for a value too small:

for a value too large:

note ............. If you attempted to apply an interval identical to the global polling settings, the client asks for confirmation.

381

Issue 3 May 2012

WM Release 4.0 User Guide

13.2

Back in the Polling Confirmation dialog, you can use ◦

the Remove button to return a highlighted device type to global polling treatment

◦

the Modify button to change the settings (in a dialog like that shown in Figure 268 above, but with the device type preselected and not changeable) that you previously made by the procedure.

◦

the Reset to Defaults button to restore all polling intervals for all device types to their defaults.

List of Available Performance Statistics (Configured Collection) WM collects data from a device based on the statistics that are defined for each device in the network. This section provides information on viewing those statistics.

Procedure 71: To view performance data collection details 1.

In the Applications tree, select PerformanceConfigured Collection. The Configured Collection view opens in the view frame.

Figure 269: Configured Collection panel

382

WM Release 4.0 User Guide

Issue 3 May 2012

The Hosts column of this view displays the devices available for data collection in the network. The name displayed in the Hosts column is the same as in the Device Name column of the Inventory view. 2.

Click a host for which you want to view data collection details (statistics). The data for the selected host is displayed in the next column as a table. Each row of performance data represents one performance data Statistic (as shown in Figure 269 above). that is collected at regular intervals. For a definition each column, see Table 26.

Table 26: Configured Collection properties Property

Description A string to identify the statistic. The three categories for statistics are Node, Interface, and Multiple (indicated by the icon).

Statistic Name

The rows are highlighted in green to indicate that data is being collected for those devices. If data collection for a device is temporarily disabled, then that specific row is depicted in blue.

Poll Id

A unique number generated automatically and associated with each Statistic.

DNS Name

Host name (device name) with which this Statistic is associated.

Data Identifier

A unique identification number of the device interface from which data about the device is to be collected. For SNMP polling, the SNMP OID.

Community

The SNMP v1/v2 Community String to be used when sending the SNMP request for collecting the Statistic.

Interval

The interval at which data should be collected for the Statistic. For example, the value 600 indicates that after every 600 seconds, data has to be collected.

Active

Specifies whether data collection for the selected device is active or not. The possible values are true or false. If it is false, data collection is not performed for that device.

Multiple

Specifies the type used to poll columnar value of the tables. Based on the types of statistics in the setup configuration, WM collects data automatically and stores it in the database. Data collected per day is stored separately: the data for each day is stored in separate database tables. The current date is appended to the table name. 3.

To view the object details of a statistic, double‐click a row. The ObjectDetails dialog is displayed. The object details of a statistic describe how it is collected from the device. To see the collected values, you will use the Plot feature as described below.

tip ................ Next to the statistic name an icon is displayed indicating the category of the statistic. There are three categories: node (with a single branch and leaf as its icon), multiple (with a triple branch icon), and interface. Nodes have one value, whereas multiple statistics can return more than one value per collection cycle (for example, when the statistic is a column in an SNMP table. When the statistic name is highlighted in green, data is scheduled to be collected for that statistic; if the name is highlighted in blue, then data collection for that statistic has been disabled.

383

Issue 3 May 2012

WM Release 4.0 User Guide

13.3

Right‐click an entry in the table and select Reports or Plot from the drop‐down menu. The Plot option supports graphs to display of both Collected Statistics and Current Statistics.

Performance Data Viewing Alternatives WM provides multiple ways to view the values of a statistic: 

running values beginning now (Current Statistic)



a history of values collected over a specified length of time (Collected Statistic)



an overview of historical values (Report)

WM handles current and historical performance data differently in some respects. The differences are described in the following table.

Table 27: Differentiating Current and Historical Data Current Performance Data (Current Statistic)

Historical Performance Data (Collected Statistic)

WM collects current performance data on demand, at very short intervals, to provide a view of the values of a statistic as they change over short time periods. WM displays the results in a continuously updated strip chart or other optional displays. The data collected for the current statistic feature is not stored in the database.

WM automatically collects data from devices in a predefined interval and stores it in the database. This data is called historical performance data. You can view this data using graphs as well as reports.

Current performance data when viewed in graph/tables are updated (based on predefined interval) as you view it.

Collected performance data when displayed in graphs/reports is not updated or the plotting does not occur as you view it. You need to reopen the graph or click Plot Chart time and again to view updated data.

The following table summarizes the formats that these alternatives provide.

Table 28: Alternatives for viewing the values of a statistic Data Format Type

Command Option Line

384

See Page

Graph Style Options Area

Bar

Scatter

Table XYstep

Current

Current Statistic

385

Historical

Collected Statistic

386

WM Release 4.0 User Guide

13.3.1

Issue 3 May 2012

Viewing a Current Performance Statistic The current view of a performance statistic is useful for troubleshooting, when you want to gather the data on demand and monitor it in real time for a while. To launch the current graph viewer, right‐ click on the target statistic in the Configured Collection view and select PlotCurrent Statistic from the drop‐down list of options. When the Current statistics window opens, the graph requires about 30 seconds as the first poll goes out and the response is received, and then begins to plot freshly collected data. In the upper left, you are able to drive up or down the polling interval, but you will typically find the default 15‐second interval sufficient. The interval that you set here has no effect on any other interval in the system. To change the interval, click the

Stop Poller icon, use the up or down arrow to change the

number of seconds for the Polling Interval and then click the

Start Poller icon.

Figure 270: Current statistics window

At the end of each interval, WM plots a new data point. The graph style options for this view are summarized in Table 28 on Page 384. This view supports zooming, auto‐ranging, printing, and saving as a PNG file. These options are available through a right‐click anywhere in the graph area.

385

Issue 3 May 2012

WM Release 4.0 User Guide note ............. If the graph displays only a zero value for a count type of statistic, this is because a constant value was received from the agent as a result of the first two observations. The difference is zero, and this is shown. This scenario can happen as the saveAbsolutes property value of a statistic is set to false by default, causing the displayed value to be the difference between successively collected values. If the saveAbsolutes value was set to true, then the absolute value would be plotted and a zero value would not occur often.

The following messages are possible when you launch the Current statistics window.

Table 29: Possible messages in a current performance data graph Message

Reason

Fetching Data....

The data is being collected from the device.

No Response from agent

This is no response from the agent running in the device. This could indicate that the element is down.

Cannot plot [Data is String type]

The collected data from the device is of string type and the graph can not be plotted.

The table view of the collected statistic can be remarkably useful, since it calls out each historical value in a table where you can read individual numbers. The table view is also the only way to view non‐numeric values. When you dismiss this window, WM will discard the values that it collected and will not save them in the database.

13.3.2

Viewing a Collected Performance Statistic The collected view of a performance statistic shows historical data collected in the past and is useful for identifying trends or focusing on time frames, such as blocks of time during which problems tend to arise. To launch the collected graph viewer, right‐click on the target statistic in the Configured Collection view and select PlotCollected Statistic from the drop‐down list of options. The Collected statistics graph opens in a separate window. This window provides not only the graph style options that are summarized in Table 28 on Page 384, but also data options in the right panel, headed Data Range Settings. The default range is the last previous 24 hours. If you switch the setting to another, click the Plot Chart button at the bottom of the panel to effect the change.

386

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 271: Collected statistics window, line graph

The following messages are possible when you launch the Collected statistics window.

Table 30: Possible messages for a Collected statistics window Message No data available

Reason By default, automatic data collection starts 5 minutes after the WM Server is started and any devices are discovered. In addition, data collection for a newly added statistic also starts after 5 minutes. However, the delay is configurable and can be set according to your network requirements. note………………For Counter type OIDs, the initial data collected is not stored. When data is collected for the second time, the difference between the two values is calculated and stored. Depending on the polling interval set, the data will be collected a second time. Therefore, it is possible that there will be more delay in plotting the graph data when working with Counter type OIDs.

Cannot plot [Data is String type]

The collected data from the device is of string type, therefore a graph will not be plotted.

Date Range Setting incorrect

The From date and To date that you set in Custom Date Range Settings are incorrect. Check for the date/time values set and click Plot Chart again.

[From‐Date is greater than To‐Date] The graph options for this view are summarized in Table 28 on Page 384. This view supports zooming, auto‐ranging, printing, and saving as a PNG file. These options are available through a right‐click anywhere in the graph area.

387

Issue 3 May 2012

WM Release 4.0 User Guide

The following is an example of a bar graph in this viewer.

Figure 272: Collected statistics window, bar graph

The table view of the collected statistic can be remarkably useful, since it calls out each historical value in a table where you can read individual numbers. The table view is also the only way to view non‐numeric values. The date range settings on the right side of the dialog allow you to display values from the last 24 hours, the past week, or an arbitrary date range.

13.4

Using System Reports WM includes various reports that are each preconfigured to deliver current values of important sets of performance statistics in all devices of a particular category:

388



AP (see Table 31: AP performance reports on Page 389)



PMP 320 AP (see Table 32: PMP 320 AP performance reports on Page 389)



SM (see Table 33: SM performance reports on Page 390)



PMP 320 CPE (see Table 34: PMP 320 CPE performance reports on Page 391)



PMP Backhaul (see Table 35: PMP Backhaul performance reports on Page 392)



PTP (see Table 36: PTP performance reports on Page 392)

WM Release 4.0 User Guide

Issue 3 May 2012

Table 31: AP performance reports System Report Name

Statistic Values Reported

AP Bridge Table Summary

[per Device Name (Device ID)] SM MAC, Local UID, Age, Extension [timeout extension flag] , Hash

AP Ethernet Statistics

Device ID, Device Name Rx Bytes, Rx Broadcast, Rx Multicast , Rx Discards, Rx Errors , Tx Bytes, Tx Broadcast, Tx Multicast , Tx Discards, Tx Errors

AP General Status

Device ID, Device Name Type, Site Contact , Site Location, Software Version, Platform Version, FPGA Version , Uptime, Regulatory, Channel Bandwidth, Cyclic Prefix, Registered SM Count , Color Code, Region Code, Temperature

AP QOS Summary

Device ID, Device Name Uplink Sustained Rate, Downlink Sustained Rate, Uplink Burst Allocation, Downlink Burst Allocation, Downlink Rate, Broadcast Downlink CIR

AP Radio Statistics

Device ID, Device Name Rx Bytes, Rx Broadcast, Rx Multicast, Rx Discards, Rx Errors , Tx Bytes, Tx Broadcast, Tx Multicast , Tx Discards, Tx Errors

AP Session Table Summary

[per Device Name (Device ID)] MAC, Session Uptime, Session State, Reg Count, Re‐reg Count, Average Jitter, RSSI (dBm), Air Delay (nsec)

AP Top 25 Report

[25 highest with total bytes] Rx Bandwidth, Rx Errors, Tx Bandwidth, Tx Errors, Aggregated Bandwidth, Aggregated Errors

AP VLAN Configuration Summary

Device ID, Device Name Enabled, Local Setting Enabled, Allow Only Tagged Frames, Dynamic Learning, Ageing Timeout, Management VID

PMP AP Graphical Summary Report

[for number of days back specified in Input Data tab, devices specified in Devices tab] Graphs and/or tables [optionally specified in Input Data tab]

Table 32: PMP 320 AP performance reports System Report Name

Statistic Values Reported

PMP 320 AP Ethernet Statistics

Device ID, Device Name Rx Bytes , Rx Discards, Rx Errors , Tx Bytes, Tx Discards, Tx Errors

PMP 320 AP General Status

Device ID, Device Name Type , Site Name, Site Contact , Site Location, Software Version, Device Version, Uptime , Center Frequency , Base Station ID

PMP 320 AP Graphical Summary Report

[for number of days back specified in Input Data tab, devices specified in Devices tab] Graphs and/or tables [optionally specified in Input Data tab]

389

Issue 3 May 2012 System Report Name

WM Release 4.0 User Guide

Statistic Values Reported

PMP 320 AP QOS Summary

Index, Service Class Name MIR, Min Reserved Rate, Max Latency, Data Delivery Type, Unsolicited Grant Interval, Unsolicited Poll Interval

PMP 320 AP Radio Statistics

Device ID, Device Name Uplink CINR (0), Uplink RSSI (0), Downlink CINR (0) , Downlink RSSI (0) , Uplink CINR (1), Uplink RSSI (1) , Downlink CINR (1), Downlink RSSI (1)

PMP 320 AP Service Flow Summary

SM MAC, SF Index Direction, QoS Profile ID, Classification Rule ID

PMP 320 AP Top 25 Report

[25 highest with total bytes] Rx Bandwidth, Rx Errors, Tx Bandwidth, Tx Errors, Aggregated Bandwidth, Aggregated Errors

Table 33: SM performance reports System Report Name

Statistic Values Reported

PMP FSK SM Graphical Summary Report

[for number of days back specified in Input Data tab, devices specified in Devices tab] Graphs and/or tables [optionally specified in Input Data tab]

PMP OFDM SM Graphical Summary Report

[for number of days back specified in Input Data tab, devices specified in Devices tab] Graphs and/or tables [optionally specified in Input Data tab]

SM Bridge Table Summary

[per Device Name (Device ID)] Device MAC, Local UID, Age, Extension [timeout extension flag], Hash

SM Ethernet Statistics

Device ID, Device Name Rx Bytes, Rx Broadcast, Rx Multicast , Rx Discards, Rx Errors , Tx Bytes, Tx Broadcast, Tx Multicast , Tx Discards, Tx Errors

SM General Status

Device ID, Device Name Type , Site Contact, Site Location , Software Version , Platform Version, FPGA Version , Uptime, Channel Bandwidth , Cyclic Prefix , Registered To , Color Code, Channel Frequency, Transmit Power Level, Region Code, Temperature , Air Delay, Jitter

SM QOS Summary

Device ID, Device Name Uplink Sustained Rate, Downlink Sustained Rate, Uplink Burst Allocation, Downlink Burst Allocation, Broadcast MIR, High Priority Channel Enabled, High Priority Uplink CIR, High Priority Downlink CIR, Low Priority Uplink CIR, Low Priority Downlink CIR

SM Radio Statistics

Device ID, Device Name Rx Bytes, Rx Broadcast, Rx Multicast , Rx Discards, Rx Errors , Tx Bytes, Tx Broadcast, Tx Multicast , Tx Discards, Tx Errors

390

WM Release 4.0 User Guide

Issue 3 May 2012

System Report Name

Statistic Values Reported [25 lowest with value] Receive power

SM Top 25 Report

[25 highest with value] Jitter [25 highest with total bytes] Rx Bandwidth, Rx Errors, Tx Bandwidth, Tx Errors, Aggregated Bandwidth, Aggregated Errors

SM VLAN Configuration Summary

Device ID, Device Name Allow Only Tagged Frames, Dynamic Learning, Ageing Timeout, Management VID, SM Management Pass‐through VID, Untagged Ingress VID

Table 34: PMP 320 CPE performance reports System Report Name

Statistic Values Reported

PMP 320 CPE Ethernet Statistics

Device ID, Device Name LAN Rx Bytes, LAN Tx Bytes, WAN Rx Bytes , WAN Tx Bytes

PMP 320 CPE General Status

Device ID, Device Name Type , Site Name, Site Contact , Site Location , Software Version , Hardware Model, Center Frequency (kHz), Device Bandwidth (kHz), Up Link Data Rate (Kbps) , Up Link Modulation Type, Down Link Data Rate (Kbps), Down Link Modulation Type

PMP 320 CPE Graphical Summary Report

[for number of days back specified in Input Data tab, devices specified in Devices tab] Graphs and/or tables [optionally specified in Input Data tab]

PMP 320 CPE Radio Statistics

Device ID, Device Name Rx Bytes, Rx Discards, Rx Errors , Tx Bytes, Tx Discards, Tx Errors

PMP 320 CPE Service Flow Summary

Device ID, Device Name SFID, CID, BCID, Type, State, Direction, Enabled, Scheduling, Max Rate (bps), ARQ Enable, HARQ Enable, Rules [25 lowest with value] RSSI

PMP 320 CPE Top 25 Report

[25 highest with value] CINR [25 highest with total bytes] Rx Bandwidth, Rx Errors, Tx Bandwidth, Tx Errors, Aggregated Bandwidth, Aggregated Errors

391

Issue 3 May 2012

WM Release 4.0 User Guide

Table 35: PMP Backhaul performance reports System Report Name

Statistic Values Reported

PMP Backhaul Bridge Table Summary

[per Device Name (Device ID)] SM MAC, Local UID, Age, Extension [timeout extension flag] , Hash

PMP Backhaul Ethernet Statistics

Device ID, Device Name Rx Rate(bytes/sec) , Rx Broadcast Rate(packets/sec), Rx Multicast Rate(packets/sec), Rx Discards, Rx Errors , Tx Rate(bytes/sec), Tx Broadcast Rate(packets/sec) , Tx Multicast Rate(packets/sec), Tx Discards, Tx Errors

PMP Backhaul General Status

Device ID, Device Name Type, Site Contact , Site Location, Software Version, Platform Version, FPGA Version , Uptime, Channel Bandwidth , Color Code, Region Code, Registered SM Count, Temperature

PMP Backhaul Graphical Summary Report

[for number of days back specified in Input Data tab, devices specified in Devices tab] Graphs and/or tables [optionally specified in Input Data tab]

PMP Backhaul Radio Statistics

Device ID , Device Name Rx Rate(bytes/sec), Rx Broadcast Rate(packets/sec), Rx Multicast Rate(packets/sec), Rx Discards, Rx Errors , Tx Rate(bytes/sec) , Tx Broadcast Rate(packets/sec) , Tx Multicast Rate(packets/sec), Tx Discards, Tx Errors

PMP Backhaul Top 25 Report

[25 highest with total bytes] Rx Bandwidth, Rx Errors, Tx Bandwidth, Tx Errors, Aggregated Errors

PMP Backhaul VLAN Configuration Summary

Device ID, Device Name Enabled, Local Setting Enabled, Allow Only Tagged Frames, Dynamic Learning, Ageing Timeout, Management VID

Table 36: PTP performance reports System Report Name

Statistic Values Reported

PTP VLAN Configuration Summary

Device ID, Device Name Enabled, Management Priority, Allow Only Tagged Frames, Management VID

PTP Ethernet Statistics

Device ID, Device Name Rx Bytes, Rx Non Unicast, Rx Unicast , Rx Discards, Rx Errors, Tx Bytes , Tx Non Unicast, Tx Unicast, Tx Discards, Tx Errors

PTP General Status

Device ID, Device Name Type, Site Contact , Site Location, Software Version, FPGA Version , Uptime, Region Code, Bandwidth, RF Receive Channel, RF Receive Frequency, RF Receive Modulation Mode , RF Receive Power, RF Transmit Channel , RF Transmit Frequency, RF Transmit Modulation Mode, RF Transmit Power

PTP Graphical Summary Report

[for number of days back specified in Input Data tab, devices specified in Devices tab] Graphs and/or tables [optionally specified in Input Data tab]

PTP Radio Statistics

Device ID, Device Name Rx Bytes, Rx Discards, Rx Errors, Tx Bytes, Tx Discards, Tx Errors

392

WM Release 4.0 User Guide

Issue 3 May 2012

System Report Name

Statistic Values Reported

PTP Top 25 Report

[25 highest with total bytes] Rx Bandwidth, Rx Errors, Tx Bandwidth, Tx Errors, Aggregated Bandwidth, Aggregated Errors

PTP VLAN Configuration Summary

Device ID, Device Name Enabled, Management Priority, Allow Only Tagged Frames, Management VID

WM also provides preconfigured reports of 

Inventory Summary (see Figure 273)



Device Uptime (see Figure 274 on Page 394)

Figure 273: Inventory Summary report

393

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 274: Device Uptime report

These reports are available on demand as preconfigured (as described in the next section). The preconfigured versions and slimmer versions of them (described under Customizing a System Report on Page 397) are also available through scheduled tasks. See Scheduling a One‐Time or Periodic Task on Page 647. By default, all system reports are accessible to the Groups Admin and Users. This access continues unless the administrator removes the permission for a specific user. They are initially inaccessible to user groups that the operator creates. As shown below in a portion of the Permissions tree hierarchy, permissions for system reports are individually assignable per report as well as categorically assignable.

394

WM Release 4.0 User Guide

Issue 3 May 2012

Some system reports, for example the WimaxCpeGraphicalSummaryReport.php, include the option to view their data in graphical form. Any desired system report must be imported into the client application as described in the next section.

395

Issue 3 May 2012

13.4.1

WM Release 4.0 User Guide

Importing System Reports To import any or all of the available system reports, perform the following steps:

Procedure 72: To import system reports 1.

In the Applications Tree, right‐click the System Reports node.

From the drop‐down list of options, select Import System Report(s).

Browse to the target path where the system reports exist within reach of the client.

note ............. If you are browsing in the server file system, this path is C:\Cambium\WM\server\Default Templates\System Reports\ or /usr/local/cambium/wm/server/Default Reports/System Reports/.

13.4.2

Use ◦

Ctrl+click to individually select a set of templates.

◦

Shift+click to individually select the first and last of a set of templates that are sequentially displayed in the browser, then Ctrl+click to subtract any from in between.

◦

Click to select a single template.

After you have highlighted (selected) all of the desired template files, click the Open button.

All of the imported reports will be useable for user (whose default permissions to use them have not been optionally removed in Security Administration).

Using a System Report As Preconfigured note ............. Access to these reports require that they are imported into a client that is networked to the WM server file system.

To access any of these reports, select System Reports from the Applications tree. This opens the System Reports view in the view panel (Figure 246 on Page 342). note ............. When you execute a report, the system may respond with Error occurred while printing report. This error occurs only rarely and when system resources are being used at a relatively high rate, such as during status polling and rediscovery. If you encounter this error, launch the report execution again. Cambium Networks tracks this issue under Item ID 0015217 and 0010672.

To open the desired report, either double‐click in the row or right‐click in it and select Execute Report. When you do, the report opens as HTML content. You can reshape the HTML window, but not resize its columns or sort by their content. However, you can export most of the entire reports as CSV for use in another application or print any of them on any networked printer. For reports that WM formats into multiple vertical blocks, the report dialog does not include an export option. However, to dump a portion (such as the contents of a block) of the HTML data that the report returns to a file type that an another application can read or a script can use, you can mark the portion of interest and copy it out. You can reshape the HTML window, but not manually resize its columns or sort by their content. However, you can export the entire report as CSV for use in another application or Print the entire report on any networked printer. Running a device summary report is a schedulable task in the WM client. See Scheduling a One‐Time or Periodic Task on Page 647. 396

WM Release 4.0 User Guide

Issue 3 May 2012

As soon as you launch a system report, WM automatically saves it into a repository that contains, in list form, all previously launched reports that have not been deleted from the list. You can access this repository by selecting System ReportsReport Results from the Applications Tree. This list is sortable by any of its columns: 

Result File Name (in the format ReportName_SequentiallyAssignedReportNumber, so that within each alpha sort of report name, the order is chronological)



User (who launched the report)



Time (date and time)



Report Name



Report Type

13.4.3

Customizing a System Report For a system report that otherwise runs on all devices of a category, you can customize the report to run on a subset of those devices if you set the report as a scheduled task and filter that task for devices and optionally for their configuration and performance values. See Table 86: Configurable task prerequisites, requirements, and options on Page 648.

13.5

Launching an Operator-defined Report If the administrator of the WM server file system has added operator‐defined reports to the system (as described in the server administration guide) and if they have been imported into a client that has network access to the WM file server, then these are available when you select System Reports from the Applications tree, which opens a list of all of them in the view frame. In the WM client, you cannot modify any of these reports, but you can execute any of them either on demand or as a scheduled task, at your option. See Scheduling a One‐Time or Periodic Task on Page 647.

397

WM Release 4.0 User Guide

Issue 3 May 2012

14 Administering Discovery This chapter explains how to use the Discovery Configurator to discover your network and how to perform discovery‐related administrative tasks. Wireless Manager default settings enable automatic discovery of network elements on the same local network as the server itself. WM can be configured to discover devices on an arbitrary network or at an arbitrary IP address, with configurable SNMP authentication. Various parameters affect the speed and efficiency of the discovery process and are accessed through the Discovery Configurator. As WM discovers devices, it adds their device type names into the applications tree: under Inventory. This section displays no device types before the first‐ever discovery is performed. It shows only non‐ device entries.

14.1

Importing Device Discovery Information WM allows you to import properly formatted device discovery information from another management system, such as Prizm. In general terms, the proper format exported from the other system has the following pattern.

Table 37: Format for device discovery information import Column Position 1

Column Data Range of IP address. Entries in this column can any either of the following formats: NetworkIP for example, n.n.n.0 IP-IP;SubnetIP range then semicolon delimiter then subnet

IP individual address 2

Any of the following syntaxes: Network if the first column data is NetworkIP Range if the first column data is IP-IP;SubnetIP Node if the first column data is an individual address

The default subnet mask to be used. The default subnet mask to use for node discovery is 255.255.255.255.

The SNMP version. Must be v1, v2c, or v3.

The SNMP agent port. The default that WM will use is 161 for any record whose fifth column does not contain a valid port number.

The SNMP read community string. Null is not allowed if the fourth column of the record contains v2c.

399

Issue 3 May 2012

WM Release 4.0 User Guide

Column Position

Column Data

The SNMP write community string.

Context name

Username

Priv Protocol

Priv Password

Auth Protocol

Auth Password

These columns are for contents only where the fourth column of the record is populated by v3.

Beware of saving the file in a program, such as MS‐Excel, that deposits its own end‐of‐line characters into it. The following is an example of a parsing error that points to the first line that ends with such an end‐of‐line character:

An import file must exist within file browser range of the client when the import operation is invoked. To perform the import operation, see Importing Data Files Into WM on Page 105. As soon as the operation is executed in the client, user account management under the imported user configuration begins.

14.2

Using the Discovery Configurator The discovery process can be configured to cause the auto discovery of remote nodes or to prevent the discovery of specific nodes or a local network. At startup of the wmserver service, the WM server reads the values of the parameters that have been set in the Discovery Configurator. The server also reads them and immediately launches rediscovery when a change is made in the Node Discovery tab of the Discovery Configurator but does not, however, similarly launch rediscovery when a change is made in the Network Discovery tab. This difference is by design, to conserve system resources.

400

WM Release 4.0 User Guide

14.2.1

Issue 3 May 2012

Opening the Discovery Configurator The Discovery Configurator is available as a runtime administration tool.

Procedure 73: To invoke the Discovery Configurator 1.

From the main menu, select ToolsDiscovery Configurator. The Discovery Configurator tool is displayed.

Figure 275: Discovery Configurator, General tab

401

Issue 3 May 2012

14.2.2

WM Release 4.0 User Guide

Discovering Mixed Networks When using Wireless Manager to manage networks that contain SNMPv3 devices as well as PMP and/or PTP devices, the following process should be used. 

To discover the SNMPv3 generic devices, use Network Discovery. The SNMPv3 credentials must be entered in the Network Discovery form. By default, WM uses SNMP broadcasts to discover devices via Network Discovery, so the switches or routers that control traffic in the specified network must be configured to allow SNMP Broadcast.



To discover PMP and/or PTP devices, use Node Discovery. If all devices use the same SNMP credentials, then the credentials must be entered only once (create the first device, then create the rest of devices by changing the IP address of the first one and clicking Add).

note ............. WM discovers PMP and PTP devices only if they have IP addresses. Assign IP addresses to them before you configure their discovery.

14.2.3

Configuring General Automatic Discovery This section explains the options available in the General tab of the Discovery Configurator.

Enabling/Disabling Auto-discovery By default, when the WM server is started, discovery automatically starts against any networks or nodes that are configured for discovery and not individually disabled. This is the auto discovery feature, which itself can be enabled or disabled. Since discovery uses system resources, it can be useful in some situations to turn off auto discovery. However, discovery and rediscovery are the only ways for WM to find new devices in any specified subnets or IP ranges, and to refresh the database copies of configuration parameters that were read from previously discovered devices.

Procedure 74: To disable auto-discovery 1.

In the General tab of the Discovery Configurator, deselect the AutoDiscovery checkbox. By default, this option is enabled. A warning message is displayed.

Figure 276: Confirmation for deselection of AutoDiscovery

Click Yes to disable auto‐discovery.

Click the Apply button.

important ........... When this option is disabled, auto-discovery does not occur when the Wireless Manager server restarts. If you disable and then later re-enable the auto discovery option, discovery will be initiated using the node, network, and other parameters previously specified in the other parts of the discovery configurator.

To re‐enable auto‐discovery, recheck the box.

402

WM Release 4.0 User Guide

Issue 3 May 2012

Rediscovering Already Discovered Devices As is shown below, rediscovery is the re‐execution of discovery using existing discovery parameters, usually on the basis of a schedule. Rediscovery defaults to a 24 hour schedule. One main purpose of rediscovery is to find new devices in the configured IP subnets or IP ranges, or at the IP addresses (nodes) previously configured for discovery. Another purpose of rediscovery is to refresh the configuration parameters for each previously discovered device, and compare them to previously polled or previously configured values. important ........... It is advisable to have the Rediscover Already Discovered option enabled (checked) because WM depends on rediscovery to check for network device configuration changes that have been made outside of the Wireless Manager application (using the web user interface of the device, for example). We refer to this as a Consistency Check. However, in addition or as an alternative, you can the configuration refresh capability in WM to poll (separate from rediscovery) to detect these changes. (See Adjusting Configuration Polling Intervals on Page 321.) By default, this refresh occurs once in each 12-hour period. When WM detects a difference between a network device's setting and the corresponding value in the database, WM updates the database value to match.

Procedure 75: To rediscover previously discovered nodes 1.

In the General tab of the Discovery Configurator, select the Rediscover Already Discovered checkbox, if it is not already selected.

Click the Apply button.

When the discovery process reschedules itself, this parameter decides the functionality of the discovery process. When it is enabled, all devices (discovered and undiscovered) are rediscovered. note ............. The above parameter does not control the behavior for nodes that obtain their IP addresses via DHCP. Those nodes are rediscovered every time the objects in the database are updated with the latest information.

Preventing a Local Network from Being Discovered By default, the local network and all its nodes are not discovered. Since discovery takes up system resources and can slow down other operations, it is important to keep local network discovery disabled when there are no devices to discover on some or all of the local network. It is most efficient to directly specify each network you want to discover and leave local discovery turned off.

Procedure 76: To prevent local network discovery 1.

In the General tab of the Discovery Configurator, deselect Discover LocalNet. By default, this option is disabled.

Click the Apply button.

Setting the Discovery Interval The interval between the attempt to discover at one address in a network and the attempt to discover at the next address in a network can be set in the Discovery Interval option. The value set for this parameter determines the performance (CPU utilization and network traffic) of the discovery process, since it determines the rate at which WM performs its discovery work and therefore the rate at which it uses system resources for discovery.

403

Issue 3 May 2012

WM Release 4.0 User Guide

Procedure 77: To set the discovery interval 1.

In the General tab of the Discovery Configurator, enter the interval value (in seconds) in the Discovery Interval field. The value can be greater than or equal to zero and the default value is 1 second.

note ............. very long intervals can result in a failure to complete discovery within the rediscovery period.

Click the Apply button.

Configuring Initial Discovery The first discovery process is started as soon as the Wireless Manager server is started (in cold start or warm start mode). The available settings in the Initial Parameters dialog determine the speed of the initial discovery process. It is not necessary to set the values for all the parameters. Initial discovery is unique because WM performs many operations during its initial startup, and because a significant amount of initialization is possibly being done in other software packages on your system during initial startup. So, it may be useful to change the timing of initial discovery to something different from the steady state parameters of discovery. The Initial Parameters settings apply to only the initial discovery. For subsequent discoveries, the configuration values provided in the General tab are used. When no parameters are set in the Initial Parameters section, Wireless Manager, by default, takes up the values set for the parameters in General tab, which is applicable both to the initial discovery process and for the subsequent discoveries.

404

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 78: To set initial discovery parameters 1.

In the General tab of the Discovery Configurator, select the Initial Parameters button. The Initial Parameters dialog box is displayed.

Figure 277: Initial Parameters contents from the Discovery Configurator

Enter the desired values and click OK.

Click the Apply button.

The Initial Parameters screen options are listed in the following table.

405

Issue 3 May 2012

WM Release 4.0 User Guide

Table 38: Initial discovery parameters Parameter

Description

Discovery Interval

Interval (in seconds) between the discovery of any two devices in the network. Default value: 1 second Interval (in hours) between two complete discoveries of a network. Default value: 48 hours

Rediscovery Interval

If a negative value is given, it is replaced by 48. important….…...For a large network, a rediscovery interval of at least 48 hours and a less-busy rediscovery launch time such as 1:00 a.m. are recommended.

Threshold value, in seconds, for all the SNMP requests. This value is the maximum time that the requesting process waits for the first response, before attempting a retransmission. SNMP Timeout

It is useful when the discovery engine is discovering a remote network where the response time could be more. Default value: 2 seconds This value grows exponentially for each retries. This value is doubled for each retry. For example, if the timeout value is set to 5 seconds and retries set as 2, the first retransmission will happen after 5 seconds. The second after 15 seconds and so on. Number of SNMP retries for discovery, status polling, and data collection.

SNMP Retries

Default value: 0 (i.e., retry is performed only once) If you set the value as 1, then retry is done twice. Setting this value at minimum gives better performance.

Scheduling Rediscovery You can specify the scheduled interval (in hours) between two complete network discoveries. When the task of pinging all of the IP addresses in a network is completed, Wireless Manager will wait for the specified interval before beginning a network rediscovery. Wireless Manager depends on rediscovery to check for network device configuration changes that may have been made outside of the Wireless Manager application (such as changes made using a device web interface). We refer to this feature as a Consistency Check. When discovery detects a difference between the network device's settings and the corresponding value in the database, Wireless Manager updates the database values to match. You can schedule the rediscovery process by specifying the rediscovery interval in hours. You can alternatively configure the rediscovery process to run at a specific hour on a specific day of the month or a specific day of the week.

406

WM Release 4.0 User Guide

Issue 3 May 2012

You can set the Rediscovery Interval using one of the following procedures: 

Procedure 79: To set the rediscovery at Regular Interval



Procedure 80: To set rediscovery on specific dates



Procedure 81: To set rediscovery on specific days

Procedure 79: To set the rediscovery at Regular Interval The time interval between two complete network discoveries can be configured using the Regular Interval option. When a regular time interval for rediscovery is configured, the Wireless Manager discovery engine, after discovering the IP Addresses in the network, waits for the specified number of hours before starting to rediscover the network again. 1.

Click General tab in the Discovery Configurator.

Click the Rediscovery button. The Rediscovery Scheduler dialog is displayed.

From within the Rediscovery Scheduler dialog, select the Regular Interval option (top).

Figure 278: Rediscovery Scheduler dialog

Specify the rediscovery interval in Hours, Minutes, and Seconds (as required). By default, the interval is set at 4 hours. You can set any value from 1 to 24 in the hours field. When you specify ‐1, rediscovery will be based on the entries configured in the User's Schedule option. When you select a negative value other than ‐1, the rediscovery interval will be taken as 24. For a large network, a rediscovery interval of 48 hours is recommended.

Click OK.

407

Issue 3 May 2012

WM Release 4.0 User Guide note ............. If the Rediscovery Interval is set using Regular Interval option, then the values set for Specific Dates and Days of Week options will not take effect.

Procedure 80: To set rediscovery on specific dates 1.

Click General tab in the Discovery Configurator.

Click the Rediscovery button. The Rediscovery Scheduler dialog is displayed.

Click the Specific Dates option.

Figure 279: Rediscovery Scheduler, Specific Dates

To choose a specific date on which the rediscovery occurs, click the appropriate date option: ◦

All: Selects all the dates of a month and indicates rediscovery occurs every day.

◦

Specific: Constitutes a range of days. For example, if you select 5 and 15, then the rediscovery will take place from the 5th to 15th of every month. When a particular month does not have the specified date, the rediscovery will occur based on the “number of days” difference between the current month and the next month. For example, if the specified date is 31 and the current month is October. As per this configuration, the rediscovery should occur after a range of 31 days. But the next month, November, does not have 31. In this case, rediscovery will be scheduled for December 1st (i.e., current month date 31 + specified date [31]). This is because all these calculations are in terms of milliseconds. Similarly if the date is specified as 31 and the current month is February (28 days), then the rediscovery will be scheduled for March 3.

408

WM Release 4.0 User Guide

Issue 3 May 2012

Select one of the Hour options. All selects all the hours in a day. Specific selects one or more specific hours of the day.

note ............. For the least impact on system resources and network traffic, select an hour when WM and the network are least busy (for example, 1:00 a.m.).

Click OK after you select the option.

Procedure 81: To set rediscovery on specific days 1.

Click General tab in the Discovery Configurator.

Click Rediscovery. The Rediscovery Scheduler dialog box is displayed.

Click the Days of Week option.

Figure 280: Rediscovery Scheduler, Days of Week

To choose a specific day on which rediscovery occurs, click the appropriate day option. All selects all the days of the week. Specific selects one or more specific days of the week. For example, if you select Tue and Fri, the rediscovery occurs only on those days, every week.

Select one of the Hour options. All Hours selects all the hours in a day. Specific Hours sets a specific hour.

Click OK after you select the option.

409

Issue 3 May 2012

WM Release 4.0 User Guide note ............. When both dates and days are configured, the precedence is given to dates and not weekdays. When the dates or days are configured, the rediscovery interval is set as -1 in the User's Schedule. If the Hour field is not specified, 10 will be assigned as the default value. So, if you specify only the days or dates without specifying the hours, rediscovery will happen at the 10th hour of that particular day or date.

The combinations of configurations for rediscovery interval are listed in the table below.

Table 39: Discovery interval parameters Rediscovery Interval

Hour

Dates

Days

Default

Any entry here will not take effect

Particular Hour(s)

‐1

Desired hour

No value should be configured

Particular Day for every week

‐1

No value should be configured

Desired days

Particular Date for every month

‐1

No value should be configured

Desired dates

No value should be configured

Particular Hour on a Particular Day

‐1

Desired hour

No value should be configured

Desired day

Particular Hour on a Particular Date

‐1

Desired hour

Desired date

No value should be configured

Category

Protocol Configuration Various device types support the various protocols. The discovery process identifies the device, and the protocol supports processes based on these parameters. The Protocol tab of the Discovery Configurator helps you configure the SNMP Protocol parameters. The SNMP authentication configured in this tab applies to initial SNMP broadcasts, when SNMP broadcast is enabled and when network discovery is used. Once a device responds to the SNMP broadcast for a network (subnet or IP range), further communication with the responding device uses the SNMP authentication information specified for that network in the Network Discovery tab of the Discovery Configurator. All discovered PMP and PTP devices use the write community string that is specified in the global SNMP Properties dialog (Figure 282 on Page 411), regardless of their IP address or subnet. In contrast, some generic devices may negotiate their own write community string with WM and ignore this string.

410

WM Release 4.0 User Guide

Issue 3 May 2012

Configuring SNMP Protocol The goal is to match the settings to those on some generic devices being discovered via SNMP broadcast, if any exist. The exception is the write community string, which should match the write community of the PTP devices being discovered (broadcast or not), if any exist.

Procedure 82: To configure SNMP Properties 1.

Select the Protocol tab in the Discovery Configurator.

Figure 281: Discovery Configurator, Protocol tab

Click on the word SNMP from the Protocols list.

Select the Properties button to display the SNMP Properties dialog.

Figure 282: SNMP Properties selected from the Protocol tab

411

Issue 3 May 2012

WM Release 4.0 User Guide

Configure the properties that are described in the table below.

Table 40: SNMP configuration parameters Option

Description

SNMP Discovery

Select this check box to enable or disable SNMP‐based discoveries. By default, SNMP discovery is enabled.

SNMP Retries

Specify the number of retries to be made to query a device. Default value: 0 (i.e., only one attempt is made to query a particular node)

SNMP Timeout

Specify the timeout (in seconds) to wait for the first response before attempting a retransmission. Default value: 2 seconds. Specify a list of communities/community strings, such as private or public can be given to discover the devices when an SNMP request is given. Multiple values can be given separated by space. To limit the number of minor alarms for Authentication failure triggered by rediscovery with multiple default read community strings, one of the following workarounds is required:

Read Community



Discover nodes individually.



Move the community strings of devices that send wrong string traps up to the top of the list of strings.



Subdivide the discovery networks such that each entry in the Network Discovery tab has the community string that applies to the nodes within its range of IP addresses.

Default value: public Write Community

Specify the community, such as private or public (for example) to set the write community property for all SNMP‐enabled devices. Default value: private

SNMP Ports

Specify the ports while trying to communicate to the SNMP agents on each node. Multiple ports can be specified either as space‐separated values or as a range of values. Example: 161 8001‐8005 9099.

Click OK.

SNMPv3 Discovery Use one of the following procedures to configure discovery of SNMPv3 devices:

412



For devices that support and are configured to allow access via both v1 and v3, use Procedure 83.



For devices that support and are configured to allow access via only v3, use Procedure 84.

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 83: To configure discovery for a network of devices set to allow SNMPv1 and v3 access 1.

Ask your server file system administrator to enable the broadcast discovery feature according to the procedure provided in the server administration guide section titled "Enabling Broadcast Discovery."

note ............. Ensuring that the feature is enabled is important for efficiency of the discovery process, since devices that are configured for both v1 and v3 respond to the initial v1 broadcast ping before they provide further information to WM based on its ability to authenticate in v3 (as a result of the remaining steps in this procedure).

After receiving confirmation that the feature is enabled, use the Network Discovery tab (Figure 283 on Page 415) to define the network as follows: a.

Use Procedure 89: To discover SNMPv3 devices in a network on Page 418 to set the SNMPv3 properties that will allow the WM discovery engine to authenticate into the devices.

Optionally, use Procedure 90: To set a network‐specific SNMPv3 configuration for discovery on Page 420 to override the common User Name and Context Name specified in Procedure 89.

note ............. The values of these settings are essential for authenticating the WM discovery engine to query the bulk of discovery information from the device.

Select the Protocol tab in the Discovery Configurator (Figure 281 on Page 411).

In the Protocols list, click on the word SNMP.

Select the Properties button to display the SNMP Properties dialog (Figure 282 on Page 411).

In the Read Community field, type in an SNMPv1/v2c read community string.

note ............. This string is necessary for the initial ping in v1, which ignores the v3 security settings.

Check the check box for SNMPv3 Discovery.

note ............. This check mark is necessary for having the v3 security settings read (for authenticating the WM discovery engine) to query the bulk of discovery information from the device.

Procedure 84: To configure discovery for a network of devices set to allow only SNMPv3 access 1.

Ask your server file system administrator to disable the broadcast discovery feature according to the procedure provided in the server administration guide section titled "Disabling Broadcast Discovery."

After receiving confirmation that the feature is disabled, use either ◦

the Network Discovery tab (Figure 283 on Page 415) to define the network as follows: a)

Use Procedure 89: To discover SNMPv3 devices in a network on Page 418 to set the SNMPv3 properties that will allow the WM discovery engine to authenticate into the devices.

b) Optionally, use Procedure 90: To set a network‐specific SNMPv3 configuration for discovery on Page 420 to override the common User Name and Context Name specified in Procedure 89.

413

Issue 3 May 2012

WM Release 4.0 User Guide ◦

the Node Discovery tab (Figure 288 on Page 422) to define the network as follows: a)

Use Procedure 94: To discover specific SNMPv3 devices on Page 424 to set the SNMPv3 properties that will allow the WM discovery engine to authenticate into the devices.

b) Optionally, use Procedure 95: To set a device‐specific SNMPv3 configuration for discovery on Page 424 on Page 420 to override the common User Name and Context Name specified in Procedure 94. 3.

Select the Protocol tab in the Discovery Configurator (Figure 281 on Page 411).

In the Protocols list, click on the word SNMP.

Select the Properties button to display the SNMP Properties dialog (Figure 282 on Page 411).

In the Read Community field, type in an SNMPv1/v2c read community string.

Check the check box for SNMPv3 Discovery.

Network Specific Discovery

Configuring Discovery of Remote Networks By default, the Discover LocalNet flag in the General tab of the Discovery Configurator (shown in Figure 275 on Page 401) is not checked, and the local network (to which the management station running WM server is connected) therefore is not discovered by default. When it is checked, WM adds to the topology any other network that it detects through the router and makes that network object unmanaged. If you want to add a remote network and also perform discovery on that network, this can be done using the Network Discovery option in the Discovery Configurator. note ............. Configuring discovery means that WM is set to attempt discovery in a specified network. WM cannot actually be forced to successfully discover a device at a given IP address. Discovery fails under any of the following conditions:  if no device with that address exists  if the SNMP authentication fails for that device  if the authentication is correct but the device is not supported by WM  if there is some kind of communications problem due to errors in the data path between WM and the device.

414

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 85: To enable discovery of remote networks 1.

Select the Network Discovery tab in the Discovery Configurator.

Figure 283: Discovery Configurator, Network Discovery tab

Select Discover.

Select Entire Network.

Enter the network address in the IPAddress field and the sub‐netmask of the network in the NetMask field.

Click the Add button. The IPAddress and NetMask are added to the screen with the Discover column enabled (checked), and their discovery is now enabled.

Click the Apply button.

note ............. This procedure uses the global SNMP authentication properties, but in most cases you will want to enter in the specific SNMP properties of the devices on the specified network. To do so, use Procedure 88: To discover SNMPv1 or v2c devices in a network on Page 417.

415

Issue 3 May 2012

WM Release 4.0 User Guide

Discovering a Range of IP Addresses in a Network Procedure 86: To discover only a range of addresses in a network important ........... This procedure involves using the Set of Nodes option. With this option, discovering SNMP v3 devices can slow your system performance where there are more networks to discover. The workaround, wherever feasible, is to specify the range of SNMP v3 device IP addresses using the Entire Network option instead of Set of Nodes.

Click the Network Discovery tab in the Discovery Configurator.

Select Discover.

Select Set of Nodes. The Start IP and the End IP text boxes become enabled.

Enter the network address in the IP Address field and the sub‐netmask of the network in the NetMask field.

In Start IP and End IP, enter the starting IP address and the ending IP address in the range of ip addresses to be discovered, respectively.

Click the Add button. A multiple range of IP addresses in a single network can also be configured.

note ............. If any of the node properties are specified in the Disallow Criteria field, the range of IP addresses specified here will not be discovered and added. Because of this, ensure that the properties of the devices specified using Set of Nodes are not specified in the Disallow Criteria field.

Click the Apply button.

Configuring DHCP Support for Discovery DHCP discovery is the default for the Network Discovery and Node Discovery tabs. WM supports DHCP and non‐DHCP discovery: 



With DHCP discovery, discovered devices have their MAC address or (failing that) the DNS name for their IP address as their primary identifier (their Name, the first column in the Inventory view). If a device's IP address changes (for example, due to DHCP reassignment of its IP address by the switch that provides DHCP), WM can −

use the DHCP server to obtain the new IP address of the device.

−

maintain its records moving forward under the new IP address.

With non‐DHCP discovery, the Name of the device is its IP address.

Procedure 87: To enable DHCP support

416

Perform Procedure 86: To discover only a range of addresses in a network.

Select DHCP. When the Start IP and End IP are specified, and the DHCP option is disabled, only the IP addresses in the specified range is attempted for discovery. If the Start IP and End IP are specified, but the DHCP option is enabled, the entire network is discovered, but the addresses within the range are discovered using DHCP discovery, whereas the addresses outside the range are attempted using non‐DHCP discovery.

Click the Add button.

Click the Apply button.

WM Release 4.0 User Guide

Issue 3 May 2012

Performing Network Specific Discovery of SNMP Devices Wireless Manager discovery module facilitates discovering the SNMP (v1, v2c, and v3) devices in a specific network or a range of devices in a network.

Discovering SNMPv1 and v2c Devices in a Network The Wireless Manager discovery engine, by default, 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.

Procedure 88: To discover SNMPv1 or v2c devices in a network 1.

Click the Network Discovery tab in the Discovery Configurator.

Check the Discover check box.

Check the SNMP check box. The SNMP Properties button becomes active.

Click the SNMP Properties button. The Snmp Properties dialog box is displayed.

Figure 284: Snmp Properties window for network discovery

Click V1 or V2 version as required. The SNMP Properties tab is enabled.

417

Issue 3 May 2012

WM Release 4.0 User Guide

Enter the read and write community of the nodes in the Read/Write Community fields.

note ............. You can enter multiple read/write community strings, separated by space(s). However, doing so will slow discovery. Each string entered is sequentially attempted until a match is detected. So, enter them in the order of most common to least common.

Enter the port number in the SNMP Agent Port field.

Click OK.

Back in the Network Discovery tab, click the Add button, or click the Modify button if you are updating an existing entry.

10. Click the Apply button. On performing this, the discovery engine discovers those SNMP devices in the specified network with the configured community and port.

Discovering SNMPv3 Devices in a Network SNMPv3 discovery for specific networks is useful under the following two situations: When only a certain network has SNMPv3 devices, sending v3 queries for all the networks to be discovered is redundant. Only specific networks should be configured for v3 discovery. The following are the configurations for this situation.

Procedure 89: To discover SNMPv3 devices in a network 1.

Open the Protocol tab of the Discovery Configurator.

Click to highlight SNMP.

Click the Properties button.

Disable SNMPv3 Discovery option in SNMP Properties dialog box (see Figure 282 on Page 411). This turns off the global SNMP v3 parameters.

Click the Network Discovery tab of the Discovery Configurator.

Select Discover.

Specify the IP Address and NetMask of the network that should be discovered as v3.

Select SNMP.

Click SNMP Properties. The Snmp Properties dialog window is displayed.

10. Select V3. The SNMP V3 Properties tab is enabled.

418

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 285: SNMP V3 Properties tab

11. Click the Add button. The SNMP V3 Properties dialog window is displayed.

Figure 286: Snmp V3 Properties window, General tab

12. In the General tab, enter the security User Name, Context Name, and Agent Port number. 13. Click the Security tab. 419

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 287: Snmp V3 Properties window, Security tab

14. In the Security Level combo box, select from among NoAuthNoPriv, AuthNoPriv, and AuthPriv. 15. Enter the authentication protocol name and authentication password in the Auth Protocol and Auth Password fields, respectively. 16. For the AuthPriv security level, enter the privacy protocol and privacy password in Priv Protocol and Priv Password fields, respectively. 17. Click OK. 18. Back in the Network Discovery tab, click the Apply button. In this setup, the discovery engine sends SNMP v3 queries to only the specific configured networks or set of nodes. If the v3 queries sent to the specific devices in the specific network fail, then WM sends v2 and v1 queries to the devices. If any of these queries succeeds, then WM adds the successfully queried device to the appropriate SNMP version set. If the common User Name and Context Name specified should not be used, and you want to override the common configurations specified for this network, set the following network‐specific SNMP configuration.

Procedure 90: To set a network-specific SNMPv3 configuration for discovery

420

Perform Procedure 82: To configure SNMP Properties on Page 411.

Click the Network Discovery tab of the Discovery Configurator.

Select Discover.

Specify the IP Address and NetMask for the network whose v3 configurations should be overridden.

Select SNMP.

Click SNMP Properties. The Snmp Properties dialog box is displayed.

Select V3. The SNMP V3 Properties tab is enabled.

WM Release 4.0 User Guide

Issue 3 May 2012

Click Add. The SNMP V3 Properties dialog is displayed.

In the General tab, override the common configurations: ◦

For overriding user name, use the User Name option.

◦

For overriding context name, use the Context Name option.

◦

For overriding SNMP port, use the Agent Port option.

10. Click the Security tab. 11. Select the security level from Security Level combo box. 12. Enter the authentication protocol name and authentication password in Auth Protocol and Auth Password fields, respectively. 13. For AuthPriv security level, enter the privacy protocol and privacy password in the Priv Protocol and Priv Password fields, respectively. 14. Click OK. 15. Back in the Network Discovery tab, click the Apply button. It is enough to override the necessary properties alone. The values of those properties that are not specified in the Network Discovery tab will be taken from the common values. note ............. During discovery, sometimes the SNMPv3 devices are discovered as SNMPv2 devices. This occurs when the timeout or retries value is less. To avoid this scenario, set the SNMP Timeout or the SNMP Retries to more than the default optimal value based on your agent's performance. These values can be configured in the Initial Parameters dialog. See Figure 277 on Page 405.

Setting Up Node-specific Discovery The discovery mechanism enables you to configure the discovery of specific devices or to discover devices with a specific port and agent, before discovering any other devices in the network. note ............. Configuring discovery means that WM is set to attempt discovery in a specified network. WM cannot actually be forced to successfully discover a device at a given IP address. Discovery fails under any of the following conditions:  if no device with that address exists  if the SNMP authentication fails for that device  if the authentication is correct but the device is not supported by WM  if there is some kind of communications problem due to errors in the data path between WM and the device.

421

Issue 3 May 2012

WM Release 4.0 User Guide

Configuring Discovery of IP Addresses in a Network Follow the procedure below to configure the discovery of specific nodes before discovering any other device in the network.

Procedure 91: To configure discovery of a specific IP address 1.

Click the Node Discovery tab in the Discovery Configurator.

Figure 288: Discovery Configurator, Node Discovery tab

422

Select the Discover checkbox.

Enter the IPAddress.

Select the SNMP Version from the drop‐down list.

Enter the read and write community of the nodes in the Read/Write Community fields.

Enter the SNMPAgentPort.

Click the Add button. The IP Address will be added to the table above the fields with the Discover column set to enabled (checked). This means that discovery of those specific nodes will be enabled. If the checkbox is unchecked, then the node will be ignored/undiscovered. Multiple IP addresses can be configured.

WM Release 4.0 User Guide

Issue 3 May 2012

Click the Apply button.

note ............. If the network corresponding to the given address is not available in the topology database, then the discovery engine will first add the network object to the database and will discover the specified IP before adding any other node in the network.

Discovering Nodes from a Local Network Disabled for Discovery There is a provision to discover nodes from a local network, where the discovery of local network option is disabled (Discover LocalNet is disabled in the General tab of the Discovery Configurator). This is the same procedure as is used to discover any individual node. To set up discovery for these nodes, perform the following steps. If Discover LocalNet is off, this procedure is irrelevant.

Procedure 92: To discover nodes where LocalNet is disabled 1.

Click the Node Discovery tab in the Discovery Configurator.

Check the Discover option.

Configure the IPAddress according to the node you want WM to discover.

Enter the Community.

Enter the SNMPAgentPort.

From the drop‐down list, select the SNMP Version.

Configure the other data in this form. The UserName and ContextName fields are context sensitive and not enabled unless you select v3 from the drop‐down list associated with SNMP Version.

Click the Add button. See Figure 288: Discovery Configurator, Node Discovery tab on Page 422.

Click the Apply button.

The above configuration can be performed to discover and add the local network and the node 192.168.4.10 (if the local network is 192.168.4.0 and is disabled).

Discovering SNMP Devices with Specific Community and Agent Port By default, Wireless Manager discovery uses the community string named public and the agent port 161 while discovering SNMP devices. It is possible that some devices in the network might be using a different port and community.

Procedure 93: To discover SNMP devices with specific community and port 1.

Click the Node Discovery tab in the Discovery Configurator.

Select the Discover checkbox.

Enter the IP address of the device that is to be discovered.

Select v1, v2, or v3 from the SNMP Version field drop‐down list.

Enter the read community of the device into the Read Community field. The default value is public.

Enter the write community of the device into the Write Community field. The default value is private.

423

Issue 3 May 2012

WM Release 4.0 User Guide

Enter the SNMP agent port of the device in SNMPAgentPort field. The default value is 161.

Click the Add button.

Click the Apply button.

Discovering Specific SNMPv3 Devices SNMPv3 discovery for specific devices is useful in the following two situations. In a network where only selected devices are SNMPv3 devices, sending v3 queries for all the devices would be redundant. In this case, only selective devices should be configured for v3 discovery. The following are the configurations to be made for this situation.

Procedure 94: To discover specific SNMPv3 devices 1.

Click the Protocol tab in the Discovery Configurator.

Select SNMP and click Properties. The SNMP Properties dialog box is displayed.

Disable SNMPv3 Discovery if already enabled.

Click OK.

Click the Node Discovery tab in the Discovery Configurator.

Select the Discover check box.

Enter the IP address and subnet mask of the device that is to be discovered.

Choose v3 from SNMP Version drop‐down box.

Enter the security user name, context name and the port number in the UserName, ContextName, and SNMPAgentPort fields, respectively.

10. Click the Properties button. The SNMP v3 Properties dialog is invoked. 11. Enter appropriate values in the fields. 12. Click OK. 13. Back in the Node Discovery tab, click the Add button. 14. Click the Apply button. In this setup, the discovery engine will send SNMP v3 queries only to the devices that are specified in the IP Address field with the SNMP Version set to v3. If the v3 queries to these devices fail, then v2 and v1 queries are sent to the devices. If any of these queries succeed, then these devices will be added to their appropriate SNMP versions. Also for a particular device, if the common UserName and ContextName specified should not be used and you want to override the common configuration specified for this device, you can use the following device‐specific v3 configuration example.

Procedure 95: To set a device-specific SNMPv3 configuration for discovery

424

Click the Protocol tab in the Discovery Configurator.

Click to highlight SNMP.

Click the Properties button. The SNMP Properties dialog is displayed.

WM Release 4.0 User Guide

Check (enable) SNMPv3 Discovery if it is disabled.

Enter the User Names, Context Name, and SNMP_Ports.

Click OK.

Click the Node Discovery tab in the Discovery Configurator.

Select the Discover check box.

Enter the IP address whose v3 configurations should be overridden.

Issue 3 May 2012

10. Choose v3 from SNMP Version drop‐down box. 11. Override the common configurations by entering values for UserName, ContextName, and SNMPAgentPort fields. 12. Click Properties. The SNMP v3 Properties dialog is invoked. 13. Enter appropriate values in the fields available. 14. Click OK. 15. Click the Add button. 16. Click the Apply button. It is enough if you override the necessary properties alone. The values of those properties that are not specified in the Node Discovery tab will be taken from the common values. note ............. During discovery, sometimes the SNMPv3 devices are discovered as SNMPv2 devices. This occurs when the timeout or retry value is less than expected. To avoid this from occurring, set the SNMP Timeout or the SNMP Retries to more than the default optimal value based on your agent's performance.

Preventing Discovery

Preventing Network Discovery This procedure provides a way to exclude a network from discovery, even though it would otherwise have been discovered due to the enablement of the Discover LocalNet setting. If Discover LocalNet is off, this procedure is irrelevant.

Procedure 96: To prevent the discovery of a specific network Important ........... When you uncheck the Discover option and click Apply, as this procedure does, WM discards some of the data that was configured in the Discovery Configurator for this particular network. For example, it discards the values for StartIP, EndIP, SNMP Version, Read Community, and SNMP Agent Port. So, before unchecking this option, you may want to note these values to identically populate them at some future time for re-enabling the discovery of this network.

Click the Network Discovery tab in the Discovery Configurator. By default, the Discover option is selected.

Disable (uncheck) this option.

Select Entire Network.

Configure the IPAddress and NetMask of the network that is to be bypassed by auto‐ discover.

Click the Add button.

425

Issue 3 May 2012

WM Release 4.0 User Guide

Click the Apply button.

note ............. This tag will not add the specified network, even if the network is reachable from the host in which Wireless Manager is running.

To prevent other networks from being discovered and added to the topology database, repeat this procedure for each of those networks.

Preventing Discovery of a Specific Device This procedure provides a way to exclude a node from discovery, even though it would otherwise have been discovered due to the enablement of the Discover LocalNet setting. If Discover LocalNet is off, this procedure is irrelevant.

Procedure 97: To prevent the discovery of an unlisted device Important ........... When you uncheck the Discover option and click Apply, as this procedure does, WM discards some of the data that was configured in the Discovery Configurator for this particular network. For example, it discards the values for SNMP Version, Read Community, and SNMPAgentPort. So, before unchecking this option, you may want to note these values to identically populate them at some future time for reenabling the discovery of this network.

Click the Node Discovery tab in the Discovery Configurator.

Deselect the Discover checkbox (not selected).

Enter the IP address of the device.

Click the Add button.

Click the Apply button.

You can configure the discovery engine to prevent the discovery of an element that is already known to Wireless Manager. To do so, perform the following steps.

Procedure 98: To prevent the discovery of a listed device 1.

Click the Node Discovery tab in the Discovery Configurator.

Figure 289: Disabling discovery for a listed device

In the table, select the row that represents the device. The individual Discover check box in this table is read only.

Click the Delete button.

Click the Apply button.

Preventing Discovery of Devices with Specific Properties The discovery engine can be configured to prevent the discovery of devices with specific properties. You can either disable the already added criteria or enter new criteria with the Allow Criteria option disabled (unchecked).

426

WM Release 4.0 User Guide

Issue 3 May 2012

Example When the value of properties type is set to SUN and name set to A, discovery engine will prevent the discovery of devices whose type property is SUN and its name starts with the letter A. This example is depicted below.

Procedure 99: To disallow discovery where type is SUN and name is A (example) 1.

Click the Criteria tab in the Discovery Configurator.

From the Property Name drop‐down list, select type.

In the Property Value text box, type in SUN.

Above Property Name, uncheck Allow Criteria.

Click the Add button.

From the Property Name drop‐down list, select name.

In the Property Value text box, type in A.

Above Property Name, uncheck Allow Criteria.

Click the Add button.

Figure 290: Criteria tab, disallow discovery for type SUN and name A

427

Issue 3 May 2012

WM Release 4.0 User Guide

10. Click the Apply button. When either of the properties matches in a found managed object, the object will not be discovered.

Deleting Network Entries In the Network Discovery tab of the Discovery Configurator, you can delete a specific network entry by clicking the Delete button and then the Apply button. However, deleting an entry in the Discovery Configurator does not delete that network from the database. When you restart the server without reinitializing it, the particular network will be discovered again. Similarly, when the discovery engine is scheduled for rediscovery, that network will be rediscovered (if rediscovery is enabled). Changes done in the Discovery Configurator do not delete already‐discovered networks from the database. To delete an already‐discovered network from the database, find the network in the Applications tree under InventoryNetworks and right‐click the network name. From the drop‐down list of options, select Delete Object and Traces.

14.2.4

Configuring Criteria-based Automatic Discovery To configure discovery based on Managed Object (MO) properties, the Criteria tab of the Discovery Configurator can be used. This configuration facility is used to allow or disallow the discovery of only those objects whose properties match with the specified match criteria. The Allow Criteria option is to be enabled when only those objects that satisfy the specified criteria should be discovered. If it is unchecked, then only those objects that do not satisfy the specified criteria will be discovered. The Allow Criteria contents are read as if the AND operator should apply. When multiple properties are configured in the Allow Criteria field, the objects are discovered only if all the specified properties match with those of the object found. The Disallow Criteria contents are read as if the OR operator should apply. When multiple properties are specified in the Disallow Criteria field, even if only one of the properties matches with that of the object found, the object will not be discovered. note ............. Only the name, type, ipAddress, sysOID, and the isSNMP attributes of the ManagedObject (and their derivatives) can be used with the Allow Criteria and Disallow Criteria specifications. Although you can enter other attributes in the Property Name field, the system behavior with other attributes is not tested or assured. See Figure 290 on Page 427.

428

WM Release 4.0 User Guide

Issue 3 May 2012

Discovering Devices with Specific Properties Only Procedure 100: To discover devices with specific properties 1.

Click the Criteria tab in the Discovery Configurator.

Figure 291: Discovery Configurator, Criteria tab

Above Property Name, select the Allow Criteria checkbox.

From Property Name drop‐down list, select the property. By default, five of the Managed Object Properties (name, type, ipAddress, sysOID, isSNMP) are available. The MO property name can be any of the fields in the ManagedObject class or one of its derived classes. Multiple values can be entered, separated by spaces.

In the Property Value field, enter the value for the selected property.

Click the Add button. The property name and its respective value are added in the table above the fields.

Click the Apply button.

Example: The following depicts the Allow Criteria set for specific name and sysOID properties.

429

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 292: Criteria tab, allow discovery for specific name and OID

This will add only those objects whose names are x and sysOID property as .1.3.6.1.4.1.311.1.1.3.2. All other objects will be filtered out—not added to the database.

Discovering Only SNMP Nodes Procedure 101: To discover only SNMP nodes

430

Click the Criteria tab in the Discovery Configurator.

Select Allow Criteria.

From the Property Name drop‐down list, select isSNMP.

In the Property Value field, enter true.

Click the Add button.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 293: Criteria tab, allow discovery for only SNMP nodes

Click the Apply button.

When this procedure is performed, only the SNMP nodes are discovered and added to the database. Ensure that the SNMP nodes are present and reachable from the host that runs the Wireless Manager server.

Discovering an Object with a Specific IP Address Procedure 102: To discover only the object corresponding to a specific IP 1.

Click the Criteria tab in the Discovery Configurator.

Select Allow Criteria.

From the Property Name drop‐down list, select ipAddress.

In the Property Value text box, enter the IP address.

Click the Add button.

Click the Apply button.

Discovering Objects with Multiple Properties When multiple properties are specified as criteria, the objects are discovered only if all of the specified properties match with that of the incoming managed object.

431

Issue 3 May 2012

14.2.5

WM Release 4.0 User Guide

Closing the Discovery Configurator When you leave the Discovery Configurator, WM opens a confirmation window:

The leading statement is indicating that, after making some change, you did not click the Apply button. The message about applying to the server is asking whether you want the discovery configuration changes that you made (during this configurator session) to be used for any discovery that comes due between now and the next restart of the wmserver service on the server device:

14.3



If you select No, then the next restart of the service is when WM read those changes.



If you select Yes, then WM will read those changes now and apply them at the very next auto‐discovery interval.



If you select Cancel, the Discovery Configurator remains open, and you have the opportunity to review changes and apply them.

Configuring Manual Discovery Network elements are discovered automatically by Wireless Manager and the discovery process is carried out in a predetermined way. Manual rediscovery would likely be useful for you only when you want to free up the node count for immediate licensing of a device. If you need to discover a node manually instead of waiting for WM to discover it automatically, see Refreshing Device Data on Page 248.

14.4

Stages of Discovery During basic discovery, WM authenticates itself to the device via SNMP and obtains a relatively small number of values from the device. Immediately following that basic discovery, WM launches deep discovery, during which it sets up such operations as performance data polling and trap handling. When you manually start or stop discovery, this typically causes WM to rediscover already‐discovered devices. During this rediscovery, WM performs deep discovery. However, deep discovery as part of rediscovery omits certain redundant aspects, such as setting up performance data polling. It does obtain fresh values for the configuration parameters.

432

WM Release 4.0 User Guide

14.5

Issue 3 May 2012

Viewing the Discovery Log The Discovery Configurator includes a Discovery Log tab, where important events in the discovery process are captured with their results.

Figure 294: Discovery Log

These are success examples. The following are examples of discovery failure events that the log calls out.

Figure 295: Failure events in the Discovery Log [02 Aug 2010 13:25:43:774] DISCOVERY(10.60.2.43:254): Unable to write to device while testing Write Community. Device is currently not writeable. Device's Write Community must be set manually. [02 Aug 2010 13:27:55:562] PING: [THREAD:: Thread-138] SNMP Ping failed for device 10.60.2.15.Snmp Properties:: ,RemotePort=161,SnmpRetries=0,TimeOut=1 [07 Aug 2010 24:22:45:483] PING: [THREAD:: statuspoll-2] SnmpPing failed for device 10.50.7.253.SnmpPing Properties:: Community=public,RemotePort=0,SnmpRetries=3,TimeOut=1 Version=v2 [06 Aug 2010 20:04:56:015] PING: [THREAD:: pool-5-thread-3] ICMP Ping failed for device 192.168.101.1

433

WM Release 4.0 User Guide

Issue 3 May 2012

15 Administering Wireless Manager Security This chapter describes the various elements associated with security, such as permissions assigned to groups, users, and operations. A WM administrator can manage the following functions: 

provide group‐based authorization where users can be assigned to groups that have configured levels of authorization and offer specific user authorizations.



provide fine‐grained access control for specific groups, views, and operations.



limit the access for some users to specific sub‐sets of objects or instances (for example, user access can be limited to a specific kind of device).

important ........... The order in which user permissions are set determine which permissions are allowed and which are disallowed. When users are added to a group and the later certain permissions are removed for that group, those users retain the permissions that were previously configured for them and those permissions cannot be removed from them. Similarly, when users are added to a group and then later certain permissions are added for that group, those users do not have the new permissions and cannot be granted them. Further, users who are configured for membership in more than one group whose sets of permissions differ from each other, the system should warn the administrator that a conflict exists, but the system does not.

You can restrict a user from accessing specific data, as well as from viewing and working on specific network topology information. The Security Administration tool provides security‐related operations that can be configured. You can specify permission for users for only certain security operations and restrict the users from others. For example, you can allow a user to create a new group but deny that user the option to delete that group.

Procedure 103: To launch the Security Administration tool 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens.

435

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 296: Initial Security Administration Tool Screen

In the left panel, the Security Administration window displays a Security tree that has Groups and Users nodes. Associated with the groups and users who belong to these nodes are icons that provide immediate information about the status of the particular group or user. The following defines the range of icons that the system may display.

Table 41: User icons Icon

Description User account is enabled. User is disabled and cannot log in until he/she is re‐ enabled. User account has expired. User password has expired. User has been forced out and cannot log in to the server. This is similar to the disabled user status. User login is denied due to continuous unsuccessful login attempts.

436

WM Release 4.0 User Guide

15.1

Issue 3 May 2012

Importing User Account Information WM allows you to import properly formatted user account data from another management system, such as Prizm or a parent instance of WM. The format is comma‐delimited CSV, with specifically allowed escape (Text Qualifier) characters. See Importing Data Files Into WM on Page 105.

Table 42: Format for user account information import Column Position

Column Data

LoginID Mandatory.

Group Name Optional, but the column (position) must be present. Separate multiple group names with semicolons.

Password The third column (position) may be null or populated.

Status Mandatory. Allowed content is enabled, disabled, or passwordExpired.

Password Age The fifth column entry of each row (record) should be the number of days in which WM should allow/prompt the user to enter a password. For security reasons, exporting systems may set this field to 0 for all exported records. Where this is the case, edit these entries to a practical number of days.

Beware of saving the file in a program, such as MS‐Excel, that deposits its own end‐of‐line characters into it. Both of the following example files are as displayed in MS‐Notepad. The following is an example of a parsing error that points to the first line that ends with such an end‐of‐line character:

The next example is of a file that will encounter no parsing error and of the successful Results window from the system response: Version: 1.0 Create Date: 08/17/2010 # User Account Information LoginID,Group Name,Password,Status,Password Age Mutt,test;Users,,enabled,0 Jeff,Users,,enabled,0 Batman,Admin;Users,,enabled,0 Robin,Users,,enabled,0

437

Issue 3 May 2012

WM Release 4.0 User Guide

A file without the problematic end‐of‐line characters may generate other errors, such as that a user of the same name as in one of the records is already a configured user, but this kind of error would be stated in the normal Results window. An import file must exist within file browser range of the client when the import operation is invoked. To perform the import operation, see Importing Data Files Into WM on Page 105. As soon as the operation is executed in the client, user account management under the imported user configuration begins. note ............. For any entries in the Group Name (second column) that did not exist in WM before the import, WM creates a new group name, but initially assigns no privileges to it. Every user who was imported with a null password will be allowed a first login, in which they will be prompted for a new password.

15.2

Managing Users A user is an individual entity that logs into the WM and is configured to perform only a set of WM functions. Before anyone has access to WM, he or she must be added as a user to the database. After you have created users, you can add them to groups, and/or give them specific permissions unrelated to the group.

15.2.1

Limiting a User to Read Only The following sections describe both

438



how to provision WM users as individual accounts, whose permissions will be limited by unchecked boxes in the permissions tree hierarchy (alternatively called the Operation Tree).



how to associate them with the names of user groups, whose permissions to see things can be limited by custom view scopes that you define.

WM Release 4.0 User Guide

Issue 3 May 2012

By unchecking the following items in the permissions tree hierarchy (shown in Figure 300 on Page 444), you effectively keep a user from being able to write to the system or any of the devices that the system manages:

15.2.2



Policy



Poll Filters



Polling Object



User Administration



Polling Units



AlertsAlert Filters



AlertsAlert User OperationsClear Alerts



AlertsAlert User OperationsAlert Pickup



AlertsDelete Alerts



Threshold Object



TopologyModify Object



TopologyDelete Object



Trap Parsers and Filters



Configuration



Administrative Operation

Adding a User You can add a user whenever you need to provide someone a certain level of access to WM. By default, the new user has only login permission. You provide access to various modules by making the user a member of pre‐configured groups or by directly assigning permissions to the user.

Procedure 104: To add a new user 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

In the Security Administration window, do any of the following: ◦

Select FileNewAddUser.

◦

Press Ctrl+Shift+U.

◦

Click to highlight the main branch Users in the Security tree, then right‐click it and select AddUser.

tip ................ Do not click on the Users node that belongs to groups by mistake. Click on the Users node that is highlighted in this example:

439

Issue 3 May 2012

WM Release 4.0 User Guide

The User Administration wizard opens to its User Description panel.

Figure 297: User Administration wizard, User Description panel

Type the user name and password in appropriate fields.

note ............. If no password is specified, the user name is set as the password.

440

Click the Next button. The wizard switches to its account panel.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 298: User Administration wizard, account and password expiry

In the User account expiry section, do either of the following: (By default, the user account never expires.) ◦

If you are providing access for a limited number of days, type the number of days in which the account expires into the Day(s) field.

◦

If the account should not expire, leave the Account never expires check box checked.

In the Password expiry section, do either of the following: (By default, the password never expires.) ◦

If the password should expire, type the number of days in which the password expires into the Day(s) field.

◦

If the password should not expire, leave the Password never expires check box checked.

note ............. User account expiry and password expiry are two different entities. This is why you can separately specify a user name and a password expiry. Password expiry is examined only when the user tries to log in. The user account expiry is examined at a regular time interval.

Click the Next button. The wizard switches to its permissions panel.

441

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 299: User Administration wizard, permissions

442

If you are associating the user with an existing group, complete the following steps: a.

Check the Group based permissions check box.

In the Assign groups for the user block, select the check boxes next to the groups to which you want to assign the user.

WM Release 4.0 User Guide

Issue 3 May 2012

note ............. Click the arrow in the dialog to display a pop-up window that lists the corresponding permissions for the group. Based on the permissions you can assign groups to the user.

..................... This pop-up is read only. This wizard provides no opportunity to broaden or narrow the permissions of an existing group.

If you want to create a new group to which you want to associate the user, complete the following steps: a.

In the Enter the new group name field, type a name for the new group.

Click the Add Group button. The name of the new group is added to the Group names(s) list in the Assign groups for the user block.

In the Group name(s) list, check the check box of the new group.

To directly assign permissions to the user, complete the following steps: 1) Select the Direct assignment check box. 2) Click the Permissions button. The Assign Permissions dialog opens.

note ............. The operations assigned to the user are specific to only that particular user.

443

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 300: Assign Permissions dialog

continued…

444

WM Release 4.0 User Guide

Issue 3 May 2012

Assign permissions by checking appropriate check boxes.

tip ................ To select or deselect all permissions under a given node, check or uncheck the check box of that node. To initially collapse all of the main nodes, click the

button in the upper

right corner of the window. To re-expand them, you can click the

button at any time.

When you have finished assigning permissions (checking check boxes), click the Done button.

10. Back in the wizard, click the Finish button. The new user is displayed under the Users node in the Security tree.

15.2.3

Changing a User Profile You can change a user’s profile when necessary. You might want to change a profile to change the expiration of an account or password.

Procedure 105: To change a user profile 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window is displayed. 2.

Under Users in the Security tree, click to highlight the user whose profile you want to change. The security administration tabs are displayed on the right‐side.

445

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 301: Security administration tabs

Click the User Profile tab.

Figure 302: User Profile tab

446

Click the Setting Profile button. The User Profile dialog opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 303: User Profile dialog

To enable or disable the user, uncheck No change in status check box and from the drop‐ down box, select enable or disable. To re‐enable an expired user, perform the following steps:

15.2.4

In the Status for the user block, uncheck the No change in status check box.

For Select the status to be set for this user, select enable from the drop‐down list.

Proceed with the following steps.

To make changes to expiration of the account or the associated password, use those areas of this form.

When you are finished changing the user profile, click Ok.

Assigning Groups to a User You can assign the users that you have created to already existing groups.

Procedure 106: To assign groups to a user 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens.

447

Issue 3 May 2012

WM Release 4.0 User Guide

In the Security Administration window, click to highlight the user whom you want to assign to a group. The security administration tabs are displayed on the right‐side.

note ............. It is not possible to select (highlight) multiple users for this operation.

Click the Member Of tab. See Figure 301 on Page 446.

Click the Setting Groups button. The Select Groups window opens.

Figure 304: Select Groups window

In the All Groups list, click to highlight the group name (or Ctrl+Click or Shift+Click to highlight multiple group names) to which you want to assign the user.

button. Click the The group name(s) are added to the Selected Groups list, and the user is assigned to those group(s) in the system.

tip ................ To unassign one or more of the other groups, select (highlight) the group(s) in the Selected Groups list and click the

15.2.5

button.

Click Ok. The groups that are now assigned to the user are listed in the Groups for list of the Member Of tab.

Changing a User Password Procedure 107: To change a user password 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens.

448

WM Release 4.0 User Guide

Issue 3 May 2012

In Users node of the Security tree, click to highlight the user whose password you want to change. The security administration tabs are displayed.

Perform any of the following steps: ◦

Select EditChange Password.

◦

Press Ctrl+Shift+C.

◦

Under the Users node of the Security tree, right‐click the user name select Change Password from the drop‐down list.

caution............... If you right-click on a user name when another user name is highlighted, the highlight does not move. However, the Change Password pop-up does not refer to the user by name. If you use the right-click access to the Change Password option, use it on only a highlighted user name.

The Change Password dialog opens.

Figure 305: Change Password dialog

15.2.6

Type the new password into both fields.

Click Ok. The new password is saved to the WM server.

Deleting a User You can delete a user to deny access. caution............... Do not delete the root user, or restrict its permissions or (most important) its permissions that govern the administration of other users, unless you have first created another user who has the same capabilities. If the root user is deleted, ask the WM server administrator to perform the steps under the section titled "Restoring a Deleted superuser Account" in the server administration guide. Then use Changing a User Password on Page 448 in this user guide to make any change in any account (new password, for example) so that the Security manager in WM is properly updated and the restored supersuser account reappears in the Security tree of the user interface. If the root user and all others who are allowed to edit user permissions are deleted or lose those permissions, you will not be able to create another user who has those permissions, except with the assistance of Cambium customer support staff.

449

Issue 3 May 2012

WM Release 4.0 User Guide

Procedure 108: To delete a user 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

Under the Users node in the Security tree, click to highlight the user you want to delete.

Do any of the following: ◦

Select EditDelete.

◦

Press Alt+D.

◦

Right‐click user node on the tree and click Delete.

important ........... If you right-click on a user name when another user name is highlighted, the highlight does not move. If you then select the Delete option, the confirmation pop-up does not identify the user. To ensure that you view the delete the intended user, right-click on only a highlighted user name.

The system prompts for confirmation.

Figure 306: Warning for user deletion

15.2.7

Click Yes.

Using Audit Trails If you have administrative permission in the Security area of WM, then audit trails enable you to view the operations that have been performed by a user. The audit trail identifies all operations that have been performed, the time, whether it was successful, category, and audited object. The most common use of audit trails is to examine the history of device configuration changes. You should periodically clear the trails after having reviewed them. You can

450



view the audit trail details of all the users or a single user.



sort the details by user, operation, time, status, category, and audited object by clicking the appropriate column heading.



search for audit details based on the properties.



clear the audit trails when you no longer need to manage them.

WM Release 4.0 User Guide

Issue 3 May 2012

Viewing Audit Trails Procedure 109: To view audit trails of all users 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

In Security Administration window, perform any of the following steps: ◦

Select ViewAuditTrails.

◦

Press Ctrl+Shift+A.

◦

Click the

AuditTrails button in the toolbar.

The Auth Audit Screen is displayed.

451

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 307: Auth Audit screen

Various operations performed by the users along with the status of whether the operation was a success or failure are displayed. The operation category such as Fault, Topo, Provisioning, Configuration, Authentication, or DEFAULT is also displayed. In the case of an operation that involves any objects, the object detail is displayed. 3.

452

View the audit trails. As needed, refer to the following sections: ◦

Interpreting Audit Entries on Page 453

◦

Searching Audit Trails on Page 454

◦

Viewing Audit Details on Page 455

To sort or reverse‐sort the list by the data in a particular column, click the heading of that column.

WM Release 4.0 User Guide

Issue 3 May 2012

To clear an audit trail, click to highlight the row and click the Clear Audit button.

To resume viewing, click the Show All button.

tip ................ To select a single audit trail, click it. For contiguous audit trails, press and hold Shift key while clicking the rows, and to select non-contiguous audit trails, press and hold the Ctrl key while clicking the rows.

Procedure 110: To view audit trails of a single user 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

Under the Users node in the Security tree, click to highlight the user whose audit trail you want to view.

Right‐click that user name and select Audit Trails from the drop‐down list of options.

important ........... If you right-click on a user name when another user name is highlighted, the highlight does not move. If you then select the Audit Trail option, the system opens displays the audit trail of the user you right-clicked on, not of the highlighted user. To ensure that you view the intended audit trail, either pay special attention to the User Name column when the Auth Audit Screen opens or right-click on only a highlighted user name.

View the audit trails in the Auth Audit Screen. See Figure 307 on Page 452. As needed, refer to the following sections: ◦

Interpreting Audit Entries (the next section)

◦

Searching Audit Trails on Page 454

◦

Viewing Audit Details on Page 455

To sort or reverse‐sort the list by the data in a particular column, click the heading of that column.

To clear an audit trail from the list, click to highlight the row and click the Clear Trails.

To resume viewing, click the Show All button.

Interpreting Audit Entries The Event Logging Extension feature in WM provides a distinctive audit entry every time that a user 

opens a session in the management web interface of a network element.



configures the device.

The audit entries for these events are listed in Table 43.

Table 43: Audit entries for user activity events Event

Audit Entry

Launching management interface

Invoked the web page URL

Adding a configuration template

Created template TemplateName

453

Issue 3 May 2012

WM Release 4.0 User Guide

Event

Audit Entry

Editing a configuration template

Updated template TemplateName

Deleting a configuration template

Deleted template TemplateName

Applying a configuration template

UserName executed TemplateName

Searching Audit Trails 1.

Press Ctrl+S.

Figure 308: Search dialog for audit trails

454

In the left drop‐down menu, select from the following properties the one on which you want the search performed:

In the right drop‐down menu, select from the following conditions the one with which you want the search performed:

In the text box, type in the value.

To slim the search by adding another property, click the More button.

Repeat Steps 2 through 4 for the new property.

To initiate the search, click the Search button.

WM Release 4.0 User Guide

Issue 3 May 2012

note ............. After viewing the audit details based on the Search results, you can view all the details again in the same page by clicking the Show All button in the top right corner of the Auth Audit Screen.

Viewing Audit Details Some audit trails have audit details available. You can access these by 1.

clicking to highlight the row of the audit trail whose details you want to view.

selecting ViewAudit Details from the menu.

When details are available, the AlertAudit window opens to the read‐only values of the properties of the selected audit trail.

Figure 309: AlertAudit window, with properties of an audit trail

15.3

Managing Groups A group is a logical collection of users grouped together to access common information or perform similar tasks. Thus, any administration done for the group is reflected in the individual members (or users) of the group. WM enables you to organize different types of users into groups so they can be classified by a set of common operations. By providing specific permissions to various groups, you can save time when creating new users. Also, the use of groups ensures consistent enforcement of access control policies that govern various classes of users.

455

Issue 3 May 2012

WM Release 4.0 User Guide

caution............... This group provides the permissions to the default "root" user. Do not delete the default "Admin" group or remove user permission editing from the permitted operations for this group unless you have created another group and user with these permissions.

Otherwise, you will not be able to create any new users or edit existing users.

15.3.1

Adding Groups You can add new groups when you want to provide a set of permissions that are different from those provided to an existing group.

Procedure 111: To add a group 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

In Security Administration window, perform any of the following: ◦

Select FileNewAddGroup.

◦

Press Ctrl+Shift+G.

◦

Right‐click the Groups node on the Security tree (located at the left side of Security Administration window) and click AddGroup.

The Groups Wizard opens.

456

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 310: Groups Wizard, Group Description panel

Type the group name and click Next. The Operation Tree is displayed.

Figure 311: Groups Wizard, Operations Tree

457

Issue 3 May 2012

WM Release 4.0 User Guide

This tree provides the expanded list of all functional areas in WM, each of which can be assigned or disallowed for the group. 4.

To collapse a parent node in the tree and hide its child nodes, click the circle to the left of its check box.

Check the check box of all nodes for which you want the group to have permissions. Selecting a parent node automatically selects all of its child nodes. For detailed information about the nodes, see Managing Operations on Page 467.

Click Finish.

note ............. After a delay as WM updates its Security module, the new group is added under the Groups node of the Security tree.

15.3.2

Assigning Users to Groups By assigning users to groups, you can limit access to specific sub‐sets of the WM clients. For example, user access can be limited to specific types of devices. To provide group‐based permissions, users are assigned to specific groups. These groups provide specific permissions and levels of permissions to the assigned users.

Procedure 112: To assign a user to a group 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

In the Security tree, click the group to which you need to assign users.

Click the Members tab.

Click the Setting Users button. The Select Users window is displayed.

Figure 312: Select Users window

458

WM Release 4.0 User Guide

Issue 3 May 2012

In the All Users list, click the user in All Users and click the

Click Ok.

button.

The users assigned to the group are displayed in the Members for list on the Members tab.

15.3.3

Deleting Users from Groups caution............... Do not delete the root user from the Admin group, unless you have first created another user who has the same capabilities.

Procedure 113: To delete a user from a group 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens.

15.3.4

In the Security tree, click the group from which you want to remove users.

Click the Members tab.

Click Setting Users. The Select Users window is displayed.

Click the user to be deleted in Selected Users and click the

Click Ok.

button.

Using Custom View Scopes Setting a custom view scope for a group enables you to filter the objects that are to be displayed and on which a user is permitted to do the respective authorized operations. By specifying the custom view scope criteria, you can ensure that users can view only the data for which they have authorization to perform operations. A custom view scope is as an additional layer of access control, imposed on a short list of major WM features that, without a custom view scope, would show lists or maps of all network elements, events, or alarms (for example) that are known to WM. A custom view scope is to be applied in addition to any other, perhaps more specific, user permissions. The following are the supported custom view scopes: 

Events



Network Database



Alerts



Stats Admin

WM checks custom view scope of a user before executing the following kinds of reports: 

created with user‐specified device selection, such as a device summary report on a selected device or a system report that filters devices and runs as a scheduled task.



created with system‐selected devices, such as a configuration summary report or other system report that runs on demand.

459

Issue 3 May 2012

WM Release 4.0 User Guide

These reports are described under 

Viewing a Device Summary Report on Page 223



Using Configuration Summary Reports on Page 339



Using System Reports on Page 388



Scheduling a One‐Time or Periodic Task on Page 647

Adding a Custom View Scope You can add an authorized custom view scope to a group to ensure the members of the group can view only the certain data.

Procedure 114: To add a custom view scope 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens.

460

In the Security tree, click to highlight the group to whom you want to assign a custom view scope.

Click the Custom View Scope for Group tab.

From the Custom View Scope Name drop‐down menu, select the scope.

Click the Add AuthorizedScope button. The Scope Settings dialog opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 313: Scope Settings dialog

In the upper Name field, type in a unique Authorized Scope Name.

For the Name field associated with Value, select a property name from among the following drop‐down menu choices:

note ............. These are specific to each of the Custom View Scope. For instance, selecting the Events Custom View Scope and clicking Scope Settings, provides you with the property names of Event Objects. note ............. The recommended way to limit the scope to a subnet is to select network in the Name field and type in a Value that is identical to what was entered in the Network Discovery tab of the Discovery Configurator. See Figure 283: Discovery Configurator, Network Discovery tab on Page 415. note ............. To set a network for a Network Database scope, do not select parentNetwork as the property name and set the associated value to x.x.x.0. Instead, select ipAddress as the property name and set the associated value x.x.x.*.

In the Value field, enter the value for the property. To identify more than one property value, separate each value according to the appropriate operator in the following value operators table.

461

Issue 3 May 2012

WM Release 4.0 User Guide

Table 44: Authorized Custom View Scopes value operators Value Operator

Description Use an asterisk to filter on a match of zero or more characters.

* (Asterisks)

Example: To view all objects starting with the name test, set the property key as name and the value as test*. Use an exclamation mark to filter the search using the NOT operator.

! (Exclamation Mark)

Example: To view all objects whose names do not start with test, set the property key as name and value as !test*. Use a comma to filter objects where a single property key has different values.

, (Comma)

Example: To view all objects with names starting with abc or xyz, set the property key as name and the value as abc*,xyz*. Use an ampersand to filter objects where a single value should be matched with many patterns.

&& (Ampersand)

Example: To view all objects with names starting with abc and ending with xyz, set the property key as name and value as abc*&&*xyz. Use a back slash to filter objects when the name of the object itself contains a comma. This character is called an escape sequence because it avoids searching for objects, as if they had two different names.

\ (Back Slash)

Example: To view an object with name a,b, set the property key as name and the value as a\,b. Use a greater than and less than signs to filter objects with numeric values within a specific range. <between> value1 and value2

Example: If object names with a poll interval value ranging between or including 300 and 305 are required, set the property key as pollinterval and the value as <300 and 305>. Note that the first number is smaller than the second number. Only the values in between the given values, including the limits, are matched.

Click the Add button. This adds the Authorized Scope for the selected Custom View Scope of the group. You can add more than one property criteria based on your requirements.

10. Click Ok to store the custom view scope for future use.

462

WM Release 4.0 User Guide

Issue 3 May 2012

Assigning an Authorized Scope for CV After you have created an authorized Custom View Scope for a group, you can assign an authorized scope in it to other groups as necessary.

Procedure 115: To assign an authorized custom view scope 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

In the Security tree, click to highlight the group to which you want to assign the custom view scope.

Click the Custom View Scope for Group tab.

note ............. The group must have permissions in the operations area in which the custom view scope was created. You can check whether it does by clicking on the Permitted Operations for Group tab. For example, if you want to assign an authorized scope for groupname2 for which the custom view scope was created in the Alerts operation area, then Alerts should be listed in that tab:

Click the Assign AuthorizedScope button. The Select AuthorizedScopes window is displayed.

463

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 314: Select AuthorizedScopes window

In the All Authorized Scopes list, click to highlight the scope that you want to assign.

Click the button. The scope is listed in both the All AuthorizedScopes list and the Selected AuthorizedScopes list.

important ........... If this group has not been assigned permissions in the specific operations area of the target authorized scope, then the scope is not copied to the Selected AuthorizedScopes list, and the custom view scope is not applied to the group. When this is the case, use Procedure 120 on Page 482 to assign the operation to the group, then repeat this present procedure.

Click Ok.

Removing a Custom View Scope from a Group You can remove an authorized Custom View Scope from a group when it is no longer valid for that group. By removing the Custom View Scope, the properties are not changed and the Custom View Scope is not deleted from the database.

Procedure 116: To remove an authorized custom view scope 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens.

464

In the Security tree, click the group for whom you want to remove the custom view scope.

Click Custom View Scope for Group tab.

Click the Assign AuthorizedScope button. The Select AuthorizedScopes window opens. See Figure 314 on Page 464.

In the Selected AuthorizedScopes list, click to highlight the scope that you want to remove.

Click the button. Now the scope is listed in only the All AuthorizedScopes list.

Click Ok.

WM Release 4.0 User Guide

Issue 3 May 2012

Changing Custom View Scope Properties After you have added properties to an authorized Custom View Scope, you can make changes as appropriate. note ............. If you have assigned the authorized Custom View Scope to other groups, any changes to the Custom View Scope will affect those groups as well.

Procedure 117: To change the properties of an authorized scope 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

In the Security tree, click to highlight any group to whom the target authorized scope is currently assigned.

Click the Custom View Scope for Group tab.

In the AuthorizedScopes for CV list, click to highlight the Authorized Scope to be modified.

Figure 315: AuthorizedScopes for CV panel

Click the Set Scope Properties button. The Scope Settings dialog opens.

note ............. You can add a new property/value combination, remove a property, or click to highlight a property and then click the Edit button to modify its value. In this last case, the value disappears from the Value text box when you click the Edit button. If you want to restore the value but you do not remember its exact syntax, you can read it from table above the Name/Value configuration section of the dialog window.

Click Ok.

Deleting a Custom View Scope When an authorized custom view scope is no longer valid, you can delete it from the database. After this action, you must recreate it if you ever need it again.

Procedure 118: To delete an authorized custom view scope 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

In the Security tree, click to highlight any group to whom the target authorized scope is currently assigned.

Click the Custom View Scope for Group tab.

465

Issue 3 May 2012

WM Release 4.0 User Guide

Click to highlight the authorized scope that you want to delete.

Right‐click the Authorized Scope to be deleted from AuthorizedScopes for CV list and click Delete AuthorizedView.

The system prompts for confirmation.

Figure 316: Warning for authorized scope deletion

15.3.5

To confirm that you want to delete it, click Yes. The authorized scope is deleted from the database and from any group to which it was assigned.

Deleting a Group Procedure 119: To delete a group 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

From the Security tree, click to highlight the group that you want to delete.

Do any of the following: ◦

Select EditDelete.

◦

Press Alt+D.

◦

Right‐click the group on the tree and click Delete.

The system prompts for confirmation.

Figure 317: Warning for group deletion

466

WM Release 4.0 User Guide

Issue 3 May 2012

caution............... If you right-click on a group when another group is highlighted, the highlight does not move and the Delete option pops up. However, neither the Delete popup nor the Warning pop-up refer to the group by name. If you use the right-click access to the Delete option, use it on only a highlighted group.

15.4

To confirm the deletion, click Yes. The group is removed from the database.

Managing Operations The Operation Tree contains a list of operations (also referred to as permissions) that WM provides by default. The operations are logically arranged in a tree structure with parent and child operations. You can add new operations when you need them and delete obsolete operations. Permission to use operations can be granted, denied, or unspecified. A typical use of unspecified permissions is to allow inherited permissions to take precedence. Another typical use of unspecified permissions is to set up an arrangement of groups, each of which specifies permissions for a particular subsystem but leaves the permissions for other subsystems to be specified by other groups, where each user is part of multiple groups.

467

Issue 3 May 2012

15.4.1

WM Release 4.0 User Guide

Default Operations Assigning different operations to different users is an administrative function. The following nodes are present in the Operation Tree. This tree is presented in the wizard when a group is being configured.

Figure 318: Operation Tree nodes showing default user permissions

In the Permissions tree hierarchy, each major node has an associated circle. A click on the circle collapses all of the contents of the node. A check mark specifies Allowed. An X specifies Not allowed. A check in the check box of any parent node automatically checks the check boxes of all of the child nodes of that parent node. However, the checks of the child nodes are individually undoable.

468

WM Release 4.0 User Guide

Issue 3 May 2012

This is for efficiency. For example, if you want to give a group all permissions under Alert User Operations except Clear Alerts, you can 1. check the checkbox of Alert User Operations.

2. click in the check box for Clear Alerts to disallow it.

The following sections provide details about the nodes of the Operation Tree.

15.4.2

Configuration

Table 45: Configuration options Operation

Description

Upload AAA Certificate

Disabling this operation prevents the user from uploading a AAA certificate for a PMP 320 CPE device.

Execute Task

Disabling this operation prevents the user from executing tasks.

Create Task

Disabling this operation prevents the user from creating new tasks.

Audit

Disabling this operation prevents the user from using the Audit node of the Applications tree.

Install Software Upgrades

Disabling this operation prevents the user from launching the software upgrade tool interface.

469

Issue 3 May 2012

WM Release 4.0 User Guide

15.4.3

Events

Table 46: Events options Operation

Description

Print Event View

Disabling this operation prevents the user from printing the list of events.

Save Events To File

Disabling this operation prevents the user from saving the events in file.

Get Event Parsers

Disabling this operation prevents the user from viewing the existing event parsers in Wireless Manager server.

Set Event Filters

Disabling this operation prevents the user from modifying or adding a new event filter.

Get Event Filters

Disabling this operation prevents the user from viewing the existing event filters in Wireless Manager server.

Set Event Parsers

Disabling this operation prevents the user from modifying or adding a new event parser.

Event User Operations

Event Filters and Parsers

15.4.4

Policy

Table 47: Policy options Operation

470

Description

Update Policy

Disabling this operation prevents the user from updating an existing policy.

Add Policy

Disabling this operation prevents the user from adding a new policy.

Delete Policy

Disabling this operation prevents the user from deleting an existing policy.

WM Release 4.0 User Guide

Issue 3 May 2012

Operation

Description

Execute Policy

Disabling this operation prevents the user from executing any policy.

Schedule Policy

Disabling this operation prevents the user from modifying the schedule of a any policy.

15.4.5

Poll Filters

Table 48: Poll Filters options Operation

Description

Get Poll Filters

Disabling this operation prevents the user from viewing the existing poll filters in Runtime Administration interface.

Update Poll Filters

Disabling this operation prevents the user from updating existing poll filters using Runtime Administration interface.

Reload Poll Filters

Disabling this operation prevents the user from reloading the poll filters using Runtime Administration interface.

15.4.6

Polling Object

Table 49: Polling Object options Operation

Description

Get Polling Objects

Disabling this operation prevents the user from viewing the existing polling objects.

Change Polling Object Status

Disabling this operation prevents the user from changing the status of a polling object.

Delete Polling Object

Disabling this operation prevents the user from deleting polling objects.

Modify Polling Object

Disabling this operation prevents the user from modifying existing polling objects.

471

Issue 3 May 2012

WM Release 4.0 User Guide

Operation Add Polling Object

15.4.7

Description Disabling this operation prevents the user from adding new polling objects.

Polling Units

Table 50: Polling Units options Operation

Description

Add Polling Units

Disabling this operation prevents the user from adding polling units or statistics.

Remove Polling Units

Disabling this operation prevents the user from removing an existing polling unit or statistic.

Get Polling Unit

Disabling this operation prevents the user from viewing the details of the polling unit or statistic.

Modify Polling Units

Disabling this operation prevents the user from modifying an existing polling unit or statistic.

15.4.8

Provisioning

Table 51: Provisioning options Operation View TemplateResult

472

Description Disabling this operation prevents the user from viewing the results of a provisioning operation in the ActivityList view.

WM Release 4.0 User Guide

15.4.9

Issue 3 May 2012

Administrative Operation Services

Table 52: Administrative Operation, Services options Operation

Description

Resume NMS

This operation is performed to resume all Wireless Manager schedulers if the backup process has some errors.

Start Backup

Clear Discovery

This operation is to start the Wireless Manager backup process. This operation suspends all the Wireless Manager schedulers. Disabling this operation prevents the user from starting the backup process. The discovery process may be stopped due to some unforeseen problems. The Clear Discovery operation is used to resume the discovery process. Disabling this option prevents the user from resuming the discovery process from the Web Client.

473

Issue 3 May 2012

WM Release 4.0 User Guide

Security Administration Security Administration provides the following security‐related operations that can be configured. You can provide permission for users only for certain security operations and restrict the others. For instance, you can provide permission for a user to create a new group but he might not have the option to delete the same. caution............... it is important to always have at least one user, either direct or through groups, who has all security administration permissions. Otherwise, no one can change the permissions of another user, and the permissions structure will be frozen as it exists.

474

WM Release 4.0 User Guide

Issue 3 May 2012

Table 53: Administrative Operation, Security options Operation

Description

Clear Audit Trails

Disabling this operation prevents the user from clearing audit trails in the client.

Set User Profile

Disabling this operation prevents the user from setting profiles for existing users.

Set User Permission

Disabling this operation prevents the user from setting operations or permissions for existing users.

Get List Of Users

Disabling this operation prevents the user from viewing the list of users added. This applies to only the web client (the link to access the list if disabled).

Change Password User Administration Remove User From Group

Disabling this operation prevents the user from removing a user from a group.

Remove Users

Disabling this operation prevents the user from removing a user.

Assign User To Group

Disabling this operation prevents the user from assigning a user to a group.

Add Users

Disabling this operation prevents the user from adding new users.

User Configuration

Disabling this operation prevents the user from accessing User Configuration link in Web Client.

Modify Group Scope Relation

Disabling this operation prevents the user from assigning a scope to a group in the Custom View Scope for Group UI.

Create Scope For Group

Disabling this operation prevents the user from adding a new scope or setting the properties of a scope.

Add Group

Disabling this operation prevents the user from adding a new group.

Remove Group

Disabling this operation prevents the user from removing a group.

Set Group Permission

Disabling this operation prevents the user from setting permissions or operations to groups.

Scope Settings

Group Operations

Disabling this operation prevents the user from changing the password of a user.

475

Issue 3 May 2012

WM Release 4.0 User Guide

Operation

Description

Remove Operation

Disabling this operation prevents the user from removing existing operations from the Operations tree.

Add Operation

Disabling this operation prevents the user from creating new operations in the Operations UI.

Operation Settings

Other Administrative Operations

Table 54: Other Administrative Operations options Operation

476

Description

Template Configuration

Disabling this operation prevents the user from executing any of the ConfigurationConfiguration Templates options for any device.

Add Relationship

Disabling this operation prevents the user from launching the Add Relationship utility for any device.

Polling Configuration

Disabling this operation prevents the user from launching the ToolsPolling Configuration interface.

Log Settings

Disabling this operation prevents the user from launching the HelpLog Settings interface.

Configure and Receive License Notification

Disabling this operation prevents the user from launching the ToolsLicense Notifications interface.

Runtime Administration

Disabling this operation prevents the user from working in the Discovery Configurator.

Configure Log Levels

Disabling this operation prevents the user from configuring the log levels (applies to only the web client).

Shutdown Web NMS Server

Disabling this operation prevents the user from shutting down the Wireless Manager server.

Broadcast Message

Disabling this operation prevents the user from launching the FileBroadcast Message interface.

WM Release 4.0 User Guide

15.4.10

Issue 3 May 2012

Reports Configuration Reports

Table 55: Configuration Reports options Operation

Description

Execute Configuration Report

Disabling this operation prevents the user running a defined configuration report.

Create or Modify Configuration Report Template

Disabling this operation prevents the user from adding any new configuration report template and from changing any that already exists.

Delete Configuration Report Template

Disabling this operation prevents the user from removing a defined configuration report template.

System Reports

You can only categorically authorize or deny the permission to execute reports of these categories.

15.4.11

Threshold Object

Table 56: Threshold Object options Operation

Description

Get Threshold Object

Disabling this operation prevents the user from invoking the Thresholds and Associations dialog in the client, hence disables all of the above operations for the user.

Delete Threshold Object

Disabling this operation prevents the user from removing threshold objects.

477

Issue 3 May 2012

WM Release 4.0 User Guide

Operation

Description

Modify Threshold Object

Disabling this operation prevents the user from modifying existing threshold objects.

Add Threshold Object

Disabling this operation prevents the user from adding new threshold objects.

15.4.12

Topology

Table 57: Topology options Operation

Modify Object

Description

Manage And Unmanage Objects

Disabling this operation prevents the user from managing or unmanaging an object or a network element.

Start And Stop Discovery

Disabling this operation prevents the user from starting or stopping the discovery process of Wireless Manager server.

Export Topology Data

Disabling this operation prevents the user from executing the ActionsExport Topology Data command option from the main menu.

View NE Dashboard

Disabling this operation prevents the user from launching the dashboard for any managed device.

Refresh Node

Disabling this operation prevents the user from refreshing a node.

Delete Object

Disabling this operation prevents the user from deleting an object or a network element.

Add Node

Disabling this operation prevents the user from adding a new node in the network manually.

Add Network

Disabling this operation prevents the user from adding a new network manually.

478

WM Release 4.0 User Guide

15.4.13

Issue 3 May 2012

Trap Parsers and Filters

Table 58: Trap Parsers and Filters options Operation

Description

Get Trap Filters

Disabling this operation prevents the user from viewing the existing trap filters.

Set Trap Filters

Disabling this operation prevents the user from setting new trap filters.

Reload Trap Filters

Disabling this operation prevents the user from reloading the trap filters.

Set Trap Parsers

Disabling this operation prevents the user from setting new trap parsers.

Get Trap Parsers

Disabling this operation prevents the user from viewing the existing trap parsers.

15.4.14

Alerts

479

Issue 3 May 2012

WM Release 4.0 User Guide

Table 59: Alerts options Operation

Description

Alert Pickup

Disabling this operation prevents the user from picking up an alarm.

Get Alert Details

Disabling this operation prevents the user from viewing the details of an alarm.

Set Alert Annotation

Disabling this operation prevents the user from annotating an alarm.

Save Alerts To File

Disabling this operation prevents the user from saving the list of alarms in a file.

Get Alert History

Disabling this operation prevents the user from viewing the history of an alarm.

Get Alert Annotation

Disabling this operation prevents the user from viewing the annotation of an alarm.

Clear Alerts

Disabling this operation prevents the user from clearing the alarms.

Print Alert View

Disabling this operation prevents the user from printing the alarms.

Set Alert Filters

Disabling this operation prevents the user from setting new alert filters.

Get Alert Filters

Disabling this operation prevents the user from viewing existing alert filters.

Alert User Operations

Alert Filters

Delete Alerts

480

Disabling this operation prevents the user from deleting an alarm.

WM Release 4.0 User Guide

15.4.15

Issue 3 May 2012

Task Scheduler Operation

Table 60: Task Scheduler Operation options Operation

Description

Create Schedule Task

Disabling this operation prevents the user from creating any task in the task scheduler utility.

View tasks of others

Disabling this operation prevents the user from viewing tasks other than their own.

Create User Script Task

Disabling this operation prevents the user from creating a user script task in the task scheduler utility.

15.4.16

Device Tools

Table 61: Device Tools options Operation

Description

Credential Manager

Disabling this operation prevents the user from the capability of setting the SNMP read and write community strings or the telnet/FTP IDs and passwords of selected devices.

Spectrum Analyzer

Disabling this operation prevents the user from launching the Spectrum Analyzer tool for PMP 320 AP or PMP SM or BHS devices.

Link Capacity Test

Disabling this operation prevents the user from launching the Link Capacity Test tool for PMP AP, SM, BHM, or BHS devices.

15.4.17

Ultralight Client Support Disabling this operation prevents the user from authenticating into Wireless Manager Ultralight via their WM login/password combination.

481

Issue 3 May 2012

15.5

WM Release 4.0 User Guide

Assigning Operations You can assign operations (include or exclude permissions) for a group or for a particular user. Assigning operations for a group automatically sets the same permissions for the users in that group.

15.5.1

Assigning Permitted Operations for a Group Typically, you would assign the permitted operations for a group at the time when you create the group, but the following procedure is helpful for modifying the permissions of an existing group.

Procedure 120: To assign operations for a group 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

Under the Groups node in the Security tree, click to highlight the group to which you want to assign operations.

Click the Permitted Operations for Group tab. All operations included or excluded for that group are displayed in the Operations For Group list.

Figure 319: Operations For Group panel

482

WM Release 4.0 User Guide

Issue 3 May 2012

Click the Set Permissions button. The Assign Permissions window opens and shows the current configuration of assigned permissions for the group.

Figure 320: Assign Permissions dialog

To grant the desired permissions, complete the following steps: ◦

Check the check box of any permission that you want to include for the group.

◦

Leave the check box unchecked for any permission for which you want the include/exclude to be inherited from its parent node.

◦

Check the check box twice for any permission that you want expressly excluded for the group. This results in .

To cancel the changes before closing the window, click Reset.

To apply the changes, click Done.

483

Issue 3 May 2012

15.5.2

WM Release 4.0 User Guide

Assigning Permitted Operations for a User Typically, you would assign a user to be a member of a group that has defined permissions. However, you can use the following procedure to provide a unique set of permissions to an individual user.

Procedure 121: To assign permitted operations for a user 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window is displayed.

15.6

Under the Users node in the Security tree, click the user for whom you want to assign operations.

Click the Permitted Operations for User tab. All operations included or excluded for that user are displayed in the Permissions For User list.

Click the Set Permissions button. The Assign Permissions window is displayed and shows the current configuration of permissions for the user.

To grant the desired permissions, complete the following steps: ◦

Check the check box of any permission that you want to include for the group.

◦

Leave the check box unchecked for any permission for which you want the include/exclude to be inherited from its parent node.

◦

Check the check box twice for any permission that you want expressly excluded for the group. This results in .

To cancel the changes before closing the window, click Reset.

To apply the changes, click Done.

Adding Operations You can add new operations. For example, as new sub‐applications are added, you might find that the current operations are not adequate for your needs. In this case, you can add operations that apply to the new sub‐application. Typically, it is not useful for users to add new operations. This is because, for an operation and its permissions to have any effect, some feature implemented in the system must check those permissions. Creating a new operation and assigning permissions for it does not implement any associated feature in the system. Only the pre‐existing operations are connected to existing implementations. For an operator‐added operation to be useful, the operator would need to first

484



extend WM to use an operator‐developed feature.



include a check for a new operation in the implementation of that feature.



add a new operation to the security administration subsystem.

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 122: To add an operation 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window is displayed. 2.

In the Security Administration window, perform one of the following steps: ◦

Select FileNewAddOperations.

◦

Press Ctrl+Shift+O.

◦

Click the

AddOperation button.

The Operations dialog is displayed.

Figure 321: Operations dialog

Click to highlight the parent operation under which you want to add the new operation. For example, Events:

485

Issue 3 May 2012

15.7

WM Release 4.0 User Guide

In the text box below the tree, type a name for the operation. For example, Event Scripts.

Click the Add button. The operation is added to the tree under the selected parent node.

Repeat Steps 3 through 5 to add more operations.

Click Ok.

Deleting Operations Do not delete any of the default operations that are installed with WM. If you do, it will be impossible to grant permissions to those operations, and the corresponding WM features will be unusable.

Procedure 123: To delete an operation 1.

Do either of the following: ◦

Select ToolsAdministrationSecurity Administration.

◦

Press Alt+S.

The Security Administration window opens. 2.

In the Security Administration window, perform one of the following steps: ◦

Select FileNewAddOperations.

◦

Press Ctrl+Shift+O.

◦

Click the

AddOperation button.

The Operations window opens.

Click to highlight the operation you want to delete.

Click the Remove button. The system prompts for confirmation.

486

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 322: Warning for operation deletion

To confirm the deletion, click Yes.

487

WM Release 4.0 User Guide

Issue 3 May 2012

16 Administering Fault Management Fault Management involves the detection and representation of error conditions that cause loss of functionality of network resources and it also provides event management, including 

alert generation



automated actions



event correlation



filtering for traps, events, and alerts



parsing for traps and events

These features enable network operators to detect, isolate, and repair malfunctions in the network and in its control subsystem. note ............. WM is also capable of interfacing with other management systems, and faults can exchanged between another management system and WM, so that individual faults detected by one system can be viewed in the other.

16.1

Administering Trap Parsers Traps are cryptic messages sent by SNMP devices to the management system. A trap must be represented in a human‐readable administrative message that completely explains the problem that triggered the trap. Since every piece of information available in the fault report can be accessed, it is possible to create the messages that are required for informed management. When a trap is received, trap parsers generate useful and appropriate event information. In the overall event flow, a received trap is passed through a level of trap parsers only if either 

the trap has not been converted into an event object by a trap filter.



the received trap has not been dropped during trap filtering.

The output of a trap parser is an event object. WM is pre‐configured with trap parsers for all significant traps sent by all supported devices. Under normal circumstances, it is unnecessary for a user to configure, add, delete, or modify a trap parser. Trap Parsers automatically load when the server is restarted and are listed in the Configured Trap Parser list. The incoming traps are processed through the list of configured Trap Parsers. The order of this list can be changed as needed. The match criteria in the parser determine whether a specific trap matches the Trap Parser. The search for matching Trap Parsers is done based on how the Trap Parsers are ordered in the list. Once a matching Trap Parser is found, an event is generated by applying the corresponding Trap Parser. Only one Trap Parser is applied to a given trap and no other Trap Parsers are applied to that trap.

489

Issue 3 May 2012

16.1.1

WM Release 4.0 User Guide

Opening the Trap Parser Configuration Tool Trap Parsers can be created or modified using the Trap Parser Configuration tool.

Procedure 124: To open the Trap Parser Configuration tool 1.

In the Applications tree, select Fault ManagementNetwork Events.

Select ActionsTrap Parsers (or press Ctrl+Shift+R). The Trap Parser Configuration dialog opens.

Figure 323: Trap Parser Configuration tool

490

WM Release 4.0 User Guide

16.1.2

Issue 3 May 2012

Adding a Trap Parser Procedure 125: To add a Trap Parser 1.

In the Trap Parser Configuration window (Figure 323 on Page 490), click the Add Trap Parser button. All the fields in the dialog box are enabled.

note.............. Unless you have deleted all of the many trap parsers that are automatically installed with WM (which is strongly discouraged), there will be trap parsers visible in the list.

Figure 324: Trap Parser Configuration window, Add Trap Parser operation

note ............. The first block of fields is SNMP version specific.

491

Issue 3 May 2012

WM Release 4.0 User Guide

If the device type you are composing this trap parser for supports SNMP v1, click the Click here to configure for V1 button. The block of fields changes to the following:

Enter a new name for your new parser in the Name field.

Enter values for the Trap Input Parameters. This involves naming the parser, giving it fields to match against incoming traps, and then setting up an event to generate when a match occurs.

The following table explains each of the fields in the Trap Parser Configuration tool.

Table 62: Trap Parser Configuration fields Field

Description Identifies the port number to which to listen for traps. The trap port is the port at which the Wireless Manager server listens for SNMP notifications. The specified Port(s) is not associated with a particular Trap Parser, but a general configuration. When no port has been specified, traps will not be received at all.

Trap Port

Multiple ports can be specified using a comma separator, for example – 8001,8002 The default configuration for Trap Port (listed in the Trap Port field) will be the port(s) specified in the trapport.conf file under the /usr/local/cambium/wm/server/conf directory in Linux (or the C:\Cambium\WM\server\conf folder in Windows). Ensure that the specified ports are free.

Name

Name to identify the parser.

Match Criteria

Determines the traps that are parsed by the Trap Parser to generate an event. Match criteria based on the source of the received trap matching one of the specified nodes listed in the field. This is an optional match criterion.

Nodes

For an SNMPv1 trap, the agent address returned by the trap is used when matching the property value. For SNMPv2c, the source address returned by the trap is used when matching the property value. Use the comma separator to specify more than one node. Example: printer2,printer4 You can use Wildcard (*) and Negation (!) characters in this field.

492

WM Release 4.0 User Guide

Issue 3 May 2012

Field

Description Match criteria based on the source of the received trap that belongs to one of the groups specified. (Wireless Manager provides a way to group a set of MOs based on some of their characteristics.)

Groups

This is an optional match criterion. Use the comma separator to specify more than one group. Example: groupX,groupY Do not use Negation (!) or Wildcard (*) characters in this field Associated with the SNMP V1 button only. Specify the enterprise object ID (OID) of the SNMPv1 trap. When specified, the parser is applied only if the incoming trap's enterprise OID starts with what is specified in this field.

Enterprise

If the enterprise OID is specified as .1.3.6.1.2.1.11, all the OIDs under this tree are matched for traps. To avoid this kind of matching, enter the enterprise OID value in angular brackets, such as <.1.3.6.1.2.1.11> If the value is given as “*”, then all the OIDs are matched. Associated with the SNMP V1 button only.

Generic Type

Each SNMPv1 trap has a generic type number which can be specified as a match criterion. When specified, the Trap Parser is applied only if the incoming traps match the specified generic type number. Associated with the SNMP V1 button only.

Specific Type

Each SNMPv1 trap has a specific type number which can be specified as a match criterion. When specified, the Trap Parser is applied only if the incoming traps match the specific type number. note………… this specific type is a trap attribute, and is not related to the specific type of a managed object (device).

This field is available only when you click the Click here to configure for V2C & V3 button. An SNMP V2C or SNMP V3 trap is uniquely identified by Trap OID that is associated with the Trap Protocol Data Unit (PDU). This trap OID can be specified as a match criterion. Trap OID

The Trap Parser is applied only if the incoming trap has a value that starts with the OID specified in this field. When a trap OID is specified, all traps that start this OID are matched and the Trap Parser is applied. If you want to match the exact OID, specify the trap OID within angular brackets <>. Wildcard – Asterisk (*) character can be used. Indicates the state of the event that determines the severity shown in the Event Viewer.

Severity

This severity determines how an alarm is affected by this event. For a given failure object, the severity specified for the event correlates with the severity of the corresponding alarm.

Message

Corresponds to the text field of the event object. The value specified here is entered in the text field of the event object created by this Trap parser.

Failure Object

Appropriate processing by the Trap parser ensures that the failure object reflects the exact problem. This is used to quickly track problems and identify the objects instead of simply reporting raw events.

Domain

Use to specify the domain name of an event. This field is optional.

Category

Use to categorize events and alarms.

Network

Identifies the network name from which the event has occurred. This field is optional.

493

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description

Node

The node value of the event. This field is optional.

Source

Identifies the source name of an event. If the status of the MO is updated with the severity of the event, then the source should match the name of the MO, which should be updated. Identification of the source is the only way in which the status of the MO can be updated in the Wireless Manager server.

Group Name

Enables you to group meaningful events.

Help URL

The URL, absolute or relative to the /usr/local/cambium/wm/server directory in Linux (or the C:\Cambium\WM\server folder in Windows) that can be configured to provide detailed help for a given event. 5.

While specifying the output values for the event object that is generated in the fields, you can use information in the incoming trap Protocol Data Unit (PDU) information. This allows you to effectively copy information from the trap into an event generated in response to the trap. You can access the information in the trap PDU by using the special tokens that each represent the value of a field in the trap.

important ........... To specify Trap PDU information for Trap Parser fields, use the dollar ($) notation. For Event Parsers and Event Filters, use percentage (%) notation instead of dollar ($). The @ notation remains the same for all the three configurations.

Table 63: Trap Protocol Data Unit fields Field

Description SNMP V1 Traps If the device corresponding to the agent address returned by the trap has been discovered by Wireless Manager, this token fetches the name of the parent managed object (MO) corresponding to the interface object matching the agent address of the trap received. If the device corresponding to the agent address of the trap has not been discovered, this token returns the corresponding IP address of the agent address from which the trap has been received.

$Agent

For example, a trap is received from an agent and the corresponding device has been discovered by Wireless Manager with the interface object of 'IF‐webserver' and the name of the parent managed object is 'webserver'. In this scenario, %Agent returns webserver. If the device is not yet discovered, %Agent returns the IP address, such as 192.168.1.30. SNMP V2C & V3 Traps If the device corresponding to the source address contained by the received trap has already been discovered by Wireless Manager, this token fetches the name of the parent MO that corresponds to the interface object matching the source address of the received trap. If the device corresponding to the source address of the trap has not been discovered, this token returns the IP address of the source of the trap.

$Community

494

This token is replaced by the community string of the received trap.

WM Release 4.0 User Guide

Field

Issue 3 May 2012 Description

$Enterprise

This token is replaced by the enterprise ID of the received trap. This token is applicable to SNMP traps only, for non‐SNMP traps it is replaced with ““.

$GenericType

This token is replaced by the generic type of the received trap. This token is applicable to SNMP V1 traps only. For non‐SNMP traps, it is replaced with ““.

$Source

If the device corresponding to the source address contained by the received trap has been discovered by Wireless Manager, this token fetches the name of the parent MO that corresponds to the interface object matching the source address of the received trap. If the device corresponding to the source address of the received trap has not been discovered, the corresponding IP address of the source address is returned.

$SpecificType

This token is replaced by the specific type of the received trap and is applicable to SNMP v1 traps only. For non‐SNMP traps, it is replaced with ““.

$Uptime

This token is replaced by the up‐time value in the received trap.

$TrapOID

This token is replaced by the trap OID of the received trap. This token is applicable to SNMP V2C traps only. For non‐SNMP traps, it is replaced with ““.

This token is replaced by all the variable bindings (both OID and variable values) of the received trap. Example: For the following varbinds, 2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10The result is ifIndex: 30, sysDescr: abc, ifIndex: 10 This token is replaced by all the variable binding values (only variable values and not OIDs) of the received trap.

Example: For the following varbinds,2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10 The result is 30, abc, 10 For this token, N is a non‐negative integer. This token is replaced by the (N+1)th SNMP variable value in the variable bindings of the received trap. The Index N starts from 0.

Example: For the following varbinds, 2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10 For %1, the result is abc This token is replaced by all the OID labels in the variable bindings of the received trap.

Example: For the following varbinds,2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10 The result is ifIndex: sysDescr: ifIndex

This token is replaced by the (N+1)th OID value in the variable bindings of the received trap. The index count starts from 0.This token is replaced by the (N+1)th OID label in the variable bindings of the received trap. The index starts from 0. Example: For the following varbinds,2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10 For @1, the result is sysDescr

495

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description

$IP‐Source

This token is replaced by the IP address corresponding to the source address of the received trap.

$IP‐Agent

This token is replaced by the IP address corresponding to the agent address of the received trap.

Special Purpose Tokens

The associated Managed object should have been discovered already by WM for using the following special purpose tags (or tokens). This is applicable to all special purpose tags (or tokens) enumerated in this section. This token enables access to managed object properties. The tag can be used to access any properties of the parent managed object for the interface object corresponding to the agent address of the received trap. (Fetching the MO is similar to the $Agent tag mechanism). For example, if you want to access the pollInterval property of the parent MO that corresponds to the agent address of the received trap and assign it to some property of the generated Event object, you must specify the tag as $AgentMO(pollInterval) against the specific property of the event.

$AgentMO

Usage: $AgentMO(PropertyName) This token is similar to $AgentMO, except that the properties of the interface MO that corresponds to the agent address of the received trap can be accessed using this tag. In the case of SNMP V2C traps, it is exactly the same as $IF‐SourceMO.

$IF‐AgentMO

Usage: $IF‐AgentMO(PropertyName) This token is similar to $Agent, except that it results in the interface MO name that corresponds to the agent address of the trap received. In the case of SNMP V2C traps, it is exactly the same as $IF‐Source.

$IF‐Agent

Usage: $IF‐Agent This token can be used to access any properties of the parent MO for the interface object that corresponds to the source address of the received trap. (Fetching the MO is similar to the $Source tag). For example, if you want to access the pollInterval property of the parent managed object corresponding to the source address of the received trap and assign it to some property of the event, you must specify the tag as $SourceMO(pollInterval) against the specific property of the event.

$SourceMO

Usage: $SourceMO(PropertyName)

$IF‐SourceMO

This token is similar to $SourceMO, except that the properties of the interface MO that corresponds to the source address of the received trap can be accessed using this tag. Usage: $IF‐SourceMO(PropertyName) This token is similar to $Source, except that it results in the interface object name that corresponds to the source address of the received trap.

$IF‐Source

Usage: $IF‐Source

496

To specify your own properties to the event object generated by the Trap Parser, click the More button. The Trap Parser Configuration dialog opens.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 325: Trap Parser Configuration dialog, Event User Properties

Enter the name and the value of the property in Property Name and Match Criteria fields, respectively.

To enter more properties, click the More button.

When you are finished adding values and properties, click the OK button.

10. In the Trap Parser Configuration window, click the Update button. The newly configured Trap Parser is added to the Configured Trap Parser List. 11. To apply this configuration to the server, click the Apply To Server button.

16.1.3

Reordering the Configured Trap Parser List WM processes incoming traps through the list of configured Trap Parsers and applies only one to a trap, based on the order of the Configured Trap Parser List. important ........... Changes to the default trap parser order may result in undesirable system behavior.

Procedure 126: To reorder the Configured Trap Parser List

16.1.4

In the Trap Parser Configuration window (Figure 323 on Page 490), click and drag the parser from the Configured Trap Parser List to a new location in the list.

To save this configuration in the server, click Apply To Server.

Viewing Trap Parser Details Procedure 127: To view details of a Trap Parser 1.

In the Configured Trap Parser List of the Trap Parser Configuration window (see Figure 323 on Page 490), click on the trap parser you want to view. The Trap Parser details are listed in the fields.

When you are finished viewing the parser details, click the Close button.

497

Issue 3 May 2012

16.1.5

WM Release 4.0 User Guide

Modifying Trap Parsers important ........... Changes to the default trap parsers may result in undesirable system behavior.

Procedure 128: To modify a Trap Parser 1.

In the Applications tree, select Fault ManagementNetwork Events.

From the main menu, select ActionsTrap Parsers. The Parser Configuration dialog opens.

In the Configured Trap Parser List, click on the Trap Parser you want to modify.

Click the Modify Trap Parser button. The fields become editable.

While referring to Procedure 125: To add a Trap Parser on Page 491 with its table of field descriptions, edit the field contents.

note ............. While specifying the output values for the event object that is generated in the fields, you can use information in the incoming trap Protocol Data Unit (PDU) information. You can access the information in the trap PDU by using the special tokens that each represent the value of a field in the trap.

To specify your own properties to the event object generated by the Trap Parser, click the More button. The Event User Properties dialog opens.

Figure 326: Event User Properties dialog

important ........... These fields support the matching of traps against multiple varbinds. Each Property Name entry is the value of the name attribute and the corresponding Match Criteria entry is the contents of the associated value in the constraint definition from the TrapSnmp tag in the trap.parser file in the WM server. The tag supports multiple constraint definitions within it. In the Property Name field, do not specify a name that is already used in an existing trap definition because doing so will result in overwriting that definition. In the Match Criteria field, do not leave the field null. If you want to specify no value, then you must populate this field with *. Also, do not end the value string with $ because doing so will result in failure of the substitution operation.

498

WM Release 4.0 User Guide

Issue 3 May 2012

Enter the name and the value of the property in Property Name and Match Criteria fields, respectively.

To add further properties, click the More button.

When you are finished adding values and properties, click the OK button.

10. In the Trap Parser Configuration window, click the Update button. note ............. If you try to update a trap parser with the same set of values that an existing trap parser has, the system prompts you to confirm your intention.

11. To apply this configuration to the server, click the Apply To Server button.

16.1.6

Deleting a Trap Parser important ........... Changes to the default trap parsers may result in undesirable system behavior.

Procedure 129: To delete a Trap Parser 1.

In the Configured Trap Parser List of the Trap Parser Configuration window (see Figure 323 on Page 490), click on the trap parser you want to remove.

Click the Delete Trap Parser button. Alternatively, you can delete a trap parser by pressing the Delete key on your keyboard. To delete two or more, press and hold the Ctrl key, select the parsers, and then press your Delete key. A confirmation pop‐up opens.

16.2

To delete the trap parser, click the Yes button.

To save this configuration to in the server, click Apply To Server.

Using Event Parsers Event parsers provide another layer of processing on events created by trap parsers, and also operate on internally generated events that do not originate with traps. The trap parser makes the notifications readable to the user. Event parsers refine the message conveyed by the events. Traps and event parsers are similar, but the event parser converts other types of events, such as threshold events and status polling events into a readable format before the events are filtered. When an event reaches the WM server, the event parser list is checked to see whether the incoming event satisfies the match criteria of the event parser. If matched, the event is passed through the corresponding event parser. The outgoing event from the parser is then matched with the remaining set of parsers (if any and in sequence). If there are any matches, the event is passed through those parsers, also. This process continues until all the parsers are scanned. These parsers are displayed in the Event Parser Configuration dialog.

499

Issue 3 May 2012

WM Release 4.0 User Guide

By default, WM has no predefined event parsers. It performs all trap and event manipulations by using the predefined trap parsers and the event filter (described under Using Event Filters on Page 509). important ........... Exercise caution when you create event parsers. It is possible to spoil the design of the predefined trap parsers and event filters. Cambium Networks Technical Support staff can help users design new event parsers. See Contacting Support Representatives on Page 758.

16.2.1

Opening the Event Parser Configuration Tool Event Parsers can be created or modified using the Event Parser Configuration tool.

Procedure 130: To open the Event Parser Configuration tool

16.2.2

In the Applications tree, select Fault ManagementNetwork Events.

In the main menu, select ActionsEvent Parsers (or press Ctrl+E).

Adding an Event Parser Procedure 131: To add an Event Parser 1.

Open the Event Parser Configuration tool.

In the Event Parser Configuration window, click the Add Event Parser button. All fields in the window are enabled.

Figure 327: Event Parser Configuration tool

500

In the Name field, type in a unique name for the new event parser.

WM Release 4.0 User Guide

Issue 3 May 2012

Specify values according to those shown in the table below. As you do, designate each value as a Match String, a Tokenizer String, or an Output String by typing them into the appropriate column.

note ............. The output event of an event parser has the same fields as the input event, but with potentially different values. The match strings are strings to search for within specified fields in the original input event, possibly including the use of wildcards. If the fields of an event match all the specified match strings for an event parser, then WM applies that parser to the event. The output of the parser consists of copied, transformed, or overwritten fields as specified in the output strings of the parser. To copy specific portions (referred to as tokens) from the original strings in the event, the tokenizer strings of the parser provide a mechanism for associating numbered tokens with designated sections of an input string.

Table 64: Event Parser fields Field

Description

Message

Corresponds to the text field of the event object.

Category

Categorizes events and alarms.

Domain

Domain name of an event.

Network

Identifies the network name from which the event has originated.

Node

Identifies the node value of an event.

Failure Object

Tracks problems and identifies objects.

Source

Identifies the source name of an event.

Severity

Indicates the state of an event.

Match String The match criteria in the Event Parser Configuration dialog box determine whether the event will be parsed by the given event parser. If a field is left blank, it is automatically matched; otherwise, all fields (AND condition applied) must match the input event. To specify the match criteria, the following special characters may be used in expressions: 

Wild Card Character – Asterisk ( * ): Signifies match 0 or more characters of any value. For example, *Failed* matches any string containing Failed.



Negation – Exclamation ( ! ): Used at the start of a field to specify exclusion of events matching the succeeding expression. For example, !Failed excludes strings containing Failed.

note ............. Expressions, such as *Failed, Fai*d, and * have the expected meanings in the match criteria.

Tokenizer String Enables you to separate the input field into a series of tokens that can be used in the output event object. The tokenizer definition is a string with tokens represented by $1, $2, etc. Only positive integers are allowed following the dollar sign ($).

501

Issue 3 May 2012

WM Release 4.0 User Guide

Example Match String and Tokenizer String Consider the case where you expect an event message text string, such as: Line Card 31 failed on Shelf 54: No Response – Match String

Using the Line Card Number (31), the Shelf Number may be required when defining other properties of the event. You need to tag these properties as tokens with a token number: Line Card $1 failed on Shelf $2: No Response – Tokenizer String

After such tokenization, you can use the token number in the output event definition. Specifying $text$1 for any field in the output event definition, replaces the string with the value 31; similarly specifying $text$2, replaces the string with 54. note ............. To identify the replaceable parameter of a specific field, the token number should be preceded by the field. For example, $text$1 indicates the first tokenized string of the field Message. The tokens of any field can be used in any other field provided that paragraph (1) is followed. Tokens will get applied for space-separated words only.

Output String The output string of the event parser is an event object that becomes the modified instance of the incoming event. The attributes of the event object are defined by the specifications in the event parser.

Value It is necessary to select correct values, particularly for important attributes, namely failure object (affected entity), severity, and message text. The properties that should remain unchanged must be specifically noted by placing a dollar sign followed by the property name. For example, if the text field should not be modified, then the value $text should be entered in the output string. To use the values of the incoming event properties while specifying the output values in the definition column, specify the exact property name (case sensitive) with a prefixed $. For example, to use the event property Source, the definition should be $source. If the particular property has been tokenized and if you intend to use the value of the token, then the format should be $propertyname$N, where N is the count of the token starting with 1.

502

WM Release 4.0 User Guide

Issue 3 May 2012

Table 65: Event properties Name

Replaceable Parameter (Property Token)

Description The present severity value (e.g., 1, 2, etc.) of the event.

severity

$severity

Severity values set for an Event are provided in SeverityInfo.conf present in the /usr/local/cambium/wm/server/conf directory in Linux (or the C:\Cambium\WM\server\conf folder in Windows). Holds the description of the fault.

text

$text

Example: If the event is for a fault indicating high processor load then the text can be set as Processor load high. Represents the failure object. Value of entity is closely coupled with the way you model your network element.

entity

$entity

Example: Consider a network element as a user's PC. You model User's PC as a ManagedObject. It can have failure objects, such as CPU, Keyboard, Monitor, etc. As per the above modeling, event which is generated from user's PC, can have entity, such as CPU, Keyboard, or Monitor. Represents the source of failure. The source field of the Event/Alert object should be same as that of the name field of ManagedObject in order to get the ManagedObject's status updated when Alerts are generated.

source

$source

Example: Assume you have 10 user PCs in your network. You model each PC as a ManagedObject. Each PC can have failure objects (entities), such as CPU, Monitor, etc. When CPU from User1 fails, you will generate Event with properties, entity = User1_CPU, source = User1. Similarly, when CPU from User2 fails, you will generate Event with properties, entity = User2_CPU, source = User2.

domain

$domain

Represents the domain name for the Event. This field may or may not be used depending on the application.

503

Issue 3 May 2012

WM Release 4.0 User Guide

Replaceable Parameter (Property Token)

Name

Description There can be any type of faults reported for an entity. This field can be used to categorize such faults from the same entity.

Category

Match criteria based on an event object property with a category name to which the event belongs. This is used to organize events.

Domain

Match criteria based on an event object property with any domain‐ specific information. The information might be based upon the physical location, or the functional or logical categorization of the source of the event. The domain name of the event displays events of a particular domain.

511

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description

Network

Match criteria based on the information about the network to which the source of the event belongs. Using this criteria, events belonging to a particular network are displayed.

Node

Match criteria based on any additional information (name of the node) about the source of the event.

Entity

Match criteria based on the information about an exact device in which a problem has occurred.

The values that you specify in the Match Criteria determine whether the incoming event should be filtered or not. If a field is left blank, it is automatically matched. For the Event Filter to be applied, all the match criteria specified must be satisfied. If even one criterion fails, the filter will not be applied. The following expressions can be used while specifying the match criteria: 

Wildcard ‐ Asterisk (*) Use to signify a match of 0 or more characters of any value. Example: Failed* matches any string starting with Failed. Expressions, such as *, *Failed, Fai*led*, can be used.



Negation ‐ Exclamation (!) Used at the start of the field to specify exclusion of events matching this expression. Example: !Failed excludes strings starting with Failed.



Separator ‐ Comma (,) Used to specify multiple values for a single match criterion by separating them with commas. Example: Critical, Major will match a string which is either Critical or Major.

The following combinations can be used while specifying match criteria. 

* AND , : This combination can be used to obtain the combined result of two matching criteria that signifies a match of 0 or more characters for the given criteria. Example: (*x,*y) is tokenized into *x and *y and only data ending with x and y is matched.



! AND , : This combination can be used to obtain the exclusion of events matching two criteria. Example: (!x,!y) is considered an AND operation. In this case, all data starting with (x,y) will not be matched.



a,b : This combination is tokenized into two strings ('a' and 'b'). Therefore this criterion matches 'a,b' and also the data 'a' and 'b'.

Procedure 139: To add an Event Filter—Additional Criteria Phase 1.

To specify additional match criteria for the Event Filter, click More Properties and complete the following steps.

Specify the property name in the Property Name field and match criteria in the Property Value field. The match criteria specified must be based on the properties of the com.adventnet.nms.eventdb.Event object including user properties. While specifying additional criteria, specify only those properties that are in the event object. The name should exactly match the case of the event object. You can also add event base properties as match criteria, such as group name, help URL, ID, and time.

When you are finished adding properties and values, close the More Properties dialog and then click OK in the Match Criteria Properties dialog.

note ............. An Event Filter must have at least one notification associated with it.

512

WM Release 4.0 User Guide

Issue 3 May 2012

The next stage is specifying the filter notification to be triggered when the new event satisfies the match criteria. The steps involved are as follows.

Procedure 140: To add an Event Filter—Notification Phase 1.

In the Actions List panel, click the Add Action The Add Actions dialog opens to Notifications.

icon.

The selectable actions (notification types) are as follows: ◦

Suppress, described on Page 514

◦

Run Command, described on Page 515

◦

Send Trap, described on Page 516

◦

Send Email, described on Page 519

◦

Custom Filter Notification, described on Page 521

Select the tree node corresponding to the notification you wish to configure.

Click the New button.

note ............. you can re-use an existing notification by selecting it and clicking the Add button (for example, to send email to the same recipient for a different event filter).

After configuring the notification values, click OK in the specific Action dialog.

Back in the Add Action dialog, select the added notification and click the Add button.

This adds the notification to the Actions List in the Event Filters dialog.

To add more notifications, repeat Steps 2 through 6.

When you are finished adding Filters and Actions, click Apply and then OK.

The following sections describe the various notification types that you can configure for an Event Filter.

513

Issue 3 May 2012

WM Release 4.0 User Guide

Suppress Action This notification type allows you to suppress (drop) events that match the filter criteria, either altogether or multiple events of the same type within a given interval.

Figure 333: Suppress Action dialog

The following are the fields are on the Suppress Action Details dialog.

Table 68: Suppress Action Details dialog fields Field

Purpose

Notification Specify a name for the notification Name This radio button indicates how to suppress incoming events. Suppress All Yes: Suppresses all subsequent events No: Allows the first event and suppresses subsequent events during the specified interval.

Suppress Interval

Specify a numeric value (in seconds) to suppress multiple events for a given interval. The first event that matches the configured criteria is allowed and all the subsequent events are suppressed for the given interval. After the suppress interval has elapsed, another event matching the criteria is allowed and the subsequent events are again suppressed, and so on. The input for this field can be extracted from the event properties by using the replaceable parameter $<Event Property> or from the PDU information contained in the event when the event has been generated from a trap. But in either case, it is imperative to ensure that the value returns a numeric value.

514

WM Release 4.0 User Guide

Issue 3 May 2012

Run Command Action This notification type allows you to run a command on the server for events matching the filter criteria. It can be used to invoke a reminder application, or any other system command.

Figure 334: Run Command Action dialog

The following are the fields present in the Run Command Notification dialog.

Table 69: Run Command Notification dialog fields Field Notification Name

Purpose Specify a name for the Run command notification Specify the command to be executed. The command string should be a machine‐executable program on the server that does not require a shell (it cannot be a batch or a shell file). Example: dir ‐ Executing this command lists in the message field of the Event all the directories under the C:\Cambium\WM\server\conf folder in Windows or the /usr/local/cambium/wm/server/conf directory in Linux.

System Command

WM supports having an audio file through the speakers of the server device when a client session on that device is open at the time that the associated notification is triggered. To configure this, use a syntax like one of the following as the entry in the System Command field: 

sndrec32 /play/close “C:\Windows\Media\Notify.wav” in Windows



play /path/sound.wav in Linux

Be aware that a client session from other than the server device will not receive this audible notification.

515

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Check boxes for command results

Abort After

Purpose To append output or errors from the command to the event message, check one or both of the check boxes ‐ append output to message and/or append error to message Checking either or both the check boxes results in the command being run synchronously in the main event processing thread. This delays all events that follow the event being processed until the command execution is completed or terminated by timeout Specify the time (in seconds) after which the command execution is to be terminated (the timeout value of the specified command). This value plays an important role if even one of the above checkboxes is checked, since the entire event processing is held up by the command execution.

To use shell scripts or commands, you must invoke the shell as a part of the command string. The command string must contain the full path of the shell where the Event server has started. The fields for which the tokens can be used are the command argument fields and the timeout (Abort After) field of the notification. If the tokens are used for the timeout field, ensure that the dynamically generated value is numeric.

Send Trap Action This notification type allows you to send SNMP v1/v2c traps when the incoming event matches these filter criteria. The traps can be configured to have event information if specified. The notification can be configured to be sent to any desired host. For devices that send traps in multiple SNMP versions, WM allows you to capture those versions into a single trap with their correlated varbinds. The most common application of the Send Trap Action is for trap forwarding: sending traps to other management systems when WM receives relevant traps.

516

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 335: Send Trap Action dialog

The following fields are present in the Send Trap Action dialog.

Table 70: Send Trap Action dialog fields Field

Description

Notification Name

Specify a name for the Send Trap notification

Trap Destination

Specify the host to which the trap is to be sent

Destination Port

Specify the port to which the trap is to be sent

Trap Community

Specify the string to be set for the generated trap

SysUpTime (secs)

Specify the sysuptime value to be used in the trap

v1/v2C

Radio box to select the type of SNMP trap to be sent

Enterprise

Specify the enterprise OID of the trap. Applicable only to SNMP v1.

Generic Type

Specify the GT number of the trap. Applicable only to SNMP v1.

Specific Type

Specify the ST number of the trap. Applicable only to SNMP v1.

517

Issue 3 May 2012

WM Release 4.0 User Guide

Field Trap OID*

Description Specify the OID of the trap that is being sent. Applicable only to SNMP v2c. Click Add to add variable bindings to the trap. OID Value: Specify the value of the Object ID.

List button

SNMP Type: Choose the appropriate SNMP string from the drop‐down list. Set Value: Specify the set value associated with the selected SNMP type. Click the Update button. To add more variable bindings, click the Add button and repeat these steps.

To add variable bindings to the trap, click the List button in the Send Trap Action dialog. The Variable Binding List dialog will be shown. note ............. In the same way as unknown traps are, trap varbinds are dumped to the event.

Figure 336: Variable Binding List dialog

Procedure 141: To add a varbind 1.

Click the Add button.

From the SNMP Type drop‐down list, select the syntax.

In the Set Value field, specify the value for the varbind.

Click the Update button.

Repeat the above procedure for adding multiple varbinds. The added varbinds will be available in the read‐only Variable Binding List Details section of the Variable Binding List window.

Procedure 142: To modify a varbind

518

Select the varbind from the Variable Binding List Details.

Modify the OID Value, SNMP Type, and/or the Set Value.

Click the Update button. The changes will be reflected in the list area of the Variable Binding List dialog.

WM Release 4.0 User Guide

Issue 3 May 2012

Send Email Action This notification type allows you to send e‐mails when the incoming event matches these filter criteria.

Figure 337: Send Email Action dialog

The following fields are present in the Send Email Action dialog. For all the Send Email Action fields (except To Email ID and From Email ID fields), you can specify the value with the event object attributes (and associated trap, if any) using tokens.

Table 71: Send Email Action Details dialog fields Field

Purpose

Notification name Specify a unique name for the notification. Account Name

Specify the user name using which the mail server will authenticate you to send the e‐mail.

Password

Specify the password using which the mail server will authenticate you to send the e‐mail.

SMTP Server

To Email ID

From Email ID

Specify the SMTP server address. Example: example.com or 192.168.1.139 Specify the destination address to which the e‐mail should be sent. Example: fault@example.com Specify the sender's address from which the e‐mail is being sent. Example: john@example.com

519

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Purpose

Subject

Specify the subject of the e‐mail.1

Message

Specify the body content of the e‐mail.2

File Attachment

Files such as log files, can be attached with the mail, which will help the administrator in debugging the fault.

NOTES: icon next to the text box to 1. As you compose the subject line, you can click on the select a key word from the drop‐down list to have the system insert the corresponding tokenizer string (see also Tokenizer String on Page 501). This makes the contents of your subject line variable. The available key words are

Example: icon next to the text box to 2. As you compose the message, you can click on the select a key word from the drop‐down list to have the system insert the corresponding tokenizer string. This makes the contents of your message variable. The available key words for the message contents are

Example:

For an event that originates from a trap, information from the trap PDU is also available for inclusion in the email message. When an event is generated by a trap, the associated Trap PDU reference is maintained in the incoming event object, if the parameter TRANSIENT_TRAP_PDU_IN_EVENT under the EventMgr module in NmsProcessesBE.conf file located in the C:\Cambium\WM\server\conf folder in Windows or the /usr/local/cambium/wm/server/conf directory in Linux is set true. If the incoming event object has maintained the trap PDU reference, then you can use the properties of the trap, within the configured event filter. The properties of the trap could be used at the level of specifying match criteria (using More option) and also for specifying values of the various action fields.

520

WM Release 4.0 User Guide

Issue 3 May 2012

The methodology of using the properties of the trap, using symbolic notations is similar to that of Trap Parsers, except for the following differences is as follows: 

To access the values of the SNMP OID in the SNMP Variable bindings, the notation should start with % and not with $ as in trap parser.



All the special purpose tags should start with % instead and not with $ as in trap parser.



To access the SNMP OID in the SNMP Variable bindings, the notation should start with the same @ as in trap parser.

To authenticate yourself as the sender, click the Authentication button.

Figure 338: Authentication Information dialog

Configure the Account Name and Password. Field

Purpose

Account Name

Specify the user name with which the mail server will authenticate you to send the e‐mail.

Password

Specify the password with which the mail server will authenticate you to send the e‐mail.

Custom Filter Notification You can also write your own Java class to perform some actions according to your requirement. This class can be invoked when the incoming events satisfy the filter criteria. This is more of an option for a developer than an administrator.

521

Issue 3 May 2012

16.3.3

WM Release 4.0 User Guide

Reordering the Event Filter Configuration List Reordering the Event Filter Configuration list can be important since event filters can alter or even suppress an event, before other event filters are evaluated on that event in succession. note…………The default event filter named EventFilter that WM provides should be first in the evaluation list. Otherwise, undesirable system behavior may result.

Procedure 143: To reorder the Event Filter list In the left panel of the Event Filters dialog (Figure 331 on Page 510), click and drag the Event Filter you want to reorder to a new location in the list.

16.3.4

Loading an Event Filter Procedure 144: To load an Event Filter file 1.

In the Event Filters dialog (Figure 331 on Page 510), click the Load/Save button.

Figure 339: Filter Details dialog

Either click the Browse button to begin browsing from the .../cambium/wm/server directory in the WM server file system or verify the pre‐populated path and file name is the filters file that you want to load.

Click the Load button.

note ............. Any filters with the same match criteria as that of the existing ones currently listed in the Event Filters dialog are replaced with the event filters from the file that you load.

522

WM Release 4.0 User Guide

16.3.5

Issue 3 May 2012

Modifying an Event Filter important ........... By default, WM has a default event filter that performs key operations and that is very dangerous to delete or even edit. For example, an operator should never modify its name or its Match Criteria (its Source or Severity). The name of this filter is EventFilter.

Procedure 145: To modify the match criteria of an Event Filter 1.

With the Network Events view in front in the view panel, from the main menu, select EditConfigureEvent Filters (or press Ctrl+Shift+E). The Event Filters dialog opens. See Figure 331 on Page 510.

In the left panel of the Event Filters dialog, click to highlight the Event Filter to modify.

Using the following procedures for reference, add or modify the criteria as needed: ◦

Procedure 138 on Page 510

◦

Procedure 139 on Page 512

Click the Load/Save button. The Filter Details dialog opens. See Figure 344 above.

Click the Save button to save the notification to the alert.filters file.

Click OK to quit the dialog.

Procedure 146: To modify the notifications in an Event Filter 1.

In the left panel of the Event Filters dialog, select the Event Filter whose notification is to be modified.

Click the Add Action icon of the Actions List panel.

In the Add Action dialog, select the tree node corresponding to the notification that needs to be modified.

Using the following procedures for reference, click Edit and make the appropriate changes: ◦

Procedure 140 on Page 513

◦

Procedure 141 on Page 518

◦

Procedure 142 on Page 518

Click the Add button in the Add Action dialog.

Click the Load/Save button. The Filter Details dialog opens. See Figure 344 above.

Click the Save button to save the notification to the alert.filters file.

Click OK to quit the dialog.

523

Issue 3 May 2012

16.3.6

WM Release 4.0 User Guide

Deleting an Event Filter important ........... Do not delete the default event filter named EventFilter, which was installed with the WM server software.

Procedure 147: To delete an event filter 1.

In the left panel of the left panel of the Event Filters dialog (Figure 331 on Page 510), click to highlight the filter to delete.

Delete Filter button in left panel. Click the The system prompts for confirmation.

Click the Yes button to delete the Event Filter.

Procedure 148: To delete a filter notification

16.4

In the left panel of the left panel of the Event Filters dialog (Figure 331 on Page 510), click to highlight the Event Filter in which the notification is to be deleted.

Click to highlight the notification in the Actions List panel.

Delete Action icon. Click the A confirmation is asked.

Click the Yes button to delete the notification.

Using Alarm Filters Events are correlated into alarms. They represent the current status of the various problems in the network. An Alarm Filter executes certain corrective actions whenever alarms are received with configurable matching criteria, such as suppressing multiple alerts in a given interval, running shell commands on the server system, sending e‐mails, sending traps, and executing custom code to filter alerts. The most common use of alarm filters is the Send Email Action, which sends email to a designated recipient, informing them of the occurrence of a high‐severity alarm. Custom code may be needed in cases where any additional data has to be retrieved, or specific rules are to be applied in processing the alarm. Custom code is also the appropriate mechanism to configure alarm grouping, because it usually requires user‐ or domain‐specific rules. After filtering, the alarms are stored in the database and made available in the Alarms Viewer. The Alarm Viewer is asynchronously notified, as soon as the processing of an alert is finished. You can configure an Alarm Filter using the Alert Filter Configuration tool. You can use the properties of the alert object in some of the fields, such as Suppress Action, Run Command Action, Send Trap Action, and Send E‐mail Action.

524

WM Release 4.0 User Guide

Issue 3 May 2012

A custom Alarm Filter can be configured to enable more effective event correlation and fault management by adding application‐specific rules when processing events and alarms. However, this should be done by a developer and not by an administrator. important ........... WM is installed with a single default alarm filter named AlertFilter. Except under extraordinary circumstances, you should not modify or delete this filter, because this would result in undesirable behavior of the system.

16.4.1

Opening the Alarm Filter Configuration Tool The Alarm Filters can be created or modified using the Alarm Filter Configuration tool.

Procedure 149: To open the Alarm Filter Configuration Tool 1.

In the Applications tree, select Fault ManagementAlarms.

In the main menu, select ActionsAlarm Filters (or press Ctrl+Shift+A). The Alert Filters dialog opens.

Figure 340: Alert Filters dialog

525

Issue 3 May 2012

16.4.2

WM Release 4.0 User Guide

Adding an Alarm Filter The following is an example to keep in mind as you work through the procedures in this section. This example presumes that you want an e‐mail message sent to the manager, with the message in the body reading An Alert of Category CATEGORY and severity SEVERITY has been generated from SOURCE. It has been picked up by OPERATOR.

An Alarm is generated with the following properties. (The alarm has many other properties, which are not examined in this example.)

Table 72: Email alert message properties Property Name

Property Value

Category

General

Severity

Critical

Source

Printer1

Who

James

Procedure 150: To add an Alarm Filter, example steps 1.

In the Alert Filters dialog, click the Add New Filter button.

Add an Alert filter with the following properties: Filter Name : Example Source : Printer1 Severity : Critical

526

In the Alert Filters dialog, click the Apply button.

Click the Advanced button.

In the Category field, type in General.

Click the More Properties button.

In the Property Name field, type in Who.

In the associated Property Value field, type in James.

WM Release 4.0 User Guide

Issue 3 May 2012

Click the Add button.

10. Click the View All button.

11. Review the attributes so far. 12. Configure a Send e‐mail action filter notification with the following properties: Notification Name : examplemail Message : An Alert of Category $category and severity $severity has been generated from $source and has been picked up by $who 13. Specify appropriate values for the remaining fields. 14. Click the Apply button. 15. Click the Load/Save button.

527

Issue 3 May 2012

WM Release 4.0 User Guide

On executing this example, an email message is sent for this type of alarm and it has the following message in the body of the e‐mail: An Alert of Category General and Severity Critical has been generated from printer1 and has been picked up by James

Procedure 151: To add an Alarm Filter, criteria phase 1.

In the Alert Filters dialog (Figure 340 on Page 525), click the The Alert Filters dialog opens.

Add New Filter icon.

Figure 341: Alert Filters dialog, example added

528

Specify a name for the Alarm Filter in the Filter Name field.

Specify the required criteria in the Match Criteria section. The Source and Severity fields are available in this dialog. Refer to the following tables for information on the Match Criteria fields.

WM Release 4.0 User Guide

Issue 3 May 2012

Table 73: Alarm Match Criteria fields Field

Description Represents the source of failure. The source field of the Event/Alert object should be same as that of the name field of ManagedObject in order to get the ManagedObject's status updated when Alerts are generated.

Source

Severity

Match criteria based on the severity of the alarm, such as Critical or Major. Other properties can be configured by clicking the Advanced button.

Figure 342: Match criteria Properties dialog

Table 74: Match criteria Properties fields Field

Description

Message

Match criteria based on a message of the incoming alarm, such as Interface failure or Status poll failed.

Category

Match criteria based on an alarm object property with a category name to which the alarm belongs. This is used to organize alarms.

529

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description

Domain

Represents the domain name for the alarm. This field may or may not be used depending on the application.

Network

To set the network name from which the alarm has to be raised. This may or may not be used depending on the application.

Node

The node value for the alarm. This may or may not be used depending on the application.

Entity

Match criteria based on the information about an exact device in which a problem has occurred. The values that you specify in the Match Criteria determine whether the incoming alarm should be filtered. If this field is left blank, it is automatically matched. For the Alarm Filter to be applied, all the match criteria specified must be satisfied. If even one criterion fails, the Filter will not be applied.

Procedure 152: To add an Alarm Filter, additional criteria phase 1.

To specify additional match criteria for the Alarm Filter, click More Properties.

Figure 343: More Properties dialog

530

In the Property Name field, type in the name for the additional property. The Property Name should exactly match the case of the alert object.

Specify the match criteria in the Property Value field. The match criteria specified should be based on the properties of the Alert object and can also include user properties.

Optionally, add alarm base properties as match criteria, such as group name, help URL, ID, and time.

When you are finished adding properties and values, click the Add button.

Dismiss the More Properties dialog.

In the Match Criteria Properties dialog, click OK.

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 153: To add an Alarm Filter, notifications phase 1.

In the Actions List panel, click the Add Action

button.

Select the tree node corresponding to the notification you wish to configure (this is the filter notification to be triggered when the incoming alert satisfies the match criteria). The action types that can be configured for an Alarm Filter are: −

Suppress Action (see Suppress Action on Page 514)

−

Run Command Action (see Run Command Action on Page 515)

−

Send Trap Action (see Send Trap Action on Page 516)

−

Send Email Action (see Send Email Action on Page 519)

−

Custom Filter (see Custom Filter Notification on Page 521)

Click the New button.

Configure the notification.

After configuring the notification values, click OK in the notification configuration dialog.

In the Notifications tree of the Add Action dialog, click to highlight the newly added notification.

Click the Add button. This adds the notification to the Actions List of the Alert Filters dialog.

To add more notifications, click the Add Action above for the next notification.

After adding each Filter or Notification, click the Apply button.

button and repeat the steps described

10. Click OK.

16.4.3

Reordering the Alarm Filter Configuration List Alarm filters are evaluated in the order shown in the list, and all alarm filters are evaluated. Since alarm filters can edit (or suppress) alarms, the order of evaluation is important. The default AlertFilter alarm should always be first in the list.

Procedure 154: To reorder the Alert Filters In the left panel of the Alert Filters dialog (Figure 340 on Page 525), click and drag the Alert Filter to a new location in the list.

531

Issue 3 May 2012

16.4.4

WM Release 4.0 User Guide

Loading an Alarm Filter Procedure 155: To load an Alert Filter file 1.

In the Alert Filters dialog (Figure 340 on Page 525), click the Load/Save button. The Filter Details dialog opens.

Figure 344: Filter Details dialog

Click Load.

note ............. Any filters with the same match criteria as that of the existing ones currently listed in the Alert Filters dialog are replaced with the Alert Filters from the file that you load.

16.4.5

Modifying an Alarm Filter important ........... Do not modify the default alarm filter named AlertFilter, which was installed with WM software.

Procedure 156: To modify the match criteria for an Alarm Filter

532

With the Alarms view in front in the view panel, from the main menu, select EditConfigureAlarm Filters (or press Ctrl+Shift+E). The Alert Filters dialog opens. See Figure 340 on Page 525.

In the left panel of the Alert Filters dialog, click to highlight the alarm filter to modify.

Using the following procedures for reference, add or modify the criteria as needed: ◦

Procedure 151 on Page 528

◦

Procedure 152 on Page 530

Click the Apply button.

Click the Load/Save button. The Filter Details dialog opens. See Figure 344 above.

Click the Save button to save the filter to the alert.filters file.

Click OK to apply the new criteria and quit the dialog.

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 157: To modify the notifications for an Alarm Filter 1.

With the Alarms view in front in the view panel, from the main menu, select EditConfigureAlarm Filters (or press Ctrl+Shift+E). The Alert Filters dialog opens. See Figure 340 on Page 525.

In the left panel of the Alert Filters dialog, click to highlight the alarm filter to modify.

Click the Add Action icon of the Actions List panel.

In the Add Action dialog, select the tree node corresponding to the notification that needs to be modified.

Using Procedure 153 on Page 531 for reference, click Edit and make the appropriate changes.

Click OK in the Add Action dialog.

Click the Apply button.

Click the Load/Save button. The Filter Details dialog opens. See Figure 344 above.

10. Click the Save button to save the notification to the alert.filters file. 11. Click OK to quit the dialog.

16.4.6

Deleting an Alarm Filter important ........... Do not delete the default alarm filter named AlertFilter, which was installed with WM software.

Procedure 158: To delete an alarm filter 1.

In the left panel of the Alert Filters dialog (Figure 340 on Page 525), select the filter to delete.

Delete Filter button in left panel. Click the The system prompts for confirmation.

Click Yes to delete the alarm filter.

Procedure 159: To delete a filter notification 1.

From the left panel of the Alert Filters dialog (Figure 340 on Page 525), click to highlight the alarm filter whose notification you want to delete.

In the Actions List panel, click to highlight the notification.

Delete Action button. Click the The system prompts for confirmation.

533

Issue 3 May 2012

WM Release 4.0 User Guide

16.5 16.5.1

Click Yes to delete the notification.

Performing Alarm Operations Deleting an Alarm You have an option to delete an alarm when you feel that the alarm is not significant or that the alarm has been cleared. By default, the alarms that have a Clear status for more than 24 hours are deleted. This deletion will happen every 60 minutes automatically. But if you want to manually delete the cleared alarms, use this option. CAUTION ........... Deleting an alarm entirely removes the alarm from the database, including its history. Typically, alarms are deleted by only the execution of policies that were designed for this purpose.

Procedure 160: To delete a triggered alarm

534

Open the Applications tree, select Fault ManagementAlarms.

In the Alarms view, click to highlight the alarm the alarm that you want to delete.

From the main menu, select EditDelete, or press Ctrl+R. The system prompts for confirmation.

Respond to the confirmation request by selecting OK.

WM Release 4.0 User Guide

16.5.2

Issue 3 May 2012

Grouping Triggered Alarms For ease of administration, you can group alarms based on some criteria. For example, you can group all the alarms pertaining to a single device and represent them as a single unit. The grouped alarms are depicted as a single representative in the client. This representative is based on the value specified for the groupName field present in the Events and Alarms views. To make this grouping possible, perform the following steps: 1.

In the Trap Parser Configuration tool, set a value to the Group Name field. This will set the Group Name as specified here for all the Events that are generated by this Trap Parser. Use Procedure 128: To modify a Trap Parser on Page 498 for reference.

In the Event Parser Configuration tool, click the More button. Use Procedure 134: To modify an Event Parser on Page 507 for reference.

In the Specify User properties and Trap based Criterias block of the Event Parser Configuration dialog a.

set the Field Name as groupName.

set the Output String with the <name of the group>.

leave the Match String and the Tokenizer String columns empty.

warning.............. When you specify the value for the GroupViewMode in the Alarms Custom View, the server will fetch data from the database for every received alarm. The server does not maintain the details of all the alarms in a group and, as a result, must fetch the data from the database. This constant fetching can degrade the performance of the server.

16.6

Assigning Fault Management Privileges You can restrict a user from accessing certain data and also confine the user to viewing and working on only selected network events and alarms. This is achieved using the Custom View Scope mechanism of Security Management. This section provides an example, based on which you can create your own Custom View Scopes. This example covers 

creating a user named FaultMgr.



associating this user with a new group named faultgroup.



providing to faultgroup the permission to view and perform operations on alarms from a specific network element named router1 and with an alarm severity of Major.

Procedure 161: To assign fault management privileges (example case) 1.

From the main menu, select ToolsAdministrationSecurity Administration. The Security Administration tool is displayed.

Either click the

Add a new user named FaultMgr.

Add User button or select FileNewAddUser from the main menu.

535

Issue 3 May 2012

536

WM Release 4.0 User Guide

Add a new group named faultgroup.

Assign required permissions to the faultgroup.

Issue 3 May 2012

537

Issue 3 May 2012

WM Release 4.0 User Guide

538

Assign the new user FaultMgr to the faultgroup.

WM Release 4.0 User Guide

Issue 3 May 2012

note ............. Some delay may be encountered as WM updates its Security module.

Set the Scope Criteria as follows: a.

Select faultgroup on the Security tree.

Click the Custom View Scope for Group tab.

539

Issue 3 May 2012

540

WM Release 4.0 User Guide

From Custom View Scope for Group drop‐down menu, select Alerts.

Click Add AuthorizedScope. The Scope Settings dialog is displayed.

WM Release 4.0 User Guide

Issue 3 May 2012

Enter the Name as Router1_Major.

From the Name drop‐down menu, select the property severity.

Enter the Value as 2.

Click Add.

From the Name drop‐down menu, select the property source.

Enter the Value as router1.

Click Add.

Click OK.

note ............. Some delay may be encountered as WM updates its Security module.

541

Issue 3 May 2012

WM Release 4.0 User Guide

Result The authorized scope is added to the Authorized Scopes list in the Custom View Scope for Group tab. When you log in with user name FaultMgr, you will be able to view only the alarms of the network element router1 with Major severity.

542

WM Release 4.0 User Guide

Issue 3 May 2012

17 Administering Performance Management By default, WM is set up to gather all significant performance data statistics from all discovered devices. The performance data setup for each device is defined in its device configuration file on the WM server, and includes a list of SNMP OIDs along with display names for each, and other fields. When a device is discovered, WM distinguishes its specific type as a normal part of discovery. Then WM applies the corresponding device configuration file, including the setup of corresponding performance data statistic polling. In this way, a standard and practically exhaustive device‐type‐ specific performance data statistic polling setup is applied to each device upon discovery, after which the only modification that most users must make is to occasionally modify the polling interval for a statistic that is already being polled. For this reason, it is extremely rare for a WM user to have any need to set up performance data collection independent of the device configuration files (to add an entirely new statistic to be polled). However, it is possible that in exceptional cases there will be a requirement to do so. For these exceptional cases, the instructions in this section present the work flow

17.1



for creating a performance data statistic polling configuration for a device that WM has discovered.



for adding a new statistic to be polled (one that is not specified by the device configuration file).

Data Collection Network performance is evaluated based on how each network element is performing. Read‐only performance data statistics must be collected from those elements. Each device deals with varied data, some of them being 

how many octets (bytes) it receives



how many octets (bytes) it sends



the speed of the device in responding.

You must know from which device to collect data and what data to collect. Once data collection starts, the collected data is stored in the database for future reference. To monitor network performance, you need to check whether the collected data is optimal. For example, the optimal speed of an Rk5 switch should be 100000, to be considered efficient. For some critical performance data statistics, it is useful to define thresholds. A threshold object contains a value for WM to compare against the value that it collects via polling. If the collected value from the device crosses the threshold, the performance of the device may have become degraded. In addition to awareness of WM data collection and its monitoring against threshold values, you need some way to view the results of data collection and threshold application. For this purpose, the Performance module provides a notification and reporting mechanism. (See Performance Data Viewing Alternatives on Page 384.) Data collection is the process of collecting useful read‐only information from network elements. The collected data is used in formulas that calculate network performance. The performance of your network depends on the data you select.

543

Issue 3 May 2012

WM Release 4.0 User Guide

This section describes how, by configuring data collection, you can

17.1.1



specify from which devices the data is to be collected.



select particular data to collect or not collect.



temporarily stop data collection and resume whenever you wish.



choose the protocol for data collection.



set storage options, such as specifying when and where to store collected data.

Elements Involved in Data Collection To configure data collection in WM, you need an understanding of the data collection process and the elements that are involved.

Managed Object (MO) The Managed Object (MO) is created by WM during discovery. An MO represents an entity that can be a device (as a whole) or a part of the device (such as a port, card, slot, or interface. An MO contains the properties of the entity, such as name and type.

Polling Object The Polling Object is created by the Performance module. This object contains the following two properties: 

Match Criteria specifies the conditions to be satisfied by the MO. Only when these conditions are satisfied will the MO be considered for data collection. For example, isSNMP = true specifies that the MO should be an SNMP node in order to match.



Data Collection Criteria specifies the list of data to be collected from the MO.

PolledData is the unit of data collection when you specify what data is to be collected in the Polling Object and stored in the database. For example, if the data number of octets received by the interface of a device has to be retrieved then a PolledData with the name of Interface_if_inoctet can be created. The WM user interface and menu options refer to PolledData objects as Statistics. PolledData can be created either via a Polling object definition or directly for a Managed Object. With a PolledData definition

544



the value set for the status property of a PollingObject reflects on the PolledData.



the set of PolledData is treated as a single group, and deletion of PollingObject automatically deletes the associated PolledData.



the definition method is useful when you want to create many PolledData objects for individual Managed Objects, wherein the match criteria of the Polling Object satisfies the Managed Object properties.

WM Release 4.0 User Guide

Issue 3 May 2012

With direct PolledData 

only one PolledData can be added at a time for a Managed Object, and each must be individually modified and deleted.



the direct method can be preferable when fewer PolledData are to be created.



PolledData added for the same Managed Object is treated separately. Any change in the Polling Object associated with the Managed Object does not affect the PolledData.

Poll Filter When PolledData is created for an MO as specified in the data collection criteria, it can undergo a change in properties, or some more PolledData can be added, or an existing set may need to be deleted. This is achieved by creating a Poll Filter object in which the action to be performed is defined.

17.1.2

Data Collection Process The following steps are involved in configuring data collection: 1.

Upon WM server startup, Polling Objects are created based on a definition present in the WM server. Each Polling object in itself contains two definitions: Match Criteria and Data Collection Criteria.

note ............. Default polling objects encompassing practically all useful performance data for all supported device types are installed with WM.

Whenever a Managed Object is discovered, it is given as input to the Polling Object.

The Match Criteria of the Polling object are compared with the properties of the Managed Object.

If the Match Criteria are met, then PolledData is created for every entry specified in Data Collection Criteria and associated with the MO.

If Poll Filters exist, then the created PolledData is passed through the Poll Filter one by one to undergo appropriate modifications. Then the filtered PolledData is added to the database.

If Poll Filters do not exist, then PolledData is added to the database without modifications.

Even if the Match Criteria are not satisfied, the Managed Object is passed through Poll Filters. If you want to add a single PolledData for a particular Managed Object, you do not need to create a Polling Object.

The definition of what data to collect and from which device is recorded in the database, and the Performance module uses this information for data collection.

545

Issue 3 May 2012

17.1.3

WM Release 4.0 User Guide

Creating a Polling Object By providing an example, this section explains how to create Polling Objects. note ............. Default Polling Objects are installed with WM software and should be sufficient for all but the most extraordinary situations.

Assume that you want to create a Polling Object to identify Managed Objects (MOs) that support SNMP and are of type Node. Type of the MO specifies whether it is a node, network, router, or switch, for example.

Procedure 162: To create a Polling Object 1.

In the Applications tree, select PerformanceConfigured Collection.

From the main menu, select ActionsPolling ObjectsAdd Polling Objects. The Poll Details wizard is displayed, including a list on the left of the default polling objects installed with WM and any that have been created by users. Only default polling objects for device types that have been discovered appear in the list. As described earlier, the default polling objects are built using the specifications in the device configuration files for discovered devices. The fields on the initial screen of the wizard are at first disabled, since the first polling object in the list is selected when the wizard starts—you cannot edit the name of an existing polling object.

caution............... If you edit or change one of the default polling objects that is installed with WM, undesirable system behavior may result.

546

Click the Add button. The fields become read‐write.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 345: Poll Details dialog, General Properties frame

Specify appropriate values in the following fields (each field is a property of the Polling Object): ◦

Polling Object Name: A string to identify the Polling object. Example: NodePollObj. This is a mandatory field.

note ............. The default polling objects have names consisting of the specific type of device and the SNMP agent name for the device that will be polled. In some cases, the type and the agent name are the same.

◦

Status: Available as check box, checked by default. −

When this is checked, the Polling Object is active, and data collection for its associated PolledData can be done.

−

When this is unchecked, data collection for the associated PolledData is stopped.

Update Managed Objects: Available as check box, unchecked by default. −

When this is checked, the definition of the Polling Object is applied over existing Managed Objects, and they will be updated with information given in Polling Objects.

−

When this is unchecked, it is not applied over existing MOs.

547

Issue 3 May 2012

WM Release 4.0 User Guide

Example: Assume you have twenty MOs and for each you have two PolledData added. If you want to add two more PolledData for a particular set of Managed Objects, you can specify the match criteria in the Polling Object and the information about the new PolledData. Now if this field is selected If this box is checked, as soon as a Polling Object is added for the existing MOs that satisfy the match criteria, the two PolledData is added. If this box is not checked, the Polling Object is used for only newly created MOs. 5.

Click the Next button. The next screen of the wizard is to set the Match Criteria that a Managed Object should satisfy for data to be collected from it.

Figure 346: Poll Details, Managed Object match criteria

You can specify the Match criteria in two ways: 

using Managed Object Criteria



using User Class

Using Managed Object Properties to Specify Match Criteria Each MO has a set of properties. You can use those properties in the Match criteria. You must specify at least one property. Example: One of the properties of an MO is isSNMP. This stores the value true if the MO denotes an SNMP object (one that uses SNMP for communication). You can specify one of the match criteria as isSNMP = true. You can specify any number of match criteria. The only limitation is that the Performance module currently supports comparing only String and long (Numeric) values.

548

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 163: To specify a match criteria via Managed Object properties 1.

Select the type of Property to be compared: String or Numeric.

Specify the MO property.

Choose the comparison operator that has to be displayed, based on the type you have chosen.

Specify the value to be compared. For this example, set the following values: String String

isSNMP isNode

equals equals

true true

The default set of MO properties are listed below. You can use these to set the match criteria.

note ............. Your environment can have more properties added to MO, in which case, you must be aware of those new properties: status, type, managed, isGroup, isContainer, isSNMP, isDHCP, isRouter, isNode, isNetwork, isInterface, sysName, sysOID, ifSpeed, ifDescr, ifIndex.

There is a check box beside every Match Criteria row.

Check the check box of each row that you have added.

To remove any match criteria row, select it and click Remove.

Using User Class to Specify Match Criteria When you specify a list of Match Criteria based on MO properties, an implicit AND operation is performed among the results. (If you specify two conditions, both of them must be satisfied for the Managed Object to be considered for data collection). If you want to change this default pattern, you can write your own class and refer to it in the User Class property. For example, you may want to specify that only if either of the two conditions is satisfied, the MO for data collection should be considered. The next step is to define what is to be collected from the device. note ............. Writing your own Java user classes is not a supported WM feature. The existing managed object classes for supported devices are available from Technical Support. See Contacting Support Representatives on Page 758.

Defining Data to Be Collected via SNMP After you have decided for which Managed Objects (MOs) to collect data, you must choose the type of data to be collected and the location. Data from the MO can be accessed from its agent. An agent is a program running on a device that awaits a data collection request. When a request is made to the agent for a particular data, the corresponding OID (Object Identifier—a unique identification number) must be specified. An OID uniquely identifies a specific characteristic of the Managed MO. In order to collect the data, you must specify the OID for that characteristic. The term OID is generically used as data identifier. OID is SNMP‐specific term. The list of OIDs can be retrieved from the MIB definition of the device. A MIB is a logical database made up of the configuration, status, and statistical information stored in a device. Use the MIB Browser tool bundled with WM product. Load the MIB of the device from which you want to collect data, then find the OIDs in it for which you want to collect data.

549

Issue 3 May 2012

WM Release 4.0 User Guide

By default, the Performance module uses SNMP for data collection and RFC1213 MIB Standards for OIDs. Alternatively, you can use your own protocol and select OIDs from various MIBs. In particular, the devices supported by WM have their own MIBs in addition to supporting large portions of the RFC1213 MIB for basic fields. note ............. The WM interface refers to an OID as a Data Identifier.

Selecting the Data Identifier for Data Collection In the Polling Object creation process, proceed to the third screen (click the Next button) of the Poll Details dialog.

Figure 347: Poll Details, Data Configuration parameters

The following tables describe each of the fields available in the Poll Details dialog. All the Data Identifier parameters have some common properties that can be specified in this section.

550

WM Release 4.0 User Guide

Issue 3 May 2012

note ............. The Performance Client allows you to specify only two common properties, Prefix and Polling period. You can set other properties common to all polled data for a given polling object by editing the configuration file that governs polling objects: polling.conf in the server/conf directory in the server.

Table 75: Common parameters Property

Description Data Identifiers are generally lengthy. For the identifiers that have in common the starting n digits, you can specify that as prefix.

Prefix

Example: Assume two Statistics, IfSpeed and IfinOctect. The corresponding Data identifiers are .1.3.6.1.2.1.2.2.1.5.1 and .1.3.6.1.2.1.2.2.1.10.1. You can specify the common prefix as .1.3.6.1.2.1.2.2.1. In the case of RFC 1213 MIB, even if the prefix is not specified, the Performance module will internally add a prefix to the identifier. The time interval for periodic data collection.

Polling Period

Example: If set to 5, it indicates that for all the Data Identifiers, data will be collected once in every 5 seconds. Default value: 300 seconds

551

Issue 3 May 2012

WM Release 4.0 User Guide

Table 76: Common Data Identifier properties Property

Description

Data Identifier

A unique Object Identifier string that represents a MIB entry. Data is collected for this identifier. An SNMP‐specific Data identifier is called OID. This input is mandatory. Example: 2.2.1.16.1 refers to IfOutOctects interface of instance 1. This can be set to interface, node, multiple, or none. Node: If you know the fully qualified OID to collect data then you can set the type as Node. Example: If you want to collect data for ifInOctets, instance 1 then choose this type and specify the data identifier as .1.3.6.1.2.1.2.2.1.10.1 Interface: This type has been exclusively made available only for IF table entries of RFC 1213 MIB. This is used when the object has many instances. When you want to collect data for all the instances of an object, you can choose the type to be Interface. Enter the Data Identifier as .1.3.6.1.2.1.2.2.1.10. For every instance of the object, a PolledData is be created.

Type

Multiple: If you do not know how many instances exist for the OID then this type can be used to collect data for all the instances. As Interface type is specific to IF table entries, for other OIDs that have multiple instance, you can choose the type as Multiple. Only one PolledData will be created for the specified OID but data collection will be done for all the instances. caution……….. Do not terminate the OID with a dot. If you do so, it will be treated as an invalid OID and data will not be collected for it. note………...This is used when other protocols are used for data collection apart from SNMP.

Default value: None Name

Any meaningful string for the Data Identifier. It is mandatory.

Protocol

Specify the protocol used – SNMP, etc. If no value is specified, default protocol SNMP is set. The interval for periodic data collection. Example: If set to 2, it indicates that for all the Data Identifiers, data will be collected once in every 2 seconds. Default value: 300 seconds.

Interval

Case 1: If polling period (common property) and interval are specified then interval value will take precedence. Case 2: If polling period is specified but no interval, then polling period will be taken as interval. Case 3: If neither polling period nor interval is specified, then default value (300 seconds) will be taken.

Threshold

552

To apply Threshold on the Data Identifier, select (check) this option. Default value: False

WM Release 4.0 User Guide

Issue 3 May 2012

Property

Store Data

Description Sometimes, you may wish not to store the data collected for the Data Identifier. If this is the case, you can view the data only by Real Time monitoring using Current Statistic Graph. To specify that you do not want to store the collected data, clear (uncheck) this check box. Default value: True (Checked) If the Collected data is of data type Long then it will be stored in STATSDATA table. The table will have the name and current date appended to it. Example: If today's date is August 10, 2003 then the table name will be STATSDATA8_10_2003. If you do not specify any input for this property, this will be the default behavior. But if you want to store data in some other table and not in default STATSDATA then you can specify it in this field. Example: MyTable.

Stats Data Table Name

caution……….. The table name you specify here must be already available with its structure defined.

You have to append a percentage symbol (%) to the table name, such as %MyTable%. This enables one table creation per day with the current date appended to the table name. If you do not specify the % symbol, no new table will be created each day and data collected everyday will be appended to the same table MyTable. This results in a voluminous table after some days. The default tables used by the default polling objects provided with WM use a separate table for each day. If the Collected data is of data type String then it will be stored in STRINGDATA table. The table will have the name and current date appended to it. Example: If today's date is August 10, 2003 then the table name will be STRINGDATA8_10_2003. If you do not specify any input for this property , then this will be the default behavior. String Data Table Name

But if you want to store data in some other table and not in default STRINGDATA then you can specify it in this field. Example: StringMyTable. caution……….. The table name you specify here must be already available with its structure defined.

The concept of appending % symbol holds good for STRINGDATA table also. For more information, refer to the explanation for the field Stats Data Table Name. Failure Threshold

Property

This option is applicable only for Counter type OIDs. By default, data collected for Counter type OIDs is not stored as it is. The difference between the previous data and latest data is collected and stored. If the exact value (absolute value) of collected data Save Absolutes has to be stored for Counter type OIDs then this check box should be checked. Data collected for OIDs of other data types are saved as absolute values. Default value: False

553

Issue 3 May 2012

WM Release 4.0 User Guide

Property

Time Average

Description If this option is selected (check), the time average is calculated as (Latest collected value + Previous value ) / Difference in Data collection Time value. This is mostly calculated for Counter type and Gauge type Data identifiers where the data collected will be an incremental value and at one point will reach the final value and reset to Zero. As this reset may happen soon and very often, it is preferred that a Delta value is derived from two consecutive polls. Default value: false If this option is not selected (uncheck), data collection will be temporarily stopped for this Data Identifier. To resume data collection you will have to select this field.

Active

Default value: True (checked) Specify a number (n) which indicates a count i.e., only after n number of polls, data will Save Poll count be stored in the database. This is used when you feel the initial set of data collected for the Data Identifier is unstable and may not be a correct measure of performance. OID Default value: 1 Save On Threshold

Available Thresholds

If this option is selected (check), it indicates that the collected data should be saved only when it exceeds threshold. Default value: false (uncheck) This provides a list of Thresholds. Choose one at a time and a comma separated list displayed. Limitation: You cannot associate thresholds specific to an instance of multiple Polled Data created using this user interface. Therefore, after creating the Polled Data, set the thresholds to the instances via Modify Statistics UI.

note ............. The SNMP version and the authentication information used for polling is taken from the individual device (MO) for which polling is performed..

For every Data Identifier you add, click Apply. It is added to the list in the left panel of the Poll Details window. To modify or delete any Data Identifier, select it from the list and click Modify or Delete respectively. After you have added all the Data Identifiers, click Apply in the Polling Objects dialog. This adds the Polling Object definition to the database. You can see the Data Identifier and Statistic Name in the Configured Collection panel for those hosts for which the match criteria are satisfied. An example of the Configured Collection view is shown in Figure 140 on Page 203.

Specifying Expressions Using OIDs Using arithmetic operators and existing Data Identifier values, you can build an expression; for example .1.3.6.1.2.1.2.2.1.10.1 + .1.3.6.1.2.1.2.2.1.16.1 ) / 2.

554

WM Release 4.0 User Guide

Issue 3 May 2012

This example expression means an average of data collected for the instances of IfInOctets and IfOutOctets. When you do so, data is collected for each Data Identifier involved in the expression and the resultant value is calculated based on the expression. The following are specific requirements for parameters:

17.1.4



You can create expressions using only Data Identifier values for which Long (Numeric) type data is collected. String OIDs cannot be used.



Only the added value is stored in STATSDATA table, and not the individual OID values.



When you specify an expression OID, specify the entire Data Identifier along with the prefix. Do not separately specify the prefix.



Operators such as + (addition), – (subtraction), * (multiplication), / (division), % (remainder), &gt; (right shift), &lt; (left shift), : (bitwise AND), | (bitwise OR), ^ (exclusive OR), min(a,b) and max (x,y) can be used.



min(oid 1, oid2), min(value1, value2) and max(oid1,min(oid2,oid3)) are valid expressions.



Specifying $DELTA_TIME is supported as a replaceable parameter; for example, if you create a Polled Data with an expression OID, such as (2.2.1.4.1 * $DELTA_TIME), then the value collected for this expression is the value retrieved for the OID 2.2.1.4.1 multiplied by the difference of the time between the current poll and previous poll of this poll data.

Modifying a Polling Object WM allows you to 

disable or deactivate the Polling Object. Doing this will stop data collection for all the associated PolledData.



modify an existing Data Identifier associated with the Polling Object, if you need to modify some properties like period of data collection, active state, or threshold list.



add a new Data Identifier to the Polling object.

caution............... If you edit or change one of the default polling objects that is installed with WM, undesirable system behavior may result. Please contact Cambium Technical Support before editing/deleting polling objects in WM. See Contacting Support Representatives on Page 758.

Procedure 164: To modify a Polling Object 1.

In the Applications tree, select PerformanceConfigured Collection.

From the main menu, select ActionsPolling ObjectsModify Polling Object. The Poll Details wizard is displayed.

In the left panel, select the Polling Object that you want to modify.

Click Modify. The General Properties frame includes the Polling Object (as read only) and has changed the Status and Update Managed Objects check boxes to read‐write.

555

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 348: Polled Details dialog, General Properties frame, active fields

In the right panel, modify the Status, if required.

Update Managed Objects is available as check box. When this is checked, it specifies that the Polling Object's definition will be applied over existing Managed Objects, and they will be updated with information given in Polling Objects. Essentially, this check box makes your change retroactive, to affect all devices previously discovered that use the polling object that is being modified. For more information, refer to Creating a Polling Object on Page 546.

Click the Next button.

note ............. You cannot edit the match criteria set for a Polling Object. This includes both Managed Object Criteria and User Class settings.

556

Click the Next button again. The Data Configuration panel opens in the right frame.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 349: Poll Details dialog, Data Configuration panel

From the Data Identifiers section, select the Data Identifier to be modified.

tip ................ This will make the selection easier. Laterally scroll the Data Identifiers block view all the way to the right. If you are at all uncertain of the OID, find it in the Data Identifier column of the Configured Collection view. Then click the OID in the Data Identifiers block of this Poll Details window and observe the read-only Name field contents to the right. Ensure that you have selected the intended statistic. note ............. At the bottom of the window, two rows of buttons, some of which are active, are provided. The upper row applies to the current frame, and the lower row persists through all frames of this window.

10. In the upper row of buttons, click Modify. Many of the fields in the right panel become editable. 11. Make appropriate changes as required. For information on each of the fields, refer to Defining Data to Be Collected via SNMP on Page 549. 12. When the modifications are done, click Apply in the upper row of buttons to apply the changes to the database. 13. In the lower row of buttons, click Apply. 14. Dismiss the Poll Details window.

557

Issue 3 May 2012

17.1.5

WM Release 4.0 User Guide

Deleting a Polling Object You can delete a Polling Object permanently from the system if you have decided not to perform data collection for certain devices any longer. caution............... This procedure will remove the Polling Object and the Data Identifiers and statistics from the hosts whose device type you specify as the Polling Object. Ensure that this is intended. If you delete one of the default polling objects that is installed with WM, undesirable system behavior may result. Contact Cambium Technical Support before you edit or delete a polling object. See Contacting Support Representatives on Page 758.

Procedure 165: To delete a Polling Object 1.

In the Applications tree, select PerformanceConfigured Collection.

From the main menu, select ActionsPolling ObjectsDelete Polling Objects. The Poll Details wizard is displayed.

Figure 350: Poll Details dialog for Delete Polling Object operation

558

In the left panel, click to highlight the Polling Object that you want to delete.

Click the Delete button. A confirmation is asked.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 351: Confirm Deletion pop-up

Click Yes to delete the Polling Object.

On performing this procedure, the Polling Object and the Data Identifiers and statistics that were added via the Polling Object are removed from the hosts that have the targeted device type.

17.2

Administering Individual Statistics If you want to monitor extra data that is not accounted for in the Configured Collection for a particular device type, you can add a new Statistic to the system by either of the following two methods:

17.2.1



modifying an existing Polling Object (see Modifying a Polling Object on Page 555).



using the Add Statistics option (see Adding a Statistic below). This method is preferred.

Adding a Statistic When you need to add a Statistic for a few nodes, the best way is to use the Add Statistics option. note ............. For most devices, all possible performance data statistics are already polled by default. Either look for the desired statistic in the Configured Collection view before you try to add it as a new statistic or consult Cambium Technical Support to get help with your performance data configuration. See Contacting Support Representatives on Page 758.

Procedure 166: To add statistics at runtime 1.

In the Applications tree, select PerformanceConfigured Collection.

From the main menu, select EditAdd Statistic (or press Ctrl+N). The Object Details dialog is displayed.

559

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 352: DataCollection Detailed Properties dialog, first form

Configure the appropriate fields of the first of two forms. The following table describes each of the fields.

Table 77: DataCollection Detailed Properties fields, first form Property Name

Description Any meaningful string for the Data Identifier. It is a mandatory field. Ordinarily this is the display name of an SNMP MIB attribute. One of the three SNMP versions – VI , V2 or V3. If you choose V3, two more fields labeled User Name and Context Name are available. They are required for authorizing SNMPv3 data collection. For information on configuring security parameters, refer to SNMPV3 Security Configuration topic.

Snmp Version

If the SNMP agent resides in a proxy implementation environment, it can be accessed via a proxy agent. The SNMP agent, then, has to be identified by a unique value called contextEngineID. This value has to be set as a user property for the Statistic. Default value: v1 All SNMP information (such as version, community, and port) must match the device's settings; otherwise, the statistic is not successfully polled. Ordinarily, discovery sets up the SNMP authentication for each statistic that WM is preconfigured to automatically provide.

560

WM Release 4.0 User Guide

Issue 3 May 2012

Property

Community

Description Specify the string using which the devices are identified in a network. Most of the equipment vendors set the Community value as public for their devices. In such case, specify this field as public. Otherwise, you need to check the string used for the particular device.

Write Community Specify the SNMP string that will authenticate WM to manage the device.

Agent

Normally, a device will have one agent in it to collect device data, where device name and agent name will be same. Because of the same naming situation, you can specify the device name as agent name. The device name is the name that is displayed in the Hosts column of the PerformanceConfigured Collection view. note…………If you are adding Statistic via UI, ensure that agent name and DNS name are set.

Port

Specify the port number to which Wireless Manager can send the request for data collection. Default SNMP agent port is 161. If no value is specified, the default port 161 is set when PolledData is created. If multiple agents are running in the same device, they have to be differentiated by different port numbers.

OID

Active

A unique Object Identifier string that represents a MIB entry. Data is collected for this identifier. An SNMP‐specific Data identifier is called OID. For example, 2.2.1.16.1 refers to IfInOctects interface instance 1. You can also specify an expression OID. This input is mandatory. If you do not select (uncheck) this option, data collection will not start for this OID. Default value: True (checked) The time interval for periodic data collection. Example: If set to 2, it indicates that for all the Data Identifiers, data will be collected once in every 2 seconds. Default value: 900 seconds

Period

You can configure the minimum period so that the period cannot be set for a Statistic less than the minimum period. This can be done by setting the property MIN‐PERIOD in Tree.xml located in the /usr/local/cambium/wm/server/users/root directory in Linux (or the C:\Cambium\WM\server\users\root folder in Windows) for the entry MODULE‐NAME = "Stats Admin". Example: MIN‐PERIOD = "200". note…………If you enter the period less than the minimum period set, an error message will be displayed.

To apply threshold on this Statistics, select (check) this field Threshold

Default value: False (unchecked) The list of Thresholds can be specified in the text box labeled Threshold List.

561

Issue 3 May 2012

WM Release 4.0 User Guide

Property

Description Specify the DNS name of the device from which the data must be collected. Typically, this is the IP address. The DNS name is displayed in the IP Address column of the Inventory view. You can also find the correct DNS name to use by looking at other statistics for the device to which you are adding new statistics.

DNS Name

If this option is not selected, data will be collected but will not be stored in the database.

Save

Default value: True (Checked)

Save Absolutes

This option is applicable only for Counter type OIDs. By default, data collected for Counter type OIDs is not stored as it is. The difference between the previous data and latest data is collected and stored. If the exact value (absolute value) of collected data has to be stored for Counter type OIDs then this option should be selected (checked). Data collected for OIDs of other data types is saved as absolute values. Default value: False To store the collected data in flat files rather than storing them in database, select this option.

Log Directly

Default value: false (unchecked) You can set the log filename in the text box labeled Log file.

562

When you are finished with the first form, click the Next button. The second form is displayed.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 353: DataCollection Detailed Properties dialog, second form

Configure the appropriate fields on the second form. The following table describes these fields.

Table 78: DataCollection Detailed Properties fields, second form Property

Description

Log file

Specify the log filename with full path (location on hard disk where the log file has to be stored).

Parent Obj

Specify the name of the Managed Object which acts as the parent for this Statistic. This is the Name (ID), or first, column entry in the Inventory view. You can also find the correct name to use by looking at other statistics for the device to which you are adding new statistics.

563

Issue 3 May 2012

WM Release 4.0 User Guide

Property

Description Specify the name of the Thresholds as comma‐separated values thus associating them with this Statistic for monitoring data collection. note…………Performance data thresholds must be defined before you add them to this list. See Associating Thresholds With Statistics and Network Elements on Page 569.

Threshold List

In case of multiple Polled Data, if you need to associate Thresholds specific to the instances then specify the association as follows: <instance number>=thresholdname1,thresholdname2, ....: <instance number>=thresholdname1,thresholdname2, .... Example: .1=th1,th2:.2=th1,th3 The specified list of Thresholds will be applied on the Statistic only when Threshold property is true.

Current save count

This is used for internal purpose.

Protocol

Specify the protocol used for data collection ‐ SNMP, etc. When no value is set, default protocol SNMP is assumed for data collection.

Poller Name

Specify a string value which is matched with agent's list of users who are authorized to collect data from it. This field is displayed only when Snmp Version is selected as V3. If the Collected data is of data type Long, it will be stored in STATSDATA table. The table will have the name and current date appended to it. Example: If today's date is Aug 10, 2003 then the table name will be STATSDATA8_10_2003. If you do not specify any input for this property, this will be the default behavior. If you want to store data in some other table other than the default STATSDATA, specify it in this field. Example: MyTable.

Statsdata Table Name

Append a percentage symbol (%) to the table name, such as MyTable%. This enables one table creation per day with the current date appended to the table name. If you do not specify the % symbol, new table is not created and data collected everyday will be appended to the same table MyTable. This results in a voluminous table after some days. It is recommended to have separate tables for each day. caution……….The table name which you specify here must be already available in the database.

Save PollCount

Specify an integer (n). During every nth Poll, the collected data will be stored. Example: If you specify 2, it indicates that for every alternate polling the collected data is stored, i.e., 2nd poll, 4th poll, and so on. Default value: 1

564

WM Release 4.0 User Guide

Property

Issue 3 May 2012 Description

This indicates the number of consecutive failures after which the threshold event should be generated. For some thresholds, a single violation is insufficient to generate an event.

Failure Threshold

Example: Assume the OID has a threshold associated and it is predicted that the data collected can be cross‐checked 3 times. If the collected value still exceeds the Threshold value then corresponding Threshold event will be generated. Default value: 0 If there are more than one Threshold associated with the Data identifier, then the collected data has to exceed the same threshold consecutively n times as specified in this field. Only then the Threshold Event will be generated.

Is multiple PolledData

Select this option if Data Identifier is of type multiple. Possible values are true and false. If set true, the collected data is saved only when it exceeds threshold.

Save On Threshold

Default value: false

Owner name

Specify a string to denote the owner of the Statistic. If this option is selected (checked) the Time Average is calculated as (Latest collected value ‐ Previous value ) / Difference in Data collection Time value. This is mostly calculated for Counter type OIDs where the collected data will be an incremental value and at one point will reach the final value and reset to Zero. As this reset may happen soon and very often, it is preferred that a Delta value is derived from two consecutive Polls.

Time Avg

Default value: false

When you have finished configuring the properties, click the Add button.

In the Configured Collection panel, you can view the added Statistic that you have just created for the device type.

17.2.2

Finding a Statistic The client includes a utility for quickly finding a statistic based on strings that constitute a portion of any of the following data that the system is storing for a given statistic:

565

Issue 3 May 2012

WM Release 4.0 User Guide

Procedure 167: To find a statistic 1.

In the Applications tree, click on PerformanceConfigured Collection. This opens a Configuration Templates view in the right panel, listing all that are currently defined.

From the main menu, select EditSearch. A special Search window opens to configure for matches against any of the tabular data that WM is displaying in the Configured Collection window, including that which is viewable only by scrolling.

Figure 354: Search window for statistic criteria

17.2.3

Modifying a Statistic WM is preconfigured to collect practically all performance data statistics that all supported devices provide. In rare cases, it can be desirable to change the polling interval of a predefined statistic, or to disable it. Editing other fields may produce undesirable results.

Procedure 168: To modify an existing Statistic

566

In the Applications tree, select PerformanceConfigured Collection.

In the Hosts list in the left panel of the Configured Collection view, select the device for which you want to modify a statistic.

Select the Statistic in the Configured Collection panel.

WM Release 4.0 User Guide

Issue 3 May 2012

Do one of the following: ◦

From the main menu, select EditModify Statistic.

◦

Press Ctrl+Shift+M.

◦

Double‐click on the desired statistic.

The ObjectDetails dialog is displayed.

Figure 355: DataCollection Detailed Properties dialog for Modify Statistic operation

Make appropriate changes. Keep in mind that this dialog consists of two forms, connected by Next and Previous buttons. If necessary as you reconfigure various fields, refer to the field documentation provided in Table 77 on Page 560 and Table 78 on Page 563.

note ............. Some properties are not editable because Wireless Manager uses them to internally identify the Statistic.

When you are finished, click the Modify button.

The modifications to the Statistics are immediately applied and are reflected in the Configured Collection view.

17.2.4

Deleting a Statistic caution............... If you want to temporarily stop the data collection for a Statistic, it is not advisable to delete the Statistic. Instead, disable (uncheck) the Active property of the Statistic. Till you enable (check) it again, the data collection will not occur for the Statistic.

567

Issue 3 May 2012

WM Release 4.0 User Guide

Procedure 169: To delete a Statistic

17.3

In the Applications tree, select PerformanceConfigured Collection.

Select the Statistic in the Configured Collection panel.

From the main menu, select EditDelete Statistic (or press Ctrl+Shift+R). A confirmation is asked.

Click Yes to delete the Statistic. User properties associated with the Statistics are automatically deleted.

Administering Extended PolledData WM facilitates creation of Extended PolledData, which contains the basic properties of a PolledData plus some extra properties that are defined specific to operator requirements. Extended PolledData creation is handled by the developer who customizes WM for operator‐specific usage. As an Administrator, you can modify the values of those extra properties of the Extended PolledData object.

17.3.1

Modifying Extended PolledData important ........... WM is preconfigured to collect practically all performance data statistics that all supported devices provide. In rare cases it can be desirable to change the polling interval of a predefined statistic or to disable it. Editing other fields may produce undesirable results.

Procedure 170: To modify the properties of Extended PolledData 1.

In the Applications tree, select PerformanceConfigured Collection.

Select the Statistic in the Configured Collection panel.

From the main menu, select EditModify Statistic (or press Ctrl+Shift+M). The DataCollection Detailed Properties dialog box is displayed.

Click the Next button twice to access the third frame of this dialog.

Click the Additional Props button. The PolledData Additional Properties dialog displays the extra properties of the Extended PolledData object.

caution............... You can modify the only value of these properties. Do not change the name of a property or delete it. If you change the name, then it is treated as a new user property. The old property of Extended PolledData is still retained. Any extra property you add via this dialog is added as a user property. When an Extended PolledData is deleted, its associated user properties are also deleted.

568

WM Release 4.0 User Guide

17.3.2

Issue 3 May 2012

To configure the additional properties, perform the following steps: a.

Click the Additional Props button. The PolledData Additional Properties dialog is displayed.

Specify the property name and its value in the Name and Value field, respectively. Example: Name = Description and Value = Example stat

To add more user properties, click More.

To remove a user property in this dialog, select the property and click Remove.

For fewer rows of properties, click Fewer.

When you have finished configuring additional properties, click OK.

Back in the original dialog, click the Modify button.

Factors for Whether a Statistic is Polled Several factors determine whether a particular performance data statistic is polled for a particular device, and some of these factors take precedence over others. In order of decreasing precedence, the factors are

17.4



Device status (managed/unmanaged): If a device is unmanaged, appearing grey in the Inventory view, then no performance data statistics of any kind are gathered for that device.



Polling object status (active/inactive): If polled data (performance data statistics that WM has been configured to collect) for a device is associated with a polling object that has been modified to be inactive, then that statistic is not polled.



Agent status: Agents of devices are not ordinarily inactivated, but if they are due to a system call, then the performance data statistics of the associated device is not polled.



Polled Data status (active/inactive): If the individual polled data element for a device has been inactivated, then that performance data statistic for that device is not polled.



the general and specific performance polling configurations that are described under Adjusting the Performance Polling Interval on Page 379.

Associating Thresholds With Statistics and Network Elements The System Administration level of permissions is required for adding, mapping, editing, or deleting a threshold or for deleting the mapping of a threshold. A threshold is a value that you associate with a statistic for any of the following: 

a single device



all devices of a specific type



all devices of a device type

A threshold association with a device, specific type, or device type applies when you click the Apply or OK button in the Thresholds and Associations dialog (see Figure 360 on Page 578) and is effective for every subsequent performance poll unless the association is removed.

569

Issue 3 May 2012

WM Release 4.0 User Guide

A threshold specifies a value, type (max, min or equal), what message should be generated when the threshold is exceeded, and at what value should this threshold be reset. A threshold is defined independent of any particular statistic and then put into action by becoming associated with (applying them to) one or more statistics. The number and types of thresholds to set up is provided in Table 79.

Table 79: How many and what type of threshold to add To establish…

first define this number of thresholds via ActionsManage Threshold, then select Add Threshold (Procedure 171 on Page 571)

a bad flash point

one: equal to

an acceptable middle range

two: a max and a min

tiers of degradation

multiple: one for each severity

A defined statistic can be associated with thresholds. A single statistic can have many thresholds indicating various severity such as Critical, Major, Minor. Whenever data is collected for the statistic, it is cross‐checked with the associated thresholds. If the collected value crosses the thresholds, then a threshold message is generated. If multiple thresholds are associated with a statistic, then the collected value is checked with every threshold value. For every threshold value crossed, a separate message is generated. The way to associate a statistic with a threshold is shown in Table 80, along with cross references to the appropriate procedures that follow.

Table 80: Ways to associate statistics with thresholds To threshold a statistic for… a single network element

associate the threshold(s) to the network element(s) via… EditModify Statistic (Procedure 174 on Page 580)

all newly discovered network elements (in the future) of a given specific type or device type

EditPolling ObjectsModify Polling Objects (Procedure 177 on Page 584)

The messages that arise out of thresholds are sent as notifications and can be viewed in the Network Events view. Also, the Alarm Count Panel displays a row of details for alarms generated because of statistics crossing their thresholds. Example: Assume you have a statistic Interface_in_octet for a switch switch‐rj5. For efficient performance of the switch, the value of this statistic must be between 1300 and 1370. This means you should have some notification mechanism to inform you when the statistic value is not within this limit. Let us assume that the thresholds are defined as given below.

570



value = 1320



type = max



threshold message = Has entered violation stage

WM Release 4.0 User Guide

Issue 3 May 2012



reset value = 1319



message = Has entered violation state

When the statistic value is 1320 or greater, the message Has entered violation state is generated as an event. Until the collected value reaches the reset value (1319), the event retains the same severity state. As soon as it reaches the reset value, the threshold is reset and waits for the collected data to cross its limit again. note…………If another threshold exists of lower severity and if the collected data falls within its limits, then that threshold will generate the message (event). If another threshold exists with higher severity, then the higher severity threshold takes precedence, and its message (event) is displayed. The threshold with lower severity loses its importance and no message is generated until the threshold with higher severity reaches its reset state.

You can express a Threshold in terms of a maximum value, a minimum value, and an equal value.

Table 81: Data collection Threshold indicators Value is

Description

max

Collected data greater than this value generates event of Severity.

min

Collected data less than this value generates event of Severity.

equal

Collected data equal to this value generates event of Severity.

The MIB that applies to the device type distinguishes the syntax type of the statistic. The WM Performance module supports thresholds for

17.4.1



long values—the threshold is associated with a Data Identifier for which the collected data is of type long; for example, IfAdminStat or IfOperStat in the RFC 1213 MIB. The value you provide for this threshold is compared to the data collected for the identifier.



string values—the threshold is associated with a Data Identifier for which the collected data is of type string, such as SysDescr. Polled string values are matched against lists of allowed/disallowed values.



percentage values—the threshold is identified with a Data Identifier, typically for which the collected data is of type long, and with a second that is specified as the Object ID and whose data type is also long. For monitoring, WM divides the value of the first OID by the value of the second, then evaluates the result, which is a ratio of the two statistics, against the threshold value.

Adding a Threshold Procedure 171: To add a threshold 1.

In the Applications tree, select PerformanceConfigured Collection.

From the main menu, select ActionsManage Threshold. The Thresholds and Associations dialog opens.

571

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 356: Thresholds and Associations dialog

572

Click the Add Threshold button. The Thresholds Properties dialog opens to its long tab.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 357: Thresholds Properties dialog, long tab

In the Name field, type in a name for the threshold.

Select the type of threshold you want to add (click on the long, string, or percentage tab).

important ........... This step requires you to know the SNMP syntax of the statistic: whether it is a long, string, or percentage. Most numerical values are considered long. Most nonnumerical values are considered strings. In case of doubt, right-click on the statistic and select Plot—Collected Statistic from the drop-down list. If the system returns only a table, then the syntax is string. note ............. The long tab is shown above. The string and percentage tabs are shown below.

573

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 358: Threshold Properties dialog, string tab

574

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 359: Threshold Properties dialog, percentage tab

Specify the desired values for specific threshold parameters. Refer to Table 82 for a description of each field. 3

Table 82: Threshold Properties fields Tab Property

Description long string

Severity (trigger severity)



Category



Threshold Type



Threshold Value

percentage



A string to establish the importance of the event generated when threshold value is crossed. By default, following severity strings have been defined: Critical, Major, Minor, Warning, Clear, Info, and Unknown.



Use “Threshold” unless you have a special purpose for this field.



Whether the threshold is a maximum limit value, a minimum limit value, or a particular value that the statistic has to equal exactly to generate the threshold. The value of the threshold. For example, the value that the gathered statistic is compared to for max/min/equal.

 

The value of the threshold, but here the value is a percentage, so it will range from only zero to 100.

575

Issue 3 May 2012

WM Release 4.0 User Guide

Tab Property

Description long string

Rearm Value

percentage Once the threshold has been crossed, and an alarm generated, you have the option of providing a rearm value such that when values gathered later cross this rearm value, a “clear” event is generated automatically. For example if the threshold is 90 and the rearm is 80, when a statistic is gathered that is over 90, an alarm is generated, but when later polls get values below 80, a clear event is generated and the alarm status of the device is automatically cleared.



 Reset Severity

Allowed Values

same as for long thresholds, but here the value is a percentage, so it will only range from zero to 100.



If the statistic has a value in the “allowed” list and an alarm was previously triggered due to a “disallowed” value, this is the severity of the reset event that’s generated – usually this will be Clear in order to get rid of the alarm.



These values generate a reset if an alarm was triggered. An asterisk can be used as a wildcard. Comma‐separated values are allowed. These values trigger an alarm. An asterisk can be used as a wildcard. Comma‐separated values are allowed. EXAMPLE

Disallowed Values





trigger Severity: Major



Reset Severity: Clear



Message: there is a problem



Clear Message: no more problem



Allowed Values: dog, cat, bird*



Disallowed Values: snake, spider

EXAMPLE RESULTS statistic gathered – “dog” – matches allowed strings ‐ nothing happens statistic gathered – “birdman” – matches allowed strings via wildcard – nothing happens statistic gathered – “snake” – matches disallowed strings – alarm generated with severity Major and message “there is a problem” statistic gathered – “cat” – matches allowed strings – event generated with severity Clear and message “no more problem” – clears the prior alarm and returns device to Clear status

576

WM Release 4.0 User Guide

Issue 3 May 2012 Tab

Property

Description long string

percentage



Object ID

This is an OID in the MIB of the same device/host, that the selected OID will be compared to. The statistic you originally selected to create the threshold, will be compared to (divided by) the statistic fetched via this OID, and the result will be expressed as a percentage, for comparison to the specified threshold value and rearm value. Consequently, the percentage threshold actually references two OIDs, the originally selected OID and the denominator value’s OID as specified in this Object ID field. This is the MIB OID type – typically it will be “node” for an ordinary SNMP MIB OID that returns a long value.

Object ID Type



important……..The type of identifier you choose here should be the same as the identifier on which this Threshold is going to be applied. Otherwise, when division of the two values takes place, an invalid resultant value will be generated.

This is the text message provided and displayed in the event/alarm created when the threshold is crossed.

Message This is the message in the triggered alarm created when the statistic value matches one of the Disallowed Values.

 Clear Message

Send Clear

  

17.4.2



If a rearm value is specified and a clear event is generated, this will be the message in that event. This is the message in the event generated by a reset.



If true, a clear event will be generated when the rearm value/threshold is crossed.

Click Add. The configured threshold is created.

Preparing to Map a Threshold Procedure 172: To prepare to map a threshold 1.

In the Applications tree, select PerformanceConfigured Collection.

From the main menu, select ActionsManage Threshold. The Thresholds and Associations dialog opens. (See Figure 356 on Page 572.)

Click the Add Mapping button. The interface adds a blank row to the bottom of the Associations table.

577

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 360: New association row added to Thresholds and Associations interface

17.4.3

Click in the Scope column of the new row.

Mapping a Threshold for an Individual Device Procedure 173: To map a threshold for an individual device 1.

Perform Procedure 172: To prepare to map a threshold on Page 577.

From the drop‐down list in the Scope cell, select Individual.

Double‐click the Name/Type cell in the same row. The Search Devices dialog opens.

Figure 361: Search Devices dialog

578

In the text box at the top of this dialog, key in a string that matches a portion of the Device Name, Name(ID), IP Address, or Location of the desired device. The system returns matches in the display panel.

WM Release 4.0 User Guide

Click to highlight the name of the desired device.

Click OK.

Click the cell in the Agents column at the same row.

From the drop‐down list, select the SNMP agent type.

Click the cell in the Statistic Name column at the same row.

Issue 3 May 2012

10. From the drop‐down list, select the Statistic Name. Only a single selection is supported.

11. Click the cell in the Threshold Name column at the same row. 12. From the drop‐down list, select the Threshold Name. Only a single selection is supported. 13. Click the Apply button. 14. Click OK.

579

Issue 3 May 2012

17.4.4

WM Release 4.0 User Guide

Associating a Threshold with a Statistic for an Individual Device Procedure 174: To add thresholds to a statistic 1.

In the Applications tree, select PerformanceConfigured Collection.

In the Hosts column, click to select the network element to which to apply the threshold.

In the Statistic Name column, click to select a Statistic.

From the main menu, select EditModify Statistic.

Figure 362: DataCollection Detailed Properties dialog, first set of properties

580

Check the check box of the threshold field. This enables thresholds to be actively applied to the statistic.

Click the Next button.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 363: DataCollection Detailed Properties, second set of properties

In the thresholdList field, specify the threshold name. This field specifies one or more thresholds, separated by commas, all of which will be applied to the statistic.

Click the Next button.

581

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 364: Data Collection Detailed Properties, third set of values

Click Modify.

Once you associate the threshold with the statistic, monitoring will be carried out for any data collected for that statistic. tip ................ After adding a list of thresholds to a statistic, if you do not want to monitor the collected data for a while, clear (uncheck) the Threshold field. This temporarily stops applying thresholds on the statistic.

17.4.5

Mapping a Threshold for a Specific Type Device Procedure 175: To map a threshold for a specific type device

582

Perform Procedure 172: To prepare to map a threshold on Page 577.

From the drop‐down list in the Scope cell, select Specific Type.

Double‐click the Name/Type cell in the same row. The Search specific type dialog opens.

In the text box at the top of this dialog, key in a string that matches a portion of the specific type name. The system returns matches in the display panel.

Click to highlight the name of the specific type.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 365:Search specific type dialog, specific type selected

Click OK.

Click the cell in the Agents column at the same row.

From the drop‐down list, select the SNMP agent type.

Click the cell in the Statistic Name column at the same row.

10. From the drop‐down list, select the Statistic Name. Only a single selection is supported. 11. Click the cell in the Threshold Name column at the same row. 12. From the drop‐down list, select the Threshold Name. Only a single selection is supported. 13. Click the Apply button. 14. Click OK.

17.4.6

Mapping a Threshold for a Device Type Procedure 176: To map a threshold for a device type 1.

Perform Procedure 172: To prepare to map a threshold on Page 577.

From the drop‐down list in the Scope cell, select Device Type.

Double‐click the Name/Type cell in the same row. The Search specific type dialog opens.

In the text box at the top of this dialog, key in a string that matches a portion of the device type name. The system returns matches in the display panel.

Click to highlight the name of the device type.

583

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 366: Search specific type dialog, device type selected

Click OK.

Click the cell in the Agents column at the same row.

From the drop‐down list, select the SNMP agent type.

Click the cell in the Statistic Name column at the same row.

17.4.7

Associating One or More Thresholds with a Polling Object for a Device Type important ........... This procedure will set up monitoring for only elements that are yet to be discovered. It does not set up monitoring for those that will be rediscovered before any new discovery on them occurs. This is because new discovery is the operation in which performance data collection is defined for a network element. The only way to trigger new discovery is to delete the device entirely (see Deleting an Object and Traces on Page 261) and then discover it. This is different from rediscovery of a device that is already in the Inventory view.

Procedure 177: To associate thresholds with a Polling Object for a device type

584

In the Applications tree, select PerformanceConfigured Collection.

From the main menu, select ActionsPolling ObjectsModify Polling Objects. The Poll Details dialog is displayed.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 367: Poll Details dialog

In the left panel, click to highlight the desired device type and agent. (Each polling object is named after its specific type and agent, separated by hyphen).

At the bottom of this window, click the Modify button. The Polling Object Name read‐only field populates with the selected device type, and the Modify button grays out.

Click the Next button twice to advance to the Data Configuration panel.

585

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 368: Poll Details dialog, Data Configuration panel with read-only fields

In the block of Data Identifiers, which contains all of the OIDs that the device type supports, scroll to select the statistic whose threshold you want to monitor.

586

WM Release 4.0 User Guide

Issue 3 May 2012

In the upper row of buttons, click Modify. Many fields in the right panel become editable, and first four fields are pre‐populated based on your selection. The first three are read only.

587

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 369: Poll Details dialog, Data Configuration panel with read-write fields

Check the check box for the Threshold field.

At the last field in the list, Available Thresholds, click the ellipsis ( ). This exposes the names of the available thresholds in a drop‐down list.

10. Click and drag the left edge of the window to enlarge the Available Thresholds box so that you can read the full names of the thresholds. 11. From the Available Thresholds drop‐down box, select the desired threshold. Multiple Thresholds can be configured by selecting them one by one, using Ctrl+Click:

12. To apply your changes to the selected polled data element (corresponding to one performance data statistic), in the upper row of buttons, click Apply.

588

WM Release 4.0 User Guide

Issue 3 May 2012

13. To apply your changes to the polling object (including all changes to any polled data elements within that polling object), in the lower row of buttons, click Apply. The General Properties frame re‐opens in the Polled Details window. The threshold(s) will be applied to all newly discovered elements of the specified device type.

Figure 370: Poll Details dialog, General Properties panel

14. Dismiss the Poll Details window.

17.4.8

Modifying a Threshold Procedure 178: To modify a threshold 1.

In the Applications tree, select PerformanceConfigured Collection.

Select the Statistic on the right‐side Configured Collection panel.

From the main menu, select ActionsManage Threshold.

Click the Edit a threshold button. The Threshold Properties dialog opens, if a threshold exists for the selected statistic.

In the left panel, click the name of the template that you want to modify.

589

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 371: Threshold Properties dialog for Modify operation

17.4.9

In the right panel, make appropriate changes. For information on any of the fields, refer to Table 82 on Page 575.

When you are finished reconfiguring the threshold, click the Modify button.

Deleting a Threshold Procedure 179: To delete a threshold

590

In the Applications tree, select PerformanceConfigured Collection.

Select the Statistic on the right‐side Configured Collection panel.

From the main menu, select ActionsManage Threshold.

Click the Delete a threshold button.

In the left panel, click to highlight the threshold that you want to delete.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 372: Threshold Properties dialog for Delete operation

17.4.10

In the right panel, review the contents to ensure that this is the threshold that you intend to delete.

If it is, click the Delete button.

Example Strategy for Choosing and Applying Thresholds Procedure 180: To create a threshold for a device 1.

Identify the statistic.

Establish baseline values, based on polling via the MIB Browser.

After a week, review the polled data to determine what values are normal for your router.

Use the normal values to determine what the highest acceptable values or thresholds are.

Set your thresholds 10‐20 percent larger than the maximum values.

Either uniformly apply the Threshold values across all devices of the same specific type or customize them for groups of devices that have similar characteristics such as core, distribution, and access.

Log all threshold values and reviewing them daily.

Investigate repeated threshold violations to distinguish whether the problem can be corrected or the Threshold value is too low.

Decide on appropriate notifications for threshold violations. Since violations are not considered hard errors, immediate notification is unnecessary.

591

Issue 3 May 2012

17.4.11

WM Release 4.0 User Guide

Interpreting Messages on Multiple Thresholds for a Single Statistic Multiple thresholds may be associated with a single statistic. This allows for a graded response to unacceptable variations in statistics. The Performance module handles multiple thresholds for a single Statistic as follows:

17.5



Until a threshold reaches its reset value, it remains in its severity state. As soon as it reaches the reset value, the threshold is reset and waits for the collected data to cross its limit again.



If another threshold exists of lower severity, and if the collected data falls within its limits, then that threshold generates the message.



If a threshold exists with higher severity, then the higher severity threshold takes precedence, and its message is displayed. The threshold with lower severity loses its importance, and an event is not generated until the threshold with higher severity reaches its reset state.

Defining a Performance Custom View You can configure an unlimited number of custom views of performance configured collection data. These views are filters, which display a subset of the entries in the unfiltered (default) view. Their primary use is to avoid searching for entries that are related in some way. They are not static, but rather are updated as new data becomes available in the system, even while you are examining the view. Whenever the front view in the frame is Configured Collection, WM opens a performance criteria dialog in response to selection of ViewCustom ViewsAdd Custom View from the main menu. This dialog has three forms in the Properties tab. See Figure 373.

592

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 373: Performance custom view criteria, Properties tab, first form

The meanings of these fields are as follows. note ............. All fields, except the filter view name and parent name, are optional. Select the fields you want to match and type in the desired values.

Table 83: Performance custom view criteria fields, first form Field

Description Specify any of the following values to view only those statistics for which data collection is taking place.

active

true – Displays those statistics for which data collection is enabled. false – Displays those statistics for which data collection is disabled. All – Displays all statistics irrespective of their active state whether enabled or disabled. Specify the agent's name.

agent

community

Example: If agent name is specified as 'Node1agent', then only statistics for which data is collected from that agent is displayed. Specify the community string of the corresponding agent associated with the type of managed devices.

593

Issue 3 May 2012

WM Release 4.0 User Guide

Field

currentSaveCount

dnsName

Description This keeps track of the number of polls that occurred after the last save. For example, if savePollCount is set to 3, the collected data is saved only after the third poll (the collected data from the first 2 polls is ignored). Specify the host (node) based on which you need the statistics to be displayed. This is the entry in the IP Address column of the Inventory view. Example: If the dnsName is specified as 'test‐machine', then all statistics pertaining to 'test‐machine' are displayed. Specify the failure count (numeric value)

failureCount

Example: If failure count is set as 2, all statistics whose Failure count have been set as 2 are displayed.

failureThreshold

Specify save failure threshold value (numeric value). All statistics with the specified failure threshold value is displayed.

Filter View Name

Specify name for the custom view you are creating or modifying. If no value is specified in this field, default values, such as Configured Collection0, Configured Collection1, Configured Collection2 are created. This name will appear in the Applications tree, under the PerformanceConfigured Collection node.

groupName

This attribute is unused. Formerly, it specified the group based on which the statistics are to be filtered.

Specify the Poll ID. Specify the type used to poll columnar value of the tables.

isMultiplePolledData

true – Displays only those statistics which are of type multiple PolledData. false – Displays statistics other than multiple PolledData. All – Displays all statistics irrespective of their type (node, interface, multiple).

lastCounterValue

Specify a numeric value. Those statistics (counter type OIDs only.) whose last collected value equals the value specified is displayed. Possible values are:

logDirectly

All ‐ Displays all statistics irrespective of the value in this property i.e. Log Directly. true ‐ Displays those statistics for which collected data is stored in flat files. false ‐ Displays those statistics for which collected data is not stored in flat files.

logFile

Specify a log filename (string), based on which the statistics is to be displayed. Choose the parent tree node under which your custom view has to be placed in the tree from the drop‐down box.

ParentName

594

The criteria set for the parent custom view will automatically be used for child custom view. Hence, it is enough to specify only additional criteria for the child custom view.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 374: Performance custom view criteria, Properties tab, second form

The meanings of these fields are as follows.

Table 84: Performance custom view criteria fields, second form Field

Description Specify the name of the statistic.

name

Example: If the statistic name is specified as 'Interface_in_octets', then only devices with the that statistic are displayed in the custom view. Tip: Specify multiple statistic names as comma separated values. Example: Interface_in_octets,Interface_out_octets

numericType

Specify the type of collected data (whether it is of type long or string). Possible values are 1 ‐ Retrieves Statistic of Long type and 2 ‐ Retrieves Statistic of String type.

oid

Specify the object identifier as reported by the SNMP agent.

ownerName

A string to denote the owner of the statistic.

parentObj

Specify the name of the Managed Object whose statistics you want to display.

595

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description Specify the polling interval.

period

Example: If period is specified as '2', then the statistics that have been scheduled for data collection with 2 seconds as interval are displayed.

policyName

Specify the name of the PollingObject that controls this PolledData.

pollerName

By default this field will contain an empty string. You may specify the name of a remote poller responsible for collecting data via this poller, but for use only when distributed pollers are used.

port

Specify the port number to which the agent is listening for data collection requests. Default SNMP agent port is 161.

previousSeverity

Specify the last severity level (in numerical) that the Statistic had reached when threshold was applied on it. Possible values are, 1 for Critical, 2 for Major, 3 for Minor, 4 for Warning, 5 for Clear, 6 for Info, 0 for Unknown. Example: If 2 is specified, those statistics whose last severity level was Major when threshold was applied on it are displayed.

protocol

Specify the name of a protocol. Example: SNMP, TL1 Possible values are:

save

All ‐ Displays all the statistics irrespective of their saved state. true ‐ Displays only those statistics whose collected data is saved in the database. false ‐ Displays only those statistics whose collected data is not saved in the database. Possible values are:

saveAbsolutes

true ‐ Displays those Counter type statistics for which the absolute value of the collected data is stored in the database. false ‐ Displays those Counter type statistics for which the differential value between the latest and previous collected data is stored in the database. Note: The saveAbsolutes can be set only for Counter type OIDs.

596

saveOnThreshold

Possible values are true or false. true indicates that the collected data is saved only when it exceeds threshold. The default value is false.

savePollCount

Specify save poll count (numeric value). All statistics with the specified save poll count are displayed.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 375: Performance custom view criteria, Properties tab, third form

The meanings of these fields are as follows.

Table 85: Performance custom view criteria fields, third form Field snmpVersion

Description Specify SNMP agent's version, such as v1, v2, v3 from which data is collected.

If you have customized tables (defined your own tables) for storing collected data, statsDataTableName specify the table name in this field. All statistics associated with this table name are displayed. Specify the suffix appended to the Data identifier for "interface" types. suffix

For example, if the ID is '2.2.1.10', the corresponding PolledData will have the Data identifier as "2.2.1.10.x" where x is the suffix part. For example, 1 (or) 16777219 for 2.2.1.10.

597

Issue 3 May 2012

WM Release 4.0 User Guide

Field

Description Specify whether you need to display data based on thresholds set.

threshold

All – Displays those statistics which have thresholds and also those which do not have thresholds associated. true – Displays only those statistics which have thresholds associated. false – Displays only those statistics which do not have thresholds associated.

thresholdList

Specify the name of the thresholds in comma‐separated format. Possible values are true or false. The default value is false. This is calculated for Counter type OIDs where the collected data will be an incremental value and at one point will reach the final value and reset to zero. As this reset happens soon and very often, it is preferred that a delta value is derived from two consecutive polls.

timeAvg

webNMS

Specify the server that owns this PolledData.

Performance filter criteria dialogs include an Additional Criteria button. If you click this button, WM opens an additional criteria dialog. See Figure 375 on Page 597. The More button in this window adds a single Property Name/Match Criteria correlated pair of fields each time you click it. To add three pairs, for example, click the More button three times. The Fewer button removes a pair. To specify what columns your new custom view should include, click the Select Props To View button.

598

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 376: Select Table Columns dialog for performance filter view

To specify more columns, click the Additional table columns button. The More, Fewer, and Remove buttons in the resulting User defined table columns window work the same as in the Criteria Dialog window above. When you are satisfied with the construction of your table, click OK in these table columns windows. Back in the Show object with these Properties window, click the Tree Node Properties tab.

599

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 377: Tree Node Properties tab for performance filter custom view

The meaning of these fields are the same as those described in Table 23: Tree node properties for event filter view on Page 362. The defaults are the same as the view you were using when you created the custom view. When you are satisfied with the view filter that you have constructed, click the Apply Filter button. See also the following other sections of this guide:

17.6



Modifying a Custom View on Page 91



Renaming a Custom View on Page 91



Resizing Columns in a Custom View on Page 91



Removing a Custom View on Page 92

Optimizing Performance Data Storage Data collected from devices is stored in either the default STATSDATA table or user‐defined tables. These tables are created daily. If they are not required for long term records, tables can be removed from the database to optimize required storage space. It is recommended to perform a periodic clean up of tables. Before removing tables, generate reports to document their contents so that you do not lose any data. This data can also be used to analyze trends in network performance.

600

WM Release 4.0 User Guide

Issue 3 May 2012

For documentation of the embedded stats data table cleanup policy (configured task), see Administering a Policy on Page 603.

601

WM Release 4.0 User Guide

Issue 3 May 2012

18 Administering a Policy WM supports the creation and management of network policies. A policy is a predefined task to be executed either periodically or on demand, usually to perform a maintenance or cleanup operation. However, since it is not a configuration task, a policy does not appear in the Scheduled Tasks view. WM is installed with a fixed set of policies that are executed on a default schedule. Each policy may or may not have configurable parameters, which you can view by right‐clicking the policy and selecting Update: 

The AlarmClearingPolicy runs every 30 minutes to clear all alarms that are older than a configurable number of days. The units for the period field are seconds.

Figure 378: AlarmClearingPolicy



The EscalationPolicy, which is not added to the executable policy list by default, allows action to automatically be taken concerning neglected alarms and events; for example, to escalate those events to a higher severity or to sending of email alerts about them.

603

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 379: EscalationPolicy



604

The SupportInfoCleanupPolicy removes files that were created by the Generate Customer Support Info task more 60 days ago.

WM Release 4.0 User Guide

Issue 3 May 2012



The ExpiredScheduleTaskCleanupPolicy removes any task that expired 30 days ago.



The CustomStatsCleanUpPolicy removes custom statistics that are more than 30 days old.

In this context, custom statistics are those stored in files that were generated once per day to store polled data per OID that the operator specified in the Poll Details dialog of the client. (See Selecting the Data Identifier for Data Collection on Page 550.) Until these files are removed by policy, their data is available −

in the CurrentStatistic Graph viewer and the CollectedStatistics Graph viewers. (See Viewing a Current Performance Statistic on Page 385 and Viewing a Collected Performance Statistic on Page 386.)

−

for HTML reports of either current or average/minimum/maximum values.

The performance data to either remove by this policy or continue storing is of the SNMP types Float, Long, and String. 

The ReportResultsCleanUpPolicy removes from the System ReportsReport Results branch of the Applications tree any report that was generated 30 days ago.

605

Issue 3 May 2012

WM Release 4.0 User Guide 

The UserScriptResultsCleanUpPolicy removes from the Administration‐Scheduled Tasks node of the Applications tree the progress records of any user script that was executed 30 days ago.

To display the table of Policies in the view frame, click on the Policies node under Administration Tools in the Applications tree.

Figure 380: Policies panel

18.1

Adding a Policy The Add Policy feature allows you to select a defined policy that is not currently added and add that policy to the list for execution and modification. From the main menu, select ActionsAdd Policy and select the policy that you want to add. The AddPolicy Details window opens.

Figure 381: AddPolicy Details window

Select the policy from the drop‐down list. When you click add, the system opens the policy configuration window specific to that policy (see Figure 378 through Figure 379 above).

606

WM Release 4.0 User Guide

18.2

Issue 3 May 2012

Scheduling a Policy To change an already‐scheduled policy, see Updating a Policy on Page 608. To schedule a policy that has no schedule (for example, a policy that you have just added), perform the following steps.

Procedure 181: To schedule a policy 1.

In the Applications tree, click AdministrationPolicies.

Right‐click the policy that you want to schedule.

From the drop‐down list of options, select Schedule Policy (or press Ctrl+H). WM opens the Policy Scheduler window.

Figure 382: Policy Scheduler window

In the Policy Scheduler window, select whether to change the policy to be based on Dates or Days.

If you selected Days, select whether to apply the policy each day (Select All Days) or on only Specific days of the week.

If you selected Specific, click on the day(s) of the week on which to apply the policy.

To apply the policy each hour on the selected day(s) or date(s), check the Select All Hours check box.

To apply the policy at only certain hours of the selected day(s) or date(s), check the Specific check box.

When you are finished setting the schedule, click OK.

607

Issue 3 May 2012

18.3

WM Release 4.0 User Guide

Updating a Policy With any currently listed policy selected (highlighted), you can edit that policy.

Procedure 182: To update a policy 1.

In the Applications tree, click AdministrationPolicies.

Right‐click the policy that you want to update.

From the drop‐down list of options, select Update Policy (or press Ctrl+U). An ObjectDetails window opens to the current policy configuration.

Figure 383: Object Details window for policy update

18.4

To change the status, select Enabled or Disabled.

To change the name, highlight and overwrite the existing name.

To reschedule the policy execution, click the Schedule button. WM opens the Policy Scheduler window. See Figure 382 on Page 607.

Change the scheduling scheme as you wish.

When you are finished changing the schedule, click OK.

Refreshing the Policies From the main menu, the ViewRefresh command option updates the list of policies to reflect any changes that other users made in the system while you were viewing the list, which would eventually be automatically refreshed. So, if another user just finished adding a policy that you want to immediately view it and/or update, for example, the refresh feature is helpful.

18.5

Executing a Policy At any time, you can execute a policy without waiting for a scheduled execution to occur. To do so, right‐click to highlight it in the policy list and select Execute Policy from the drop‐down list of options (or press Ctrl+X). WM confirms the policy execution request.

608

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 384: Execute policy confirmation pop-up

18.6

Stopping a Policy While WM is executing a policy, it displays the name of the policy against a green background.

Figure 385: List background for policies under execution

At any time during the scheduled or manually triggered execution of a policy, you can stop it from further execution. To do so, right‐click to highlight it in the policy list and select Stop Policy from the drop‐down list of options (or press Ctrl+T). WM prompts you to confirm the stop request.

Figure 386: Stop Policy confirmation pop-up

The system confirms the stop.

609

Issue 3 May 2012

18.7

WM Release 4.0 User Guide

Deleting a Policy important ........... There is an exception to the following paragraph about deleted policies. If you ever delete the AlarmClearingPolicy, WM will remove that policy from its file system, and you will never be able to access it for future use.

In the time during which a policy is deleted 

it will not be scheduled for future execution.



it will not be available in the list for manually triggered execution.



it will still be defined and accessible to the Add Policy command for later use.

To remove a policy, right‐click to highlight it in the policy list and select Delete Policy from the drop‐ down list of options (or press Ctrl+C).

610

WM Release 4.0 User Guide

Issue 3 May 2012

19 Configuring Network Elements 19.1

Using the Configure Device Command The Configure Device command option allows you to make quick changes to the device configuration which can be applied immediately. You can also quickly view the current values stored in the database for the selected device. warning.............. The Configure Device command should primarily be used by only advanced users who have a thorough understanding of the relationships and dependencies between configuration parameters for network devices. New users should use configuration templates, created by administrators or specialists, that configure additional parameters that depend on and support the individual parameters you may select.

In addition to requiring a more detailed understanding of the configuration parameters and their interdependencies, the Configure Device command does not support the following other functions that the use of templates does support: 

configuring multiple devices



scheduling a configuration for a later date or time



reapplying a previous configuration to other devices.

Procedure 183: To configure a device 1.

In the Inventory view, right‐click on the desired device.

From the drop‐down list, select ConfigurationConfigure Device. The Configuration Group dialog is displayed, showing a tree that lists the configurable parameters for the selected device in the left panel and a dialog in the right panel for the branch that you select in the left.

611

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 387: Configuration Group, PMP SM device

612

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 388: Configuration Group, PMP BHM device

613

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 389: Configuration Group, PMP 320 CPE

614

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 390: Configuration Group, PTP 800 Slave

615

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 391: Configuration groups for a child WM

continued…

616

WM Release 4.0 User Guide

Issue 3 May 2012

Parameter listings in the tree can be expanded to display all groups. Configurable parameters for each device configuration group can then be changed by using the drop‐ down lists and text boxes in the right panel. 3.

Display and modify the attributes you want to configure.

Figure 392: Configuration Group attributes – IP

WM will send configuration changes to the device for only parameters that have been modified in the configuration form. The initial values displayed for parameters are from the WM database, not from the device. If you know that the WM database value does not match the device value, and you are trying to change the device value to the same value that the WM database displayed by default, then you should use a configuration template to make the change. 4.

Click Configure. The changes to the device configuration are applied immediately. A pop‐up opens to indicate the result of the operation.

617

Issue 3 May 2012

WM Release 4.0 User Guide

WM checks the device type configuration file in its server file system to distinguish whether any of the parameters that you are setting require a reboot of the device in order to take effect. If it finds that any of them do, then it 

posts the message Device will be rebooted after applying configuration.



shows an estimate of how much time the reboot will take.



provides the option to proceed or cancel the configuration.



configures the parameters and reboots the device, if you opted to proceed.

If it finds that none of the parameters require a reboot, then WM immediately launches into the configuration and does not reboot the device when the configuration is finished.

19.2

Using Configuration Templates Configuration templates constitute the primary tool to configure network devices. The use of configuration templates is the preferred method for configuring devices for novice users. This method is safer than the Configure Device command because it 

prevents accidental changes to parameters that were not intended to be configured, when such parameters have been deliberately omitted from the template.



provides useful default values to be set for each parameter.



represents a meaningful, useful, and appropriate selection of parameters to be configured as a unit, when the template has been properly constructed by an administrator or specialist.

The WM distribution includes a set of prestructured templates for each supported device type. However, you can create and modify additional sets of custom templates that are better suited for configuring, managing, and updating your network. note ............. For a list and description of the configuration parameters available for templates, see the user guide that is dedicated to the device.

Authorized users in the WM client can create, modify, apply, or remove other templates, which are capable of configuring parameters to non‐default values to configure, manage, and update your elements according to your preferences. If there are templates currently available in the Inventory or Maps view, then you can use the Apply Template command to configure selected devices with the parameters from an existing template as described under Applying a Configuration Template on Page 626.

19.2.1

Importing a Configuration Template When at least one configuration template exists in your system, it is possible to import a template from an exported template file on disk (for example, one that was created on another WM system). The exported template file must either exist on your client device or be within network reach of your client device. All templates that have been created on the same WM system, except those marked private during their creation, are visible and usable by all users of that system, provided that they have the relevant permissions. The only instance, apart from troubleshooting, in which a user would need to use the import/export template feature is to exchange templates with users of another WM installation.

618

WM Release 4.0 User Guide

Issue 3 May 2012

Procedure 184: To import a configuration template 1.

In the Applications tree, right‐click on ConfigurationConfiguration Templates.

From the drop‐down list of options, select Template OperationsImport Template(s). A file system browser opens, preset to look for template files.

note ............. The import operation involves pointing the client application to one or more files that are either in the client device file system or within networked reach of the client. If you want to import a template from a remote WM server, to which you lack a network connection or in which you lack file permissions, then you may need to ask the remote server administrator to transmit the file(s) for copying into the client file system before you perform the Import operation.

19.2.2

Browse to and double‐click on the template that you want to import. The system adds the template to the list in the Configuration Templates view.

Pushing Values from a Prestructured Configuration Template For each supported device, WM includes a set of templates prestructured with the parameters that are configurable in device types of the selected elements. The Inventory view provides access for applying these templates. In these views, the list of drop‐down options from a right‐click on an element includes the selection ConfigurationConfiguration TemplatesApply Template. The resulting Apply Template dialog lists all of the imported templates of this kind. An example for a 5.4‐ GHz PMP 400 AP device type is shown in Figure 393.

Figure 393: Apply Template dialog, 5.4-GHz OFDM BHM device

619

Issue 3 May 2012

WM Release 4.0 User Guide

The client device is local to the server device. In this case, the templates are available at .../cambium/wm/server/Default Templates/Configuration Templates

(the path is in the server file system). 

The client device is remote from the server device, but either −

a network connection, authenticated where required, exists between the client and the server file system, and the operator uses that connection to browse in it.

−

the operator has copied the template files from the remote path quoted above to a path in the client file system and browses to this local path.

Procedure 185: To import configuration templates

620

In the Applications Tree, expand the Configuration node.

Right‐click the Configuration Templates sub‐node.

Select Template OperationsImport template(s).

Browse to the target path where the configuration templates exist within reach of the client. (See the path quoted above for location in the server file system.)

Use ◦

Ctrl+click to individually select a set of templates.

◦

Shift+click to individually select the first and last of a set of templates that are sequentially displayed in the browser, then Ctrl+click to subtract any from in between.

◦

Click to select a single template.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 394: Select Import Files browser for configuration templates

note ............. The example case depicted above is the logical total of template selections for a network that consists of (or will consist of) CMM4s and all PMP element types, except OSU and ULAP.

After you have highlighted (selected) all of the desired template files, click the Open button.

All of the imported files will be available to any user from the Apply Template dialog upon a right‐click of an element and selection of ConfigurationConfiguration TemplatesApply Template from the drop‐down list of command options.

19.2.3

Creating a Configuration Template In an alternative to using a prestructured configuration template to push values to elements of a certain device type, the WM client interface allows you to build a template that will contain only the values for the parameters that you choose to include, and then push those values by applying the template that you created.

Procedure 186: To create a configuration template 1.

In the Inventory view, right‐click on a device of the desired device type.

From the drop‐down menu, select ConfigurationConfiguration TemplatesCreate template. WM reads the device type of the selected device, opens a Create Template dialog, and makes available in it the manageable parameters for that device type.

621

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 395: Create Configuration Template example, PMP OFDM SM with RF tooltip

note ............. The mouse-over tooltip in this case describes the radio feature that the attribute enables. Where the default and valid range values are available to WM, the tooltip states them, as in the following example.

622

Type in a Template name by which you will distinguish this template from others in the future.

Type in a Template description that will further help you recognize this template in the future.

WM Release 4.0 User Guide

Issue 3 May 2012

important ........... Before you select checkboxes in the Include column, consider whether you want the values for the associated parameters (in the Name column) to be their defaults or to be drawn from the WM database. The defaults are useful for returning a device to the initial values of its device type. The database values cause this template to inherit the current settings that are in the selected device(s) and, so, are useful for making other elements mirror the selected device(s), as in cloning or in selective parametercopying operations.

To inherit the last values that were previously applied to the selected device(s), check the checkbox for Load values from database at the top of the screen. To apply the default values (as specified in the device type configuration file in the WM server file system), ensure that the Load values from database checkbox is unchecked.

note ............. Many parameters do not have a default value specified for the OID in the device configuration file. So, if Load values from database is not selected, the values of these parameters will be blank and will require manual editing before the template is applied.

For convenience, optionally use the Jump To drop‐down list to select one configurable parameter. Alternatively, scroll in the left panel to a parameter for which you want to set a value. In either case, the right panel displays the selected parameter in the context of the other parameters from the same branch of the template.

623

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 396: Create Configuration Template dialog, parameter selected via Jump To, but Include not checked

624

In the Include column, check the check box of the selected parameter (or of the branch to which it belongs, if you want the other parameters in the branch to become configurable). In the right panel, the parameter name and associated text box or selection list are active (are no longer grayed out) not every parameter whose Include box is checked.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 397: Create Configuration Template dialog, parameter selected and Include checked

Checking a branch automatically checks all parameters that belong to the branch. 8.

Set the value that you want WM to apply via this template.

For each desired parameter, repeat Steps 6 through 8.

10. To terminate the operation and dismiss the dialog without saving the new template, click the No button in the Information Message window and the Cancel button in the Create Configuration Template window. To put the Include column and all values back to the default state (how they were set when you opened the dialog), click the Reset button. To make this new template available to edit and apply to other devices, click the Create button. If WM detects an error, it opens a message with specific information about the error. If this operation succeeds, WM opens an Information Message:

625

Issue 3 May 2012

WM Release 4.0 User Guide

11. To acknowledge, click OK.

19.2.4

Applying a Configuration Template Procedure 187: To apply an existing configuration template 1.

In the Inventory view, either ◦

right‐click to select the single device to which you want to apply the template.

◦

hold down the Ctrl key and left‐click to select multiple devices, then right‐click on one of the selected devices.

◦

hold down the Shift key and left‐click to the first and last of a contiguous set of devices, then right‐click on one of the selected devices.

From the drop‐down list of options, select ConfigurationConfiguration TemplatesApply Template. The Apply Configuration Template window opens, listing all existing configuration templates that exist in the server for the selected device type(s).

Figure 398: Apply Template window

Click to highlight (select) the template that you want to apply to the selected device(s). You can select only one template per Apply operation.

To check or change the values that the template will push, perform the following steps: a.

626

Click the Modify Values button.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 399: Modify Values dialog

important ........... Neither the Name nor the Description of the template is editable as part of the Apply template operation. If any of the changes that you want to make in a configurable parameter would alter the template such that its description would become misleading, click the Cancel button and consider using Procedure 189: To edit a configuration template on Page 629 to alter the description or creating a new template with the values you want to push in this case. If the name would become misleading, click the Cancel button, consider simply creating a new template. The Delete button is available in case the original template is no longer useful. If you realize that you selected the wrong template, click the Back button.

Change the values as appropriate for the target device(s).

To keep the changes for future application of this template, click the Save button.

Either 

click the Apply Now button to push the values immediately.



click the Apply Later button to enter the Task Scheduler utility. For instructions on how to schedule the task, see Defining the Task to Perform on Page 653.

note ............. If the value of any attribute in the template is null, WM throws a Confirm Application message.

627

Issue 3 May 2012

WM Release 4.0 User Guide

If you want to change the set of devices to which WM will push the template values, perform the following steps: a.

click the Add Devices button in the Apply Template dialog.

Figure 400: Devices tab

b. 8.

19.2.5

Using Procedure 189: To edit a configuration template on Page 629 as a guide, select or filter additional devices into the Devices Selected block of this dialog.

When you are satisfied that the template is appropriately defined or revised, click the Apply Now button.

Finding a Configuration Template The client includes a utility for quickly finding a configuration template based on strings that constitute a portion of or the entire template name or template description, the device type that the template supports, or whether the template requires a reboot of the device for a successful push.

Procedure 188: To find a configuration template

628

In the Applications tree, click on ConfigurationConfiguration Templates. This opens a Configuration Templates view in the right panel, listing all that are currently defined.

From the main menu, select EditSearch. A special Search window opens to configure for matches against any of the tabular data that

WM Release 4.0 User Guide

Issue 3 May 2012

WM is displaying in the Configuration Templates window, including that which is viewable only by scrolling.

Figure 401: Search window for configuration template criteria

19.2.6

Editing a Configuration Template Procedure 189: To edit a configuration template 1.

In the Applications tree, click on ConfigurationConfiguration Templates. This opens a Configuration Templates view in the right panel, listing all that are currently defined.

In this list, right‐click on the template that you want to edit.

In the drop‐down list of options, select Edit Template. The Edit Template dialog opens.

note ............. Alternatively, you can select a template to edit by right-clicking a device in the Inventory view and selecting Configuration TemplatesEdit Template from the drop-down list of command options, and then selecting a template from the resulting dialog.

629

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 402: Edit Template dialog for editing

note ............. If the device type configuration file stored on the WM server specifies that a reboot is required in order for settings of a particular parameter to take effect, and you select that parameter in your template, then WM automatically checks the Reboot required check box, and each device to which the template is applied will be rebooted after the template application. In this case, you cannot uncheck the check box. If the check box is not automatically checked, then you can select that option in case you want to.

Configure what WM should do when an attempt to apply the template to a device fails: ◦

To revert to the previous settings, select the Roll back Configuration to Previous Values check box.

note ............. This option is beneficial when WM successfully applied some parameters from the template but failed in attempting to apply one. For that case, this option puts original settings into effect (for example, when the settings are related such that a partial update would result in an invalid device configuration).

◦

To attempt to apply the template to the next device in the sequence, select Continue with Next Device.

note ............. If this is not checked, all configurations will stop.

◦ 5.

630

To attempt to apply the next attribute value in the template, select Continue with Next Attribute.

Edit the parameter values that you want to change.

WM Release 4.0 User Guide

Issue 3 May 2012

To effect your changes in the template, click Update. To put the Include column and all values back to the default state (how they were set when you opened the dialog), click the Reset button. To terminate the edit session without saving the results, click Cancel.

19.2.7

Pushing Configuration Values Upon Discovery You can create an association for any single imported prestructured configuration template (see Pushing Values from a Prestructured Configuration Template on Page 619) and operator‐created configuration templates (see Creating a Configuration Template on Page 621), for WM to automatically push the values in the template to every device of a specified device type at the time of initial discovery. 8 To use this feature, perform the following steps.

Procedure 190: To set up automatic configuration upon discovery 1.

From the main menu, select ToolsDefault Config Template Mapping. The Default Configuration Template Mapping dialog opens, as shown in Figure 403.

note ............. Regardless of whether you have imported prestructured configuration templates to the client device and whether one or more devices are selected (highlighted) at the time that you select this menu option, the mapping dialog does not presume that you intend a particular a mapping scheme and so it is not pre-populated by those template associations.

Figure 403: Default Configuration Template Mapping dialog

Click the Add button to add an association for a specific device type.

Use the Device Type drop‐down list to scroll to the desired device type.

This push does not occur during rediscovery or during the configuration refresh operation that is set in the Configuration Polling tab of the Polling Interval dialog.

631

Issue 3 May 2012

WM Release 4.0 User Guide

If no templates have been imported or created for this device type, then the system returns the following message: No configuration template exists for selected device type.

If any templates have been imported or created for this device type, use the Template Name drop‐down list to scroll to and select the desired template to apply upon discovery to each device of the selected type.

Check the Template Description to ensure that the selected template is the desired template.

note ............. In the example case shown above, checking the Template Description in the Mapping dialog may give the impression that the associated template will enforce authentication. However, this example description does not state (as the full Template Name does) that the associated template disables authentication. Since resizing the Template Name column in the Mapping dialog may not expose sufficient length in the names to distinguish between similarly named templates, you may need to select InventoryConfiguration Templates from the Applications Tree and then resize the columns of the Configuration Templates panel to see associated names and descriptions.

632

When you are satisfied that the Template Name you selected is the template whose values you will sometimes want imposed upon discovery, click the Save button.

WM Release 4.0 User Guide

Issue 3 May 2012

Repeat the steps of this procedure for each device type onto which you want WM to impose a configuration upon discovery.

Sort the table by clicking on the Device Type column head.

Scan the list, looking for instances of multiple templates per device type.

10. For each case of these, understand that ◦

WM will push these multiple templates in the sequence, top to bottom (lowest S. No. to highest).

◦

In the case of the any attribute that appears in and have different values in multiple templates, the result will be the value from the last template (highest S. No.) that pushed it.

11. Change the sequence for any device type, as desired. 12. Click the Save button. At any time, you can recheck any template mappings by selecting ToolsDefault Config Template Mapping from the main menu. The table in the Mapping dialog accumulates and preserves all current mappings for display so that you can recheck the list at any time. For any mapping that you want to remove, click to highlight the row of the mapping and then click the Delete button. Whenever you make a change that you want preserved in this feature dialog, click the Save button before you cancel the window. If you forget to, then this dialog will open with the contents it had in the last previously saved instance.

19.2.8

Exporting a Configuration Template It is similarly possible to export a template that you created on this system to another location. You can use this function to either store a backup copy in a safe folder or share with another WM system.

Procedure 191: To export a configuration template 1.

In the Applications tree, select ConfigurationConfiguration Templates. This opens the Configuration Templates view in the view frame, where all defined templates are listed.

In this list, right‐click on a device that the configuration template you want to export supports.

From the drop‐down list of options, select Export template. A file system browser titled Select Template Export Folder opens in the local client device.

Browse to and double‐click on the folder where you want to store the configuration template.

633

Issue 3 May 2012

19.2.9

WM Release 4.0 User Guide

Exporting All Configuration Templates WM supports the export of all configuration templates by a single operation as follows.

Procedure 192: To export all configuration templates

19.2.10

In the Applications Tree, right‐click on ConfigurationConfiguration Templates.

From the drop‐down list of options, select Template OperationsExport All Template(s). A file system browser titled Select Template Export Folder opens in the local client device.

Browse to and double‐click on the folder where you want all of the configuration templates from the system deposited.

Deleting a Configuration Template Procedure 193: To delete a configuration template 1.

In the Inventory view, right‐click to highlight any device for which the template that you want to delete is could apply.

From the drop‐down list of options, select Configuration Configuration TemplatesDelete Template. The Delete Configuration Template window opens, listing all that could apply.

Figure 404: Delete Template window

Click to highlight (select) the template that you want to delete.

If you want to review the template before deleting it, click the View button.

When you want to delete the template, click the Delete button. The system opens a warning window that asks for confirmation.

Figure 405: Warning pop-up for Delete template operation

To confirm the delete operation, click Yes. To terminate the delete operation, click No.

634

WM Release 4.0 User Guide

19.3

Issue 3 May 2012

Cloning a Device Configuration WM provides a user interface for cloning device configurations with values, from either a selected device or the database, either pushed to destination devices of the same device type or saved to a template you will later push to them, without touching attributes that should be excluded from cloning; for example, without 

those that are not readable from the source, such as keys and passwords.



others that could fail the operation, such as Device Region Code and Device Default Reset.



optionally, those that should in most cases remain unique, such as IP, DHCP, NAT, and bridge mode attributes.

This is preferred to the Create Template operation with all attributes selected, because of unique and null values frequently causing the Configuration Template push to fail. To launch the cloning interface, perform the following steps.

Procedure 194: To clone a device configuration 1.

Right‐click on the target source device and select Clone Device from its drop‐down list of options.

Figure 406: Clone Device dialog

For Data Source, select either Database (the default) or Device (the drop‐down option).

If you want to include the attribute Name (ID), check the check box for Include Unique Properties.

note ............. Attributes such as IP, DHCP, NAT, and bridge mode are device specific and should not be copied from one device to another, so cloning operations always exclude them.

If you selected Include Unique Properties in the preceding step, make a note to yourself that each cloned device ultimately will need a unique Name (ID) in order for WM to properly manage it.

For Destination, click a radio button to select either Save To Template or Device(s).

635

Issue 3 May 2012

WM Release 4.0 User Guide

If you selected Save To Template, perform the following steps: a.

For Template Name, type in a unique name that will help you distinguish this template from others.

For Template Description, type in some text that will make extra information available to you at a glance in the future when you see it listed among other templates.

If you selected Device(s) as the Destination, click to highlight each device in the list of managed elements of the same device type.

Regardless of whether the Destination is template or device(s), click OK when you are satisfied with how the Clone Device dialog is configured. WM opens an Information window that advises you to review the attributes.

Click OK in the Information window. WM opens a tabular Clone Device dialog, which allows you to review all attributes, except those omitted by feature design (those not readable and those that could cause the operation to fail) and unique attributes if you did not select Include Unique Properties. If you had Save To Template selected, then WM also opens a message window that indicates whether the template was created.

The new tabular dialog is not active until you dismiss the message window. 636

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 407: Clone Device dialog, table of attributes and values

637

Issue 3 May 2012

WM Release 4.0 User Guide

Vertical scrolling is required to see all of the attributes, and each of the column headings is active for sorting and reverse sorting the table by the contents of the column. 9.

For any attribute that you do not want to push, click to highlight the row and click the Delete Rows button at the bottom of the window. WM will ask you to confirm before it removes the row(s).

10. In the Value column, make any changes that are appropriate for the remaining attributes. 11. In the On Failure block, select from among Roll back Configuration to Previous Values, Continue with Next Device, or Continue with Next Attribute. note ............. Observe that, if you selected Device(s) for Destination in the initial window, the top of the tabular window provides a default template name and description, each constructed as CONF_SourceDeviceName(ID). These templates will not be saved in the Device(s) case. If you selected Save To Template for Destination, then the Template Name and Template Description that you configured are shown there.

12. When you are satisfied with all of the contents of this table and the failure alternatives, click Apply Now, Apply Later, or Save. These selections have the same affects that they do for configuration templates. (See Procedure 187: To apply an existing configuration template on Page 626.) If a value exists in the configuration that would cause the entire cloning operation to fail, then WM opens a specific error message about what is needed to make the operation succeed, as in the following example:

If you selected Save, and the system saw no values that would cause the entire cloning operation to fail, then WM adds the new template to the list available from the Applications tree at ConfigurationConfiguration Templates, among any configuration templates ◦

that you brought into the client using the ConfigurationConfiguration TemplatesTemplate OperationsImport Template(s) operation.

◦

that you created using the ConfigurationConfiguration TemplatesTemplate OperationsCreate Template operation.

In the case of Apply Now, WM converts the window to a display of the results.

638

WM Release 4.0 User Guide

Issue 3 May 2012

Results whose Identifier is shown as TASK... indicate that the system made no attempt to implement a value after a previous attempt did not succeed.

13. To view information associated with the results, click to highlight the row(s) for which you want the information, then click the Details button. Now the window converts another table that associates the OID, attribute name, and result for each attribute that remained when you applied the configuration.

639

Issue 3 May 2012

WM Release 4.0 User Guide

Vertical scrolling is required to see all of the attributes, and each of the column headings is active for sorting and reverse sorting the table by the contents of the column.

19.4

Launching BAM At any time, you can open a BAM session from within WM.

Procedure 195: Launching a BAM session 1.

In the Inventory view, the network tree view, or the physical map, right‐click on any PMP device.

From the drop‐down list of command options, select LaunchBAM. After finding an appropriate Java version on your WM client device, the BAM subsystem of Prizm opens to its login interface.

For information on using BAM, with its proprietary protocol, to configure elements, see Using the Bandwidth and Authentication Manager (BAM) Subsystem on Page 262.

640

WM Release 4.0 User Guide

19.5 19.5.1

Issue 3 May 2012

Using Certain Device Type-specific Configuration Dialogs Configuring an EtherWAN Switch This section provides an example of how the configuration interface presents data fields and responds to user attempts to modify device settings. For the management of EtherWAN Switches (8‐port and 14‐port) for CMM4 Devices, WM provides the following capabilities: 

enhanced port security through per‐port MAC address locking.



enhanced switching through −

bridge aging.

−

Layer 2 forwarding.

−

port mirroring.



MAC address‐based trunking with link fail‐over.



support for IGMP (Internet Group Management Protocol) snooping. This feature correlates links with the IP multicast streams intended for them, so that they do not handle unneeded packets.



support for the following protocols, which these switches support: −

802.1d, Spanning Tree

−

802.1w, Rapid Spanning Tree

−

802.1q, GARP (Generic Attribute Registration Protocol) VLAN Registration Protocol (GVRP) and Tag‐based VLAN Configuration

−

802.1p, QoS with four configurable priority queues

As with any other configurable device, the configuration dialog is accessible through a right‐click on the device and then selection of ConfigurationConfigure Device. In several fields of the Edit BostEtherwan14PortSw dialog, an ellipsis (…) indicates that a single click opens a separate dialog for configuring the attributes of the category for that field.

641

Issue 3 May 2012

WM Release 4.0 User Guide

For example, if you click to highlight Port in the left panel, and then click the ellipsis associated with Port Configuration in the right panel, the Port Configuration dialog opens.

Shading marks the fields that are read‐only in this further dialog. These provide information that is helpful for decisions on the configurable fields in the same dialog, which are per port 

Admin Setting



Switch DLF and Multicast rate limit type



Speed Configuration



Switch rate limit level



Duplexity Configuration



Default priority



Flow Control



Port VLAN ID



Switch Broadcast rate limit type



Port alias name

As with any other configurable attributes in this and other device types, consult its user guide for information about whether, why, and how to configure them to the best advantage of your network. Other secondary dialogs follow suit. For example, if you click to highlight Switching in the left panel, and then click the ellipsis associated with Mirror from port map in the left panel, the mirror from post map dialog opens.

When such a secondary dialog is not configurable, the label for the ellipsis field is gray. For example, if you click to highlight Switching in the left panel, you may see that the Port Mirror map label is gray.

642

WM Release 4.0 User Guide

Issue 3 May 2012

If you click the ellipsis in this case, the Port Mirror map dialog opens, but its fields are gray, and nothing in it is selectable.

Some of the secondary dialogs may comprise multiple tabs. This is the case for the QoS dialog that opens when you click to highlight QOS in the left panel and then click the ellipsis associated with QOS in the right panel.

643

Issue 3 May 2012

WM Release 4.0 User Guide

In these tabs, the cells are configurable whenever QOS status is enabled on the switch.

644

WM Release 4.0 User Guide

Issue 3 May 2012

645

WM Release 4.0 User Guide

Issue 3 May 2012

20 Scheduling a One-Time or Periodic Task Subject to permissions, any user in the WM client interface has access to the following task management capabilities of the system:

20.1



schedule a one‐time or periodically repeating task



slim or expand the list of already configured tasks that you are currently viewing to include −

only those that the session user owns

−

only those that were automatically created by WM (owner: SYSTEM)

−

only those that a user with lesser permissions owns

−

a greater list that also includes all tasks defined by all users.

Schedulable Tasks WM supports the following types of schedulable tasks: 

PMP/PTP Upgrade



Reports



User Script



Physical Map Data Refresh



Configuration



Generate Customer Support Information



Geo‐location Import (CSV)

Each of these tasks are alternatively supported by the client interface for execution on demand, some in a single operation and others in multiple operations. Some advantages of using the Task Scheduler utility of WM (instead of on‐demand executions elsewhere in the client) are 

labor savings from having the operations run automatically and repeatedly.



system resource savings from having the operations run at times when less traffic exists across the system.



accuracy from having the entire set of associated operations bundled, reviewable, and editable until the set of them matches your exact needs.



quality from having successful tasks preserved and identically repeated until either they are deliberately deleted or their configured executable time span has expired.

The prerequisites, specifications required, and user options that are associated with each type of supported task are described in Table 86. note ............. This table describes task definition and does not attempt to include what is involved in task scheduling, which is universal to all task types and is described under Table 87: Options for scheduling of tasks on Page 667.

647

Issue 3 May 2012

WM Release 4.0 User Guide

Table 86: Configurable task prerequisites, requirements, and options Task Type

Geo‐location Import (CSV)

Task Definition

Prerequisites or Requirements

CSV file name

Populated CSV file that already exists within browser reach of the client and contains only properly formatted geo‐locations. Used to update coordinates of devices that WM already manages.

Template to push

Device configuration template already imported into the client.

Optional Criteria

Either Static Selection



the Name (ID)s of one or more devices



the names of one or more already defined Device Groups Either or both of

Dynamic Selection, Basic

zero or one Configuration Attribute value4



zero or one Performance Attribute value4

One or more of the following Device Properties

Configuration (of devices that meet selection criteria)

Dynamic Selection, Advanced

Device Group Selection

648

Specific [device] Type (including firmware version)



Device Type1 (regardless of firmware version)



IP Address2



Managed



Name (ID)2



SNMP

Applying to all matches of specified Device Types or Specific Type, either or both of 

zero or more values of Configuration Attributes4



zero or more values of Performance Attributes4



Read Community



V3 Context Name2



V3 User Name2



Version



Specific [device] Type1 (including firmware version)



Status3



Sys OID2

At least one existing device group

WM Release 4.0 User Guide

Task Type

Task Definition

Mail Options

File Options

Issue 3 May 2012 Prerequisites or Requirements

SMTP server must be configured. SMTP port must be open.

Report file must exist within browser reach.

Support Information Level Generate Customer Support Info

Optional Criteria Unique Ticket ID (overwriting 00000000) for the subject line, local record keeping, and reference by technical support staff. Whether to Split File (recommended for files larger than 1.5 MB). Whether to Encrypt the files by associating them with a Password. High or Low level of detail.

Script selection

Script file(s) must exist within browser reach of the client, and can be of VisualBasic, batch, shell, or Perl type.

Recommended file types include VisualBasic, batch, shell, and Perl.

Files to attach

Extra file(s) must exist within browser reach of the client.

The support tool does not constrain the file type.

Comments to include

Composed comments. Either or both of 

some or all members of one or more selected device group



devices individually selected

Device selection

Physical Map Data Refresh User Script

Script to execute

A script already composed as a file whose mode is set to executable.

Arguments

649

Issue 3 May 2012 Task Type

WM Release 4.0 User Guide

Task Definition

Prerequisites or Requirements

Optional Criteria Either

Select Report Type



Configuration



System

Either Source of report data



Database (stored)



Device (current)

Either Static Selection



the Name (ID)s of one or more devices



the names of one or more already defined Device Groups Either or both of

Dynamic Selection, Basic

Specific [device] Type (including firmware version)



zero or one Configuration Attribute value4



zero or one Performance Attribute value4

Reports5 One or more of the following Device Properties

Dynamic Selection, Advanced

Device Group Selection

650



Device Type1 (regardless of firmware version)



IP Address2



Managed



Name (ID)2



SNMP



Read Community2



V3 Context Name2



V3 User Name2



Version



Specific [device] Type1 (including firmware version)



Status3



Sys OID2

At least one existing device group

Applying to all matches of specified Device Types or Specific Type, either or both of 

zero or more values of Configuration Attributes4



zero or more values of Performance Attributes4

WM Release 4.0 User Guide

Task Type

Task Definition

Issue 3 May 2012 Prerequisites or Requirements

Optional Criteria Both

General Configuration

whether to use passive FTP



whether to enable SM Autoupdate when upgrading APs.

What to use as file server to push upgrade packages to SMs.

SM Autoupdate Configuration

PMP/PTP Upgrade



HPAP Channel Bandwidth configuration.

Select Packages

Packages must be downloaded.

Device Settings

ID and password for access to the files of devices being upgraded.

Sequence in which WM will examine selected packages for appropriateness.

Any of the following: 

use of the Add operation to select one or more from the Device List



use of the Remove button to delete one or more from the Devices Selected list



use of the Load From Group operation to add an entire group by its Device Group Name

Add or remove device(s)

For Device Type or Specific Type, select all types in a single Add or Modify operation. After this operation, neither type is any longer available among selectable Device Properties. Through a subsequent Modify operation, you can specify additional types but the Conditions block will contain only a single line for all selected types.

In the text box associated with each of these Device Properties, you enter a string and specify whether a proper match contains, starts with, ends with, or equals that string.

If you select Status from among the Device Properties, then you must select only one status level from among the following: However, this selection establishes only one condition. Through another Add operation in the same task definition, you can select another individual Status level for a separate condition, and so forth.

The method for specifying a value for one of these attributes is specific to and appropriate for the attribute you have selected. It may involve typing into a text box and then selecting an associated operator from the drop‐down list. It may involve selecting an attribute value option from a drop‐down‐list and then selecting an associated operator.

Some reports do not involve device selection (for example, Physical Map Data Refresh). For those that do, the output of the report depends on the permissions and custom view scope of the user who schedules the task.

651

Issue 3 May 2012

20.2

WM Release 4.0 User Guide

Launching the Task Scheduler To launch the Task Scheduler utility, perform the following steps.

Procedure 196: To launch Task Scheduler 1.

In the Applications tree, click to expand the Administration branch.

Right‐click its child node Scheduled Tasks and select Schedule A Task (or click the Scheduled Tasks node and select ActionsSchedule A Task from the main menu). WM opens the Select Task Type dialog, shown in Figure 408.

Figure 408: Select Task Type dialog

652

From the drop‐down list, select the task type. WM opens a Create Schedule Task dialog whose tabs are specific to the task type, shown in Figure 409.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 409: Create Schedule Task dialog for all tasks except Configuration and Reports

For information on populating the Details tab or Devices tab (present for only a Reports or Configuration task) contents, see Table 86: Configurable task on Page 648 and Defining the Task to Perform on Page 653. For information on setting the schedule for your desired task, see Table 87: Options for scheduling of tasks on Page 667.

20.3

Defining the Task to Perform This section provides an example for defining the device list or device criteria and the details (configuration template selection) for a Configuration task.

Procedure 197: To define a Configuration task 1.

In the Applications tree, expand the Configuration node.

Click its child node Configuration Templates. The Configuration Templates table opens in the view panel to the right.

If the template that you want this new task to apply is not listed in the panel, perform Procedure 184: To import a configuration template on Page 619.

Perform Procedure 196: To launch Task Scheduler on Page 652, selecting Configuration as the task type.

653

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 410: Create Schedule Task dialog for a Configuration or Reports task, Schedule tab

654

Click the Devices tab.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 411: Create Schedule Task dialog for a Configuration or Reports task, Devices tab

Applying the guidance of Creating and Using Device Groups on Page 299, decide whether you want this task to be executed against −

(1) a static group of devices

−

a dynamic group of devices that is based on

− 7.



(2) Basic filtering



(3) Advanced filtering

(4) an existing device group

Use the following color code to find the appropriate substeps to perform before Step 8:

To configure the task to affect devices that you identify by…

and filter those devices by certain attribute values…

use substeps of this color

(1) a static group of devices

a through d

(2) a dynamic group of devices from Basic filtering

yes or no

a through e

(3) a dynamic group of devices from Advanced filtering

yes or no

a through g

(4) one or more existing device groups

a through e

655

Issue 3 May 2012

WM Release 4.0 User Guide

If you want this new task to apply a device configuration template to one or more device Name (ID)s and do not want to filter those devices by any existing configuration or performance attribute values, perform the following steps: a.

Under Device Selection, click the radio button for Static Selection.

Click the Add button in the Devices Selected panel.

Figure 412: Add Device window

656

Ctrl+click to highlighted the devices against which you want this task to be executed.

Click the Add button in the Add Device window.

If you want to include all devices that are members of each of one or more device groups, click the From Group button.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 413: Device Groups window

Click to highlight the row of a device group to be included.

Click the Load button.

For each other device group to be included, repeat Steps e through g.

To remove any duplicate or undesired devices from the Devices Selected list, Ctrl+click to highlight them and then click the Remove button.

657

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 414: Individual devices selected for removal

Advance to Step 8.

If you instead want this new task to apply a device configuration template to one or more device types specific to firmware version and you do or do not want to filter the matching devices by the values of one configuration attribute and/or one performance attribute value, perform the following steps: a.

In the Device Selection panel, click the radio button for Dynamic Selection.

From the drop‐down list associated with Dynamic Selection, select Basic.

Specify one or more device specific types by performing the following steps: −

Click the down arrow associated with Specific Type.

note ............. Since the configuration and performance attribute scroll lists (presuming that you want to specify any) are specific to device type, you must make a Specific Type selection before the interface will make those options available.

658

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 415: Specific Type drop-down list for Basic Dynamic Selection

− d.

Select an individual Specific Type.

If you want to optionally filter the matching devices by the value of one configuration attribute, perform the following steps: −

Click the down arrow associated with Configuration Attribute.

659

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 416: Configuration Attribute drop-down list for Basic Dynamic Selection

−

Scroll and click to highlight the row(s) of the single attribute whose value you want to specify.

note ............. Depending on what attribute you selected, the interface may provide either a drop-down list or a text box for value specification.

−

Specify the value for the selected Configuration Attribute.

−

From the operator drop‐down list, select the operator that relates to the value you selected or entered.

If you want to optionally filter the matching devices by the value of one performance attribute, perform the following steps: −

660

Click the down arrow associated with Performance Attribute.

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 417: Performance Attribute drop-down list for Basic Dynamic Selection

−

Scroll and click to highlight the row(s) of the single attribute whose value you want to specify.

−

Enter the value for the selected Performance Attribute.

−

From the operator drop‐down list, select the operator that relates to the value you entered.

note ............. The operators for each performance attribute values must be equals (=), does not equal (!=), is less than (<), is less than or equal to (<=), is greater than (>), or is greater than or equal to (>=).

Advance to Step 8.

If you instead want this new task to apply a device configuration template to a set of devices that match one or more Device Properties (see the Dynamic Selection, Advanced row of Table 86 on Page 648) and you do or do not want this set further filtered by any number of current configuration or performance attribute values, perform the following steps: a.

In the Device Selection panel, click the radio button for Dynamic Selection.

From the drop‐down list associated with Dynamic Selection, select Advanced.

Click the Add button. The Add Advanced Criteria window opens, shown in Figure 418.

661

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 418: Add Advanced Criteria window, ready for Device Properties selections

important ........... Refer to the Dynamic Selection, Advanced row of Table 86 on Page 648 and the notes associated with it at the end of the table for the rules involved in this type of task definition. Only one condition is created for all Device Types or Specific Types You must select all types (that you want to apply) in a single Add or Modify operation. After this operation, neither type is any longer available in the list of selectable Device Properties. Through a subsequent Modify operation, you can specify additional types, but the Conditions block will contain only a single line for all selected types. The sets of Configuration Attributes and Performance Attributes that you can optionally choose from are only those that are supported for the device types or specific [device] types that you have selected (that are listed in that one condition). By contrast, any of the Device Properties that you optionally specify a value and operator for can have the effect of expanding the set of target devices, but this property will be shown in a separate row of the Conditions block, and the specific devices that the task includes because of this property will not be shown in the task definition (WM will not apply the property condition until it executes the task).

Click the down arrow associated with Name.

Scroll and select either Device Type (to allow you to select types regardless of their firmware versions) Specific Type (to allow you to select types specific to their firmware versions).

Click OK.

To optionally introduce another condition for either filtering the set of devices to be affected by the task or adding (at execution time) devices that meet the new condition, perform the following steps: −

Click the Add button.

−

From the drop‐down list at the top of the window, either select Device Properties to add non‐attribute conditions that could include more devices at execution time.

662

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 419: Add Advanced Criteria window, selectable Device Properties

select Configuration Attribute or Performance Attribute to add a qualification that must be met by any device that is of a selected Device Type or Specific Type.

663

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 420: Add Advanced Criteria window, Configuration Attributes for a subset of Specific Types

−

For each new condition (Name) set the Value. set the associated Operator. Click OK.

−

Back in the updated Create Schedule Task window click to highlight the new condition. select the operator AND or OR.

−

Review the Conditions block to ensure that the value and its operator are correct in the new condition. the AND/OR switch is properly set for the new condition.

Repeat Step g as many times as required to introduce all desired filtering conditions.

Advance to Step 8.

If you instead want this new task to apply a device configuration template to all members of one or more device groups and do not want to filter those devices by any existing configuration or performance attribute values, perform the following steps:

664

Click to select the radio button for Device Group Selection.

In the Device Groups block, click to highlight the desired device group(s).

Click the Preview button.

WM Release 4.0 User Guide

Issue 3 May 2012

Examine the Device List to ensure that these are the devices against which the task should be executed.

Click OK to dismiss the Devices Preview window.

Click the Details tab.

Click to highlight the row of a single configuration template for the task to apply.

Figure 421: Create Schedule Task window, Details tab listing configuration templates

note ............. Each template that you want Task Scheduler to apply requires the definition of a separate task.

10. Click OK. The selected template opens to allow you to set new or other values into the template. note ............. This feature supports the inherent interdependencies among configurable attributes. For example, if you set Network NTP Enable to Enabled, then Get NTP Server From DHCP is automatically set to Disabled; if you set Network IP Access Filter to Disabled, then Network Allowed IP Access 1 to 3 become not configurable.

665

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 422: Create Schedule Task window, Details tab open to a configuration template

note ............. The initial contents of the Details tab are specific to the type of task being defined (Configuration, Generate Customer Support Info, or Geo-location Import). See Table 86: Configurable task prerequisites, requirements, and options on Page 648.

Click the Schedule tab.

note ............. Regardless of the task type, the interface for defining the schedule always has the same settable parameters. These are listed in Table 87.

666

WM Release 4.0 User Guide

Issue 3 May 2012

Table 87: Options for scheduling of tasks Schedule Type

Periodic

Frequency

Requirements for Specification of Launch Time(s)

all

Selection of Minutes, Hourly, Daily, Weekly, or Monthly. Start date. Start time. Selection of end date or perpetual task. Selection of whether to keep the defined task in a dormant but defined state or delete it after the schedule expires.

number of minutes

Selection of Minutes. Selection of every n number of minutes.

Hourly

Selection of either every hour or every n number of hours. Selection of how many minutes after the top of the hour.

Daily

Selection of either every day or every n number of days. Selection of either every day of the week (all seven).

Weekly

—OR— Selection of one to seven individual days of the launch weeks and number of weeks between launches. Selection of one to twelve individual months and date of the month.

Monthly

—OR— Selection of one to twelve individual months and first, second, third, fourth, or last selected individual weekday during the month.

Non‐ recurring

Once

Start date. Start time. Selection of whether to keep the defined task in a dormant state or delete it after the task expires.

Immediate

once

Click of the Run Now button.

If you want the task to run only once and then expire, set the schedule parameters that are listed in the Non‐recurring row under the column Requirements in Table 87 above.

667

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 423: Create Schedule Task dialog, Schedule tab for non-recurring task

10. If you want the task to run more than once, set the schedule parameters that are listed in the appropriate Periodic rows (all and number of minutes, hourly, all and daily, all and weekly, or all and monthly) under the column Requirements in Table 87 above.

668

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 424: Create Schedule Task dialog, Schedule tab for a minute-based task

669

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 425: Create Schedule Task dialog, Schedule tab for an hourly task

670

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 426: Create Schedule Task dialog, Schedule tab for a daily task

671

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 427: Create Schedule Task dialog, Schedule tab for a weekly task

672

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 428: Create Schedule Task dialog, Schedule tab for a monthly task

important ........... Although WM does not prompt for confirmation if you close a Create Schedule Task window, it will not retain any of the task definition that you have specified before, and that work will be irretrievable if you close the window before performing the next (Save or Run Now) step.

11. Click the Save button to store the task definition and to set up its execution or click the Run Now button to immediately execute the task.

20.4

Viewing Configured Tasks Depending on your user permissions, you can view the full set of all currently configured tasks or a subset as follows: 

only those that you own (that you created)



only those that were automatically created by WM (owner: SYSTEM)



only those that a user with lesser permissions owns

For each task, the table view presents 

attributes of the task −

Task Name

−

[Task] Type

−

Owner (creator)

673

Issue 3 May 2012

WM Release 4.0 User Guide



−

Status (whether the task is Inactive [has expired] or Active [has not expired])

−

Frequency (configured)

attributes of the executions(s) −

Last Executed [time and date]

−

Next Execution [time and date]

−

Progress [information]

To view the table of tasks, perform the following steps.

Procedure 198: To view configured tasks 1.

In the Applications tree, click to highlight the Scheduled Tasks branch.

From the User drop‐down list, select All, SYSTEM (for a list of WM‐generated tasks), or the name of the user whose owned tasks you want to view. An example of a table view of ◦

SYSTEM tasks is shown in Figure 429.

◦

user‐owned tasks is shown in Figure 430.

Figure 429: Scheduled Tasks view for SYSTEM-owned tasks

674

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 430: Scheduled Tasks view for user-owned tasks

In addition to the columnar data, the appearance of the row for any task in the table view provides task status as follows. A task that is shown 

on a grey background has expired.



on a white background has not expired.



on a green background is currently running.



on a red background has been paused and not yet resumed.

To view the results from the last completed execution of a task, perform the following steps.

Procedure 199: To view results of last execution of a task 1.

In the Scheduled Tasks table view (see Procedure 198: To view configured tasks on Page 674), right‐click on the desired task.

From the drop‐down list of options, select Edit Scheduled Task. WM opens the Edit Scheduled Task dialog, shown in Figure 431.

Figure 431: Edit Scheduled Task dialog

675

Issue 3 May 2012

WM Release 4.0 User Guide

Click the Results tab. Any data that the task type supports reporting on is displayed in table form, as shown in Figure 432.

Figure 432: Results tab for a scheduled task

Click to highlight the task.

Click the View button. For a configuration task, the Configuration Result column provides the result for each configurable parameter that the template attempted to push when the task was last executed. For a report task, a Report Result window opens to the data that the report gathered, as shown in Figure 433. Keep in mind that your selection of Execute this report from when you defined the task determined whether the data you are viewing now was stored (Database) or current (Device) at the time that the report task executed.

Figure 433: Report Result window for report task execution

676

WM Release 4.0 User Guide

20.5

Issue 3 May 2012

Editing the Definition of a Configured Task To edit the definition of a task that you own or have permissions that allow you to modify, perform the following steps.

Procedure 200: To edit a task definition 1.

In the Scheduled Tasks table view (see Procedure 198: To view configured tasks on Page 674), right‐click on the desired task.

Figure 434: Options for an Active task

From the drop‐down list of options, select Edit Scheduled Task. WM opens the Edit Scheduled Task dialog, shown in Figure 431 on Page 675.

Edit the attributes of the task. For guidance on the fields of the Details tab (and the Devices tab, for a Configuration or Report task), see ◦

Table 86: Configurable task prerequisites, requirements, and options on Page 648

◦

Procedure 197: To define a Configuration task on Page 653.

note ............. For Device Type or Specific Type, you must select all types (that you want to apply) in a single Add or Modify operation. After this operation, neither type is any longer available among selectable Device Properties. Through a subsequent Modify operation, you can specify additional types but the Conditions block will contain only a single line for all selected types.

20.6

Click the Save button.

Rescheduling or Triggering a Scheduled Task For any previously configured task, you can modify the scheduled launch(es) or trigger the task to run on demand. To run the task now, right‐click on the task and select Run Scheduled Task from the drop‐down list of options. To change the schedule, perform the following steps.

Procedure 201: To reschedule a task execution 1.

In the Scheduled Tasks table view (see Procedure 198: To view configured tasks on Page 674), right‐click on the desired task.

From the drop‐down list of options, select Edit Scheduled Task. WM opens the Edit Scheduled Task dialog, shown in Figure 431 on Page 675.

677

Issue 3 May 2012

WM Release 4.0 User Guide

20.7

To reset the schedule, see Table 87: Options for scheduling of tasks on Page 667.

Pausing or Resuming a Scheduled Task To throw a hiatus for an active task, perform the following steps.

Procedure 202: To pause a task 1.

In the Scheduled Tasks table view (see Procedure 198: To view configured tasks on Page 674), right‐click on the desired task.

From the drop‐down list of options, select Pause Scheduled Task. The task remains defined but dormant, and the row in the Scheduled Tasks view shows the task on a red background, until either you select the task or it is deliberately resumed.

Figure 435: Paused task in Scheduled Task table view

To resume a paused task, perform the following steps.

Procedure 203: To resume a task

20.8

In the Scheduled Tasks table view (see Procedure 198: To view configured tasks on Page 674), right‐click on the desired task.

From the drop‐down list of options, select Resume Scheduled Task. The task becomes active again, and the row in the Scheduled Tasks view shows the task against a white background.

Retaining or Removing a Scheduled Task The ExpiredScheduleTaskCleanupPolicy regularly executes according to its configuration in the Policy Scheduler dialog and removes any task that both is Inactive and has its Mark for Cleanup option checked.

Figure 436: Mark for Clean Up option in Schedule tab for tasks

When you initially define a task, this option is checked. If you uncheck this option during the initial setup of the task or a later edit of it, then WM retains the task definition after it expires but will not run it again until after you edit its schedule to effectively make it Active again.

678

WM Release 4.0 User Guide

Issue 3 May 2012

To save a task from automatic deletion after its expiry will arrive, perform the following steps.

Procedure 204: To cancel automatic deletion of a task 1.

In the Scheduled Tasks table view (see Procedure 198: To view configured tasks on Page 674), right‐click on the desired task.

From the drop‐down list of options, select Edit Scheduled Task.

In the Clean Up Option block of the Schedule tab in the Edit Scheduled Task window, uncheck the check box for Mark for Clean Up. When the expiry arrives, the task will enter the inactive status, but its definition will be retained, and it will continue to be listed ion the Scheduled Tasks view.

To remove a task and its definition, perform the following steps.

Procedure 205: To delete a task 1.

In the Scheduled Tasks table view (see Procedure 198: To view configured tasks on Page 674), right‐click on the desired task. Options vary depending on whether the task is Active or Inactive. See Figure 434: Options for an Active task on Page 677 and Figure 437.

Figure 437: Options for an Inactive task

20.9

From the drop‐down list of options, select Delete Scheduled Task. The task is immediately deleted and can never be retrieved. To replace an inadvertently removed task that was indispensable, define a new, identical task.

Stopping a Running Task To stop a task while it is running, perform the following steps.

Procedure 206: To stop a task 1.

In the Scheduled Tasks table view (see Procedure 198: To view configured tasks on Page 674), right‐click on the desired task.

From the drop‐down list of options, select Stop Scheduled Task. If the task had been launched via Run Scheduled Task earlier than it was scheduled to be, then the task is stopped but will run when it was scheduled by the task definition to run. If the task was running on schedule, it will be stopped and will not run again until its next scheduled execution.

679

WM Release 4.0 User Guide

Issue 3 May 2012

21 Broadcasting a Message The Broadcast Message command can be used to send messages to all the clients connected to the WM Server.

Procedure 207: To Broadcast a message 1.

From the main menu, select FileBroadcast Message, or press Ctrl+G. The Broadcast Message dialog box is displayed.

Figure 438: Broadcast Message dialog

In the Message field, type the message that you want to broadcast.

note ............. The option that is associated with this message (Send to my FE client only or Sent to all clients) has no effect.

Click the BroadCast button. The message is delivered to all intended clients that are connected to the WM Server and is displayed on the status bar.

681

WM Release 4.0 User Guide

Issue 3 May 2012

22 Administering Wireless Manager 22.1

Terminating a Client Session WM provides a means to terminate a rogue or runaway client session while other concurrent sessions continue. To access this feature, select ToolsAdministrationClients' Details. The system responds by opening a Clients' Details window.

Figure 439: Clients' Details window

To terminate one of the sessions listed in this view, check the associated check box in the Terminate column, then click the Terminate button. WM asks for confirmation.

To abort the termination, click the No button. To terminate the selected client session, click the Yes button. To monitor this view, occasionally click the Refresh button.

22.2

Using the WM Administrator Tool To launch this tool from the main menu in the WM client, select ToolsAdministrationServer Administration. The defaults for the various panels of the WM Administrator Tool are as shown in this section. The fields that require attention in a typical setup are noted in other sections of this guide. If you perform any action in one of these panels and then attempt to leave the tool or access another panel without applying your changes, the GUI prompts you for whether you want to apply them:

683

Issue 3 May 2012

22.2.1

WM Release 4.0 User Guide

Using the WM Server Panel To launch this panel from the main menu in the WM client, select ToolsAdministrationServer Administration; in the left panel of the resulting WM Administrator Tool dialog, select WM Server. The client version of the WM Server panel is useful to only ensure that the WM and Apache services are running. Knowing whether they are is sometimes helpful in trouble scenarios.

Figure 440: WM Server panel of WM Administrator Tool

The function invoked by the NE Re‐Sync and NE Re‐Sync after backup buttons is to remove the events and alarms of all the managed elements as well as their traps that WM is currently processing, and to refresh their status, but to allow their statistics to continue to be stored. If you select either of these, WM throws a warning.

This amount of status polling consumes a significant amount of resources. Consider this advisory carefully before you consider confirming by clicking the Yes button.

684

WM Release 4.0 User Guide

22.2.2

Issue 3 May 2012

Configuring the BAM Panel To launch this panel from the main menu in the WM client, select ToolsAdministrationServer Administration; in the left panel of the resulting WM Administrator Tool dialog, select BAM.

Figure 441: BAM panel of WM Administrator Tool

The BAM Configuration block defaults to the following attribute values.

To make any changes from the defaults, click in the Value cell. This transforms the cell from read‐only data into a text box. Type in the substitute value. Then, to return the cell to read‐only, click elsewhere in the table (in the Attribute column or one of the column headings, for example). BAM privileges are essential to its management functionalities, and each mapped privilege must be at the System Administration (A) level.

685

Issue 3 May 2012

22.2.3

WM Release 4.0 User Guide

Configuring the Database Panel note ............. The Database panel contains no options to backup and/or restore the database.

To launch the Database panel from the main menu in the WM client, select ToolsAdministrationServer Administration; in the left panel of the resulting WM Administrator Tool dialog, select Database.

Figure 442: Database panel of WM Administrator Tool

WM encrypts the database Password such that it is never readable in either the WM server file system or the WM client. However, any change that you make in the Password field of this panel must reflect the password that is configured in MySQL. The Reset button returns all of the values to their defaults. Since these are all connection‐related attributes, the Reset operation does not return the original database schema as well. If you changed the table structure or deliberately altered any other SQL settings and now need to revert to the

686

WM Release 4.0 User Guide

Issue 3 May 2012

configuration that the WM installation tool had installed, perform the server administration guide procedure titled "To restore the installed WM database configuration." The Test button launches a test of the connection between WM and the database, using the current settings in this panel. When the values are properly set, the expected result of the connection test is the following pop‐up message:

22.2.4

Using the Licensing Panel One single or three redundant License Manager servers are supported. One of these may be local to the WM server. This panel configures how WM communicates with the licensing server(s) and also provides options to start, stop, and restart License Manager, and to upload license files into License Manager. To launch this panel from the main menu in the WM client, select ToolsAdministrationServer Administration; in the left panel of the resulting WM Administrator Tool dialog, select Licensing.

Figure 443: Licensing panel of WM Administrator Tool

note ............. Start differs from restart as follows: Start commands start the service; in a two-step automatic operation, Restart commands stop the running service and then restart it.

687

Issue 3 May 2012

WM Release 4.0 User Guide

Changes that you save and licenses that you upload are reflected in the file .../server/conf/licensing.xml. Restart LM is not necessitated by license uploads.

The Upload License option opens a browser to the local file system.

Figure 444: Upload License File dialog

An example of License Status information is as follows.

688

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 445: License Manager Status display window

...

689

Issue 3 May 2012

22.2.5

WM Release 4.0 User Guide

Configuring the NBI Panel The Northbound Interface (NBI) provides an SNMP‐based Java Management Extension (JMX) agent for other management systems to poll WM for information about its managed objects, events, alarms, and performance data. The NBI panel configures the agent of WM. To launch this panel from the main menu in the WM client, select ToolsAdministrationServer Administration; in the left panel of the resulting WM Administrator Tool dialog, select NBI.

Figure 446: NBI panel of WM Administrator Tool, active SNMP V3 settings

The NBI panel allows you to change the NBI passwords for SNMPv3‐based security. 

The Auth Password field is the SNMPv3 Authentication password.



The Priv Password field is the SNMPv3 Privacy password.

To use the V3 agent, you must provide both. The default passwords are authPassword and privPassword, respectively.

The two SNMP settings blocks of this dialog are active only if they have context in the selected SNMP Version.

690

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 447: NBI panel of WM Administrator Tool, active SNMP V1/V2 settings

To make any change in the Trap Forwarding Configuration table, you must first check the Enable Trap Forwarding check box. After this is done 

to change an existing configuration, double‐click the cell whose contents you want to change and type the new content into the resulting text box there.

note ............. The Host and Port values are not editable by this means. If you need to make a change in either or both of these, you must remove the configuration and then add a new one that has the changed host or port value(s).



to remove an existing configuration, click the highlight the configuration you want to delete; then click the Remove Trap Forwarding button.



to add a configuration, click the Add Trap Forwarding button; then for each column, double‐ click in the blank cell and type the contents into the resulting text box.

To enforce all of the changes you have made in this dialog, click the Apply button. To dismiss the dialog, click the OK button. important ........... To ensure WM security, these passwords should be changed soon after installing WM.

22.2.6

Using the Offline Physical Map Panel The use of this tool interface presumes that your server administrator has configured offline map layers in GeoServer. This tool makes those layers available to the WM client application by specifying the image layers, pointing the WM server to the proper connection parameters for communication with GeoServer, and switching on the optional offline physical map feature for the client. Instructions and background information for the GeoServer setup are provided in the WM server administration guide.

691

Issue 3 May 2012

WM Release 4.0 User Guide

To launch this panel from the main menu in the WM client, select ToolsAdministrationServer Administration; in the left panel of the resulting WM Administrator Tool dialog, select Offline Physical Map.

Figure 448: Offline Physical Map panel of WM Administrator Tool

note ............. The following operations require both a click of the Apply button and a new client session in order to be reflected in the client: Enable offline physical map, Add Layer, and Delete Layer.

Instructions for setting up WM to use the image layers that your WM server administrator has configured in GeoServer are provided in the WM server administration guide. To later make changes in the configuration of a layer, perform the following steps.

Procedure 208: To reconfigure offline physical map images in WM

692

Click the cell that you want to edit.

Overwrite its textual contents.

Click the Apply button.

When finished in the Offline Physical Map Configuration panel, click the OK button to dismiss the WM Administrator Tool interface.

Drop the current client session and open a new one to view the results of the changes.

WM Release 4.0 User Guide

22.2.7

Issue 3 May 2012

Configuring the Email Configuration Panel For several various purposes, the WM client allows you to compose email to configurable recipient addresses for immediate, delayed, or conditional sending. These instances include email 

triggered by −

an event filter. See Send Email Action on Page 519.

−

an alarm filter. See Adding an Alarm Filter on Page 526.

−

an escalation policy. See Administering a Policy on Page 603.



to communicate a notice to one or more customers of your network services. See Sending an Email Notification to a Customer on Page 247.



to accompany data gathered to inform technical support efforts. See Running the Tool from the Client Application on Page 750.

In a single panel, the WM administrator tool allows you to specify or reconfigure the settings that determine how these emails will be processed. To launch this panel from the main menu in the WM client, select ToolsAdministrationServer Administration; in the left panel of the resulting WM Administrator Tool dialog, select Email Configuration.

Figure 449: Email Configuration panel of WM Administrator Tool

To configure these settings, perform the following steps.

693

Issue 3 May 2012

WM Release 4.0 User Guide

Procedure 209: To configure server and admin email settings

22.3

For SMTP Server Host, replace SMTP_SERVER_HOST with the host name of your local SMTP server.

If its port is other than 25, highlight and overwrite 25 with the number of the port that is locally reserved for the SMTP host.

If you want WM to require users to authenticate themselves before they are allowed to send email or configure email for later sending, perform the following steps: a.

For Login, specify the SMTP username for WM to authenticate itself to the SMTP server.

For Password, specify the SMTP password for WM to authenticate itself to the SMTP server.

Type the same string into the Confirm Password text box.

Click to check the check box associated with Authentication required.

For From Mail ID, highlight wm_server@company.com and overwrite this placeholder address with the FROM address that the SMTP should mark the outbound email that is triggered by an escalation policy or an event or alarm filter.

For To Mail ID, highlight wm_admin@company.com and overwrite this placeholder address with the FROM address that the SMTP should mark the outbound email that is addressed to either customers or technical support staff (possibly in addition to others added to the support tool because they are to be copied on support emails).

Click the Test button to ensure that the SMTP server and its port are properly configured in this panel.

If the test is successful, click the OK button to apply its settings.

Configuring Log Settings The Logging Service is useful for various purposes, such as pinpointing bugs, configuration errors, performance blockades, creating audit logs, and tracking various actions on the server.

22.3.1

Opening the Log File Configuration Tool Procedure 210: To open the Log File Configuration tool From the main menu, select HelpLog Settings or press Alt+L. The Log Settings window opens. The table lists the existing log file names. These files are located on the WM server device in the /usr/local/cambium/wm/server/logs directory in Linux (or the C:\Cambium\WM\server\logs folder in Windows).

694

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 450: Logging Configuration panel

The sections that immediately follow this one cover the functions that the buttons at the bottom of this panel make available: 

Adding Log Files on Page 696



Viewing Details of Log Files on Page 696



Modifying Log File Settings on Page 697

695

Issue 3 May 2012

WM Release 4.0 User Guide

You can specify any arbitrary number of files to retain and any number of lines to retain per file. The File Count limits the number of retired log files that are retained after they reach the Maximum Lines value. The Maximum Lines value determines when a file is retired and a new file is created (possibly causing the deletion of the oldest retired file, if the number of files including the current exceeds the File Count).

22.3.2

Adding Log Files Although WM provides a way for you to add operator‐defined logs, any that you add would have no use or value. This is because the server software contains no code that would use your new log. So, the log would never have any content. Ignore this feature.

22.3.3

Viewing Details of Log Files The details that this section describes are the same details, except for the Advanced Properties shown here, that are available for editing when you click the Modify button in the Logging Configuration panel (see Figure 450).

Procedure 211: To view log file details

696

From the main menu, select HelpLog Settings or press Alt+L.

In the Log Settings window, click to highlight the target log file in the table.

WM Release 4.0 User Guide

Issue 3 May 2012

Click the View Details button The Log Details dialog is displayed.

Figure 451: Viewing the Log Details dialog

22.3.4

Modifying Log File Settings Procedure 212: To modify log file details 1. From the main menu, select HelpLog Settings or press Alt+L. 2. In the Log Settings window, click to highlight the target log file in the table. 3.

Click the Modify button.

697

Issue 3 May 2012

WM Release 4.0 User Guide

The Logging configuration dialog is displayed.

Figure 452: Logging configuration window, Log Settings, first frame

698

Make necessary changes in the first screen.

WM Release 4.0 User Guide

Issue 3 May 2012

Table 88: Log Settings panel fields, first frame Field

Description

Log File Name

The file name to be used for storing the current log. Only the file names that are compatible with the operating system on your WM server device are supported. Specify the file extension as .txt and avoid numbers.

Logging Directory

The directory in which the log file is to be stored. By default, the log files are stored in the /usr/local/cambium/wm/server/logs directory in Linux (or the C:\Cambium\WM\server\logs folder in Windows). If you need to specify a directory within this default location, specify logs/directory_name.

Maximum Number of Lines Per File

The maximum number of lines per file before a new file is created to hold subsequent log entries. If you remove the entry and leave this field blank, the default of 10000 lines is imposed. When the log file exceeds the maximum number of lines specified, it is carried forward to another new file that is created with similar name, and the old (retired) file is retained for future reference. For example, when somelogfile.txt reaches 10000 lines, then a new file somelogfile1.txt is created and the logging continues. The number of files that can be created at such cases can be specified in the Maximum Number of Files field.

Maximum Number Of Files

The number of old log files to retain. Extras are deleted to save disk space. If you remove the entry and leave this field blank, the default value of 10 is imposed.

Maximum Lines Cached

Configure the maximum number of lines to be kept in memory before writing them to a log file. For example, if you set this parameter to 50, the first 50 lines are kept in memory. After the 50th line, all the 50 lines are written to the log file. Then, the second round of writing would occur after caching 50 more lines, and so on.

Use Time Stamp ?



0 means entries are written immediately.



A high number is more efficient. This is because of fewer instances of large blocks being written to the file. However, a high setting risks losing important cached messages when a crash occurs.



The default is 0.

Whether to include a time stamp. Time stamps are extremely useful and typically should be included in the log. However, they consume pace in the file.

Click the Next button.

699

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 453: Logging configuration window, Log Settings, second frame

Make necessary changes in the second screen.

Table 89: Log Settings panel fields, second frame Field

Description

Key Name

This name is primarily for internal use. Changing this name is discouraged.

Display Name

This name is primarily for internal use. Changing this name is discouraged.

Log Level

Debug causes the most logging. Summary causes the least.

Enable Logging

Summary: important messages



Intermediate Messages: frequently generated log messages



Verbose: detailed/error messages



Debug: composite of above levels plus more information for debugging

Logging is a low overhead feature. Thus, keeping it enabled for all logs is recommended. 7.

700



click the Modify button.

WM Release 4.0 User Guide

Issue 3 May 2012

When you are satisfied with the settings, click the Finish button.

To effect the changes on the server‐side logging_parameters.conf file, click the Apply button back in the original window.

This file is located on the WM server in the /usr/local/cambium/wm/server/conf directory in Linux (or the C:\Cambium\WM\server\conf folder in Windows).

22.3.5

Using Debug Mode In the Help of the WM client, the Tools menu includes the command option Debug Mode. This is a mode of operation that collects information that has potential value to troubleshooting efforts. Since this is not considered a normal mode of operation, the option is deselected by default. If technical support personnel ask you to enable it, simply select HelpDebug Mode. If you ever feel it is wise to check whether this mode is enabled, click on Help and observe the check box associated with Debug Mode in the drop‐down list. Checked is enabled:

701

Issue 3 May 2012

22.3.6

WM Release 4.0 User Guide

Logging JVM Monitoring Details The JVM Monitoring feature allows you to see the extent of system resources that the WM back‐end server is using on the server device. In the main menu of the WM client, the Help menu includes the DiagnosticsJVM Monitoring Details command option. If you select this option, the system launches the Collected statistics window, which plots Java Virtual Machine activity from the client across a time frame that you specify.

Figure 454: Collected statistics window with JVM monitoring history plotted

This tool provides options to view either memory (MonitorMemory) or independent execution threads (MonitorThread) across the time frame that you select. However, the memory monitor function does not operate properly, and you should ignore it.

702

WM Release 4.0 User Guide

Issue 3 May 2012

23 Monitoring WM and Its Networks Through Wireless Manager Ultralight The WM server supports secure read‐only web access as Wireless Manager Ultralight to provide a quick and summary view of the health of the server and the networks it manages. The views in this client are practical for display on mobile devices as well as on stationary devices that have at least as much display area as phones do for web pages. Wireless Manager Ultralight does not mimic the Java client that is described in all of the foregoing chapters of this guide.

23.1

Accessing Wireless Manager Ultralight In your browser, launch the URL http://WMServerIPAddress:9090/opwm/. The Wireless Manager Ultralight interface opens to its login page.

Figure 455: Login web page of Wireless Manager Ultralight

Proceed to log in as follows.

Procedure 213: To log in to the Wireless Manager Ultralight 1.

For Username, type in the same user name that you use for authenticating into the full client.

For Password, type in the associated password.

For Database IP or Hostname ◦

if the MySQL database is remote to the server, type in the IP address of the database.

◦

if it is local to the server, leave localhost in the text box.

note ............. In the context of this field, localhost is relative to the server, not to the device on which your browser exists. The initial contents of this and the two following fields are read from a file where valid configuration information is stored in the server.

For Database Port, leave 3306 (the default port for MySQL databases), unless your implementation uses a customized port number.

For Database Name, leave WMSDB.

Click the Submit button. 703

Issue 3 May 2012

WM Release 4.0 User Guide

Wireless Manager Ultralight opens to its What's Up web page.

23.2

Using the What's Up Web Page The view that opens upon a successful login is the What's Up web page.

Figure 456: What's Up web page

In this view, each managed element is listed by its IP address and surrounded by the background color that corresponds to its most severe alarm. The color scheme for alarms in Wireless Manager Ultralight is the same as that in the client. Each device IP address in the list is a link to a page of further information about the device. This web page delivers data in each of the following vertical categories:

704



Alarms



Events



Key Information, which may include (depending on device type) the following attribute and statistic blocks: −

Device

−

Device Group (for EtherWAN switches)

−

GPS (for CMM devices)

−

Radio

−

Authentication

−

Link (for PTP devices)

WM Release 4.0 User Guide

Issue 3 May 2012

−

Status

−

Key Statistics



Active Statistics



Configuration

That page also provides a link to the launch of the management web interface of the device (Goto Device Webpage).

705

Issue 3 May 2012

WM Release 4.0 User Guide

Figure 457: SM Device-specific web page, top

706

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 458: Device-specific web page, middle

The device‐specific web page includes only the statistics that are enabled in the Polling Configuration dialog (from the Tools menu). See 

Adjusting the Status Polling Intervals on Page 195



Adjusting Configuration Polling Intervals on Page 321



Adjusting the Performance Polling Intervals on Page 379.

707

Issue 3 May 2012

23.3

WM Release 4.0 User Guide

Using the Summary View The Summary view provides counts of alarms of each severity, events of each severity, and managed devices of each device type.

Figure 459: Summary View in Wireless Manager Ultralight

Each item in the left column of all three tables is a link to a web page that pertains entirely to the item. For example, Mjr in the Alarms table links to a page that displays details on only the alarms of Major severity and contains links to similar pages (each for another severity) and to a page of all alarms.

708

WM Release 4.0 User Guide

Issue 3 May 2012

Figure 460: Alarms (Major) web page in Wireless Manager Ultralight

The events in the system are available from the Summary view in a page scheme similar to that of the alarms.

Figure 461: Events (Critical) web page in Wireless Manager Ultralight

In the Summary view, the links to devices types each open a page that reiterates the linked counts of all managed device types and, beneath the counts, contains a separate block of information about each element that is of the target device type.

Figure 462: Individual device block in Wireless Manager Ultralight

709

Issue 3 May 2012

WM Release 4.0 User Guide

The color of the title bar of each block correlates to the status of the device, and the IP address (Device Name) in the title bar is a link to the device‐specific web page. See

710



Figure 457 on Page 706



Figure 458 on Page 707.

WM Release 4.0 User Guide

23.4

Issue 3 May 2012

Using the Inventory View in Wireless Manager Ultralight The Inventory view in Wireless Manager Ultralight is identical to the individual device type view described immediately above, except that an element block is provided for every element in the system.

Figure 463: Inventory view in Wireless Manager Ultralight

Be aware that the sorted order of the element blocks is by IP address (decimal), so is not by status of the devices. Scrolling reveals the devices whose status may warrant individual attention.

711

Issue 3 May 2012

23.5

WM Release 4.0 User Guide

Using the Alarms View in Wireless Manager Ultralight The Alarms (All) view in Wireless Manager Ultralight is identical to the Alarms (Major) web page shown in Figure 460 on Page 709, except that this view lists the alarms of all severities in the system.

Figure 464: Alarms (All) view in Wireless Manager Ultralight

The bar at the top of this view contains a link for each severity and a link (All) that refreshes this view. Mjr in this bar links to a page that displays details on only the alarms of Major severity and contains links to similar pages (each for another severity) and to this page of all alarms.

712

WM Release 4.0 User Guide

Issue 3 May 2012

In the title bar of each alarm block in the Alarms (All) view, the IP address (Device Name) is a link to the device‐specific web page. See 

Figure 457 on Page 706



Figure 458 on Page 707.

Be aware that the sorted order of the alarm blocks is by the full time stamp on the alarm, so is not by severity of the alarms. Scrolling reveals the alarms whose status may warrant individual attention.

23.6

Using the Events View in Wireless Manager Ultralight The Events (All) view in Wireless Manager Ultralight provides a top bar that contains a link for each severity and a link (All) that refreshes this view. Crt in this bar links to a page that displays details on only the events of Critical severity and contains links to similar pages (each for another severity) and to this page of all events.

Figure 465: Events (All) view in Wireless Manager Ultralight

In the title bar of each event block in the Alarms (All) view, the IP address (Device Name) is a link to the device‐specific web page. See 

Figure 457 on Page 706



Figure 458 on Page 707.

713

Issue 3 May 2012

WM Release 4.0 User Guide

Be aware that the sorted order of the event blocks is by the full time stamp on the event, so is not by severity of the events. Scrolling reveals the events whose status may warrant individual attention.

23.7

Using the Customer Info View in Wireless Manager Ultralight The Events (All) view in Wireless Manager Ultralight provides a list view of customers who have been configured as associated with managed elements.

23.8

Using the Logs View in Wireless Manager Ultralight Wireless Manager Ultralight provides linked access to each plain text log that WM maintains, in a table that also indicates the last time when each was written. The order is alphabetical. The available logs are as follows.

Figure 466: Logs available from Wireless Manager Ultralight

23.9

agent

migration_manager_err

starleafqueueerr

AggregatedDiscoveryLog

mserr

starleafqueueout

alert_audit

msout

stderr

customMapErr

nmserr

stdout

customMapOut

nmsout

SUMLog

DecryptionTool

oakleaferr

system_dash_err

deviceupgrade

oakleafout

system_dash_out

discoveryLogs

php_error

test

mapexporter

ServerAdminLog

transactionLogs

mesherr

spotlight_err

updatemanagerlog

meshout

spotlight_out

wmsout

Terminating the Wireless Manager Ultralight Session At the conclusion of the monitoring session, click the Logout link in the main menu. The web interface returns to the login page.

714

WM Release 4.0 User Guide

Issue 3 May 2012

Legal Notices and License Agreements CAMBIUM NETWORKS, LTD END USER LICENSE AGREEMENT

CAMBIUM NETWORKS, LTD (“Cambium”) is willing to license its Wireless Manager™ software and the accompanying documentation (collectively, the “Software,” as further defined below) to you only on the condition that you accept all the terms in this End User License Agreement (this “Agreement”). IMPORTANT: READ THE FOLLOWING TERMS AND CONDITIONS BEFORE USING THE SOFTWARE AND ANY EQUIPMENT AND/OR PRODUCTS THAT ACCOMPANY THE SOFTWARE. BY CLICKING ON THE “ACCEPT” BUTTON DURING INSTALLATION, YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, UNDERSTAND IT AND AGREE TO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS AGREEMENT, CAMBIUM IS NOT WILLING TO LICENSE THE SOFTWARE TO YOU AND YOU SHOULD CLICK ON THE “DO NOT ACCEPT” BUTTON TO DISCONTINUE THE INSTALLATION PROCESS. IF YOU DO NOT AGREE TO THESE TERMS AND CONDITIONS, YOU MAY, FOR A FULL REFUND: (I) RETURN THE SOFTWARE TO THE ENTITY FROM WHOM YOU PURCHASED IT; OR, (II) FOR DOWNLOADED SOFTWARE, PROVIDE TO THE ENTITY FROM WHOM YOU PURCHASED THE SOFTWARE YOUR WRITTEN VERIFICATION OF DELETION OF ALL COPIES OF THE SOFTWARE. 1. Definitions. In this Agreement, the word “Software” refers to the set of instructions for computing devices, in executable form and in any media (which may include diskette(s), CD‐ROM(s), downloadable Internet file(s), hardware, firmware, etc.), and includes without limitation interfaces, content, fonts, images, photographs, animations, video, audio, music text, “applets” and included data, as well as the accompanying documentation, such as manuals and instructional aids, whether in printed or electronic form, for the software product identified above. 2. General. The Software is licensed, and not sold, to you by Cambium for use only under the terms of this Agreement. Cambium and/or Cambium’s licensor(s) retain all right, title and interest in and to the Software, and the copyrights and other intellectual property rights therein and thereto, and reserve all rights not expressly granted to you in this Agreement. The terms of this Agreement will govern any update(s) and/or upgrade(s) to the Software provided by Cambium that replace and/or supplement the original Software, unless such update(s) and/or upgrade(s) are accompanied by a separate license in which case the terms of that license will govern. 3. Grant of License. Cambium grants you (“Licensee” or “you”) a limited, personal, nonexclusive and non‐ transferable (except as otherwise provided herein) license to use the Software subject to the Conditions of Use set forth in Section 4 and the remaining terms and conditions of this Agreement. Any terms or conditions appearing on the face or reverse side of any purchase order, purchase order acknowledgment or other order document that are different from, or in addition to, the terms of this Agreement will not be binding on the parties, even if payment is accepted. 4. Conditions of Use; Restrictions on Use. The Software is protected by international intellectual property laws and treaties, and other applicable laws. Any use of the Software in violation of the terms and conditions set forth in this Agreement is strictly prohibited and will be deemed a breach of this Agreement. In addition to the other terms and conditions of this Agreement, you agree to the following specific conditions and restrictions: 4.1.

You will use the Software in compliance with all applicable laws, including local laws of the country or region in which you reside or in which you use the Software.

4.2.

Only you, your employees or agents may use the Software. You will take all necessary steps to insure that your employees and agents abide by the terms of this Agreement.

4.3.

You will use the Software: (i) only for your internal business purposes; (ii) only as described in the Software; and, (iii) in strict accordance with this Agreement.

715

Issue 3 May 2012

WM Release 4.0 User Guide

4.4.

You will install and use the Software on a single computing device.

4.5.

To the extent the Software includes features involving maps, you will take all reasonable efforts not exceed 20,000 map page views per year. Cambium reserves the right to disable the usage of features involving maps if your annual usage of map page views exceeds 20,000 map page views.4.6. You will not, and you will not enable others to, copy (except for back‐up purposes as expressly permitted by this Agreement), decompile, bootleg, reverse engineer, disassemble, attempt to derive the source code of, decrypt, modify, translate, or create derivative works from the Software, or any part thereof (except as, and only to the extent, any foregoing restriction is prohibited by applicable law). Any attempt to do so is a violation of the rights of Cambium and/or its licensor(s) in the Software.

4.7.

You will not attempt to defeat any copy protection device included with the Software.

4.8.

If the Software is provided on multiple types of media, you will use only the media that best meets your specific needs, and you will not loan, rent, lease or transfer the other media contained in the package without Cambium’s written consent.

4.9.

You will not remove any proprietary notices, marks, labels, or logos from the Software.

4.10

Unless otherwise provided herein, you will not rent, lease, sublicense or transfer the Software, or any part thereof, to any other party without Cambium’s prior written consent.

4.11. You will not use the Software for any purposes prohibited by applicable law, including without limitation the development, design, manufacture or production of nuclear, missiles, or chemical or biological weapons. USE OF THE SOFTWARE IN ANY MANNER OTHER THAN AS PROVIDED HEREIN IS STRICTLY PROHIBITED AND MAY INFRINGE ON THE INTELLECTUAL PROPERTY RIGHTS OF CAMBIUM AND/OR ITS LICENSOR(S), SUBJECTING YOU TO CIVIL AND CRIMINAL PENALTIES, INCLUDING WITHOUT LIMITATION MONETARY DAMAGES AND IMPRISONMENT FOR COPYRIGHT INFRINGEMENT. 5. Back‐Ups. Notwithstanding anything to the contrary in this Agreement, you may make one (1) copy of the Software in machine‐readable form for back‐up purposes only. If the documentation for the Software is in printed form, it may not be copied. With regard to all copies of the Software permitted herein, you agree to reproduce on such copies all Cambium copyright notices, and other proprietary notices appearing on and in the original Software. 6. Export. You may not export, re‐export or transfer, directly or indirectly, the Software except as authorized by United States law or by the laws of the jurisdiction(s) in which the Software was obtained. By way of example, but without limitation of the foregoing, if your Software was obtained in the United States, the Software may not be exported, re‐exported or transferred: (a) into any U.S. embargoed countries; or, (b) to anyone on the U.S. Treasury Department's list of Specially Designated Nationals or the U.S. Department of Commerce Denied Person’s List or Entity List. By using the Software, you represent and warrant that you are not located in any such country or on any such list. 7. Confidentiality. You acknowledge that the Software contains valuable proprietary information and trade secrets and that unauthorized or improper use of the Software will result in irreparable harm to Cambium for which monetary damages would be inadequate and for which Cambium will be entitled to immediate injunctive relief. Accordingly, you will limit access to the Software to those of your employees and agents who need to use the Software for your internal business purposes, and you will take appropriate action with those employees and agents to preserve the confidentiality of the Software, using the same degree of care to avoid unauthorized or improper disclosure as you use for the protection of your own proprietary software, but in no event less than reasonable care. You have no obligation to preserve the confidentiality of any information that: (i) was in the public domain at the time of disclosure; (ii) entered the public domain through no fault of yours; (iii) was given to you free of any obligation to keep it confidential; (iv) is independently developed by you; or, (v) is disclosed as required by law provided that you notify Cambium prior to such disclosure and provide Cambium with a reasonable opportunity to respond.

716

WM Release 4.0 User Guide

Issue 3 May 2012

8. Right to Use Cambium’s Name. Except as required in Section 5 above, you will not, during the term of this Agreement or thereafter, use any trademark of Cambium, or any word and/or symbol likely to be confused with any Cambium trademark, either alone or in any combination with other words and/or symbols. 9. Transfer. In the case of Software designed to operate on Cambium equipment, you may not transfer the Software to another party except: (i) if you are an end‐user, when you are transferring the Software together with the Cambium equipment on which it operates; or, (ii) if you are a Cambium authorized distributor, when you are transferring the Software either together with such Cambium equipment or are transferring the Software as a licensed duly paid‐for upgrade, update, patch, new release, enhancement or replacement of a prior version of the Software. If you are a Cambium authorized distributor, when you are transferring the Software as permitted in this Agreement, you agree to transfer the Software with a license agreement having terms and conditions no less restrictive than those contained in this Agreement. All transfers of the Software under this Section 9 are strictly subject to the conditions precedent that: (iii) the other party agrees to accept the terms and conditions of this Agreement; and, (ii) you destroy any copy of the Software you do not transfer to that party. Unless otherwise provided herein, the Software may not be transferred, and this Agreement may not be assigned, by you without Cambium’s prior written consent. 10. Upgrades and Updates. If the Software is licensed to you as an upgrade or update to software previously licensed to you, you must destroy the software previously licensed to you, including any copies, within 30 days of your receipt of the Software. 11. Maintenance and Support. Cambium is not responsible for maintenance or support of the Software, or the equipment on which the Software resides or is used, under this Agreement. By accepting the license granted under this Agreement, you agree that Cambium will be under no obligation to provide any support, maintenance or service in connection with the Software or such equipment. Maintenance and support of the Software and/or such equipment by Cambium may be available under the terms of a separate agreement. 12. Limited Warranty. All physical media, such as diskettes or CD‐ROMS, on which the Software is furnished by Cambium (the “Media”) are warranted to be free from manufacturing and material defects for ninety (90) days after the shipment date of the Media to you. Media that becomes defective during such period will be repaired or, at Cambium’s option, replaced. This limited warranty is contingent upon proper use of the Media and does not cover Media that has been tampered with, modified or subjected to unusual physical or electrical stress. Tampering with or removing any factory seal or label on any Media voids this warranty and releases Cambium from any and all liability. The entire liability of Cambium, and your exclusive remedy under the warranty provided in this Section 12 will be, at Cambium’s option, to repair or replace any Media found to be defective within the warranty period, or to refund the purchase price and terminate this Agreement. To seek such a remedy, you must return the Software to Cambium, with a copy of the original purchase receipt, within the warranty period. 13. Disclaimer. EXCEPT FOR THE ABOVE EXPRESS LIMITED WARRANTY FOR THE MEDIA, AND TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE SOFTWARE IS PROVIDED "AS IS" AND “AS AVAILABLE”, WITHOUT WARRANTY OF ANY KIND, AND CAMBIUM ON BEHALF OF ITSELF AND ITS LICENSOR(S) HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS WITH RESPECT TO THE SOFTWARE, EXPRESS, IMPLIED OR STATUTORY, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES AND/OR CONDITIONS OF MERCHANTABILITY, OF SATISFACTORY QUALITY, OF FITNESS FOR A PARTICULAR PURPOSE, OF ACCURACY, OF QUIET ENJOYMENT, AND OF NON‐ INFRINGEMENT OF THIRD PARTY RIGHTS. CAMBIUM ALSO DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED IN, PERFORMED AND/OR PROVIDED BY THE SOFTWARE WILL MEET YOUR REQUIREMENTS, THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR‐FREE, THAT THE SOFTWARE WILL BE COMPATIBLE OR WORK WITH ANY THIRD PARTY SOFTWARE, APPLICATIONS OR DEVICES, OR THAT DEFECTS IN THE SOFTWARE WILL BE CORRECTED. CAMBIUM MAKES NO WARRANTY WITH RESPECT TO THE CORRECTNESS, ACCURACY, OR RELIABILITY OF THE SOFTWARE, AND YOU EXPRESSLY ACKNOWLEDGE AND AGREE THAT, TO THE EXTENT PERMITTED BY APPLICABLE LAW, YOUR USE OF THE SOFTWARE IS AT YOUR SOLE RISK AND THAT THE ENTIRE RISK AS TO SATISFACTORY QUALITY, PERFORMANCE, ACCURACY AND EFFORT IS WITH YOU. YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE IS NOT INTENDED OR SUITABLE FOR USE IN SITUATIONS OR ENVIRONMENTS WHERE THE FAILURE OR TIME DELAYS OF, OR ERRORS OR INACCURACIES IN THE CONTENT, DATA OR INFORMATION PROVIDED BY THE SOFTWARE COULD LEAD TO DEATH, PERSONAL INJURY, OR SEVERE PHYSICAL

717

Issue 3 May 2012

WM Release 4.0 User Guide

OR ENVIRONMENTAL DAMAGE. NO ORAL OR WRITTEN INFORMATION OR ADVICE GIVEN BY CAMBIUM OR AN AUTHORIZED CAMBIUM REPRESENTATIVE SHALL CREATE A WARRANTY. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES OR LIMITATIONS ON APPLICABLE STATUTORY RIGHTS OF A CONSUMER, SO THE ABOVE EXCLUSION AND LIMITATIONS MAY NOT APPLY TO YOU. 14. Limitation of Liability. THE TOTAL LIABILITY OF CAMBIUM FOR ANY DAMAGES UNDER THIS AGREEMENT WILL NOT EXCEED THE TOTAL AMOUNT PAID BY YOU FOR THE SOFTWARE LICENSED UNDER THIS AGREEMENT. TO THE EXTENT NOT PROHIBITED BY APPLICABLE LAW, IN NO EVENT SHALL CAMBIUM BE LIABLE FOR PERSONAL INJURY, OR ANY INCIDENTAL, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES WHATSOEVER, INCLUDING WITHOUT LIMITATION DAMAGES FOR LOSS OF PROFITS, LOSS OF DATA, BUSINESS INTERRUPTION OR ANY OTHER COMMERCIAL DAMAGES OR LOSSES, ARISING OUT OF OR RELATED TO YOUR USE OR INABILITY TO USE THE SOFTWARE, OR ANY THIRD PARTY SOFTWARE, APPLICATIONS AND/OR DEVICES IN CONJUNCTION WITH THE SOFTWARE, HOWEVER CAUSED, REGARDLESS OF THE THEORY OF LIABILITY (CONTRACT, TORT OR OTHERWISE) AND EVEN IF CAMBIUM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SOME JURISDICTIONS DO NOT ALLOW THE LIMITATION OF LIABILITY FOR PERSONAL INJURY, OR OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS LIMITATION MAY NOT APPLY TO YOU. 15. U.S. Government End Users. The Software is a “Commercial Item,” as that term is defined at 48 C.F.R. §2.101, consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §227.7202‐1 through 227.7202‐4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users: (i) only as Commercial Items; and, (ii) with only those rights as are granted to all other end users pursuant to the terms and conditions herein, notwithstanding any other FAR or other contractual clause to the contrary in any agreement into which this Agreement may be incorporated or which Cambium may provide to Government end user. Use of the Software constitutes agreement by the U.S. Government that the Software is Commercial Computer Software and Commercial Computer Software Documentation, and constitutes acceptance of the rights and restrictions herein. Unpublished rights ARE reserved under the copyright laws of the United States. The name and address of the contractor for United States Government end users is: Cambium Networks, Ltd, a company registered in England and Wales under company number 07752773, with an address at 1299 E. Algonquin Road, Schaumburg, IL 60196. 16. Term and Termination. This Agreement, and your right to use the Software, will begin when you click the “ACCEPT” button, which constitutes acceptance of the terms and conditions in this Agreement, and will continue in perpetuity unless terminated as follows. This Agreement will terminate immediately and automatically without notice upon a breach of this Agreement by you. You may also terminate this agreement by ceasing use of the Software. Upon the termination of this Agreement for any reason, you must cease all use of the Software and destroy all copies of the Software in your possession or control. 17. Governing Law and Severability. This Agreement is governed by the laws of the United States of America, to the extent that they apply, and otherwise by the laws of the State of Illinois, excluding its conflicts of laws principles. This Agreement shall not be governed by the United Nations Convention on Contracts for the International Sale of Goods, the application of which is expressly excluded. If for any reason a court of competent jurisdiction finds any provision of this Agreement, or portion thereof, to be unenforceable, the remainder of this Agreement shall continue in full force and effect. 18. Survival. The parties agree that where the context of any provision indicates an intent that it survives the term of this Agreement, then it will survive. 19. Entire Agreement. This Agreement constitutes the entire agreement between you and Cambium relating to the Software licensed hereunder and supersedes all prior or contemporaneous understandings regarding such subject matter. No amendment to or modification of this Agreement will be binding unless in writing and signed by Cambium, except that Cambium may modify and/or translate this Agreement as necessary to comply with applicable laws. In the event of a dispute between the English version and any non‐English versions, the English version of this Agreement shall govern, to the extent not prohibited by the local law in your jurisdiction. 20. Third‐Party Software. The Software may contain one or more items of third‐party software supplied by third‐ party suppliers (collectively, “Third‐Party Software”). The terms of this Agreement govern your use of any Third‐

718

WM Release 4.0 User Guide

Issue 3 May 2012

Party Software UNLESS A SEPARATE THIRD‐PARTY SOFTWARE LICENSE IS INCLUDED, IN WHICH CASE YOUR USE OF THE THIRD‐PARTY SOFTWARE WILL THEN BE GOVERNED BY THE SEPARATE THIRD‐PARTY LICENSE. Use of the Google Maps service is subject to the following additional terms: Google Maps Terms of Service available at http://maps.google.com/help/terms_maps.html and Google Maps Legal Notices at http://maps.google.com/help/legalnotices_maps.html. By using the Software you are agreeing be bound by the terms of use for all Third‐Party Software. If the Software licensed under this Agreement contains publicly available (open source) Third‐Party Software, the terms and conditions governing the use of such publicly available Third‐ Party Software are in the software licenses of the copyright owner(s) of such software and not this Agreement. If there is a conflict between the terms and conditions of this Agreement and the terms and conditions of the publicly available Third‐Party Software license(s) governing your use of the publicly available Third‐Party Software, the terms and conditions of the license of the applicable publicly available Third‐Party Software license(s) will take precedence over the license granted in this Agreement. The license agreements for publicly available Third‐Party Software included by Cambium are available in the file Cambium Publicly Available Software Legal Notices.htm installed in the server file system during installation of the Software. The software license agreements for publicly available Third‐Party Software included by third parties are available in the file Third Party Publicly Available Software Legal Notices.htm installed in the server file system during installation of the Software. 21. Privacy. Your use of the Software is subject to Cambium’s Privacy Policy available at: http://cambiumnetworks.com/legal/terms_of_use.php as well as the Google Maps privacy policy described at http://www.google.com/privacy.html, the terms of which are incorporated herein by reference. IF THE FOREGOING TERMS AND CONDITIONS ARE ACCEPTABLE TO YOU, PLEASE INDICATE YOUR AGREEMENT AND ACCEPTANCE BY CLICKING ON THE BUTTON LABELED “ACCEPT.” IF THE FOREGOING TERMS AND CONDITIONS ARE NOT ACCEPTABLE TO YOU, PLEASE CLICK ON THE “DO NOT ACCEPT” BUTTON. WIRELESS MANAGER™, CAMBIUM™, CAMBIUM NETWORKS™, and the Cambium Networks Logo are trademarks of Cambium Networks, Ltd. © Copyright 2012 Cambium Networks, Ltd All rights reserved.

719

Issue 3 May 2012

WM Release 4.0 User Guide

CAMBIUM PUBLICLY AVAILABLE SOFTWARE LEGAL NOTICES AND END USER LICENSE AGREEMENTS FOR PUBLICLY AVAILABLE SOFTWARE

The Wireless Manager™ software may include Cambium software, commercial third party software, and/or publicly available (open source) software. The Cambium software included in the Wireless Manager™ software is copyright (c) by Cambium Networks, LTD (“Cambium”), and its use is subject to the licenses, terms and conditions of the agreement in force between the purchaser of the Wireless Manager™ software and Cambium. The commercial third party software that may be included in or with the Wireless Manager™ software is subject to the licenses, terms and conditions of the agreement in force between you and Cambium, unless a separate commercial third party software license is included, in which case, your use of the commercial third party software will then be governed by the separate commercial third party license. The publicly available software that may be included in or with the Wireless Manager™ software is listed below. The use of the listed publicly available software is subject to the licenses, terms and conditions of the agreement in force between you and Cambium, as well as the terms and conditions of the license of each publicly available software package. Copies of the licenses for the listed publicly available software, as well as, all attributions, acknowledgements, and software information details, are included below. Cambium is required to reproduce the software licenses, acknowledgments and copyright notices as provided by the authors and owners, thus, all such information is provided in its native language form, without modification or translation. The publicly available software in the list below includes the publicly available software included by Cambium. The publicly available software included by commercial third party software that is used in the Wireless Manager™ software is disclosed in the Third Party Publicly Available Software Legal Notices accompanying the Wireless Manager™ software. For instructions on how to obtain a copy of any source code being made publicly available by Cambium related to software used in the Wireless Manager™ software you may send your request in writing to: Cambium Networks, LTD Attention: Open Source Software Manager 1299 E. Algonquin Road Schaumburg, IL 60196 In your request, please include the version of the Wireless Manager™ software, along with the publicly available software specifics, such as the publicly available software name and version. Note: the source code for the publicly available software may be resident on the Cambium product installation media, or on supplemental Cambium product media and/or Cambium websites. Please reference and review these entire Cambium Publicly Available Software Legal Notices and End User License Agreements for Publicly Available Software for the details on location and methods of obtaining the source code. Note: dependent on the license terms of the publicly available software, source code may not be provided. Please reference and review these entire Cambium Publicly Available Software Legal Notices and End User License Agreements for Publicly Available Software for the details on location and methods of obtaining the source code. To view additional information regarding licenses, acknowledgments and required copyright notices for publicly available software used in the Wireless Manager™ software, please select “Legal Notices” display from the GUI (if applicable), or review the legal notices and end user license agreements in the README files or other files created during installation, in the documentation, on the installation media, or resident in the Wireless Manager™ software. WIRELESS MANAGER™, CAMBIUM™, CAMBIUM NETWORKS™, and the Cambium Networks Logo are trademarks of Cambium Networks, LTD. All other trademarks, logos, and service marks are the property of the respective third party owners. You are not permitted to use any marks without the prior written consent of Cambium or such third party which may own the marks.

720

WM Release 4.0 User Guide

Issue 3 May 2012

Software Included by Cambium

The following are the end user license agreements for publicly available software that Cambium has included. Ant Contrib Version: 1.0b3 Description: The Ant‐Contrib project is a collection of tasks (and at one point maybe types and other tools) for Apache Ant. Used to facilitate automation of build scripts. Software site: http://sourceforge.net/projects/ant‐contrib Source Code: The source packages for Ant Contrib 1.0b3 are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. License:

The Apache Software License, Version 1.1

Copyright (c) 2001‐2003 Ant‐Contrib project. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The end‐user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by the Ant‐Contrib project (http://sourceforge.net/projects/ant‐contrib)." Alternately, this acknowledgment may appear in the software itself, if and wherever such third‐party acknowledgments normally appear. 4. The name Ant‐Contrib must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact ant‐contrib‐developers@lists.sourceforge.net. 5. Products derived from this software may not be called "Ant‐Contrib" nor may "Ant‐Contrib" appear in their names without prior written permission of the Ant‐Contrib project. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ANT‐CONTRIB PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Geo API Version:

2.1

Description: Java library for Geo spatial data manipulation Software site: http://geoapi.sourceforge.net/ Source Code: The source packages for Geo API are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. License:

OGC (Open Geospatial Consortium)

721

Issue 3 May 2012

WM Release 4.0 User Guide

This OGC work (including software, documents, or other related items) is being provided by the copyright holders under the following license. By obtaining, using, and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions: Permission to use, copy, and modify this software and its documentation, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the software and documentation or portions thereof, including modifications, that you make: 1. The full text of this NOTICE in a location viewable to users of the redistributed or derivative work. 2. Any pre‐existing intellectual property disclaimers, notices, or terms and conditions. If none exist, a short notice of the following form (hypertext is preferred, text is permitted) should be used within the body of any redistributed or derivative code: "Copyright © [$date‐of‐document] Open Geospatial Consortium, Inc. All Rights Reserved. http://www.opengeospatial.org/Legal/ (Hypertext is preferred, but a textual representation is permitted.) 3. Notice of any changes or modifications to the OGC files, including the date changes were made. (We recommend you provide URLs to the location from which the code is derived.) THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKENO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITEDTO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THATTHE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTYPATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL ORCONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION. The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the software without specific, written prior permission. Title to copyright in this software and any associated documentation will at all times remain with copyright holders. Javolution Version:

5.2.5

Description: Java library for Geo spatial data manipulation Software site: http://javolution.org/ Source Code: The source packages for Javolution are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. License:

Javolution ‐ Java(tm) Solution for Real‐Time and Embedded Systems

Copyright (c) 2005 ‐ 2007 Javolution (http://javolution.org/). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

722

WM Release 4.0 User Guide

JScience Version:

Issue 3 May 2012

4.3.1

Description: Java library for Geo spatial data manipulation Software site: http://jscience.org Source Code: The source packages for JScience are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. License:

JScience ‐ Java(TM) Tools and Libraries for the Advancement of Sciences

Copyright (C) 2006 ‐ JScience (http://jscience.org/). All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice and include this license agreement. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" ANDANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ONANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. XStream Version:

4.2.6

Description: Java, JSON and XML serialization library Software site: http://xstream.codehaus.org/ Source Code: The source packages for XStream are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. License:

XStream is open source software, made available under a BSD license.

Copyright (c) 2003‐2006, Joe Walnes Copyright (c) 2006‐2007, XStream Committers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of XStream nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH.

723

Issue 3 May 2012 NetCDF Version:

WM Release 4.0 User Guide

2.2.22

Description: Used to calculate latitude/longitude points Software site: http://www.unidata.ucar.edu/software/netcdf‐java/ Source Code: The source packages for NetCDF are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. License:

Portions of this software were developed by the Unidata Program at the University Corporation for Atmospheric Research. Access and use of this software shall impose the following obligations and understandings on the user. The user is granted the right, without any fee or cost, to use, copy, modify, alter, enhance and distribute this software, and any derivative works thereof, and its supporting documentation for any purpose whatsoever, provided that this entire notice appears in all copies of the software, derivative works and supporting documentation. Further, UCAR requests that the user credit UCAR/Unidata in any publications that result from the use of this software or in any product that includes this software, although this is not an obligation. The names UCAR and/or Unidata, however, may not be used in any advertising or publicity to endorse or promote any products or commercial entity unless specific written permission is obtained from UCAR/Unidata. The user also understands that UCAR/Unidata is not obligated to provide the user with any support, consulting, training or assistance of any kind with regard to the use, operation and performance of this software nor to provide the user with any updates, revisions, new versions or "bug fixes." THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE. Yahoo Yui widgets Version: 2.5.2 Description: Javascript based client mapping log widget Software site: http://developer.yahoo.com/yui/ Source Code: The source packages for Yahoo Yui Widgets are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. License:

Software License Agreement (BSD License)

Copyright (c) 2009, Yahoo! Inc. All rights reserved. Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Yahoo! Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission of Yahoo! Inc. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

724

WM Release 4.0 User Guide

Issue 3 May 2012

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. dnsjava Version:

2.0.6

Description: dnsjava is an implementation of DNS in Java. It supports all defined record types (including the DNSSEC types), and unknown types. It can be used for queries, zone transfers, and dynamic updates. Software site: http://www.dnsjava.org/ Source Code: The source packages for dnsjava are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. License: dnsjava is placed under the BSD license. Several files are also under additional licenses; see the individual files for details. Copyright (c) 1999‐2005, Brian Wellington. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the dnsjava project nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Final notes: ‐ Thanks to Network Associates, Inc. for sponsoring some of the original dnsjava work in 1999‐2000. ‐ Thanks to Nominum, Inc. for sponsoring some work on dnsjava from 2000 to the present. Packages That Use Apache License Version 2.0

The following six packages use the Apache License, Version 2.0, January 2004, whose full text is provided under Apache License Version 2.0, January 2004. Axis.jar Version:

1.4

Description: Used to access Prizm APIs exposed through Web Services from WM Software site: http://ws.apache.org/axis/ Source Code: The source packages for Axis are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. JAX RPC 1.1 Version: 1.1 Description: Used to access Prizm APIs exposed through Web Services from WM Software site: http://ws.apache.org/axis/

725

Issue 3 May 2012

WM Release 4.0 User Guide

Source Code: The source packages for JAX RPC 1.1 are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. log4j‐1.2.12.jar Version: 1.2.12 Description: Used to access Prizm APIs exposed through Web Services from WM Software site: http://sourceforge.net/projects/log4j Source Code: The source packages for log4j‐1.5.12.jar are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. wsdl4j‐1.5.1.jar Version: 1.5.1 Description: Used to access Prizm APIs exposed through Web Services from WM Software site: http://sourceforge.net/projects/wsdl4j Source Code: The source packages for wsdl4j‐1.5.1.jar are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. commons‐logging‐1.0.4.jar Version: 1.0.4 Description: Used to access Prizm APIs exposed through Web Services from WM Software site: http://commons.apache.org/logging/ Source Code: The source packages for commons‐logging‐1.0.4.jar are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. commons‐discovery‐0.2.jar Version: 0.2 Description: Used to access Prizm APIs exposed through Web Services from WM Software site: http://commons.apache.org/discovery/ Source Code: The source packages for commons‐discovery‐0.2.jar are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in the preamble of this document. Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall

726

WM Release 4.0 User Guide

Issue 3 May 2012

mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non‐exclusive, no‐charge, royalty‐free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non‐exclusive, no‐charge, royalty‐free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross‐claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a)

You must give any other recipients of the Work or Derivative Works a copy of this License; and

(b)

You must cause any modified files to carry prominent notices stating that You changed the files; and

(c)

You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

(d)

If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third‐party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works

727

Issue 3 May 2012

WM Release 4.0 User Guide

as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON‐ INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third‐party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE‐2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

728

WM Release 4.0 User Guide

Issue 3 May 2012

THIRD PARTY PUBLICLY AVAILABLE SOFTWARE LEGAL NOTICES AND END USER LICENSE AGREEMENTS FOR PUBLICLY AVAILABLE SOFTWARE

The Wireless Manager™ software may include Cambium software, commercial third party software, and/or publicly available (open source) software. The Cambium software included in the Wireless Manager™ software is copyright (c) by Cambium Networks, LTD (“Cambium”), and its use is subject to the licenses, terms and conditions of the agreement in force between the purchaser of the Wireless Manager™ software and Cambium. The commercial third party software that may be included in or with the Wireless Manager™ software is subject to the licenses, terms and conditions of the agreement in force between you and Cambium, unless a separate commercial third party software license is included, in which case, your use of the commercial third party software will then be governed by the separate commercial third party license. The publicly available software that may be included in or with the Wireless Manager™ software is listed below. The use of the listed publicly available software is subject to the licenses, terms and conditions of the agreement in force between you and Cambium, as well as the terms and conditions of the license of each publicly available software package. Copies of the licenses for the listed publicly available software, as well as, all attributions, acknowledgements, and software information details, are included below. Cambium is required to reproduce the software licenses, acknowledgments and copyright notices as provided by the authors and owners, thus, all such information is provided in its native language form, without modification or translation. The publicly available software in the list below includes the publicly available software included by commercial third party software that is used in the Wireless Manager™ software. The publicly available software included by Cambium that is used in the Wireless Manager™ software is disclosed in the Cambium Publicly Available Software Legal Notices and End User License Agreements for Publicly Available Software accompanying the Wireless Manager™ software. For instructions on how to obtain a copy of any source code being made publicly available by Cambium related to software used in the Wireless Manager™ software you may send your request in writing to: Cambium Networks, LTD Attention: Open Source Software Manager 1299 E. Algonquin Road Schaumburg, IL 60196 In your request, please include the version of the Wireless Manager™ software, along with the publicly available software specifics, such as the publicly available software name and version. Note: the source code for the publicly available software may be resident on the Cambium product installation media, or on supplemental Cambium product media and/or Cambium websites. Please reference and review these entire Third Party Publicly Available Software Legal Notices and End User License Agreements for Publicly Available Software for the details on location and methods of obtaining the source code. Note: dependent on the license terms of the publicly available software, source code may not be provided. Please reference and review these entire Third Party Publicly Available Software Legal Notices and End User License Agreements for Publicly Available Software for the details on location and methods of obtaining the source code. To view additional information regarding licenses, acknowledgments and required copyright notices for publicly available software used in the Wireless Manager™ software, please select “Legal Notices” display from the GUI (if applicable), or review the legal notices and end user license agreements in the README files or other files created during installation, in the documentation, on the installation media, or resident in the Wireless Manager™ software. WIRELESS MANAGER™, CAMBIUM™, CAMBIUM NETWORKS™, and the Cambium Networks Logo are trademarks of Cambium Networks, LTD. All other trademarks, logos, and service marks are the property of the respective third party owners. You are not permitted to use any marks without the prior written consent of Cambium or such third party which may own the marks.

729

Issue 3 May 2012

WM Release 4.0 User Guide

Software Included by Commercial Third Party Software

The following are the end user license agreements for publicly available software that commercial third party software has included. openorb_tools‐1.2.0.jar Version: 1.2 Description: CORBA Software Site: http://sourceforge.net/project/showfiles.php?group_id=43608&package_id=36153 Source Code: The source packages for openorb_tools are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. License: The OpenORB Community Software License, Version 1.0 Copyright (C) 2002 The OpenORB Project. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The end‐user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by the OpenORB Community Project (http://sourceforge.net/projects/openorb/)." together with the due credit statements listed below. Alternately, this acknowledgment and due credits may appear in the soft‐ ware itself, if and wherever such third‐party acknowledgments normally appear. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE MEMBERS OF THE OPENORB COMMUNITY PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This software consists of voluntary contributions made by many individuals to the OpenORB Community Project. For more information on the OpenORB Community Project, please refer to http://sourceforge.net/projects/openorb/. Due Credits This product includes software developed by the Apache Software Foundation (http://www.apache.org/), including the Avalon Framework, Avalon Logkit, and related Excalibur utilities. Due credit to the Apache Software Foundation is hereby acknowledged. This product is derived from initial works published under the Exolab Group, (http://www.exolab.org</a>). Due credit to the Exolab Group is hereby acknowledged. Parts of this software are derived from and subject to the terms of the Exolab license. A copy of the Exolab license is contained in respective distributions. Exolab Group License Copyright (C) 1999‐2001 Intalio, Inc. All Rights Reserved.

730

WM Release 4.0 User Guide

Issue 3 May 2012

Redistribution and use of this software and associated documentation ("Software"), with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain copyright statements and notices. Redistributions must also contain a copy of this document. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The name "ExoLab" must not be used to endorse or promote products derived from this Software without prior written permission of ExoLab Group. For written permission, please contact info@exolab.org. 4. Products derived from this Software may not be called "ExoLab" nor may "ExoLab" appear in their names without prior written permission of ExoLab Group. Exolab is a registered trademark of ExoLab Group. 5. Due credit should be given to the ExoLab Group (http://www.exolab.org). THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ''AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. jython.jar Version:

2.1

Description: Jython is an implementation of the high‐level, dynamic, object‐oriented language Python written in 100% Pure Java, and seamlessly integrated with the Java platform. It thus allows you to run Python on any Java platform. Software Site: http://www.jython.org Source Code: The source packages for Jython are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. License: A. TERMS AND CONDITIONS FOR ACCESSING OR OTHERWISE USING JYTHON PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2 1. This LICENSE AGREEMENT is between the Python Software Foundation ("PSF"), and the Individual or Organization ("Licensee") accessing and otherwise using this software ("Jython") in source or binary form and its associated documentation. 2. Subject to the terms and conditions of this License Agreement, PSF hereby grants Licensee a nonexclusive, royalty‐free, world‐wide license to reproduce, analyze, test, perform and/or display publicly, prepare derivative works, distribute, and otherwise use Jython alone or in any derivative version, provided, however, that PSF's License Agreement and PSF's notice of copyright, i.e., "Copyright (c) 2007 Python Software Foundation; All Rights Reserved" are retained in Jython alone or in any derivative version prepared by Licensee. 3. In the event Licensee prepares a derivative work that is based on or incorporates Jython or any part thereof, and wants to make the derivative work available to others as provided herein, then Licensee hereby agrees to include in any such work a brief summary of the changes made to Jython. 4. PSF is making Jython available to Licensee on an "AS IS" basis. PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND DISCLAIMS

731

Issue 3 May 2012

WM Release 4.0 User Guide

ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF JYTHON WILL NOT INFRINGE ANY THIRD PARTY RIGHTS. 5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF JYTHON FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING JYTHON, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF. 6. This License Agreement will automatically terminate upon a material breach of its terms and conditions. 7. Nothing in this License Agreement shall be deemed to create any relationship of agency, partnership, or joint venture between PSF and Licensee. This License Agreement does not grant permission to use PSF trademarks or trade name in a trademark sense to endorse or promote products or services of Licensee, or any third party. 8. By copying, installing or otherwise using Jython, Licensee agrees to be bound by the terms and conditions of this License Agreement. Jython 2.0, 2.1 License Copyright (c) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 Jython Developers. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the Jython Developers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. p6spy.jar Version:

1.3

Description: Debug Tool Software Site: http://www.p6spy.com/ Source Code: The source packages for p6spy.jar are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. License: The P6Spy Software License, Version 1.2 This license is derived and fully compatible with the Apache Software license, see http://www.apache.org/LICENSE.txt. Copyright (c) 2001‐2003 Andy Martin, Ph.D. and Jeff Goke All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

732

WM Release 4.0 User Guide

Issue 3 May 2012

3. The end‐user documentation included with the redistribution, if any, must include the following acknowledgment: The original concept and code base for P6Spy was conceived and developed by Andy Martin, Ph.D. who generously contributed the first complete release to the public under this license. This product was due to the pioneering work of Andy that began in December of 1995 developing applications that could seamlessly be deployed with minimal effort but with dramatic results. This code is maintained and extended by Jeff Goke and with the ideas and contributions of other P6Spy contributors. (http://www.p6spy.com) Alternately, this acknowledgment may appear in the software itself, if and wherever such third‐party acknowledgments normally appear. 4. The names "P6Spy", "Jeff Goke", and "Andy Martin" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact license@p6spy.com. 5. Products derived from this software may not be called "P6Spy" nor may "P6Spy" appear in their names without prior written permission of Jeff Goke and Andy Martin. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Trademark Notices Sun, the Sun logo, Sun Microsystems, JavaSoft, JavaBeans, JDK, Java, HotJava, HotJava Views, Visual Java, Solaris, NEO, Joe, Netra, NFS, ONC, ONC+, OpenWindows, PC‐NFS, SNM, SunNet Manager, Solaris sunburst design, Solstice, SunCore, SolarNet, SunWeb, Sun Workstation, The Network Is The Computer, ToolTalk, Ultra, Ultracomputing, Ultraserver, Where The Network Is Going, Sun WorkShop, XView, Java WorkShop, the Java Coffee Cup logo, and Visual Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. Windows, WindowsNT, and Win32 are registered trademarks of Microsoft Corp. JBoss and JBoss Group are trademarks of Marc Fleury under operation by JBoss Group, LLC. Sybase, SQL Anywhere, and Adaptive Server Anywhere are trademarks of Sybase, Inc. Microsoft SQL Server is a trademark of the Microsoft Corporation. BEA, WebLogic, Tuxedo, and Jolt are registered trademarks, and How Business Becomes E‐Business, BEA WebLogic E‐Business Platform, BEA Builder, BEA eLink, BEA WebLogic Enterprise, BEA WebLogic Express, BEA WebLogic Integration, BEA WebLogic Personalization Server, BEA WebLogic Portal, and BEA WebLogic Server are trademarks of BEA Systems, Inc. Oracle is a registered trademark, and ConText, Oracle Alliance and Oracle8 are trademarks or registered trademarks of Oracle Corporation. DB2, DB2 OLAP Server, WebSphere, and IBM are trademarks or registered trademarks of International. Business Machines Corporation in the United States, other countries or both. MySQL is a trademark of MySQL AB in the United States and other countries. Other product names mentioned herein and throughout the this web site are the trademarks of their respective owners. Zlib Version:

1.1.14

Description: Compression library used by libpng

733

Issue 3 May 2012

WM Release 4.0 User Guide

Software Site: http://www.zlib.net Source Code: The source packages for ZLib are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. License: License zlib.h ‐‐ interface of the 'zlib' general purpose compression library version 1.2.2, October 3rd, 2004 Copyright (C) 1995‐2004 Jean‐loup Gailly and Mark Adler This software is provided 'as‐is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Jean‐loup Gailly jloup@gzip.org Mark Adler madler@alumni.caltech.edu Org.w3c.dom Version: 1 Description: Document Object Model Software Site: http://www.w3.org/DOM Source Code: The source packages for Org.w3c.dom are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. License: http://www.w3.org/Consortium/Legal/2002/copyright‐software‐20021231 This work (and included software, documentation such as READMEs, or other related items) is being provided by the copyright holders under the following license. By obtaining, using and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions. Permission to copy, modify, and distribute this software and its documentation, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the software and documentation or portions thereof, including modifications: The full text of this NOTICE in a location viewable to users of the redistributed or derivative work. Any pre‐existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software Short Notice should be included (hypertext is preferred, text is permitted) within the body of any redistributed or derivative code. Notice of any changes or modifications to the files, including the date changes were made. (We recommend you provide URLs to the location from which the code is derived.) THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER

734

WM Release 4.0 User Guide

Issue 3 May 2012

RIGHTS. COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION. The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the software without specific, written prior permission. Title to copyright in this software and any associated documentation will at all times remain with copyright holders. LibPNG Version:

1.2.5

Description: PNG encoding/decoding Software Site: http://www.libpng.org/pub/png/libpng.html Source Code: The source packages for PNG are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. License: This copy of the libpng notices is provided for your convenience. In case of any discrepancy between this copy and the notices in the file png.h that is included in the libpng distribution, the latter shall prevail. COPYRIGHT NOTICE, DISCLAIMER, and LICENSE: If you modify libpng you may insert additional notices immediately following this sentence. libpng versions 1.2.6, August 15, 2004, through 1.2.35, February 14, 2009, are Copyright (c) 2004, 2006‐2008 Glenn Randers‐Pehrson, and are distributed according to the same disclaimer and license as libpng‐1.2.5 with the following individual added to the list of Contributing Authors: Cosmin Truta libpng versions 1.0.7, July 1, 2000, through 1.2.5 ‐ October 3, 2002, are Copyright (c) 2000‐2002 Glenn Randers‐ Pehrson, and are distributed according to the same disclaimer and license as libpng‐1.0.6 with the following individuals added to the list of Contributing Authors: Simon‐Pierre Cadieux Eric S. Raymond Gilles Vollant and with the following additions to the disclaimer: There is no warranty against interference with your enjoyment of the library or against infringement. There is no warranty that our efforts or the library will fulfill any of your particular purposes or needs. This library is provided with all faults, and the entire risk of satisfactory quality, performance, accuracy, and effort is with the user. libpng versions 0.97, January 1998, through 1.0.6, March 20, 2000, are Copyright (c) 1998, 1999 Glenn Randers‐ Pehrson, and are distributed according to the same disclaimer and license as libpng‐0.96, with the following individuals added to the list of Contributing Authors: Tom Lane Glenn Randers‐Pehrson Willem van Schaik libpng versions 0.89, June 1996, through 0.96, May 1997, are Copyright (c) 1996, 1997 Andreas Dilger Distributed according to the same disclaimer and license as libpng‐0.88, with the following individuals added to the list of Contributing Authors: John Bowler Kevin Bracey Sam Bushell Magnus Holmgren

735

Issue 3 May 2012

WM Release 4.0 User Guide

Greg Roelofs Tom Tanner libpng versions 0.5, May 1995, through 0.88, January 1996, are Copyright (c) 1995, 1996 Guy Eric Schalnat, Group 42, Inc. For the purposes of this copyright and license, "Contributing Authors" is defined as the following set of individuals: Andreas Dilger Dave Martindale Guy Eric Schalnat Paul Schmidt Tim Wegner The PNG Reference Library is supplied "AS IS". The Contributing Authors and Group 42, Inc. disclaim all warranties, expressed or implied, including, without limitation, the warranties of merchantability and of fitness for any purpose. The Contributing Authors and Group 42, Inc. assume no liability for direct, indirect, incidental, special, exemplary, or consequential damages, which may result from the use of the PNG Reference Library, even if advised of the possibility of such damage. Permission is hereby granted to use, copy, modify, and distribute this source code, or portions hereof, for any purpose, without fee, subject to the following restrictions: 1. The origin of this source code must not be misrepresented. 2. Altered versions must be plainly marked as such and must not be misrepresented as being the original source. 3. This Copyright notice may not be removed or altered from any source or altered source distribution. The Contributing Authors and Group 42, Inc. specifically permit, without fee, and encourage the use of this source code as a component to supporting the PNG file format in commercial products. If you use this source code in a product, acknowledgment is not required but would be appreciated. A "png_get_copyright" function is available, for convenient use in "about" boxes and the like: printf("%s",png_get_copyright(NULL)); Also, the PNG logo (in PNG format, of course) is supplied in the files "pngbar.png" and "pngbar.jpg (88x31) and "pngnow.png" (98x31). Libpng is OSI Certified Open Source Software. OSI Certified Open Source is a certification mark of the Open Source Initiative. Glenn Randers‐Pehrson glennrp@users.sourceforge.net February 14, 2009 Packages That Use GNU Lesser General Public License Version 2.1

The following nine packages use the GNU LESSER GENERAL PUBLIC LICENSE, Version 2.1, February 1999, whose full text is provided under GNU Lesser General Public License Version 2.1, February 1999. jasperreports.jar Version: 1.0 Description: Jasper Reports Software Site: http://sourceforge.net/project/showfiles.php?group_id=36382&package_id=28579 Source Code: The source packages for jasperreports.jar are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document.

736

WM Release 4.0 User Guide

Issue 3 May 2012

Jfreechart.jar Version: 0.9.15 Description: Charting tool Software Site: http://sourceforge.net/project/showfiles.php?group_id=15494&package_id=12428 Source Code: The source packages for Jfreechart.jar are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. bsh‐1.2b3.jar Version: 1.2 Description: Scripting files Software Site: Source code not available from AdventNet Source Code: The source packages for bsh‐1.2b3.jar are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. jvcs.jar Version:

2.1

Description: Scripting tool Software Site: http://www.jcvs.org/download/jcvs/jcvs‐522.tgz Source Code: The source packages for Jvcs are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. ftp.jar Version:

2.1

Description: FTP package Software Site: http://www.enterprisedt.com/downloads/ftp/ftp‐1.1.tar.gz Source Code: The source packages for FTP are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. jcommon Version:

1.0.0

Description: General purpose classes used by Jfree chart Software Site: http://www.jfree.org/jcommon/download/ Source Code: The source packages for jcommon are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. MySQL Connector Version: Linux‐MM.MySQL ‐ 3.0.8 Solaris‐MM.MySQL ‐ 3.0.8 Windows‐MM.MySQL ‐ 3.0.8 Description: JDBC Driver Software Site: http://Mysql.com Source Code: The source packages for MySQL Connector are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document.

737

Issue 3 May 2012

WM Release 4.0 User Guide

itext‐1.02b.jar Version: 1.0.2 Description: Text Parser Software Site: http://www.lowagie.com/iText/ Source Code: The source packages for itext are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. j2ssh‐common.jar, j2ssh‐core.jar (SSHTools) Version: j2ssh0.2.7 Description: SSH Tools Software Site: http://sourceforge.net/project/showfiles.php?group_id=60894&package_id=57233 Source Code: The source packages for SSH Tools are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. GNU Lesser General Public License Version 2.1, February 1999 Copyright (C) 1991, 1999 Free Software Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110‐1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the Lesser GPL. It also counts as the successor of the GNU Library Public License, version 2, hence the version number 2.1.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software‐‐to make sure the software is free for all its users. This license, the Lesser General Public License, applies to some specially designated software packages‐‐typically libraries‐‐of the Free Software Foundation and other authors who decide to use it. You can use it too, but we suggest you first think carefully about whether this license or the ordinary General Public License is the better strategy to use in any particular case, based on the explanations below. When we speak of free software, we are referring to freedom of use, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish); that you receive source code or can get it if you want it; that you can change the software and use pieces of it in new free programs; and that you are informed that you can do these things. To protect your rights, we need to make restrictions that forbid distributors to deny you these rights or to ask you to surrender these rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link other code with the library, you must provide complete object files to the recipients, so that they can relink them with the library after making changes to the library and recompiling it. And you must show them these terms so they know their rights. We protect your rights with a two‐step method: (1) we copyright the library, and (2) we offer you this license, which gives you legal permission to copy, distribute and/or modify the library. To protect each distributor, we want to make it very clear that there is no warranty for the free library. Also, if the library is modified by someone else and passed on, the recipients should know that what they have is not the

738

WM Release 4.0 User Guide

Issue 3 May 2012

original version, so that the original author's reputation will not be affected by problems that might be introduced by others. Finally, software patents pose a constant threat to the existence of any free program. We wish to make sure that a company cannot effectively restrict the users of a free program by obtaining a restrictive license from a patent holder. Therefore, we insist that any patent license obtained for a version of the library must be consistent with the full freedom of use specified in this license. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License. This license, the GNU Lesser General Public License, applies to certain designated libraries, and is quite different from the ordinary General Public License. We use this license for certain libraries in order to permit linking those libraries into non‐free programs. When a program is linked with a library, whether statically or using a shared library, the combination of the two is legally speaking a combined work, a derivative of the original library. The ordinary General Public License therefore permits such linking only if the entire combination fits its criteria of freedom. The Lesser General Public License permits more lax criteria for linking other code with the library. We call this license the "Lesser" General Public License because it does Less to protect the user's freedom than the ordinary General Public License. It also provides other free software developers Less of an advantage over competing non‐free programs. These disadvantages are the reason we use the ordinary General Public License for many libraries. However, the Lesser license provides advantages in certain special circumstances. For example, on rare occasions, there may be a special need to encourage the widest possible use of a certain library, so that it becomes a de‐facto standard. To achieve this, non‐free programs must be allowed to use the library. A more frequent case is that a free library does the same job as widely used non‐free libraries. In this case, there is little to gain by limiting the free library to free software only, so we use the Lesser General Public License. In other cases, permission to use a particular library in non‐free programs enables a greater number of people to use a large body of free software. For example, permission to use the GNU C Library in non‐free programs enables many more people to use the whole GNU operating system, as well as its variant, the GNU/Linux operating system. Although the Lesser General Public License is Less protective of the users' freedom, it does ensure that the user of a program that is linked with the Library has the freedom and the wherewithal to run that program using a modified version of the Library. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, whereas the latter must be combined with the library in order to run. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library or other program which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Lesser General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered

739

Issue 3 May 2012

WM Release 4.0 User Guide

only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: * a) The modified work must itself be a software library. * b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. * c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. * d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well‐defined independent of the application. Therefore, Subsection 2d requires that any application‐supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine‐readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange.

740

WM Release 4.0 User Guide

Issue 3 May 2012

If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also combine or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: * a) Accompany the work with the complete corresponding machine‐readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine‐readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) * b) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (1) uses at run time a copy of the library already present on the user's computer system, rather than copying library functions into the executable, and (2) will operate properly with a modified version of the library, if the user installs one, as long as the modified version is interface‐compatible with the version that the work was made with. * c) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. * d) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. * e) Verify that the user has already received a copy of these materials or that you have already sent this user a copy.

741

Issue 3 May 2012

WM Release 4.0 User Guide

For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the materials to be distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side‐by‐side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: * a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. * b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties with this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty‐free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

742

WM Release 4.0 User Guide

Issue 3 May 2012

13. The Free Software Foundation may publish revised and/or new versions of the Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. one line to give the library's name and an idea of what it does. Copyright (C) year name of author This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110‐1301 USA Also add information on how to contact you by electronic and paper mail.

743

Issue 3 May 2012

WM Release 4.0 User Guide

You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. signature of Ty Coon, 1 April 1990 Ty Coon, President of Vice That's all there is to it! Packages That Use Apache Software License Version 1.1

1.2.12

Description: Log Framework Software Site: http://logging.apache.org/log4j/1.2/index.html Source Code: The source packages for Log4j are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. Struts Version:

1.1

Description: Web Framework Software Site: http://www.apache.org/dist/jakarta/struts/binaries/jakarta‐struts‐1.1.zip http://www.ibiblio.org/pub/packages/infosystems/WWW/servers/apache/jakarta/struts/binaries/jakarta‐struts‐ 1.1‐rc1.zip Source Code: The source packages for Struts are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. Apache Version:

2.0.47

Description: The Apache HTTP Server provides a secure, efficient and extensible server that provides HTTP services in sync with the current HTTP standards. Software Site: http://www.apache.org/dist/httpd/ Source Code: The source packages for Apache are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document. TomCat Version:

4.1.27

Description: Apache Tomcat is an implementation of the Java Servlet and JavaServer Pages technologies. The Java Servlet and JavaServer Pages specifications are developed under the Java Community Process. Software Site: http://tomcat.apache.org/download‐41.cgi Source Code: The source packages for TomCat are available from the original software site, or may be acquired from Cambium. To obtain the software from Cambium, please contact Cambium using the methods described in this document.

744

WM Release 4.0 User Guide

Issue 3 May 2012

Apache Software License Version 1.1 Copyright (c) 2001‐2003 Ant‐Contrib project. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The end‐user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by the Ant‐Contrib project (http://sourceforge.net/projects/ant‐contrib)." Alternately, this acknowledgment may appear in the software itself, if and wherever such third‐party acknowledgments normally appear. 4. The name Ant‐Contrib must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact ant‐contrib‐developers@lists.sourceforge.net. 5. Products derived from this software may not be called "Ant‐Contrib" nor may "Ant‐Contrib" appear in their names without prior written permission of the Ant‐Contrib project. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ANT‐CONTRIB PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

745

WM Release 4.0 User Guide

Issue 3 May 2012

Glossary Alarm

Alarms result from traps or other events, which are determined to represent a problem with a network element. Alarms require attention from a user.

Device Group

A list of devices that can be jointly configured or reported upon.

EMS

element management system

Link

A connection between two devices or symbols. 

Logical links are abstract parent‐child relationships that WM can graphically display and that generally indicate a data path between two network elements.



Wireless links are real‐world communications links between devices.



Physical map links are lines drawn between the icons of two devices in the physical map. These are color‐coded according to the presence of logical links between the devices and according to performance data that WM has gathered about the wireless link between the two devices.

Managed Object

The network entity; usually a PMP access point or subscriber module, or a PTP series master or slave device, but can be an IP subnet, an SNMP agent within a device, or any other network abstraction or subdivision.

Network Event

The basic unit of management information that is complete in itself and relates to an occurrence, such as discovery of an element, status update of an element or failure in an element. Events form a repository of information for all the occurrences in the system.

Object

Refer to Managed Object.

PolledData

The basic object used for performance data collection. It contains the details such as what device must be contacted, what data must be collected, and in what time interval. This does not store the collected data. The poll engine reads the PolledData definition and collects data from the network device according to that definition. This is alternatively referred to as a statistic.

Polling

The process of contacting the SNMP agent of a device and collecting data from that device (for example, for a specific SNMP OID).

Statistics



Status polling simply listens for a response to distinguish whether the device is responsive and discards the result.



Performance data polling gathers information about the performance and behavior of the device.



Configuration data polling gathers information about the settings on the device.

Performance data, also termed PolledData because the objects that store the configuration of how performance data statistics are polled are called PolledData objects.

747

Issue 3 May 2012

WM Release 4.0 User Guide

Status Polling

Process of pinging the device and determining its state such as up/down at regular intervals. If Status Polling yields negative results (for example, if the device is not responding), provisions are made to report the condition that requires attention.

Threshold

Minimum and maximum limits for collected performance data statistics. If a collected statistic value violates one of its defined thresholds, then an event (and perhaps a severe alarm) is generated.

748

WM Release 4.0 User Guide

Issue 3 May 2012

Technical Support The main menu selection HelpDiagnostics provides a link to the Customer Support Tool by opening the Support Tool Options window. Before you contact the Cambium support representatives, it is typically advisable to run the Support Tool and avoid deleting any of the files that it generates. After you run the tool and attempt to solve the problem by using the documentation and the troubleshooting methods that its procedures and descriptions imply, you can contact your designated representative as indicated in Contacting Support Representatives on Page 758.

Running the Customer Support Tool WM provides a tool for users on the client application or the administrator on the server to launch when trouble exceeds local diagnostic efforts. This tool assembles into one or more encryptable files most of the information that Support representatives require to diagnose typical problems encountered in WM operations. The tool also allows the operator to split the file to 

enable transmittal of files that the tool outputs as larger than 1.5 MB.



speed up transmittal of files that are between 1 and 1.5 MB in size.

Options for Running the Support Tool Depending on whether the tool is launched from the client application or the WM server, the data may include 

various WM log files.



license file contents and usage, if WM and License Manager run on the same machine.



the platform and environment on which the WM server operates.



device templates, including any that were locally created or modified.



WM configuration (all xml) files.



installation logs.



the identification of all running processes.



individual device data for selected devices.



additional information that you voluntarily enter in the interface to the tool.

If the tool is launched from both the client and the server, then the composite of the data files that the tool produces can include all of the above listed information. By default, the tool stores the output in the file system of the server device.

749

Issue 3 May 2012

WM Release 4.0 User Guide

Running the Tool from the Server When run from the server (by executing C:\Cambium\WM\server\bin\SupportTool.bat or /usr/local/cambium/WM/server/bin/SupportTool.sh), the tool does not collect information from the database. Typically, this is recommended only when the server process is not running. The resulting data is limited to information about the environment, WM configuration files, and extra logs. However, the server administrator can attach additional, locally written scripts in VisualBasic, Perl, shell, and or SQL by adding their file names to an external scripts list in the server. This is especially useful under the direction of a Cambium Support representative.

Running the Tool from the Client Application When run from the server, the tool collects information about the environment and WM configuration files (the same as if it were run from the server), but also collects various WM log files and relevant information from the database, including alarms. Typically, this is recommended when the server process is running. From main menu of the WM client application, you can launch the tool in either of two ways, depending on the results you want. If you want to be able to name and manage the running of the tool as a task and specify its scope and owner, then you should enter the tool from the Task Scheduler. When you launch the Support Tool via the HelpDiagnostics selection from the main menu in the WM client application, the tool assembles a variety of useful information and formats it into individual files that you can 

view the list of files and save them to the local client device.



use the tool to send as email either instantaneously or at a scheduled time and date.

If you select HelpDiagnosticsLaunch Support Tool from the main menu, WM opens the Support Tool Options window, which prompts you to indicate whether you want to launch the tool or select by user (and possibly manage as well) any generated support files that have been stored on the WM server for sharing with the Technical Support staff. An example of this window is shown in Figure 467.

Figure 467: Support Tool Options window

The radio buttons allow you to select whether to

750



launch the tool (see Populating the Fields of the Customer Support Tool Window on Page 751).



view, slim the list of, and locally store or delete the files that the Support Tool has already created when it ran (see Viewing and Saving Files That are Useful for Support on Page 757).

WM Release 4.0 User Guide

Issue 3 May 2012

If you select Run the Support Tool and click OK, WM opens a Task Attributes window. Examples of this window are shown in Figure 468 and in Figure 470: Customer Support Tool dialog, Devices tab with Add selected on Page 756.

Populating the Fields of the Customer Support Tool Window General Information Tab Figure 468: Customer Support Tool dialog, General Information tab

751

Issue 3 May 2012

WM Release 4.0 User Guide

The General Options sections allows you to configure how and when the tool should send email that transmits results. In the Email field, type in an appropriate address and/or add other recipients by first checking the Send Mail option in this section. If you specify multiple recipients, separate the addresses by semicolons. When you are satisfied with the string of the recipient(s), then you can either 

move on to the File Options section, and the tool will automatically send the information that technical support requires, presuming that Send Mail is checked, whenever the Run Now button is clicked.



first recheck Save for later, and the tool will assemble that information and store it in the local folder from which you can later send it. In this case, the tool will not send it for you.

The File Options section allows you to configure how the tool should format the results. If a Report File already exists in the local folder, and you select it using the browse function (click the … ellipsis button), this sets up the tool to gather the latest data into that file whenever you select Run Now. So, the contents of the report file are dynamic. If you want to keep a snapshot that the tool cannot overwrite, move the file to a distinctive file name elsewhere in your file system This section also allows you to optionally 

select Split File to break the directory or file into separate pieces, each not larger than the number of megabytes that you then enter in the Max. File Size (in MB) dialog box, to facilitate transmittal of the file.

important ........... It is recommended to split the report file if it is larger than 1.5 MB (or the server logs are larger than 5 MB). If the resulting file is larger than 1.5 MB and the Split File option is selected, then more than one file is created, each of which is smaller than 1.5 MB. If the report file that is generated is larger than 5 MB, then the tool throws an error and does not send the file via email.



select Encrypt to secure the file such that it can be accessed only with the password that you then enter twice into the dialog boxes provided for that purpose. If you select this option, then you must also separately send the password to technical support. Without it, they will be unable to open the report file.

The Support Information Level section allows you to select the type and depth of information that the tool gathers. Selection of Low or High results in one of the following levels of detail collection:

752

WM Release 4.0 User Guide

Issue 3 May 2012

Table 90: Support Detail levels Detail Level Low

Detail Level High

All of the contents that the tool assembles for Detail Level Low, but also includes all of the contents of the following other files in the WM server file system. 



all files that are in the following directories: −

conf

−

logs

−

apache/logs

−

apache/tomcat/logs

−

conf/devices

−

conf/devices/templates

−

the subdirectories of the mib directory (for broad device types)

all files of the following types −

MIBs in the mib directory (for example, RFC, SNMP, HOST‐ RESOURCES, BRIDGE, ATM, and Printer MIBs)

−

logs of the WM server installation

−

the results of queries executed in predefined scripts on the WM server

When the information collection and assembly succeeds, the system throws success messages similar to the following:

753

Issue 3 May 2012

WM Release 4.0 User Guide

If it fails, the system throws the following types of errors: 

Error in saving file. null



Some file(s) were unable to be saved successfully, some exceptions occurred.

If these errors occur, it is typically because the report file that was generated is larger than 5 MB or because an error occurred in the WM server as it generated the report file. The Additional Information section provides the opportunity to browse to other files (Additional Files) that the tool should attach when it sends email to Customer Support as well as type any explanatory remarks into the Comments dialog box and, if appropriate to do so, modify the Ticket ID. Make note of this ID. This is the number by which both you and technical support personnel will refer to this information and distinguish it from past and future sets of information that are generated for technical support. The number of files that results from the Split File function is the number of separate emails that the tool will send, each with the Ticket ID on the subject line and your Comments in the message body. When you click the … ellipsis button associated with Additional Files, WM opens a Choose a File window. An example is shown in Figure 469.

Figure 469: Choose a File window for additional files to send to Customer Support

754

WM Release 4.0 User Guide

Issue 3 May 2012

This window, with its Add Files button, allows you to include any file from the client device in the data transmittal to technical support. Unlike the other files that the tool assembles, these are not overwritten by later versions when Run Now is selected. These additional files can be of any type. For example, you may send a mix of screen captures, performance charts, and notes of your own observations. After you have added files, you can mark one file at a time in the list and click the Remove Files button to keep the tool from including it in the transmittal. The Report File is an encrypted .enc file or an unencrypted .zip file (or a numbered set of these file types, if the Split File option was selected). The file(s) contains the following directories and files, most of which are from the WM server. The additional_files directory (highlighted below) that the Report File includes the Additional Files that you select from the client device. The index.html file contains links to all of the files, including the Additional Files from the client. Report file contents where WM server operates on Linux

Windows

/additional_files /Boot Information /config /Configuration Data /Devices /devicetemplate0 /Disk Filesystem Information /Environment Information /htmlresources /InstallationLog0 /JDBC Information /Kernel Information /License Status /LicenseFiles0 /logs /Mail Information /mibfiles0 /Miscellaneous Data /Network Configuration /Network Service Information /ODBC Configuration /OS Log Data /Process Information /RPM Information /Services Information /Tool Run Log bottomleftnav.html configuration.html devicetemplate.html index.html InstallationLog.html jdbc_drivers.html LicenseFiles.html log.html main.html mibfiles.html topleftnav.html

755

Issue 3 May 2012

WM Release 4.0 User Guide

When you are finished populating the fields of the General Information tab, click the Devices tab.

Devices Tab Figure 470: Customer Support Tool dialog, Devices tab with Add selected

To select device groups from whose membership to load devices into the Add/Remove Devices panel of this tab

756

click the Load From Group button.

click to highlight the row of an individual device group in the Device Groups window.

click the Load button.

repeat Steps 1 through 3 to load devices from another device group.

WM Release 4.0 User Guide

Issue 3 May 2012

For any loaded device whose data you do not want included in the support files 1.

click to highlight the individual device(s).

click the Remove button.

To add devices by individual selection 1.

click the Add button.

click to highlight the individual devices in the Add Device window.

click the Add button to load the devices and to dismiss the Add Device window.

For the remaining devices, you may need to provide the radio login ID and password so that WM can obtain the data as HTML pages. For these devices 1.

click, Ctrl+click, or Shift+click to highlight devices whose login ID and password are in common among each other.

click the LoginID/Password button.

complete the Update Device LoginID/Password form.

click OK.

repeat Steps 1 through 4 for any others.

Execution When you are finished populating the fields of both tabs, select either 

Run Now, to instantaneously launch the data collection and formatting.



Run Later, to schedule the task of running the tool.

Viewing and Saving Files That are Useful for Support note ............. It is generally advisable to run the Support Tool and avoid deleting any of the files that it generates.

If you select HelpDiagnosticsLaunch Support Tool from the main menu, WM opens the Support Tool Options window, an example of which is shown in Figure 467 on Page 750. The radio buttons allow you to select whether to 

launch the tool (see Running the Customer Support Tool on Page 749).



view, slim the list of, and locally store or delete the files that the Support Tool has already created when it ran.

757

Issue 3 May 2012

WM Release 4.0 User Guide

If you then select Get saved support tool files and click OK, WM opens a Saved Support Files window. An example of this window is shown in Figure 471.

Figure 471: Saved Support Files window

In this window, you can change the user field to view a different set of files, delete any old or unwanted files, and save any to a directory on the client device.

Contacting Support Representatives You can obtain support for Wireless Manager from any or all of the following sources:

758



Wireless Manager setup guide, administration guide, and release notes.



Cambium Networks support web page: http://www.cambiumnetworks.com/support. This page provides links to information on all products and tools, as well as access to customer support materials and interactive support forums. Some of these resources are restricted to registered users and channel partners.



the Community Forum. Visit http://www.cambiumnetworks.com/forum/.

WM Release 4.0 User Guide

Issue 3 May 2012



direct contact with Cambium Networks Technical Support. This contact is available 7 days a week, 24 hours a day. To find the appropriate phone number based on your country or region, visit http://www.cambiumnetworks.com/support/technical.php.



a technical support case, which you can open at http://www.cambiumnetworks.com/support/support_case.php. The case captures basic information about answers you are seeking or the problem that your network is experiencing and provides this to the support team, who are available 7 days a week, 24 hours a day, and will respond. They will also provide a case number by which you and they can continue to track progress on issues that require deeper investigation.

759

WM Release 4.0 User Guide

Issue 3 May 2012

Index A Alarm .....................................................................747 Alarm Count Panel.................................................364 Alarm Details .........................................................364 Alarm Filters ..........................................................525 Alarm History.........................................................364 Alarm Viewer .........................................................364 Alarms....................................................................364 AlertAssignDialog...................................................364 Alerts .............................................480, 503, 529, 540 Annotation.............................................................364 Annotation and History .........................................364 Area Chart..............................................................384 Assign To................................................................364 Assigning Operations .....................................482, 484 Assigning Users ......................................................458 Audit Trails.....................................450, 453, 454, 475

B Bar Chart................................................................384 Broadcast Message................................................681

C Cannot plot [Data is String type] ...........................384 Clear Alarms...........................................................364 Clear Graph............................................................384 Client‐side sorting..................................................102 Collected Statistics(P) ............................................384 CollectedGraphViewer...........................................384 Configured Collection ............................................382 Configuring Trap Parsers .......................................489 Container ...............................................................747 Context‐Sensitive Help ............................................43 Critical Alarms........................................................364 Custom View Scopes..... 459, 460, 462, 463, 464, 465, 535

D Data Collection ..............................................544, 571 Data Collection Details ..........................................382 Date Range Setting incorrect.................................384 Deleting Groups.....................................................466 Deleting Operations...............................................486

Deleting Users................................................449, 459 Details ....................................................................102 Device Discovery Options ......................................432 Device Specific Discovery ......................................421 Discovery Configurator . 399, 400, 401, 402, 403, 404, 405, 407, 408, 409, 410, 411, 414, 415, 416, 417, 418, 420, 422, 423, 424, 425, 426, 428, 429, 430, 431 Document Conventions ...........................................43

E Event Details..........................................................345 Event Filters ...........................470, 494, 509, 510, 522 Event Parsers ................. 470, 494, 499, 500, 507, 510 Event Viewer..........................................................345 Events ....................................................................345

F Fewer .....................................................................345 Find ........................................................................345 First Page ...............................................................102

G Gateway.................................................................747 Graphs ...................................................................384

H Help .........................................................................43 Historical Performance Data..................................384 History ...................................................................364

I Installation Guide ....................................................43

L Last Page................................................................102 Line Chart...............................................................384 Link ........................................................................747 Log Settings............................................................694 Logging Configuration....................................694, 698

761

Issue 3 May 2012

WM Release 4.0 User Guide

Runtime Administration ........................471, 694, 697

Major Alarms .........................................................364 Managed Object ....................................................747 Managing Operations ............................................467 Managing Users .....................................................438 Map Symbol...........................................................747 Match all of the following......................................345 Match any of the following....................................345 Merge ....................................................................364 Minor Alarms .........................................................364 More ......................................................................345

N Navigating Through the Table ...............................102 Network Events .............................................345, 747 Next Page...............................................................102 No data available ...................................................384 Node ......................................................................747

O Object ....................................................................747

P Page Length ...........................................................102 Pick Up ...................................................................364 Plot Chart...............................................................384 Polled Data ............................................................747 Polling Properties ..................................................747 Previous Page ........................................................102 Print .......................................................................345 Printing Events.......................................................345 Product Support ......................................................43 Protocol Configuration ..........................................410

R Range of Table Details ...........................................102 Re‐arranging and Re‐sizing Columns .....................102 Refresh...................................................................102 Related Alarms.......................................................345 Related Events .......................................................364 Reports ..................................................................384 Row Details ............................................................102

Save To File ............................................................345 Saving Events .........................................................345 Scatter Chart..........................................................384 Searching Alarms ...................................................364 Searching Events....................................................345 Security Management ...................................435, 535 Send to all client ....................................................681 Send to my FE client only.......................................681 Server‐side sorting.................................................102 severity ..................................................................364 Sorting Table Details..............................................102 Statistics.................................................................747 Status Polling .........................................................747

T Table ......................................................................102 Table View Operations ..........................................102 Threshold...............................................................747 Thresholds .... 543, 554, 561, 564, 571, 580, 582, 584, 588 Thresholds .............................................................382 Trap Parsers .. 479, 489, 490, 497, 498, 499, 506, 508, 521, 525

U UnPick....................................................................364 Update ...................................................................364 User Password .......................................................448 User Profile ....................................445, 446, 447, 475

V View history...........................................................364 Viewing Alarms ......................................................364

W Warning Alarms .....................................................364

X X‐Y Chart ................................................................384

762