Embed Size (px)
Citation preview
EMC CorporationCorporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000www.EMC.com
EMC Backup Advisor2.0.1
ADMINISTRATOR’S GUIDE300-004-336 A01
EMC Backup Advisor 2.0.1 Administrator’s Guideii
Copyright © 2005- 2006 EMC Corporation. All rights reserved.EMC Backup Advisor 2.0.1 Administrator’s Guide
Published August, 2006
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.
All other trademarks used herein are the property of their respective owners.
EMC Backup Advisor 2.0.1 Administrator’s Guideiii
Contents
Audience .........................................................................................................................................................xxiii.
Organization....................................................................................................................................................xxiii.
Related Documentation...................................................................................................................................xxiv.
Conventions Used in This Guide ....................................................................................................................xxiv.
Where to Get Help ..........................................................................................................................................xxiv.
Your Comments ............................................................................................................................................... xxv.
Chapter 1: Introduction ...........................................................................................................27.
Architecture........................................................................................................................................................ 27.
The Server Component ...................................................................................................................................... 31.
Database...................................................................................................................................................... 31.
The Controller Process................................................................................................................................ 32.
The Listener Process ................................................................................................................................... 32.
The Reporter Process .................................................................................................................................. 33.
The Predictive Analysis Engine (PAE) Process ......................................................................................... 33.
The Publisher Process ................................................................................................................................. 33.
The Standard Graphical User Interface....................................................................................................... 33.
The Lite Graphical User Interface ..............................................................................................................34.
The Collector Component .................................................................................................................................. 34.
Chapter 2: Getting Started ......................................................................................................37.
Logging into EMC Backup Advisor .................................................................................................................. 37.
Logging into Networker.............................................................................................................................. 38.
Logging into EMC Backup Advisor for Non NetWorker Environments ................................................... 40.
Licensing............................................................................................................................................................ 41.
Changing Your Password................................................................................................................................... 44.
Chapter 3: Configuring Users .................................................................................................45.
Creating a User................................................................................................................................................... 45.
Editing a User..................................................................................................................................................... 47.
Deleting a User................................................................................................................................................... 48.
LDAP Authentication ........................................................................................................................................ 48.
User Preferences ................................................................................................................................................ 49.
Configuring Appearance............................................................................................................................. 52.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Contents
iv
Chapter 4: Configuring Views and Nodes ..............................................................................57.
The Navigation tree ........................................................................................................................................... 57.
Working with Views .......................................................................................................................................... 60.
Creating a View .......................................................................................................................................... 60.
Changing a View ........................................................................................................................................ 61.
Editing a View ............................................................................................................................................ 61.
Deleting a View .......................................................................................................................................... 62.
Restricting a User to a View....................................................................................................................... 62.
Working with Nodes .......................................................................................................................................... 63.
Creating a Node .......................................................................................................................................... 64.
Assigning a Node........................................................................................................................................ 66.
Editing a Node ............................................................................................................................................ 69.
Unassigning a Node.................................................................................................................................... 70.
Deleting a Node .......................................................................................................................................... 71.
Queries ............................................................................................................................................................... 71.
Standard Queries......................................................................................................................................... 72.
Creating a Standard Query .................................................................................................................. 73.
Advanced Queries....................................................................................................................................... 74.
Creating an Advanced Query .............................................................................................................. 75.
Running Queries ......................................................................................................................................... 76.
Attributes ........................................................................................................................................................... 76.
Creating an Attribute .................................................................................................................................. 77.
Editing an Attribute .................................................................................................................................... 78.
Deleting an Attribute .................................................................................................................................. 78.
Chapter 5: Configuring Requests............................................................................................79.
Viewing Requests .............................................................................................................................................. 80.
Assigning a Request to a Node .......................................................................................................................... 80.
Unassigning a Request................................................................................................................................ 81.
Reloading the Collector ..................................................................................................................................... 81.
Editing a Request ............................................................................................................................................... 83.
Creating a Request ............................................................................................................................................. 85.
Deleting a Request ............................................................................................................................................. 85.
Remote Data Collection..................................................................................................................................... 85.
Creating a Credential ......................................................................................................................................... 87.
Editing a Credential ........................................................................................................................................... 88.
Deleting a Credential ......................................................................................................................................... 88.
Contents
EMC Backup Advisor 2.0.1 Administrator’s Guidev
Chapter 6: Monitoring Devices and Applications .................................................................89.
Backup Applications .......................................................................................................................................... 89.
NetWorker .................................................................................................................................................. 89.
VERITAS NetBackup................................................................................................................................. 90.
Configuring NetBackup Authentication for Remote Data Collection................................................. 91.
Tivoli Storage Manager .............................................................................................................................. 91.
Monitoring TSM Remotely ................................................................................................................. 92.
Configuring a TSM Server in EMC Backup Advisor ......................................................................... 94.
HP OpenView Storage Data Protector........................................................................................................ 95.
Monitoring HP Data Protector Remotely ............................................................................................ 95.
Configuring a HP Data Protector Server in EMC Backup Advisor .................................................... 97.
VERITAS Backup Exec ............................................................................................................................. 97.
Monitoring Backup Exec Remotely .................................................................................................... 97.
Configuring a Backup Exec Server in EMC Backup Advisor ............................................................ 98.
Oracle RMAN............................................................................................................................................. 99.
Monitoring Oracle RMAN Remotely.................................................................................................. 99.
Configuring EMC Backup Advisor for Oracle RMAN....................................................................... 99.
System Monitoring........................................................................................................................................... 100.
Monitoring a Windows Host Remotely .................................................................................................... 101.
Tape Libraries .................................................................................................................................................. 104.
Fibre Channel Switches ................................................................................................................................... 104.
IP Switches....................................................................................................................................................... 105.
Network Appliance Filers and NearStores....................................................................................................... 105.
Filer Configuration ................................................................................................................................... 105.
Configuring NetApp monitoring in EMC Backup Advisor...................................................................... 106.
EMC CLARiiON Disk Libraries ..................................................................................................................... 106.
ACSLS .............................................................................................................................................................107.
Chapter 7: Configuring Time Windows ...............................................................................109.
Specifying a Time Period................................................................................................................................. 109.
Creating a New Time Window ........................................................................................................................ 110.
Editing a Time Window............................................................................................................................ 111.
Deleting a Time Window.......................................................................................................................... 111.
Creating Time Definitions ............................................................................................................................... 112.
Editing a Time Definition ......................................................................................................................... 113.
Deleting a Time Definition ....................................................................................................................... 113.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Contents
vi
Chapter 8: Configuring Schedules ........................................................................................115.
Using the Schedule Editors.............................................................................................................................. 115.
Using the Basic Editor ..................................................................................................................................... 117.
Window Schedules ................................................................................................................................... 117.
Point-in-Time Schedules .......................................................................................................................... 118.
Using the Advanced Editor.............................................................................................................................. 120.
Schedule Component Editor ..................................................................................................................... 121.
Dates .................................................................................................................................................. 122.
Hours ................................................................................................................................................. 123.
Days................................................................................................................................................... 125.
Every N Days Filter.................................................................................................................... 125.
Week Filter ................................................................................................................................. 126.
Month Filter................................................................................................................................ 127.
Weeks ................................................................................................................................................ 128.
Week Filter ................................................................................................................................. 129.
Month Filter................................................................................................................................ 130.
Months............................................................................................................................................... 131.
Chapter 9: Configuring Analysis Save Sets..........................................................................133.
Rulesets and Analyses ..................................................................................................................................... 133.
Assigning an Analysis Save Set....................................................................................................................... 134.
Creating an Analysis Save Set ......................................................................................................................... 139.
Editing an Analysis Save Set ........................................................................................................................... 141.
Deleting an Analysis Save Set ......................................................................................................................... 141.
Chapter 10: Using the Ruleset Editor ...................................................................................143.
Ruleset Basics .................................................................................................................................................. 143.
Creating a Simple Ruleset................................................................................................................................ 145.
Complex Rulesets ............................................................................................................................................ 155.
Testing a Ruleset.............................................................................................................................................. 157.
Chapter 11: Configuring Menus ...........................................................................................159.
Tree Menus ...................................................................................................................................................... 159.
Report Menu .................................................................................................................................................... 160.
Creating a Menu............................................................................................................................................... 160.
Adding a Report Menu Item..................................................................................................................... 163.
Adding a Control Panel Menu Item.......................................................................................................... 165.
Adding a Command Menu Item ............................................................................................................... 165.
Contents
EMC Backup Advisor 2.0.1 Administrator’s Guidevii
Removing a Menu Item or Folder............................................................................................................. 166.
Positioning Menu Items ............................................................................................................................ 166.
Configuring Menu Item Permissions ........................................................................................................ 167.
Copying a Menu............................................................................................................................................... 167.
Editing a Menu................................................................................................................................................. 167.
Deleting a Menu............................................................................................................................................... 167.
Users and Menus.............................................................................................................................................. 168.
Chapter 12: Configuring Reports .........................................................................................169.
Accessing the Report Editor ............................................................................................................................ 169.
Understanding Reports..................................................................................................................................... 170.
Creating a Simple Report ................................................................................................................................. 171.
Creating Report Content .................................................................................................................................. 180.
Customizing Data Sources........................................................................................................................ 180.
Data Source Label.............................................................................................................................. 181.
Data Source Fields............................................................................................................................. 182.
Data Source Times............................................................................................................................. 183.
Specifying the Start Time and End Time Fields ........................................................................ 184.
Interval Type and Values............................................................................................................185.
Data Source Nodes ............................................................................................................................ 187.
Data Source Conditions ..................................................................................................................... 187.
Data Source Limits ............................................................................................................................ 191.
Data Source Order ............................................................................................................................. 193.
Data Source Options .......................................................................................................................... 193.
Customizing Operators ............................................................................................................................. 194.
Operator Label ................................................................................................................................... 194.
Operator Parameters .......................................................................................................................... 195.
Operator Conditions........................................................................................................................... 195.
Operator Fields .................................................................................................................................. 196.
External Data Sources............................................................................................................................... 196.
Customizing the Appearance of a Report ........................................................................................................ 199.
Common Report Appearance Parameters................................................................................................. 199.
Common Table-based Report Appearance Parameters ............................................................................ 200.
Table Style ......................................................................................................................................... 200.
Table Fields ....................................................................................................................................... 202.
Cell Styles.......................................................................................................................................... 203.
Detailed Table Report Menu Parameter ............................................................................................ 207.
Summary Table Column Links Parameter ........................................................................................ 208.
Report Card Report Type.......................................................................................................................... 208.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Contents
viii
Field Mapping ................................................................................................................................... 209.
Status Styles....................................................................................................................................... 210.
Report Link........................................................................................................................................ 211.
Common Chart-based Report Appearance Parameters ............................................................................ 212.
Chart Style ......................................................................................................................................... 212.
Series Styles....................................................................................................................................... 213.
Legend Option ................................................................................................................................... 215.
Report Menu...................................................................................................................................... 215.
y-axis ................................................................................................................................................. 216.
Chart Labels....................................................................................................................................... 218.
Trend Chart Specific Appearance Parameters.......................................................................................... 219.
Data Views ........................................................................................................................................ 219.
Area Chart and Stacked Area Chart Appearance Parameters................................................................... 222.
Bar Charts and Stacked Bar Charts Appearance Parameters.................................................................... 223.
3D Bar Options.................................................................................................................................. 223.
x-axis ................................................................................................................................................. 224.
Bubble Chart Appearance Parameters ...................................................................................................... 226.
y-axis Parameter ......................................................................................................................... 227.
Bubble Chart Field Selection ..................................................................................................... 227.
Candle Chart Appearance Parameters ...................................................................................................... 228.
Candle Field Mapping ....................................................................................................................... 228.
Pie Chart Appearance Parameters ............................................................................................................ 229.
Pie Chart Fields ................................................................................................................................. 230.
Pie 3D Options .................................................................................................................................. 231.
3D Surface Chart and 3D Bar Chart Appearance Parameters .................................................................. 231.
z-axis.................................................................................................................................................. 232.
3D Rendering Options....................................................................................................................... 233.
Rotation ............................................................................................................................................. 234.
Editing a Report ............................................................................................................................................... 235.
Deleting a Report ............................................................................................................................................. 235.
Exporting a Report........................................................................................................................................... 235.
Chapter 13: Configuring Control Panels..............................................................................237.
Creating a Control Panel.................................................................................................................................. 237.
Changing the Background of a Control Panel .......................................................................................... 239.
Adding a Label to a Control Panel ........................................................................................................... 241.
Adding an Image to a Control Panel......................................................................................................... 242.
Adding a Report to a Control Panel.......................................................................................................... 244.
Contents
EMC Backup Advisor 2.0.1 Administrator’s Guideix
Running a Control Panel from Navigation tree ............................................................................................... 248.
Setting an Initial Control Panel ........................................................................................................................ 248.
Editing a Control Panel .................................................................................................................................... 249.
Copying a Control Panel .................................................................................................................................. 250.
Deleting a Control Panel .................................................................................................................................. 250.
Chapter 14: Scheduling Reports ...........................................................................................251.
Creating a Scheduled Report............................................................................................................................ 251.
Editing a Scheduled Report.............................................................................................................................. 254.
Deleting a Scheduled Report............................................................................................................................ 255.
Testing a Scheduled Report ............................................................................................................................. 255.
Chapter 15: Database Maintenance ......................................................................................257.
Backing up the Database.................................................................................................................................. 257.
Restoring the Database..................................................................................................................................... 257.
Performance Tuning......................................................................................................................................... 258.
Implementing a Datamine Maintenance Plan .................................................................................................. 258.
Chapter 16: System Settings ..................................................................................................265.
Database ........................................................................................................................................................... 266.
Controller ......................................................................................................................................................... 267.
Reporter............................................................................................................................................................ 268.
Listener.............................................................................................................................................................268.
Collector........................................................................................................................................................... 269.
GUI................................................................................................................................................................... 269.
The Publisher Process ...................................................................................................................................... 270.
The Web Application Process.......................................................................................................................... 270.
Appendix A: Analysis Save Set Definitions.......................................................... 271.
Capacity Planning ............................................................................................................................................ 271.
Change Management........................................................................................................................................ 272.
Configuration ................................................................................................................................................... 273.
Data Protection................................................................................................................................................. 274.
Licensing.......................................................................................................................................................... 276.
Performance ..................................................................................................................................................... 276.
Provisioning ..................................................................................................................................................... 277.
Resource Utilization......................................................................................................................................... 277.
Service Level Agreements ............................................................................................................................... 279.
Status ................................................................................................................................................................ 279.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Contents
x
Troubleshooting ............................................................................................................................................... 281.
EMC Backup Advisor 2.0.1 Administrator’s Guidexi
List of Tables
Table 1. User Properties Fields .................................................................................................................................... 47
Table 2. LDAP Configuration Fields ........................................................................................................................... 48
Table 3. User Reporting Preferences............................................................................................................................ 50
Table 4. Navigator Node Types ................................................................................................................................... 63
Table 5. Node Properties .............................................................................................................................................. 65
Table 6. Attributes Properties Fields ............................................................................................................................ 77
Table 7. Request Properties.......................................................................................................................................... 84
Table 8. Proxy Configuration Fields ............................................................................................................................ 86
Table 9. Creating a Credential...................................................................................................................................... 87
Table 10. System Monitoring Modules ...................................................................................................................... 100
Table 11. Window Properties Fields .......................................................................................................................... 111
Table 12. Schedule Component Types....................................................................................................................... 120
Table 13. Analysis Engine Alert Types...................................................................................................................... 135
Table 14. Alert Parameters ......................................................................................................................................... 137
Table 15. Email Parameters........................................................................................................................................ 137
Table 16. Email Report Parameters............................................................................................................................ 137
Table 17. SNMP Parameters ...................................................................................................................................... 138
Table 18. CBE Parameters ......................................................................................................................................... 138
Table 19. Script Field Parameters .............................................................................................................................. 138
Table 20. Analysis Parameters ................................................................................................................................... 140
Table 21. Report Element Variables .......................................................................................................................... 149
Table 22. Report Properties Fields ............................................................................................................................. 171
Table 23. EMC Backup Advisor Report Types ......................................................................................................... 177
Table 24. Start and End Time Values......................................................................................................................... 185
Table 25. Interval Types............................................................................................................................................. 185
Table 26. Node Selection Fields................................................................................................................................. 187
Table 27. Condition Fields ......................................................................................................................................... 188
EMC Backup Advisor 2.0.1 Administrator’s Guide
List of Tables
xii
Table 28. Data Source Limit Fields ............................................................................................................................192
Table 29. Operator Parameters Fields.........................................................................................................................195
Table 30. CSV File Parameters...................................................................................................................................197
Table 31. Report Title Editor Parameters ...................................................................................................................200
Table 32. Table Style Editor Fields ............................................................................................................................201
Table 33. Report Card Field Definitions.....................................................................................................................209
Table 34. Chart Style Editor Parameters.....................................................................................................................213
Table 35. Show Legend Option ..................................................................................................................................215
Table 36. Y Axis Parameter Editor Fields ..................................................................................................................217
Table 37. Trend Chart Parameters ..............................................................................................................................219
Table 38. Data View Editor Fields..............................................................................................................................221
Table 39. Appearance Parameters...............................................................................................................................222
Table 40. Bar Charts and Stacked Bar Charts Appearance Parameters......................................................................223
Table 41. Bubble Chart Appearance Parameters ........................................................................................................226
Table 42. Candle Chart Appearance Parameters ........................................................................................................228
Table 43. Pie Chart Appearance Parameters...............................................................................................................229
Table 44. 3D Surface Chart and 3D Bar Chart Parameters ........................................................................................231
Table 45. 3D Rendering Options Editor Fields...........................................................................................................233
Table 46. Report Properties Fields..............................................................................................................................245
Table 47. Basic Properties ..........................................................................................................................................252
Table 48. Content Properties.......................................................................................................................................252
Table 49. Action Properties ........................................................................................................................................253
Table 50. Group Values ..............................................................................................................................................261
Table 51. Type Values ................................................................................................................................................261
Table 52. Database Parameters ...................................................................................................................................266
Table 53. Controller Parameters .................................................................................................................................267
Table 54. Reporter Parameters....................................................................................................................................268
Table 55. Listener Parameters.....................................................................................................................................268
Table 56. Collector Parameters ...................................................................................................................................269
Table 57. GUI Parameters...........................................................................................................................................269
Table 58. Publisher Parameters...................................................................................................................................270
List of Tables
EMC Backup Advisor 2.0.1 Administrator’s Guidexiii
Table 59. Web Application Parameters...................................................................................................................... 270
Table 60. Capacity Planning ...................................................................................................................................... 271
Table 61. Change Management.................................................................................................................................. 272
Table 62. Configuration ............................................................................................................................................. 273
Table 63. Data Protection........................................................................................................................................... 274
Table 64. Licensing .................................................................................................................................................... 276
Table 65. Performance ............................................................................................................................................... 276
Table 66. Provisioning ............................................................................................................................................... 277
Table 67. Resource Utilization................................................................................................................................... 277
Table 68. Service Level Agreement ........................................................................................................................... 279
Table 69. Status .......................................................................................................................................................... 279
Table 70. Troubleshooting ......................................................................................................................................... 281
EMC Backup Advisor 2.0.1 Administrator’s Guide
List of Tables
xiv
EMC Backup Advisor 2.0.1 Administrator’s Guidexv
List of Figures
Figure 1. EMC Backup Advisor Architecture............................................................................................................28
Figure 2. NetWorker Environments ...........................................................................................................................29
Figure 3. Non NetWorker Architecture......................................................................................................................30
Figure 4. EMC Backup Advisor Server Architecture ................................................................................................31
Figure 5. Database Architecture.................................................................................................................................32
Figure 6. Collector Architecture.................................................................................................................................34
Figure 7. Memory Module Functions ........................................................................................................................35
Figure 8. Proxy Requests ...........................................................................................................................................36
Figure 9. NetWorker Console Launch Page...............................................................................................................38
Figure 10. NMC Login...............................................................................................................................................38
Figure 11. NMC User Interface..................................................................................................................................39
Figure 12. EMC Backup Advisor Launch Page.........................................................................................................40
Figure 13. Login Screen .............................................................................................................................................40
Figure 14. License Warning Message ........................................................................................................................41
Figure 15. License Manager.......................................................................................................................................41
Figure 16. File Selection ............................................................................................................................................42
Figure 17. License Confirmation ...............................................................................................................................42
Figure 18. License Manager.......................................................................................................................................43
Figure 19. EMC Backup Advisor GUI.......................................................................................................................43
Figure 20. Changing Your Password .........................................................................................................................44
Figure 21. User List....................................................................................................................................................46
Figure 22. Creating a User .........................................................................................................................................46
Figure 23. LDAP Configuration.................................................................................................................................48
Figure 24. Testing LDAP Credentials........................................................................................................................49
Figure 25. User Properties..........................................................................................................................................50
Figure 26. Configuring Chart Appearance.................................................................................................................52
Figure 27. Configuring Color.....................................................................................................................................53
EMC Backup Advisor 2.0.1 Administrator’s Guide
List of Figures
xvi
Figure 28. Color Properties ........................................................................................................................................53
Figure 29. Font Properties..........................................................................................................................................54
Figure 30. Chart Appearance .....................................................................................................................................55
Figure 31. Navigation Tree ........................................................................................................................................57
Figure 32. Basic Views and Nodes ............................................................................................................................58
Figure 33. EMC Backup Advisor Tree Hierarchy .....................................................................................................59
Figure 34. View List ..................................................................................................................................................60
Figure 35. View Properties ........................................................................................................................................60
Figure 36. Changing a View ......................................................................................................................................61
Figure 37. Editing a View ..........................................................................................................................................62
Figure 38. Node List ..................................................................................................................................................64
Figure 39. Group Properties.......................................................................................................................................64
Figure 40. Node Properties ........................................................................................................................................65
Figure 41. Assigning a Node to a Group ...................................................................................................................67
Figure 42. Node List ..................................................................................................................................................67
Figure 43. Assigning Nodes to Groups ......................................................................................................................68
Figure 44. Editing a Node ..........................................................................................................................................69
Figure 45. Node Properties ........................................................................................................................................70
Figure 46. Unassigning a Node..................................................................................................................................71
Figure 47. Query Properties, Standard.......................................................................................................................73
Figure 48. Query Properties, Advanced.....................................................................................................................75
Figure 49. Navigation Tree with Query Nodes..........................................................................................................76
Figure 50. Attribute Properties...................................................................................................................................77
Figure 51. Node Properties ........................................................................................................................................78
Figure 52. Viewing Assigned Requests .....................................................................................................................80
Figure 53. Request Properties ....................................................................................................................................81
Figure 54. Reloading the Collectors ..........................................................................................................................82
Figure 55. Request List ..............................................................................................................................................83
Figure 56. Request Properties ....................................................................................................................................83
Figure 57. Remote Data Collection............................................................................................................................85
Figure 58. Proxy Properties .......................................................................................................................................86
List of Figures
EMC Backup Advisor 2.0.1 Administrator’s Guidexvii
Figure 59. Credential Properties.................................................................................................................................87
Figure 60. Master Server Properties...........................................................................................................................91
Figure 61. TSM Client Install ....................................................................................................................................92
Figure 62. TSM Custom Setup...................................................................................................................................93
Figure 63. TSM Configuration Wizard ......................................................................................................................93
Figure 64. TSM Configuration Wizard, Options File Task .......................................................................................94
Figure 65. Installing HP Data Protector Client ..........................................................................................................96
Figure 66. Modifying Service Logon Rights for EMC Backup Advisor Collector ...................................................98
Figure 67. Modifying Service Login Rights for EMC Backup Advisor Collector ..................................................102
Figure 68. Credential Parameters for WMI..............................................................................................................103
Figure 69. Proxy Properties for WMI ......................................................................................................................103
Figure 70. Time Windows........................................................................................................................................109
Figure 71. Window List ...........................................................................................................................................110
Figure 72. Window Properties .................................................................................................................................110
Figure 73. Time List.................................................................................................................................................112
Figure 74. Time Properties.......................................................................................................................................112
Figure 75. Schedule List...........................................................................................................................................115
Figure 76. Schedule Properties - Basic Schedule Editor..........................................................................................116
Figure 77. Schedule Properties - Advanced Schedule Editor ..................................................................................117
Figure 78. Schedule Properties - Window Schedules ..............................................................................................118
Figure 79. Schedule Component Properties .............................................................................................................118
Figure 80. Schedule Properties - Point in Time Schedules ......................................................................................119
Figure 81. Schedule Component Properties .............................................................................................................119
Figure 82. Schedule Properties - Advanced Schedule Editor ..................................................................................120
Figure 83. Scheduled Component Properties ...........................................................................................................121
Figure 84. Schedule Component Properties - Type .................................................................................................121
Figure 85. Schedule Component Properties - Dates ................................................................................................122
Figure 86. Dates for Point In Time ..........................................................................................................................122
Figure 87. Editing the Date Fields ...........................................................................................................................123
Figure 88. Editing the Hours Fields .........................................................................................................................124
Figure 89. Filtered Hours Parameter ........................................................................................................................124
EMC Backup Advisor 2.0.1 Administrator’s Guide
List of Figures
xviii
Figure 90. Editing the Days Fields...........................................................................................................................125
Figure 91. Every N Days Filter ................................................................................................................................126
Figure 92. Week Filter .............................................................................................................................................127
Figure 93. Month Filter ............................................................................................................................................128
Figure 94. Editing the Weeks Fields ........................................................................................................................129
Figure 95. Week Filter .............................................................................................................................................129
Figure 96. Month filter.............................................................................................................................................130
Figure 97. Editing the Months Fields.......................................................................................................................131
Figure 98. Months Filter ..........................................................................................................................................132
Figure 99. Assigned Analysis ..................................................................................................................................134
Figure 100. Assigning an Analysis ..........................................................................................................................135
Figure 101. Configuring an Alert.............................................................................................................................136
Figure 102. Analysis List .........................................................................................................................................139
Figure 103. Analysis Properties ...............................................................................................................................140
Figure 104. Example Analysis .................................................................................................................................141
Figure 105. Ruleset List ...........................................................................................................................................143
Figure 106. Ruleset Properties .................................................................................................................................144
Figure 107. Creating a New Ruleset ........................................................................................................................145
Figure 108. Input Element Properties ......................................................................................................................146
Figure 109. Defining Input Parameters....................................................................................................................146
Figure 110. Defining Ruleset Input Parameters.......................................................................................................147
Figure 111. Adding Report Element to a Ruleset ....................................................................................................148
Figure 112. Defining Report Element Properties.....................................................................................................148
Figure 113. Specifying Report Element Conditions ................................................................................................149
Figure 114. Updated Ruleset with Report Properties ..............................................................................................150
Figure 115. Property Editor .....................................................................................................................................150
Figure 116. Adding a Ruleset Condition Element ...................................................................................................151
Figure 117. Condition Properties .............................................................................................................................151
Figure 118. Adding the Ruleset Event Element.......................................................................................................152
Figure 119. Event Properties....................................................................................................................................153
Figure 120. Updated CPU Busy Ruleset..................................................................................................................154
List of Figures
EMC Backup Advisor 2.0.1 Administrator’s Guidexix
Figure 121. Completed Ruleset ................................................................................................................................155
Figure 122. Defining a New Variable ......................................................................................................................156
Figure 123. A Rule Set with a Variable and Branch Elements ................................................................................156
Figure 124. Testing a Ruleset...................................................................................................................................157
Figure 125. Sample Navigation Menu .....................................................................................................................160
Figure 126. Menu List ..............................................................................................................................................161
Figure 127. Menu Properties ....................................................................................................................................161
Figure 128. Adding a Folder ....................................................................................................................................162
Figure 129. Creating a Menu Item ...........................................................................................................................163
Figure 130. Adding a Report Menu Item .................................................................................................................164
Figure 131. Specifying a Report Name....................................................................................................................164
Figure 132. Adding a Control Panel.........................................................................................................................165
Figure 133. Adding a Command ..............................................................................................................................165
Figure 134. Menu Item Permissions ........................................................................................................................167
Figure 135. Report List ............................................................................................................................................170
Figure 136. Report Properties ..................................................................................................................................171
Figure 137. Report Item Properties ..........................................................................................................................172
Figure 138. Selecting the Data Source .....................................................................................................................173
Figure 139. Adding Backup Job Details ..................................................................................................................174
Figure 140. Selecting an Operator............................................................................................................................174
Figure 141. Adding the Count Operator...................................................................................................................175
Figure 142. Link the Report Item.............................................................................................................................176
Figure 143. Adding a Report Item ...........................................................................................................................176
Figure 144. Specifying a Report Type .....................................................................................................................177
Figure 145. Bar Chart Report Toolbar .....................................................................................................................179
Figure 146. Sample Data ..........................................................................................................................................179
Figure 147. Displaying Report Results ....................................................................................................................180
Figure 148. Customizing a Data Source...................................................................................................................181
Figure 149. Data Source Field Selection..................................................................................................................182
Figure 150. Data Source Time Selection .................................................................................................................183
Figure 151. Point in Time Report.............................................................................................................................184
EMC Backup Advisor 2.0.1 Administrator’s Guide
List of Figures
xx
Figure 152. Node Selection......................................................................................................................................187
Figure 153. Data Source Condition Expression.......................................................................................................188
Figure 154. Condition ..............................................................................................................................................188
Figure 155. Example Condition ...............................................................................................................................189
Figure 156. Updated Condition Expression.............................................................................................................190
Figure 157. Updated Condition Expression.............................................................................................................190
Figure 158. Updated Condition Expression.............................................................................................................191
Figure 159. Data Source Limit Selection.................................................................................................................192
Figure 160. Order Selection .....................................................................................................................................193
Figure 161. Data Source Options .............................................................................................................................193
Figure 162. Operator Options ..................................................................................................................................194
Figure 163. Multiply Operator Parameters ..............................................................................................................195
Figure 164. Operator Field Selection .......................................................................................................................196
Figure 165. Read CSV File Parameters ...................................................................................................................197
Figure 166. Configured Parameter List....................................................................................................................198
Figure 167. Complex Report Item ...........................................................................................................................198
Figure 168. Detailed Table Report Toolbar .............................................................................................................199
Figure 169. Report Title Editor................................................................................................................................199
Figure 170. Table Style Editor .................................................................................................................................201
Figure 171. Table Fields Editor ...............................................................................................................................202
Figure 172. Styles Editor .........................................................................................................................................203
Figure 173. Style Editor ...........................................................................................................................................204
Figure 174. Conditions.............................................................................................................................................204
Figure 175. Condition ..............................................................................................................................................205
Figure 176. Conditions.............................................................................................................................................205
Figure 177. Updated Conditions ..............................................................................................................................206
Figure 178. Updated Style Editor ............................................................................................................................206
Figure 179. Updated Styles Editor ...........................................................................................................................207
Figure 180. Report Menu Selection .........................................................................................................................207
Figure 181. Report Links Editor ..............................................................................................................................208
Figure 182. Example Report Card ...........................................................................................................................209
List of Figures
EMC Backup Advisor 2.0.1 Administrator’s Guidexxi
Figure 183. Report Card Field Mapping ..................................................................................................................210
Figure 184. Style Editor ...........................................................................................................................................210
Figure 185. Adding a Style Rule ..............................................................................................................................211
Figure 186. Updated Style Editor.............................................................................................................................211
Figure 187. Report Link Editor ................................................................................................................................212
Figure 188. Chart Style Editor .................................................................................................................................213
Figure 189. Series Style Editor ................................................................................................................................214
Figure 190. Adding a Series Style............................................................................................................................214
Figure 191. Legend Option ......................................................................................................................................215
Figure 192. Menu Selection .....................................................................................................................................216
Figure 193. y-Axis Editor.........................................................................................................................................217
Figure 194. Chart Labels Enabled on a Bar Chart ...................................................................................................218
Figure 195. Chart Label Editor ................................................................................................................................218
Figure 196. Report Example with Two Data Views ................................................................................................220
Figure 197. Data Views Editor.................................................................................................................................221
Figure 198. 3D Bar Option.......................................................................................................................................224
Figure 199. Stacked Bar Chart x-axis Over Time....................................................................................................225
Figure 200. Stacked Bar Chart at Point In Time ......................................................................................................225
Figure 201. x-axis Editor..........................................................................................................................................226
Figure 202. Bubble Chart y-axis Parameter .............................................................................................................227
Figure 203. Bubble Chart Field Selection................................................................................................................228
Figure 204. Candle Field Mapping ..........................................................................................................................229
Figure 205. Pie Chart Field Selection ......................................................................................................................230
Figure 206. Pie Chart 3D Option Editor ..................................................................................................................231
Figure 207. z-axis Editor ..........................................................................................................................................232
Figure 208. 3D Rendering Options Editor ...............................................................................................................233
Figure 209. Rotation Editor......................................................................................................................................234
Figure 210. Control Panel List .................................................................................................................................238
Figure 211. Control Panel Editor .............................................................................................................................238
Figure 212. Control Panel Background....................................................................................................................239
Figure 213. Image Selection.....................................................................................................................................240
EMC Backup Advisor 2.0.1 Administrator’s Guide
List of Figures
xxii
Figure 214. Updated Control Panel with Background.............................................................................................241
Figure 215. Label Properties ....................................................................................................................................241
Figure 216. Updated Control Panel..........................................................................................................................242
Figure 217. Properties ..............................................................................................................................................243
Figure 218. Updated Control Panel..........................................................................................................................243
Figure 219. Adding a Report to a Control Panel......................................................................................................244
Figure 220. Report Properties ..................................................................................................................................245
Figure 221. Report Parameter Toolbar ....................................................................................................................246
Figure 222. Testing a Report on Control Panel .......................................................................................................247
Figure 223. Completed Control Panel......................................................................................................................247
Figure 224. Control Panel Report ............................................................................................................................248
Figure 225. User Properties .....................................................................................................................................249
Figure 226. Creating a Scheduled Report ................................................................................................................252
Figure 227. Assigning Datamine Maintenance Plans ..............................................................................................259
Figure 228. Datamine Maintenance Plan Properties................................................................................................260
Figure 229. Plan Item Properties..............................................................................................................................260
Figure 230. Updated Maintenance Plan...................................................................................................................262
Figure 231. Datamine Maintenance Plan Editor ......................................................................................................262
Figure 232. Datamine Maintenance Plan Assignments ...........................................................................................263
Figure 233. System Settings.....................................................................................................................................265
EMC Backup Advisor 2.0.1 Administrator’s Guide xxiii
Preface
As part of its effort to continuously improve and enhance the performance and capabilities of EMC Backup Advisor, EMC periodically releases new versions of its hardware and software. Therefore, some functions described in this Admininstration Guide may not be supported by all revisions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes.
AudienceThis guide is part of the EMC Backup Advisor documentation set, and is intended for use by the system administrators who are responsible for setting up the database and making sure that reports are enabled for users who need them. All functions available to the System Administrator user ID are described in this document. Those functions available to users for running and printing reports are described in the EMC Backup Advisor 2.0 User’s Guide.
OrganizationThis guide is organized as follows:
• "Chapter 1: Introduction" on page 27• "Chapter 2: Getting Started" on page 37• "Chapter 3: Configuring Users" on page 45• "Chapter 4: Configuring Views and Nodes" on page 57• "Chapter 5: Configuring Requests" on page 79• "Chapter 6: Monitoring Devices and Applications" on page 89• "Chapter 7: Configuring Time Windows" on page 109• "Chapter 8: Configuring Schedules" on page 115• "Chapter 9: Configuring Analysis Save Sets" on page 133• "Chapter 10: Using the Ruleset Editor" on page 143• "Chapter 11: Configuring Menus" on page 159• "Chapter 12: Configuring Reports" on page 169• "Chapter 13: Configuring Control Panels" on page 237• "Chapter 14: Scheduling Reports" on page 251• "Chapter 15: Database Maintenance" on page 257• "Chapter 16: System Settings" on page 265• "Appendix A: Analysis Save Set Definitions" on page 271
EMC Backup Advisor 2.0.1 Administrator’s Guide
Preface
xxiv
Related DocumentationThis documentation set contains the following manuals:
• EMC Backup Advisor 2.0 Administrator’s Guide• EMC Backup Advisor2.0 Installation Guide• EMC Backup Advisor 2.0 User’s Guide• EMC Backup Advisor 2.0 Release Notes
Conventions Used in This GuideThis document uses the following typographic conventions and symbols to make information easier to access and understand.
Where to Get HelpFor information about software patches, technical documentation, support programs, sales, and licensing, go to:
http://softwaresupport.EMC.com
Convention Indicates Example
boldface Names of line commands, daemons, options, programs, or scripts
The nsradmin command starts the command line version of the NetWorker Administrator program.
italic in text Pathnames, filenames, computer names, new terms defined in the Glossary or within the chapter, or emphasized words
Displayed messages are also written to /nsr/logs/daemon.log.
The specifications are created, one for each swap file, in c:\pagefile.sys.
italic in command line
A variable that must be provided in the command line
nwadmin -s server_name
fixed-width Examples and information displayed on the screen
media waiting: recover waiting for 8mm 5GB tape volume name
fixed-width, boldface
Commands and options that must be entered exactly as shown
nsr_shutdown -a
Menu_Name>Command
A path or an order to follow for making selections in the user interface
Volume>Change Mode>Appendable
Important: Information that must be read and followed to ensure successful backup and recovery of data
Important: Use the no_verify option with extreme caution.
Preface
EMC Backup Advisor 2.0.1 Administrator’s Guidexxv
Your CommentsComments and suggestions about our product documentation are always welcome.
To provide feedback:
1. Go to:
http://softwaresupport.EMC.com
2. Click the Documentation link.
3. Click the "Technical Publications Customer Survey" link at the top of the page to comment on a particular guide.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Preface
xxvi
EMC Backup Advisor 2.0.1 Administrator’s Guide27
Chapter 1: Introduction
The purpose of this document is to provide EMC (R) Backup Advisor administrators with the information required to configure and administer the product. For information on installing EMC Backup Advisor, see the EMC Backup Advisor Installation Manual.
This chapter introduces EMC Backup Advisor, providing an overview of its architecture and describing its main components. It contains the following sections:
• "Architecture" on page 27• "The Server Component" on page 31• "The Collector Component" on page 34
ArchitectureEMC Backup Advisor is an advanced backup reporting and analysis application that gives its users complete visibility into everything happening within their backup environment. EMC Backup Advisor gathers data from your backup application, backup servers, backup clients, network switches, storage area network (SAN) switches, and tape libraries.
The EMC Backup Advisor Graphical User Interfaces correlate information and give the user the ability to perform advanced reporting, troubleshooting, performance management, and capacity planning. The EMC Backup Advisor Predictive Analysis Engine actively monitors the environment and notifies the user through SNMP traps or emails of events that have occurred or that are expected to occur based on predictive trending. The EMC Backup Advisor Publisher sends automated reports via email or saves them for viewing later on a web server. Figure 1 on page 28 displays a high level view of the architecture.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 1: Introduction
28
1
Figure 1. EMC Backup Advisor Architecture
EMC Backup Advisor is capable of monitoring not only EMC NetWorker TM backup applications, but also backup application software provided by other vendors. For more details of the products supported, refer to the list of supported applications in the EMC Backup Advisor 2.0 Installation Guide.
In NetWorker environments, EMC Backup Advisor integrates with NetWorker Management Console (NMC). NMC must be installed before EMC Backup Advisor. When integrated with NMC, EMC Backup Advisor shares the database with NMC and the user interface can be launched from the NMC console. A high level architecture diagram showing EMC Backup Advisor integrated with NMC can be seen in Figure 2 on page 29.
Chapter 1: Introduction
EMC Backup Advisor 2.0.1 Administrator’s Guide29
1
Figure 2. NetWorker Environments
In non NetWorker environments, EMC Backup Advisor does not require NetWorker Management Console. You can configure EBA to use either an embedded database that is included with the product, or an external database. In non NetWorker environments, the GUI is launched from a web browser. A high-level architecture diagram for non NetWorker environments is shown in Figure 3 on page 30.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 1: Introduction
30
1
Figure 3. Non NetWorker Architecture
EMC Backup Advisor consists of two components:
• EMC Backup Advisor Server—The Server component stores all collected data in a relational database and manages the EMC Backup Advisor configuration. The server component contains several core processes, including the:
•Standard Graphical User Interface, which is used to configure the product and run reports. The standard graphical user interface is a Java based UI, that requires the user to have Java installed on the machines it will run on•Lite Graphical User Interface, a HTML based user interface that provides a simple mechanism to run reports on clients that do not have Java available•Publisher process, which is used to generate reports on a scheduled basis•Predictive Analysis Engine, which generates alerts when certain conditions occur in the environment
• EMC Backup Advisor Collector—The Collector component gathers data on a device or application and sends it back to the server. Several Collectors can be installed on different machines, all communicating with the same server
The following sections provide details on each component.
Chapter 1: Introduction
EMC Backup Advisor 2.0.1 Administrator’s Guide31
1The Server Component
The EMC Backup Advisor Server component is the core component of the product that manages all data stored within the system and provides the methods for the user to view data and to receive alerts. Figure 4 displays the EMC Backup Advisor Server architecture.
Figure 4. EMC Backup Advisor Server Architecture
Several processes run on the EMC Backup Advisor Server. The processes include:
• Database• The Controller Process• The Listener Process• The Reporter Process• The Predictive Analysis Engine (PAE) Process• The Publisher Process• The Standard Graphical User Interface• The Lite Graphical User Interface
The following sections describe each component of the server.
DatabaseThe database is at the core of the product and stores all of the data collected by EMC Backup Advisor Server as well as configuration information about the product.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 1: Introduction
32
1
In NetWorker environments, EMC Backup Advisor uses the same database installed by the NetWorker Management Console (NMC) NMC must, therefore, be installed before EMC Backup Advisor.
In non NetWorker environments, EMC Backup Advisor can work with an embedded iAnyWhere database that is automatically installed on the server during the install process, or with an external database that must be supplied and managed by the customer. If you are using an external database, the database must be installed before the EMC Backup Advisor software. EMC Backup Advisor supports different databases depending on the server’s platform. For more details about the supported database platforms, see the EMC Backup Advisor Installation Guide.
In the database, EMC Backup Advisor segregates the configuration information stored in the system from data that has been collected by the Collector processes. The default names for these databases are config and datamine, as shown in Figure 5 on page 32.
Figure 5. Database Architecture
The Controller ProcessThe Controller process manages all configuration information stored within the EMC Backup Advisor database. This includes information about what data should be collected and how often it should be collected. It communicates with the database using the database’s native programming interfaces, and presents to other components an open XML based API that allows them to obtain, update, and create configuration information in the database. It is critical that the Controller process is running at all times for EMC Backup Advisor to function normally.
You can modify the behavior of the Controller process by altering certain configuration settings. Details of how to modify these settings are provided in "Chapter 16: System Settings" on page 265.
The Listener ProcessThe Listener process receives data collected by Collectors and processes the information, inserting or updating information in the database so that you can report on that data. It is critical that this process is running at all times for EMC Backup Advisor to function normally. If this process is not running collected data will not be logged to the database.
You can modify the behavior of the Listener process by altering several configuration settings. Details on how to modify these settings are provided in "Chapter 16: System Settings" on page 265.
Chapter 1: Introduction
EMC Backup Advisor 2.0.1 Administrator’s Guide33
1
The Reporter ProcessThe Reporter process receives report requests from the GUI, Predictive Analysis Engine (PAE), or Publisher processes, extracts data from the database, formats a result set as an XML string, and sends it back to the calling process over the network. It communicates with the database using the database’s native programming interfaces. It is critical that this process is running at all times for EMC Backup Advisor to function normally. If the Reporter process is not running, it will not be possible to run reports in the GUI, Publisher or PAE.
You can modify the behavior of the Reporter process by altering several configuration settings. Details on how to modify these are provided in "Chapter 16: System Settings" on page 265.
The Predictive Analysis Engine (PAE) ProcessThe PAE process analyzes the data stored in the database and monitors user-specified conditions. When these conditions are met, the PAE either sends SNMP traps or emails, or executes command line scripts that can be used to perform recovery actions or pass information into other products. It is not critical that the PAE runs at all times, but if the PAE is not running, EMC Backup Advisor cannot monitor your backup environment and generate alerts.
You can modify the behavior of the PAE by altering certain configuration settings. Details on how to modify these are provided in "Chapter 16: System Settings" on page 265.
The Publisher ProcessThe Publisher process automatically generates reports on a scheduled basis. You can distribute reports via email, or by saving the reports to disk. Users can view the reports that are written to disk using a web browser. When saving reports to disk, you can distribute emails to users, sending them a link to the report’s URL on the server to which they were saved. Users can then click the link and view the reports. It is not critical that the Publisher runs at all times, but if the Publisher is not running, no scheduled reports will be published.
The behavior of the Publisher process can be modified by altering a number of configuration settings. Details of how to modify these are contained in "Chapter 16: System Settings" on page 265.
The Standard Graphical User InterfaceThe Standard Graphical User Interface (GUI) is the main interface for all EMC Backup Advisor users. The Standard GUI is a Java based interface that requires that the user has Java installed on the machine in which the GUI will run. All configuration and reporting functions can be carried out using the Standard GUI.
In NetWorker environments, the Standard GUI can be launched from within NetWorker Management Console (NMC). In non NetWorker environments, you launch the Standard GUI using a browser from a web page on the EMC Backup Advisor server. For more details on how to start the Standard GUI, refer to the EMC Backup Advisor User Manual.
You can modify the GUI’s behavior by altering certain configuration settings, which are described in "Chapter 16: System Settings" on page 265.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 1: Introduction
34
1
The Lite Graphical User InterfaceThe Lite Graphical User Interface (GUI) is a secondary interface that can be used by users that do not have Java installed on their machines. It provides the ability to run reports and save the results, but has no ability to perform the same level of interactive drill down available in the Standard GUI or any capabilities to configure the product.
For more details on how to launch the Lite GUI, refer to the EMC Backup Advisor User Manual.
The Collector ComponentThe Collector process gathers data from applications, hosts, and devices. When the Collector starts, it communicates with the Controller process on the EMC Backup Advisor Server to determine what to monitor and how often to monitor it. The configuration information returns in the form of a series of data gathering requests. The Collector performs these requests and sends the collected data back to the Listener process on the EMC Backup Advisor Server. All communication to and from the Collector process happens through an XML-based API.
A Collector is installed automatically on the EMC Backup Advisor Server when the Server component is installed. This provides the ability to monitor devices and applications remotely, although this may require the installation of additional software on the EMC Backup Advisor server. Additional Collectors can be installed onto any other supported host in the environment. Installing Collectors on additional machines enhances the amount and types of data that you can collect because you cannot collect all data types of remotely.
The Collector process is split into a core component and a set of modules that implement data gathering routines as displayed in Figure 6. The core component communicates with the Controller process on the Server to obtain its configuration and to schedule the data collection requests. When data is returned from a module, the core component formats the response into XML and sends it back to the Listener process on the Server. If a network interruption or Server failure occurs, the Collector process stores this data until the Listener process becomes available.
Figure 6. Collector Architecture
Each module in the Collector is implemented as either a shared library or DLL depending, on the platform on which the Collector is running. This modular design means that new modules can be easily added to the Collector to enhance its data collection capabilities.
Chapter 1: Introduction
EMC Backup Advisor 2.0.1 Administrator’s Guide35
1
Each module has several functions that are used to gather different types of data. Structuring the data gathering in each module into a series of functions allows you to gather different types of data at different rates. For example, the memory module implements three functions: configuration, status, and performance as shown Figure 7 on page 35.
• The configuration function gathers information on the amount of memory that exists on the host. As this information does not frequently change, this information is gathered once a day
• The status function gathers information on the amount of memory that is currently being used. This information changes very frequently, thus it this is gathered every five minutes
• The performance function gathers information on memory performance in terms of how much memory is being paged in and out of virtual memory stored on disk. Again, as this information changes fairly frequently and is gathered every five minutes
Figure 7. Memory Module Functions
You can configure a Collector process to monitor certain types of data remotely. When performing remote monitoring, the machine on which the Collector is running is called the proxy host. To gather data, the Collector uses a remote protocol to communicate with the machine from which it is collecting data, then forwards that information back to the EMC Backup Advisor Server as shown in Figure 8. The remote protocol type depends on the type of data that is being gathered.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 1: Introduction
36
1
Figure 8. Proxy Requests
Not all information can be gathered remotely from all applications and devices that are supported by EMC Backup Advisor. For more information on what data can be collected remotely, and how to configure it see "Chapter 6: Monitoring Devices and Applications" on page 89.
EMC Backup Advisor 2.0.1 Administrator’s Guide37
Chapter 2: Getting Started
EMC Backup Advisor is an advanced backup reporting and analysis application that gives the user complete visibility into everything happening within their backup environment. This chapter describes how to log into the EMC Backup Advisor user interface, change your initial password, and load the license required to enable software. It contains the following sections:
• "Logging into EMC Backup Advisor" on page 37• "Licensing" on page 41• "Changing Your Password" on page 44
EMC Backup Advisor includes a standard GUI that is Java based, and lite version that is HTML based. The lite interface gives the user the ability to perform reporting functionality only, and does not give you the ability to perform administrative functions. As such this chapter only describes how to launch the standard user interface. For more details on how to start the lite user interface, please consult the EMC Backup Advisor 2.0 User’s Guide.
Logging into EMC Backup AdvisorIf you are using NetWorker, follow the instructions in the next section, otherwise skip to the section entitled "Logging into EMC Backup Advisor for Non NetWorker Environments" on page 40.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 2: Getting Started
38
2
Logging into NetworkerTo log into EMC Backup Advisor in NetWorker environments, perform the following steps:
1. Bring up a web browser, and type http://servername:9000 into the Address field, and press Enter. This launches the NetWorker Management Console(NMC) launch page as shown in Figure 9.
Figure 9. NetWorker Console Launch Page
Note: The example screen shows the launch page for NetWorker 7.3. The launch page for previous versions of NMC may look different to this one.
2. Click the Start button. The login screen for NMC appears as shown in Figure 10 on page 38
Figure 10. NMC Login
Chapter 2: Getting Started
EMC Backup Advisor 2.0.1 Administrator’s Guide39
2
3. If this is the first time you are using EMC Backup Advisor, login to NMC as the NMC administrator user. The default password for the administrator user is administrator. Click OK.
4. The NMC User Interface appears. Select Start > EMC Backup Advisor from the menu bar as shown in Figure 11.
Figure 11. NMC User Interface
EMC Backup Advisor launches.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 2: Getting Started
40
2
Logging into EMC Backup Advisor for Non NetWorker EnvironmentsTo log into EMC Backup Advisor in a non NetWorker environment, perform the following steps:
1. Bring up a web browser, and type http:\\servername:9002 into the Address field and press Enter. The EMC Backup Advisor launch page appears as shown in Figure 12.
Figure 12. EMC Backup Advisor Launch Page
2. To perform administrative functions, click the Standard UI button. Java starts the web client. After a few minutes, the Login screen appears as shown in Figure 13 on page 40.
Figure 13. Login Screen
3. Enter your username and password. If you are logging in for the first time, use administrator for both the User Name and Password fields.
Chapter 2: Getting Started
EMC Backup Advisor 2.0.1 Administrator’s Guide41
2
4. If this is the first time you have logged into the product, follow the instructions in the "Licensing" section.
Licensing1. The first time you launch EMC Backup Advisor, you are prompted for a license
as shown in Figure 14 on page 41.
Figure 14. License Warning Message
2. Click Yes. The License Manager dialog box appears as shown in Figure 15 on page 41.
Figure 15. License Manager
3. Click Add. The Open dialog box appears as shown in Figure 16 on page 42.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 2: Getting Started
42
2
Figure 16. File Selection
4. Navigate to and select the license file that was provided with the software. Click Open. The Add the license? dialog box appears as shown in Figure 17 on page 42.
Figure 17. License Confirmation
5. Click OK to confirm the license addition. The license file is added to the system and displayed in the License List dialog box as shown in Figure 18 on page 43.
Chapter 2: Getting Started
EMC Backup Advisor 2.0.1 Administrator’s Guide43
2
Figure 18. License Manager
6. Click Close. The EMC Backup Advisor user interface launches as shown in Figure 19 on page 43
Figure 19. EMC Backup Advisor GUI
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 2: Getting Started
44
2
Changing Your Password1. In non-NetWorker environments, EMC recommends that you change your password the first
time you log in by selecting File > Preferences. The Preferences dialog box appears as shown in Figure 20.
Figure 20. Changing Your Password
2. Enter your new password in both the Password and Verify fields and click OK. You can now use this password to log in to the application.
EMC Backup Advisor 2.0.1 Administrator’s Guide45
Chapter 3: Configuring Users
EMC Backup Advisor maintains information about all users who log in. Each EMC Backup Advisor user has an account identified by a user name. This chapter describes how to configure users. This chapter contains the following sections:
• " Creating a User" on page 45• " Editing a User" on page 47• " Deleting a User" on page 48• " LDAP Authentication" on page 48• " User Preferences" on page 49
Each user is assigned a role within EMC Backup Advisor, which may be one of the following:
• Admin - Has the ability to perform all configuration and reporting functions• User - Has the ability to perform reporting functions only
For each user, there are several preferences that you can use to customize the way EMC Backup Advisor behaves and appears. This chapter describes how to use the graphical user interface (GUI) to create and modify the properties for a user.
When you install EMC Backup Advisor, the installer creates two users who can log in:
• Administrator (the password is also administrator)• User (the password is also user)
Creating a UserNote: In NetWorker environments, you can launch the GUI from NetWorker Management Console (NMC). When you launch the GUI, EMC Backup Advisor uses the credentials that you used to log in to NMC when you log in to EMC Backup Advisor.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 3: Configuring Users
46
3
To create a new user:
1. Log in to EMC Backup Advisor as a user with administrative privileges.
2. Select Tools >User Editor from the menu bar. The User List dialog box appears and shows all users currently defined in EMC Backup Advisor as shown in Figure 21 on page 46.
Figure 21. User List
3. Click New The User Properties dialog box appears as shown in Figure 22 on page 46.
Figure 22. Creating a User
Chapter 3: Configuring Users
EMC Backup Advisor 2.0.1 Administrator’s Guide47
3
4. Select the User Properties tab and specify the fields described in Table 1 on page 47.
5. Click OK.
6. Click Cancel to exit without creating the user.
Editing a UserTo edit information for a user:
1. Select Tools >User Editor from the menu bar.
2. Select the user you want to edit. Click Edit.
3. The User Editor dialog box appears that allows you to edit the user information. When you have completed your changes, click OK.
Table 1. User Properties Fields
Property Description
User Name Short login name of the user to log in to EMC Backup Advisor.
Full Name Full name of the user. This is a descriptive field that allows you to enter more information about the account being created.
Role Permission level of the user. Values include User and Admin.
View Views that the user is allowed to access within EMC Backup Advisor. Admin users can access all views defined in EMC Backup Advisor. You can restrict Users to a specific view by selecting a view name in this field.
Auth Type Authentication method for the user when logging in to application.
Set this field to NMC in a NetWorker environment. In non-NetWorker environments, set this field to either Password or LDAP:• Password - Specifies that the password is stored within the
EMC Backup Advisor database in encrypted form• LDAP - Specifies that EMC Backup Advisor authenticates the
user against an LDAP server in the environment
Password Specifies the password to be used to authenticate the user.
Note: This field is not required if you are launching the user interface from NMC.
Verify Enter the password again to validate that the previously entered password is correct.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 3: Configuring Users
48
3
Deleting a UserTo delete a user:
1. Select Tools > User Editor from the menu bar.
2. Select the user you want to delete. Click Delete.
3. The Delete Confirmation dialog box prompts you to confirm the deletion. Click Yes.
4. Click No to cancel the deletion.
LDAP AuthenticationIn non-NetWorker environments, EMC Backup Advisor provides authentication against an encrypted password stored in the datamine database or authentication against an LDAP server in the customer environment.
To configure EMC Backup Advisor to use LDAP for authentication:
1. Log in to EMC Backup Advisor as a user with administrative privileges.
2. Select File > System Settings. The System Settings dialog box appears.
3. Select the LDAP tab. The LDAP parameters appear as shown in Figure 23 on page 48.
Figure 23. LDAP Configuration
4. Specify the LDAP fields described in Table 2 on page 48.
Table 2. LDAP Configuration Fields
Field Description
LDAP URL URL to connect to the LDAP server. For example, ldap://ldap.company.com:port. The default value for the port is 389.
Chapter 3: Configuring Users
EMC Backup Advisor 2.0.1 Administrator’s Guide49
3
5. To test that the LDAP configuration settings are correct, click Test. The Test Authentication dialog box appears as shown in Figure 24 on page 49.
Figure 24. Testing LDAP Credentials
6. Enter a valid user ID and password. Click OK. The GUI attempts to connect to the LDAP server using the configured parameters and authenticates the user and password that you enter. The result of the authentication appears in the Message dialog box.
Note: If the username includes commas (,), then you must manually insert a back slash (\) before the comma. For example:
john doe, ABC Company,OU=EITO,OU=Users,OU=ABCGroup
must be entered as:
john doe\, ABC Company,OU=EITO,OU=Users,OU=ABCGroup
7. Click OK. The properties are saved to the database.
After the LDAP server settings are correctly configured, you can create users with LDAP authentication. Define the username in the Full Name field and set this to the LDAP name. When those users log in to EMC Backup Advisor using this username, the GUI connects to the LDAP server and verifies that the password matches that on the LDAP server.
User PreferencesThere are several reporting preferences that you can specify to control the behavior of EMC Backup Advisor when users are running reports.
To modify those preferences:
1. Select Tools >User Editor from the menu bar. The User List dialog box appears.
2. Select a user. Click Edit.
3. Select the Preferences tab as shown in Figure 25 on page 50.
Base Name Base distinguished name for the directory (Base DN). For example, ou=People,dc=company,dc=com.
Identification Attribute
User identification attribute, normally uid or cn.
Table 2. LDAP Configuration Fields
Field Description
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 3: Configuring Users
50
3
Figure 25. User Properties
Table 3 on page 50 describes the User Reporting Preference fields.
Table 3. User Reporting Preferences
Field Description
Anchor Axis Controls whether the y-axis is set between 0-100% or floats around the values returned in the data when displaying chart reports.
Smooth Graph Controls whether an average operator is applied to trend charts.
Tooltip Controls whether tool tips appear on charts.
Refresh Configures whether reports automatically refresh when displayed.
Refresh Rate Controls how often, in seconds, reports refresh. This setting applies to Refresh mode only.
Max Reports Maximum number of reports displayed simultaneously in the GUI. If the user opens more than this number of reports, the GUI closes the oldest report before opening the new one.
Num Points Maximum number of points returned in each chart series.
Chapter 3: Configuring Users
EMC Backup Advisor 2.0.1 Administrator’s Guide51
3
Max Rows in Table Maximum number of rows displayed in a table.
Report History Count
Number of reports stored in the report history.
Currency Default currency to be used in chargeback reports. If not specified, this field defaults to the currency of the locale of the user.
Time Zone Time zone to be used for running all reports. Default is the time zone on the current machine, but can be overridden if the user is reporting on information that occurred in a different time zone.
Control Panel Control Panel displayed when a user first logs in. If no Control Panel is specified, users are logged directly in to the main user interface.
View Initial view displayed when a user logs in to EMC Backup Advisor.
Menu Name of the menu displayed when the user clicks a node in the Navigation tree.
Table 3. User Reporting Preferences
Field Description
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 3: Configuring Users
52
3
Configuring AppearanceCustomize the GUI color schemes for each user defined in EMC Backup Advisor. To do this, select the Appearance tab from the User Properties dialog box. The Appearance parameters are displayed as shown in Figure 26 on page 52.
Figure 26. Configuring Chart Appearance
Change the default appearance of charts and tables displayed in reports. For each of these objects, you can change the color of the background, foreground, title, axis, plot area, or grid.
Chapter 3: Configuring Users
EMC Backup Advisor 2.0.1 Administrator’s Guide53
3
To change the color of an object:
1. Select a value from the Object field. Select a parameter as shown in Figure 27 on page 53.
Figure 27. Configuring Color
2. Click Edit. The Color Properties dialog box appears as shown in Figure 28 on page 53.
Figure 28. Color Properties
3. Click the color chart to select the color to which you want the object to be changed. Click OK.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 3: Configuring Users
54
3
4. If you chose to edit the font parameters, the Font Properties dialog box appears as shown in Figure 29 on page 54.
Figure 29. Font Properties
By modifying these parameters, you can significantly change the appearance of a report as shown in Figure 30 on page 55.
Chapter 3: Configuring Users
EMC Backup Advisor 2.0.1 Administrator’s Guide55
3
Figure 30. Chart Appearance
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 3: Configuring Users
56
3
EMC Backup Advisor 2.0.1 Administrator’s Guide57
Chapter 4: Configuring Views and Nodes
This chapter describes how to configure views and nodes. This chapter contains the following sections:
• "The Navigation tree" on page 57• "Working with Views" on page 60• "Working with Nodes" on page 63• "Queries" on page 71• "Attributes" on page 76
The Navigation treeThe Navigation tree is located on the left side of the GUI as shown in Figure 31 on page 57.
Figure 31. Navigation Tree
The Navigation tree plays an important role when running reports and configuring EMC Backup Advisor. Understanding how to manage and maintain the Navigation tree can simplify system management and allow users to perform more intelligent reporting.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
58
4
The Navigation tree consists of two main elements, views and nodes. A view refers to a single hierarchy of nodes that you can see in the Navigation tree at any one time. Create views to group things in various ways for reporting purposes. You can assign permissions to users to enable them to see specific views or restrict users to only be able to report on certain nodes. A node is an element within a view. Nodes are linked together to form a hierarchy. This hierarchy is an individual view.
When EMC Backup Advisor is installed, an initial view entitled Basic is created as shown in Figure 32 on page 58.
Figure 32. Basic Views and Nodes
The Basic view is created with an initial structure with groups for Backup Servers, Critical Clients, Fibre Channel switches, IP switches, NetApp Filers, and Tape Libraries during the installation process as shown in Figure 33 on page 59.
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide59
4
Figure 33. EMC Backup Advisor Tree Hierarchy
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
60
4
Working with ViewsA view refers to a single hierarchy of nodes that you can see in the Navigation tree at any one time. Create views to group things in various ways for reporting purposes. You can assign users permission to see specific views, thus restricting them to report only on certain nodes. This section describes how to:
• Create a view• Change a view• Edit a view• Delete a view• Restrict a user to a view
Creating a ViewTo create a new view:
1. Select Tools >View Editor from the menu bar. The View List dialog box appears and shows a list of existing views as shown in Figure 34 on page 60.
Figure 34. View List
2. Click New. The View Properties dialog box appears as shown in Figure 35 on page 60.
Figure 35. View Properties
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide61
4
3. Enter the name of the view in the Name field.
4. Optionally, enter a description in the Description field.
5. Click OK. The view is now created.
Changing a ViewTo change the view that is currently displayed in the GUI, select View on the menu bar and select that view. Alternatively, you can right-click the view node in the Navigation tree, and select Change View as shown in Figure 36 on page 61. The view changes to the selected view.
Figure 36. Changing a View
Editing a ViewTo edit the properties of a view, either select Tools > View Editor from the menu bar or select the root node of the view, right-click the view, and select Configuration > Properties as shown in Figure 37 on page 62.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
62
4
Figure 37. Editing a View
The View Properties dialog box appears that allows you to change the name and description of the view. Make any changes and click OK. Click Cancel to keep the current information.
Deleting a ViewTo delete a view, select Tools > View Editor. Select the view you want to delete. Click Delete. The Delete Confirmation dialog box prompts you to confirm the deletion. Click Yes to complete the deletion. Click No to cancel it.
Note: Deleting a view does not delete any of the nodes in the view. Deleting a view removes all assignments that existed within the view.
Restricting a User to a ViewYou can restrict access to a specific view or views. For more details on this topic, see "Chapter 3: Configuring Users" on page 45.
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide63
4
Working with NodesA node represents either a logical or physical entity within an enterprise and provides the ability to describe both the presence and classification of such entities. Table 4 on page 63 describes the different node types you can create within a view.
By combining these elements, you can easily create and update a map of the enterprise. The remaining sections describe how to configure nodes.
The following rules apply to nodes:
• No two nodes can share the same name• No node can share its name with an alias of another node• All host nodes names and aliases must be in lowercase
When a Collector starts, it contacts the Controller on the EMC Backup Advisor server to determine what it should monitor. To perform this task, the server matches the name of the Collector’s host to a node within the database so that it can determine what requests are assigned to that Collector. This matching process is performed by comparing a list of possible hostnames for the Collector host with either the name or alias contained within the node definition. In certain situations, this matching process may not work automatically. You may need to add alternative names as aliases to the node definition for Collector hosts. These alternate names should include either the short or fully qualified hostname or the IP address of an interface on the host.
Table 4. Navigator Node Types
Node Type Definition
Group Special node type that groups other nodes together. Groups can be members of other groups.
Host Physical machine. You can define a host by its hostname or its IP address.
CDL EMC CLARiiON(R) Disk Library (CDL) TM.
Database Logical database server on a machine.
Disk Physical disk on a machine.
Fibre Channel port Fibre Channel HBA.
Fibre Channel switch Fibre Channel switch.
File System File system
NetApp NearStore NetWork Appliance Filer.
Network Interface Network interface on a machine.
Network switch Physical network switch.
Process Process running on a machine.
Tape drive Physical tape drive attached to a host.
Tape library Physical tape library.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
64
4
Creating a NodeCreating a node defines a new logical or physical element within the enterprise.
To create a new node:
1. Select Tools > Node Editor from the menu bar. The Node List dialog box appears as shown in Figure 38 on page 64
Figure 38. Node List
2. To create a new group, click New Group. The Group Properties dialog box appears as shown in Figure 39 on page 64.
Figure 39. Group Properties
3. Enter a name for the group in the Name field.
4. Optionally, enter a description in the Description field.
5. Click OK to return to the Node List dialog box.
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide65
4
6. To create a node of any other type, click New Node. The Node Properties dialog box appears as shown in Figure 40 on page 65.
Figure 40. Node Properties
7. Enter data in the fields as described in Table 5 on page 65.
8. Click OK to create the node.
Table 5. Node Properties
Property Description
Type One of the types as listed in Table 4 on page 63.
Host Name Name of the host. The field label differs for nodes of the following type:• Fibre Channel switch• Network switch• Tape library• NetApp
Qualifier Depending on node type, this field further defines the node. For example, if you are creating a file system node, enter the name of the file system. This field is not used for the following types:• Host• Fibre Channel switch• Network switch• Tape library• NetApp
Description Optional description that adds information about the node.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
66
4
Assigning a NodeCreating a node adds it to the configuration database but does not add it to a view.
To add a node to a view:
1. Change your current view to the view to which you want to assign the node.
2. Right-click the group to which you want to assign the node and select Configuration > Assign Node as shown in Figure 41 on page 67.
Gather data Indicates if the node is to actively gather data. Values include Yes and No. This field is not available for group nodes. By default, this field is enabled on host nodes. If you disable this property, data is not gathered for this host.
Report Indicates if this node is to participate in reports. Values include Yes and No. This field is not available for group nodes. By default, this field is enabled on host nodes. If you disable this property, report information is not collected for this host.
Alert Indicates whether this node is considered when running Analysis Rule Sets. Values include Yes and No. This field is not available for group nodes. By default, this field is enabled on host nodes. If you disable this property, alerts are not generated for this host when conditions are detected by the Analysis Engine.
Aliases List of aliases by which this node is known. This property is enabled for hosts only. To add an alias:1. Click Add. The Input dialog box appears.2. Enter the name of the alias. Click OK to add the alias to the
field.3. To update an alias, select it from the field. Click Edit.4. Modify the alias in the Input dialog box.5. To delete an alias, select it from the field. Click Delete.
A host often has several aliases including fully qualified and unqualified names, legacy identification, and different names for separate network interfaces. Add all of these names to the alias list to ensure that the host is recognized correctly regardless of which name it uses.
Table 5. Node Properties
Property Description
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide67
4
Figure 41. Assigning a Node to a Group
The Node List appears as shown in Figure 42 on page 67.
Figure 42. Node List
3. Select the node that you want to include in the group and click Assign. That node now appears in the tree within the selected group as shown in Figure 43 on page 68.
4. Alternatively, click Cancel to cancel the assignment.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
68
4
Figure 43. Assigning Nodes to Groups
You can assign group nodes within any other group nodes to build a hierarchy of groups.
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide69
4
Editing a NodeTo modify the properties of a node:
1. Right-click the node you want to edit. Select Configuration > Properties as shown Figure 44 on page 69.
Figure 44. Editing a Node
2. The Node Properties dialog box appears as shown in Figure 45 on page 70.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
70
4
Figure 45. Node Properties
3. Make your changes to the node. Click OK. The node is modified with your changes.
Unassigning a NodeUnassign a node to remove it from a view in the Navigation tree. This does not delete the node from the database.
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide71
4
To unassign a node:
1. Right-click the node you want to unassign. Select Configuration > Unassign Node as shown in Figure 46 on page 71.
Figure 46. Unassigning a Node
2. You are prompted to confirm the deletion. Click OK to unassign the node. Click Cancel to cancel the unassign operation.
Deleting a NodeDeleting a node removes the node from the database. To delete a node:
1. Select Tools > Node Editor from the menu bar.
2. Select the node you want to delete. Click Delete. The Delete Confirmation dialog box prompts you to confirm the deletion. Click Yes to confirm or No to cancel.
Note: Removing a node unassigns the node from all views before deleting it from the database.
QueriesA query node runs a custom report and then creates nodes in the tree based on the results of the report. This can be used to create dynamic views based on information gathered by the Collector process.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
72
4
Queries allow users with administrative privileges to create groups that are populated dynamically with information from the results of EMC Backup Advisor reports. The main benefit of queries is that they provide high levels of flexibility. Administrators can set up queries to return information about which nodes meet the business and technical needs of the organization without being required to manually configure groups.
Note: Nodes that are returned as results of queries cannot be associated with analyses or scheduled reports. If you want to provide reporting or analysis functionality for dynamic nodes, you must configure these for the query.
You can create standard queries and advanced queries.
• "Standard Queries" on page 72• "Advanced Queries" on page 74
Standard QueriesStandard queries provide a single set of nodes from a report. Standard requests always return a list of nodes. You can assign to standard queries the same items that you can assign to regular nodes, including analyses and scheduled reports. Because of this, EMC Backup Advisor can generate suitable alerting and reporting without the administrative users having to manually create and maintain each group.
For example, a financial firm may have a convention where the first two characters of each backup client contain details of the business unit to which they are assigned. If the first two characters are "am," then the backup client belongs to the asset management group. Due to the nature of the business, a large number of clients are created, renamed, or removed daily. Rather than spend a lot of time updating the group configuration each day, the EMC Backup Advisor administrator can create a query that uses the existing Backup Client Configuration report to list each backup client. In the query, he/she can filter the results to only contain clients that start with "am." As EMC Backup Advisor automatically updates the client configuration list every time it obtains data from the backup server, this list is kept up-to-date with whatever changes are made within the backup environment. The EMC Backup Advisor administrator can now assign a scheduled report to this node. Regardless of the changes that take place in the environment, the report always runs against the correct hosts and provides users with the information that they require.
Examples of standard queries include:
• All backup clients containing "exch"• All hosts with an E: drive• All nodes with severity 1 alerts in the last day
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide73
4
Creating a Standard QueryCreate a standard query to obtain data from EMC Backup Advisor reports.
1. Navigate to the Query Properties dialog box by right-clicking a group in the Navigation tree and selecting Configuration > New > New Query from the Navigation tree. Alternatively, select Node > New Query from the menu bar. The Query Properties dialog box appears as shown in Figure 47 on page 73.
Figure 47. Query Properties, Standard
2. In the Properties tab, in the Name field, enter a name for the query to be displayed in the Navigation tree. Optionally, add a description in the Description field.
3. In the Node Type field, select Standard from the list of values.
4. In the Children report region, select a category of the report to be run to obtain the children of the query in the Report Category field.
5. In the Report field, select a report to be run to obtain the children of the query.
6. In the Report filter field, click the Report filter button to launch the Condition Expression dialog box. For information about using the Condition Expression dialog box, see "Data Source Conditions" on page 187 in "Chapter 12: Configuring Reports" on page 169. Create a filter to be applied to the results of the report. This allows the use of standard EMC Backup Advisor reports with additional filters to provide simple access to the required nodes.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
74
4
7. In the Report window field, select a time period over which to run the children report from the list of values.
8. In the Report view field, select a view for nodes over which to run the children report. The default value of None runs the report for all nodes within EMC Backup Advisor.
9. The Report nodes field is only available if you select a value other than None in the Report view field. The value in this field specifies the specific nodes over which to run the children report.
10. Click OK to create the query.
Advanced QueriesAdvanced queries provide one of a number of sets of nodes from a report depending on the node from which the query is run. The most common example of a hierarchical query is the traditional EMC Backup Advisor tree view, where expanding one group can lead to a combination of nodes and additional groups which can be further expanded.
Hierarchical queries are usually integrated with external data sources and are used to provide a complete multi-level view of data. One important aspect of multi-level reporting is the ability to track from one level in the tree to another. In addition, it is important to view the parent-child relationships of the nodes.
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide75
4
Creating an Advanced QueryCreate advanced queries to obtain a multi-level view of data based on an external data source.
1. Navigate to the Query Properties dialog box by right-clicking a group in the Navigation tree and selecting Configuration > New > New Query from the Navigation tree. Alternatively, select Node > New Query from the menu bar. The Query Properties dialog box appears as shown in Figure 48 on page 75.
Figure 48. Query Properties, Advanced
2. In the Name field, enter a name for the query to be displayed in the Navigation tree. Optionally, add a description in the Description field.
3. In the Node Type field, select Standard from the list of values.
4. In the Children report region, select a category of the report to be run to obtain the children of the query in the Report Category field.
5. In the Report field, select a report to be run to obtain the children of the query.
6. In the Descendents report region, select the category of the report to be run to obtain the descendents of the query in the Report Category field.
7. In the Report field, select the report to be run to obtain the descendents of the query.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
76
4
8. In the Initial node name field, select the name of the top-level node to be supplied when the query is expanded.
9. Click OK to save the query.
Running QueriesExpand a query to run it. Queries automatically run when the query node is expanded in the Navigation tree. An example of the updated Navigation tree populated with the results of a standard query is shown in Figure 49 on page 76.
Figure 49. Navigation Tree with Query Nodes
The name of the dynamic node is determined by an internal hierarchy within EMC Backup Advisor for the data returned by reports. This hierarchy is as follows:
• Node• Client Name• Client• Server Name• Server• Hostname• Name
If the report does not return any of these nodes, then the first key field that is returned by the report is used as the name of the node.
Only nodes of type Host are returned for standard queries and nodes of type Group are returned for advanced queries.
AttributesAttributes are optional properties that administrators can create and assign to nodes. Attributes are a way of extending the information that EMC Backup Advisor holds about a node.
Chapter 4: Configuring Views and Nodes
EMC Backup Advisor 2.0.1 Administrator’s Guide77
4
Creating an AttributeCreating an attribute informs EMC Backup Advisor of a new node property.
To create a new attribute:
1. Select Tools > Attribute Editor from the menu bar. The Attributes List dialog box appears.
2. Click New. The Attributes Properties dialog box appears as shown in Figure 50 on page 77.
Figure 50. Attribute Properties
3. Specify the Attributes Properties fields, which are described in Table 6 on page 77.
4. Click OK to create the attribute.
Table 6. Attributes Properties Fields
Field Description
Name Name of the attribute.
Description Optional description that adds information about the attribute.
Type Type of data that the attribute holds. Values include:• Text - Free-form text• Integer Value - Integer number, e.g. 3• Decimal Value - Decimal number, e.g. 3.14• Flag - True or false flag
Required If selected, this attribute must be specified for all nodes. If deselected, this attribute is optional.
No Value Specify whether the value has a default.
Default Default value used by this attribute until overridden on a specific node.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 4: Configuring Views and Nodes
78
4
The attribute now exists for all nodes. You can edit the attribute for a node by selecting the Attributes tab on the Node Properties dialog box when creating or editing a node, as shown in Figure 51 on page 78.
Figure 51. Node Properties
Editing an AttributeTo edit an attribute:
1. Select Tools > Attribute Editor from the menu bar. The Attributes List dialog box appears.
2. Select the attribute you want to edit. Click Edit. The Attributes Properties dialog box appears.
3. Optionally, change the name and description of the attribute. To make your changes, click OK. Click Cancel to keep the current information.
Editing an attribute does not allow you to change its type or modify whether the attribute is required. If you want to make this change, you must delete the attribute and recreate it with the appropriate settings.
Deleting an AttributeTo delete an attribute:
1. Select Tools >Attribute Editor from the menu bar.
2. Select the attribute you want to delete. Click Delete. The Delete Confirmation dialog box prompts you to confirm the deletion. Click Yes to confirm the deletion. Click No to cancel the deletion.
Note: Deleting an attribute removes the extended information stored for each node relating to that attribute. Recreating the attribute will not bring back the lost information.
EMC Backup Advisor 2.0.1 Administrator’s Guide 79
Chapter 5: Configuring Requests
A request directs the Collector to perform a specific monitoring task. It contains information on what data is collected, how often it is collected, and any options that are specified. Assign requests to nodes in the Navigation tree to configure EMC Backup Advisor to gather data from a host, device, or application.
This chapter describes how to create and configure requests. This chapter contains the following sections:
• "Viewing Requests" on page 80• "Assigning a Request to a Node" on page 80• "Reloading the Collector" on page 81• "Editing a Request" on page 83• "Creating a Request" on page 85• "Deleting a Request" on page 85• "Remote Data Collection" on page 85• "Creating a Credential" on page 87• "Editing a Credential" on page 88• "Deleting a Credential" on page 88
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 5: Configuring Requests
80
5
Viewing RequestsTo see which requests are assigned to a node, right-click the node in the navigation tree and select Configuration > Current Configuration. The Configuration dialog box appears in the user interface that shows the properties of the node, the requests that are assigned to it, and any analyses that are assigned to it as shown in Figure 52 on page 80.
Figure 52. Viewing Assigned Requests
Requests can be assigned directly to a host in the Navigation tree or to a group. Requests that are assigned to a group node are inherited by any hosts within that group.
Assigning a Request to a NodeTo assign a request to a node:
1. Right-click the node to which you want to assign requests. Select Configuration > Properties. The Node Properties dialog box appears.
2. Select the Requests tab as shown in Figure 53 on page 81.
Chapter 5: Configuring Requests
EMC Backup Advisor 2.0.1 Administrator’s Guide 81
5
Figure 53. Request Properties
3. The Request tab shows all EMC Backup Advisor requests as well as all requests that are currently assigned to this node. To assign one or more requests to the node, select the requests you want to activate from the Unassigned list and click Assign. These requests then transfer to the Assigned.
4. Click OK to confirm the assignments. Click Cancel to cancel the assignments.
Unassigning a RequestTo unassign a request, perform the same steps as described in "Assigning a Request to a Node", but select the requests from the Assigned field click Unassign. The items then move back up into the Unassigned field.
Reloading the CollectorAfter assigning or unassigning requests to either a group or host node, you need to reload the Collectors to update the configuration. To do this, right-click the changed group or host node and select Configuration > Reload Collectors as shown in Figure 54 on page 82.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 5: Configuring Requests
82
5 Figure 54. Reloading the Collectors
EMC Backup Advisor calculates which Collectors must be updated. A dialog box confirms whether each Collector was contacted successfully.
Chapter 5: Configuring Requests
EMC Backup Advisor 2.0.1 Administrator’s Guide 83
5
Editing a RequestWhen EMC Backup Advisor is installed, several predefined requests are created in the database with predefined polling periods and options. If required, you can modify these properties. To edit a request:
1. Select Tools > Request Editor from the main menu. The Request List dialog box appears that shows all defined requests (regardless of whether or not they are assigned) as shown in Figure 55 on page 83.
Figure 55. Request List
2. Select the request that you that you want to edit. Click Edit. The Request Properties dialog box appears and shows the details of the request as shown in Figure 56 on page 83.
Figure 56. Request Properties
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 5: Configuring Requests
84
5
3. Edit the Request Editor fields as described in Table 7 on page 84.
4. Change the parameters that you want to modify.
5. Click OK to save the request to the database.
Note: When editing a request, you cannot change the module or function. To modify these fields, create a new request and edit the copy.
Table 7. Request Properties
Field Description
Name Name that defines the request.
Description Optional description.
Module Module name containing the function that is run to gather data.
Function Name of the function within the module that is run to gather data. The functions available depend on the selected module. Most modules have the following functions:• config - Gathers configuration information. Configuration
information defines the static state of a device or application, and is unlikely to change without a large-scale system modification (the number and type of file systems on a server, or the number of network ports on a network switch)
• status - Gathers status information. Status information defines he dynamic state of a device or application and can change, but does not fluctuate wildly (the percentage usage of a file system, link status, speed, and network port duplex, for example)
• perf - Gathers performance information. Performance information is usually defined as information that defines the performance characteristics of a device or application and is likely to be different at every poll (e.g., the amount of data read from a file system or the amount of data received by a network port)
Period Frequency with which data is gathered. The recommended period used for each request depends on the type of data being gathered and the number of Collectors that are deployed within the environment. However, as a rough guideline you should set the:• Configuration functions to a period of 12 hours• Status functions to a period of 15 minutes• Performance functions to a period of 5 minutes
This gathers a sizeable amount of data without overloading the Collector’s server or EMC Backup Advisor itself.
Options Any function-specific options that you can specify. Basic information for each option appear as tool tips if you hover your mouse over the option name.
Chapter 5: Configuring Requests
EMC Backup Advisor 2.0.1 Administrator’s Guide 85
5
Creating a RequestTo create a new request:
1. Select Tools > Request Editor from the main menu. The Request List dialog box appears.
2. Click New. The Request Properties dialog box appears.
3. Complete the fields as described in Table 7 on page 84.
4. Click OK to save the request to the database.
Deleting a RequestTo delete a request:
1. Select Tools > Request Editor from the main menu. The Request List dialog box appears.
2. Click Delete. You are prompted to confirm the deletion of the request. Click Yes to delete the request. Click No to cancel it.
Note: Deleting a request automatically unassigns it from all nodes to which it is assigned.
Remote Data CollectionYou can gather certain types of data with EMC Backup Advisor without deploying a Collector on the monitored device. To do this, a Collector on another machine, such as the EMC Backup Advisor Server, gathers the data remotely. When gathering data remotely, the Collector’s host is referred to as a proxy server. The Collector uses a protocol to gather data from the remote machine and then forwards it back to the Listener process on the EMC Backup Advisor server as shown in Figure 57 on page 85. The protocol used depends on the type of data being collected.
Figure 57. Remote Data Collection
For certain devices types, such as IP and Fibre Channel switches, data must always be gathered remotely as it is impossible to install a Collector directly on a switch.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 5: Configuring Requests
86
5
To configure remote data collection within EMC Backup Advisor, you need to configure the details when assigning requests. To specify remote data collection:
1. Right-click a node in the Navigation tree. Select Configuration > Properties.
2. Select the Requests tab.
3. Select the request from the list of assigned requests on that node, and then select the Proxy check box. The Proxy Properties dialog box appears as shown in Figure 58 on page 86.
Figure 58. Proxy Properties
4. Specify the proxy configuration details as described in Table 8 on page 86.
5. Click OK to assign the proxy properties to the request.
6. Click OK on the Node Properties dialog box to assign the requests to the node.
Table 8. Proxy Configuration Fields
Field Description
Proxy Host Name of the host that you want to perform the remote data collection.
Proxy Type Method that connects from the proxy host to the host to be monitored. The options are:• Application-specific - Application-focused modules,
such as NetWorker and Netbackup, can communicate remotely with the applications they are monitoring
• WMI - Microsoft standard for gathering system information remotely from Windows hosts. This can only be used if both the proxy and the target are Windows hosts
• SNMP - Network management standard supported by most network devices
• CIM - Common Information Model (CIM), a protocol that can be used to gather devices that support the CIM standard
Credential Name of a credential that contains the user ID and password information that may be required to gather data from the remote system. See "Creating a Credential" for instructions on creating credentials.
Chapter 5: Configuring Requests
EMC Backup Advisor 2.0.1 Administrator’s Guide 87
5
7. Right-click the node to which you have assigned the proxy requests.
8. Select Configuration > Reload Collectors from the menu to initiate data collection.
Creating a CredentialTo create a credential:
1. In the Proxy Properties dialog box (shown in Table 8 on page 86), click Credentials. The Credentials List dialog box appears that shows all existing credentials.
2. Click New. The Credential Properties dialog box appears as shown in Figure 59 on page 87.
Figure 59. Credential Properties
3. Specify the fields described in Table 9 on page 87 as required.
Note: A credential does not require both a username and a password because some systems do not need both. An example of this is SNMP, where the password (known as the community string) is the only required authentication.
4. After you complete the credentials information, click OK to create the credential.
Table 9. Creating a Credential
Field Description
Name Name of the credential.
Description Optional description that adds information about the credential being created.
Username Username for the credential. This is the string that identifies a user for access to a system.
Password Password for the credential. This is the string that authenticates that the user as named in the Username field.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 5: Configuring Requests
88
5
Editing a CredentialTo edit a credential:
1. In the Proxy Properties dialog box (shown in Figure 58 on page 86), click Credentials. The Credentials List dialog box appears that shows existing credentials in EMC Backup Advisor.
2. Click Edit. The Credential Properties dialog box appears as shown in Figure 59 on page 87.
3. Edit the credential information you want to change. Click OK. Click Cancel to discard your changes.
Deleting a CredentialTo delete a credential:
1. In the Proxy Properties dialog box (shown in Figure 58 on page 86), click Credentials. The Credentials List dialog box appears that shows all known credentials in EMC Backup Advisor.
2. Select the credential you want to delete.
3. Click Delete. The Delete Confirmation dialog box prompts you to confirm the delete the credential deletion. Click Yes to confirm. Click No to cancel.
EMC Backup Advisor 2.0.1 Administrator’s Guide89
Chapter 6: Monitoring Devices and Applications
"Chapter 5: Configuring Requests" on page 79 describes, in generic terms, how to assign requests to nodes to configure data collection. This chapter describes how to configure application and device monitoring. This chapter contains the following sections:
• "Backup Applications" on page 89• "System Monitoring" on page 100• "Tape Libraries" on page 104• "Fibre Channel Switches" on page 104• "IP Switches" on page 105• "Network Appliance Filers and NearStores" on page 105• "EMC CLARiiON Disk Libraries" on page 106• "ACSLS" on page 107
Backup ApplicationsEMC Backup Advisor monitors the following backup applications:
• "NetWorker"• "VERITAS NetBackup"• "Tivoli Storage Manager"• "HP OpenView Storage Data Protector"• "VERITAS Backup Exec"• "Oracle RMAN"
This section provides instructions for configuring each application.
NetWorkerYou can configure NetWorker to be monitored by either the Collector running on the backup server or remotely using a Collector running on the EMC Backup Advisor Server. If you monitor the application remotely, the NetWorker client package much be installed on the Collector’s host. The NetWorker module uses commands such as mminfo and nsradmin to communicate with the NetWorker server and to gather information, and, as a result, requires access to the binaries within the NetWorker client package.
To monitor NetWorker:
1. Create a node for the backup server in the GUI and assign it in the Navigation tree. The primary name of the node that you create should match the hostname of the NetWorker server. The hostname must be resolvable from the Collector’s machine. You can specify an IP address rather than a hostname if you prefer.
2. Select the node that you just created in the Navigation tree and assign the following requests:
• NetWorker Configuration
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
90
6
• NetWorker Status• NetWorker Save Set Monitor• NetWorker Performance• NetWorker Volume Status
Note: If you assign the node you have created underneath the EMC NetWorker group in the Basic view, then the node will automatically inherit these requests.
3. If you are monitoring the NetWorker server from a Collector running on another machine, configure each of the assigned requests to be a proxy request. To configure the proxy details, enter the name of the Collector’s host as the proxy host. If that host is not yet defined in EMC Backup Advisor, create a node definition for it before setting the proxy properties. Set the proxy type to Application-specific. There is no need to specify a credential when monitoring a NetWorker server from a different machine.
4. Select Configuration > Reload Collectors from the backup server node to update the Collector process with the new monitoring details The Collector now collects data from the NetWorker server. It may take several minutes for data for to be displayed in the GUI.
VERITAS NetBackupYou can configure a VERITAS NetBackup server to be monitored from a Collector running on the Netbackup Master Server or from a Collector running on a different host such as the EMC Backup Advisor server.
If you are gathering data remotely, the VERITAS NetBackup Server binaries must be installed on the Collector’s host. You also must modify the NetBackup Master Server to permit the Collector’s host to gather data from it. Details on how to configure these permissions in NetBackup are provided in the procedure. This step is not necessary if the Collector is running on the Master Server itself.
To configure EMC Backup Advisor to monitor NetBackup:
1. Create a node in the GUI for the backup server and assign it to a view in the Navigation tree. If you assign it to the VERITAS NetBackup group in the Basic view, then it will automatically inherit requests to monitor it from the group object. Set the primary name for the node to the hostname of the VERITAS NetBackup Master Server. The name of the node must be resolvable on the Collector’s machine. You can specify an IP address rather than a hostname if you prefer.
2. Assign the following requests to the Master Server node:
• NetBackup Configuration• NetBackup Status• NetBackup Volume Status• NetBackup Save Set Monitor
3. If you are monitoring the VERITAS NetBackup server from a Collector running on another machine (such as the EMC Backup Advisor Server), you must configure each of these requests as a proxy request. Enter the name of the Collector’s host as the proxy host. Set the proxy type to Application-specific. There is no need to specify a credential when monitoring a VERITAS NetBackup server from a different machine.
4. After configuring the requests, select Configuration > Reload Collectors from the backup server node to notify the Collector process about the configuration changes. The Collector now collects data from the NetBackup server. It may take several minutes for data for to be displayed in the GUI.
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide91
6
Configuring NetBackup Authentication for Remote Data CollectionIf the NetBackup Master Server is running on a UNIX machine, the name of the host on which the Collector is running must be added to the bp.conf file on the NetBackup Master Server by editing the /usr/openv/netbackup/bp.conf file and adding the following line.
SERVER = Collectorhost
Change Collectorhost to the Collector’s hostname. The Collector’s hostname must be resolvable by the Master Server. Restart NetBackup on the Master Server so that the changes take effect.
If the NetBackup Master Server is running on a Windows machine:
1. Launch the NetBackup Administration Console and open the Master Server Properties dialog box.
2. Select the Servers tab. Add the name of the Collector’s host to the list of additional servers that are allowed to access the Master Server as shown in Figure 60 on page 91.
.
Figure 60. Master Server Properties
3. Click OK to close the Master Server Properties dialog box.
4. Restart the NetBackup services to activate the changes.
Tivoli Storage ManagerYou can configure a TSM server to be monitored from a Collector running on the TSM Server or remotely from a Collector running on a different host (such as the EMC Backup Advisor server). If you are monitoring TSM remotely, follow the instructions
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
92
6
in this section before configuring the server in EMC Backup Advisor. If you are monitoring TSM from a Collector running on the TSM server, skip to the section entitled "Configuring a TSM Server in EMC Backup Advisor" on page 94.
Monitoring TSM RemotelyWhen monitoring a TSM instance remotely, the TSM client software must be installed on host that will monitor the TSM instance. The TSM module uses the dsmadmc command included with the TSM client software to connect to the TSM instance and gather its data.
In a default TSM Client installation on a Windows machine, the administrative components required by EMC Backup Advisor are not installed. To install the administrative components:
1. Select the Custom radio button while performing the TSM Client installation as shown in Figure 61 on page 92.
Figure 61. TSM Client Install
2. The installation components are displayed. Select Administrative Client Command Line Files as shown in Figure 62 on page 93.
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide93
6
Figure 62. TSM Custom Setup
3. Select Next. The TSM Client installation continues.
4. After the TSM client installation is complete, initialize the client for the first time by starting the Backup Archive GUI from the Start menu. A wizard prompts you to configure the client as shown in Figure 63 on page 93.
Figure 63. TSM Configuration Wizard
5. To configure the client, accept the default Help me configure the TSM Backup Archive Client value. Click Next.
You are prompted to either import an existing options file or to create a new one as shown in Figure 64 on page 94.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
94
6
Figure 64. TSM Configuration Wizard, Options File Task
6. Accept the default value Create a new options file. Continue to progress through the wizard. Complete all of the panels in the Wizard until a new options file is created.
Configuring a TSM Server in EMC Backup AdvisorTo configure a TSM server in EMC Backup Advisor:
1. Create a node and assign it in the Navigation tree. If you assign the node underneath the IBM TSM group in the Basic view, it automatically inherits requests to monitor it. The primary name for the node depends on the Collector’s operating system.
• On a Windows system, the name of the node is the hostname of the TSM Server. The hostname must be resolvable by the operating system
• On a UNIX system, the name of the node must match the name of the TSM server name as defined in the TSM Client System Options file on the Collector’s machine. Typically, this file is located in /usr/bin/dsm.opt file and contains defined TSM instancesUse the name of the TSM instance you want to monitor as defined in this file when defining the node name in EMC Backup Advisor. If the name of the instance differs from the hostname of the machine, enter the machine’s hostname as an alias. If you do not specify this name, you may not be able to gather TSM information from a Collector running on UNIX systems
2. Assign the following requests:
• TSM Configuration• TSM Status• TSM Job Monitor• TSM Volume Status• TSM Occupancy
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide95
6
3. Set up each request as a proxy request even if the Collector is running on the TSM Server. When entering the proxy details, set the proxy host to the hostname of the Collector’s machine. Set the proxy type to Application-specific. Specify the hostname as the operating system hostname of the machine and not the TSM instance name. If the hostname of the machine is not available from the field, create a node using the Node Editor.
• On a Windows system, if you are monitoring TSM remotely, you must specify the tsmhost and tsmport options if there is more than one instance on a system. These options allow you to specify the name of the instance you want to monitor. If you want to monitor more than one instance, you must create multiple requests and assign each request to an instance
4. Create a credential for the TSM Server. Specify the name and password of a TSM Administrator in the Username and Password fields of the Credential Properties dialog box. Assign this credential to each request when configuring the proxy details of the request.
5. Select Configuration > Reload Collectors from the backup server node to notify the Collector process of the changes. The Collector now collects data from the TSM server. It may take several minutes for data for to be displayed in the GUI.
HP OpenView Storage Data ProtectorA Collector can monitor HP Data Protector servers running on the HP Data Protector Cell Manager or remotely from another machine. If you are monitoring a Cell Manager remotely, follow the instructions in the next section. If you are monitoring a Cell Manager from a Collector installed on the Cell Manager, skip to section entitled "Configuring a HP Data Protector Server in EMC Backup Advisor" on page 97.
Monitoring HP Data Protector RemotelyTo monitor HP Data Protector remotely, the HP Data Protector client software must be installed on the Collector’s host and the client must be configured on the Data Protector Cell Manager so that it has permission to run reports.
To install the client software on the machine that monitors the Cell Manager:
1. Launch the Data Protector Manager administration GUI and add a client for the host that will monitor the server.
2. When selecting the software components to install on the client, ensure that the User Interface option is selected as shown in Figure 65 on page 96.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
96
6
Figure 65. Installing HP Data Protector Client
Note: The EMC Backup Advisor Data Protector module requires access to commands such as omnirpt and omnicellinfo to gather data from the Cell Manager. These components are only installed when the user interface component is installed, so it is essential that you select this option.
3. Configure the client to have permissions to run reports on the Cell Manager. First determine the user for which the Collector process will be running:
• On UNIX systems, the Collector always runs as the root user• On Windows systems, the Collector runs as the EMC Backup Advisor Collector service
user. To verify the user for which the service is running on a Windows system, launch the Windows service control manager and view the details of the EMC Backup Advisor Collector service
4. Create a user on the Cell Manager that matches the Collector’s username. Enter the name of the host in the user definition field.
5. Add the user to a Data Protector User Group that has Reporting and Notifications permissions.
Note: Typically, this means adding the user to the admin group, but if you want to restrict this user so that they do not inherit other administrator privileges, create a new group with Reporting and Notification permissions and add the user to that group.
6. Verify that remote authentication privileges are set up correctly by running the following command from the Collector’s host:
omnirpt -tab -report list_sessions 06/01/01 12:00 06/01/30 12:00
If successful, this command returns a list of all the sessions that have run on the Data Protector server during the time period specified. If you receive an error indicating that you do not have permission to run reports, review the configuration settings on the Data Protector server.
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide97
6
Configuring a HP Data Protector Server in EMC Backup AdvisorTo configure a HP Data Protector server for EMC Backup Advisor monitoring:
1. Create a node for the backup server and assign it in the Navigation tree. If you assign it to the HP Data Protector group in the Basic view, it automatically inherits requests to monitor the application.
2. Specify the hostname of the Data Protector server as the hostname of the node.
3. Assign the following requests to the new node:
• Data Protector Config• Data Protector Status• Data Protector Volume Status• Data Protector Job Monitor
4. If you are monitoring Data Protector remotely, configure each request as a proxy request.
5. When entering the proxy details, set the proxy host to the name of the Collector’s host and set the proxy type to Application-specific.
6. Reload the Collectors that will monitor that server by right-clicking the new node and selecting Configuration > Reload Collectors from the Navigation tree. Data collection from the Data Protector server begins. It may take several minutes for data to be displayed in the GUI.
VERITAS Backup ExecYou can monitor VERITAS Backup Exec servers from a Collector running on the Backup Exec server or from a Collector running on any other Windows machine in the environment. You cannot monitor a VERITAS Backup Exec server from a Collector running on a UNIX-based host. If you are monitoring Backup Exec remotely, follow the steps in the next section. If you are monitoring Backup Exec with a Collector on the Backup Exec server, skip to the section entitled "Configuring a Backup Exec Server in EMC Backup Advisor" on page 98.
Monitoring Backup Exec RemotelyTo monitor a VERITAS Backup Exec backup server remotely, the EMC Backup Advisor Collector service must run as a named user account rather than the Local System account. When installing the Collector, you are prompted to specify whether you want the Collector to run using the Local System account or as a named user.
To verify the user that the Collector service is running, launch the Windows Service Control Manager and edit the properties of the EMC Backup Advisor Collector service by performing the following steps:
1. Select the Log On tab of the Service Properties window.
2. Verify that the Collector is configured to run using a named account by ensuring that the This Account radio button is selected.
3. If the This Account radio button is not selected, select it and enter the username and password of the local administrator account to run the service as shown in Figure 66 on page 98.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
98
6
Figure 66. Modifying Service Logon Rights for EMC Backup Advisor Collector
4. Modify the service account details. Click OK.
5. Restart the service to activate your changes.
Configuring a Backup Exec Server in EMC Backup AdvisorTo configure the Backup Exec server for monitoring with EMC Backup Advisor:
1. Create a node for the backup server and assign it in the Navigation tree. The name that is entered here must match the NetBIOS name of the machine on which Backup Exec is running. The NetBIOS name of the Backup Exec server must be resolvable from the Collector’s host for remote monitoring. The Collector may not be able to gather data from Backup Exec remotely if you do not use the NetBIOS name.
2. Configure requests for Backup Exec monitoring by selecting the backup server node and assigning the following requests:
• Backup Exec Configuration• Backup Exec Status• Backup Exec Volume Status• Backup Exec Job Monitor
3. If you are monitoring Backup Exec from a Collector running on a different host, configure each of these requests as a proxy requests. When entering the proxy details, set the proxy host to the name of the Collector’s host and set the proxy type to Application-specific.
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide99
6
4. If monitoring Backup Exec remotely, create a credential. Set the Username and Password fields of the Credential Properties dialog box to the username and password of a Windows Administrator account on the Backup Exec server. Assign this credential to each of the requests when configuring the proxy details of the request.
5. Reload the Collectors that will monitor that server by right-clicking the new node in the Navigation tree. Select Configuration > Reload Collectors. Data collection from the Backup Exec server begins. It may take several minutes for data to be displayed in the GUI.
Oracle RMANEMC Backup Advisor gathers detailed information about Oracle backup jobs with Oracle (Recovery Manager) RMAN utility. When RMAN backups run, they write detailed information about the backups to either the database that was backed up or to a designated recovery catalog within your environment. Depending on the configuration of the EMC Backup Advisor Oracle RMAN module, the module gathers information either directly from the database that was backed up or from a centralized recovery catalog.
Backup applications such as NetWorker and VERITAS NetBackup interface directly with RMAN to perform hot backups of Oracle databases. If you are monitoring your backup applications with EMC Backup Advisor, you receive information about the RMAN backups that occurred on the backup application. However, the level of detail that is available from traditional backup applications is significantly less than gathering data directly from RMAN.
You can gather information on RMAN jobs from a Collector running on the Oracle backup server or a recovery catalog from a Collector running on the same machine as the recovery catalog. You can also gather data remotely in either of these scenarios, but the Oracle client must be installed on the Collector’s host so that it can communicate with the database.
Monitoring Oracle RMAN RemotelyTo monitor Oracle RMAN remotely, the Oracle client must be installed on the Collector’s host so that the Collector process can communicate with the database.
The version of the client installed on the machine must be compatible with the target database to which the Collector connects.
Configuring EMC Backup Advisor for Oracle RMANTo configure EMC Backup Advisor for Oracle RMAN monitoring:
1. Determine the name of the target database in the environment. If you are using a recovery catalog for backups, the recovery catalog database should be monitored. If you are not using a recovery catalog, the name of the target database is the individual database that is being backed up.
2. Create a host of type Database in the Navigation tree. Set the hostname of the Database node to the name of the host on which the target database is running. Set the database name to the Oracle service name of that database.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
100
6
3. If you are using a recovery catalog, assign the RMAN Job Monitor - Recovery Catalog request to the node. If you are not using a recovery catalog, assign the RMAN Save Set Monitor - Control File request to the node.
Note: If multiple recovery catalogs are configured on a database server, separate nodes can be created in EMC Backup Advisor of the form database.schema so that they can be monitored.
4. Configure the request as a proxy request. This is necessary even if data is being gathered from a Collector running on the same machine. For the proxy details, set the Proxy Host to be the name of the Collector’s host. Set the proxy type to Application-specific.
5. Create a credential that contains the username and password of a user that can connect to the database. Specify this credential in the proxy settings for the request.
6. Reload the Collector that will monitor the server by right-clicking the new node. Select Configuration > Reload Collectors from the Navigation tree. Data collection from the Oracle server begins.
Verifying that Backup Application Monitoring is WorkingTo verify that Backup Application monitoring is working as expected, select the new database and run the EBA >Collector Errors report. If there are problems gathering data, these problems are listed in this report. Verify that after a backup Save Set completes, it appears in EMC Backup Advisor by running theData Protection->Save Sets->All Save Sets report.
System MonitoringEMC Backup Advisor can gather data from operating systems that enable users to report on operating system configuration, status, and performance. There are several EMC Backup Advisor modules that gather different types of information. The system monitoring modules available in EMC Backup Advisor are described in Table 10 on page 100
Table 10. System Monitoring Modules
Module Description
Host Gathers basic information about the operating system type.
Disk Gathers configuration, status, and performance information on the disks attached to the host.
Fibre Channel HBA
Gathers configuration, status, and performance information on Fibre Channel HBAs configured on the machine.
Filesystem Gathers configuration, status, and performance information on the file systems mounted to the host.
Memory Gathers configuration, status, and performance information on memory in the host.
NetInt Gathers configuration, status, and performance information on network interface cards in the host.
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide101
6
To perform system monitoring on UNIX machines, you must install a Collector on the host that you want to monitor. It is not possible to gather system information remotely from UNIX machines.
It is possible to gather all system monitoring information remotely from Windows machines with the exception of Fibre Channel HBA information. To gather Fibre Channel HBA information, the Collector must be installed on the machine. For more details on the steps required to monitor a Windows host remotely, see the section entitled "Monitoring a Windows Host Remotely" on page 101.
To set up system monitoring for a system on which a Collector is installed, assign the relevant requests to the host or group that you want to monitor and reload the Collector by selecting Configuration > Reload Collectors from the node that you are monitoring in the GUI.
Monitoring a Windows Host RemotelyYou can gather all of the system information remotely from a Windows machine with the exception of Fibre Channel HBA information. To monitor a Windows machine remotely, you must have a Collector installed on another Windows machine. It is not possible to remotely monitor a Windows machine from a Collector running on a UNIX machine.
To monitor a Windows host from another Windows machine, the EMC Backup Advisor Collector service must run as an Administrator account on the machine that is performing the monitoring. During the EMC Backup Advisor Collector installation, you are prompted to enter the name and password of an Administrator account on the local machine and the Collector service is automatically configured to run as that user. If this was entered incorrectly during installation, then you must modify the Collector service login parameters so that the Collector service runs as an Administrator account rather than the Local System account.
To modify the login parameters of the Collector service:
1. Launch the Windows Services control manager, and select theEBA Collector service. Right-click and select Properties from the menu.
2. Select the Log On tab on the Properties dialog box. Select the This Account radio button.
3. Enter the details of the username and password of an administrator account for which you want the service to run as shown in Figure 67 on page 102.
Process Returns information on any processes running on the host.
Processor Returns configuration, status, and performance information on all CPUs on the host.
Table 10. System Monitoring Modules
Module Description
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
102
6
Figure 67. Modifying Service Login Rights for EMC Backup Advisor Collector
4. Click OK. Restart the service.
To monitor activity on a remote machine:
1. Create a host node for the machine that you want to monitor in the GUI. The name of the node is the hostname of the remote host. The hostname must be resolvable from the machine on which the Collector that will be monitoring the node is running.
2. Assign requests to that node to specify what data you want to gather.
3. Mark each request as a proxy request and complete the proxy details for that request.
4. To complete the proxy details, enter the name of the host for the Collector in the Proxy Host field and select WMI as the proxy type.
5. Create a credential for the Administrator account on the machine being monitored. This account can be the name of a Local Administrator or that of a Domain Administrator. To create the credential, specify the Username and Password fields of that account in the Credential Properties dialog box as shown in Figure 68 on page 103.
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide103
6
Figure 68. Credential Parameters for WMI
6. Specify the Proxy Properties as shown in Figure 69 on page 103.
Figure 69. Proxy Properties for WMI
7. Notify the Collector that will monitor the server of the changes you have made by right-clicking the node in the Navigation tree. Select Configuration > Reload Collectors. Data collection from the server begins. It may take several minutes for data to be displayed in the GUI.
Note: It may not be possible to gather file system performance information from Windows 2000 servers unless disk monitoring is enabled on the host. It is disabled by default. To enable disk monitoring on Windows 2000, run the following commands and then reboot the machine.
diskperf /Y
winmgmt /resyncperf <PID of winmgmt process>
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
104
6
Tape LibrariesTo monitor a tape library, create a node of type Tape Library and assign it within the Navigation tree. Set the name of the node to the hostname or IP address of the tape library. If you are specifying a hostname, it is important that the name of the tape library is resolvable from the host from the Collector’s host that is monitoring the tape library. To configure requests for the tape library:
1. Assign the following requests to the node or group containing the tape library in the Navigation tree:
• Tape Library Configuration• Tape Library Status
2. Configure each of these requests as proxy requests. In the proxy configuration details, specify the name of the host on which the Collector is running as the proxy host, and select SNMP as the proxy type.
3. Create a credential that contains the SNMP community string for the tape library in the Password field of the Credential Properties dialog box. Unless the community string was modified on the tape library, set the community string to public. Specify the credential for each of the assigned tape library requests.
4. Reload the Collectors that will monitor the tape library by right-clicking the node you created in the Navigation tree. Select Configuration > Reload Collectors. Data collection from the tape library begins. It may take several minutes for data to be displayed in the GUI.
Fibre Channel SwitchesTo configure monitoring for a Fibre Channel switch, create a node of type Fibre Channel Switch and assign it to the Navigation tree. Set the name of the node the hostname or IP address of the Fibre Channel switch. If specifying a hostname, it is important that the name of the switch is resolvable on the Collector’s host. To configure requests for the switch:
1. Assign the following requests to the node that represents the switch in the Navigation tree:
• Fibre Channel Switch Config• Fibre Channel Switch Status• Fibre Channel Switch Performance
2. Configure each request as a proxy request. In the proxy configuration details, specify the name of the Collector’s host as the proxy host, and select SNMP as the proxy type.
3. Create a credential that contains the SNMP community string for the switch in the Password field of the Credential Properties dialog box. Unless the community string was modified on the switch, set the community string to public. Specify the credential on each of the assigned Fibre Channel requests.
4. Reload the Collectors that will monitor that server by right-clicking the new node. Select Configuration > Reload Collectors. The data collection from the switch begins. It may take several minutes for data to be displayed in the GUI.
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide105
6
IP SwitchesTo monitor an IP switch, create a node of type Network Switch and assign it in the Navigation tree. Set the name of the node to the hostname or IP address of the switch. If you are specifying a hostname, it is important that the name of the switch is resolvable on the Collector’s host. To configure requests for the switch:
1. Assign the following requests to either the node that represents the switch in the Navigation tree or a group that includes the switch:
• Network Interface Configuration• Network Interface Status• Network Interface Performance
2. Configure each request as a proxy request. In the Proxy Properties dialog box, specify the name of the Collector’s host as the proxy host. Select SNMP as the proxy type.
3. Create a credential that contains the SNMP community string for the switch in the Password field of the Credential Properties dialog box. Unless the community string was modified on the switch, set the community string to public. Specify the credential on each of the assigned network interface requests.
4. Reload the Collectors that will monitor that server by right-clicking the new node in the Navigation tree. Select Configuration > Reload Collectors. Data collection from the switch begins. It may several minutes for data to be displayed in the GUI.
Network Appliance Filers and NearStoresNetApp Filers must be monitored from a Collector running on a remote machine. In order to perform monitoring, there may be some configuration steps required on the Filer before configuring the Filer in EMC Backup Advisor. These requirements are detailed in the following section.
Filer ConfigurationThe NetApp module gathers information from a Filer by communicating with the NetApp ONTAPI service that listens on port 80. If there are any firewalls between the Collector and the Filer, it is important that port 80 is open to permit data gathering.
If the Filer is configured to run multiple virtual Filers (vFilers), the Controller only requires network connectivity to vFiler0 (i.e., the physical filer). You can obtain vFiler information directly from the physical Filer connection.
To gather data from a Filer, you must enable HTTP administrative access on the Filer. To confirm that this option is enabled, log in to the Filer and run the following command:
filer> options httpd.admin.enable
If the option is set to off, you can enable it by running the following command:
filer> options httpd.admin.enable on
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
106
6
EMC Backup Advisor requires a valid Filer username and password to connect to the Filer. You can use the standard Filer user of root, but if a separate login is desired for monitoring purposes, you can create it.
For filers running versions of ONTAP prior to 7.0, run:
filer> useradmin useradd eba
And enter a valid password.
For filers running ONTAP version 7.0 and higher, run:
filer> useradmin user add eba -g Administrators
And enter a valid password.
Configuring NetApp monitoring in EMC Backup AdvisorTo configure a NetApp Filer for EMC Backup Advisor monitoring:
1. Create a node in the Navigation tree of type NetApp to represent the Filer. Set the node name to be the hostname or IP address of the Filer.
2. If you are specifying a hostname, ensure that it is resolvable from the Collector’s host that will be monitoring the Filer.
3. Assign the following requests to the node:
• NetApp Configuration• NetApp Save Set Monitor• NetApp Performance• NetApp Status
4. Configure all requests as proxy requests. In the Proxy Properties dialog box, enter the name of the Collector’s host as the value for the Proxy Host field. Specify Application-specific as the Proxy Type. Create a credential that contains the username and password of a user that has access to query the Filer (typically the root user on the filer). Assign the credential to the proxy information.
5. Click OK.
6. Reload the Collector by right-clicking the node. Select Configuration > Reload Collectors. After a couple of minutes you should see data being retrieved from the Filer when running reports. If no data appears, run the Collector Errors report to look for error messages or to review the log file of the Collector.
EMC CLARiiON Disk LibrariesTo monitor an EMC CLARiiON(R) Disk Library (CDL), create a node of type CDL and assign it in the Navigation tree. Set the name of the node to the hostname or IP address of the CDL. If you are specifying a hostname, it is important that the name of the switch is resolvable on the Collector’s host. To configure requests for the switch:
1. Assign the following requests to either the node that represents the CDL in the Navigation tree or to a group that includes the unit:
• EMC CLARiiON Disk Library Configuration• EMC CLARiiON Disk Library Status• EMC CLARiiON Disk Library Performance
Chapter 6: Monitoring Devices and Applications
EMC Backup Advisor 2.0.1 Administrator’s Guide107
6
2. Configure each request as a proxy request. In the Proxy Properties dialog box, specify the name of the Collector’s host as the proxy host, and select SNMP as the proxy type.
3. Create a credential that contains the SNMP community string for the CDL in the Password field. Unless the community string was modified on the CDL, set the community string to public. Specify the credential on each of the assigned requests.
4. Reload the Collectors that will monitor the CDL by right-clicking the CDL node in the Navigation tree. Select Configuration > Reload Collectors. Data collection from the CDL begins. It may several minutes for data to be displayed in the GUI.
ACSLSThe Collector component must be installed and running on the ACSLS server that you want to monitor. ACSLS cannot be monitored remotely.
After installing the Collector, verify that the ACS_HOME value in the EMC Backup Advisor.config file matches the location in which ACSLS is installed.
To monitor an ACSLS server, create a node of type Host and assign it in the Navigation tree. Set the name of the node to the hostname of the ACSLS server.
1. Assign the following requests to the node:
• ACSLS Config• ACSLS Status
2. Click OK.
3. Reload the Collector by right-clicking the node. Select Configuration > Reload Collectors. After a couple of minutes, when running reports, you should see data retrieved from the ACSLS server. If no data appears, run the Collector Errors report to look for error messages or review the log file of the Collector.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 6: Monitoring Devices and Applications
108
6
EMC Backup Advisor 2.0.1 Administrator’s Guide 109
Chapter 7: Configuring Time Windows
This section describes how to configure time windows. This chapter contains the following sections:
• "Specifying a Time Period" on page 109• "Creating a New Time Window" on page 110• "Creating Time Definitions" on page 112
Specifying a Time PeriodWhen running a report, you must specify a time period for which you want to run the report by indicating the specific start and end times. To do so, select a value from the Time Window field as shown in Figure 70 on page 109.
Figure 70. Time Windows
In addition to the standard windows contained in the field, you can create and modify your own time windows as described in the next few sections.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 7: Configuring Time Windows
110
7
Creating a New Time WindowTo create a new time window:
1. Ensure that you are logged into EMC Backup Advisor as a user with administrative privileges.
2. Select Tools > Time Window Editor from the menu bar. The Time Window List dialog box appears that shows all defined time windows as shown in Figure 71 on page 110.
Figure 71. Window List
3. Click New. The Window Properties dialog box appears as shown in Figure 72 on page 110.
Figure 72. Window Properties
Chapter 7: Configuring Time Windows
EMC Backup Advisor 2.0.1 Administrator’s Guide111
7
4. Specify the Windows Properties fields, which are described in Table 11 on page 111.
5. Click OK. The window is now created.
See "Creating Time Definitions" on page 112 for instructions on using the Edit Times button on the Window Properties dialog box.
Editing a Time WindowTo edit a time window:
1. Ensure that you are logged into EMC Backup Advisor as a user with administrative privileges.
2. Select Tools > Time Window Editor from the menu bar.
3. Select the window you want to edit. Click Edit. The Time Window Properties dialog box appears that allows you to edit the window.
4. Make your changes. Click OK. Click Cancel to discard your changes.
Deleting a Time WindowTo delete a time window:
1. Ensure that you are logged into EMC Backup Advisor as a user with administrative privileges.
2. Select Tools > Time Window Editor from the menu bar.
3. Select the window you want to delete. Click Delete. The Delete Confirmation dialog box prompts you confirm the deletion.
4. Click Yes. Click No to cancel the deletion.
Table 11. Window Properties Fields
Field Definition
Name Name of the window (required).
Description Description that adds information about the window being created (required).
Start Time Time at which the window should start.
End Time Time at which window should end.
Set Interval Indicates if a window is subdivided into a fixed number of intervals when running chart reports.
Interval If the Set Interval check box is selected, the Interval field is enabled and allows you to set the size of each interval within the window.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 7: Configuring Time Windows
112
7
Creating Time DefinitionsWhen creating a Window, select a start time and end time. Several predefined time definitions are installed with EMC Backup Advisor, but you can create new time definitions to further customize your windows. To view a list of all available times:
1. Ensure that you are logged into EMC Backup Advisor as user with administrative privileges.
2. Select Tools > Time Window Editor from the menu bar. The Time List dialog box appears as shown in Figure 73 on page 112.
Figure 73. Time List
3. Click New. The Time Properties dialog box appears that allows you to edit the new time window as shown in Figure 74 on page 112.
Figure 74. Time Properties
Chapter 7: Configuring Time Windows
EMC Backup Advisor 2.0.1 Administrator’s Guide113
7
4. Enter data in the Name and Description fields.
5. Optionally, enter data in the Day of Week, Day of Month, Month, Year, Hour, and Minutes fields.
Note: You can create times with relative or absolute times. For example for the Month field, you can specify an absolute month such as July or August, or you can specify a relative month such as 1 month ago. You can use combinations of relative and absolute times used for the different fields to build a more complex time definition. For example, specifying 1 day ago for the Day of Month along with 6 PM for the Hour field and 15 minutes past for the Minutes field results in a time of 6:15 yesterday. This is evaluated at the time the report is run to produce an absolute time that is used when generating the report.
Note: If you do not specify a value for one of the time definition fields, the current time is used when the time is evaluated. For example if you specify 1 day ago for the Day of Month, but do not specify a value for the Hour or Minutes fields, then the time at which the report is ran is substituted for that field. If the report is run at 3:37 PM then the time is evaluated at 3:37 PM yesterday.
Editing a Time DefinitionTo edit an existing time definition:
1. Open the Time List dialog box by following the instructions in "Creating Time Definitions".
2. Select the time definition you want to edit. Click Edit. The Time Properties dialog box appears and contains the time definition details of the selected time.
3. When you have finished modifying the time definition, click OK to save the definition to the database.
Deleting a Time DefinitionTo delete a time definition:
1. Launch the Time List dialog box by following the instructions in "Creating Time Definitions".
2. Select the time definition that you want to delete. Click Delete. You are prompted to confirm the deletion.
3. If you want to proceed, click Yes. Click No to cancel the deletion. If the time definition that you are attempting to delete is still assigned to any windows, an error message appears preventing you from deleting that time definition.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 7: Configuring Time Windows
114
7
EMC Backup Advisor 2.0.1 Administrator’s Guide115
Chapter 8: Configuring Schedules
Schedules are used by the Publisher and Analysis Engine processes to configure when reports are dispatched and when Analysis Engine rules run. This chapter describes how to configure Schedules. This chapter contains the following sections:
• "Using the Schedule Editors" on page 115• "Using the Basic Editor" on page 117• "Using the Advanced Editor" on page 120
Using the Schedule EditorsA schedule is made up of components that define when each schedule produces certain results or runs certain reports. The Schedule Editor provides two ways to create schedules:
• Basic Editor - Configure schedules using a graphical editor• Advanced Editor - Create more complex schedules by manually editing the schedule parameters
You can edit a schedule created in the Basic Editor using the Advanced Editor. However, you cannot edit all schedules created in the Advanced Editor from the Basic Editor. Where possible, you can switch between the Basic and Advanced modes by selecting the tabs in the Schedule Editor.
To create a schedule:
1. Open the Schedule Editor by selecting Tools > Schedule Editor from the menu bar. The Schedule List dialog box appears as shown in Figure 75 on page 115.
Figure 75. Schedule List
Note: The following schedules are available when you install EMC Backup Advisor and are displayed in the Schedule List dialog box shown in Figure 75 on page 115:
•9 AM every day•Always
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
116
8
•Default SLA Schedule
2. To edit an existing schedule, click Edit. The Schedule Properties dialog box appears as shown in Figure 76 on page 116.
Note: You cannot edit the schedules that are installed with EMC Backup Advisor. If you click one of the preinstalled schedules, the View button replaces the Edit button. To modify one of the preinstalled schedules, copy the schedule and modify the copy.
Figure 76. Schedule Properties - Basic Schedule Editor
3. Enter data in the Name field.
4. Optionally, enter a description in the Description field.
5. Select a Type radio button. Values include Point-in-time or Window. A point-in-time schedule consists of point events (e.g., something should happen at 8 AM each day). A window schedule is a schedule that consists of time periods (e.g., between 8 AM and 9 AM every day).
When you create a new schedule, the Schedule Properties dialog box displays the Basic Schedule Editor as shown in Figure 76 on page 116.
6. Select the Advanced tab as shown in Figure 77 on page 117.
Chapter 8: Configuring Schedules
EMC Backup Advisor 2.0.1 Administrator’s Guide117
8
Figure 77. Schedule Properties - Advanced Schedule Editor
The remaining sections in this chapter provide instructions for the following:
• "Using the Basic Editor" on page 117• "Using the Advanced Editor" on page 120
Using the Basic EditorYou can use the Basic Schedule Editor to graphically create and edit schedules that last up to a week. These schedules repeat every week. You can create both window schedules and point-in-time schedules in the Basic Schedule Editor. Both are described in the following section.
Window SchedulesFor a window schedule, add schedule components to a schedule by clicking the Start Time for the component and dragging the mouse to the End Time as shown in Figure 78 on page 118.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
118
8
Figure 78. Schedule Properties - Window Schedules
Figure 78 on page 118 shows a schedule that is set up for non-business hours. The yellow bar indicates a schedule window, and the green bar indicates the currently selected window. As you draw a new window, the bar appears pink.
You can change the start and end times for a window by selecting it and clicking Properties. The Schedule Component Properties dialog box appears as shown in Figure 79 on page 118.
Figure 79. Schedule Component Properties
To delete a window, select the window you want to remove and click Delete.
Point-in-Time SchedulesFor point-in-time schedules, add schedule components by clicking the mouse at the point-in-time you want to activate the schedule. Add multiple times by selecting additional times in the week as shown in Figure 80 on page 119.
Chapter 8: Configuring Schedules
EMC Backup Advisor 2.0.1 Administrator’s Guide119
8
Figure 80. Schedule Properties - Point in Time Schedules
To modify a point-in-time Schedule Component, click it (the color changes to green) and click Properties. The Schedule Component Properties dialog box appears as shown in Figure 81 on page 119.
Figure 81. Schedule Component Properties
You can modify the time at which the schedule component occurs by changing the values in this dialog box. To apply the change, click OK.
To remove a point-in-time schedule component, select it and click Remove.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
120
8Using the Advanced Editor
If you need to create a more complex schedule than the Basic Editor allows, you can use the Advanced Schedule Editor. To view the Advanced Schedule Editor, select the Advanced tab in the Schedule Properties dialog box as shown in Figure 82 on page 120.
Figure 82. Schedule Properties - Advanced Schedule Editor
A schedule is composed of one or more schedule components. Each schedule component defines a period of time. Schedule components can either be inclusive or exclusive:
• Inclusive - Determines when a schedule runs• Exclusive - Defines times when a schedule does not run
When exclusive schedule components are present, they are processed after all inclusive components. As a result, the order of the components does not matter.
The schedule component types of the Advanced Editor are described in Table 12 on page 120.
All of these components (except for the Date type) allow you to further filter data, such as applying the components on certain months of the year only. Filtering is described in more detail in "Schedule Component Editor" on page 121.
Table 12. Schedule Component Types
Type This Schedule Component...
Date Works with absolute dates.
Hour Repeats hourly.
Day Repeats daily.
Week Repeats weekly.
Month Repeats monthly.
Chapter 8: Configuring Schedules
EMC Backup Advisor 2.0.1 Administrator’s Guide121
8Schedule Component Editor
To add a new schedule component, click Add. The Schedule Component Properties dialog box appears as shown in Figure 83 on page 121.
Note: Click Properties to edit a component. Click Remove to remove a component. You can change the Schedule Component type while editing that component.
Figure 83. Scheduled Component Properties
The Schedule Component Properties dialog box contains the following fields:
• Inclusion - Determines whether the time parameters included in this schedule component are used to determine a time when the schedule should run by selecting Include radio button. Explicitly state a time when the schedule should not run by selecting the Exclude radio button
• Type - Determines the schedule component type. The schedule components types include the following and are shown in Figure 84 on page 121:
•Dates•Hours•Days•Weeks•Months
Figure 84. Schedule Component Properties - Type
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
122
8
Each type has associated parameters that determine the behavior of the schedule component. The following sections describe each type in more detail.
DatesThe Dates schedule component uses absolute dates. For window schedules, enter the start and end dates for the window. For a point-in-time schedule, specify only one date. Figure 85 on page 122 and Figure 86 on page 122 display the dialog boxes in which you specify dates.
Figure 85. Schedule Component Properties - Dates
Figure 86. Dates for Point In Time
To specify a specific date, click the button displaying the date(s). The Date dialog box similar to that shown in Figure 87 on page 123 appears.
Chapter 8: Configuring Schedules
EMC Backup Advisor 2.0.1 Administrator’s Guide123
8
Figure 87. Editing the Date Fields
If you are modifying a window date, the dialog box contains two calendar selections. Click the date, enter a time, and click OK. The window date is added to the Schedule Component Properties dialog box. Click OK again to save this schedule component to the schedule.
HoursThe Hours schedule component defines a window or a point-in-time within an hour. The schedule is in effect for the times specified within that hour, every hour of the day. The Schedule Component Properties dialog box appears for the Hours schedule components as shown in Figure 88 on page 124.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
124
8
Figure 88. Editing the Hours Fields
If the To time is before the From time, then the window wraps to the next hour. In the example, the hour schedule shows a window from the 45th minute of the hour to the 30th minute of the next hour (i.e., 00:45 - 01:30, 01:45 - 02:30, etc.).
Use the Time Zone field to specify times for a time zone different than the one in which the Publisher process or Analysis Engine is running. The Publisher process runs Save Sets in the same time zone synchronously.
By default, a schedule component of type Hours applies to every hour of the day. You can restrict the schedule to only apply to particular hours of the day if necessary. To do this, select the Hour Filter from the Filter field. The dialog box extends showing boxes for every hour of the day as shown in Figure 89 on page 124.
Figure 89. Filtered Hours Parameter
Chapter 8: Configuring Schedules
EMC Backup Advisor 2.0.1 Administrator’s Guide125
8Select the check boxes for the hours to which you want the schedule to apply. If a filter is not defined, then the schedule applies to every hour of the day. Regardless of the filter, the schedule repeats daily.
DaysThe Days schedule component defines a window or point-in-time within a day. By default, the schedule repeats every day. If you choose the Days schedule component, the Schedule Component Properties dialog box appears as shown in Figure 90 on page 125.
Figure 90. Editing the Days Fields
As in the Hours schedule component, if the start time is after the end time, the window extends to the next day. Use the Time Zone field to specify a time zone different than the one in which the Publisher process or Analysis Engine is running.
By default, the schedule repeats every day. You can restrict the schedule to apply to only certain days by applying a filter. You can apply one of the three filters to a Days schedule component; either Every N Days, Week, and Month. These are discussed in more detail in the following section.
Every N Days FilterThe Every N Days filter changes the schedule from repeating every day to repeating every specified number of days, starting on a specific date as shown in Figure 91 on page 126.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
126
8
Figure 91. Every N Days Filter
This example shows a window that repeats every other day starting on the March 1, 2004. It will run from 10:30 PM. on March 1, 2004 to 04:30 AM on March 2, 2004, then again at 10:30 PM on March 3, 2004 to 04:30 AM on March 4, 2004, continuing this way every other day.
Week FilterThe Week filter defines the days of the week to which the schedule applies as shown in Figure 92 on page 127.
Chapter 8: Configuring Schedules
EMC Backup Advisor 2.0.1 Administrator’s Guide127
8
Figure 92. Week Filter
In this example, a window is defined to run between 02:00 and 03:00, but to run only on Mondays, Wednesdays, and Fridays.
By default, with a Weeks filter, the schedule repeats every week. You can add restrictions to run every N weeks. For example, you can filter a schedule to run between 02:00 and 03:00 on Mondays, Wednesdays, and Fridays, every other week.
Alternatively, you can filter the schedule to apply to only certain weeks of the month. For example, a schedule can run between 02:00 and 03:00 on Monday, Wednesday, and Friday on the first and last weeks of the month. Finally, you can further filter the schedule to run on certain months of the year. For example, you can configure a schedule to run between 02:00 and 03:00 on Monday, Wednesday, and Friday on the first and last weeks of March, June, September, and December.
Month FilterThe Month filter defines the days of the month to which the schedule applies. For example, you can define schedule to run between 02:00 and 03:00 on the first, 10th and 15th day of every month as shown in Figure 93 on page 128.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
128
8
Figure 93. Month Filter
Again, by default, such a schedule repeats every month. However, you can filter it to only apply to certain months of the year; for example, you can create a schedule between 02:00 and 03:00 on the first, 10th and 15th day of March, April and May. To do this, select the Month check boxes at the bottom of the dialog box.
WeeksUse a schedule component of type Weeks to define a single window or a single point in time within a week. By default, the schedule repeats every week. The Weeks Schedule Component Properties dialog box appears in Figure 94 on page 129.
Chapter 8: Configuring Schedules
EMC Backup Advisor 2.0.1 Administrator’s Guide129
8
Figure 94. Editing the Weeks Fields
Like the other components, if the end time is before the start time for the week, the window extends to the next week. For example, a week schedule component can define a continuous window between 17:00 on a Friday and 09:00 on Monday.
Use the Time Zone field to specify times in a time zone different to the one in which the Publisher process or Analysis Engine is running.
By default, a Weeks schedule component repeats every week. You can restrict this further by applying either the "Week Filter" or the "Month Filter". Both are described in the following section.
Week FilterThe Week filter allows the schedule to repeat every N weeks starting on a specific date rather than every week as shown in Figure 95 on page 129.
Figure 95. Week Filter
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
130
8
To modify the frequency, modify the value in the Every field. To specify the start date, click Edit. Select the date on which the filter starts.
Month FilterThe Month filter defines which weeks of the month and/or which months of the year to which the schedule applies as shown in Figure 96 on page 130.
Figure 96. Month filter
Like other components, the filter is based on the start time of the window. For example, if a window runs from 09:00 on Monday to 18:00 on Wednesday on the last week of the month during May and August, then for 2004 (when the May 31 is a Monday), the window runs from 09:00 AM on Monday, May 31 to 6:00 PM on Wednesday, April 2.
Chapter 8: Configuring Schedules
EMC Backup Advisor 2.0.1 Administrator’s Guide131
8Months
The Months schedule component defines a window or a point-in-time within a month as shown in Figure 97 on page 131. By default, the schedule repeats itself every month.
Figure 97. Editing the Months Fields
The Months schedule component defines a window or a point in time within a month. If the end time is before the start time, then the window extends to the next month. For example, a window can be defined from 09:00 on the first day of the month to 06:00 on the 10th day of the month. This component is slightly more complex in that the from and to times can also be relative. For example, you can define a window to be from 09:00 on the second to last day of the month to 06:00 on the last day of the month.
By default, a Months schedule repeats every month. You can further restrict the schedule using the Month filter as shown in Figure 98 on page 132.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 8: Configuring Schedules
132
8
Figure 98. Months Filter
The Month filter allows a schedule to only repeat on certain months of the year. To specify the months to which you want the schedule to apply, select the check boxes for those months.
EMC Backup Advisor 2.0.1 Administrator’s Guide133
Chapter 9: Configuring Analysis Save Sets
The Analysis Engine is a process that analyzes collected data in the datamine to monitor events within the enterprise to predict situations that may happen in the future. This chapter describes how configure Analysis Save Sets. This chapter contains the following sections:
• "Rulesets and Analyses" on page 133• "Assigning an Analysis Save Set" on page 134• "Creating an Analysis Save Set" on page 139• "Editing an Analysis Save Set" on page 141• "Deleting an Analysis Save Set" on page 141
Rulesets and AnalysesTo perform these functions, the Analysis Engine operates on a ruleset and an analysis:
• Ruleset - Set of instructions to the Analysis Engine to carry out certain operations and display the resulting events. For example, the file system filling up ruleset contains the set of rules that the Analysis Engine uses to determine if any file systems will exceed a certain threshold at a certain point in the future. The file system filling up ruleset has two parameters, the maximum predicted utilization, that specifies at which utilization level you want an alert to be generated, and the Number of hours to forecast parameter, that specifies how far in the future to look. Several rulesets are available when you install EMC Backup Advisor. You can use these rulesets as the basis for creating analyses. EMC Backup Advisor provides a Ruleset Editor that you can use to create entirely new rulesets. The Ruleset Editor is discussed in "Chapter 10: Using the Ruleset Editor" on page 143
• Analysis - Consists of the name of a ruleset along with that details that specify how that ruleset is run, and includes:
• Schedule - Determines the hours for which the ruleset is run• Period - Determines how often it should run within the selected schedule• Values - Passed to ruleset-specific parameters
For example, an analysis may be created that specifies that the file system filling up ruleset should monitor for partitions whose utilization may exceed 90% in the next hour, every 30 minutes between 9 AM and 5 PM.
A set of predefined analyses are installed with EMC Backup Advisor. For more details on the analyses that are installed with EMC Backup Advisor, see "Appendix A: Analysis Save Set Definitions" on page 271.
To monitor a node or group of nodes, you must assign analyses to a node in the Navigation tree. Analyses that are assigned to group nodes are automatically inherited by the host nodes that are children of that group.
To view the analyses that are assigned to a node, right-click the node. Select Configuration > Current Configuration from the Navigation tree. Assigned analyses are displayed in the Analyses region of the Configuration dialog box as shown in Figure 99 on page 134.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 9: Configuring Analysis Save Sets
134
9
Figure 99. Assigned Analysis
When an analysis finds a matching condition, EMC Backup Advisor generates an event. All events are automatically logged into the EMC Backup Advisor database and can be viewed by running a report in the GUI. You can also configure analyses to generate an email, send an SNMP trap, or execute a script when events occur.
Assigning an Analysis Save SetTo assign an Analysis Save Set:
1. In the Navigation window, right-click the node to which you want to assign the analysis. Select Configuration > Properties from the Navigation tree. The Properties dialog box for that node appears.
2. Select the Analyses tab as shown in Figure 100 on page 135.
Chapter 9: Configuring Analysis Save Sets
EMC Backup Advisor 2.0.1 Administrator’s Guide 135
9
Figure 100. Assigning an Analysis
3. The Unassigned field shows all existing analyses that are and are not assigned to this node. Select the analysis you want to assign from the Unassigned field and click Assign. The analysis is moved to the Assigned field. To unassign an analysis, select it in the Assigned field. Click Unassign.
4. All events detected by the Analysis Engine are automatically logged to the database so that they can be viewed in reports. Each event is assigned a severity level. To modify the severity level of an alert, specify a value for the Default Severity field for each analysis you assign.
In addition to sending alerts to its own database, EMC Backup Advisor can send the alerts described in Table 13 on page 135.
Table 13. Analysis Engine Alert Types
Alert Type Description
Email Sends an email to the specified recipients containing details of the alert.
Email Report Emails a report orDashboard to the specified recipients.
SNMP Trap Sends an SNMP Trap to the specified host containing the details of the alert.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 9: Configuring Analysis Save Sets
136
9 5. To create a new alert, click Edit Alerts to display all alerts in EMC Backup Advisor.
6. Click New. The Alert Properties dialog box appears as shown in Figure 101 on page 136.
Figure 101. Configuring an Alert
CBE Alert Sends a CBE alert to the specified host.
Script Runs a user-configured script passing in the event details.
Table 13. Analysis Engine Alert Types
Alert Type Description
Chapter 9: Configuring Analysis Save Sets
EMC Backup Advisor 2.0.1 Administrator’s Guide 137
9
7. Specify the alert parameters defined in Table 14 on page 137.
a. If you are configuring an email alert, you must specify the email parameters defined in Table 15 on page 137.
b. If you are configuring an alert to email a report or Dashboard, you must specify the parameters specified in Table 16 on page 137.
Table 14. Alert Parameters
Parameter Definition
Name Name of the alert.
Description Optional description for the alert.
Type Type of alert. Values include:• Email - Generate an email• SNMP - Generate an SNMP trap• Script - Run an external script
Severity Severity assigned to the alert.
Table 15. Email Parameters
Parameter Description
To Address of the user to which the email is sent.
Subject Subject of the email.
Table 16. Email Report Parameters
Parameter Description
To Email address of the recipient of the report.
Subject Subject of the email.
Report Type Indicates whether you want to email a report or a Dashboard.
Category Category of the report or Dashboard you want to mail.
Report Name of the report you want to mail.
Dashboard Name of the Dashboard you want to mail.
Window Period of time over which you want to run the report.
User User for which the report is run. The report is formatted with those user preferences.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 9: Configuring Analysis Save Sets
138
9
Note: The report is run against the node for which the alert is generated.
c. If you are configuring an SNMP alert, specify the SNMP parameters defined in Table 17 on page 138.
d. If you are configuring an alert to send a CBE alert, specify the CBE parameters defined in Table 18 on page 138
e. If you are configuring an alert to execute a script, specify the name of the script that is run. When the Analysis Engine executes a script, it passes the fields in Table 19 on page 138 as parameters to the script so that the script can use it to perform actions.
Table 17. SNMP Parameters
Parameter Description
Hostname Name of the host for which the trap is issued.
Community Community string that is sent in the trap.
Port Port on which the trap receiver is listening.
Table 18. CBE Parameters
Parameter Description
Hostname Name of the host to which the alert is sent.
Port Port on the host to which the alert is sent.
Table 19. Script Field Parameters
Parameter Description
Node Name of the node to which the alert applies.
Text Textual error message as defined in the ruleset.
Severity Severity of the alert.
Name Name of the analysis that triggered this alert.
Alert ID ID that uniquely describes this alert.
Event ID ID that uniquely describes the type of alert that has occurred.
First Occurrence Timestamp that details the time that this alert first occurred.
Last Occurrence Timestamp that details the time that this alert last occurred.
Count Number of times this alert has been issued.
View Name of the view to which the analysis is assigned.
Node Name of the node to which the analysis is assigned.
Category Category of the analysis Save Set that ran.
Chapter 9: Configuring Analysis Save Sets
EMC Backup Advisor 2.0.1 Administrator’s Guide 139
9
8. Click OK.
9. Select the alert from the drop down list to assign it to that analysis.
10. Click OK on the Node Properties dialog box. The analysis for this node is now stored within the database.
Creating an Analysis Save SetWhen EMC Backup Advisor is installed, several analysis Save Sets are installed that you can use to monitor most environments. In some cases, however, you may want to create new Analysis Save Sets with custom parameters or to work against rulesets you have created.
To create a new Analysis Save Set:
1. Select Tools > Analysis Editor from the menu bar. The Analysis List dialog box appears as shown in Figure 102 on page 139
Figure 102. Analysis List
2. Click New. The Analysis Properties dialog box appears as shown in Figure 103 on page 140.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 9: Configuring Analysis Save Sets
140
9
Figure 103. Analysis Properties
3. Specify the Analysis Properties defined in Table 20 on page 140.
4. To create an analysis Save Set to report when a file system is close to being full, for example, specify the parameters shown in Figure 104 on page 141.
Table 20. Analysis Parameters
Parameter Definition
Name Name of this analysis.
Description Optional description of the analysis.
Category Category in the analysis Save Set is assigned. Select a value from the field or enter the name of a new category.
Schedule Period of time during which the analysis is run.
Period Frequency with which the Analysis Engine processes the ruleset within the schedule.
Ruleset Name of the ruleset that is the basis of this analysis. See "Chapter 10: Using the Ruleset Editor" on page 143 for information about configuring rulesets.
Options Set of options specific to the selected ruleset. Hover your mouse over the option for a description of the option.
Chapter 9: Configuring Analysis Save Sets
EMC Backup Advisor 2.0.1 Administrator’s Guide 141
9
Figure 104. Example Analysis
5. Click OK. Your analysis is saved to the database.
6. You can now assign a node in the Navigation tree to the analysis using the steps detailed in "Assigning an Analysis Save Set" on page 134.
Editing an Analysis Save SetTo edit an analysis Save Set, select the analysis Save Set you want to edit in the Analysis List dialog box. Click Edit.
You cannot edit analysis Save Sets that were available for use upon installation. If you select a system analysis Save Set, Edit is replaced by View. To modify that analysis, copy the analysis by clicking Copy. Edit the copy.
Deleting an Analysis Save SetTo delete an analysis Save Set, select the analysis you want to delete from the Analysis List dialog box. Click Delete. You are prompted to confirm the deletion. Click Yes to proceed with the deletion. Click No to cancel it.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 9: Configuring Analysis Save Sets
142
9
EMC Backup Advisor 2.0.1 Administrator’s Guide143
Chapter 10: Using the Ruleset Editor
A ruleset is the set of instructions used by the Analysis Engine to determine whether a condition has been met and if EMC Backup Advisor generates an alert. This chapter describes how to use the Ruleset Editor to create rulesets and alerts. This chapter contains the following sections:
• "Ruleset Basics" on page 143• "Creating a Simple Ruleset" on page 145• "Complex Rulesets" on page 155• "Testing a Ruleset" on page 157
Ruleset BasicsWhen you install EMC Backup Advisor, several predefined rulesets are installed that you can use to monitor common problems in your environment. Use the EMC Backup Advisor Ruleset Editor to modify and create rulesets.
To view an existing ruleset:
1. Ensure that you are logged in to EMC Backup Advisor as a user with administrative privileges.
2. Select Tool > Ruleset Editor from the menu bar. The Ruleset Editor dialog box appears that shows all existing rulesets as shown in Figure 105 on page 143.
Figure 105. Ruleset List
3. Select the ruleset you want to view. Click View. The Ruleset Properties dialog box appears as shown in Figure 106 on page 144.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 10: Using the Ruleset Editor
144
10
Figure 106. Ruleset Properties
The Ruleset Properties dialog box is a graphical editor that allows you to build new rulesets or change existing rulesets. A ruleset is represented as a flowchart with different elements representing the steps performed by the Analysis Engine as it evaluates the ruleset.A ruleset is built using several element types. These elements are displayed in the toolbar above the graphical editor.To add an element to a ruleset, select the element on the toolbar, and click the main pane of the Ruleset Properties dialog box. Link elements to the flow chart by selecting the input port or output port of the element and dragging the mouse to the input port or output port of another element.
Chapter 10: Using the Ruleset Editor
EMC Backup Advisor 2.0.1 Administrator’s Guide145
10
Creating a Simple RulesetThe following example illustrates how to use the Ruleset Editor to create a simple ruleset entitled CPU Busy. The ruleset generates an event for all hosts for which CPU utilization is beyond a threshold specified in the analysis Save Set.
To create this ruleset:
1. Select Tools > Ruleset Editor from the menu bar. The Ruleset List dialog box appears. Click New. The Ruleset Properties dialog box appears as shown in Figure 107 on page 145.
Figure 107. Creating a New Ruleset
2. Enter a name for the ruleset in the Name field. The name of the field must uniquely identify the ruleset.
3. Enter a description for the ruleset in the Description field describing your ruleset actions.
4. Select a ruleset category by selecting a value from the Category field or by typing a new category name in the field. The category helps you search for the ruleset in other areas of EMC Backup Advisor.
Initially, the Ruleset Properties dialog box contains only the Input element, which is the starting point for all rulesets. An input parameter is a variable that specifies when a user creates an Analysis Save Set using this ruleset. In this example, the user specifies the threshold on which to generate alerts as a parameter to the ruleset.
5. Right-click the input element and select Properties from the menu as shown in Figure 108 on page 146.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 10: Using the Ruleset Editor
146
10
Figure 108. Input Element Properties
6. The Properties Editor appears. Click Add. The Properties Editor inserts a blank line so that you can specify the input parameters to be associated with the ruleset. All input parameters have a name, description, and cast (the default value is optional). The description of the parameter appears as a tool tip when a user creates an Analysis Save Set using this ruleset.
In our example, we want the user to be able to specify a parameter that determines the maximum CPU utilization that is allowed before an alert is generated by the Analysis Engine.
7. In the Name field, enter Maximum CPU Utilization. Optionally, enter a description in the Description field. Enter Float in the Cast field. Set the default value to 90 in the Default field as shown in Figure 109 on page 146.
Note: To add text to a field, double-click in that field. Enter the value for the Cast field by selecting a value from the list of values as shown in Figure 109 on page 146.
Figure 109. Defining Input Parameters
8. Click OK. The input element is updated in the Ruleset Properties dialog box to display the names of any input parameters as shown in Figure 110 on page 147.
Chapter 10: Using the Ruleset Editor
EMC Backup Advisor 2.0.1 Administrator’s Guide147
10
Figure 110. Defining Ruleset Input Parameters
9. The next element in any ruleset is a Report element. A report element runs one or more reports and returns the results for the remainder of the ruleset to analyze. To add a report element to the ruleset, click Report on the toolbar. Click the main pane of the Ruleset Properties dialog box.
10. Most elements have two connectors represented by small red triangles. These triangles represent the input and output connector of the element. You can interconnect elements using these connectors. To connect two elements, click the output connector of the first element and drag the mouse to the input connector of the second element before releasing it as shown in Figure 111 on page 148.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 10: Using the Ruleset Editor
148
10
Figure 111. Adding Report Element to a Ruleset
11. Right-click the report element. Select Properties from the menu. The Property Editor dialog box appears as shown in Figure 112 on page 148.
Figure 112. Defining Report Element Properties
12. The available data sources are displayed in the Reports field. These are the reports that you can use as a data source for the ruleset. To select the report, scroll to Processor Utilization by Node and drag the report to the Current field as shown in Figure 112 on page 148.
Chapter 10: Using the Ruleset Editor
EMC Backup Advisor 2.0.1 Administrator’s Guide149
10
You can select (by dragging) more than one report to include in the ruleset. The Property region shows the properties of the currently selected report in the Current field. The Property region allows you to label the report in the Name field. You can then run the same report twice with different input parameters, and still uniquely identify the outputs of each report later in the ruleset.When a report is run by the Analysis Engine, it requires several passed arguments. The Property region allows you to specify each of these input arguments. The input arguments can be static values, typed in, or selected from the variables in the list of values. Variables are enclosed in braces ({}). By default, several report element variables are displayed and are described in Table 21 on page 149.
In addition to the system variables, you can select any input parameter created on the input element.
13. The Conditions region allows you to filter the results returned from the report. For example, to restrict those clients that are alerted to just those that begin with the letter a, add a condition so that only information returned from the report that meets that condition is passed onto the next stage of the ruleset.
To do this, click Add to modify the Conditions region. Select the variable that contains the host from the list of values in the Instance field. In this case the field is Processor Utilization By Node::Hostname. This represents the Hostname field as returned by the Processor Utilization by Node report. Specify a condition of starts with and type a in the Value field as shown in Figure 113 on page 149.
Figure 113. Specifying Report Element Conditions
Table 21. Report Element Variables
Variable Description
{The current node} Node to which the analysis Save Set is assigned.
{The current node and all its children}
Node to which the analysis Save Set is assigned and all of its children.
{Each child of the current node (separately)}
Children of the node to which the analysis is assigned.
{Now} Time at which the ruleset is evaluated.
{Last time the ruleset ran}
Last time the ruleset was evaluated.
{Interval between runs of this ruleset}
Time interval between subsequent evaluations of the ruleset.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 10: Using the Ruleset Editor
150
10
14. Remove that condition by clicking Remove.
15. Click OK to return to the Ruleset Properties dialog box as shown in Figure 114 on page 150.
Figure 114. Updated Ruleset with Report Properties
16. Specify what to do with the results. One option is to iterate over each element in the results and carry out further actions by adding an iteration element to the ruleset. The element for iteration is the For Each element. To add the For Each element to the chart, select it from the toolbar, and click the main Ruleset Properties dialog box panel. Connect it to the output of the report element.
17. Because a report element can evaluate more than one report, you must configure the For Each element to the Analysis Engine. To do so, select the source to which to iterate over by right-clicking the For Each element and selecting Properties to display the Property Editor, as shown in Figure 115 on page 150
Figure 115. Property Editor
18. Accept the default in the Iterate over field and click OK.
19. This example defines a ruleset that triggers an event if the CPU on a host is greater than a certain percentage. To do this, add a condition element to the ruleset by selecting the Condition element on the toolbar and clicking the main Ruleset Properties dialog box panel.
20. Connect it to the For Each element by dragging as shown in Figure 116 on page 151.
Chapter 10: Using the Ruleset Editor
EMC Backup Advisor 2.0.1 Administrator’s Guide151
10
Figure 116. Adding a Ruleset Condition Element
21. To specify the details of a condition, right-click the Condition element and select Properties. The Property Editor dialog box appears as shown in Figure 117 on page 151.
Figure 117. Condition Properties
22. A condition consists of an instance, a relational operator, and a value. The value can be one of the variables available in the list of values or a static value. For this example, the required condition is set to {Processor Utilization By Node: Utilization} greater than {Maximum CPU Utilization}. That is, we take the processor utilization variable returned from the report and compare it to the Maximum CPU Utilization parameter that we created as an input parameter to the ruleset. Click OK.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 10: Using the Ruleset Editor
152
10
A Condition element can have more than one condition. If more than one condition exists, all conditions have to be met for the information to be passed to the next element in the ruleset.
23. After determining the hosts for which CPU utilization is greater than the specified amount, the Analysis Engine generates an alert for each of those hosts. The final element of all rulesets is an Event element. To generate an alert, add an Event element to the ruleset by clicking Event, and then clicking in the main Ruleset Properties dialog box panel. Condition elements have two outputs. The first, indicated by a green triangle, indicates the path that is taken if the condition is met. Attach the event condition to the green triangle as shown in Figure 118 on page 152.
Figure 118. Adding the Ruleset Event Element
24. Events forwarded by the Analysis Engine are sent with three pieces of information: a key, a hostname, and a message. To specify this information, right-click the Event element and choose Properties from the menu. The Event Properties dialog box appears.
25. Configure the Key, Host, and Message fields for an event by entering information in the relevant fields. Each field can contain a mix of text and/or variables that are substituted when the ruleset is evaluated. Complete these fields as shown in Figure 119 on page 153. Click Insert variable to modify the Key field. Select a value from the list of values in the Host field. Type data in the Message field and click Insert variable to insert variables in the text that you enter.
Chapter 10: Using the Ruleset Editor
EMC Backup Advisor 2.0.1 Administrator’s Guide153
10
Figure 119. Event Properties
We have created a message that combines variables from the ruleset with static text. The alert message produced by the Analysis Engine looks something like:CPU on host.emc.com is at 94% which is greater than 90%
Note: It is possible include XML tags in the Message field.
26. After specifying the Event properties, click OK. The graphical editor displays the ruleset as shown in Figure 120 on page 154.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 10: Using the Ruleset Editor
154
10
Figure 120. Updated CPU Busy Ruleset
27. To complete the ruleset, define what happens if the condition is not met by connecting an element to the red triangle on the Condition element. In this case, do not perform any action, so add the End element to the flow chart. The End element tells the Analysis Engine to stop processing at that point. Select End on the toolbar and click the main Ruleset Properties dialog box panel. Link the End element to the red triangle of the Condition element. The completed Ruleset appears in Figure 121 on page 155.
Chapter 10: Using the Ruleset Editor
EMC Backup Advisor 2.0.1 Administrator’s Guide155
10
Figure 121. Completed Ruleset
28. Save the ruleset by clicking OK. The ruleset is saved to the database. You can now use the ruleset as part of analysis Save Sets when perform monitoring functions.
Complex RulesetsIn addition to the elements used in the CPU Busy rule set, you can also use the Ruleset Editor to configure a ruleset with the Once, Variable, Branch, and Merge elements creating more complex rulesets that provide more intelligent behavior.
• The Once element is similar to the For each block, however, rather than iterating over each row of the result, Once executes the remaining rule set only once
• The Variable element allows you to define new variables or functions. A variable consists of a name and its assigned value, which can be a static value the user enters or a dynamic value calculated by a function or expression. The Property Editor dialog box for the Variable element is shown in Figure 122 on page 156.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 10: Using the Ruleset Editor
156
10Figure 122. Defining a New Variable
• A branch element defines multiple paths to enable you to check different conditions. An example ruleset using variables and branches to generate two different events dependant on certain conditions appears in Figure 123 on page 156.
Figure 123. A Rule Set with a Variable and Branch Elements
• A merge element is the opposite of the branch element in that you can use it to merge different branches of the flow chart together.
Chapter 10: Using the Ruleset Editor
EMC Backup Advisor 2.0.1 Administrator’s Guide157
10
Testing a RulesetTo test a ruleset:
1. Select the ruleset in the Ruleset List dialog box. Click Test. The Parameters dialog box appears as shown in Figure 124 on page 157.
Figure 124. Testing a Ruleset
2. Set the View, Node, Time, and Last Run and any other ruleset-specific input parameters fields available for your ruleset. Click OK. The ruleset and input parameters are passed to the Analysis Engine and executed immediately.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 10: Using the Ruleset Editor
158
10
EMC Backup Advisor 2.0.1 Administrator’s Guide159
Chapter 11: Configuring Menus
To run a report, right-click a node in the Navigation tree and select the report. You can also run reports from within other reports by right-clicking the report and selecting a new report from the menu. You can customize the two menu types using the Menu Editor:
• Tree menus - Displayed when you right-click a node in the Navigation tree• Report menus - Displayed when you right-click a chart or table
This chapter describes how to configure menus. This chapter contains the following sections:
• "Tree Menus" on page 159• "Report Menu" on page 160• "Creating a Menu" on page 160• "Copying a Menu" on page 167• "Editing a Menu" on page 167• "Deleting a Menu" on page 167• "Users and Menus" on page 168
Tree MenusThe Tree menu appears when you right-click a node in the Navigation tree. When the menu appears, the GUI analyzes each item on the menu and determines if the underlying report is applicable to the selected nodes. If the GUI determines that a menu item requires data that is not being gathered for the selected node, then the menu item does not appear in the menu.
When EMC Backup Advisor is installed, the default Navigation tree appears as shown in Figure 125 on page 160.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 11: Configuring Menus
160
11
Figure 125. Sample Navigation Menu
Report MenuYou can configure report menus on certain report types. If you configure a report to display a report menu, that menu appears when the user right-clicks the report. Use the Report Editor to configure report menus as discussed in "Chapter 12: Configuring Reports" on page 169.
When menus are created using the Report Editor, the same Menu Editor is launched as the one used when creating Tree menus. The process for creating a menu used in reports is identical to that discussed in this chapter.
Creating a MenuTo create a new menu:
1. Log in to EMC Backup Advisor as a user with administrative privileges.
2. Select Tools > Menu Editor. The Menu List dialog box displays all the Tree menus defined in EMC Backup Advisor as shown in Figure 126 on page 161.
Chapter 11: Configuring Menus
EMC Backup Advisor 2.0.1 Administrator’s Guide161
11
Figure 126. Menu List
3. Click New. The Menu Properties dialog box appears as shown in Figure 127 on page 161.
Figure 127. Menu Properties
The Menu Properties dialog box has two main components:• Menu Tree - Shows a pictorial representation of what the menu looks like
along with a toolbar that allows you to perform operations on the menu• Fields - Displays details on the currently selected menu item allowing you to
modify that item
4. When you create a new menu, the name Untitled appears in the Menu Name field. Change the name of your new menu. As you change the name, the name displayed in the Menu Tree also changes.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 11: Configuring Menus
162
11
5. Select the Default Menu check box to specify whether this menu becomes the default menu that all users see when clicking nodes in the Navigation tree (unless they specifically request a different menu). If you want this menu to become the default menu for all users, select the Default Menu check box.
6. Define the object types for a menu:
• Menu Folder - Group elements of other menu folders or menu items• Menu Item - Contains the details of the report, Control Panel, or command that is run
when a user selects the item
7. Select the folder within which you want to add the new folder. Click Add Folder from the toolbar ( ) to create a new folder entitled New Folder. Change the name of the folder by editing the Folder field. The change is reflected in the Menu Tree as shown in Figure 128 on page 162.
Figure 128. Adding a Folder
8. Add a menu item within the folder by selecting the folder within which the item is added and clicking Add Menu Item ( ). A menu item labeled Untitled is created below the folder as shown in Figure 129 on page 163.
Chapter 11: Configuring Menus
EMC Backup Advisor 2.0.1 Administrator’s Guide163
11Figure 129. Creating a Menu Item
9. Change the label of the menu item by typing the new name for the menu item in the Menu Label field. The name also changes in the Menu Tree.
10. Specify the type for the menu item by selecting an option from the Menu Item Type field. Menu items can be one of the following types:
• Report - Run a report• Control Panel Control Panel- Run a Control Panel Control Panel• Command - Run an external command; for example, run a command to start
a web browser• Action - Add a value to a right-click menu. Values include Backup
Resolution and Remove Resolution
11. Click OK. Your menu item is created.
Adding a Report Menu ItemTo create a report menu item:
1. Give the menu item a label by typing it in the Menu Label field.
2. Select a value from the list of values in the Report Category field as shown in Figure 130 on page 164.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 11: Configuring Menus
164
11 Figure 130. Adding a Report Menu Item
3. Select the report name from the list of values in the Report Name field as shown in Figure 131 on page 164.
Figure 131. Specifying a Report Name
4. Click OK. The report that you specified runs when a user selects the newly created menu item.
Note: If a report has been deleted, the Report Name field appears in red.
Chapter 11: Configuring Menus
EMC Backup Advisor 2.0.1 Administrator’s Guide165
11
Adding a Control Panel Menu ItemIf you choose to create a Control Panel menu item, the dialog box displays a list of available Control Panels as shown in Figure 132 on page 165.
Figure 132. Adding a Control Panel
Select the Control Panel Name from the list on the right, and assign the menu item a label. The information is automatically reflected in the Menu Tree.
Adding a Command Menu ItemTo add a Command menu item:
1. Select Command from the list of values in the Menu Item Type field. A Command Name field appears as shown in Figure 133 on page 165.
Figure 133. Adding a Command
2. In the Command Name field, enter a command to be executed when the user selects the menu item.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 11: Configuring Menus
166
11
3. For Report menus, when defining the command name, you can include field values in the table from which the menu is being run. The field value is substituted at the time the command is executed. Input the field names using the @fieldname@ format.
For example, if a report contains the five columns, host,job,status,starttime,endtime, define a command against a menu item to send a page message to a user using the following syntax:C:\Program Files\Pager\pager.exe 34535 @host@:@job@ @status@ at @endtime@'This results in a message such as amazon:/usr failed at 23/10/2006 07:00:00 sent to a pager number.
4. For Tree menus, you can include the node attributes value for which the menu item is being run. To include the value of an attribute, specify the name of an attribute using the @attributename@ format.
Removing a Menu Item or FolderTo remove a menu item or folder, select the menu item or folder you want to remove. Click Delete ( ). You are prompted to confirm that you want to remove the item. Click Yes. Click No to cancel the deletion.
Positioning Menu ItemsYou can change a the position of a menu item within a folder by clicking Up ( ) and Down ( ). Select the item you want to move. Click Up or Down to change its position.
If moving menu items or folders to entirely different parts of the menu, click Cut ( ), Copy ( ), and Paste ( ).
Chapter 11: Configuring Menus
EMC Backup Advisor 2.0.1 Administrator’s Guide167
11
Configuring Menu Item PermissionsYou can control when a menu item appears based on the object type in the tree from which the user is running the menu. To do this:
1. Select the menu item you want to configure. Click Permissions. The Menu Item Permissions dialog box appears as shown in Figure 134 on page 167.
Figure 134. Menu Item Permissions
2. By default, menu items are displayed on all node types as long as the GUI detects that the data required by that report is being gathered from that device. To restrict the report item to only run from certain devices, select the check box beside the Node type in the Menu Item Permissions dialog box.
3. Click OK to save the permission settings.
Copying a MenuTo copy a menu, select a menu it from the Menu List dialog box. Click Copy. The Menu Editor opens to allow you to modify the newly created copy.
Editing a MenuTo edit a menu, select it from the Menu List dialog box. Click Edit. Menus that were installed with EMC Backup Advisor cannot be edited directly. To edit a menu that was installed with EMC Backup Advisor, make a copy of that menu and edit the copy.
Deleting a MenuTo delete a menu, select it from the Menu List dialog box. Click Delete. You are prompted to confirm the deletion. Click Yes to confirm. Click No to cancel the deletion.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 11: Configuring Menus
168
11
Users and MenusIn certain situations, it may be required to restrict reports from specific users or to make reports available that are specific to the roles of users. For example, a System Administrator may want to run different reports on a daily basis than an Operator.
You can configure different users to use specific menus in order to meet your requirements. To specify which menu a user will see when using EMC Backup Advisor:
1. Log in to EMC Backup Advisor as a user with administrative privileges.
2. Select Tools > User Editor. The User List dialog box appears.
3. Select the user whose menu you want to change and click Edit.
4. Select the Preferences tab. The Users Properties dialog box displays that user preferences.
5. Select the name of the menu that you want the user to use from the Menu drop-down list box.
6. Click OK to save the users preferences. The next time that user logs in to the system, the menu you have selected appears when they click a node in the Navigation tree.
EMC Backup Advisor 2.0.1 Administrator’s Guide 169
Chapter 12: Configuring Reports
EMC Backup Advisor provides the ability to create and edit reports using the Report Editor. This chapter describes how to configure reports using the Report Editor. This chapter contains the following sections:
• "Accessing the Report Editor" on page 169• "Understanding Reports" on page 170• "Creating a Simple Report" on page 171• "Creating Report Content" on page 180• "Customizing the Appearance of a Report" on page 199• "Editing a Report" on page 235• "Deleting a Report" on page 235• "Exporting a Report" on page 235
Accessing the Report EditorTo access the Report Editor:
1. Log in to EMC Backup Advisor as a user with administrative privileges.
2. Select Tools > Report Editor from the menu bar. The Report List dialog box appears and shows all of the reports that are defined EMC Backup Advisor in alphabetical order as shown in Figure 135 on page 170.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
170
12
Figure 135. Report List
3. If you know the name of the report that you want to edit, type part of the report name into the Search field. The Report List jumps to that letter combination.
Note: The reports are also categorized. To display reports within a particular category, change the value in the Category field to the category that in which the report that you want to edit is classified. To view a list of all reports in EMC Backup Advisor, select All from the list of values in the Category field as shown Figure 135 on page 170.
Understanding ReportsThere are many predefined reports that are available when you install EMC Backup Advisor. You cannot modify the preinstalled reports directly because they may be updated in future releases.
To modify a predefined report:
1. Open the Report List dialog box by selecting Tools > Report Editor from the menu bar. Click Copy. The Report Properties dialog box appears.
2. Make changes to the copy of the report.
3. In the Name field, enter a unique name for the modified report.
4. Click OK.
5. Using the Menu Editor, add the new report to a menu and specify the modified report instead of the original report. See "Chapter 12: Configuring Reports" on page 169 for information about using the Menu Editor.
You can also use the Report Editor to create new reports as discussed in "Creating a Simple Report" on page 171.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide171
12
Creating a Simple ReportThe following example illustrates how to use the Report Editor to create a simple report that produces a bar chart that displays how many Jobs are processed on a backup server.
1. Select Tools > Report Editor from the menu bar. The Report List dialog box appears.
2. Click New. The Report Properties dialog box appears as shown in Figure 136 on page 171.
Figure 136. Report Properties
3. Specify the fields as described in Table 22 on page 171.
4. Define the data gathered for the report and specify how you want to display that data.
Table 22. Report Properties Fields
Field Description
Name Unique name for the report you are creating.
Description Information about what the report does.
Category Category in which the report is placed. The values for this field include the report categories defined in EMC Backup Advisor. If you want to create a new category, type a new category name in this field.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
172
12
Note: The data that makes up a report is the report content. Content is defined by adding a report item to the report. A report item returns a report data set that contains the information displayed in the report. A report must contain at least one report item, but can contain many report items in more complex reports.
For example, a simple report that displays information about backup Jobs typically includes one report item that returns the backup Job information. A more complex report that displays both file system utilization and memory utilization in a chart and includes two report items: one for the file system utilization information and one for the memory utilization information.
5. To define the report content, click Add in the Report Item region. The Report Item Properties dialog box appears as shown in Figure 137 on page 172.
Figure 137. Report Item Properties
6. Enter a name in the Name field and an optional description in the Description field for the report item. Create report items by combining Data Sources and Operators in a graphical editor. When the report is executed, the graphical editor is evaluated to produce a report data set.
• Data Source - Object that generates a data set. An example of a report data source is the Backup Job Details data source, which queries the EMC Backup Advisor database and returns a row containing information on every executed backup Job
• Operator - Object that operates on a data set and modifies it in some form. An example Count operator counts the number of rows in a data set
7. To view the list of available data sources, click the Sources element in the tree in the left-hand panel of the Report Item Properties dialog box. The tree is expanded to show a hierarchy of all the available data sources in EMC Backup Advisor as shown in Figure 138 on page 173.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide173
12Figure 138. Selecting the Data Source
8. All data sources are included in categories displayed in the tree. To view all of the available data sources, expand the tree by clicking the + to the left of that folder. This displays each data source in the category.
9. Retrieve more information about a data source and the fields displayed on the report by selecting the data source and clicking Description at the bottom of the Report Item Properties dialog box.
10. Select a data source and drag it to the graphical editor as shown in Figure 139 on page 174. In this example, select the Backup Job Details data source. This data source returns a row for every Job backed up during the time specified.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
174
12
Figure 139. Adding Backup Job Details
11. To calculate the number of complete backups, use the Count operator. To select the Count operator, expand the Operators section on the tree, and expand the Math category as shown in Figure 140 on page 174.
Figure 140. Selecting an Operator
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide175
12
12. Select the Count operator and drag it to the graphical editor as shown Figure 141 on page 175.
Note: Online help is available for all operators by selecting an operator in the tree and clicking Description.
Figure 141. Adding the Count Operator
13. Link the Backup Job Details data source to the Count operator, and link the Count operator to the End element by dragging from the red triangle on the Backup Job Details element to the red triangle at the top of the Count operator.
14. Connect the red triangle at the bottom of the Count operator to the End element. The items are now linked as shown in Figure 142 on page 176.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
176
12
Figure 142. Link the Report Item
15. Click OK to return to the Report Properties dialog box. The new report item appears in the Item List as shown in Figure 143 on page 176.
Figure 143. Adding a Report Item
16. To view the list of fields returned by the report item, expand the report item. In this example, only one field entitled Count is returned.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide177
12
17. To complete the report, specify how to display the report by selecting a report type in the Appearance region of the Report Properties dialog box. Click Report Type. A list of available report types are displayed as shown in Figure 144 on page 177.
Figure 144. Specifying a Report Type
18. EMC Backup Advisor provide 13 report types as described in Table 23 on page 177. Select one of these report types for your report.
Table 23. EMC Backup Advisor Report Types
Report Type Description
Detailed Table Table that displays several rows. You can apply rules to alter the appearance of rows. Users can select individual rows and run reports using a menu.
Summary Table Table that typically represents a smaller amount of data than a Detailed Table. A Summary Table can be configured so that if a user clicks an individual cell another report is run.
Report Card Sophisticated table that displays the status of items over time. A cell appears for each day with each cell displaying the number of items that occurred on that day, color-coded to differentiate them.
Trend Chart Line chart that plots values on the y-axis against time on the x-axis. Multiple series are represented by additional lines on the chart.
Area Chart Similar to trend charts except they shade the area below the plotted line. If multiple series are plotted, these areas overlap each other.
Stacked Area Chart Similar to an area chart except that if multiple series are plotted, the areas are stacked on top of each other rather than overlapping.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
178
12
You can modify several parameters for each report type to change the appearance of the report. The report toolbar displays available parameters, depending on which report type you select.
The Appearance toolbar associated with the bar chart report type is described in Figure 145 on page 179.
Bar Chart Displays each data point in a series within a bar. If the data spans over a period of time, the x-axis represents time, with a bar for each point in time of the series. If the data represents state at a point in time, then a bar appears for each series. If multiple series are displayed, a different bar appears for each series.
Stacked Bar Chart Similar to a bar chart except that if multiple series are displayed, the bars are stacked on top of each other.
Bubble Chart Displays two data values over a series of time. One data value appears with reference to the y-axis, and the second piece of data is represented by the size of the bubble displayed.
Candle Chart Displays data in a Gantt-style chart. For each series, a horizontal bar shows when the activity started and when it completed. View the additional information about the activity by hovering over the bar with the mouse.
Pie Chart Displays how the data values in different series compare at a point in time. A Pie Chart is created with a segment for each data series. The size of each segment is related to the value of that series.
3-D Bar Chart Displays data in a three dimensional bar form. The x-axis and y-axis depict different elements of time. The z-axis depicts the value of the data series at each point in time.
3-D Surface Chart Displays data in a three-dimensional surface form. The x-axis and y-axis depict different elements of time. The x-axis depicts the value of the data series at each point in time.
Table 23. EMC Backup Advisor Report Types
Report Type Description
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide179
12
Figure 145. Bar Chart Report Toolbar
19. To test a report in the Report Editor, click Test Report ( ). The Sample Data dialog box appears.
20. Select a reporting period in the Time Window field. In the View field, select a view from the list of values. Select and an object in the Navigation tree against which you want to report the data as shown in Figure 146 on page 179.
Figure 146. Sample Data
21. Click OK. The Report Editor displays the report in the main window as shown in Figure 147 on page 180.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
180
12
Figure 147. Displaying Report Results
22. After testing the report, you can customize the appearance of the report by configuring the other parameters for that report type by clicking different report appearance buttons from the toolbar. These appearance buttons are described in "Customizing the Appearance of a Report" on page 199.
23. After the content and appearance of your report is satisfactory, click OK. The report is saved to the database.
Note: To allow this report to be run from a menu in the main application, add this report to a menu. See "Chapter 11: Configuring Menus" on page 159 for instructions.
Creating Report Content"Creating a Simple Report" on page 171 describes how to use the Report Item Editor to specify the content for a report. You can also specify parameters for data sources and operators to obtain finer control over the data returned by the report item. This section discusses these features and describes how to use them to define more complex reports.
Customizing Data SourcesAll data sources that query the EMC Backup Advisor database provide several options that control how data is gathered from the database. Among other things, you can:
• Modify the fields on the report• Modify the order of these fields• Apply conditions to restrict the data that appears on the report
To customize a data source, from the Report Item Editor:
1. Selecting Tools > Report Editor from the menu bar. The Report List dialog box appears.
2. Click New. The Report Properties dialog box appears.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide181
12
3. Click Add. The Report Item Properties dialog box appears.
4. Add a data source by dragging it to the main Report Item Properties panel from the data source tree.
5. Right-click the data source. A menu appears as shown in Figure 148 on page 181.
Figure 148. Customizing a Data Source
6. Complete the following sections:
• "Data Source Label" on page 181• "Data Source Fields" on page 182• "Data Source Times" on page 183• "Data Source Nodes" on page 187• "Data Source Conditions" on page 187• "Data Source Limits" on page 191• "Data Source Order" on page 193• "Data Source Options" on page 193
Data Source LabelWhen you add a data source to a report item, the label in the box defaults to the title of the data source. Changing the label of a data source does not change the data that is returned; it is purely a method for making report items more understandable.
To modify the data source label:
1. Select Label from the menu shown in Figure 148 on page 181. The Input dialog box appears that allows you to specify the new label to be displayed for that data source.
2. Enter a value in the Source Label field.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
182
12
3. Click OK.
Data Source FieldsTo modify the fields that are returned by a data source:
1. Select Fields from the menu. The Field Selection dialog box appears as shown in Figure 149 on page 182.
Figure 149. Data Source Field Selection
2. The Field Selection dialog box displays the fields that can be returned by a data source in the Field column. To include fields returned by the data source, select the check box in the Include column. To remove a field from the selection, deselect the check box.
Note: In most data sources, there is usually at least one field that cannot be removed from the selection. These are key fields and must always be included to ensure data integrity. Key fields are shown in bold. Value fields are shown in regular text.
3. Each field in the list has a label associated with it. Changing the label of a field effectively renames that field. To change the name of a field, click the Label column and type in the new name for the field.
4. The Cast column displays the type of data returned by the field (examples include text and integer values). You cannot modify the cast of the field.
5. The Units column displays the units in which the data of the fields is stored. For example, the size of Backup Jobs returned by the Backup Job Details data source is always stored in MBs. It is not possible to modify the this field in the Field Selection dialog box.
Note: To modify a Unit field, use the Multiply or Divide operators to perform the conversion. See the online help for the Multiply and Divide operators for more information.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide183
12
Data Source TimesData source time parameters specify the times that are used when the data is queried from the database. The time defaults to values that are appropriate for the type of report created and the type of data reported, but can be modified to obtain different results.
To modify the time parameters:
1. Select Time from the menu. The Time dialog box appears as shown in Figure 150 on page 183.
Figure 150. Data Source Time Selection
2. The Time Type field includes the following values:
• Period - Instructs the Reporter to return data between two points in time. For example, if you want to display all backup Jobs that occurred between Monday at 9 AM.and Friday at 5 PM, select a Time of type Period to enable the Start Time and End Time fields
• Point In Time - Instructs the Reporter to return a data value at a specific point in time. For example, if you want to identify the state of a file system at 9 AM on Friday, then select the Point In Time type. When you select a Point In Time report, only the Start Time fields are enabled as shown in Figure 151 on page 184
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
184
12
Figure 151. Point in Time Report
3. Enter data in the following fields as described in "Specifying the Start Time and End Time Fields" on page 184:
• Start Time Field• Start Time• Start Time Param• End Time Field• End Time• End Time Param
4. Enter data in the Interval Type and Interval Value fields as described in "Interval Type and Values" on page 185.
Specifying the Start Time and End Time FieldsAll data within the EMC Backup Advisor database is stored with time information that identifies when a transaction occurred and how long it is valid. Some data types can contain multiple fields that contain time values. For backup Jobs, EMC Backup Advisor maintains the time that the Job starts to queue, the time the Job starts to write to tape, and the time the Job finishes writing to tape. If you modify the Start Time and End Time fields, you can use alternate criteria for the report.
For example, if you want to report on all backup Jobs that start queuing between the start time and end time that the user specifies, you can modify the Start Time and End Time fields to select the Queue Time option on the Backup Job Details data source.
For most reports, the default value is adequate for these fields.
There are several options you can specify to determine what values are used for the start time and end time of the data source, some of which require parameters. For values that require parameters, the Start Time Param and End Time Param fields are enabled.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide185
12
The options for the Start Time and End Time value fields are described in Table 24 on page 185.
Interval Type and ValuesWhen creating a data source to retrieve data over a time period, you can specify an interval for that time period. For example:
• If you are plotting file system utilization over a period of time in a chart, the data set returns many data points that show the state of file system utilization at different time intervals during the period. To do this, select an interval type
• If you are reporting all backup Jobs that ran between two points in time in a table and the Job information reports data over the whole period instead of different time segments, do not specify an interval
Interval types are described in Table 25 on page 185.
Table 24. Start and End Time Values
Value Description
Epoch Earliest point in time (January 1,1970).
Start of Window Start time selected by the user.
End of Window End time selected by the user.
Current Time Current time when the report runs.
End of Time Point of time far in the future (January 19, 2038).
Specific Time Hard code a data source to get data at a specific point in time. You can create additional times using the Windows Editor. See "Chapter 7: Configuring Time Windows" on page 109 for more information about using the Windows Editor.
Relative to Start of Window
Specify an offset to the start time selected by the user.
Relative to End of Window
Specify an offset to the end time selected by the user.
Variable If this is a drill down report, then this is the value of the time stored in a field in the previous report. Set the Start Time Param or End Time Param field to specify the name of the field in the previous report. The value of this field is used as the time value.
Table 25. Interval Types
Interval Description
No Interval Do not use an interval.
Fixed Interval Use an absolute value (in seconds) for the interval.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
186
12
User Interval Calculate the interval by using the number of points in the Num Points field in the Preferences tab in the User Properties dialog box of the user that is running the report.
Full Interval Use the full period of the report as the interval value.
Table 25. Interval Types
Interval Description
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide187
12
Data Source NodesSpecify which nodes EMC Backup Advisor uses for generating the report as shown Figure 152 on page 187.
Figure 152. Node Selection
1. Select Nodes from the menu. The Node Info dialog box appears.
2. Enter data in the fields as described in Table 26 on page 187.
Data Source ConditionsUse the Condition Expression dialog box to place conditions on the data that is returned from the EMC Backup Advisor database. You can combine these conditions into a condition expression using the logical operators AND and OR.
Table 26. Node Selection Fields
Field Description
Node Field Similarly, to the Start Time Field and End Time Field parameters in the Time Selection dialog box, certain database tables may contain multiple fields that contain hostnames. When a report is run, the nodes selected in the Navigation tree is matched against one of these fields.
The Node Field field allows you to specify which field is used in this matching process. For example, for backup Job information, each backup Job contains information about the clients that were backed up, the backup server, and the media server where the Job took place.
To display all Jobs that took place on a backup server, select Server from the list of values. For most data types, there is only one value for this field in the data set. Select that option.
Node Value Indicates the value to be used for the node in the report. Values include:• User Selected - Name of the node specified by the user
(typically from the Navigation tree)• Variable -Value specified in a variable passed to the report
from a previous report. Use this value when a report is linked to another previously run report. If selected, the Variable field is enabled. Enter the name of the variable
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
188
12
To apply a set of conditions to a data set:
1. Select Conditions from the menu. The Condition Expression dialog box appears as shown in Figure 153 on page 188.
Figure 153. Data Source Condition Expression
2. Click Add Condition. The Condition dialog box appears as shown in Figure 154 on page 188.
Figure 154. Condition
3. A condition consists of a field name, an operator, and a value. When the report is run, only the rows in the database that match that condition are returned. Enter data in the fields described in Table 27 on page 188.
Table 27. Condition Fields
Field Description
FieldName Name of the field on which to apply the condition.
Operators Condition itself, for example, equal to, not equal to, greater than.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide189
12
For example, to create a condition that restricts those backup Jobs to show only those Jobs that are greater than one gigabyte, create the condition shown in Figure 155 on page 189
Figure 155. Example Condition
4. Click OK. The Condition Expression appears as shown in Figure 156 on page 190.
Value Type Condition value. Can be a fixed static value or something that is determined at the time the report is evaluated. The options are:• Static—The value is taken from the Value field• User Entered—Prompts the user for the value at the time
the report is run.• Current Time—The current time in seconds.• Start Time—The start time of the report.• End Time—The end time of the report.
Value If defining a static value, specify that value in this field.
Table 27. Condition Fields
Field Description
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
190
12
Figure 156. Updated Condition Expression
5. To add a second condition to the expression and link it to the first using a logical operator, click Add operator. This adds an operator above the first condition as shown in Figure 156 on page 190.
Figure 157. Updated Condition Expression
Note: You can modify the operator by selecting a value from the list of values in the Condition Expression region.
6. Add another condition by clicking Add Condition again and specify that condition. For example, to add a condition to show only those Jobs that backed up more than one file, specify the fields shown in Figure 158 on page 191. Click OK.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide191
12
Figure 158. Updated Condition Expression
After applying the second condition, the Condition Expression dialog box is updated to display the condition expression. You can create complex conditions by combining multiple operators and conditions.
Data Source LimitsYou can apply limits to data sources that restrict the number of rows that display on a report. To apply a row limit, select Limit from the data source menu. The Limit dialog box appears as shown in Figure 159 on page 192.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
192
12
Figure 159. Data Source Limit Selection
1. To apply a limit, select the Limit check box.
2. In the Type field, select a value from the list of values. These values are described in Table 28 on page 192.
3. In the Value field, select a value from the list of values or type a field name.
4. Click OK.
Table 28. Data Source Limit Fields
Field Description
Static Requires that the user enter the specific number of rows that are displayed in the Value Field of the report.
Variable Value is calculated at run time by the GUI if users are drilling down from one report to the next. The value used is the contents of a field in the preceding report. To specify a variable limit, enter the field name from which you want the GUI to obtain the value.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide193
12
Data Source OrderTo specify the order that data is returned from the server:
1. Select Order from the menu. The Order dialog box appears as shown in Figure 160 on page 193.
Figure 160. Order Selection
2. Select the Order Flag check box to enable the other fields in the dialog box.
3. Specify the field on which you want to order by selecting it from the list of values in the Order Field field.
4. Specify how the field is ordered by selecting either Ascending or Descending from the list of values in the Order Policy field.
5. Select a value in the Order Limit field. An order limit allows you to return either the First or Last row in the ordered series. Select None to return all rows.
6. Click OK.
Data Source OptionsSelect Options from the menu to apply smoothing to the data set returned from the database. Smoothing applies an average function against the data to create a smoother curve on an a chart for data that may be erratic. By default, user preferences determine smoothing, but the Options dialog box allows you to override this parameter on certain reports so that smoothing is either always applied or never applied.
To override smoothing behavior:
1. Select Options from the data source menu. The Options dialog box appears as shown in Figure 161 on page 193.
Figure 161. Data Source Options
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
194
12
2. Select a value from the list of values in the Smooth field. Values include:
• Yes - Smooths the data set for the report each time it is run• No - Never smithies the data in the report• User Selected - Determines smoothing behavior based on user preferences
3. Click OK.
Customizing OperatorsTo customize an operator, add the operator to the main panel of the Report Item Editor and right-click that operator. A menu appears and displays the options as shown in Figure 162 on page 194.
Figure 162. Operator Options
The valid options for the operator are highlighted. Invalid options for the operator are greyed out. All operator options are discussed in the following sections:
• "Operator Label" on page 194• "Operator Parameters" on page 195• "Operator Conditions" on page 195• "Operator Fields" on page 196
Operator LabelWhen you add an operator to a report item, the name in the box is displayed as the label of the operator. You can modify this label by right-clicking that operator and selecting Label from the menu. Specify the new label. Click OK.
Changing the label on an operator does not change the behavior of the operator, but it is a method for making complex report items more understandable.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide195
12
Operator ParametersThe parameters on an operator are specific to that operator. For example, the Multiply operator allows you to multiply a field by a value. Its parameters let you specify which field you want to multiply and the value by which you want to multiply the parameter.
To configure the parameters for an operator:
1. Right-click the operator and select Parameters from the menu. The Parameters dialog box for the Multiply operator is shown in Figure 163 on page 195.
Figure 163. Multiply Operator Parameters
2. Specify the fields described in Table 29 on page 195, and c
3. lick OK.
Note: Different operators have different parameters. This example shows the parameters for the Multiply operator. The parameters for each operator are described in the online help text for each operator.
Operator ConditionsIn the same way that you can apply conditions to data sources, you can also apply conditions can to operators so that the results of an operator only include those that match the conditions specified.
To apply conditions to an operator, right-click an operator and select Conditions. The Operators Conditions dialog box behaves the same way as the Conditions dialog box displayed on data sources described in "Data Source Conditions" on page 187.
Table 29. Operator Parameters Fields
Parameter Description
Field Name Field name to multiply.
Field Label Name the field after the multiply operation.
Units Units to which the value are assigned after the multiply operation.
Value Value by which the field is multiplied.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
196
12
Operator FieldsYou can modify the fields that are returned by an operator by right-clicking the operator and selecting Fields. The Fields dialog box appears as shown in Figure 164 on page 196.
Figure 164. Operator Field Selection
1. To modify the name of a field, select that row. Select the Label column. Enter the new name for the field.
2. To drop a field from the results of an operator, select the check box in the Drop column for the field that you want to drop.
3. The Cast and Unit fields in the dialog box display the type of data and the units of data for each field. You cannot modify these values.
4. Click OK.
External Data SourcesEMC Backup Advisor provides several pre-defined data sources that you can use to extract information from its database. In addition to data sources that gather data from the EMC Backup Advisor database, there are also External data sources you can use to pull information into EMC Backup Advisor from other locations.
An example of such an external data source is the Read CSV File data source, which is located in the Plugins category in the Data Source Selection dialog box. This is a standard data source plug-in that is installed with EMC Backup Advisor. The Read CSV File data source reads information from a flat file so that you can include that information in your reports.
You can modify the behavior of a data source plug-in by changing its parameters. To modify the parameters of a plug-in data source:
1. Select the data source from the Data Source Selection dialog box and add it to the report item.
2. Right-click the data source and select Parameters. For example, if you select the Read CSV File data source, the Parameters dialog box appears as shown in Figure 165 on page 197.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide197
12
Figure 165. Read CSV File Parameters
3. The online help for the parameters for any individual plug-in data source are available by clicking Description when selecting a data source from the tree. The parameters for the Read CSV File data source are described in Table 30 on page 197.
4. In a simple example where a file that contains a list of Jobs that form an exception list that should not be included in a report, the fields in the file may be as follows:
Server,Group,Schedule,Client,Job
Example:amazon,Default,Fulls,congo,D:
In this case, configure the Read CSV File parameters dialog box as shown in Figure 166 on page 198.
Table 30. CSV File Parameters
Parameter Description
Cast String Specifies what cast the field is returned as for each field in the file.
Field String Specifies the field names of each field in the file.
Filename Name of the field to be read.
Key String Indicates whether or not each field is treated as a key value.
Separator The separator that differentiates fields in a file.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
198
12
Figure 166. Configured Parameter List
5. You can now implement this data source as a report item property or incorporate it with other data sources into more complex reports.
In the Report Item Properties dialog box shown in Figure 167 on page 198, use the Backup Job Details data source to extract information from the EMC Backup Advisor database about backup Jobs. Use the Drop operator to drop the Queue Start field from its results. At the same time, information about Jobs that you do not want to include is read from an exception list using the Read CSV File data source. Combine this information using the Missing operator, which returns only those results that are in the Backup Job Details input, but not the Read CSV File input.
Figure 167. Complex Report Item
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide199
12
The result is a report with information on backup Jobs with the exception of those that we have included in an exception list.
Customizing the Appearance of a ReportThe Report Editor allows you to alter the appearance of reports using the toolbar associated with the selected report type. For example, the toolbar for the detailed table report is shown in Figure 168 on page 199.
Figure 168. Detailed Table Report Toolbar
Each report type has certain parameters associated with that report type that you can customize. Hovering over the icon displays the name of the parameter. To customize a parameter, click the icon. A dialog box appears allowing you to specify the values for that parameter.
Common Report Appearance ParametersAlthough different report types have different parameters, all reports share the Title parameter, which provides the ability to create and modify the title of the report.
To modify the title of a report:
1. Click Title ( ). The Report Title Editor dialog box appears as shown Figure 169 on page 199.
Figure 169. Report Title Editor
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
200
12
2. Customize the report by specifying one or more of the Report Title Editor options described in Table 31 on page 200.
3. After modifying the parameters for the report title, click OK. If you have specified sample data for the report, the changes to the report title are shown in the Appearance region of the Report Properties dialog box.
Common Table-based Report Appearance ParametersThe detailed table and summary table reports have three common report parameters:
• "Table Style" on page 200• "Table Fields" on page 202• "Cell Styles" on page 203
Table StyleThe Table Style parameter allows you to modify the colors and fonts used in table reports.
Table 31. Report Title Editor Parameters
Field Description
Display Controls whether or not the title appears on the report. To remove a title from a report, deselect this check box. To add a title back to a report, ensure that this check box is selected.
Title Details the text that appears in the title.
Include Nodes If selected, the name of the node(s) for which the report was run is appended to the end of the title.
Include Time If check box is selected, the time that the report run is appended to the end of the title.
Time Format Specifies the time format to be displayed if you have included the Time option in the title.
User Style If selected, the Title uses the font and color options from the user preferences. If deselected, the Set Style buttons are enabled.
Set Style Modifies the color and font settings for the Title.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide201
12
To customize table styles:
1. Click Table Style ( ). The Table Style Editor dialog box appears as shown in Figure 170 on page 201.
Figure 170. Table Style Editor
2. To change the appearance of a table, modify one or more of the Table Style Editor fields described in Table 32 on page 201.
Table 32. Table Style Editor Fields
Field Value
Background Color Customizes the background color of the table. By default, this is set to User Selected, which means that the Background Table Color specified in user preferences is used. The Background color can be fixed to a specific color by modifying this value to one of the colors in the field.
Repeat Color 1 Sets the background color of rows in the table. Row colors alternate between the value of the Repeat Color 1 and Repeat Color 2 fields. By default, the color is set to User Selected, which means that the Repeat Color value specified in user preferences is used. You can change the color to a fixed, specific color by changing this value to one of the colors in the field.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
202
12
3. To save the Table Style settings, click OK. Your changes are shown in the Appearance region of the Report Properties dialog box.
Table FieldsUse the Table Fields parameter to specify which fields are displayed in the table and to configure the scaling of data within the table.
To modify the table field parameters:
1. Click Table Fields ( ). The Table Fields Editor dialog box appears as shown in Figure 171 on page 202.
Figure 171. Table Fields Editor
Repeat Color 2 Sets the background color of the alternate row to the value of the Repeat Color 1 field. Row colors alternate between the values of the Repeat Color 1 and Repeat Color 2 fields. By default, the color is set to User Selected, which means that the Repeat Color value specified in user preferences is used. You can change the color to a fixed, specific color by changing this value to one of the colors in the field.
Table Font Use the Table Font value to set the font that is used for text within the table. By default, this is set to User Selected, which means that the Table Font value specified in user preferences is used. To override the Table Font with a specific Font, deselect the check box. Click Font to launch the Font Selection dialog box to specify a Font.
Table 32. Table Style Editor Fields
Field Value
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide203
12
By default, all of the fields returned in the report are displayed in a report, but you can disable them by selecting the row for the field and then deselecting the check box in the Display column.Certain fields in a data source can contain association units. For example, the Backup Job Size field contains information on the size of a backup Job. The data is measured in Megabytes. By default, a table report automatically scales the data in the table. If the size of a backup Job is 2325 MB, it is displayed in the table as 2.3 GB.
2. In certain situations you may want to turn off this automatic data scaling and display the data to a specific scale. For example, to display the size of backup Jobs in MB, select the row for which you want to modify scaling and select from the Scale To column. Select a value from the list of values.
3. Click OK to save the Table Fields settings on the report. The report is updated to reflect your changes.
Cell StylesThe Cell Styles parameter allows you to configure rules that control the background and foreground cells colors in the table based on the contents of the data within the rows.
To configure cell styles:
1. Click Cell Style ( ). The Cell Styles Editor dialog box appears as shown in Figure 172 on page 203.
Figure 172. Styles Editor
2. Click Add to add a rule that controls the appearance of cells and rows within the table. The Rule Editor dialog box appears as shown in Figure 173 on page 204.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
204
12
Figure 173. Style Editor
3. Select the Condition check box. Click Edit. The Conditions dialog box appears as shown in Figure 174 on page 204.
Figure 174. Conditions
4. Click Add Condition to add a Condition. The Condition dialog box appears as shown in Figure 175 on page 205.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide205
12
Figure 175. Condition
5. Select a value from the list of values in the FieldName field.
6. Select an operator from the list of values in the Operator field.
7. Select either the Static Value radio button or the Dynamic radio button:
• Static - Fixed value• Dynamic - Value is one that is calculated at run time and can be either
Current Time, Start Time, End Time, or End of Time
8. Click OK. The condition is added to the Conditions dialog box as shown in Figure 176 on page 205.
Figure 176. Conditions
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
206
12
9. To create complex conditions, you can combine multiple conditions with AND and OR operators. To add an operator, click Add Operator and select the operator you want to use from the list of values. As you add conditions and operators, you can add complex conditions as shown in Figure 177 on page 206.
Figure 177. Updated Conditions
10. To complete the condition, click OK. The condition is added to the Style Editor dialog box as shown in Figure 178 on page 206.
Figure 178. Updated Style Editor
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide207
12
11. To specify the foreground and background colors, select either the Foreground or Background check boxes. Click Foreground or Background. The Color Properties dialog box appears that allows you to specify the color.
12. To modify the selection to a specific field, change the Select field to the name of the field to which you want the Style rule to apply. Click OK. The Styles Editor dialog box appears as shown in Figure 179 on page 207.
Note: You can apply the specified colors to the entire row that match the condition or to just specific fields in that row.
Figure 179. Updated Styles Editor
13. You can add multiple style rules so that rules are matched against the data in the table in the order that they are displayed in the list. The data in the table is displayed with the foreground and background colors defined in the first rule in the list to which the data in the row matches.
Detailed Table Report Menu ParameterThe Report Menu parameter allows you to configure a menu to appear when a user right-clicks a row in the table. You can configure the menu to run other reports, Dashboards, or external commands.
To configure a menu on a detailed table report:
1. Click Report Menu ( ). The Report Menu Selection dialog box appears as shown in Figure 180 on page 207.
Figure 180. Report Menu Selection
2. Select the name of the menu that you want to be displayed when the user right-clicks a row.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
208
12
3. Click Menu Editor to launch the Menu Editor List dialog box that displays all report menus.
4. Click New. Create a menu by following the instructions detailed in "Chapter 11: Configuring Menus" on page 159.
5. Click OK to save your selection. When a user selects a row in the table and right-clicks, the menu that you just added appears.
Summary Table Column Links ParameterSummary tables have an additional parameter that allows you to specify the name of a report that appears if a user clicks a column. That report is then launched automatically. To enable this function, you need to configure the report using the Column Links parameter. To specify Column Links:
1. Click Column Links ( ). The Report Links Editor dialog box appears as shown in Figure 181 on page 208.
Figure 181. Report Links Editor
2. Select a column in the report from the listed fields. Select the name of a report in the Report field by clicking the cell and selecting a report from the dialog box that is displayed.
3. To display the report in a new window when it is run, select the New Window check box. If deselected, the report replaces the previous report.
4. Click OK to save the Column Links settings.
Report Card Report TypeA report card is a report type shows the status of an object at different times. An example of a report card implementation is one that shows the number of backup Jobs that succeeded and failed for different clients on different days as shown in Figure 182 on page 209.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide209
12
Figure 182. Example Report Card
To generate a report card, you must specify the fields in Table 33 on page 209 for the report data set.
There are several Appearance parameters that you can specify when creating a report card, including Field Mapping, Status Style, and Report Link. Each parameter is described in the following sections:
• "Field Mapping" on page 209• "Status Styles" on page 210• "Report Link" on page 211
Field MappingFor each report card component, you must indicate which field in the report data set maps to which purpose within the report card. For example, you must specify that the Client field is used as the Node field and not the Size field.
Table 33. Report Card Field Definitions
Field Name Description
Node Field Field that contains the name of the object that you are monitoring. This is displayed on the left hand column of the report card.
Status Field Field that contains the status of the object being monitored.
Value Field Field that returns the values associated with the status. For example, this may be the number of times a backup Job has succeeded or failed.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
210
12
To specify a field mapping:
1. Click Field Mapping ( ). The Report Card Field Mapping dialog box appears as shown in Figure 183 on page 210.
Figure 183. Report Card Field Mapping
2. Specify the fields that match to the roles in the report card that are described in Table 33 on page 209.
Status StylesThe Status Styles parameter allows you to specify rules that change the color of items in the report card based on the value of the Status Field field. For example, if you want to show the number of Job failures in red and the number of successful Jobs in green, you can specify the status style rules of the report card.
To specify status style rules:
1. Click Status Styles ( ). The Style Editor dialog box appears as shown in Figure 184 on page 210.
Figure 184. Style Editor
2. This dialog box displays all of the style rules that exist in the report card. Initially, there may be none listed. To add a style rule, click Add. The Style Editor dialog box in Figure 185 on page 211 appears.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide211
12
Figure 185. Adding a Style Rule
3. In the Label field, enter the value of the Status Field field for which you want to specify a color.
4. Click Edit. Select a color from the Color Properties dialog box. Click OK. The Style Editor dialog box appears as shown in Figure 186 on page 211.
Figure 186. Updated Style Editor
5. You can add more styles for different status values to the list. After you have selected your settings, click OK. The selections are applied to the report card displayed in Appearance region of the Report Properties dialog box.
Report LinkYou can configure a report card so that when a user clicks a cell in the report card, a new report is run.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
212
12
To configure a report card to run a new report:
1. Click Report Link ( ). The Report Link Editor dialog box appears as shown in Figure 187 on page 212.
Figure 187. Report Link Editor
2. Select the new report to be displayed when a user clicks a cell in the list of reports.
3. If you want the report to be displayed in a new window, select the Select in New Window check box.
4. Select the Do no link check box if you do not wish to link reports. If deselected, the list of reports is available for selection.
5. Click OK to return to the Report Properties dialog box. When a report is run in the main UI, and a user click a cell in the report card, the new report appears.
Common Chart-based Report Appearance ParametersThere are several report appearance parameters that are common to certain chart-based reports, and some that have specific parameters associated with a single chart-based report. This section describes how to configure each of the common appearance parameters as well as specific chart report parameters.
Chart StyleThe Chart Style appearance parameter is common to all chart-based reports. It provides the ability to customize color attributes used in and around chart-based reports.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide213
12
To modify chart styles:
1. Click Chart Style ( ). The Chart Style Editor dialog box appears as shown in Figure 188 on page 213.
Figure 188. Chart Style Editor
2. Modify one or more the colors of the chart as shown in Table 34 on page 213.
3. In the fields, select a color to be displayed for a specific parameter by selecting a value from the list of values. By default, all parameters use the User Selected option, which means that the colors for the charts specified in user preferences are used. To override these preferences, set the colors in the report to specific values.
4. To modify the axis font, deselect the User Selected check box. Click Font to select a font.
5. After making your changes, click OK. The changes you made are reflected in the report display area.
Series StylesAll two dimensional charts give the user the ability to change the colors that represent a different data series within the chart. The following charts can be modified in this way:
Table 34. Chart Style Editor Parameters
Field Description
Foreground Color Foreground color of the chart.
Background Color Background color of the chart.
Grid Color Grid line color of the chart.
Plot Area Color Color of the plot area within the chart.
Axis Color Color of the axis within the chart.
Axis Font Font used on the axis titles.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
214
12
• Trend• Area• Bar• Candle• Bubble• Pie
To modify the colors used by a data series:
1. Click Series Styles ( ). The Style Editor dialog box appears as shown in Figure 189 on page 214.
Figure 189. Series Style Editor
2. The Series Style Editor dialog box displays all of the series styles that are defined for a report. There are no series styles by default. Click Add. The Style Editor dialog box appears as shown in Figure 190 on page 214.
Figure 190. Adding a Series Style
3. Enter the name of the series in the Label field. Click Edit.
4. Select a color from the Color Properties dialog box. Click OK. The series style is added to the list of series styles.
5. You can combine multiple styles for different series by repeating this action for different series. When you have finished adding style definitions, click OK. The Report Properties dialog box appears. The report in the report area is updated to reflect your changes.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide215
12
Legend OptionAll two-dimensional charts provide the ability to customize the behavior of the legend that is displayed with the chart. The following reports can be modified in this way:
• Trend• Area• Bar• Candle• Bubble• Pie
By default, charts display the legend if the user interface determines there is enough space to display it without significantly affecting the size of the report. You can modify this behavior to instruct EMC Backup Advisor to either always display a legend or to never display a legend.
To specify when the legend is displayed:
1. Click Legend Parameter ( ). The Legend Option dialog box appears as shown in Table 191 on page 215.
Figure 191. Legend Option
2. Specify when the legend is displayed by selecting a value described in Table 35 on page 215.
3. Click OK. That option is applied to the report in the Report Properties dialog box.
Report MenuThe Report Menu parameter allows you to configure a menu that appears when a user right-clicks a chart. This parameter is available for the following charts:
• Trend• Bar• Candle
Table 35. Show Legend Option
Option Description
Automatic User interface determines when the legend is displayed based on how many items are in the legend.
Always Always display the legend.
Never Never display the legend.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
216
12
To configure a menu:
1. Click Report Menu ( ). The Select Menu dialog box appears as shown in Figure 192 on page 216
Figure 192. Menu Selection
2. Select the menu from the list of values in the Menu field.
3. Click Menu Editor. Follow the same process described in "Configuring Menus" on page 159 to create a new menu.
4. To select your menu choice, click OK. When the user right-clicks the chart, the selected menu appears.
y-axis The y-axis appearance parameter allows you to configure the y-axis on a chart. This parameter is available on the following charts:
• Area• Stacked Area• Bar• Stacked Bar• Bubble
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide217
12
To configure the y-axis parameter on any of these chart types:
1. Click y-axis ( ). The Axis Parameter Editor dialog box appears as shown in Figure 193 on page 217.
Figure 193. y-Axis Editor
2. Specify the fields in the Axis Parameter Editor dialog box described in Table 36 on page 217.
Table 36. Y Axis Parameter Editor Fields
Field Description
Fields Select which series in the data set will be displayed on the chart. To remove a series from a chart deselect the Include check box next to the field name.
Axis Label Contains the label that is displayed next to the Axis.
Unit Calculated automatically based on the data series displayed on the chart. If data series with different units are being displayed on the same chart, select the units that you want to be displayed on the axis.
Scale To By default, this field is set to Automatic, which means that the chart will automatically scale the axis to suit the data. For example if plotting values between 2300MB and 2500MB, the chart may display this as between 2.3GB and 2.5GB. To change the scale of the axis, select from a value from the list of values.
Range Restrict the range of the axis on the chart so that only data points within a specific range are plotted. To restrict the range of values that are plotted, select this check box and enter a minimum and maximum value in the numeric boxes.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
218
12
Chart LabelsThe Chart Label parameter provides the ability to display a data value in a label above the bar or piece of pie as shown in Figure 194 on page 218. This parameter is available on the following charts:
• Bar• Stacked Bar• Pie
Figure 194. Chart Labels Enabled on a Bar Chart
To display chart labels:
1. Click Chart Labels ( ). The Chart Label Editor dialog box appears as shown in Figure 195 on page 218.
Figure 195. Chart Label Editor
2. Select the Enable chart labels check box. To disable chart labels, deselect the Enable chart labels check box.
3. In the Anchor field, select the location for the chart labels.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide219
12
4. In the Color field, select a color for the chart labels from the list of values. Select Edit to launch the Color Properties dialog box.
5. In the Font field, select the Default check box to use the values defined in the User Preferences dialog box. Deselect this check box and click Font to launch the Font Properties dialog box.
6. Click OK. The report is updated with your changes.
Trend Chart Specific Appearance ParametersThe following parameters are available for trend charts:
Data ViewsA data view on a chart is the object against which a data series is plotted. A data view is similar to an Axis. A chart may have two data views, in which case a second axis is plotted on the right side of the chart. An example of a report with two data views is shown in Figure 196 on page 220. In this report, two different data views plot two series with different units on the same chart: Filesystem Utilization (%) and Memory Used (MB).
Table 37. Trend Chart Parameters
Parameter Name Description
Title Customize report titles. For more details, see "Common Report Appearance Parameters" on page 199.
Chart Styles
Configure the colors and fonts used in and around the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Series Styles
Configure the colors and styles used by a data series in the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Legend Configure when legends will be displayed on a chart. This is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Report Menu
Configure a menu that appears when a user right-clicks a chart as discussed in "Common Chart-based Report Appearance Parameters" on page 212
Data Views
Configure different views on a trend chart as described in "Data Views" on page 219.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
220
12
Figure 196. Report Example with Two Data Views
The data view appearance parameter controls the following:
• Number of data views to display on the chart• Data view against which a series is plotted• How the axis within that data view is displayed
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide221
12
To edit data views for a chart:
1. Click Data Views ( ). The Data View Editor dialog box appears as shown in Figure 197 on page 221.
Figure 197. Data Views Editor
2. Enter data in the fields that apply to your report as described in Table 38 on page 221
Table 38. Data View Editor Fields
Field Description
Num Data Views Select between either 1 or 2 data views. If you select 2 in this field, the View 2 region of the dialog box is enabled so that you can configure the second data view.
y-axis Label Label for the y-axis.
Use Range If selected, you can restrict the range of the axis that is displayed to only show data points between the two values selected in the Lower Limit and Upper Limit fields. If deselected, no range is used and all values are included in reports.
Lower Limit See the description for the Use Range field.
Upper Limit See the description for the Use Range field.
Use Logarithmic Scale
If selected, values are plotted against a logarithmic axis. This is useful when you have values spread over a very wide range.
Unit Use this field to specify the units that are used for the axis. This value is automatically calculated.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
222
12
Area Chart and Stacked Area Chart Appearance ParametersThe parameters in Table 39 on page 222 are available on Area Charts and Stacked Area Charts.
Scale If the plotted data units are numeric units, then this field allows you to force the chart to display the data to the scale you specify. By default, the data view scales data automatically.
For example if plotting values between 1300MB and 1500MB, EMC Backup Advisor automatically adjusts the value to display between 1.3GB and 1.5GB. If you want to override this automatic scaling, modify this field to set the scale to a specific value.
Fields Specify which data series is plotted on this data view. If you have multiple data views, you can move the series to the second data view by selecting the series from the Fields field and clicking the > button. Disable series on a data view by deselecting the Include check box.
Table 39. Appearance Parameters
Parameter Name Description
Title Customize report titles. For more details, see "Common Report Appearance Parameters" on page 199.
Chart Styles
Configure the colors and fonts used in and around the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Series Styles
Configure the colors and styles used by data series in the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Legend Configure when legends will be displayed on a chart. This is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
y-axis Configure the y-axis. This is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Table 38. Data View Editor Fields
Field Description
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide223
12
Bar Charts and Stacked Bar Charts Appearance ParametersTable 40 on page 223 shows the parameters available for Bar Charts.
3D Bar OptionsYou can modify the elevation, rotation, and bar depth for bar charts and stacked bar charts.
Table 40. Bar Charts and Stacked Bar Charts Appearance Parameters
Parameter Name Description
Title Customize report titles. For more details, see "Common Report Appearance Parameters" on page 199.
Chart Styles
Configure the colors and fonts used in and around the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Series Styles
Configure the colors and styles used by data series in the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Legend Configure when legends are displayed on a chart. This is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
y-axis Configure the y-axis. This is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Report Menu
Configure a menu that appears when a user right-clicks a chart as discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Chart Label
Configure labels that are displayed in front of bars as discussed in "Common Chart-based Report Appearance Parameters" on page 212.
3D Bar Options
Change the elevation, rotation, and depth of the bars in the chart. This option is specific to bar charts. For more details, see "3D Bar Options" on page 223.
x-axis This parameter is only available for stacked bar charts and controls whether the x-axis is displayed over time or at a specific point in time. This details of this option are discussed in "x-axis" on page 224.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
224
12
To change any of these parameters:
1. Click 3D Bar Options ( ). The Bar Chart 3D Option Editor dialog box appears as shown in Figure 198 on page 224.
Figure 198. 3D Bar Option
2. Change any of the parameters by moving the relevant slidebar. Observe the changes to the appearance of the report in the Report Properties dialog box.
3. Click OK to save the parameters.
x-axis The x-axis Parameter is only available when configuring stacked bar charts. Use the x-axis parameter to control whether the x-axis displays the values in the data set over time or displays the value at a point-in-time. An example of a stacked bar chart over time is shown in Figure 199 on page 225.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide225
12
Figure 199. Stacked Bar Chart x-axis Over Time
An example of the same data shown at a point-in-time appears in Figure 200 on page 225.
Figure 200. Stacked Bar Chart at Point In Time
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
226
12
To configure the x-axis settings of a bar chart:
1. Click x-axis ( ). The x-axis Editor dialog box appears as shown in Figure 201 on page 226.
Figure 201. x-axis Editor
2. Select either the Time or Value radio button:
• Time - Displays the x-axis over time• Value - Displays the x-axis at a point-in-time. If selected, you can also choose how you
want to group the bars in the chart by selecting the fields returned in the data set
3. Select OK to save your settings to the database.
Bubble Chart Appearance ParametersBubble charts can be useful for plotting complex distributions. A bubble chart can display two values for a data point. The first value is plotted by its location against the y-axis. The second value is displayed by a bubble that is proportionate in size to the value of a field. The bubble chart assesses the data in a data set and uses the first numeric field as the value that to plot against the y-axis. The Bubble Chart Field Selection parameter denotes how big the bubble is. See "Bubble Chart Field Selection" for more information.
All of the appearance parameters available for configuring a bubble chart are described in "Bubble Chart Appearance Parameters" on page 226.
Table 41. Bubble Chart Appearance Parameters
Parameter Name Description
Title Customize report titles. For more details, see "Common Report Appearance Parameters" on page 199.
Chart Styles Configure the colors and fonts used in and around the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide227
12
y-axis ParameterTo modify the label of the y-axis of a bubble chart:
1. Click y-axis ( ). The Axis Editor dialog box appears as shown in Figure 202 on page 227.
Figure 202. Bubble Chart y-axis Parameter
2. Enter a value in the Axis Label field.
3. Click OK. The y-axis is updated to specify the new label.
Bubble Chart Field SelectionThe Field Editor dialog box for the bubble chart specifies the field in the data set that represents the size of the bubble.
Series Styles Configure the colors and styles used by data series in the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Legend Configure when legends are displayed on a chart. This is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
y-axis Configure the label of the y-axis as discussed in "y-axis Parameter".
Bubble Chart Field Selection
Must be specified by the user to select which field value that represents the size of a bubble. For more details, see "Bubble Chart Field Selection".
Table 41. Bubble Chart Appearance Parameters
Parameter Name Description
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
228
12
To specify the field:
1. Click Bubble Chart Field Selection ( ). The Field Editor dialog box appears as shown in Figure 203 on page 228.
Figure 203. Bubble Chart Field Selection
2. In the Field field, select a value from the list of values.
3. Click OK to save the setting The bubble chart is displayed.
Candle Chart Appearance ParametersThe appearance parameters available for configuring a candle chart are described in Table 42 on page 228.
Candle Field MappingWhen creating a candle chart, you must specify which fields in the data set contain the start time, and end times for each candle.
Table 42. Candle Chart Appearance Parameters
Parameter Name Description
Title Customize report titles. For more details, see "Common Report Appearance Parameters" on page 199.
Chart Styles Configure the colors and fonts used in and around the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Report Menu Configure a menu that appears when a user right-clicks a chart as discussed in "Common Chart-based Report Appearance Parameters" on page 212.
Candle Styles Configure the color and appearance of candles in the candle chart in a similar way to how row styles are configured in tables. For more details, see "Cell Styles" on page 203.
Candle Field Mapping
Specify which fields in the data set denote the start time, mid time, and end time of each bar. See "Candle Field Mapping" for more details.
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide229
12
To specify this information:
1. Click Candle Field Mapping ( ). The Candle Chart Fields Editor appears as shown in Figure 204 on page 229
Figure 204. Candle Field Mapping
2. In the Start Time Field field, specify the field in the report data set that contains the start time. In the End Time Field field, specify the field in the report data set that contains the end time for each of the candles. Optionally, enter data in the Mid Time Field field. If data is entered in this field, the mid-time value is marked in the candle.
3. Select the Merge continuous values check box to apply candle styles to the chart and merge together values within a candle.
4. Click OK to save the settings. The Report Properties dialog box appears.
Pie Chart Appearance ParametersThe appearance parameters available for configuring pie charts are described in Table 43 on page 229.
Table 43. Pie Chart Appearance Parameters
Parameter Name Description
Title Customize report titles. For more details, see "Common Report Appearance Parameters" on page 199.
Chart Styles
Configure the colors and fonts used in and around the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212
Series Styles
Configure the colors and styles used by data series in the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
230
12
Pie Chart FieldsWhen creating a pie chart, you must specify which fields that you want to include in the pie chart by configuring the Fields parameter of the pie chart.
Within a report data set, there may be many rows of data, each corresponding to a different object. In addition, there may be multiple fields returned for each data object that contains data that can be plotted in a pie chart.
When drawing a pie chart, you can specify whether a pie chart is drawn for each object in the data set or for each field in the data set. If drawing a pie chart for each object, then each pie chart contains a slice for each field returned by that object. If drawing a pie chart for each field, then each pie chart contains a slice that represents each object for which you are gathering data.
To configure the field selection:
1. Click Fields ( ). The Pie Chart Fields Editor dialog box appears as shown in Figure 205 on page 230.
Figure 205. Pie Chart Field Selection
2. To draw a pie chart for each object, select Key in the Plot Pie Per radio button.
Legend Configure when legends will be displayed on a chart. This is discussed in "Common Chart-based Report Appearance Parameters" on page 212
Chart Label
Configure labels that are displayed in front of bars as discussed in "Common Chart-based Report Appearance Parameters" on page 212
Fields Specify which fields that you want to plot in the pie chart. This option is specific to pie charts and is discussed in "Pie Chart Fields".
3D Pie Options
Change the elevation and depth of the pie chart. This option is specific to pie charts and is discussed in "Pie 3D Options".
Table 43. Pie Chart Appearance Parameters
Parameter Name Description
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide231
12
3. To draw a pie chart for each field, select Field in the Plot Per Pie radio button.
4. Select the check box in the Plot column to display individual fields in the report.
5. Click OK.
Pie 3D OptionsThe Pie 3D Options allow you to configure the elevation and depth of the pie chart.
To configure these options:
1. Click 3D Pie Option ( ). The Pie Chart 3D Option Editor dialog box appears as shown in Figure 206 on page 231.
Figure 206. Pie Chart 3D Option Editor
2. Click OK to return to the Report Properties dialog box.
3D Surface Chart and 3D Bar Chart Appearance Parameters3D surface and bar charts allow you to plot a data series in three dimensions. In doing this, the chart uses the time series of the data on the x-axis and y-axis. In order to get an accurate chart, it is important to set the interval of the data you are plotting to one hour intervals. Table 44 on page 231 describes the 3D chart appearance parameters.
Table 44. 3D Surface Chart and 3D Bar Chart Parameters
Parameter Name Description
Title Customize report titles. For more details, see "Common Report Appearance Parameters" on page 199.
Chart Styles
Configure the colors and fonts used in and around the chart. This parameter is discussed in "Common Chart-based Report Appearance Parameters" on page 212
z-axis Parameter
Specify which field is plotted on the z-axis. This option is specific to 3D charts and is discussed in "z-axis".
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
232
12
z-axisAll surface charts plot the time values of the data against the x-axis and y-axis of the chart. The field that is plotted on the z-axis (Vertical) must be selected by specifying the z-axis parameter within a surface chart.
To specify the z-axis parameter:
1. Click z-axis parameter ( ). The Z Axis Editor dialog box appears as shown in Figure 207 on page 232.
Figure 207. z-axis Editor
2. Specify the field that you want to plot on the z-axis by selecting a value from the list of values in the Field field.
3. The Unit field displays the in base units that data in that field is stored.
4. Select a value from the list of values in the Scale To field to modify how the data is scaled on the z-axis.
5. Click OK.
3D Rendering Options
Change various aspects of the coloring and contouring used in the 3D surface and 3D bar charts. This option is specific to 3D charts and is discussed in "3D Rendering Options".
Rotation Specify the rotation angles for the chart. This option is specific to the 3D charts and is discussed in "Rotation".
Parameter Name Description
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide233
12
3D Rendering OptionsTo modify the 3D Rendering options of a 3D surface chart or 3D bar chart:
1. Click 3D Rendering Options ( ). The 3D Render Option Editor dialog box appears as shown in Figure 208 on page 233.
Figure 208. 3D Rendering Options Editor
2. Specify the 3D rendering options described in Table 45 on page 233.
Table 45. 3D Rendering Options Editor Fields
Field Description
Meshed If selected, grid lines are drawn between all cells in the chart. If deselected, grid lines are only be shown if the values have changed.
Shaded If the chart is configured to be meshed and the Shaded check box is selected, each cell is shaded with the color that represents the value at that point. If deselected, only the outline of the cell is colored.
Contoured If selected, contour lines are displayed on the chart to display trends in data values changes. If deselected, contour lines are not displayed.
Contour Levels If the Contoured check box is selected, the Contour Levels slidebar controls how many contours are plotted in the chart.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
234
12
RotationThe Rotation parameter allows you to modify the rotation parameters of a 3D Surface or 3D Bar chart. To modify the rotation properties:
1. Click Rotation ( ). The Rotation Parameter Editor dialog box appears as shown in Figure 209 on page 234.
Figure 209. Rotation Editor
2. Modify the rotation properties of a 3D surface or 3D bar chart by modifying the values of the Rotate X, Rotate Y, and Rotate Z fields.
3. To restore the chart to its initial defaults, click Restore Default.
4. To apply the rotation parameters to the chart, click OK.
Projection Controls the projection of the chart. The slide bar can adjust the chart to display a range of projections from a perspective to orthogonal view.
Zoned If selected, each cell is colored with a value that corresponds to the value of the data point at that location. The colors that are used are controlled by using the Zone Colors field.
Zone Colors Configure the range of colors that are used when zoning is enabled. To modify the color chart, click a point in the color chart and select a new color from the Color Properties dialog box that appears.
The display is updated to show the new gradient. You can add zone points to the gradient by right-clicking the color chart and selecting Add. A new point is added to the color chart for the color selected.
Table 45. 3D Rendering Options Editor Fields
Field Description
Chapter 12: Configuring Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide235
12
Editing a ReportTo edit a report, select Tools > Report Editor from the menu bar. The Report List dialog box appears. Select the report that you want to edit. Click Edit. This launches the Report Properties dialog box. for the selected report.
Note: The Edit button is available only for reports that are not installed with EMC Backup Advisor. The View button appears for those reports. If you want to edit one of the EMC Backup Advisor reports, make a copy of that report first, and then edit the copy.
Deleting a ReportTo delete a report, select Tools > Report Editor from the menu bar. Select the report that you want to delete. Click Delete. You are prompted to confirm the deletion. Click Yes to confirm the deletion. Click No to cancel the deletion.
Exporting a ReportYou can export a report definition to an XML file so that you can import that report to another instance of an EMC Backup Advisor server. To export a report, select the report you want to export. Click Edit. Click Export and specify the location where you want to save the report definition.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 12: Configuring Reports
236
12
EMC Backup Advisor 2.0.1 Administrator’s Guide237
Chapter 13: Configuring Control Panels
A Control Panel is a collection of reports grouped together into a single screen to provide users with multiple views of the performance of their application with a single mouse click. You can view Control Panels by attaching them to menus and running them from the Navigation tree. You can also configure EMC Backup Advisor so that a Control Panel appears automatically when users log in to EMC Backup Advisor.
This chapter describes how to create and configure Control Panels. This chapter contains the following sections:
• "Creating a Control Panel" on page 237• "Running a Control Panel from Navigation tree" on page 248• "Setting an Initial Control Panel" on page 248• "Editing a Control Panel" on page 249• "Copying a Control Panel" on page 250• "Deleting a Control Panel" on page 250
Creating a Control PanelTo create a Control Panel:
1. Log in as a user with administrative privileges.
2. Select Tools > Control Panel Editor from the menu bar. The Control Panel List dialog box appears and shows all Control Panels as shown in Figure 210 on page 238.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 13: Configuring Control Panels
238
13
Figure 210. Control Panel List
3. Select New. The Control Panel Properties dialog box appears as shown in Figure 211 on page 238.
Figure 211. Control Panel Editor
4. The Control Panel Properties dialog box consists of a Configuration region and a Control Window region that displays what the Control Panel looks like when it is run. When creating a new Control Panel, enter a unique name for the Control Panel in the Name field.
5. In the Spacing field, specify the minimum number of pixels by which Control Panel components must be separated.
6. By default, when a user clicks a report on a Control Panel, the report is launched in a separate frame outside of the Control Panel. This is referred to as a drill down. To change this behavior so that reports are not launched when a user clicks them, deselect the Allow Drill Down check box.
Chapter 13: Configuring Control Panels
EMC Backup Advisor 2.0.1 Administrator’s Guide239
13
Changing the Background of a Control PanelTo modify the appearance of a Control Panel:
1. Click Background ( ). The Control Panel background dialog box appears as shown in Figure 212 on page 239.
Figure 212. Control Panel Background
2. Select a different color for the background of the Control Panel by clicking the Color field. The Color Properties dialog box appears.
3. Select the background color.
4. To use an image in the background, select the Use Image check box and click the Image field to select an image from the Image Chooser dialog box displayed in Figure 213 on page 240.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 13: Configuring Control Panels
240
13
Figure 213. Image Selection
5. Select one of the images in the dialog box or enter the URL to an image you want to include. Click OK. An example URL for a file on your local filesystem is: ’file:///C:/myimage.gif’
6. Select whether the image you have chosen for your background is tiled across the background, centred, or stretched to fit the size of the window by selecting one of the values from the list of values in the Layout field.
7. Click OK to apply the Control Panel background settings as shown in Figure 214 on page 241.
Chapter 13: Configuring Control Panels
EMC Backup Advisor 2.0.1 Administrator’s Guide241
13
Figure 214. Updated Control Panel with Background
Adding a Label to a Control PanelTo add a label to a Control Panel:
1. Click Add Label ( ).
2. In the Control Panel Properties dialog box, click a location on the Control Panel to add the label. A text label is added to the Control Panel containing the name of the Control Panel. The Label Properties dialog box appears to allow you to modify the content and appearance of the label as shown in Figure 215 on page 241.
Figure 215. Label Properties
3. In the Control Panel Properties field, type a label for the Control Panel.
Note: You can add multiple labels to the Control Panel in different locations.
4. Optionally, select a variable name from the list of values in the Variables field.
Note: You can modify the label to include a variable name for the nodes or time period for which the Control Panel is being run.
5. Click Color to change the color of the label. Click Font to change the font of the label.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 13: Configuring Control Panels
242
13
6. Click OK. The label is added to the Control Panel as shown in Figure 216 on page 242.
Figure 216. Updated Control Panel
Adding an Image to a Control PanelTo add images to the Control Panel:
1. Click Add Image ( ). The Properties dialog box appears.
2. In the URL field, type the following to display an image that is stored on a local disk:
•file:\c:\<directory name>\<filename.extension>An example of a Control Panel that displays an image stored on a local disk is shown in Figure 217 on page 243.
Chapter 13: Configuring Control Panels
EMC Backup Advisor 2.0.1 Administrator’s Guide243
13
Figure 217. Properties
3. Select the image that you want to add. Click OK. The image is added to the Control Panel as seen in Figure 218 on page 243.
Figure 218. Updated Control Panel
You can move images and titles around on a Control Panel by selecting the component and dragging it with the mouse to a different location within the Control Panel.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 13: Configuring Control Panels
244
13
Adding a Report to a Control PanelTo add a report to a Control Panel:
1. Select the report you want to add from the Report field and drag it to the main window.
2. To find the report, partially type in the name of the report in the Search field or select a report category to narrow down your search.
Note: When the report is added to the Control Panel window, you can resize or move it using the mouse to drag it into the final size and shape as shown in Figure 219 on page 244.
Figure 219. Adding a Report to a Control Panel
3. You can configure properties on the report frame within the Control Panel by clicking Properties ( ) on the Control Panel toolbar or right-clicking the report window in the Control Panel and selecting Properties from the menu. The Report Properties dialog box appears as shown in Figure 220 on page 245.
Chapter 13: Configuring Control Panels
EMC Backup Advisor 2.0.1 Administrator’s Guide245
13
Figure 220. Report Properties
4. Specify the Report Properties fields as described in Table 46 on page 245.
Table 46. Report Properties Fields
Field Description
x Controls the location of the report within the Control Panel on the x-axis. Manually set the location if you are not using the mouse.
y Controls the location of the report within the Control Panel on the y-axis. Manually set the location if you are not using the mouse.
Border Type Select an optional border for a report. Values include:• Line• Titled• Raised Etched• Lowered Etched• Raised Bevel• Lowered Bevel
Border Title If you are using a Titled Border, modify the text displayed in the title.
Window If selected, the report is always run against the window specified rather than any user selected value.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 13: Configuring Control Panels
246
13
5. A second set of parameters enable you to configure the contents of the report within the report frame. To modify the report parameters, click Report Parameters ( ). The Report Parameters toolbar appears as shown in Figure 221 on page 246.
Figure 221. Report Parameter Toolbar
The Report Parameters toolbar is identical to the toolbar that appears in the Report Editor when editing a report. Use this toolbar to customize the appearance of the report within the Control Panel. Any changes you make using the toolbar within the Control Panel Properties dialog box only apply to that report when run within that Control Panel.
6. To test a report, click Test Report ( ). The Sample Data dialog box appears. Select some parameters to run the report while viewing it in the Control Panel Editor. This allows you to get a better feel for how the Control Panel will look when run within EMC Backup Advisor.
7. In the Control Panel Properties dialog box, enter the report period, view, and node against which you want to run the report. Click OK. The report is run and you can view the output within the Control Panel Properties dialog box as shown in Figure 222 on page 247.
View Name If selected, the report is always run against the view specified rather than the view displayed by the user when running the Control Panel.
Node Name If selected, the report is always run against the nodes specified rather than the nodes currently selected in the Navigation tree.
Report Required If selected, then the Control Panel is only displayed on the Navigator menu if the node against which the Control Panel is being run is gathering the data required to run the report.
Table 46. Report Properties Fields
Field Description
Chapter 13: Configuring Control Panels
EMC Backup Advisor 2.0.1 Administrator’s Guide247
13
Figure 222. Testing a Report on Control Panel
The other parameters on the report parameter toolbar allow you to modify other aspects of the appearance of the report. For more details on each of the parameters, see "Chapter 12: Configuring Reports" on page 169.
By adding more reports to a Control Panel you can create more complex Control Panels within the Control Panel Properties dialog box as shown in Figure 223 on page 247.
Figure 223. Completed Control Panel
To remove a report, title, or image from a Control Panel, select the item you want to remove. Click Delete ( ). The item is removed from the Control Panel.
To view page boundaries, select a value from the Show Page Boundary field. Values include the following:
• None
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 13: Configuring Control Panels
248
13
• A4 Landscape• A4 Portrait• US Letter Landscape• US Letter Portrait
Page boundaries are displayed in a red box on the Control Panel.
Running a Control Panel from Navigation treeTo run a Control Panel from the Navigation tree, the menu that is used by the user must be updated so that the Control Panel you have created is available for the user to select. For more details on how to do this, see "Chapter 11: Configuring Menus" on page 159. When run from the Navigator menu, the Control Panel appears as shown in Figure 224 on page 248.
Figure 224. Control Panel Report
Setting an Initial Control PanelEMC Backup Advisor can be configured so that when a user first logs in to EMC Backup Advisor, an initial Control Panel is launched.
To configure a Control Panel to be displayed when a user logs in to EMC Backup Advisor:
1. Launch the User List dialog box by selecting Tools > User Editor from the menu bar.
2. Select the user you want to edit. Click Edit.
3. Select the Preferences tab in the User Properties dialog box. Select a Control Panel from the list of values in the Control Panel field as shown in Figure 225 on page 249.
Chapter 13: Configuring Control Panels
EMC Backup Advisor 2.0.1 Administrator’s Guide249
13
Figure 225. User Properties
4. Restart the GUI and log in as the user you have modified.
Editing a Control PanelTo edit a Control Panel:
1. Select Tools > Control Panel Editor from the menu bar. The Control Panel List dialog box appears.
2. Select the name of the Control Panel you want to edit, and click Edit. The Control Panel Properties dialog box appears and displays the selected Control Panel.
Note: When first installed, several Control Panels are automatically installed. You cannot modify these Control Panels directly. When you select these Control Panels, the Edit button is replaced with the View button. To modify a system Control Panel, copy the Control Panel and edit the copy.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 13: Configuring Control Panels
250
13
3. Make desired changes. Click OK.
Copying a Control PanelTo copy a Control Panel:
1. Select Tools > Control Panel Editor from the menu bar. The Control Panel List dialog box appears.
2. Select the name of the Control Panel that you want to copy.
3. Click Copy. The Control Panel Properties dialog box appears and displays a copy of the Control Panel that you copied.
4. Make desired changes. Click OK.
Deleting a Control PanelTo delete a Control Panel:
1. Select Tools > Control Panel Editor from the menu bar.
2. Select the name of the Control Panel that you want to delete.
3. Click Delete. You are prompted to confirm the Control Panel deletion.
4. Click OK to confirm. Click Cancel to cancel the deletion.
EMC Backup Advisor 2.0.1 Administrator’s Guide251
Chapter 14: Scheduling Reports
A scheduled report is a report that the Publisher process runs at a scheduled time and sends the results to either a file or an email address. This chapter describes how to create and schedule reports. This chapter contains the following sections:
• "Creating a Scheduled Report" on page 251• "Editing a Scheduled Report" on page 254• "Deleting a Scheduled Report" on page 255• "Testing a Scheduled Report" on page 255
Creating a Scheduled ReportTo create a scheduled report:
1. Log in as a user with administrative privileges.
2. Select Tools > Scheduled Report Editor from the menu bar. The Scheduled Report List dialog box appears.
3. Click New. The Scheduled Report Properties dialog box appears as shown in Figure 226 on page 252.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 14: Scheduling Reports
252
14
Figure 226. Creating a Scheduled Report
4. Enter data in the fields of the Basic Properties region for a scheduled report as described in Table 47 on page 252.
5. Specify the details of the report or Dashboard you want to run by entering values in the fields of the Content region as described in Table 48 on page 252.
Table 47. Basic Properties
Field Description
Name Name of the scheduled report.
Description Optional description for the scheduled report.
Schedule Frequency with which the report is executed.
User User for which the report is run. The Publisher process inherits all of the preferences of the user. If no value is selected, the administrator preferences are used.
Table 48. Content Properties
Field Description
View View containing the node against which you want to run the report.
Node Node in the view against which you want to run the report.
Type Indicates if you want to run a Report or a Dashboard. Select
Chapter 14: Scheduling Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide253
14
6. Specify the actions that you want to take when the published report is run by entering values for the fields in the Action region as described in Table 49 on page 253.
Report If running a report, specify the report name in the report field. Use the Category field to help refine your search.
Dashboard If running a Dashboard, specify the name of the Dashboard in the Dashboard field.
Window Time period over which you want to run the report.
Table 49. Action Properties
Field Description
Publish Via Method by which you want the report/Dashboard to be published. Select either the File or Email radio button.
File Name If saving the report to disk, enter the name of the file to which you want to save the report. The file is saved in the directory specified in the Document Root parameter for the Publisher process. For more details on how to change the Document Root for the Publisher process, see "The Publisher Process" on page 270.
The Publisher process allows date and/or time substitution using @ tags. The meaning of the tags are as defined in the Java API documentation. See http://java.sun.com/j2se/1.4.2/docs/api/java/text/SimpleDateFormat.html
For example:• report1 @ddMMMyyyy@ > report1 20Sep2004• report2 @EEE@ @MMM@ @yyyy@ > report2 Mon Sep
2004• report@yyyyMMddHHmm@ > report200409201556• report @HH@:@mm@ > report 10:34•
It is also possible to specify a relative path. For example, if you enter bdb/bdb_@, the file is located and named as follows:
$docroot/bdb/bdb_<date>.jpg
Note: The subdirectory must be created before you can specify it in the relative path.
File Type If saving the report to disk, specify the format in which you would like the file to be saved. Values include HTML, JPEG, CSV or XML.
Table 48. Content Properties
Field Description
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 14: Scheduling Reports
254
14 7. Click OK. The scheduled report is created.
Editing a Scheduled ReportTo edit a scheduled report:
1. Select Tools > Scheduled Report Editor from the menu bar. The Scheduled Report List dialog box appears.
2. Select the scheduled report you want to edit. Click Edit. The Scheduled Report Editor dialog box appears.
3. Edit the scheduled report.
4. Click OK. Click Cancel to discard your changes.
Notify By Mail If selected and you are saving a report to disk, the Publisher process emails a link to the newly created report to the address entered in the To field.
To Email address of the user to whom you want to send the report if sending a report via email.
Subject Subject that you want to be contained in the email that is sent if sending a report via email.
Template Style template used to create reports.
When the Publisher process creates reports, it uses style templates located in the styles directory on the EMC Backup Advisor server. You can modify these template files to change the appearance of reports that are published by the Publisher process. By default, the Publisher process uses the following template files:• reportcard.vtl - Generating report card reports• image.vtl - Rendering chart reports• table.vtl - Rendering table reports
If you want to customize templates for different reports, then copy the template files and rename and edit them within the styles directory. Rename the templates in accordance with the current naming standards. If creating a template for table reports for the company Acme, rename the table template to table.acme.vtl. Enter the name of the template in the customized HTML output template field. In this example the name of the value is Acme.
Always If selected, forces the Publisher process to run the report even though the data set is empty. If a report runs and no data is found, the Publisher process does not perform the actions associated with the scheduled report by default.
Table 49. Action Properties
Field Description
Chapter 14: Scheduling Reports
EMC Backup Advisor 2.0.1 Administrator’s Guide255
14
Deleting a Scheduled ReportTo delete a scheduled report:
1. Select Tools > Scheduled Report Editor from the menu bar. The Scheduled Report List dialog box appears.
2. Select the scheduled report you want to delete. Click Delete. The Delete Confirmation dialog box prompts you to confirm the deletion. Click Yes to confirm. Click No to cancel the deletion.
Testing a Scheduled ReportWhen a scheduled report is created, you can test it by clicking Test on the Scheduled Report List dialog box. This sends a message to the running Publisher process and requests it to run the report immediately.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 14: Scheduling Reports
256
14
EMC Backup Advisor 2.0.1 Administrator’s Guide257
Chapter 15: Database Maintenance
For EMC Backup Advisor to run efficiently within your environment and in the event of data loss, it is recommended that you run several database maintenance routines to perform backups and tune the database on a regular basis. For environments with an iAnywhere database, including NetWorker environments, that are using NetWorker Management Console as the repository, EMC Backup Advisor provides a script to help perform these database maintenance routines..
In addition to performing backups and performance tuning, it is also recommended that you implement a data retention strategy in EMC Backup Advisor that purges data that you no longer need from the database on a regular basis. EMC Backup Advisor provides the ability to create and manage Datamine Maintenance Plans that control the length of time data is stored for in the database. You can configure Datamine Maintenance Plans to retain certain data types for specified periods of time. You can retain the data for some hosts longer than others by assigning specific plans to specific nodes within the Navigation tree.
By default, EMC Backup Advisor does not implement Datamine Maintenance Plans. For that reason, data is never removed from the database.This chapter contains the following section:
• "Implementing a Datamine Maintenance Plan" on page 258
Backing up the DatabaseTo perform a backup of the EMC Backup Advisor database in NetWorker environments or if using an iAnywhere database:
1. Ensure that EMC Backup Advisor is running.
2. On UNIX systems, source the profile file /opt/eba/etc/eba.config.
3. Run the eba_dbmaint command as follows:
eba_dbmaint -m BACKUP -a <archive directory>
Restoring the DatabaseTo restore the EMC Backup Advisor database in NetWorker environments or if using an iAnywhere database:
1. Ensure that EMC Backup Advisor is NOT running.
2. On Unix systems, source the profile file /opt/eba/eba/eba.config.
3. Run the eba_dbmaint command as follows:
eba_dbmaint -M RESTORE -a <archive directory>
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 15: Database Maintenance
258
15Performance Tuning
It is recommended that at least once a week the EMC Backup Advisor database is reorganized. This ensures that the indexes are optimized and that performance degradation does not occur as the databases get larger.
To perform database tuning in NetWorker environments or if using an iAnywhere database:
1. Ensure that EMC Backup Advisor is running.
2. On Unix systems, source the profile file /opt/eba/etc/eba.config.
3. Run the eba_dbmaint command as follows:
eba_dbmaint -m REORG
Implementing a Datamine Maintenance PlanTo implement a Datamine Maintenance Plan:
1. Select the node in the Navigation tree to which you want to apply the Maintenance Plan.
Note: Maintenance Plans that are assigned to group nodes within the Navigator apply to all hosts within that group. To apply a Maintenance Plan to all hosts within a view, select the highest node in the Navigator hierarchy.
2. Right-click the node and select Configuration > Properties. The Node Properties dialog box appears.
3. Select the Datamine Maintenance Plans tab as shown in Figure 227 on page 259.
Chapter 15: Database Maintenance
EMC Backup Advisor 2.0.1 Administrator’s Guide259
15
Figure 227. Assigning Datamine Maintenance Plans
4. The Unassigned field displays a list of the Maintenance Plans in EMC Backup Advisor. The Assigned field shows which maintenance plans are currently assigned to this node. Click Plan Editor to create a new plan. The Datamine Maintenance Plan Editor dialog box appears and displays all maintenance plans.
5. Click New. The Datamine Maintenance Plan Properties dialog box appears as shown in Figure 228 on page 260.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 15: Database Maintenance
260
15
Figure 228. Datamine Maintenance Plan Properties
6. Enter a Datamine Maintenance Plan name in the Name field. Optionally, enter a description in the Description field.
7. To enter a plan item in the Plan Items field, click Add. The Plan Item Properties dialog box appears as shown in Figure 229 on page 260.
Figure 229. Plan Item Properties
Chapter 15: Database Maintenance
EMC Backup Advisor 2.0.1 Administrator’s Guide261
15
8. Select the type of data that you want to remove from the database by selecting a value in the Group field. The values for this selection box are described in Table 50 on page 261.
9. In the Type field, specify a subset of the data type that has been selected in the Group field. The selections available depend on the selected group, but typically includes the data types defined in Table 51 on page 261.
10. Specify the Minimum Age field to indicate how long data of the group and type specified is maintained.
11. Click OK to save the plan item information. The Datamine Maintenance Plan Properties dialog box appears as shown in Figure 230 on page 262.
Note: You can add additional plan items to a Maintenance Plan, if necessary.
Table 50. Group Values
Value Description
All Removes all data types from the database.
fcswitch Removes information on fibre channel switches.
webserver Removes information on web servers
netapp Removes information collected from Network Appliance devices
tapedrive Removes information gathered from tape drives
tapelibrary Removes information gathered from tape libraries.
system Remove system information such as CPU, file system, or network interface.
backup Removes information gathered from backup applications.
Table 51. Type Values
Value Description
All Removes all data types of data in the selected group.
Status Removes status information for the selected group.
Configuration Removes configuration information gathered by the selected group.
Performance Remove performance information gathered by the selected group.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 15: Database Maintenance
262
15
Figure 230. Updated Maintenance Plan
12. To modify a plan item, select the plan item from the Plan Items field. Click Edit.
13. To remove a Plan Item, select the plan item from the Plan Items field. Click Remove.
14. Click OK to return to the Datamine Maintenance Plan Editor dialog box as shown in Figure 231 on page 262.
Figure 231. Datamine Maintenance Plan Editor
15. Click OK. The Node Properties dialog box appears as shown in Figure 232 on page 263.
Chapter 15: Database Maintenance
EMC Backup Advisor 2.0.1 Administrator’s Guide263
15
Figure 232. Datamine Maintenance Plan Assignments
16. To assign the Datamine Maintenance Plan to the node, select the plan in the Unassigned field. Click Assign. The plan is moved to the Assigned field.
17. In the Schedule field, specify when you want the Maintenance Plan to be executed. This value specifies when the data is deleted. It is recommended that you specify a time of day when the database is not heavily used.
Note: You can create alternate schedules using the Schedule Editor discussed in "Chapter 8: Configuring Schedules" on page 115.
18. To unassign a Datamine Maintenance Plan, select the maintenance plan from the Assigned field. Click Unassign.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 15: Database Maintenance
264
15
EMC Backup Advisor 2.0.1 Administrator’s Guide265
Chapter 16: System Settings
This chapter describes how to change the configuration parameters for EMC Backup Advisor processes from within the Graphical User Interface. These processes include the following:
• "Database" on page 266• "Controller" on page 267• "Reporter" on page 268• "Listener" on page 268• "Collector" on page 269• "GUI" on page 269• "The Publisher Process" on page 270• "The Web Application Process" on page 270
To modify configuration parameters for one of the processes:
1. Log in to EMC Backup Advisor as a user with administrative privileges.
2. Select File > System Settings. The System Settings dialog box appears as shown in Figure 233 on page 265.
Figure 233. System Settings
3. Select the Processes tab if it is not already displayed. The left side of the dialog box lists each process.
4. Select the process that you want to modify. The parameters for that component are displayed in the right side of the dialog box.
5. Double-click the Value field to modify its contents.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 16: System Settings
266
16
The following sections describe the settings for each component:
• "Database" on page 266• "Controller" on page 267• "Reporter" on page 268• "Listener" on page 268• "Collector" on page 269• "GUI" on page 269• "The Publisher Process" on page 270• "The Web Application Process" on page 270
DatabaseAll of the processes that connect to the database use the database parameters. These parameters specify the name of the database and the user ID and password used to connect to the database. Table 52 on page 266 describes each database parameter.
Table 52. Database Parameters
Parameter Description
Config Database Type Database type. Values include:• Microsoft SQL Server• Oracle 9• Oracle 10
Config Database Server Host name on which the database server is running.
Config Database Name Name of the config database.
Config Database Port Port used by the database to listen for requests.
Config Database User User name used to connect to the configuration database.
Config Database Password Password used to connect to the configuration database.
Datamine Database Type Database type of the datamine. Values include:• Microsoft SQL Server• Oracle 9• Oracle 10
Datamine Database Server Host name on which the database server is running.
Datamine Database Name Name of the datamine database.
Datamine Database Port Port used by the database to listen for requests.
Datamine Database User User name used to connect to the datamine database.
Datamine Database Password
User password used to connect to the datamine database.
Chapter 16: System Settings
EMC Backup Advisor 2.0.1 Administrator’s Guide267
16
After changing any of the database parameters, restart all server processes, including the Controller, Listener, and Reporter. Reconnect to the database to apply the changes.
ControllerThe Controller parameters control the behavior of the Controller process. Table 53 on page 267 describes each Controller parameter.
Table 53. Controller Parameters
Parameter Description
Concurrency Maximum number of database connections used by the Controller to connect to the database. The default is five connections.
Listen Port Port on which the Controller listens for requests.
Log File File to which the Controller writes its log information.
Log Level Verbosity level when the Controller writes to its log file.
Mail From Email address from which emails sent from the GUI, the Publisher process, or the Analysis Engine appear to originate.
Mail Server Mail server to which any emails are forwarded when sent from the GUI, the Publisher process, or the Analysis Engine.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 16: System Settings
268
16Reporter
The Reporter parameters control the behavior of the Reporter process. Table 54 on page 268 describes the Reporter parameters
ListenerThe Listener parameters control the behavior of the Listener process. Table 55 on page 268 describes the Listener parameters.
Table 54. Reporter Parameters
Parameter Description
Concurrency Maximum number of database connections used by the Reporter when connecting to the database. The default is five connections.
Log File File to which the reporter writes its log information.
Log Level Verbosity level when the Reporter writes to its log file.
Reporter Host Name of the host on which the reporter is running. The GUI, Analysis Engine, and the Publisher process use this parameter to connect to the Reporter.
Reporter Port Port on which the reporter listens for requests.
Table 55. Listener Parameters
Parameter Description
Concurrency Maximum number of database connections used by the Listener when connecting to the database. The default is five connections.
Log File File to which the Listener writes its log.
Log Level Verbosity level when the Listener writes to its log file.
Listener Host Name of the host on which the Listener is running.
Listener Port Port on which the Listener listens for requests.
Chapter 16: System Settings
EMC Backup Advisor 2.0.1 Administrator’s Guide269
16Collector
The Collector parameters control the behavior of the Collector processes. Within the System Settings dialog box, expand the Navigation tree to show all hosts on which the Collectors are running so that you can modify the settings for an individual Collector.
GUIThe GUI parameters control the behavior of the currently running GUI. Table 57 on page 269. describes the parameters of the GUI
Table 56. Collector Parameters
Parameter Description
Collector Port Port on which the Collector listens for requests.
Concurrency Maximum number of threads the Collector uses to gather data. The default is five connections.
Log File Name of the file to which the Collector writes its log information.
Log Level Verbosity level when the Collector writes to its log file.
Maximum Queue Size Maximum number of files that are stored in EMC Backup Advisor if the Listener is offline.
Table 57. GUI Parameters
Parameter Description
Log File Name of the log file to which the user GUI writes it log information.
Log Level Verbosity level when the GUI writes to its log file.
Watermark File name of the image used as a background image on charts.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Chapter 16: System Settings
270
16The Publisher Process
The Publisher parameters control the behavior of the Publisher process. Table 58 on page 270 describes the Publisher parameters.
The Web Application ProcessThe Web Application parameters control the behavior of the Web Server and Lite UI that is installed. The parameters that you can modify are described in Table 59 on page 270.
Table 58. Publisher Parameters
Parameter Description
Base URL Initial part of this URL is the value used by the Publisher when sending emails that contains a URL from which to download the saved file.
Document Root Location to which reports are saved if the user saves a report to disk.
Log File Location to which the Publisher writes its log file.
Log Level Verbosity level when the Publisher writes to its log file.
Maximum Memory for JVM (MB)
Memory limit for Publisher, in MB.
Publisher Host Publisher host.
Publisher Port TCP/IP port on which the Publisher listens for connections. The GUI and Analysis engine connect to this port to communicate with the Publisher
Watermark Name of the image file that the Publisher uses as a background in chart reports.
Table 59. Web Application Parameters
Parameter Description
Log File Name of the log file to which the Web Application process writes its log information.
Log Level Verbosity level when the Web Application process writes to its log file.
Maximum Memory for JVM (MB)
Memory limit for the Web Application, in MB.
Watermark Name of the image file that the Web Application process uses as a background in chart reports.
EMC Backup Advisor 2.0.1 Administrator’s Guide 271
Appendix A: Analysis Save Set Definitions
This appendix contains information regarding all of the analysis Save Sets that are included in EMC Backup Advisor. This appendix contains the following sections:
• "Capacity Planning" on page 271• "Change Management" on page 272• "Configuration" on page 273• "Data Protection" on page 274• "Licensing" on page 276• "Provisioning" on page 277• "Resource Utilization" on page 277• "Service Level Agreements" on page 279• "Status" on page 279• "Troubleshooting" on page 281
Capacity PlanningCapacity planning analysis Save Sets create alerts about events that indicate if you may run out of resources in the near future. Table 60 on page 271 describes these Save Sets:
Table 60. Capacity Planning
Name Description Ruleset Parameters
Filesystem May Be Full In 2 Weeks
Generates alerts if a filesystem utilization will exceed 90% in the next 2 weeks.
Filesystem filling up
Max Predicted Utilization - 100%
Number of hours to forecast 336
Less Than 25 Available Backup Client Licenses
Generates alerts if your license only permits you to monitor less than an additional 25 machines.
Running out of backup client licenses
Maximum client licenses - 25
NetApp May Run Out of Spare Disks in 6 Weeks
Generates alerts if a NetApp may run out of spare disks in the next 6 weeks.
Running out of spare disks
Number of days to forecast - 42
Tape Pool May Be Out of Empty Tapes within 6 weeks
Generates alerts if there will be no empty tapes available in a tape pool within 6 weeks.
Running out of empty tapes
Maximum Predicted Count - 0
Number of hours to forecast - 1008
EMC Backup Advisor 2.0.1 Administrator’s Guide
Appendix A: Analysis Save Set Definitions
272
A
Change ManagementChange management analysis Save Sets alert about changes in the environment. Table 61 on page 272 describes these Save Sets.
Table 61. Change Management
Name Description Ruleset Parameters
Backup Client Configuration Changed
Generates alerts if the configuration of a backup client has been modified.
Backup client configuration changed
N/A
Backup Device Configuration Changed
Generates alerts if the configuration of a backup device has been modified.
Backup device configuration changed
N/A
Backup Group Configuration Changed
Generates alerts if the configuration of a backup group has been modified.
Backup group configuration changed
N/A
Disk Firmware Level Changed
Generates alerts if the firmware level of a disk has changed.
Disk firmware level changed
N/A
Disk Serial Number Changed
Generates alerts if a disk serial number has changed.
Disk serial number changed
N/A
NetApp Configuration Option Changed
Generates alerts if one of the configuration options on a NetApp filer has changed.
NetApp configuration option changed
N/A
Node Operating System Changed
Generates alerts if the operating system of a node has changed.
Node operating system changed
N/A
Tape Drive Firmware Level Changed
Generates alerts if the firmware level on a tape drive has changed.
Tape drive firmware level changed
N/A
Tape Drive Serial Number Changed
Generates alerts if the serial number of a tape drive has changed.
Tape drive serial number changed
N/A
Appendix A: Analysis Save Set Definitions
EMC Backup Advisor 2.0.1 Administrator’s Guide273
A
ConfigurationThe configuration analysis Save Sets monitor your environment for device or application configuration issues. Table 62 on page 273 describes these Save Sets.
Table 62. Configuration
Name Description Ruleset Parameters
Backup Client Inactive
Generates alerts if a backup client is not scheduled to run.
Backup client inactive N/A
Fileserver export and LUN on same volume
Generates alerts if a fileserver export is on the same volume as a LUN.
Fileserver export and LUN on same volume
N/A
LUN on vol0 Generates alerts if a LUN has been configured on vol0.
LUN on given volume Volume - vol0
NetApp Autosupport Disabled
Generates alerts if autosupport has been disabled on a NetApp.
NetApp autosupport disabled
N/A
NetApp Cluster Partner Missing License
Generates alerts if a NetApp cluster partner is missing a license.
NetApp cluster partner missing license
N/A
NetApp Potential Performance Impact
Generates alerts if the configuration option on a NetApp filer allows a potential performance impact.
NetApp background process performance impact high
N/A
NetApp Volume Larger than 3TB
Alert is a NetApp volume is larger than 3TB.
NetApp volume larger than recommended size
Maximum capacity - 3000
NetApp Volume Overallocated
Generates alerts if a NetApp volume has more space allocated than available.
NetApp volume overallocated
N/A
NetApp Volume Using Disks of Different Size
Alert if a NetApp volume is using disks of different sizes.
NetApp volume using disks of different size
N/A
EMC Backup Advisor 2.0.1 Administrator’s Guide
Appendix A: Analysis Save Set Definitions
274
A
Data ProtectionThe data protection analysis Save Sets monitor your environment for exceptions related to backup and recovery issues. Table 63 on page 274 describes these Save Sets.
NetApp vol0 has Multiple Data Disks
Generates alerts if vol0 has more than 1 data disk.
Filesystem has too many data disks
Filesystem - vol0
Max disks - 1
Network Autonegotiation Mismatch
Generates alerts if there is an autonegotiation mismatch between a host and its switch port.
IP autonegotiation mismatch
N/A
Network Duplex Mismatch
Generates alerts if there is a duplex mismatch between node and switch.
IP duplex mismatch N/A
Virtual Memory Less Than 1.5x Physical Memory
Generates alerts if the amount of virtual memory on a machine is less than 1.5 times the amount of physical memory.
Not enough virtual memory
N/A
Volume Priority Not Normal
Generates alerts when volume priority is set to something other than normal.
Volume priority not normal N/A
Table 63. Data Protection
Name Description Ruleset Parameters
Application Restore Time Estimate More Than 12 Hours
Generates alerts if it is estimated that it will take more than 12 hours to restore an application.
Application restore time estimate too high
Recovery time objective - 12 hours
Application Unprotected For 72 Hours
Alert if an application has not had a successful backup in more than 72 hours.
Application recovery point objective missed
Recovery point objective - 72 hours
Table 62. Configuration
Name Description Ruleset Parameters
Appendix A: Analysis Save Set Definitions
EMC Backup Advisor 2.0.1 Administrator’s Guide275
A
Backup Failed Alert generated if a backup fails.
Backup failed N/A
Backup Failed More than Twice In A Row
Alert generated if a backup fails two consecutive times.
Backup failed many times
Maximum failures - 2
Backup More Than 200% of Average Size
Generates an Alert if a backup Save Set is double its size of its average size over the last 14 days.
Backup larger than average
Days of history - 14 days
Deviation - 100%
Backup Not Succeeded For At Least 3 Days
Alert is generated if a host has not had a backup in the last 3 days.
Backup not occurred for many days
Maximum days not backed up - 3
Backup Spans More Than 3 Tapes
Alert is generated if a backup spans more than 3 tapes.
Backup spans multiple tapes
Maximum number of tapes - 3
Full Backup Less Than 50% of Average Size
Generates alerts if a Full backup is less than 50% of its usual size.
Full backup smaller than average
Days of History - 14 days
Deviation - 50%
Full Backup Not Succeeded for At Least 14 days
Generates alerts if a host has not had a successful full backup in the last 14 days.
Full backup not occurred for many days
Maximum Days Not Backed Up - 14
Mirror Not Updated For At Least 2 Days
Generates alerts if a Remote Disk Mirror has not been updated in at least 2 days.
Mirror not updated for a number of hours
Maximum Exposure - 48 hours
More than 7 Backups Without A Full
Generates alerts if there have been more than seven runs of a backup Save Set since the last Full backup.
Too many backups without a full
Maximum Non Fulls - 7
No NetWorker Bootstrap Generated in Last 48 Hours
Generates an alert if there has not been a NetWorker bootstrap Save Set ran in the last 48 hours.
No networker bootstrap generated
Maximum hours without bootstrap - defaults to 48 hours
Table 63. Data Protection
Name Description Ruleset Parameters
EMC Backup Advisor 2.0.1 Administrator’s Guide
Appendix A: Analysis Save Set Definitions
276
A
LicensingThe licensing Analysis Save Sets monitor your environment and generate alerts about licensing issues. Table 64 on page 276describes these Save Sets in more detail.
PerformanceThe performance Analysis Save Sets monitor your environment and generate alerts about performance problems. Table 65 on page 276 describes these Save Sets.
Table 64. Licensing
Name Description Ruleset Parameters
License Expired
Generates an alert if a license in EMC Backup Advisor has expired.
License expired N/A
License Will Expire in the Next Week
Generates an alert if a license will expire in the next week.
License nearing expiration
Minimum days before expiry - defaults to 7 days
Table 65. Performance
Name Description Ruleset Parameters
Backup Less Than 50% of Average Speed
Generates an alert if the performance of a backup Save Set is 50% less than its average over the last 2 weeks.
Backup slower than average
Days of history - 14
Deviation - 50%
Backup Running For More Than 18 Hours
Generates an alert if a backup has been running for more than 18 hours.
Backup overrunning
Max Runtime - 18 hours
Fileserver Cache Hit Rate Below 80%
Generates alerts if the cache hit rate of a fileserver drops below 80%.
Fileserver cache hit rate low
Minimum cache hit rate - 80%
Full Backup Ran At Less Than 300KB/Sec
Generates an alert if a full backup ran at less than 300KB/Sec.
Full backup succeeded but slow
Minimum expected speed - 300KB/Sec
Appendix A: Analysis Save Set Definitions
EMC Backup Advisor 2.0.1 Administrator’s Guide277
A
ProvisioningThe provisioning Analysis Save Sets generate alerts about events that may require you to perform provisioning operations. Table 66 on page 277 describes these Save Sets.
Resource UtilizationResource Utilization Analysis Save Sets generate alerts about events that have occurred because of resource utilization problems within the environment. Table 67 on page 277 describes these Save Sets.
Table 66. Provisioning
Name Description Ruleset Parameters
Filesystem Peak Snapshot Usage Below 80%
Generates alerts if the peak snapshot usage over the last 14 days is less than 80%.
File system snapshot space under utilized
Days to examine usage - 14
Minimum peak snapshot usage - 80%
NetApp Has No Spare Disks
Generates an alert if a NetApp has run out of spare disks.
Few spare disks Minimum Spares - defaults to 0
Table 67. Resource Utilization
Name Description Ruleset Parameters
Aggregate Snapshot Utilization Above 90%
Generates an alert if an aggregate snapshot utilization is higher than a specified threshold.
Aggregate snapshot utilization high
Maximum aggregate snapshot utilization - default is 90%
CPU Utilization At Least 90% For Last 30 Minutes
Generates an alert if the CPU Utilization on a host is greater than 90% for last 30 minutes.
CPU pegged Maximum CPU utilization - defaults to 90%
Number of minutes - 30 minutes
Disk Activity At Least 90% For Last 30 Minutes
Generates an alert if a disk on a host is greater than 90% busy for over 30 minutes.
Disk pegged Maximum Disk Busy Percentage - 90%
Number of minutes - defaults to 30 minutes
EMC Backup Advisor 2.0.1 Administrator’s Guide
Appendix A: Analysis Save Set Definitions
278
A
Fibre Channel Port Above 70% of Rated Throughput
Generates an alert if a fibre channel port exceeds 70% of its max throughput.
Fibre Channel port utilization high
Maximum utilization - 70%
Fibre Channel Port Out of BB Credits
Generates an alert if a fibre channel port has ran out of buffer to buffer credits.
Fibre Channel port no BB credits
N/A
Filesystem File Utilization High
Generates an alert if the number of files on a filesystem is greater than 90% of the max number allowed.
Filesystem file utilization high
Maximum file system file utilization - 90%
Filesystem Snapshot Utilization Above 90%
Generates an alert if a filesystems snapshot utilization is above 90%.
File system snapshot utilization high
Maximum filesystem snapshot utilization - defaults to 90%
Filesystem Utilization Above 90% and Increasing
Generates alerts if a filesystem utilization is above 90% and is increasing.
Filesystem utilization high and increasing
Maximum filesystem utilization - defaults to 90%
Memory Utilization Above 90%
Generates an alert if memory utilization on a host is greater than 90%.
Memory utilization high
Maximum memory utilization - defaults to 90%
NetApp Cluster Pair CPU Overloaded
Generates an alert if a clustered pair of NetApps have a combined CPU utilization of greater than 100%.
NetApp cluster pair joint CPU high
Maximum CPU - defaults to 100%
Network Interface Above 70% of Rated Throughput
Generates an alert if a network interface exceeds 70% of its rated throughput.
Network utilization high
Maximum utilization - defaults to 70%
NetApp Volume Would Benefit from More Disks
Generates an alert if the Data or Parity disks are busy due to high activity.
NetApp volume would benefit from more disks
Maximum Activity - defaults to 90%
Table 67. Resource Utilization
Name Description Ruleset Parameters
Appendix A: Analysis Save Set Definitions
EMC Backup Advisor 2.0.1 Administrator’s Guide279
A
Service Level AgreementsService Level Agreements Analysis Save Sets generate alerts about violations of service level agreements. Table 68 on page 279 describes these Save Sets.
StatusStatus Category Analysis Save Sets generate alerts when the current status of a monitored device or application matches creates concern. Table 69 on page 279 describes these Save Sets.
Table 68. Service Level Agreement
Name Description RulesetParameters
Backup Succeeded But Did Not Meet SLA Requirements
Generates an alert if a backup was successful but outside of its backup window.
Backup succeed but failed SLA requirements
N/A
Table 69. Status
Name Description Ruleset Parameters
CPU Offline Generates an alert if a CPU is offline.
CPU offline N/A
Collector Heartbeat Failed
Generates an alert if a collector fails to send in its heartbeat.
Collector heartbeat failed
N/A
Disk Failed Generates an alert if a disk has failed.
Disk failed N/A
Fan Inactive Generates an alert if a fan on a device is inactive.
Fan inactive N/A
Fibre Channel Port Changed State
Generates an alert if a fibre channel port has changed state.
Fibre channel port changed state
N/A
Less than 75% of Backup Devices Available
Generates an alert if less than 75% of the backup devices on a backup server are Up.
Less than x% of backup devices available
Lowest backup device availability - defaults to 75%
More Than 3 Backup Devices Unavailable
Generates an alert if there are more than 3 backup devices on a backup server Down.
Many backup devices unavailable
Maximum number of downed devices - 3
EMC Backup Advisor 2.0.1 Administrator’s Guide
Appendix A: Analysis Save Set Definitions
280
A
Network Interface Changed State
Generates an alert if network interface gets a link up or link down event.
Network interface changed state
N/A
Node Restarted Generates an alert if a host has been rebooted.
Node restarted N/A
PSU Inactive Generate an alert if a Power Supply Unit is not active.
PSU inactive N/A
Tape Drive Needs Cleaning
Generates an alert if a tape drive needs cleaning.
Tape drive needs cleaning
N/A
Tape Drive Not Okay
Generates an alert if a tape drive is reporting a status other than okay.
Tape drive not okay N/A
Tape Library Not Okay
Generates an alert if a tape library is reporting a status other than ok.
Tape library not okay
N/A
Thermometer Overheating
Generates an alert if a thermometer on a device indicates that it is overheating.
Thermometer overheating
N/A
Waiting For Writable Tapes For More Than 30 Minutes
Generates an alert if a backup server has been waiting more than 30 minutes for a writable tape.
Waiting for writable devices
Maximum outstanding devices - defaults to 0
Minutes before alerting - defaults to 30 minutes
Table 69. Status
Name Description Ruleset Parameters
Appendix A: Analysis Save Set Definitions
EMC Backup Advisor 2.0.1 Administrator’s Guide281
A
TroubleshootingThe troubleshooting analysis Save Sets provide help for troubleshooting problems with there environment. Table 70 on page 281 describes these Save Sets.
Table 70. Troubleshooting
Name Description Ruleset Parameters
Backup Failed Due to Client Network Errors
Generate an alert if a backup failed on a client while it experienced an increase in network errors.
Backup failed due to client network errors
N/A
Backup Failed Due To High Client CPU Utilization
Generate an alert if a backup failed on a client, while the CPU utilization on the machine was greater than 90%.
Backup failed due to high client CPU utilization
Maximum processor utilization - defaults to 90%
Backup Failed Due To High Client Memory Utilization
Generates an alert if a backup failed on a client whilst the memory utilization on that client was greater than 90%.
Backup failed due to high client memory utilization
Maximum memory utilization - defaults to 90
Backup Failed Due To High Server CPU Utilization
Generates an alert if a backup failed on a client whilst the CPU utilization on the backup server was greater than 90%.
Backup failed due to high server CPU utilization
Maximum processor utilization - defaults to 90%
Backup Failed Due to High Server Memory Utilization
Generates an alert if a backup fails whilst the memory utilization on the backup server is greater than 90%.
Backup failed due to high server memory utilization
Maximum memory utilization - defaults to 90%
Backup Failed Due to Server Network Errors
Generates an alert if a backup failed while there was an increase in the number of network errors on the backup server.
Backup failed due to server network errors
N/A
Disk Failed For More Than 48 Hours
Generates an alert if a disk is in a failed state for more than 48 hours.
Disk failed for a number of hours
Maximum failure time - defaults to 48 hours
EMC Backup Advisor 2.0.1 Administrator’s Guide
Appendix A: Analysis Save Set Definitions
282
A
Fibre Channel Port Reporting Errors
Generates an alert if a fibre channel port is reporting errors.
Fibre channel port reporting errors
N/A
Fibre Channel Port Reporting Errors On More Than 1% Frames
Generates an alert if more than 1% of all frames going through a fibre channel port have errors.
Fibre Channel port reporting more than x% errors
Maximum percentage errors - defaults to 1%
Network Interface Reporting Errors
Generates an alert if errors are being seen on a network interface.
Network interface reporting errors
N/A
Network Interface Reporting Errors On More Than 1% Packets
Generates an alert if more than 1% of the packets travelling through a network interface have errors.
Network interface reporting more than x% errors
Maximum percentage errors - defaults to 1%
Tape Drive Reporting Errors
Generates an alert if there is an increase in the number of errors seen on a tape drive.
Tape drive reporting errors.
Include Recoverable Errors - defaults to False
Table 70. Troubleshooting
Name Description Ruleset Parameters
EMC Backup Advisor 2.0.1 Administrator’s Guide 283
Glossary
.
administrator EMC Backup Advisor has two types of account IDs: a user and an administrator. The administrator privileges allow that user to perform all functions within EMC Backup Advisor, including creating and generating reports as well as all administrative functions. The user privileges allow users to generate reports.
Advanced Schedule Editor
If you need to create a more complex schedule than the EMC Backup Advisor Basic Editor allows, you can use the Advanced Schedule Editor. This tool allows you to create substantially more complex schedules.
Basic Schedule Editor The Schedule Editor provides two ways to create schedules:• The Basic Editor, which allows you to configure schedules
using a graphical editor, or• The Advanced Editor, which allows you to create more
complex schedules by manually editing the schedule parameters.
Chart Report You can use EMC Backup Advisor Report Editor to create two types of reports: table reports and chart reports. Chart reports display information graphically, while table reports display information in tables.
Collector The Collector is the process that gathers data from applications, hosts, and devices. When the Collector starts, it communicates with the Controller process on the EMC Backup Advisor Server to find out what it should monitor and how often it should monitor it. The configuration information is returned in the form of a series of data gathering requests. The Collector performs these requests and sends the collected data back to the Listener process on the EMC Backup Advisor Server.
Controller The Controller is the process that controls the configuration of the whole product. All processes communicate with the controller when it starts up, and all configuration changes are performed via the Controller.
Listener The Listener is the process that listens for data that has been collected by collectors and inserts it into the database.
Lite GUI The Lite UI, is a HTML based user interface that gives the users a simple light weight interface to run reports in.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Glossary
284
Glo
ssar
y
Menu Editor The EMC Backup Advisor Menu Editor allows you to customize all menus in EMC Backup Advisor.
Navigation tree The Navigation tree is the tree on the left side of the EMC Backup Advisor GUI. Reports are ran by selecting a node in the Navigation tree, right-clicking and selecting a report from the menu.
Node A Node is an element of a view. A node can be of many different types including Group, Host, CDL, NetApp, Tape Library etc. Requests are assigned to nodes in a view to specify what data is collected by the Collector. Reports can be ran by selecting a node in the tree and selecting a report from the menu.
Publisher The Publisher process schedules the publication reports via email or saves them to disk. Users can view the reports that have been written to disk using a web browser.
Predictive Analysis Engine
The Predictive Analysis Engine is a process that analyzes the data stored in the database and monitors for user specified conditions. When these conditions are met, the Analysis Engine has the ability to send SNMP traps or E-Mails, or to execute command line scripts that may alert a user, or perform recovery actions.
Reporter The reporter process receives requests from the GUI, the Publisher process, and the Analysis Engine when reports are ran. It contacts the database, extracts information, and returns information to the calling process in the form of a Report Data Set.
Report Editor You create and edit EMC Backup Advisor reports using the Report Editor.
Report Item An EMC Backup Advisor report contains report items. Each report item returns a report data set that contains information that will be displayed in the report. A report must contain at least one report item, but may contain many in more complex reports.
Request A request is an instruction to the Collector process about how to gather data. It includes the name of the module and function to execute along with any options that the user has specified, and a period that determines how often it should run.
Row Style rule You can apply Row Style rules to detailed table reports to change the foreground and background colors of rows based on the content of the report.
Glossary
EMC Backup Advisor 2.0.1 Administrator’s Guide285
Glossary
Ruleset Editor A ruleset is the set of instructions used by the Analysis Engine to determine whether a condition has been met and if an alert is generated. A ruleset is used by an Analysis Save Set to perform analysis and alerting based on information within the EMC Backup Advisor database.
When EMC Backup Advisor is installed, a number of pre-defined rulesets are installed that can monitor for common problems that may occur in your environment. The EMC Backup Advisor Ruleset Editor allows you to modify these and create entirely new rulesets. This chapter introduces the Ruleset Editor, and details how to create and modify analysis rulesets.
Schedule Component Schedules are used in the Publisher process and the Analysis Engine to configure when reports is dispatched and when Analysis Engine rules should run. Each schedule consists of one or more Schedule Components that define the different time elements that make up a schedule.
Schedule Editor The Schedule Editor provides two ways to create schedules:• The Basic Editor, which allows you to configure schedules
using a graphical editor, or• The Advanced Editor, which allows you to create more
complex schedules by manually editing the schedule parameters.
Standard GUI The Standard GUI is a Java based GUI, that is the main user interface for EMC Backup Advisor. It allows the user to configure EMC Backup Advisor and run reports.
Summary Table Report A Summary Table Report is a type of report that can be generated by EMC Backup Advisor. The Summary Table Report allows you to drill down by clicking a cell in the report to view more detailed information.
Table Report You can use the EMC Backup Advisor Report Editor to create two types of reports: table reports and chart reports. Chart reports display information graphically, while table reports display information in tables.
View A view is a collection of nodes in a tree hierarchy that appears in the Navigation tree. Multiple views can be created in EMC Backup Advisor with different users restricted to only access certain views.
EMC Backup Advisor 2.0.1 Administrator’s Guide
Glossary
286
Glo
ssar
y
EMC Backup Advisor 2.0.1 Administrator’s Guide287
Index
A
Advance Editor 120Alert Parameters 137Analysis 133analysis 133Analysis assigned 134Analysis Engine 133Analysis Job
creating 134Analysis Parameters 140Analysis Properties 140Anchor Axis 50Appearance
configuring 52Architecture 27, 32Architecture, product 27Attribute
editing 78properties 77
B
Backup Applications 89Basic Editor 117Branch Elements 156
C
Chart Appearance 52, 55Collector
reloading 81Collector architecture 34Collector component 30, 34Color
configuring 53editor 53
Command type menu itemadding 165
config 32Controller Process 32CPU Busy Ruleset 154Credential
creating 87deleting 88editing 88
CSV File Parameters 197
D
Dashboardcreating 237Deleting 250editing 249
Data SourceCondition Selection 187Field Selection 182Label Name 181Limit Selection 191Node Selection 187Option Selection 193Order Selection 193Time Selection 183
Data Sources, customizing 180Database
architecture 31restoring 257
databasebacking up 257
Database Architecture 32datamine 32Datamine Maintenance 258Date Fields
days 125editing 123hours 123Weeks 128
E
Email Parameters 137EMC Backup Advisor GUI 43Event Properties dialog box 153Every N Days Filter 125
F
Fibre Channel Switches 104Folder, adding 162Font Properties 54
G
Graphical User Interface (GUI) 33
H
Help xxiv
IndexI - R
EMC Backup Advisor 2.0.1 Administrator’s Guide288
I
Interval 185Interval Type 185IP Switches 105
L
Launch Page 40LDAP Authentication 48LDAP, testing 49Licensing 41Listener Process 32Logging into NetWorker 38
M
Maintenance 257Memory Module functions 35Menu
copying 167creating 160deleting 167editing 167
Menu Properties 161Month Filter 127, 130Months schedule component 131
N
NetBackupconfiguring authentication 91
NetWorker 89NetWorker Environments 29NetWorker environments 28NMC 28NMC Launch Page 38NMC User Interface 39Node
assigning 66creating 64deleting 71editing 69properties 65un-assigning 70working with 63
Non NetWorker Architecture 30Non NetWorker Environments 40non NetWorker environments 29
O
Operator Conditions 195Operator Fields 196Operator Label 194
Operator Parameters 195Operators, customizing 194
P
PAE 33Password, changing 44Performance Tuning 258Plug-In Data Sources 234Point in Time Schedules 118Predictive Analysis Engine 27Predictive Analysis Engine (PAE) Process 33predictive trending 27Proxy Properties dialog box 86Proxy Properties dialog box for WMI 103Proxy Requests 36Publisher 27Publisher Process 33
R
Remote Data Collection 85Remote Windows host monitoring 101Report
creating 171deleting 235editing 235exporting 235
Report Element Conditions 149Report Element Properties
defining 148Report Element Variables 149Report Item Properties 172Report Menu 160Report Menu Item
adding 163Report Properties Fields 171Reporter Process 33Reports
configuring 169Request
assigning 80configuring 79creating 85deleting 85editing 83Properties 81unassigning 81
Request List dialog box 83Request Properties 84Ruleset
adding report elements 148creating a simple 145input parameters 147testing 157
ruleset 133
EMC Backup Advisor 2.0.1 Administrator’s Guide
IndexS - X
289
Ruleset Basics 143Ruleset Condition Element 151Ruleset Editor 143Ruleset Event Element 152Ruleset Properties 144Ruleset with Report Properties 150Rulesets
complex 155
S
Schedule Component Editor 121Schedule Component Types 120–121Scheduled Report
creating 251deleting 255editing 254Properties 252testing 255
Schedulesconfiguring 115properties 116
Script Field Parameters 138Server Architecture 31Server component 31server component 30Smooth Graph 50SNMP Parameters 138System Monitoring 100System Monitoring Modules 100
T
Tape Libraries 104Time Definitions
creating 112deleting 113editing 113
Tivoli Storage Manager 91Tree Menus 159Tree Navigator 57
U
Usercreating 45deleting 48editing 47preferences 49properties 47
User user 45
V
VERITAS Backup Exec 97
VERITAS NetBackup 90View
changing 61creating 60deleting 62editing 61restricting 62
W
Week Filter 126, 129Window
configuring 109creating 110deleting 111editing 111properties 111
Window Schedules 117
X
XML-based API 34
IndexX - X
EMC Backup Advisor 2.0.1 Administrator’s Guide290
