SAM Admin Guide
SAM Admin Guide
Copyright 1995-2012 SolarWinds Worldwide, LLC. All rights reserved worldwide. No part of this document may be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the written consent of SolarWinds. All right, title, and interest in and to the software and documentation are and shall remain the exclusive property of SolarWinds and its respective licensors. SOLARWINDS DISCLAIMS ALL WARRANTIES, CONDITIONS OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON SOFTWARE AND DOCUMENTATION FURNISHED HEREUNDER INCLUDING WITHOUT LIMITATION THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL SOLARWINDS, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY EVEN IF SOLARWINDS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. The SolarWinds, the SolarWinds & Design, ipMonitor, LANsurveyor, Orion, and other SolarWinds marks, identified on the SolarWinds website, as updated from SolarWinds from time to time and incorporated herein, are registered with the U.S. Patent and Trademark Office and may be registered or pending registration in other countries. All other SolarWinds trademarks may be common law marks or registered or pending registration in the United States or in other countries. All other trademarks or registered trademarks contained and/or mentioned herein are used for identification purposes only and may be trademarks or registered trademarks of their respective companies. Microsoft, Windows, and SQL Server are registered trademarks of Microsoft Corporation in the United States and/or other countries. Portions Copyright ComponentOne, LLC 1991-2002. All Rights Reserved. Portions of the following SolarWinds SAM Documentation is excerpted from: IBM DeveloperWorks, Copyright IBM Corporation 1994, 2012. Available at http://www.ibm.com/developerworks/ Microsoft TechNet, TechNet Library, 2010 Microsoft Corporation. All rights reserved. Available at technet.microsoft.com. Oracle Corporation, 2012 2010 Oracle Corporation. All rights reserved. . Available at www.oracle.com SolarWinds Server & Application Monitor Administrator Guide, 9/4/2012, version 5.2 - DJR
About SolarWinds
SolarWinds (NYSE: SWI) provides powerful and affordable IT management software to customers worldwide from Fortune 500 enterprises to small businesses. We work to put our users first and remove the obstacles that have become status quo in traditional enterprise software. SolarWinds products are downloadable, easy to use and maintain, and provide the power, scale, and flexibility needed to address users management priorities. Our online user community, thwack, is a gathering-place where tens of thousands of IT pros solve problems, share technology, and participate in product development for all of SolarWinds products. Learn more today at http://www.solarwinds.com. SolarWinds, SolarWinds.com, and Orion are registered trademarks of SolarWinds. All other company and product names mentioned are used only for identification purposes and may be trademarks or registered trademarks of their respective companies.
Contacting SolarWinds
You can contact SolarWinds in a number of ways, including the following: Team Sales Technical Support User Forums Contact Information 1.866.530.8100 http://www.solarwinds.com http://www.solarwinds.com/support, you need a customer account to access the Customer Support area of the website. http://www.thwack.com contains the community oriented user forums
Conventions
The documentation uses consistent conventions to help you identify items throughout the printed and online library. Convention Bold Italics Specifying Window items, including buttons and fields. Book and CD titles, variable names, new terms File and directory names, commands and code examples, text typed by you Optional command parameters Required command parameters Exclusive command parameters where only one of the options can be specified
Fixed font
Straight brackets, as in [value] Curly braces, as in {value} Logical OR, as in value1|value2
Release Notes
The following documents supplement the Server & Application Monitor documentation library with information about SolarWinds Common Components: Document Orion Common Components Administrator Guide Orion Common Components Page Help Release Notes Purpose Provides detailed setup, configuration, and conceptual information for the common components. Provides help for every window in the Orion Common Components user interface. Provides late breaking information, known issues, and updates. The latest Release Notes can be found at www.solarwinds.com.
Note: With this release, Orion products are based on a set of common features that are shared by all of the Orion products. Therefore you need to consult the documentation listed above for the Orion Common Components in order to find information about all of the common features.
About SolarWinds v
Contents
About SolarWinds ........................................................................................ iv Contacting SolarWinds ................................................................................ iv Conventions.................................................................................................. iv SolarWinds Server & Application Monitor Documentation Library ......... v
Chapter 1
Introduction...................................................................................................... 1 SolarWinds SAM vs. Orion APM .................................................................. 1 Applications Defined .................................................................................... 2 SAM Glossary of Terms ................................................................................ 3 How Does SolarWinds Server & Application Monitor Work? ................... 5 Application Availabilty and Status .............................................................. 7
Chapter 2
Requirements and Installation......................................................................... 9 Requirements for SolarWinds SAM ............................................................ 9 FIPS Support................................................................................................ 13 Server Sizing................................................................................................ 15 SNMP Requirements for Monitored Devices ............................................ 15 Enabling Microsoft Internet Information Services (IIS) ........................... 16 Enabling IIS on Windows Server 2003 ..................................................... 16 Enabling IIS on Windows Server 2008 ..................................................... 20 Upgrading SolarWinds Server & Application Monitor............................. 23 Upgrading NPM and SolarWinds SAM on Your Current Server .............. 24 Upgrading APM to a New Server While Keeping NPM on Your Current Server ....................................................................................................... 24 Moving SolarWinds SAM to a different server ......................................... 25 General Requirements .............................................................................. 25 Database Requirements ........................................................................... 26 Stopping SAM Services ............................................................................ 26 Creating a Database Backup File with Database Manager ...................... 27
vi Contents
Creating a Database Backup File with SQL Server Management Studio Express ..................................................................................................... 28 Creating a Database Backup File with SQL Server Management Studio. 29 Restoring a Database Backup File for SQL Express Server .................... 30 Restoring a Database Backup File for SQL Server 2005 ......................... 31 Restoring a Database Backup File for SQL Server 2008 ......................... 32 Updating SolarWinds SAM to Use the New Database Server .................. 34 Reassigning Nodes ................................................................................... 35 Copying Custom Reports .......................................................................... 37 Updating Report Schemas ........................................................................ 37 Moving SolarWinds SAM Security Certificates to a New Server .............. 38 Migrating Licenses with License Manager ................................................ 39 Installing License Manager ....................................................................... 40 Upgrading SolarWinds APM when SolarWinds Failover Engine is Installed ................................................................................................................... 41 Installing SolarWinds Server & Application Monitor ............................... 43 Activating Your License ............................................................................. 48 Finishing SolarWinds SAM Installation ..................................................... 49 Excluding SolarWinds Data Directories from Anti-Virus Scanning ....... 52 Running SolarWinds SAM .......................................................................... 52 Internet Explorer Security Settings ........................................................... 53 Licensing ...................................................................................................... 53
Chapter 3
Common Tasks with SolarWinds SAM .......................................................... 55 Monitoring Internal and External Web Site Performance ........................ 56 Monitoring Microsoft Windows Performance ........................................... 59 Monitoring IIS Application Pools ............................................................... 62 Scanning for Applications Worth Monitoring ........................................... 65 Monitoring a Specific URL .......................................................................... 67 Monitoring VMware Performance Counters ............................................. 69 Monitoring and Restarting Stopped Windows Services .......................... 72 Creating a Custom Component Availability Report ................................. 74 Monitoring Large Directories ..................................................................... 76
Contents vii
Managing the Web Console .......................................................................... 79 Getting Started with SolarWinds ............................................................... 82 Discovery Central ..................................................................................... 82 Network Sonar Discovery ......................................................................... 82 Add a Node ............................................................................................... 82 Node & Group Management ....................................................................... 82 Manage Nodes ......................................................................................... 83 Virtualization Settings ............................................................................... 83 Manage Dependencies ............................................................................. 83 Manage Groups ........................................................................................ 83 Accounts ...................................................................................................... 83 Manage Accounts ..................................................................................... 84 Account List .............................................................................................. 84 Customize .................................................................................................... 84 Customize Menu Bars .............................................................................. 84 Color Scheme ........................................................................................... 84 External Websites ..................................................................................... 85 Manage Alerts .............................................................................................. 85 Manage Advanced Alerts .......................................................................... 85 Product Updates ......................................................................................... 86 Available Product Updates ....................................................................... 86 SolarWinds Product Team Blog ............................................................... 86 Views ............................................................................................................ 86 Manage Views .......................................................................................... 87 Add New View .......................................................................................... 87 Views by Device Type .............................................................................. 87 Views by Application Type ........................................................................ 87 Settings ........................................................................................................ 87 Web Console Settings .............................................................................. 88 Polling Settings ......................................................................................... 88 SAM Settings ............................................................................................ 88 SolarWinds Thresholds ............................................................................. 88 Virtualization Thresholds .......................................................................... 88 Details ........................................................................................................... 88 Database Details ...................................................................................... 89
viii Contents
Polling Engines.......................................................................................... 89 Orion Core Details ..................................................................................... 89 License Details .......................................................................................... 89 Navigating the SolarWinds Web Console ................................................. 89 Using Web Console Tabs ......................................................................... 90 Using and Disabling Web Console Breadcrumbs ..................................... 90 Managing Nodes from the Web Console................................................... 91 Adding Nodes for Monitoring..................................................................... 92 Deleting Nodes from Monitoring ................................................................ 95 Deleting Applications or Volumes from Monitoring ................................... 96 Viewing Node Data in Tooltips .................................................................. 96 Editing Node Properties ............................................................................ 97 Promoting a Node from ICMP to SNMP Monitoring.................................. 98 Promoting a Node from ICMP to WMI Monitoring ................................... 100 Viewing Node Resources ........................................................................ 101 Setting Node Management States .......................................................... 101 Unscheduled Node Polling and Rediscovery .......................................... 102 Monitoring Windows Server Memory ...................................................... 104 Scheduling a Node Maintenance Mode Time Period.............................. 104 Administrative Functions of the SolarWinds Web Console .................. 104 Changing an Account Password ............................................................. 104 Viewing Secure Data on the Web ........................................................... 105 Handling Counter Rollovers .................................................................... 105 SolarWinds General Thresholds .............................................................. 106 SolarWinds General Threshold Types .................................................... 106 Setting SolarWinds General Thresholds ................................................. 108 Customizing Views .................................................................................... 108 Creating New Views ................................................................................ 109 Editing Views ........................................................................................... 109 Configuring View Limitations ................................................................... 111 Copying Views......................................................................................... 112 Deleting Views......................................................................................... 112 Views by Device Type ............................................................................. 112 Resource Configuration Examples.......................................................... 113 Customizing Web Console Menu Bars ................................................... 122 Changing the Web Console Color Scheme ............................................ 123 Changing the Web Console Site Logo .................................................... 123 Configuring the Available Product Updates View ................................... 124 Updating your SolarWinds Installation .................................................... 125 Customizing Charts in the SolarWinds Web Console ............................. 125 Custom Node Charts ............................................................................... 126
Contents ix
Custom Volume Charts ........................................................................... 128 Custom Chart View ................................................................................. 128 Multiple Object Chart .............................................................................. 130 Exporting Views to PDF .......................................................................... 131 Event Log Message Details .................................................................... 132 Min/Max Average Chart .......................................................................... 133 Component Availability Chart ................................................................. 136 Creating a Custom Summary View ........................................................ 136 Creating and Editing External Website Views ........................................ 137 Custom Object Resources in the SolarWinds Web Console ................ 138 Editing a Custom Object Resource ........................................................ 138 Selecting Custom Objects and Resources ............................................. 139 Available Custom Resources.................................................................. 139 Integrating SolarWinds Engineers Toolset ........................................... 139 Configuring a Toolset Integration ........................................................... 140 Adding Programs to a Toolset Integration Menu .................................... 141 Web Console Configuration ..................................................................... 141 Creating a Web Console Configuration Backup ..................................... 142 Restoring a Web Console Configuration Backup ................................... 142 Clearing a Web Console Configuration .................................................. 142 Logging in for the First Time as an Administrator ................................ 143 Windows Authentication with Active Directory ..................................... 143 Using the Web Console Notification Bar ................................................ 144 Using the SolarWinds Web Console Message Center .......................... 145 Suppressing Events ................................................................................ 145 Using Node Filters .................................................................................... 146 Accessing Nodes Using HTTP, SSH, and Telnet ................................... 147 Using Integrated Remote Desktop .......................................................... 148
Chapter 5
SolarWinds SAM Settings ........................................................................... 149 Getting Started with SAM ......................................................................... 150 Scan Nodes for Applications................................................................... 150 Manually Assign Application Monitors .................................................... 151 Browse for Component Monitor .............................................................. 151 Application Monitors ................................................................................ 151
x Contents
Manage Application Monitors .................................................................. 151 Application Monitor Templates ................................................................ 151 Manage Templates.................................................................................. 151 Create a New Template .......................................................................... 152 Component Monitors................................................................................. 152 Component Monitor Library ..................................................................... 152 Manage Assigned Component Monitors ................................................. 152 Manage Component Monitors within Templates ..................................... 152 Application Detail Views ........................................................................... 153 Views by Application Type ...................................................................... 153 Global SAM Settings ................................................................................. 153 Credentials Library .................................................................................. 153 Data and Database Settings ................................................................... 153 License Summary ...................................................................................... 155 SAM License Summary ........................................................................... 155 thwack Community .................................................................................... 155 Shared thwack Templates ....................................................................... 155 SAM thwack Forum ................................................................................. 155
Chapter 6
Discovering and Adding Nodes on a Network ............................................. 157 Discovery Central ...................................................................................... 157 Virtualization Discovery ........................................................................... 158 Application Discovery .............................................................................. 158 Network Sonar Discovery ......................................................................... 158 Using the Network Sonar Results Wizard ............................................... 165 Managing Scheduled Discovery Results ................................................ 166 Using the Discovery Ignore List ............................................................... 167
Chapter 7
Application Discovery .................................................................................. 169 Add Application Monitors ......................................................................... 170 Reading the Application Summary .......................................................... 171
Contents xi
Active Application Alerts ......................................................................... 172 Application Health Overview ................................................................... 172 Applications with Problems ..................................................................... 173 Last 25 Application Events ..................................................................... 173 Thwack Latest Application Templates .................................................... 173 Top 10 Components Monitored by Response Time ............................... 174 Top 10 Processes Monitored by CPU Load ........................................... 174 Top 10 Processes Monitored by Physical Memory ................................ 175 Top 10 Processes Monitored by Virtual Memory.................................... 175
Chapter 8
Managing Groups and Dependencies ........................................................ 177 Creating Groups ..................................................................................... 177 Editing Groups ........................................................................................ 179 Managing Group Members ..................................................................... 179 Deleting Groups ...................................................................................... 180 Managing the Display of Group Status ................................................... 180 Managing Dependencies .......................................................................... 181 Creating a Dependency .......................................................................... 182 Editing a Dependency ............................................................................. 183 Deleting a Dependency .......................................................................... 184 Viewing Alerts on Child Objects ............................................................. 185
Chapter 9
Managing Accounts ..................................................................................... 187 Creating Accounts .................................................................................... 187 Editing User Accounts .............................................................................. 188 User Account Access Settings................................................................ 190 Configuring Audible Web Alerts .............................................................. 191 Setting Account Limitations .................................................................... 192 Defining Pattern Limitations .................................................................... 194 Setting Default Account Menu Bars and Views ...................................... 195 Configuring an Account Report Folder ................................................... 197 Server & Application Monitor Settings .................................................... 198 Orion General Settings ........................................................................... 198 Integrated Virtual Infrastructure Monitor Settings ................................... 199
Chapter 10
Managing SolarWinds SAM Polling Engines .............................................. 201 Viewing Polling Engine Status................................................................. 201
xii Contents
Configuring Polling Engine Settings ....................................................... 201 SolarWinds Polling Settings ..................................................................... 202 Polling Intervals ....................................................................................... 202 Polling Statistics Intervals ....................................................................... 202 Network ................................................................................................... 203 Calculations & Thresholds ...................................................................... 203 Calculating Node Availability ................................................................... 204 Calculating a Baseline .............................................................................. 205 Using the Polling Engine Load Balancer ................................................ 205 Setting the Node Warning Level .............................................................. 206 Managing Packet Loss Reporting ............................................................ 207
Chapter 11
Virtualization ................................................................................................ 209 VMware Monitoring.................................................................................... 209 Requirements for Monitoring ESXi and ESX Servers ............................. 210 Enabling SNMP on VMware ESXi and ESX Servers .............................. 211 Enabling SNMP on VMware ESXi........................................................... 211 Enabling SNMP on ESX Server Version 3.5 ........................................... 212 Enabling SNMP on ESX Server Version 4.0 ........................................... 213 Creating ESX Server Credentials for SolarWinds SAM .......................... 215 Managing VMware Credentials in the Web Console .............................. 216 Adding Virtual Servers for Monitoring ..................................................... 217 Virtualization Summary ........................................................................... 217 Viewing ESX Host Details ....................................................................... 218 Changing Polling Orders for ESX Servers .............................................. 218 Troubleshooting ESX Hardware Monitoring ............................................ 219 Hyper-V Monitoring ................................................................................... 220 Requirements for Monitoring Hyper-V Servers ....................................... 220 Configuring Hyper-V Servers for Discovery ............................................ 220 Enabling and Disabling Hyper-V Monitoring ........................................... 223 Accessing Hyper-V Details ...................................................................... 225
Chapter 12
Building Component Monitors and Templates ............................................ 227 Understanding Component Monitors and Application Monitor Templates ................................................................................................... 230
Contents xiii
Choosing Component Monitors and Templates Based on Protocol ... 232 Requirements for Component Monitors and Templates that use WMI 232 Monitoring External Nodes ...................................................................... 234 Understanding the Credentials Library .................................................. 234 Adding Credentials to the Credentials Library ........................................ 235 Editing Credentials in the Credentials Library ........................................ 235 Deleting Credentials from the Credentials Library .................................. 235 Using Quick Credentials ......................................................................... 236 Using Application Monitor Templates .................................................... 237 Scanning Nodes for Applications ............................................................ 237 Manually Assign Application Monitors .................................................... 239 Creating New Templates ........................................................................ 240 Managing Templates .............................................................................. 242 Multi-Edit Templates ............................................................................... 245 Managing Assigned Application Monitors ............................................. 249 Editing an Assigned Application Monitor ................................................ 250 Unmanaging Assigned Application Monitors .......................................... 251 Remanaging Assigned Application Monitors .......................................... 251 Deleting Assigned Application Monitors ................................................. 252 Working with Component Monitors ........................................................ 252 Viewing the Component Monitor Library ................................................ 253 Managing Assigned Component Monitors .............................................. 253 Managing Component Monitors within Templates ................................. 257 Scripting Custom Component Monitors ................................................. 259 Creating a Linux/Unix Script Monitor ...................................................... 261 Creating a Windows Script Monitor ........................................................ 265 Creating a Nagios Script Monitor ............................................................ 273 Creating a Windows PowerShell Monitor ............................................... 276 JMX Component Monitor Wizard ............................................................. 279 Custom Application Monitor Template Example: Creating a SolarWinds SAM Template............................................................................................ 281 Conversion Value ...................................................................................... 283 Available Data Transformations .............................................................. 284 Multiple Statistic Chart ............................................................................. 285
xiv Contents
Viewing Application and Component Performance and Status ................... 289 Understanding the SAM Application Summary ...................................... 289 Understanding SAM Application Details ................................................. 291 Understanding SolarWinds SAM Component Details ........................... 292 Understanding SolarWinds SAM Component Settings ......................... 294 Showing SolarWinds SAM Data in Node Details .................................... 294 Customizing SAM Application Summary Views ..................................... 295 Customizing Application Details Views .................................................. 297 Viewing Node and Application Data in Tooltips ..................................... 299 Monitoring Network Events in the Web Console ................................... 300 Viewing Event Details in the Web Console ............................................. 300 Acknowledging Events in the Web Console ........................................... 301
Chapter 14
Creating Account Limitations ....................................................................... 303 Using the Account Limitation Builder ..................................................... 303 Creating an Account Limitation ............................................................... 303 Deleting an Account Limitation ................................................................ 304
Chapter 15
Alerting and Reporting ................................................................................. 305 Creating Alerts ........................................................................................... 305 Configuring SolarWinds SAM Alerts ....................................................... 306 SolarWinds SAM Alerts ........................................................................... 309 Testing Alert Actions ............................................................................... 315 Viewing Alerts in the SolarWinds Web Console ..................................... 316 Acknowledging Advanced Alerts in the Web Console ............................ 316 Viewing Alerts from Mobile Devices ........................................................ 317 Restarting Windows Services with an Alert Action ................................. 318 Creating a New Advanced Alert .............................................................. 319 Naming, Describing, and Enabling an Advanced Alert ........................... 320 Setting a Trigger Condition for an Advanced Alert .................................. 322 Setting a Reset Condition for an Advanced Alert .................................... 325 Setting a Suppression for an Advanced Alert ......................................... 327 Setting the Monitoring Period for an Advanced Alert .............................. 328 Setting a Trigger Action for an Advanced Alert ....................................... 328
Contents xv
Setting a Reset Action for an Advanced Alert ........................................ 329 Alert Escalation ....................................................................................... 330 Understanding Condition Groups ........................................................... 330 Using the Advanced Alert Manager ........................................................ 332 Adding Alert Actions ................................................................................ 335 Sending an E-mail / Page ....................................................................... 336 Playing a Sound ...................................................................................... 337 Logging an Advanced Alert to a File ....................................................... 338 Logging an Advanced Alert to the Windows Event Log ......................... 339 Logging an Advanced Alert to the NetPerfMon Event Log ..................... 340 Sending a Syslog Message .................................................................... 341 Executing an External Program .............................................................. 343 Executing a Visual Basic Script .............................................................. 343 Emailing a Web Page ............................................................................. 344 Using Text to Speech Output ................................................................. 346 Sending a Windows Net Message .......................................................... 346 Sending an SNMP Trap .......................................................................... 347 Using Get or Post URL Functions .......................................................... 348 Dial Paging or SMS Service ................................................................... 349 Escalated Advanced Alerts ...................................................................... 349 Escalated Alert Example ......................................................................... 349 Creating a Series of Escalated Alerts ..................................................... 350 Creating and Viewing Reports ................................................................. 353 Creating SolarWinds SAM-Specific Reports .......................................... 353 Using Predefined SolarWinds SAM Reports .......................................... 354 Viewing SolarWinds Server & Application Monitor Reports ................... 358 Filtering and Grouping Data in Resources ............................................. 360 SQL Syntax ............................................................................................. 361 SWQL Syntax (Semantic Web Query Language) .................................. 362 Predefined SolarWinds Reports ............................................................. 364 Availability ............................................................................................... 365 Current Node Status ............................................................................... 366 Current Volume Status ........................................................................... 366 Daily Node Availability ............................................................................ 366 Events ..................................................................................................... 367 Historical CPU and Memory Reports ...................................................... 368 Historical Response Time Reports ......................................................... 368 Historical VMware ESX Server Reports ................................................. 368 Groups: Current Groups and Groups Members Status .......................... 369 Groups: Daily Group Availability ............................................................. 369 Groups: Group Availability (with members) ............................................ 369 Groups: Historical Groups Status ........................................................... 370 Historical Volume Usage Reports ........................................................... 370
xvi Contents
Inventory .................................................................................................. 370 Viewing Reports ...................................................................................... 371 Using Report Writer ................................................................................. 372 Creating and Modifying Reports .............................................................. 373 Using SolarWinds Report Scheduler....................................................... 377 Customizing the Report Header and Footer Image ................................ 381 Exporting Reports.................................................................................... 381 Example Device Availability Report ........................................................ 382 Reports and Account Limitations ............................................................ 389
Chapter 16
Monitoring Hardware Health ........................................................................ 391 Hardware Items Monitored by SAM ......................................................... 392 Hardware Monitoring and VMware ........................................................... 392 Accessing Hardware Monitoring Agent Software .................................. 393 Adding Server Hardware Monitoring ....................................................... 394 Hardware Details........................................................................................ 396 Current Hardware Health Status ............................................................. 397 Hardware Health Overview Chart ........................................................... 398 Changing Threshold Values .................................................................... 398 Hardware Health Chart .............................................................................. 400 Customizing the Hardware Health Chart ................................................ 401 Alerting on Hardware Health .................................................................... 403 Manually Changing Alert Thresholds ...................................................... 404
Chapter 17
Monitoring Processes in Real Time ............................................................. 405 Accessing the Real Time Process Explorer ........................................... 406 Using the Real Time Process Explorer.................................................... 408 Monitoring Unmonitored Processes ........................................................ 409 Real Time Process Explorer Alerts ......................................................... 411 Real Time Process Information in Top XX Alerts .................................... 412
Chapter 18
Monitoring Syslog Messages ....................................................................... 415 Configuring the SolarWinds Syslog Port ................................................ 415
Contents xvii
Syslog Messages in the Web Console .................................................... 416 Syslog Resources ................................................................................... 416 Viewing Syslog Messages in the Web Console ..................................... 417 Acknowledging Syslog Messages in the Web Console .......................... 418 Using the Syslog Viewer .......................................................................... 419 Viewing and Acknowledging Current Messages .................................... 419 Searching for Syslog Messages ............................................................. 419 Syslog Server Settings ........................................................................... 420 Configuring Syslog Viewer Filters and Alerts ......................................... 421 Available Syslog Alert Actions ................................................................ 423 Forwarding Syslog Messages................................................................. 425 Syslog Alert Variables .............................................................................. 426 Syslog Date/Time Variables ................................................................... 426 Other Syslog Variables ........................................................................... 427 Syslog Message Priorities........................................................................ 427 Syslog Facilities ...................................................................................... 427 Syslog Severities .................................................................................... 428
Chapter 19
Monitoring SNMP Traps .............................................................................. 429 The SNMP Trap Protocol .......................................................................... 429 Viewing SNMP Traps in the Web Console .............................................. 429 Using the Trap Viewer .............................................................................. 430 Viewing Current Traps ............................................................................ 430 Searching for Traps ................................................................................ 431 Trap Viewer Settings .............................................................................. 431 Configuring Trap Viewer Filters and Alerts ............................................. 432 Available Trap Alert Actions .................................................................... 434 Trap Alert Variables ................................................................................ 435 Trap Date/Time Variables ....................................................................... 436 Other Trap Variables .............................................................................. 436
Chapter 20
Managing the SolarWinds SAM Database .................................................. 439 Using Database Manager ......................................................................... 439 Adding a Server ...................................................................................... 439
xviii Contents
Creating Database Backups ................................................................... 440 Restoring a Database ............................................................................. 441 Compacting your Database ..................................................................... 441 Compacting Individual Tables ................................................................. 442 Viewing Database Details ....................................................................... 442 Viewing Table Details .............................................................................. 443 Editing Database Fields .......................................................................... 444 Detaching a Database ............................................................................. 445 Creating a Database Maintenance Plan ................................................. 445 Using SQL Server Management Studio ................................................... 446 Database Maintenance .............................................................................. 449 Running Database Maintenance ............................................................. 449 Migrating your Database ......................................................................... 450
Chapter 21
Creating Custom Properties ........................................................................ 453 Creating a Custom Property ..................................................................... 453 Removing a Custom Property .................................................................. 454 Importing Custom Property Data ............................................................. 455 Custom Property Editor Settings ............................................................. 456 Editing Custom Properties ....................................................................... 456 Using Filters in Edit View .......................................................................... 457 Creating Custom Properties Filters ......................................................... 457 Removing Custom Properties Filters ...................................................... 458
Appendix A
Additional Polling Engine and Web Console ............................................... 459 Understanding How Polling Engines Work ............................................ 459 SolarWinds SAM is Poller-Unaware By Default ...................................... 460 SolarWinds SAM Additional Polling Engines are Poller-Aware .............. 461 Requirements for Installing an Additional Polling Engine .................... 462 Installing an Additional Polling Engine ................................................... 462 Installing an Additional Web Console ..................................................... 464
Contents xix
SolarWinds Variables and Examples .......................................................... 469 Variable Modifiers ..................................................................................... 469 95 Percentile Calculations ..................................................................... 469 Regular Expression Pattern Matching .................................................... 471 Advanced Alert Engine Variables ............................................................ 475 General ................................................................................................... 475 Date/Time ............................................................................................... 476 Group Variables ...................................................................................... 476 SQL Query .............................................................................................. 477 Status Variables ...................................................................................... 478 Node Variables ....................................................................................... 478 Volume Variables .................................................................................... 481 Hardware Specific Variables................................................................... 482 Example Messages Using Variables ...................................................... 486 Syslog Alert Variables .............................................................................. 486 Syslog Date/Time Variables ................................................................... 486 Other Syslog Variables ........................................................................... 487 Trap Alert Variables .................................................................................. 487 General Trap Variables ........................................................................... 487 Trap Date/Time Variables ....................................................................... 488
Appendix D
th
Network Atlas .............................................................................................. 489 What is in a Map? ...................................................................................... 489 Example Maps ........................................................................................... 489 Installing Network Atlas ........................................................................... 491 Network Atlas Requirements ................................................................... 491 Installing Network Atlas on a Remote Computer................................... 491 Creating a Basic Map ................................................................................ 493 Starting Network Atlas .............................................................................. 493 Adding Map Objects ................................................................................. 494
xx Contents
Connecting Map Objects Manually .......................................................... 495 Using Object Links to Represent Interface Status ................................. 495 Interpreting Map Links .............................................................................. 495 Using Anchor Points to Reshape Map Links .......................................... 495 Adding a Background ............................................................................... 496 Saving Maps ............................................................................................... 498 Opening Maps ............................................................................................ 498 Displaying Maps in the Web Console ...................................................... 499 Map Resources in the Network Atlas Web Console .............................. 499 Displaying Maps in the SolarWinds Web Console ................................. 500 Displaying Maps in the SolarWinds EOC Web Console ........................ 500 Advanced Mapping Techniques ............................................................... 500 Zooming In and Out of a Map ................................................................... 501 Creating Nested Maps ............................................................................... 501 Displaying Map Object Metrics ................................................................ 502 Adding Independent Map Objects and Floating Labels ........................ 503 Changing the Appearance of Map Objects ............................................. 503 Pasting Custom Icons from the Windows Clipboard ............................. 504 Adding Custom Icons from Graphics Files ............................................ 505 Changing the Appearance of Links ......................................................... 506 Changing the Appearance of Labels ....................................................... 507 Linking Map Objects to URLs ................................................................... 508 Linking or Embedding Maps in Web Pages ............................................ 508 Customizing SolarWinds Web Console Tooltips ................................... 508 Advanced Map Layouts ............................................................................ 509 Displaying Grid Guides ............................................................................. 510 Aligning Map Objects ................................................................................ 510 Distributing Map Objects .......................................................................... 511 Selecting Automatic Layout Styles.......................................................... 511 Map Properties ........................................................................................... 512
Contents xxi
Network Atlas Settings ............................................................................. 513 Network Atlas Tooltip Variables .............................................................. 515 Application Variables ................................................................................ 515 Application Component Monitor Variables ............................................ 515 Date and Time Variables ........................................................................... 516 General Variables ...................................................................................... 517 Node Variables .......................................................................................... 517 Volume Variables ...................................................................................... 519 Wireless Variables .................................................................................... 519 Group Variables ........................................................................................ 520
Appendix E
Configuring Automatic Login ....................................................................... 521 Using Windows Pass-through Security .................................................. 521 Passing Login Information Using URL Parameters............................... 524 Using the DirectLink Account .................................................................. 524
Appendix F
Troubleshooting .......................................................................................... 525 Why do my SAM WMI Monitors Show Status Unknown? ..................... 527 WMI Troubleshooting Flowchart for SolarWinds SAM ........................... 529 Testing Local WMI Services ................................................................... 530 Test WMI on the Target Server .............................................................. 530 Reset the WMI Counters ........................................................................ 533 Testing Remote WMI Connectivity ......................................................... 534 Remotely Test WMI on the Target Server .............................................. 534 Verify Administrator Credentials ............................................................. 537 Enable Remote Procedure Call (RPC) ................................................... 537 Configure Distributed Component Object Model (DCOM) and User Account Control (UAC) ........................................................................... 538 Enabling DCOM ...................................................................................... 539 Enabling Account Privileges in WMI ....................................................... 539 Disabling Remote User Account Control for Workgroups ...................... 540 Add a Windows Firewall Exception for Remote WMI Connections ........ 541 Do You Need an Additional Polling Engine? .......................................... 541 Verify SAM Component Configuration .................................................... 541 Service reporting, "Invalid Class"............................................................ 542
xxii Contents
WMI is Still Not Working. Now What? ..................................................... 544 Working with Temporary Directories ....................................................... 544 Moving the SQL Server Temporary Directory ......................................... 544 Redefining Windows System Temporary Directories .............................. 544 Slow Performance on Windows Server 2008 .......................................... 545 Troubleshooting Hardware Health ........................................................... 547 Hardware Prerequisite Checklist ............................................................. 547 Hardware Troubleshooting Flowchart ..................................................... 548 Troubleshooting an SNMP Node ............................................................ 549 Troubleshooting a WMI Node ................................................................. 552 Troubleshooting a VMWare Node ........................................................... 555
Appendix G
Component Monitor Types .......................................................................... 557 DHCP User Experience Monitor ............................................................... 559 Directory Size Monitor............................................................................... 562 DNS Monitor - TCP..................................................................................... 564 DNS Monitor - UDP .................................................................................... 565 DNS User Experience Monitor .................................................................. 566 Download Speed Monitor ......................................................................... 568 File Age Monitor ......................................................................................... 570 File Change Monitor .................................................................................. 572 File Count Monitor ..................................................................................... 574 File Existence Monitor .............................................................................. 576 File Size Monitor ........................................................................................ 577 FTP Monitor ................................................................................................ 579 FTP User Experience Monitor .................................................................. 580 HTTP Form Login Monitor ........................................................................ 583 HTTP Monitor ............................................................................................. 587 HTTPS Monitor ........................................................................................... 590 IMAP4 Monitor ............................................................................................ 593 IMAP4 User Experience Monitor .............................................................. 594 JMX Monitor ............................................................................................... 597
Contents xxiii
LDAP User Experience Monitor ............................................................... 599 Linux/Unix Script Monitor ........................................................................ 601 MAPI User Experience Monitor ................................................................ 603 Nagios Script Monitor ............................................................................... 606 NNTP Monitor ............................................................................................ 608 ODBC User Experience Monitor .............................................................. 609 Oracle User Experience Monitor.............................................................. 612 Performance Counter Monitor ................................................................. 617 POP3 Monitor............................................................................................. 620 POP3 User Experience Monitor ............................................................... 622 Process Monitor - SNMP .......................................................................... 624 Process Monitor - WMI ............................................................................. 626 RADIUS User Experience Monitor ........................................................... 628 Service Status SNMP ............................................................................. 630 SMTP Monitor ............................................................................................ 632 SNMP Monitor ............................................................................................ 633 SQL Server User Experience Monitor ..................................................... 635 SSL Certificate Expiration Date Monitor ................................................. 638 TACACS+ User Experience Monitor ........................................................ 640 TCP Port Monitor ....................................................................................... 642 Tomcat Server Monitor ............................................................................. 644 VMware Performance Counter Monitor .................................................. 647 Web Link Monitor ...................................................................................... 651 Windows Event Log Monitor .................................................................... 654 Windows PowerShell Monitor .................................................................. 658 Windows Script Monitor ........................................................................... 661 Windows Service Monitor ........................................................................ 663 WMI Monitor ............................................................................................... 665
xxiv Contents
Filter Syntax Reference ............................................................................... 669 Filter Syntax ............................................................................................... 669 SWQL Filter Syntax Examples ................................................................ 670 SQL Filter Syntax Examples ................................................................... 671 SWQL Resource Matrix ............................................................................. 672 EOC Filters .............................................................................................. 672 IVIM Filters .............................................................................................. 678 SolarWinds SAM Filters .......................................................................... 680
Appendix I
Configuring and Integrating ......................................................................... 681 JMX.............................................................................................................. 681 JConsole ................................................................................................. 682 Adding a JMX Component Monitor to SAM ............................................ 683 Configuring Java Applications Servers for JMX ...................................... 687 Configuring Java Virtual Machines for SNMP ......................................... 698 MAPI ............................................................................................................ 708 The MAPI User Experience Monitor in SAM ........................................... 709 Install the MAPI Client on the SolarWinds SAM Server .......................... 709 Troubleshooting MAPI ............................................................................. 714 Advanced Troubleshooting ..................................................................... 716 Oracle .......................................................................................................... 719 Physical and Logical Structures .............................................................. 719 Storage .................................................................................................... 719 Disk files .................................................................................................. 719 Configuring SAM to Monitor an Oracle Database Server ....................... 720 Prerequisites for Oracle Server Monitoring ............................................. 720 Installing ODP.Net ................................................................................... 721 Installing the Basic Lite Oracle Client...................................................... 727 Adding an Oracle Database Server to SAM ........................................... 730 Monitoring an Oracle Database on an Existing Node ............................. 736 Getting the Required Settings ................................................................. 742 Troubleshooting....................................................................................... 745 PowerShell ................................................................................................. 762 PowerShell and SAM: Configuration and Usage .................................... 763 PowerShell Templates and Monitors ...................................................... 771 PowerShell Code with SAM .................................................................... 776 Execute Scripts Remotely via Secure WinRM ........................................ 780
Contents xxv
PowerShell 2.0 Remoting Requirements ................................................ 780 PowerShell 2.0 Remoting Configuration ................................................. 781 Remoting Client/SAM Computer Configuration ...................................... 792 Communicate with Remoting Host ......................................................... 800 Setup Windows PowerShell Monitor in SAM .......................................... 801 LDAP ........................................................................................................... 805 LDAP Key Terms and Components ....................................................... 805 Basic LDAP Syntax ................................................................................. 806 The LDAP User Experience Monitor ...................................................... 808 Integrating the LDAP User Experience Monitor...................................... 809
Index
xxvi Contents
Chapter 1
Introduction
SolarWinds Server & Application Monitor (SolarWinds SAM) allows you to create and monitor your own custom collection of monitored components, providing an open field of opportunity to the network engineer. It also allows you to create flexible Application Monitor templates to combine process monitors, port availability, and performance counters, allowing you to assess the status of every aspect of your application and the health of the application as a whole.
Introduction 1
Be aware of these name changes as you explore the software and this manual: The acronym APM has been replaced with, SAM, when referring to this software product. There are instances throughout this guide, as well as various places within the software itself, and on the SolarWinds website, that the acronym, APM, may still exist. This is intentional and will be found in paths, variables, and previous versions of the software. While this may be a slight inconvenience, it is essential to ensure the integrity of an already active implementation of previous versions of the software. The word Orion has been removed when referring to specific SolarWinds software. For example: Orion APM, Orion NPM, and so on. The word Orion refers to shared platform items such as alerts, shared components, variables, and so on.
Applications Defined
An application in SolarWinds SAM is considered a collection of component monitors housed in a template. A component monitor is defined as a value returned by a specific process, counter, status, or a value returned by a script. With this received data, SolarWinds SAM can easily show you a myriad of vital statistics concerning the health of your system. Templates provide blueprints for the applications to be monitored. You can quickly and easily customize numerous templates, using only the component monitors you need for a specific environment. SolarWinds SAM recognizes and answers the complexity of todays business applications with scalability, flexibility, and reliability. Refer to the following sections for more information: SAM Glossary of Terms How Does SolarWinds Server & Application Monitor Work?
2 Introduction
Component Monitor A component monitor is the fundamental element of an application. Component monitors return the current status or value of a monitored service or process. All component monitors return at least one value or one status condition. Node - A node is considered to be any endpoint of a given network. For example, any server or computer on a network is considered a node. Sometimes a node is referred to as a device. Application - An application in SolarWinds SAM is a collection of component monitors. Template - A template is the blueprint for an application. It is a collection of component monitors designed to monitor a server or application. You can customize numerous templates using only the component monitors you need for a specific environment.
Introduction 3
The type of information returned by the component monitor is based upon the type of monitor being utilized. For example, one type of monitor can report the up or down status of a service or process, another monitor can return the percentage of free space of a volume. Another type of component monitor can return up to ten values. Each monitor type, along with its parameters and returned values and/or states, is unique. Each node, along with its applications and component monitors, can be viewed from the SolarWinds SAM web console as shown in the diagram below. The view can be customized to suit your needs.
4 Introduction
Installed as a module in your family of SolarWinds products, SAM can be visualized with the following flowchart:
Introduction 5
6 Introduction
Introduction 7
8 Introduction
Chapter 2
SolarWinds Server Software Requirements The following table lists minimum software requirements and recommendations for your SolarWinds server.
Software Requirements Windows Server 2003 or Windows Server 2008 R2, with IIS in 32-bit mode. IIS must be installed. SolarWinds recommends that SolarWinds administrators have local administrator privileges to ensure full functionality of local SolarWinds tools. Accounts limited to use of the SolarWinds Web Console do not require administrator privileges. Notes: SolarWinds does not support production installations of SolarWinds products on Windows XP, Windows Vista, or Windows 7 systems. If you are installing SolarWinds SAM on Windows Server 2003, confirm that your full computer name is no longer than 15 characters in length. Windows Server 2003 trims any characters beyond the fifteenth, and this may prevent SolarWinds services from properly identifying your SolarWinds server. For more information, see Additional SolarWinds SAM Requirements on page 12. Microsoft IIS, version 6.0 and higher, in 32-bit mode. DNS specifications require that hostnames be composed of alphanumeric characters (A-Z, 0-9), the minus sign (-), and periods (.). Underscore characters (_) are not allowed. For more information, see RFC 952. Warning: The following Windows accounts, as configured by IIS 6.0 on Windows Server 2003 with their default security settings, are required: IUSR_<hostname>, as a member of the Guests group ONLY. IWAM_<hostname>, as a member of the IIS_WPG group ONLY. Disabling these accounts or changing any default settings of these accounts may negatively affect the operation of your SolarWinds installation. SolarWinds strongly recommends against altering these accounts or their settings. Note: SolarWinds neither recommends nor supports the installation of any SolarWinds SAM product on the same server or using the same database server as a Research in Motion (RIM) Blackberry server. Version 3.5 .NET Framework, 4.0 is recommended. Windows operating system management and monitoring tools component Microsoft Internet Explorer version 7 or higher with Active scripting, Firefox 13.0 or higher (Toolset Integration is not supported on Firefox), Google Chrome
Operating System
Web Server
SolarWinds Server Hardware Requirements The following table lists minimum hardware requirements and recommendations for your SolarWinds server. Note: Hardware requirements are listed by SolarWinds license level.
Hardware CPU Speed AL50, AL100, AL250, or AL500 2.0 GHz AL1000 2.4 GHz ALX 3.0 GHz
Requirements for Virtual Machines and Servers SolarWinds installations on VMware Virtual Machines and Microsoft Virtual Servers are fully supported if the following minimum configuration requirements are met for each virtual machine. Note: SolarWinds strongly recommends that you maintain your SQL Server database on a separate physical server.
Virtual Machine Configuration CPU Speed Allocated Hard Drive Space Memory SolarWinds Requirements by License Level AL50, AL100, AL250, or AL500 2.0 GHz 2GB AL1000 2.4 GHz 5GB ALX 3.0 GHz 20GB
Note: Due to intense I/O requirements, SQL Server should be hosted on a separate physical server configured as RAID 1+0. RAID 5 is not recommended for the SQL Server hard drive. 3 GB 4 GB 4 GB Each virtual machine on which SolarWinds is installed should have its own, dedicated network interface card. Note: Since SolarWinds uses SNMP to monitor your network, if you are unable to dedicate a network interface card to your SolarWinds server, you may experience gaps in monitoring data due to the low priority generally assigned to SNMP traffic.
Network Interface
Requirements for the SolarWinds Database Server (SQL Server) The following table lists software and hardware requirements for your SolarWinds database server. SolarWinds license levels are provided as a reference.
Requirements AL50, AL100, AL250, or AL500 AL1000 ALX
SQL Server
SQL Server 2005 SP1 Express, Standard, or Enterprise SQL Server 2008 Express, Standard, or Enterprise Notes: Due to latency effects, SolarWinds does not recommend installing your SQL Server and your SolarWinds server or additional polling engine in different locations across a WAN. For more information, see SolarWinds Knowledge Base article, Can I install my SolarWinds server or Additional Polling Engine and my SolarWinds database (SQL Server) in different locations across a WAN? Either mixed-mode or SQL authentication must be supported. If you are managing your SolarWinds database, SolarWinds recommends you install the SQL Server Management Studio component. Use the following database SQL statement to check your SQL Server version, service pack or release level, and edition: select SERVERPROPERTY ('productversion'), SERVERPROPERTY ('productlevel'), SERVERPROPERTY ('edition') 2.0 GHz 2 GB 2.4 GHz 5 GB 3.0 GHz 20 GB
CPU Speed
Note: Due to intense I/O requirements, a RAID 1+0 drive is strongly recommended the SQL Server database and SolarWinds data and log files. RAID 5 is not recommended for the SQL Server hard drive. The SolarWinds installer needs at least 1GB on the drive where temporary Windows system or user variables are stored. Per Windows standards, some common files may need to be installed on drive as your server operating system. 2 GB 3 GB 4 GB Note: SolarWinds recommends additional RAM for SolarWinds SAM installations utilizing more than 1,000 monitors. For optimal performance in larger ALX environments, we recommend 8GB of RAM or greater. Additional memory will improve both performance and reliability.
Memory
The Configuration Wizard installs the following required x86 components if they are not found on your SolarWinds database server: Microsoft SQL Server Native Client Microsoft SQL Server Management Objects Additional SolarWinds SAM Requirements Enterprise-level SolarWinds SAM deployments with the potential for more than 1,000 monitors may need additional computing resources above the standards required for SolarWinds common components:
Note: If you are running Windows Server 2008, you must upgrade to Windows Server 2008 R2 because SolarWinds SAM does not support Windows Server 2008 due to known WMI issues.
FIPS Support
FIPS (Federal Information Processing Standard) defines security and interoperability standards for computers used by the U.S. federal government. To enable FIPS in the Local Security Policy on Windows: 1. Click Start > Control Panel > System and Security > Administrative Tools, and then double-click Local Security Policy. 2. Expand the Local Policies category in the left pane, and then click Security Options. 3. Right-click System cryptography: Use FIPS compliant algorithms for encryption, hashing, and signing. 4. In the context menu that is displayed, click Properties. 5. In the Local Security Setting tab, click Enabled and then click Ok. Note: FIPS can also be enabled as part of Group Policy. SolarWinds SAM installations on Windows Server 2008 R2 require a Microsoft hotfix to realize the FIPS-compatibility features of this release. For more information about this required Microsoft hotfix, see the article http://support.microsoft.com/kb/981119. As noted in the KB article, you need to enable FIPS first before applying the Microsoft hotfix. If you use component monitors that have not passed FIPS testing, they may not work properly when FIPS is enabled. The following SolarWinds SAM component monitors have passed FIPS testing: DHCP User Experience Monitor Directory Size Monitor DNS Monitor - TCP DNS Monitor - UDP DNS User Experience Monitor
Requirements and Installation 13
Download Speed Monitor File Age Monitor File Count Monitor File Existence Monitor File Size Monitor FTP Monitor HTTP Form Login Monitor HTTP Monitor HTTPS Monitor IMAP4 Monitor IMAP4 User Experience Monitor LDAP User Experience Monitor Linux/Unix Script Monitor MAPI User Experience Monitor NNTP Monitor ODBC User Experience Monitor Oracle User Experience Monitor Performance Counter Monitor POP3 Monitor POP3 User Experience Monitor Process Monitor - SNMP FIPS not supported when SNMP is SNMPv3 and using MD5. Process Monitor - WMI SMTP Monitor SNMP Monitor FIPS not supported when SNMP is SNMPv3 and using MD5. SQL Server User Experience Monitor TCP Port Monitor Tomcat Server Monitor Web Link Monitor Windows Event Log Monitor Windows Script Monitor
14 Requirements and Installation
Server Sizing
SolarWinds SAM is capable of monitoring networks of any size, ranging from small corporate LANs to large enterprise and service provider networks. Most SolarWinds SAM systems perform well on 3.0 GHz systems with 4 GB of RAM using default polling engine settings. However, when monitoring larger networks, you should give additional consideration to the hardware used and the system configuration. There are three primary variables that affect scalability. The most important consideration is the number of monitored components. Monitoring more than 1,000 components may require fine tuning for optimal performance. The second variable to consider is polling frequency. For instance, if you are collecting statistics more frequently than the default, the system will have to work harder and system requirements will increase. Finally, the number of simultaneous users accessing SolarWinds SAM directly impacts system performance. When planning a SolarWinds SAM installation, there are four main factors to keep in mind with respect to polling capacity: CPU, memory, number of polling engines, and polling engine settings. For minimum hardware recommendations, see Requirements for SolarWinds on page 9. For more information about polling engines, see Additional Polling Engine and Web Console on page 459. Installing SolarWinds SAM and SQL Server on different servers is highly recommended, particularly if you are planning on having more that 1,000 component monitors. This scenario offers several performance advantages as the SolarWinds SAM server does not perform any database processing and it does not have to share resources with SQL Server. If you plan to monitor 10,000 or more components, SolarWinds recommends that you install additional polling engines on separate servers to help distribute the work load. For more information about sizing SolarWinds SAM to your network, contact the SolarWinds sales team or visit www.solarwinds.com. For more information about configuring additional pollers, see Additional Polling Engine and Web Console on page 459.
To properly monitor devices on your network, you must enable SNMP on all devices that are capable of SNMP communications. Unix based devices should use the configuration of Net-SNMP version 5.5 or higher that is specific to the type of Unix-based operating system in use. SolarWinds SAM is capable of monitoring VMware ESX and ESXi Servers versions 3.5 and higher with VMware Tools installed. For more information about enabling SNMP and VMware Tools on your VMware device, consult your VMware documentation or technical representative. If SNMPv2c is enabled on a device you want to monitor, by default, SolarWinds SAM will attempt to use SNMPv2c to poll the device for performance information. If you only want SolarWinds SAM to poll using SNMPv1, you must disable SNMPv2c on the device to be polled.
4. Confirm that Internet Information Services (IIS) is checked, and then click Details.
5. Confirm that World Wide Web Service is checked, and then click Details.
6. Confirm that World Wide Web Service is checked, and then click OK.
7. Click OK on the Internet Information Services (IIS) window, and then click OK on the Application Server window.
9. Confirm that both Simple Network Management Protocol and WMI SNMP Provider are checked, and then click OK.
10. Click Next, and then click Finish when the wizard completes. Note: You may be prompted to install additional components, to provide your Windows Operating System media, or to restart your computer.
4. Click Next to start the Add Roles Wizard, and then check Web Server (IIS).
5. If you are prompted to add features required for Web Server (IIS), click Add Required Features.
6. Click Next on the Select Server Roles window, and then click Next on the Web Server (IIS) window.
7. Confirm that Common HTTP Features > Static Content is installed. 8. Check Application Development > ASP.NET.
10. Check both Security > Windows Authentication and Security > Basic Authentication.
12. Click Next on the Select Role Services window. 13. Click Install on the Confirm Installation Selections window. 14. Click Close on the Installation Results window. 15. If you are currently enabling IIS as part of a SolarWinds SAM installation, restart the SolarWinds SAM installer.
If installed on different servers, SAM and SolarWinds NPM each require their own database. You cannot share one database between separate SAM and SolarWinds NPM servers.
Upgrading APM to a New Server While Keeping NPM on Your Current Server
To upgrade APM to a new server: 1. Back up your current SolarWinds Server. 2. Shutdown SolarWinds NPM and APM on your current SolarWinds Server. 3. Have your Database Administrator clone your SolarWinds database to a different name. Note: To clone your SolarWinds database, use the appropriate version of Microsoft SQL Server Management Studio for your database. You can download this from the Microsoft website if it is not already installed. 4. Uninstall APM from your original Orion Server. a. Use Add or Remove Programs in Control Panel to remove SolarWinds Server & Application Monitor. b. The Configuration Wizard should be run automatically as part of the uninstallation. If it is not, execute it manually by clicking Start > All Programs > SolarWinds Orion > Configuration and AutoDiscovery > Configuration Wizard.
c. In the Configuration Wizard, select all components to be modified: Database, Website, and Services, and then configure them appropriately for your original SolarWinds Server. Ensure that you specify the original database. d. Delete the APM folder in the <drive>:\INETPUB\SOLARWINDS\ORION directory, where <drive> is the drive letter for the APM Website Root Directory, for example: C. 5. Copy the security certificate from the original server to the new server. 6. Install SAM on its new server as described in the section Installing SolarWinds Server & Application Monitor on page 43, and in the Configuration Wizard specify the new cloned database. For more information, see Installing SolarWinds Server & Application Monitor on page 43.
General Requirements
Moving your SolarWinds SAM implementation to a new server requires the following: Server hardware meeting minimum requirements for the new SolarWinds SAM implementation. Windows user account credentials that have been granted administrative rights on both servers. A license reset to register SolarWinds SAM on your new server. You will need to install SolarWinds License Manager to manage the required license migration.
Note: Maps and map objects created or edited in SolarWinds Network Atlas are stored in the SolarWinds database. If the database is successfully migrated, there is no need to migrate any additional Network Atlas map files.
Database Requirements
Ensure that you comply with the following requirements before you attempt to modify or back up your existing database: SolarWinds APM version 4.0 and higher requires SQL Server 2005 SP1 or later, including SQL Server 2008. Install your new database server. The following procedures assume you are moving your database from one physical server to another and that the management tool (Enterprise Manager, SQL Server Management Studio Express, or SQL Server Management Studio) is installed on the new database server. If you want to use a Microsoft SQL Server Express database, recognize that the database store is limited to 4GB. Know the sa password to both your existing SolarWinds database server and your new database server. Know the credentials to an account with administrator rights on both your existing SolarWinds database server and your new database server. Have a maintenance window during which you can safely shutdown your SolarWinds SAM services. You need to stop data collection to ensure that your backup file matches your last active database state.
7. Click OK. 8. If you are moving the SQL database to the new SolarWinds SAM server, copy the new backup file to a folder on the new server. 9. Install SolarWinds SAM on the new server, but DO NOT run the Configuration Wizard yet. Reboot the server if prompted, and then register the software. Note: A new license key is required, and you will need to install SolarWinds License Manager to manage the required license migration. 10. On the new server, click Start > SolarWinds Orion > Advanced Features > Database Manager.
Requirements and Installation 27
11. If your SQL Server is not listed in the left pane, add your server, as shown in the following steps: a. Click Add Server. b. Select the name of the SQL instance from the SQL Server list. If your server is not listed, type the name or IP address. c. Select the appropriate authentication type, and then click Connect to Database Server. 12. Locate and right-click on your server in the Database Manager tree in the left pane, and then click Connect to Server. 13. If you moved the SQL database to the new server, perform the following steps: Note: Database Manager cannot create new folders. Therefore, specify a path that already exists. a. Click Database > Restore Database. b. Click the ellipsis to Select the Database file to Restore. c. If you want to verify the validity of the selected database, click Verify. d. Confirm or edit the name of the restored database in the Restore Database as the following Database name field. e. If you want to restore the database as .MDF or .LOG files, provide appropriate filenames in the Restore Database in the following MDF and LOG files fields. f. Click OK.
14. Run the Configuration Wizard and specify the existing (or newly restored) database on the Database setup section of the wizard. When prompted, click Yes to use the existing database. Note: Do not skip tabs or deviate from the tab order. Click Start, and then click Continue to complete the wizard in order. Completing tabs out of order may adversely affect the install process.
Creating a Database Backup File with SQL Server Management Studio Express
Complete the following procedure if your new database server uses SQL Server 2005 Express edition. To backup your SolarWinds database using SQL Server Management Studio Express:
1. Log on to the new database server using an administrator account. 2. Click Start > All Programs > Microsoft SQL Server 2005 > SQL Server Management Studio Express. 3. Specify the name of the current SolarWinds database server on the Connect to Server window. 4. If you are using SQL Server Authentication, click SQL Server Authentication in the Authentication field, and then specify your credentials in the User name and Password fields. 5. Click Connect. 6. Expand the name of your SolarWinds server, and then expand Databases in the left pane. 7. Right-click the name of your SolarWinds database, and then click Tasks > Backup. 8. Click Add, and then specify and remember the Destination you provide. This is the directory and name of your backup. Note: Remember, this file is created on the remote database server. It is not created locally. 9. Click Options in the Select a page pane on the left. 10. Check Verify backup when finished. 11. Click OK. 12. Copy the .bak file from your current SolarWinds database server to your new database server.
4. If you are using SQL Server Authentication, click SQL Server Authentication in the Authentication field, and then specify your credentials in the User name and Password fields. 5. Click Connect. 6. In the pane on the left, expand the name of the server hosting the SQL instance you are using for SolarWinds SAM, and then expand Databases. 7. Right-click the name of your SolarWinds database, and then click Tasks > Back Up. 8. In the Source area, select Full as the Backup type. 9. In the Backup set area, provide an appropriate Name and Description for your database backup. 10. If there is not already an appropriate backup location listed in the Destination area, click Add, and then specify and remember the destination path and file name you provide. This is the location where your backup is stored. Note: Remember, if your database is on a remote server, as recommended, this backup file is also created on the remote database server. It is not created locally. 11. Click Options in Select a page pane on the left. 12. In the Reliability area, check Verify backup when finished. 13. Click OK. 14. Copy the .bak file from your current SolarWinds database server to your new database server.
4. Specify the name of the new SolarWinds database server on the Connect to Server window. 5. If you are using SQL Server Authentication, click SQL Server Authentication in the Authentication field, and then specify your credentials in the User name and Password fields. 6. Click Connect. 7. Click the name of your server to view an expanded list of objects associated with your server. 8. Click Databases, and then click Restore Database. 9. Leave To database blank. 10. Click From device, and then browse () to the location of your .bak file. 11. Click Add, and then navigate to the .bak file and click OK. 12. Click OK on the Specify Backup window. 13. Check Restore. 14. Select the name of your database from the To database field. It will now be populated with the correct name. 15. Click Options in the left Select a page pane, and then check Overwrite the existing database. 16. Ensure you select a directory that already exists for the files listed in the Restore As column. 17. Click OK. 18. Open and run the configuration wizard to update your SolarWinds SAM installation.
5. If you are using SQL Server Authentication, click SQL Server Authentication in the Authentication field, and then specify your credentials in the User name and Password fields. 6. Click Connect. 7. Click the name of your server to view an expanded list of objects associated with your server, and then right-click Databases. 8. Click Restore Database. 9. Leave To database blank. 10. Click From device, and then browse () to the location of your .bak file. 11. Click Add, and then navigate to the .bak file and click OK. 12. Click OK on the Specify Backup window. 13. Check Restore. 14. Select the name of your database from the To database field. It will now be populated with the correct name. 15. Click Options in the left Select a page pane. 16. Check Overwrite the existing database. 17. For each Original File Name listed, complete the following steps to ensure a successful restoration: a. Click Browse (). b. Select a directory that already exists. c. Provide a name for the Restore As file that matches the Original File Name, and then click OK. 18. Select Leave the database ready to use by rolling uncommitted transactions(RESTORE WITH RECOVERY). 19. Click OK. 20. Open and run the configuration wizard to update your SolarWinds SAM installation. Note: Due to the nature of security identifiers (SIDs) assigned to SQL Server 2005 database accounts, SolarWinds recommends that you create and use a new account for accessing your restored SolarWinds database on the Database Account window of the SolarWinds Configuration Wizard.
To restore your database backup file on a server running SQL Server 2008: 1. Log on to the new database server using an administrator account. 2. Click Start > All Programs > Microsoft SQL Server 2008 > SQL Server Management Studio. 3. Click File > Connect Object Explorer. 4. Specify the name of the new SolarWinds database server on the Connect to Server window. 5. If you are using SQL Server Authentication, click SQL Server Authentication in the Authentication field, and then specify your credentials in the User name and Password fields. 6. Click Connect. 7. Click the name of your server to view an expanded list of objects associated with your server, and then right-click Databases. 8. Click Restore Database. 9. Leave To database blank. 10. Select From device, and then click Browse (). 11. Confirm that File is selected as the Backup media. 12. Click Add. 13. Navigate to the .bak file, select it, and then click OK. 14. Click OK on the Specify Backup window. 15. In the Destination for restore area, select the name of your database from the To database field. Note: The To database is now populated with the correct name. 16. Check Restore next to the database backup you are restoring. 17. Click Options in the left Select a page pane. 18. Check Overwrite the existing database (WITH REPLACE). 19. For each Original File Name listed, complete the following steps to ensure a successful restoration:
a. Click Browse (). b. Select a directory that already exists. c. Provide a name for the Restore As file that matches the Original File Name, and then click OK. 20. Select Leave the database ready to use by rolling uncommitted transactions(RESTORE WITH RECOVERY), and then click OK. 21. Open and run the configuration wizard to update your SolarWinds SAM installation. Note: Due to the nature of security identifiers (SIDs) assigned to SQL Server 2008 database accounts, SolarWinds recommends that you create and use a new account for accessing your restored SolarWinds database on the Database Account window of the SolarWinds Configuration Wizard.
Notes:
Creating a new account ensures that SolarWinds SAM has required access to your migrat The New Account must be a member of the securityadmin server role. The sysadmin role and the sa user account are always members of securityadmin. 10. Provide and confirm an account Password. 11. Click Next to start database configuration, and then click Finish to exit the Configuration Wizard
Reassigning Nodes
If a new name is used for the new SolarWinds SAM server, it is added to the database as a new polling engine. All current nodes remain assigned to the old polling engine name and must be reassigned to the new polling engine, as shown in the following procedure. To reassign items to the new polling engine: 1. Click Start > All Programs > SolarWinds Orion > Advanced Features > Orion Service Manager. 2. Stop all SolarWinds services. Notes: If you have more than one Polling Engine, you will need to stop each additional Polling Engine before continuing. Do not stop the SQL Service. The SQL Service needs to be running in order to make the necessary changes to the database. 3. Click File > Exit 4. Click Start > SolarWinds Orion > Database Utilities > Database Manager. 5. Expand your SQL Server in the tree. 6. Expand the SolarWinds database. Note: By default, this database is named NetPerfMon. 7. Right-click on the Engines table, and then click Query Table. 8. Click Refresh to display the table entries.
10. Replace the value in the ServerName field for the old polling engine with the server name of the new polling engine. In the previous graphic, the OLDSERVER is renamed NEW-SERVER. Note: It is not necessary to update the IP field. The next time the service is started, SolarWinds SAM discovers the new IP address, and the IP field is updated automatically. 11. Delete the newly added engine from the table (EngineID: 2 in this example) by clicking on the blank area to the left of the row to select it. Right-click anywhere in the selected row, and then click Delete Selected Rows.
12. Click Yes when prompted to confirm deleting the row. Note: The final result will display the new server name with the IP address of the old server. The next time the service starts, the IP field will be updated with the IP address of the new server. 13. Close Database Manager.
g. Click OK. h. Expand the Certificates (Local Computer) > Personal > Certificates group. i. Right-click SolarWinds APM Engine (if present), and SolarWindsOrion, point to All Tasks on the shortcut menu, and then click Export. Note: Exporting SolarWinds APM Engine is only required if you are upgrading from APM 4.0.1 or earlier. If you have APM 4.0.2 or later, you do not need to do anything with this certificate. Just migrate the SolarWinds-Orion certificate. j. Click Next in the Certificate Export Wizard.
k. Select Yes, export the private key, click Next, and then click Next again. l. Type and confirm a password for this private key, and then click Next.
m. Specify the file name to which you want to save the certificate, click Next, and then click Finishthe certificate is saved with a .pfx file name extension. 2. Copy the .pfx certificate file to the new server. 3. Import the certificate to the new server.
38 Requirements and Installation
a. On the Start Menu, click Run, type MMC, and then click OK. b. On the File menu, click Add/Remove Snapin, and then click Add. c. Select Certificates, and then click Add. d. Select Computer account, and then click Next. e. Select Local computer, and then click Finish. f. Click Close.
g. Click OK. h. Expand the Certificates (Local Computer) group. i. j. Expand the Personal group. Expand the Certificates group.
k. If there is a SolarWinds SAM Engine item in the list, right-click SolarWinds APM Engine and SolarWinds-Orion and select Delete from the shortcut menu. l. Right-click the CertificatesPersonalCertificates node, point to All Tasks in the shortcut menu, and then click Import.
m. Click Next in the Certificate Import Wizard. n. Specify the .pfx certificate file you copied to the server and then click Next. o. Enter the password for the private key, check Mark this key as exportable, and then click Next. p. Select Place all certificates in the following store, and then select Personal as the Certificate Store. q. Click Next and then click Finish.
4. Specify your SolarWinds Customer ID and password when prompted, and then click Deactivate. Note: Deactivated licenses are now available to activate on a new computer. When you have successfully deactivated your products, log on to the computer on which you want to install your products, and then begin installation. When asked to specify your licenses, provide the appropriate information. The license you deactivated earlier is then assigned to the new installation.
When you have successfully deactivated your products, log on to the computer on which you want to install your products, and then begin installation. When asked to specify your licenses, provide the appropriate information. The license you deactivated earlier is then assigned to the new installation.
iv. SolarWinds Orion Failover Engine will start and SolarWinds Orion will be stopped. v. On the primary server, launch the SolarWinds Orion Failover Engine Configure Server wizard and click on the Machine tab. Change the Current role to Primary/active. vi. Restart SolarWinds Orion Failover Engine on the primary server and allow system to synchronize. vii. Start SolarWinds Orion Failover Manager and check that the system completes the full system check. Needs to be updated: SQL is already updated, needs revert Orion is not able to uninstall upgrade, needs repair of previous release 6. Change the server role to Secondary/passive: a. Start failover engine in context menu of tray icon - to update service default start up mode b. Stop failover engine including stopping all protected applications in context menu of tray icon c. Wait until all protected services are stopped d. Launch the Configure Server wizard and click on the Machine tab. Change the Current role to Secondary/passive e. Start Failover Engine - to enable packet filter f. Shutdown Failover Engine
On the primary Server (assuming a successful upgrade of secondary completed): 7. Perform upgrade on primary: a. Disable Neverfail Packet Filter Driver on Public NIC 1. Open Properties of the Public Network Adapter. (e.g. in Network Connections window, accessible via Control Panel, right click the Public Network Adapter and select Properties) 2. Uncheck the Neverfail Packet Filter Driver item on the list and close the window by OK. b. Install the SolarWinds Orion Update by running the setup program. c. If asked, reboot server now. After reboot, shutdown Failover Engine and proceed with Configuration Wizard. d. Verify that SolarWinds Orion is operational. e. Enable the Neverfail Packet Filter Driver on Public NIC 1. Open Properties of the Public Network Adapter.
(e.g. in Network Connections window, accessible via Control Panel, right click the Public Network Adapter and select Properties) 2. Check the Neverfail Packet Filter Driver item on the list and close the window by OK. 8. Resume the Failover Engine a. Start Failover engine on the Primary Server. b. Launch Failover Manager on the Primary Server and make the Primary Server Active using the Make Active button. c. Start Failover Engine on the Secondary server. d. Start Replication using Start Replication button in the Failover Manager. 9. License the SolarWinds a. If applicable, license the application(s) on the Active (Primary) server. If SolarWinds fails to start on the secondary server, follow the steps below: 1. Shutdown Orion Failover Engine. 2. Launch the Configure Server wizard and set the secondary server role to passive. 3. Start Orion Failover Engine on the secondary server. 4. Start the Configure Server wizard on the primary server and set the server role to active. 5. Start Orion Failover Engine on the primary server. 6. Launch the SolarWinds Orion Failover Manager and verify that the system completes the Full System Check. 7. Investigate the cause of the SolarWinds Orion failure on the secondary server.
To install or upgrade SolarWinds Server & Application Monitor: 1. Using an account with local administrative privileges, log on to the SolarWinds server on which you want to install SolarWinds SAM. To avoid permissions issues, this account should not be a domain account, and it should not be subject to any local or group policy restrictions. 2. If you downloaded the product from the SolarWinds website, complete the following steps: a. Navigate to the location of your downloaded .zip file, and then extract the evaluation package to an appropriate location. b. Launch the SolarWinds SAM evaluation executable. 3. If you are prompted to install any required components, such as Microsoft .NET Framework 3.5 or Microsoft ASP.NET 2.0 AJAX Extensions, click Install and then complete the component installation. Note: Downloading and installing Microsoft .NET Framework 3.5 may take a long time, depending on your existing system configuration. 4. Review the Welcome text, and then click Next.
5. If the InstallShield Wizard detects that Microsoft Internet Information Services (IIS) is not installed, suspend installation, quit setup, and then install Internet Information Services (IIS). 6. If you had to install Internet Information Services (IIS), launch the SolarWinds evaluation executable again.
44 Requirements and Installation
7. Accept the terms of the license agreement, and then click Next.
8. Accept the default install location, or navigate to a different location, and then click Next.
9. Accept the Express Install Recommended option, and then click Next.
11. After files are copied and installed, configuring begins automatically.
13. Type Admin in the User Name field, and then click LOGIN.
14. The Network Sonar Wizard is displayed. Click Cancel and then confirm that you want to cancel the network discovery by clicking Ok. Note: The wizard can be used to discover a set of nodes in your network. You will use it later in this guide.
7. If you cannot find an activation key in the Unregistered Licenses section, contact SolarWinds customer support. 8. Return to the Activate SAM window, and then enter the activation key in the Activation Key field. 9. If you access Internet web sites through a proxy server, click I access the internet through a proxy server, and enter the proxy address and port. 10. Click Next. 11. Enter your email address and other registration information, and then click Next. To license the software on a server without Internet access: 1. Click Enter Licensing Information 2. Select This server does not have internet access, and then click Next. 3. Click Copy Unique Machine ID. 4. Paste the copied data into a text editor document. 5. Transfer the document to a computer with Internet access. 6. On the computer with Internet access, complete the following steps: 7. Browse to http://www.solarwinds.com/customerportal/licensemanagement.aspx and then log on to the portal with your SolarWinds customer ID and password. 8. Navigate to your product, and then click Manually Register License. 9. If the Manually Register License option is not available for your product, contact SolarWinds customer support. 10. Provide the Machine ID from Step 5, and then download your license key file. 11. Transfer the license key file to the server. 12. Return to the Activate SAM window, browse to the license key file, and then click Next.
Confirm that you have designated a SQL Server database instance for SolarWinds SAM. Confirm that the Internet Information Services (IIS) Manager is not open while the Configuration Wizard is running. During configuration, the SolarWinds polling engine will shut down temporarily with the result that, if you are actively polling, you may lose some polling data. SolarWinds recommends that you perform upgrades during off-peak hours of network usage to minimize the impact of this temporary polling stoppage. To configure Server & Application Monitor: 1. If the Configuration Wizard has not loaded automatically, click Start > All Programs > SolarWinds Orion > Configuration and Auto-Discovery > Configuration Wizard. 2. Click Next on the Welcome window of the Configuration Wizard. 3. If you are prompted to stop services, click Yes. Note: To ensure that all updates and changes are installed correctly, it is imperative that you stop all services. 4. Specify the SQL Server instance you want to use to store network data. 5. Provide the credentials, if necessary, that are required to log into the selected instance. Notes: If you are using an existing database, the user account needs only to be in the db_owner database role for the existing database. If you are using an existing SQL account, the user account needs only to be in the db_owner database role for the SolarWinds SAM database.
The selected instance must support mixed mode or SQL authentication with strong passwords. A strong password must meet at least three of the following four criteria: o o o o Contains at least one uppercase letter. Contains at least one lowercase letter. Contains at least one number. Contains at least one non-alphanumeric character, e.g., #, %, or ^.
For more information about authentication with strong passwords, see http://msdn.microsoft.com/ms143705.aspx.
If you are using SQL Express, specify your instance as (local) and use a strong password. For more information about authentication with strong passwords, see http://msdn.microsoft.com/ms143705.aspx. Due to its inherent limitations, SolarWinds recommends against the use of SQL Express in production environments. If you are creating a new database, the user account must be a member of the dbcreator server role. The sysadmin role and the sa user account are always members of dbcreator. If you are creating a new SQL account for use with SolarWinds SAM, the user account must be a member of the securityadmin server role. Note: The sysadmin role and the sa user account are always members of securityadmin. 6. Click Next. 7. If you are creating a new database, select Create a new database, provide a name for the new database, and then click Next. Note: SolarWinds recommends against using non-alphanumeric characters in database names. 8. If you are using an existing database, select Use an existing database, type the database name or select it from the list, and then click Next. 9. If you want to create a new SQL account for the SolarWinds SAM polling engine and web console to use for accessing the database, select Create a new account, provide an account name and password, confirm the account password, and then click Next. 10. If you want to use an existing SQL account for the SolarWinds SAM polling engine and web console to use for accessing the database, select the existing account, provide the appropriate password, and then click Next. 11. If you need to specify a particular IP Address for the SolarWinds SAM Web Console, provide the IP address of the host web server. Note: SolarWinds recommends the default All Unassigned unless your environment requires a specific IP address for your SolarWinds Web Console. 12. Specify both the port through which you want to access the web console and the volume and folder in which you want to install the web console files. Note: If you specify any port other than 80, you must include that port in the URL used to access the web console. For example, if you specify an IP address of 192.168.0.3 and port 8080, the URL used to access the web console is http://192.168.0.3:8080. 13. Click Next. 14. If you are prompted to create a new directory, click Yes.
Requirements and Installation 51
15. If you are prompted to create a new website, click Yes. Note: Choosing to overwrite the existing website will not result in the deletion of any custom SolarWinds SAM website settings you may have previously applied. 16. Confirm that all services you want to install are checked, and then click Next. 17. Review the final configuration items, and then click Next. 18. Click Next on the Completing the SolarWinds Configuration Wizard dialog. 19. Click Finish when the SolarWinds Configuration Wizard completes. 20. Log in to the SolarWinds Web Console as an administrator. Note: By default, you can log in with User Name Admin and no password. 21. If you have not discovered your network devices and added them to the SolarWinds database, the Network Discovery Wizard starts.
To add the specified URLs to your trusted sites list, click the Add button in the Internet Explorer dialog. For more information about adding sites to your trusted sites list, see the Microsoft article, Working with Internet Explorer Security Settings.
Licensing
The SolarWinds SAM license you purchase is based on the number of allowed assigned component monitors. A component monitor provides a statistic that you want to monitor in SolarWinds SAM. You can have as many application templates and assigned monitors as you need, as long as the number of assigned component monitors does not exceed the license count. If you have more assigned component monitors than allowed by your license, the monitors that exceed your license limit are not activated, and their component statuses are changed to "Not Licensed." You can either disable some assigned component monitors to reduce your total assigned monitor count, or contact SolarWinds about upgrading your SolarWinds SAM license. Note: SolarWinds SAM licenses do not have to mirror the license count of any other installed SolarWinds product. For example, you can install SolarWinds SAM with a 50 component license on a SolarWinds NPM server with an unlimited node license. To see the available component monitors remaining in your license: 1. Log on to the SolarWinds Web Console with an administrator account. 2. Click Applications. 3. Click SAM Settings. 4. Click SAM License Summary.
Requirements and Installation 53
Note: As an alternative to the previous procedure, you can also click License Details in the Settings page to view the used and available component monitors.
Chapter 3
Deciding What to Monitor The Intranet server is in your server room. To make sure only employees can access the Intranet web site, the web site is secured using basic HTTP authentication (htpasswd) that requires them to log on using a user name and password. You decide to monitor this server using the HTTP template and the valid credentials: user name "admin" and password "password. The corporate web server is hosted and managed by a web hosting company. You can monitor the web site with the HTTP Template, but because you do not have direct control over the server hardware, you will add the server to the SolarWinds database as an external node. Monitoring the Intranet Home Page We need to add the Intranet web server to the SolarWinds database, and then assign the SolarWinds SAM HTTP template to the web server. 1. Log on to the SolarWinds Web Console. 2. Click Applications if not already selected.
3. Add the Intranet web server to the SolarWinds database. a. Click Add a Node. b. Type the Hostname or IP Address of the Intranet web server. c. Check the ICMP (Ping only) check box, select the appropriate Polling Engine (if applicable), and then click Next. d. In the Add Application Monitors page, click Next. Note: If you wish to add an Application Monitor to the node, you may do so either here or from the Application Settings as described elsewhere in this guide. e. In the Change Properties page, click Ok, Add Node. 4. Assign the HTTP template to the Intranet web server node. a. Click Applications if not already selected. b. Click SAM Settings. c. Click Manually Assign Application Monitors. d. Select Web Server in the Show only list. e. Select HTTP, and then click Next. f. Expand the categories and locate your Intranet web server node, select it, and then click Next.
g. Select <New Credential> in the Choose Credential list. h. Type Intranet Admin in the Credential Name field. i. j. Type admin in the User Name field. Type password in the Password and Confirm Password fields. If the test fails, see Troubleshooting the HTTP Template.
k. Click Test. l.
m. Click Assign Application Monitors. n. Click Done. Monitoring the Corporate Home Page We need to add the corporate web server to the SolarWinds database as an external node, and then assign the HTTP template to the web server. 1. Log on to the SolarWinds Web Console. 2. Click Applications if not already selected.
3. Add the corporate web server to the SolarWinds database as an external node. a. Click Add a Node. b. Type the Hostname or IP Address of the corporate web server. c. Check the External check box, select the appropriate Polling Engine (if applicable), and then click Next. 4. Assign the HTTP template to the corporate web server node. a. Select Web Server in the Show only list. b. Select HTTP. c. Select Inherit credentials from template and then click Test. d. If the test fails, see Troubleshooting the HTTP Template. e. Click Next. f. Enter the Name for your corporate web server.
g. Click Ok, Add Node. Troubleshooting the HTTP Template If the web site requires a user name and password, verify that you are entering a working user name and password. If the SolarWinds SAM server must connect to the Internet through a web proxy: 1. Click Assign Application Monitors even though the test failed. 2. Click Edit. 3. Click [+] to expand the HTTP Monitor component. 4. Click Override Template next to Use Proxy. 5. Check the Use Proxy check box. 6. Click Override Template next to Proxy Address. 7. Type the proxy address in the Proxy Address field using the syntax
http://proxyaddress
Deciding What to Monitor You suspect that the disk systems on a few of these servers need to be upgraded to RAID or something similar to increase the speed. You know that monitoring the disk queue length for each system would tell you whether there is an I/O bottleneck. You decide to apply the Windows Server 2003-2008 template to these servers because it includes a built-in Disk Queue Length monitor. Monitoring the Windows 2003 Servers We need to add the server nodes to the SolarWinds database, assign the Windows Server 2003-2008 template to the server nodes, and then adjust the warning threshold of the template's Disk Queue Length component to >2. This will make SolarWinds SAM send us a warning if the Disk Queue Length of any server is greater than 2. The Windows 2003 servers occupy the IP address range 192.168.1.120 to 192.168.1.127. We could add each server to the SolarWinds database one at a time, but it is easier to add the entire IP range using SolarWinds Network Discovery.
1. Log on to the SolarWinds Web Console. 2. Add the Windows 2003 servers to the SolarWinds database. a. Click Settings. b. Click Network Sonar Discovery. c. Click Add New Discovery. d. Click Next. e. Click Next. f. Enter 192.168.1.120 as the Start address, 192.168.1.127 as the End address, and then click Next.
g. Click Next to save the discovery settings. h. Click Discover to begin the discovery process. The Discovering Network dialog is displayed. i. j. Click Next on each page until you reach the IMPORT PREVIEW page. When you reach the IMPORT PREVIEW page, click Import.
k. When you reach the RESULTS page, click Finish. 3. Assign the Windows 2003-2008 template to your Windows 2003 server nodes. a. Click Applications if not already selected. b. Click SAM Settings. c. Click Manually Assign Application Monitors. d. Select Windows in the Show only list. e. Select Windows Server 2003-2008, and then click Next. f. Browse to your Windows 2003 nodes, select all of them, and then click Next.
g. Enter sysadmin in the Credential Name field. h. Enter your administrator user name in the User Name field. i. j. Enter your password in the Password and Confirm Password fields. Click Test.
k. If the test fails, see Troubleshooting the Windows 2003-2008 Template. l. Click Assign Application Monitors, and then click Done.
4. Change the Disk Queue Length warning threshold of the Windows 20032008 template to >2. a. Click SAM Settings. b. Click Manage Templates. c. Select Windows in the tag group column. d. Check the Windows Server 2003-2008 check box. e. Click Edit. f. Click + to expand the Disk Queue Length group.
g. Enter greater than 2 for the Statistic Warning Threshold, and then click Submit. Troubleshooting the Windows 2003-2008 Template. Verify that you are entering the user name and password of an administratorlevel account. If you think you have entered an incorrect credential, correct the mistake and then retest. Verify that the monitored server allows remote WMI connections. Consult the WMI Troubleshooting Guide if you are unsure whether the monitored server allows remote WMI connections. The guide is available from: http://www.solarwinds.com/support/apm/docs/APMWMITroubleshooting.pdf For information about troubleshooting the Windows performance counters, refer to the KB article How can I troubleshoot SolarWinds SAM performance monitoring and Windows performance counters?: http://knowledgebase.solarwinds.com/kb/questions/2139
Deciding What to Monitor Internet Information Services 6.0 runs each application pool in a new instance of wp3w.exe. Monitoring the five w3wp.exe instances individually will let you see which web site is using the most system resources. You can then make a more informed decision as to which web site you should move to the new server. Note: w3wp.exe is running only if there are HTTP requests made to a server. To keep w3wp.exe running if no HTTP requests are made to that server, add an HTTP Monitor to the same application. The HTTP Monitor will then check the same website and generate HTTP requests, thereby keeping w3wp.exe running.
What needs to be monitored: Five instances of w3wp.exe, differentiated by application pool. SolarWinds SAM can monitor them separately if you specify the application pool names in the component monitors. 1. Log on to the SolarWinds Web Console. 2. Click Applications if not already selected. 3. Add the web server to the SolarWinds database. a. Click Add a Node. b. Type the hostname or IP address of the Intranet web server. c. Check the ICMP (Ping only) check box and then click Next. d. In the Add Application Monitors page, click Next. e. In the Change Properties page, Click Ok, Add Node. 4. Find the wp3w.exe process on the web server. a. Click Applications if not already selected. b. Click SAM Settings. c. Click Browse for Component Monitor. d. Select Process Monitor WMI as the monitor type, and then click Next. e. Click Browse, select the web server, and then click Select. f. Enter WebServerAdmin in the Credential Name field.
g. Enter your administrator user name in the User Name field. h. Enter your password in the Password and Confirm Password fields. i. j. Click Next. Wait for the process list to load.
k. Click the last page button to view the last page. l. Check the check box next to w3wp.exe, and then click Next.
m. Change Monitor Name to Webpool1. n. Enter webpool1 in the Command Line Filter field. o. Change the CPU Warning Threshold to greater than 40. p. Change the CPU Critical Threshold to greater than 50.
q. Click Add Another Component. r. Repeat steps d through q, changing the Monitor Name and Command Line Filter fields appropriately for the four remaining webpool filters.
s. After creating the monitors for all five w3wp.exe instances, click Next. t. Select New Application Monitor.
u. Type Web Server Application Pools as the Application Monitor Name, and then click Next. v. Select the web server node, and then click Next. w. Review the list of component monitors to create, and then click Ok, Create.
What needs to be monitored: You decide to scan for Windows and IIS because you have the Windows administrator password to access many computers on the network and you have a hunch at least a few of them are running IIS. All the computers in your network are already in the SolarWinds database, so there is no need to add them. The administrator user name and passwords are: User Name: WAREHOUSE\Administrator Password: H0merSamps0n User Name: IT\Administrator Password: FourLights 1. Log on to the SolarWinds Web Console. 2. Click Applications if not already selected. 3. Click SAM Settings.
4. Click Scan Nodes for Applications. 5. Select nodes: a. Click [+] to expand the node groups. b. Select the nodes you want to scan, and then click Next. 6. Select applications to find. a. Uncheck all applications except: Internet Information Services Windows Server 2003-2008. b. Click Next. 7. Enter the credentials for the servers you are scanning: a. Click Add Credential. b. Type Warehouse Admin in the Credential Name field. c. Type WAREHOUSE\Administrator in the User Name field. d. Type H0merSamps0n in both the Password and Confirm Password fields. e. Click Submit. f. Click Add Credential.
g. Type IT Admin in the Credential Name field. h. Type IT\Administrator in the User Name field. i. j. Type FourLights in the both the Password and Confirm Password fields. Click Submit.
k. Click Next. 8. Click Start Scan. 9. Click View SAM Summary Page. 10. Click View results (near the top of the page) after the SAM scan is complete. 11. Review the results of the scan.
4. Click Next then select Web Pages from the drop-down menu.
5. Check Web Link and select Inherit credentials from Template. Click Test and then click Next.
6. On the Change Properties page, review properties you wish to change and then click, OK, Add Node. 7. Navigate to the Node Details page to review the results. To do this, click the Home tab then drill down to your specific node in the All Nodes resource.
Choosing Multiple systems will provide more generic counters that can be applied to multiple systems. Note: This option provides only aggregate performance counters (without instances). Therefore the Application Monitor or template created based on them can be considered as generic and assigned to different ESX/vCenter target hosts. In this case, monitors in the application or template created will contain the special ${VMWARE_ENTITY_NAME} variable in the Entity Name field of the monitor. When the monitor runs, this variable will be resolved to the first available Entity on a target host with the desired Entity Type (for example, the first Host System). 12. Select the desired VMware Entity Type to monitor: Cluster Compute Resource (only available if the VMware vCenter Performance Counter Monitor type is selected in step 5) Data object that aggregates the computation resources of its associated Host System objects into one single computation resource for use by virtual machines. The cluster services such as HA (High Availability), DRS (Distributed Resource Scheduling), and EVC (Enhanced vMotion Compatibility), enhance the usefulness of this single computation resource. This Entity Type is specific to vCenter systems. Host System Managed object type that provides access to a virtualization host platform. Resource Pool Represents a set of physical resources which may be a single host, a subset of a host's resources, or resources spanning multiple hosts. You can subdivide Resource pools by creating child resource pools. In order to run, a virtual machine must be associated as a child of a resource pool. In a parent/child hierarchy of resource pools and virtual machines, the root resource pool is the single resource pool that has no parent pool. Virtual Machine Managed object type for manipulating virtual machines, including templates that can be repeatedly deployed as new virtual machines. This object type provides methods for configuring and controlling a virtual machine.
13. If you selected the A single system option in step 11, select the desired VMware Entity to monitor. 14. Select the desired Performance Object (group) to monitor. For example, if you want to monitor CPU counters, select CPU. 15. Select the check boxes next to the counters to monitor for the selected Performance Object. Note: To select all the counters listed, select the check box next to Counter. The selected counters are listed in the Selected items list with a red X next to
70 Common Tasks with SolarWinds SAM
each one. To delete an item, click the red X next to the item and it will be removed from the list. 16. If you want to select counters from an additional Performance Object, select the next Performance object and then add the desired counters for it. 17. When you are finished selecting counters, click Next. 18. If you selected the A single system option in step 11, select the desired counter instances to monitor: a. Use the Group By dropdown to display the counters for a particular Performance Object, or select All Counters. b. Click the name of the desired counter to choose its instances. c. Select the check box(es) next to the desired instance(s) to monitor. Note: To select all the instances listed, select the check box next to Instance Name. The selected instances are then displayed in the Selected items list with a red X next to each one. To delete an item, click the red X next to the item and it will be removed from the list. d. When you are finished selecting counter instances, click Next. 19. The Edit Properties page is displayed with the component monitors that have been created for each of your selected counters or counters/instances. Here you can modify settings such as the Monitor Name, which defaults to the counter name that was selected. This is only a descriptive label, and can be modified as desired. If you chose the Multiple systems option in step 11, you can see the special ${VMWARE_ENTITY_NAME} variable in the Entity Name field of the monitor. When the monitor runs, this variable will be resolved to the first available Entity on a target host with the desired Entity Type (for example, the first Host System). You also need to configure your warning and critical thresholds for response time and statistic. 20. When you are finished editing monitor properties, click Next. 21. The Add to Application Monitor or Template page is displayed with the Component list collapsed. Click + next to Component list to expand the list of counters or counters/instances to be added. 22. Select New Application Monitor. Then enter a name for the new Application Monitor, for example: VMware Disk and CPU Monitor. You can change the name of the Application Monitor up to and including step 25.
Common Tasks with SolarWinds SAM 71
23. If you selected the Multiple systems option in step 11, expand the list of nodes and select the nodes to monitor. Only VMware ESX and vCenter nodes are displayed. 24. Click Next. 25. Click Ok, Create. 26. Click View SAM Summary Page. 27. Your new VMware monitor appears in the tree view for the All Applications resource. The polling results for the new monitor are updated after a few minutes.
9. If suitable credentials do not exist, choose <New Credential> from the Choose Credential list, and then add the new credential by filling out the credential details. 10. Click Next. 11. Browse the list of services and check the boxes for the services to monitor. 12. Adjust thresholds as desired. 13. Click Next. 14. Ensure that New Application Monitor Template Name is selected and then enter a name for your new template, for example CustomWindowsServices. 15. Click Next. 16. Select the boxes for the desired nodes to monitor and click Next. 17. Click Ok, Create to create the assigned Application Monitor. To create an alert that restarts any stopped Windows services and sends an email: 1. Click Start > All Programs > SolarWinds Orion > Alerting, Reporting, and Mapping > Advanced Alert Manager. 2. Click Configure Alerts. 3. Scroll to the bottom of the list in the Manage Alerts dialog, and check the box for Restart a service. 4. If you would also like to send an e-mail notification for the service restart: a. Highlight Restart a service and click Edit. b. Select the Trigger Actions tab and then click Add New Action. c. Select Send an E-Mail / Page and click Ok. d. Complete the e-mail info and click Ok. e. Click Ok. 5. Click Done. For more information about restarting Windows services with an alert action, see Restarting Windows Services with an Alert Action on page 318.
16. Click the Field asterisk, and then select Historical Daily Component Availability > Component > ComponentAvailability. 17. On the line for Component Availability, click the function asterisk and then select Average. 18. Click Preview to run the SQL query and view the report data in the Preview window. 19. Click Design in the toolbar to return to design mode. 20. Click the Field Formatting tab. 21. Select DateTime from the field list. 22. Change the Column Header entry to Date/Time. 23. Select Application_Name from the field list. 24. Change the Column Header entry to Application Name. 25. Select Component_Name from the field list. 26. Change the Column Header entry to Component Name. 27. Select Average_of_ComponentAvailability from the field list. 28. Change the Column Header entry to Average Component Availability. Note: Column widths are adjustable. To change a column width, place your cursor on the column divider and drag it to a different position. 29. Click Preview to run the SQL query and view the report data in the Preview window. 30. Click Design in the toolbar to return to design mode. 31. Click the Select Fields tab. 32. Click the sort asterisk on the Component Availability field line, and then select descending. 33. Click Preview to run the SQL query and view the report data in the Preview window. 34. Click Design in the toolbar to return to design mode. 35. Click the Time Frame tab. 36. Select Relative Time Frame, type 7 in the text field, and then select Days from the list. 37. If you want to break down the report day-by-day, click the Summarization tab and specify your choices. 38. If you want to filter your report, click the Filter Results tab and specify filter rules.
Common Tasks with SolarWinds SAM 75
10. Select credentials with appropriate permissions to run the script on the SolarWinds SAM server, and that also has appropriate permissions to do whatever else the script requires. 11. Copy the following Visual Basic script to get the directory size into the Script Body field:
Dim folderPath
folderPath = WScript.Arguments(0)
WScript.Echo "Message: Folder " & folderPath & " is " & folder.Size & " bytes large" WScript.Echo "Statistic: " & folder.Size
The VB code does the following: a. Reads the first argument passed to the script (the UNC pathname for the directory to monitor) and stores it in folderPath. b. Creates the Scripting.FileSystemObject and stores it in fs. c. Gets the folder name from the saved command line argument and stores it in folder. d. Displays the message with the folder name and the folder size. e. Displays the statistic (folder size in bytes). Note: The script does no error checking, such as handling the case if the folder does not exist. 12. Type the UNC pathname for the directory name to monitor into the Script Arguments field. You can use the token ${IP} and the IP address will be filled in with the IP address of the target node to which the monitor is assigned when the Windows Script monitor runs. For example, if you type the following UNC pathname for the directory name in the Script Arguments:
\\${IP}\c$\my_large_directory
the VBscript will get the size of the directory c:\my_large_directory on the
Common Tasks with SolarWinds SAM 77
node to which the Windows Script monitor is assigned. 13. Specify the critical and warning thresholds appropriately based on the desired directory size. 14. Click Submit. 15. Create an assigned Application Monitor by assigning the Large Directory Monitor template to the desired node to monitor. a. Click the Applications tab. b. Click SAM Settings. c. Click Manually Assign Application Monitors underneath Getting Started with SAM. d. Select All in the Show only list. e. Click Large Directory Monitor and then Next. f. Click Manually Assign Application Monitors underneath Getting Started with SAM.
g. Select All in the Show only list. h. Click Large Directory Monitor and then click Next. i. j. Browse to the desired node to monitor, select it, and then click Next. Enter itadmin in the Credential Name field.
k. Enter your administrator user name in the User Name field. l. Enter your password in the Password and Confirm Password fields.
m. Click Test. n. If the test fails, see Troubleshooting the Large Directory Monitor. o. Click Assign Application Monitors, and then click Done. Troubleshooting the Large Directory Monitor Verify that you are entering the user name and password of an administratorlevel account. If you think you have entered an incorrect credential, correct the mistake and then retest. If you made a mistake with the spelling of the directory name, correct it and then retest.
Chapter 4
To manage the SolarWinds Web Console, navigate to the Settings page: 1. Log on to your SolarWinds Web Console with an Administrator account. Note: Initially, Admin is the default administrator user ID with a blank password. You can change the password later using the Account Manager. For more information, see "Managing Accounts" on page 187. 2. Click Settings near the top right of the SolarWinds Web Console to display the Settings page. Refer to the sections that follow for details about the administrative commands available in each category: Getting Started with SolarWinds Discovery Central Network Sonar Discovery
Add a Node Node & Group Management Manage Nodes Virtulaization Settings Manage Dependencies Manage Groups Accounts Manage Accounts Account List Customize Customize Menu Bars Color Scheme External Websites Manage Alerts Manage Advanced Alerts Product Updates Available Product Updates Orion Product Team Blog Views Manage Views Add New View Views by Device Type Views by Application Type Settings Web Console Settings Polling Settings SAM Settings Orion Thresholds Virtualization Thresholds Details
Discovery Central
Click Discovery Central on the Settings page to view a centralized overview of the types and number of network objects you are monitoring with your currently installed SolarWinds products. Refer to Discovering and Adding Nodes on a Network on page 157.
Add a Node
Click Add a Node on the Settings page to add a single device to your SolarWinds SAM. For more information, see "Adding Nodes for Monitoring" on page 92.
Manage Nodes
Click Manage Nodes on the Settings page to add, view, and manage all nodes and resources managed or monitored by your SolarWinds SAM installation. For more information, see "Managing Nodes from the Web Console" on page 91.
Virtualization Settings
Click Virtualization Settings on the Settings page to open the Virtualization Settings view. Here you can view a list of currently monitored VMware ESX Servers, VMware credentials, as well as Hyper-V information. For more information, refer to Virtualization on page 209.
Manage Dependencies
Click Manage Dependencies on the Settings page to manage dependencies for your SolarWinds SAM. For more information, see "Managing Groups and Dependencies" on page 177.
Manage Groups
Click Manage Groups on the Settings page to manage groups for your SolarWinds SAM. For more information, see "Managing Groups and Dependencies" on page 177.
Accounts
The Accounts category gives you access to the commands for managing accounts, permissions, and views. Refer to the following sections for more information: Manage Accounts Account List
Manage Accounts
Click Manage Accounts on the Settings page to manage user accounts, permissions, and views. For more information, see "Managing Accounts" on page 187.
Account List
Click Account List on the Settings page to open the SolarWinds Website Accounts view, providing an immediate overview of web console user account settings. You may use this view to make changes to multiple accounts simultaneously and immediately by clicking to check or clear options. Clicking an Account user name opens the Account Manager for the selected account. For more information, see "Managing Accounts" on page 187.
Customize
The Customize category provides commands to customize the navigation and appearance of your SolarWinds Web Console. Refer to the following sections for more information: Customize Menu Bars Color Scheme External Websites
Color Scheme
Click Color Scheme on the Settings page to select a default color scheme for resource title bars. For more information, see "Changing the Web Console Color Scheme" on page 123.
External Websites
Click External Websites on the Settings page to designate any external website as a SolarWinds Web Console view, appearing in the Views toolbar. For more information, see "Creating and Editing External Website Views" on page 137.
Manage Alerts
The Manage Alerts category gives you access to the commands that allow you to edit, disable, enable, or delete currently configured advanced alerts. Refer to the following section for more information: Manage Advanced Alerts
1. Select the check box(es) for the alert(s) you want to delete. 2. Click Delete. 3. Click Yes to confirm the alert deletion. Creating New Alerts and Configuring Advanced Alerting Options To create new alerts or configure advanced alerting options: Click Start > All Programs > SolarWinds Orion > Alerting, Reporting and Mapping > Advanced Alert Manager. For information about creating and configuring alerts using the Advanced Alert Manager, see Creating Alerts on page 305.
Product Updates
The Product Updates category provides commands to get up-to-date information about using and upgrading SolarWinds SAM. Refer to the following sections for more information: Available Product Updates SolarWinds Product Team Blog
Views
The Views category gives you access to the commands that allow you to manage individual web console views as well as views for device and application types. Refer to the following section for more information: Manage Views
Add New View Views by Device Type Views by Application Type Customizing Views
Manage Views
Click Manage Views on the Settings page to add, edit, copy, or remove individual web console views. For more information see Customizing Views" on page 108.
Settings
The Settings category gives you access to the commands that allow you to manage configuration settings for the Web Console, polling, SAM, and thresholds. Refer to the following sections for more information: Web Console Settings SAM Settings SolarWinds Thresholds
Managing the Web Console 87
Virtualization Thresholds
Polling Settings
Click Polling Settings on the Settings page to define the configuration of polling intervals, timeouts, statistics calculations, and database retention settings for your SolarWinds SAM polling engine. For more information, see "SolarWinds Polling Settings" on page 202.
SAM Settings
Click SAM Settings on the Settings page to configure SolarWinds SAM and its templates and component monitors. For more information refer to Configuring SolarWinds SAM on page 149.
SolarWinds Thresholds
Click SolarWinds Thresholds on the Settings page to configure SolarWinds SAM threshold settings. For more information, see "SolarWinds General Thresholds" on page 106.
Virtualization Thresholds
Click Virtualization Thresholds on the Settings page to configure SolarWinds SAM virtual threshold settings for VMware and Hyper-V objects. For more information, see "SolarWinds General Thresholds" on page 106.
Details
The Details category gives you access to the commands that allow you to view configuration details for the database, polling engines, licenses, and modules. Refer to the following sections for more information: Database Details
Database Details
Click Database Details on the Settings page to display details about the SQL Server database currently used. For more information, see "Data and Database Settings" on page 153.
Polling Engines
Click Polling Engines on the Settings page to show the status and selected configuration information for each currently operational polling engine. For more information, see "Managing SolarWinds SAM Polling Engines" on page 201.
License Details
Click License Details on the Settings page to display details about both your SolarWinds SAM license and your monitored network. This page also shows the version of the applications that you are running and the versions of associated DLLs.
3. Select a criterion from the menu, and then click Submit. Note: All items in the customized list will be identical for the selected criterion. Disabling Web Console Breadcrumbs To ensure access is appropriately restricted for account-limited users, you may want to disable breadcrumbs, as indicated in the following procedure. To disable web console breadcrumb navigation: 1. Log on to your SolarWinds server using an account with administrative access. 2. Open web.config (default location C:\Inetpub\SolarWinds\) for editing. 3. In the <appsettings> section, locate the following setting:
<add key=DisableBreadCrumbs value=false/>
5. Save web.config. Note: If you run the Configuration Wizard after editing this setting, your changes may be overwritten.
Note: The Node Management feature is accessible by clicking Manage Nodes either in the header of any All Nodes resource or in the Node & Group Management grouping of the Website Administration page. The All Nodes resource is included on the SolarWinds Summary Home view by default, but you can include it on any other web console view as well. Confirm that the All Nodes resource is available on an appropriate Web Console view before continuing. For more information about adding resources to SolarWinds Web Console views, see Editing Views on page 109. Refer to the following sections for more information: Adding Nodes for Monitoring Deleting Nodes from Monitoring Viewing Node Data in Tooltips Editing Node Properties Promoting a Node from ICMP to SNMP Monitoring Viewing Node Resources Setting Node Management States Unscheduled Node Polling and Rediscovery Monitoring Windows Server Memory Scheduling a Node Maintenance Mode Time Period
7. If you only want to use ICMP to monitor node status, response time, or packet loss for the added node, check ICMP (Ping only). 8. If you want to add an External node to monitor a hosted application with SolarWinds Server & Application Monitor, select No Status: External Node. Note: The External status is reserved for nodes hosting applications that are to be monitored with SolarWinds Server & Application Monitor. SolarWinds SAM will not collect or monitor any data about a node itself, if it is marked as External. 9. If you want to monitor Windows Servers using WMI and ICMP, select Windows Servers: WMI and ICMP. 10. If you are adding a VMware device, check Poll for VMware to ensure that SolarWinds SAM acquires any data the VMware device provides to SNMP polling requests, and then complete the following steps to provide required vCenter or ESX Server credentials. For more information, see Virtualization" on page 209. a. Select an appropriate vCenter or ESX credential. Notes: If you are creating a new credential, select <New Credential>. If you are editing an existing credential, select the credential you want to edit. SolarWinds recommends against using non-alphanumeric characters in VMware credential names.
b. If you are creating a new credential, provide a Credential name. c. Provide an appropriate User name and a Password, and then provide the password again in the Confirm password field. d. Click Test to confirm the VMware credentials you have provided. 11. If you want to use SNMP and ICMP to monitor the added node, complete the following steps: a. Select the Most Devices and the SNMP Version for the added node. Notes: SolarWinds uses SNMPv2c by default. If the device you are adding supports or requires the enhanced security features of SNMPv3, select SNMPv3. If SNMPv2c is enabled on a device you want SolarWinds SAM to monitor, by default, SolarWinds SAM will attempt to use SNMPv2c to poll for performance information. If you only want SolarWinds SAM to poll using SNMPv1, you must disable SNMPv2c on the device to be polled.
Managing the Web Console 93
b. If you have installed multiple polling engines, select the Polling Engine you want to use to collect statistics from the added node. Note: This option may not be available if you are only using one polling engine to collect information from your network. c. If the SNMP port on the added node is not the SolarWinds default of 161, provide the actual port number in the SNMP Port field. d. If the added node supports 64-bit counters and you want to use them, check Allow 64-bit counters. Note: SolarWinds fully supports the use of 64-bit counters; however, these high capacity counters can exhibit erratic behavior depending on manufacturer implementation. If you notice peculiar results when using these counters, use the Node Details view to disable the use of 64-bit counters for the device and contact the hardware manufacturer. 12. If you want SolarWinds to use SNMPv2c to monitor the added node, provide valid community strings for the added node. Note: The Read/Write Community String is optional, but SolarWinds does require the public Community String at a minimum, for node monitoring. If you want to use read/write SNMPv3 credentials, complete the following steps in the Read / Write SNMPv3 Credentials area. 13. If you want SolarWinds to use SNMPv3 to monitor the added node, provide the following SNMP Credentials, Authentication, and Privacy/Encryption settings: SNMPv3 Username, Context, Authentication Method, and Password. Note: If this password is a key, check Password is a key. SNMPv3 Privacy/Encryption Method and Password. Note: If this password is a key, check Password is a key. 14. If you want to save the provided credentials as a Credential Set in the Credential Set Library, provide a Name, and then click Save. 15. If you want to delete a currently saved credential set, select the set to delete, and then click Save. 16. If you are using SNMP to communicate with your added node, click Validate SNMP after entering all credentials to confirm your SNMP settings. 17. Click Next. 18. Check the objects for the added node that you want SolarWinds to monitor or manage. The following options are available in the Selection toolbar: Clicking All selects all listed devices for monitoring. Clicking None clears any checked devices.
94 Managing the Web Console
Clicking All Volumes selects all listed volumes for monitoring. 19. After you have selected objects for monitoring, click Next. 20. If you want to edit the SNMP settings you provided earlier, change the appropriate values in the SNMP area of the Change Properties page, and then click Validate SNMP to confirm your new settings. 21. If you want to edit the default polling settings for your added node, change the Node Status Polling or Collect Statistics Every values in the Polling area of the Change Properties page, as appropriate. Note: The Node Status Polling value refers to the number of seconds, between the node status checks that SolarWinds performs on the added node. The Collect Statistics Every value refers to the period of time between updates SolarWinds makes to display statistics for the added node. 22. If you have defined any custom properties for a monitored node, provide appropriate values for the added node in the Custom Properties area of the Change Properties page. Note: The Custom Properties area is empty if you have not defined any custom properties for monitored network objects. 23. Click Ok, Add Node when you have completed properties configuration. 24. If you have successfully added the node, click Ok on the dialog.
4. Locate the node to delete using either of the following methods: Use the search tool above the node list to search your SolarWinds database for the node you want to delete. Select an appropriate Group by: criterion, and then click the appropriate group including the node to delete. 5. Check the node to delete in the list, and then click Delete on the toolbar.
9. If you want to poll for ESX data using a new ESX credential, complete the following steps: a. Select <New Credential> in the Choose Credential dropdown menu, and then provide a new credential name in the Credential Name field. Note: SolarWinds recommends against using non-alphanumeric characters in VMware credential names. b. Add the credential User name and Password, as necessary. c. Confirm the password and then click Validate VMware to confirm the credentials you have provided are valid for the edited node. 10. Edit additional device properties as needed, and then click Submit.
collect information from your network. 7. If the SNMP port on the added node is not the SolarWinds default of 161, provide the actual port number in the SNMP Port field. 8. If the added node supports 64 bit counters and you want to use them, check Allow 64 bit counters. Note: SolarWinds fully supports the use of 64-bit counters; however, these high capacity counters can exhibit erratic behavior depending how they are used. If you notice peculiar results when using these counters, use the Edit Properties view to disable the use of 64-bit counters on the device in question, and then contact the hardware manufacturer. 9. If you want to use SNMPv2c to monitor the promoted node, provide valid community strings for the added node. Note: The Read/Write Community String is optional, but SolarWinds does require the public Community String, at minimum, for node monitoring. 10. If you want to use SNMPv3 to monitor the promoted node, provide the following SNMPv3 credential settings: SNMPv3 User name and Context SNMPv3 Authentication Method and Password/Key SNMPv3 Privacy/Encryption Method and Password/Key Note: Read/Write SNMPv3 Credentials are optional, but the public Community String is required, at a minimum, for node monitoring. 11. If you want to edit an existing SNMPv3 credential set, select the name of your set from the Saved Credential Sets list, and then edit the stored settings. 12. If you want save the provided SNMPv3 credentials as a credential set, provide a Name for your new credential set, and then click Save. 13. Click Validate SNMP after entering all required credentials to confirm your SNMP settings. 14. If you want to change the default polling settings for your promoted node, edit the Node Status Polling or Collect Statistics Every values in the Polling area, as appropriate. Note: The Node Status Polling value refers to the period of time, in seconds, between the node status checks SolarWinds performs on the promoted node. The Collect Statistics Every value refers to the period of time between updates SolarWinds makes to displayed statistics for the promoted node. 15. If you have defined any custom properties for monitored nodes, provide appropriate values for the promoted node in the Custom Properties.
Managing the Web Console 99
16. Click Submit when you have completed properties configuration for your promoted node. 17. If you have successfully added the node, click Ok on the dialog.
4. Locate the node to manage using either of the following methods: Use the search tool above the node list to search your SolarWinds database for the device you want to manage. Select an appropriate Group by criteria, and then click the appropriate group including the node to manage. 5. Check the node to change, and then click Unmanage or Remanage, as appropriate, for the selected node. 6. If you have selected Unmanage, provide start and end times and dates for your management suspension, and then click Ok.
Depending upon how many components are in a given template, and the type of component monitors that make up a template, it is not unusual for polling to take several minutes for the process to fully complete. To see this behavior, click Edit Application Monitor on the Application Details page and then click Test All.
3. Click Manage Accounts in the Accounts grouping of the SolarWinds Website Administration page. 4. Select the user account with the password you want to change, and then click Change Password. 5. Complete the New Password and Confirm Password fields, and then click Change Password. 6. Click Continue when the password is successfully changed.3
If Method 2 is selected, SolarWinds SAM will intentionally skip a poll if a polled 64 value is less than the previous polled value to permit counting to 2 . SolarWinds fully supports the use of 64-bit counters; however, these 64-bit counters can exhibit erratic behavior in some implementations. If you notice peculiar results when using these counters, disable the use of 64-bit counters for the problem device and contact the device manufacturer. 4. If you are using of 32-bit counters, select Method 1 in the Counter Rollover field in the Calculations & Thresholds area. Note: If Method 1 is selected, when a rollover is detected, the time between polls 32 is calculated as (2 Last Polled Value) + Current Polled Value.
Percent Memory Used Monitored network devices experiencing a percent memory usage higher than the value set for the Error Level display in High Percent Utilization reports and resources. Gauges for these devices also display as bold red. Monitored network devices experiencing a percent memory usage higher than the value set for the Warning Level, but lower than the value set for the Error Level, display in High Percent Utilization reports and resources. Gauges for these devices also display as red. Percent Packet Loss Monitored network devices experiencing a percent packet loss higher than the value set for the Error Level display in High Percent Loss reports and resources. Gauges for these devices also display as bold red. Monitored network devices experiencing a percent packet loss higher than the value set for the Warning Level, but lower than the value set for the Error Level, display in High Percent Loss reports and resources. Gauges for these devices also display as red. SolarWinds SAM calculates percent packet loss using ICMP ping requests made on the Default Poll Interval. SolarWinds pings monitored devices and records the results of the ten most recent ping attempts. Percent packet loss is expressed as the number of failed ping requests, X, divided by the number of ping requests, 10. For more information about the Default Poll Interval, see Orion Polling Settings on page 202. For example, if, at a given point in time, the last ten ping requests made of a selected device resulted in 2 failures and 8 successes, the percent packet loss for the selected device at the given time is reported as 2/10, or 20%. Response Time Monitored devices experiencing response times longer than the value set for the Error Level display in High Response Time reports and resources. Gauges for these devices also display as bold red. Devices experiencing response times longer than the value set for the Warning Level, but shorter than the value set for the Error Level, also display in High Response Time reports and resources. Gauges for these devices also display as red. SolarWinds SAM calculates response time using ICMP ping requests made on the Default Node Poll Interval. SolarWinds pings monitored devices and records the results of the ten most recent ping attempts. Average Response Time is expressed as the average response time of these last 10 ping requests. If SolarWinds SAM does not receive a ping response within the Default Poll Interval, SolarWinds SAM will attempt to ping the nonresponsive device once every 10 seconds for the period designated as the Warning Interval. For more information, see Orion Polling Settings on page 202.
Managing the Web Console 107
Customizing Views
SolarWinds Web Console views are configurable presentations of network information that can include maps, charts, summary lists, reports, events, and links to other resources. Customized views can then be assigned to menu bars. Note: In environments where security is a priority, SolarWinds recommends against providing a view where users may change their own web console account passwords. Refer to the following sections for more information: Creating New Views Editing Views Configuring View Limitations Copying Views Deleting Views Views by Device Type Resource Configuration Examples Customizing Web Console Menu Bars Changing the Web Console Color Scheme Changing the Web Console Site Logo Configuring the Available Product Updates View Updating your SolarWinds Installation
108 Managing the Web Console
Customizing Charts in the SolarWinds Web Console Custom Node Charts Custom Volume Charts Custom Chart View Custom Volume Charts
Editing Views
The SolarWinds Web Console allows administrators to configure views for individual users. The following steps are required to configure an existing view. To edit an existing view: 1. Click Settings in the top right of the web console. 2. Click Manage Views in the Views group of the SolarWinds Website Administration page.
Managing the Web Console 109
3. Select the view you want to customize from the list, and then click Edit. 4. If you want to change the column layout of your view, complete the following steps. a. Click Edit to the right of the column widths. b. Select the number of columns under Layout. c. Provide the width, in pixels, of each column in the appropriate fields, and then click Submit. 5. If you want to add a resource, repeat the following steps for each resource: Notes: Resources already in your view will not be checked on this page listing all web console resources. It is, therefore, possible to pick duplicates of resources you are already viewing. Some resources may require additional configuration. For more information, see Resource Configuration Examples on page 113. Several options on the Add Resources page are added to the list of resources for a page, but the actual configuration of a given map, link, or code is not added until the page is previewed. a. Click + next to the column in which you want to add a resource. b. Click + next to a resource group on the Add Resources page to expand the resource group, displaying available resources. c. Check all resources you want to add. d. If you have completed the addition of resources to the selected view, click Submit. 6. If you want to delete a resource from a column, select the resource, and then click X next to the resource column to delete the selected resource. 7. If you want to copy a resource in a column, select the resource, and then click next to the resource column to delete the selected resource. 8. If you want to rearrange the order in which resources appear in your view, select resources, and then use the arrow keys to rearrange them. 9. If you have finished configuring your view, click Preview. Note: A preview of your custom web console displays in a new window. A message may display in the place of some resources if information for the resource has not been polled yet. For more information, see Resource Configuration Examples on page 113. 10. Close the preview window.
11. When done, click Done. Notes: For more information about adding a customized view to menu bars as a custom item, see Customizing Web Console Menu Bars on page 122. For more information about assigning your customized view as the default view for a user, see Editing User Accounts on page 188.
To enable a view limitation: 1. Click Settings in the top right of the web console, and then click Manage Views in the Views group of the SolarWinds Website Administration page. 2. Select the view to which you want to add a limitation, and the click Edit. 3. In the View Limitation area of the Customize View page, click Edit. 4. Select the type of view limitation you want to apply, and then click Continue. 5. Provide or check appropriate strings or options to define the device types to include or exclude from the selected view, and then click Submit. Note: The asterisk (*) is a valid wildcard. Pattern limitations restrict views to devices for which the corresponding fields include the provided string.
Copying Views
When you want to create multiple views based on the same device type, copying views allows you to create one view, and then use that view as a template to create other new views. The following steps copy an existing view. To copy a view: 1. Click Settings in the top right of the web console. 2. Click Manage Views in the Views group. 3. Select the view you want to copy, and then click Copy. 4. If you want to edit a copied view, follow the procedure in the Editing Views section on page 109.
Deleting Views
The following steps delete an existing view. To delete an existing view: 1. Click Settings in the top right of the web console. 2. Click Manage Views in the Views grouping of the SolarWinds Website Administration page. 3. Select the view you want to delete, and then click Delete.
view for each unique type of device you have on your network, including routers, firewalls, and servers. The following steps assign a view by any available device type. To assign a view by device type: 1. Click Settings in the top right of the web console, and then click Views by Device Type in the Views group of the SolarWinds Website Administration page. 2. Select available Web Views for the different types of devices that SolarWinds is currently monitoring or managing on your network. 3. Click Submit.
Note: Titles and subtitles may be entered as either text or HTML. 9. Select from the list of available maps. 10. Select the Scale at which you want to display the map. Note: If you leave the Scale field blank, the map will display at full scale, based on the size of the column in which the map displays. 11. Click Submit. Displaying a List of Objects on a Network Map When your web console view includes a network map, it can be helpful to maintain a list of network objects that appear on the map. The following procedure enables a resource listing network map objects. Note: Clicking the resource title displays the resource in a new browser window. To display a list of network map objects: 1. Create a new view or edit an existing view. Note: For more information, see Customizing Views on page 108. 2. Select the view to display the list of network map objects, and then click Edit. 3. Click + next to the view column in which you want to display the new list of network map objects. 4. Click + next to Network Maps, check List of Objects on Network Map, and then click Submit. 5. Click Preview on the Customize YourView page. 6. Click Edit in the title bar of the List of Objects on Network Map resource. 7. If you do not want to use the default title provided, enter a new Title for the header of the objects list. 8. If you want a subtitle, enter a new Subtitle for the added objects list. Note: Titles and subtitles may be entered as either text or HTML. 9. Select from the list of available maps for the objects that you want to populate your list, and then click Submit. Displaying a Custom List of Maps The web console allows you to populate a custom view with a list of available network maps. Each map in your custom list, when clicked, opens in a new window. The following procedure enables a custom network maps list resource. Note: Clicking the resource title displays the resource in its own browser window.
To display a custom list of maps: 1. Create a new view or edit an existing view. Note: For more information, see Customizing Views on page 108. 2. Select the view to which you want to add the custom list of network maps, and then click Edit. 3. Click + next to the view column in which you want to display the custom list of network maps. 4. Click + next to Network Maps. 5. Check Custom List of Maps, and then click Submit. 6. Click Preview on the Customize YourView page, and then click Edit in the title bar of the Custom List of Maps resource. 7. If you do not want to use the default title provided, enter a new Title for the header of the maps list. 8. If you want a subtitle, enter a new Subtitle for the custom list of maps. Note: Titles and subtitles may be entered as either text or HTML. 9. Check the maps you want to include in your maps list. 10. Click Submit. Displaying an Event Summary - Custom Period of Time You may want your web console view to display an event summary for a specified period of time. The following procedure details the steps to include an event summary in your web console. Note: Clicking the resource title in the title bar menu displays the resource by itself in a browser window. To display an event summary: 1. Create a new view or edit an existing view. Note: For more information about creating a new view or editing an existing view, see Customizing Views on page 108. 2. Select the view to include the event summary, and then click Edit. 3. Click + next to the view column that will display the event summary. 4. Click + next to Events. 5. Check Event Summary Custom Time Period, and then click Submit. 6. Click Preview on the Customize YourView page.
7. Click Edit in the title bar of the Event Summary resource. 8. If you do not want to use the default title provided, enter a new Title for the header of the event summary. Note: Titles may be entered as either text or HTML. 9. Select the time period for displaying events from Display Events for the following Time Period. 10. Click Submit. Specifying User-Defined Links The User-Defined Links option may be used to create quick access to external websites or customized views. URLs of your customized views can be copied from their preview pages and pasted in a User-Defined Links field. The following steps enable user-defined links from within your web console. Note: Clicking the resource title in the title bar menu displays the resource by itself in a browser window. To enable a user-defined links resource: 1. Create a new view or edit an existing view. Note: For more information, see Customizing Views on page 108. 2. Select the view to which you want to add the user-defined links resource. 3. Click Edit. 4. Click + next to the view column to display the user-defined links resource. 5. Click + next to Miscellaneous 6. Check User Defined Links. 7. Click Submit. 8. Click Preview on the Customize YourView page. 9. Click Edit in the title bar of the User Defined Links resource. 10. If you do not want to use the default title provided, enter a new Title for the links list.
11. If you want a subtitle, enter a new Subtitle for the links list. Note: Titles and subtitles may be entered as either text or HTML. 12. Enter the following information for each link you want to define: a. A link Name and the URL of your link. b. If you want your links to open in a new browser window, check Open in New Window. 13. Click Submit. Specifying Custom HTML or Text In situations where you have static information that you want to provide in the web console, use the Custom HTML or Text option. The Custom HTML or Text option may also be used to create quick access to your customized views. The following procedure will create a static content area within your web console for displaying text or HTML content. Note: Clicking the resource title displays the resource in a new browser window. To specify custom HTML or text: 1. Create a new view or edit an existing view. Note: For more information, see Customizing Views on page 108. 2. Select the view to include the custom HTML or text. 3. Click Edit. 4. Click + next to the column to display the custom HTML or text. 5. Click + next to Miscellaneous, and then check Custom HTML or Text. 6. Click Submit. 7. Click Preview on the Customize YourView page. 8. Click Edit in the title bar of the Custom HTML or Text resource. 9. If you do not want to use the default title provided, enter a new Title for the specified content area. 10. If you want a subtitle, enter a new Subtitle for the specified content area. Note: Titles and subtitles may be entered as either text or HTML. 11. Enter content as either text or HTML into the Raw HTML field. 12. Click Submit.
Specifying a SolarWinds Report The web console is able to incorporate reports that you have created in SolarWinds Report Writer into any view. The following procedure will take a report that you have created with Report Writer and include it within a web console view. Note: Clicking the resource title in the title bar menu displays the resource by itself in a browser window. To include a SolarWinds report: 1. Create a new view or edit an existing view. Note: For more information, see Customizing Views on page 108. 2. Select the view to which you want to add the report. 3. Click Edit. 4. Click + next to the view column in which you want to display the report. 5. Click + next to Report Writer. 6. Check Report from SolarWinds Report Writer. 7. Click Submit. 8. Click Preview on the Customize YourView page. 9. Click Edit in the title bar of the Report from SolarWinds Report Writer resource. 10. If you do not want to use the default title provided, enter a new Title for the included report. 11. If you want a subtitle, enter a new Subtitle for the included report. Note: Titles and subtitles may be entered as either text or HTML. 12. Select a Report to include. 13. If you want to add a filter to the included report, enter an appropriate query in the Filter Nodes field. Note: Filter Nodes is an optional, advanced, web console feature that requires some knowledge of SQL queries. Click + next to Show Filter Examples to view a few example filters. 14. Click Submit. Displaying a Custom List of Reports The web console allows you to populate a custom view with a custom reports list. When clicked from the list, each report opens in a new window. The following procedure details the steps required to enable a custom list of network reports.
118 Managing the Web Console
Note: Clicking the resource title displays the resource in a new browser window. To display a custom list of reports: 1. Create a new view or edit an existing view. For more information, see Customizing Views on page 108. 2. Select the view to which you want to add the custom list of reports, and then click Edit. 3. Click + next to the column to display the custom list of reports. 4. Click + next to Report Writer. 5. Check Custom List of Reports, and then click Submit. 6. Click Preview on the Customize YourView page, and then click Edit in the title bar of the Report from SolarWinds Report Writer resource. 7. If you do not want to use the default title provided, enter a new Title for the header of the reports list. 8. If you want a subtitle, enter a new Subtitle for the custom list of reports. Note: Titles and subtitles may be entered as either text or HTML. 9. Check the reports that you want to include in your custom list of reports. Note: To allow a user to view a report included in the custom list, you must set the report access for the account. For more information, see Configuring an Account Report Folder on page 197. 10. Click Submit. Filtering Nodes Your SolarWinds Web Console can maintain a customizable node list for your network. Node lists may be configured for specific views using SQL query filters. The following steps set up node filtering for node lists included in web console views. Note: Clicking the resource title displays the resource in a new browser window. To enable filtering on a node list: 1. Create a new view or edit an existing view. Note: For more information, see Customizing Views on page 108. 2. Select the view to which you want to add the node list 3. Click Edit. 4. Click + next to the view column in which you want to display the node list.
5. Click + next to Node Lists. 6. Check All Nodes Table, and then click Submit. 7. Click Preview on the Customize YourView page, and then 8. Click Edit in the title bar of the All Nodes Table resource. 9. If you do not want to use the default title provided, enter a new Title for the node list. 10. If you want a subtitle, enter a new Subtitle for the node list. Note: Titles and subtitles may be entered as either text or HTML. 11. If you want to filter your node list by text or IP address range, provide the text or IP address range by which you want to filter your node list in the Filter Text field, as shown in the following examples: Type Home in the Filter Text field to list all nodes with Home in the node name or as a location. Type 192.168.1.* in the Filter Text field to list all nodes in the 192.168.1.0-255 IP address range. 12. Select the property that is appropriate to the filter text provided above, as shown in the following examples: If you typed Home in the Filter Text area, select Node Name or Location to list nodes with Home in the node name or as a location. If you typed 192.168.1.* in the Filter Text area, select IP Address to list only nodes in the 192.168.1.0-255 IP address range. 13. If you want to apply a SQL filter to the node list, enter an appropriate query in the Filter Nodes (SQL) field. Notes: Filter Nodes (SQL) is an optional, advanced, web console feature that requires some knowledge of SQL queries. Click + next to Show Filter Examples to view a few example filters. By default, node list resources are designed to sort nodes alphabetically by node caption. This configuration cannot be overwritten using a SQL filter, so order by clauses included in SQL filters are redundant and will result in Custom SQL filter formatting errors. 14. Click Submit.
Grouping Nodes Your SolarWinds Web Console can maintain a customizable node list for your network. Node lists may be configured for specific views with node grouping. The following steps set up node grouping for node lists included in web console views. Note: Clicking the resource title in the title bar menu displays the resource by itself in a browser window. To enable grouping on a node list: 1. Create a new view or edit an existing view. Note: For more information, see Customizing Views on page 108. 2. Select the view to which you want to add the node list, and then click Edit. 3. Click + next to the view column in which you want to display the node list. 4. Click + next to Node Lists. 5. Check an appropriate node list, and then click Submit. 6. Click Preview on the Customize YourView page. 7. Click Edit in the title bar of the All Nodes Tree (AJAX) resource. 8. If you do not want to use the default title provided, enter a new Title for the node list. 9. If you want a subtitle, enter a new Subtitle for the node list. Note: Titles and subtitles may be entered as either text or HTML. 10. Select up to three criteria, in specified levels, for Grouping Nodes within your web console view. 11. If you want to apply a SQL filter to the node list, enter an appropriate query in the Filter Nodes field. Notes: Filter Nodes (SQL) is an optional, advanced, web console feature that requires some knowledge of SQL queries. Click + next to Show Filter Examples to view a few example filters. By default, node list resources are designed to sort nodes alphabetically by node caption. This configuration cannot be overwritten using a SQL filter, so order by clauses included in SQL filters are redundant and will result in Custom SQL filter formatting errors. 12. Click Submit.
Hover over any view title to read a view description. Selected items display from left to right in the new menu bar as they are listed from top to bottom. If you check Reports from the Select Menu Items page, you must also enable reports for the accounts that use the menu bar. For more information, see Configuring an Account Report Folder on page 197. 6. If you want to add a custom menu item, complete the following steps: a. Click Edit under the menu bar to which you are adding the custom item. b. Click Add. c. Provide the Name, URL, and Description of your custom menu item. d. If you want the menu option to open in a new window, check Open in a New Window. e. Click Ok. 7. If you want to delete a menu item, click and drag the item to delete from the Selected items list on the right to the Available items list on the left. Warning: Do not delete the Admin option from the Admin menu bar. 8. If you want to change the location of an item in your menu, click and drag items to move them up and down in the Selected items list. 9. If you have finished editing your menu bar, click Submit.
1. Create an appropriately sized graphic to replace the SolarWinds logo. Notes: The SolarWinds banner file is 271x48 pixels at 200 pixels/inch. The SolarWinds.com End User License Agreement prohibits the modification, elimination, or replacement of either the SolarWinds.com logo and link on the menu bar or the SolarWinds copyright line at the bottom of the page. 2. Place your graphic in the images directory. Note: By default, it is in C:\Inetpub\SolarWinds\NetPerfMon\. 3. Log in to the web console as an administrator. 4. Click Settings in the top right of the web console. 5. Click Web Console Settings in the Settings grouping of the SolarWinds Website Administration page. 6. Type the new logo image name as a replacement for SolarWinds.Logo.jpg in the Site Logo URL field.
Select a Chart allows you to change the chart type displayed in the current resource. Chart options are determined in accordance with the type of view displaying the resource you are currently editing. For more information about available node charts, see Custom Node Charts on page 126. For more information about available volume charts, see Custom Volume Charts on page 128. The Time Period for the selected chart may be any of the following:
Last Hour Yesterday Last 30 Days Last 2 Hours Last 7 Days Last 3 Months Last 24 Hours This Month This Year Today Last Month Last 12 Months
The Sample Interval for the selected chart may be any of the following:
Every Minute Every 30 Minutes Every 12 Hours Every 5 Minutes Every Hour One a Day Every 10 Minutes Every 2 Hours Every 7 Days Every 15 Minutes Every 6 Hours
Notes: Each sample interval is represented on a chart by a single point or bar. Data within a selected sample interval is summarized automatically. Due to limits of memory allocation, some combinations of time periods and sample intervals require too many system resources to display, due to the large number of polled data points. As a result, charts may not display if the time period is too long or if the sample interval is too small. The Trend Line option allows you to enable the trend line feature of SolarWinds SAM charts. By enabling trend lines on SolarWinds SAM charts, you can see potential future results as they are extrapolated from collected historical data. Note: Due to the broad array of factors that can affect the performance of devices on your network, trend lines provided on SolarWinds SAM charts are intended as approximate predictions of future data only. For more information, th see "95 Percentile Calculations" on page 469.
Availability The following charts are available to display node availability information over custom time periods for nodes monitored by SolarWinds. Availability Availability Autoscale Availability and Response Time CPU Load The following charts display CPU loading information over specified periods of time for nodes monitored by SolarWinds. Average CPU Load Min/Max/Average CPU Load Memory Usage The following charts present memory usage information over custom time periods for nodes monitored by SolarWinds. Average Memory Usage Memory/Buffer Failures Min/Max/Average Memory Usage Percent Memory Used Packet Loss and Response Time The following charts are available to display historical statistics about packet loss and response time for nodes monitored by SolarWinds. Availability and Response Time Average Response Time Average Response Time and Packet Loss
Min/Max/Average Response Time Min/Max/Average Response Time and Packet Loss Percent Loss Bar Chart Percent Loss Line Chart
Chart Titles Chart Titles are displayed at the top center of a generated chart. The Chart Titles area allows you to modify the Title and Subtitles of your generated chart. Note: SolarWinds may provide default chart titles and subtitles. If you edit any of the Chart Titles fields on the Custom Chart page, you can restore the default titles and subtitles by clearing the respective fields, and then clicking Submit. Time Period Predefined and custom time periods are available for generated charts. You may designate the time period for a chart by either of the following methods: Select a predefined period from the Select a Time Period: menu. Provide custom Beginning and Ending Dates/Times in the appropriate fields in the Time Period area. Sample Interval The sample interval dictates the precision of a given chart. A single point or bar is plotted for each sample interval. If a sample interval spans multiple polls, data is automatically summarized and plotted as a single point or bar on the chart. Note: Due to limits of memory allocation and the large number of polled data points, some combinations of time periods and sample intervals may require too many system resources to display. As a result, charts may not display if the time period is too long or if the sample interval is too small. Chart Size Chart Size options configure the width and height, in pixels, of the chart. You can maintain the same width/height aspect ratio, or scale the chart in size, by entering a width in the Width field and then entering 0 for the Height. Font Size Font sizes for generated charts are variable. The Font Size option allows you to select a Small, Medium, or Large size font for your chart labels and text. Note: Font Size selections are maintained in the printable version of your chart. Data Export Options The Display Data from Chart area provides the following options to export chart data as either Excel-compatible Raw Data or as HTML-formatted Chart Data: To view chart data in an Excel-compatible format, click Raw Data, and then follow the prompts, if provided, to open or save the resulting raw data file. To view HTML-formatted chart data in a new browser, click Chart Data.
Managing the Web Console 129
To add the Multiple Object Chart to your home page, take the following steps: 1. Click the Home tab to get to the Summary view. 2. Click Customize Page on the far top right of the page. 3. Click the green [+] to the right of where you want to add this chart. 4. From the Add Resources to SolarWinds Home Summary page, select and expand Multiple Series Charts. 5. Check Multiple Object Chart, and then click Submit, and then click Done. To configure the Multiple Object Chart, take the following steps:
130 Managing the Web Console
1. Once the chart is on your Home Summary page, click Edit at the top right of the chart. 2. From this page, you can have multiple options to choose from, including: i) ii) Title: This allows you to change the title of your chart. Subtitle: This allows you to add a subtitle to your chart.
iii) Choose Objects: This allows you to choose the type of objects to display from the dropdown menu provided. You can remove an object from the list by clicking the red X to its right. iv) Select a Chart: This allows you to chart various aspects of what you intend to monitor. v) Choose Objects: Click the Select SolarWinds Object button to choose which objects you want charted based on your selection in step iii. vi) Limit Series: Checking this box and setting the number of series will limit the number of items displayed on the chart to the specified amount. vii) Show Sum in Data Series: This allows you to chart the total of the other objects graphed and is represented by its own plot line. viii) Time Period: This allows you to set the range displayed on the chart. ix) Sample Interval: This allows you to set the interval that this chart is updated.
4. Navigate to an appropriate location, provide an appropriate file name, and then click Save.
Clicking on Show More will expand the resource to fill a separate screen. Note: If Show More is clicked, the time shown in the new screen will show UTC time. The original resource view will maintain local time Clicking on any message in this resource will bring up the entire message that was created in the event log, as shown below:
Alerts with this resource can be used with the complete message text of events. For more information see, "Other Syslog Variables" on page 487. This collection of detailed data is enabled by default. To disable this, navigate to the event log monitor component, as shown below:
Charts from an earlier version of SAM will be renamed to have the prefix "Legacy" once the tree is expanded.
Adding the Chart: 1. Navigate to the Component Details page or the Application Details page. 2. Click Customize Page. 3. Click the [+] in either column. 4. Expand the tree view as shown below: Note The highlighted green charts are the newly implemented charts.
5. Select the charts you want, and then click Submit. 6. Click Done. Customizing the Chart This chart can be customized to view the following data by clicking the Edit button at the top-right of the chart. The available data to this chart are as follows: CPU Load Physical Memory Virtual Memory Response Time Statistic Data
Clicking Edit also reveals several self-explanatory options. This resource is made up of three sections: the toolbar, the main chart, and the lower chart. This allows you to visualize the selected data by viewing the minimums, maximums, and averages of the data for a selected time period.
Zooming You can have the chart show a pre-determined time period of data by clicking on any one of the three Zoom buttons; 1 Day, 1 Week, or 1 Month, as highlighted in the following illustration. Alternatively, you can have the chart show a specific date range by typing in specific dates in the From and To fields, also highlighted. Once you have a time period selected, the lower chart will zoom to the starting and ending values of the selected time period. With the lower chart you can zoom in further by fine tuning the view with the sliders, highlighted above. The main view of the chart will display the selected time peiod between the two sliders of the lower chart. Moving the mouse over the main chart will reveal a tooltip with more detailed information about the specific time period the mouse is hovering over. By default, all statistics are shown in the main chart. You can add or remove any statistic from the chart by checking and unchecking any statistic from the legend at the lower left of the resource,
Clicking the chart itself, as opposed to the Edit button, will bring up additional, self-explanatory options.
a. If you have selected an alerts resource, indicate whether or not you want to display acknowledged alerts by checking or clearing Show Acknowledged Alerts, as appropriate. b. If you have selected a resource to which SQL filters may be applied, edit available SQL filters as appropriate. For more information, see Using Node Filters on page 146. c. If you have selected a resource with an Auto-Hide option, select Yes or No to enable or to disable the Auto-Hide feature, respectively. If enabled, the resource is automatically hidden if and when related data is not present in the SolarWinds database. d. If you have selected a sortable list resource, in the Sort By field select the property by which you want the list sorted. e. If you have selected a gauge-style resource, select a gauge Style and provide a Gauge Size. f. If you have selected a chart-style resource, select an appropriate Time Period and Sample Interval, and then indicate whether or not you want to show a Trend Line.
g. If you have selected a Universal Device Poller resource, select the Universal Device Poller and Chart Format, and then configure all other options as required for similar resource types. 8. Click Submit. Note: For more information about customizing available resource types, click Help in the header of any resource on the Custom Summary view, and then click the corresponding resource type.
5. If you want to edit an existing external website, click Edit next to the name of the website you want to edit. 6. Provide a Menu Title for the external website to display in the Views toolbar. 7. If you want to include a heading within the view, provide an optional Page Title to display within the view. 8. Provide the URL of the external website, in http://domain_name format. 9. Select the Menu Bar to which you want to add the new external website link. Note: For more information about customizing menu bars, see Customizing Web Console Menu Bars on page 122. 10. Click Ok. 11. Click Preview to view the external website as the web console will display it.
Refer to the following sections for more information: Configuring a Toolset Integration Adding Programs to a Toolset Integration Menu
Note: These options expand the list of available menu items by incorporating menu links to MIB browser bookmarks and Real Time Interface Monitor saved reports, respectively.
Note: The string supplied for Title is the name for the added script or application that will display in the menu. The string supplied for the ExecString is the path to the script or application executable file. 6. Save the new SWToolset.MenuOptions to automatically update the Toolset Integration menu.
2. Select a Backup file from the list. 3. Choose either Merge or Overwrite for the restoration process. 4. Click Restore Backup.
configuration before you clear it to confirm that no issues arise as a result of the deletion of your web console customizations. To clear your SolarWinds Web Console configuration: 1. Locate and run the OrionWebBackup.exe utility, typically located at
C:\Program Files (x86)\SolarWinds\Orion.
2. Click File > Clear Web Configuration. 3. Click Yes to confirm the deletion of your current web console configuration.
2. If you want to enable automatic login for web console accounts using Windows Authentication, configure the SolarWinds Web Console as shown in the following steps: a. Click Start > All Programs > SolarWinds Orion > Configuration and Auto-Discovery > Configuration Wizard. b. Check Website, and then click Next. c. After providing the appropriate IP Address, Port, and Website Root Directory, select Yes Enable automatic login using Windows Authentication. d. Click Next, and then complete the Configuration Wizard. 3. Log in to the web console using the appropriate domain and user, providing Domain\Username or Username@Domain as the web console User name.
To remove the notification bar from your web console, click Close (X) at the right end of the notification bar.
Suppressing Events
There is no option within SAM to suppress event types from the web console; however, suppression can be accomplished by modifying the database directly. You can suppress specific events based on the event type. In order to do this, refer to the following screenshot and steps:
Suppressing Events 1. Open Microsoft SQL Server Management Studio. 2. Modify the dbo.Event types table. 3. Change the number in the Record column from 1 to 0 to suppress a specific event. Note: SAM supports event suppression for every SAM event type (event types from 500 to 532):
The following are a few example filters with associated SQL queries. Note: By default, node list resources are designed to sort nodes alphabetically by node caption. This configuration cannot be overwritten using a SQL filter, so order by clauses included in SQL filters are redundant and will result in Custom SQL filter formatting errors. Filter the results to only show nodes that are not Up:
Status<>1
the server to the Node is dropping packets) Only show Cisco devices: Vendor = 'Cisco' Only show devices in Atlanta. (using a custom property named City):
City = 'Atlanta'
Only show devices beginning with "AX3-": Caption Like 'AX3-*' Only show Nortel devices that are Down:
Vendor Like 'Nortel*' AND Status=2
Note: Depending on the security settings of your browser, you may be asked to install an ActiveX control for remote desktop viewing. Follow all prompts to install this required control. 3. Verify the Server IP address or hostname, select an appropriate Screen Size, and then click Connect.
Chapter 5
To configure SolarWinds SAM: 1. Log on to your SolarWinds Web Console with an Administrator account. Note: Initially, Admin is the default administrator user ID with a blank password. 2. Click the Applications tab. 3. Click SAM Settings. Refer to the sections that follow for details about the administrative commands available in each category: Getting Started with SAM Scan Nodes for Applications Manually Assign Application Monitors
SolarWinds SAM Settings 149
Browse for Component Monitor Application Monitors Manage Application Monitors Application Monitor Templates Manage Templates Create a New Template Component Monitors Component Monitor Library Manage Assigned Component Monitors Manage Component Monitors within Templates Application Detail Views Views by Application Type Global SAM Settings Credentials Library Data and Database Settings License Summary SAM License Summary thwack Community Shared thwack Templates SAM thwack Forum
For more information, see Scanning Nodes for Applications on page 237.
Application Monitors
The Application Monitors category gives you access to the commands that allow you to actively monitor nodes using a collection of component monitors to determine the overall health of applications. For more information, see Managing Assigned Application Monitors on page 249.
Manage Templates
Click Manage Templates on the SAM Settings page to edit, copy, export, import, and delete templates.
Component Monitors
Component monitors are the building blocks of SolarWinds SAM. This category gives you access to the commands that allow you to monitor the status and performance of different aspects of an application. Refer to the following sections for more information: Component Monitor Library Manage Assigned Component Monitors Manage Component Monitors within Templates
Credentials Library
Click Credentials Library on the SAM Settings page to create, edit, and delete the credential sets component monitors use to access protected system resources. For more information, see Understanding the Credentials Library on page 234.
Database Maintenance The amount of data collected in the database is dependent upon the size of the data collected as well as the number of applications and component monitors you define. Due to the volume of data collected, detailed statistics are stored in hourly averages after a specified time period (7 days, by default). Hourly statistics are compressed into daily statistics after a number of days (30 days, by default). Detailed statistics retention is based on the individual polling intervals for each component monitor. These settings allow you to set a length of time after which SolarWinds SAM purges data from the database. Note: Before modifying your database settings, consider noting your database size and amount of data collection for a week. When the week is complete, recheck your database size. This should help you forecast and plan for an appropriate data compression and retention period. To set the three Statistic Retention Intervals: 1. Log on to your SolarWinds Web Console with an Administrator account. Note: Initially, Admin is the default administrator user ID with a blank password. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Data and Database Settings. 5. Specify the appropriate values for the SolarWinds SAM data retention settings. Polling Engine Mode The polling engine mode specifies the behavior of both the main polling engine and any additional ones you may have. To set the Polling Engine Mode: 1. Log on to your SolarWinds Web Console with an Administrator account. Note: Initially, Admin is the default administrator user ID with a blank password. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Data and Database Settings. 5. Specify the appropriate value for the Polling Engine Mode: Local-OnlyOnly the main polling engine is used.
Poller-BoundEach node is polled by its assigned polling engine. Note: Changes in the Polling Engine Mode do not take effect until SAM is restarted. For more information, see "Managing the SolarWinds SAM Database" on page 439.
License Summary
The License Summary category gives you access to the command that allows you to view the license information summary. For more information, see "SAM License Summary" on page 155.
thwack Community
The thwack Community category gives you access to the commands that allow you to view and download useful information from the thwack community for SolarWinds users. Refer to the following sections for more information: Shared thwack Templates SAM thwack Forum
Chapter 6
Discovery Central
Discovery Central provides a centralized overview of the types and number of nodes you are monitoring. You can also access Network Discovery and Virtualization Discovery from within Discovery Central. To access Discovery Central: Click Settings at the top right of the SolarWinds Web Console. Then, click Discovery Central in the Getting Started with SolarWinds category. Note: Clicking Go to SolarWinds Home opens the SolarWinds Summary Home view for your entire monitored network. Refer to the following sections for more information:
Discovering and Adding Nodes on a Network 157
Virtualization Discovery
The Virtualization Discovery category displays information for both VMware and Hyper-V infrastructures on your network. To use virtualization discovery, click Network Sonar Discovery to discover multiple nodes or click Add A Single Device to add a single node. For more information, see Polling for VMware nodes Using the Network Sonar Wizard on page 217.
Application Discovery
SolarWinds SAM can scan nodes and automatically assign the Application Monitors it deems suitable for each scanned node. You control the nodes to be scanned, the application templates used in the scan, and the scanning parameters that determine a match. For more information, see "Application Discovery" on page 169.
To discover devices on your network from Discovery Central: 1. If the Network Sonar Wizard is not already open, click Start > All Programs > SolarWinds > Configuration and Auto-Discovery > Network Discovery. 2. Click Network Sonar Discovery.
3. If you want to create a new discovery, click Add New Discovery. 4. If you have already defined a network discovery, a number of options are available on the Network Sonar Discovery tab. Select one of the following: If you want to edit an existing discovery before using it, select the discovery you want to edit, and then click Edit. If you want to use an existing discovery to rediscover your network, select the discovery you want to use, click Discover Now, and then complete the Network Sonar Results Wizard after discovery completes. For more information about network discovery results, see Using the Network Sonar Results Wizard on page 165. If you want to import some or all devices found in a defined discovery that you may not have already imported for monitoring, select a currently defined discovery, and then click Import All Results. For more information about network discovery results, see Using the Network Sonar Results Wizard on page 165. If you want to import any newly enabled devices matching a defined discovery profile, select a currently defined discovery, and then click Import New Results. For more information about network discovery results, see Using the Network Sonar Results Wizard on page 165. If you want to delete an existing discovery profile, select a currently defined discovery and then click Delete. 5. If the devices on your network do not require community strings other than the default strings public and private provided, click Next on the SNMP Credentials view. 6. If any of your network devices require community strings other than public and private or if you want to use an SNMPv3 credential, complete the following steps to add the required SNMP credential. Note: Repeat the following procedure for each new community string. To speed up discovery, highlight the most commonly used community strings on your
Discovering and Adding Nodes on a Network 159
network, and then use the arrows to move them to the top of the list. a. Click Add New Credential, and then select the SNMP Version of your new credential. b. If you are adding an SNMPv1 or SNMPv2c credential, provide the new SNMP Community String. c. If you are adding an SNMPv3 credential, provide the following information for the new credential: User Name, Context, and Authentication Method Authentication Password/Key, Privacy/Encryption Method and Password/Key, if required. d. Click Add. 7. Click Next on the SNMP Credentials view.
8. If you want to discover any VMware VCenter or ESX Servers on your network, confirm that Poll for VMware is checked, and then complete the following steps to add or edit required VMware credentials. Note: Repeat the following procedure for each new credential. To speed up discovery, use the up arrow to move the most commonly used credentials on your network to the top of the list. a. Click Add vCenter or ESX Credential. b. If you are using an existing VMware credential, select the appropriate credential from the Choose Credential dropdown menu. c. If you are adding a new VMware credential, select <New Credential> in the Choose Credential dropdown menu, and then provide a new credential name in the Credential Name field. Note: SolarWinds recommends against using non-alphanumeric characters in VMware credential names. d. Add or edit the credential User Name and Password, as necessary.
160 Discovering and Adding Nodes on a Network
e. Confirm the password, and then click Add. 9. Click Next on the Local vCenter or ESX Credentials for VMware view.
10. If you want to discover devices located on your network within a specific range of IP addresses, complete the following procedure.
Note: Only one selection method may be used per defined discovery. a. Click IP Ranges in the Selection Method menu, and then, for each IP range, provide both a Start address and an End address. Note: Scheduled discovery profiles should not use IP address ranges that include nodes with dynamically assigned IP addresses (DHCP). b. If you want to add another range, click Add More, and then repeat the previous step. Note: If you have multiple ranges, click X to delete an incorrect range. c. If you have added all the IP ranges you want to poll, click Next.
11. If you want to discover devices connected to a specific router or on a specific subnet of your network, complete the following procedure: Note: Only one selection method may be used per defined discovery. a. Click Subnets in the Selection Method menu. b. If you want to discover on a specific subnet, click Add a New Subnet, provide both a Subnet Address and a Subnet Mask for the desired subnet, and then click Add. Note: Repeat this step for each additional subnet you want to poll. c. If you want to discover devices using a seed router, click Add a Seed Router, provide the IP address of the Router, and then click Add. Notes: Repeat this step for each additional seed router you want to use. Network Sonar reads the routing table of the designated router and offers to discover nodes on the Class A network (255.0.0.0 mask) containing the seed router and, if you are discovering devices for a SolarWinds SAM installation, the Class C networks (255.255.255.0 mask) containing all interfaces on the seed router, using the SNMP version chosen previously on the SNMP Credentials page. Networks connected through the seed router are NOT automatically selected for discovery. d. Confirm that all networks on which you want to conduct your network discovery are checked, and then click Next. 12. If you already know the IP addresses or hostnames of the devices you want to discover and include in the SolarWinds database, complete the following procedure: a. Click Specific Nodes in the Selection Method menu. b. Type the IPv4 or IPv6 addresses or hostnames of the devices you want to discover for monitoring into the provided field. Note: Type only one address or hostname per line. c. Click Validate to confirm that the provided addresses and hostnames are assigned to SNMP-enabled devices. d. If you have provided all the addresses and hostnames you want to discover, click Next.
13. Configure the options on the Discovery Settings view, as detailed in the following steps: a. Provide a Name and Description to distinguish the current discovery profile from other profiles you may use to discover other network areas.
Note: This Description displays next to the Name in the list of available network discovery configurations on the Network Sonar view. b. Position the slider or type a value, in ms, to set the SNMP Timeout. Note: If you are encountering numerous SNMP timeouts during Network Discovery, increase the value for this setting. The SNMP Timeout should be at least a little more than double the time it takes a packet to travel the longest route between devices on your network. c. Position the slider or type a value, in ms, to set the Search Timeout. Note: The Search Timeout is the amount of time Network Sonar Discovery waits to determine if a given IP address has a network device assigned to it. d. Position the slider or type a value to set the number of SNMP Retries. Note: This value is the number of times Network Sonar Discovery will retry a failed SNMP request, defined as any SNMP request that does not receive a response within the SNMP Timeout defined above. e. Position the slider or type a value to set the Hop Count. Note: If the Hop Count is greater than zero, Network Sonar Discovery searches for devices connected to any discovered device. Each connection to a discovered device counts as a hop.
f.
Position the slider or type a value to set the Discovery Timeout. Note: The Discovery Timeout is the amount of time, in minutes, Network Sonar Discovery is allowed to complete a network discovery. If a discovery takes longer than the Discovery Timeout value provided, the discovery is terminated.
14. If you only want to use SNMP to discover devices on your network, check Use SNMP only. Note: By default, Network Sonar uses ICMP ping requests to locate devices. Most information about monitored network objects is obtained using SNMP queries. 15. If multiple SolarWinds polling engines are available in your environment, select the Polling Engine you want to use for this discovery. 16. Click Next. 17. If you want the discovery you are currently defining to run on a regular schedule, select either Custom or Daily as the discovery Frequency, as shown in the following steps: Notes: Scheduled discovery profiles should not use IP address ranges that include nodes with dynamically assigned IP addresses (DHCP). Default Discovery Scheduling settings execute a single discovery of your network that starts immediately, once you click Discover. Results of scheduled discoveries are maintained on the Scheduled Discovery Results tab of Network Discovery. For more information about managing scheduled discovery results, see Managing Scheduled Discovery Results on page 166. a. If you want to define a custom discovery schedule to perform the currently defined discovery repeatedly in the future, select Custom and then provide the period of time, in hours, between discoveries. b. If you want your scheduled discovery to run once daily, select Daily, and then provide the time at which you want your discovery to run every day, using the format HH:MM AM/PM. 18. If you do not want to run your network discovery at this time, select No, dont run now, and then click Save or Schedule, depending on whether you have configured the discovery to run once or on a schedule, respectively.
19. If you want your Network Sonar discovery to run now, click Discover to start your network discovery.
Note: Because some devices may serve as both routers and switches, the total number of nodes discovered may be less than the sum of reported routers discovered plus reported switches discovered.
Note: If you are not sure if you want to monitor a specific device type, check the device type in question. Later, you can delete the device using Web Node Management. 2. On the Volume Types to Import page, check the volume types you want to monitor, and then click Next. Note: If you are not sure you want to monitor a specific volume type, check the volume type in question. Later, you can delete the volume of the selected type using Web Node Management. 3. If you want to import nodes, even when they are already known to be polled by another polling engine, check the option in the Allow Duplicate Nodes section. For more information about working with multiple polling engines, see Managing Orion Polling Engines on page 201. 4. If there are any devices on the Import Preview that you do not ever want to import, check the device to ignore, and then click Ignore. Selected nodes are added to the Discovery Ignore List. For more information, see Using the Discovery Ignore List on page 167. 5. Confirm that the network objects you want to monitor are checked on the Import Preview page, and then click Import. Note: Imported devices display in the All Nodes resource.
Select Ignored to view all devices you have added to your Discovery Ignore List. For more information about the Discovery Ignore List, see Using the Discovery Ignore List on page 167. Select Found and Changed to view a combined list of all devices found or changed as described above. Select All except Ignored to view all discovered, changed or imported devices you have not already designated as Ignored, as detailed above. 4. If you want to apply a grouping criterion to organize your listed results, select an appropriate criterion from the Group by menu in the left pane. 5. If there are changed or discovered nodes in the results list that you want to add to your SolarWinds database, check them and then click Import Nodes. 6. If there are devices you want SolarWinds SAM to ignore in future discoveries, regardless of discovered updates or changes, check the nodes to ignore, and then click Add to Ignore List. For more information about the Discovery Ignore List, see Using the Discovery Ignore List on page 167.
c. Click Remove from Ignore List. d. Confirm that you want to stop ignoring the selected items by clicking Ok. After the Network Sonar Wizard completes the node discovery and imports the results, you are taken directly to the Application Discovery Wizard to discover applications to monitor on the nodes. For more information, see "Application Discovery" on page 169.
Chapter 7
Application Discovery
SolarWinds SAM can scan nodes and automatically assign the Application Monitors it deems suitable for each scanned node. You control the nodes to be scanned, the application templates used in the scan, and the scanning parameters that determine a match. To access Application Discovery, click Settings at the top right of the SolarWinds Web Console. Now click Discovery Central in the Getting Started with SolarWinds category. In the Application Discovery category, click Discover Applications to begin using the wizard-like interface. For more information, see "Add Application Monitors" on page 170. Select Nodes Click [+] in the list to expand the node groups and to select the nodes you want to scan. When you are finished selecting nodes, click Next. Select Applications To keep the scanning time to a minimum, we recommend you initially scan for a limited number of application templates. To see more application templates, select a different template group from the Show Only list. To adjust the template assignment criteria, expand Advanced Scan Settings and move the slider to the desired setting: Exact Match All the components must match to assign the template. Strong Match Most of the components must match to assign the template. Partial Match Some of the components must match to assign the template. Minimal Match At least one component must match to assign the template. When you are finished selecting applications, click Next.
Application Discovery 169
Enter Credentials Some application templates require credentials either to access restricted resources, or to run within the context of a specific user. To scan for these templates, add the necessary credentials to the list. If a template you are scanning for requires credentials, the credentials in this list are tried in the order in which they appear. Warning: Credentials are tried several times over the course of a scan, so an incorrect password is likely to lock out an account. To avoid potential account lockouts that affect actual users, we recommend you create and use service accounts. A service account is an account created specifically for the purpose of providing credentials to use for SolarWinds monitoring. With service accounts, no actual user is affected by an account lockout if a password should be entered incorrectly. If you have domains sharing user names with different passwords, we recommend you run separate application discoveries for each domain. When you are finished entering credentials, click Next. Review and Start Scan Review the summary for the scan. If the automatic discovery matches templates that are already assigned to the node, by default the template is not assigned a second time. If you want to assign duplicate templates, select Yes, Assign Anyway from the Do you want to assign duplicates list. Click Start Scan to begin the scan. The scan runs in the background. If you like, click View progress near the light bulb icon toward the top of the page to view the progress of the scan. You are notified by a message near the top of the window when scanning is completed. Click View Results to see the results of the scan. Click View SAM Summary Page (or > SAM Application Summary) to display the SAM summary page. Add UX Monitors You cannot scan for user experience (UX) monitors, but you can assign them to nodes manually. Adding monitors from this page does not affect your scan.
To add Application Monitors on the Add Application Monitors page: 1. Use the Show Only list to select the desired category for the Application Monitors you want to add. 2. Check the check box next to the Application Monitor(s) you want to assign. 3. The selected Application Monitor(s) are added to the list of Selected applications. 4. If you change your mind and want to delete an application, click the red X next to the name of the application in the Selected applications list. 5. If suitable credentials already exist, choose the credential from the Choose Credential list. 6. If suitable credentials do not exist, choose <New Credential> from the Choose Credential list, and then add the new credential by filling out the credential details. 7. Click Test to test the credentials and component monitors against the test node. 8. If the test fails, troubleshoot the problem based on the error messages, and then retest the node. 9. Click Next. 10. On the Change Properties page, modify any of the information as needed, such as the Node Status Polling interval (in seconds) and the Collect Statistics Every frequency (in minutes). 11. Click Ok, Add Node.
The following statuses are depicted on the Application Health Overview: Application Up Assigned application monitors with all component monitors responding and operating within their thresholds. Application Critical Assigned application monitors with at least one component monitor operating past the critical threshold. Application Down Assigned application monitors with at least one unresponsive component monitor.
Application Warning Assigned application monitors with at least one component monitor operating past the warning threshold. Other Assigned application monitors that are suspended due to licensing restrictions. Unknown Assigned application monitors with status that cannot yet be determined.
Chapter 8
Creating Groups
Creating a group is a straightforward process of selecting the SolarWinds objects you want the group to contain. At creation time, you can also decide how you want SolarWinds to roll up the status of the group members. It is also possible to specify group members on the basis of shared properties by adding them with a dynamic query. SolarWinds objects added through dynamic queries are automatically added or removed from the group.
Refer to the following sections for more information: Editing Groups Managing Group Members Deleting Groups Managing the Display of Group Status
To create a new group: 1. Click Start > All Programs > SolarWinds > Orion Web Console. 2. Click Settings in the top right of the web console. 3. Click Manage Groups in the Node & Group Management grouping of the SolarWinds Website Administration page. 4. Click Add New Group. 5. Enter a name for the group in the Name field, and then expand Advanced. 6. If you want the group to roll up the worst status of the group members, select Show Worst Status. 7. If you want the group to roll up the best status of the group members, select Show Best Status. 8. If you want the group to display a warning status if the group members have a mixture of different statuses, select Mixed Status shows warning. 9. Click Next. 10. If you want to individually select group members, follow these steps: a. In the Show Only list, select the type of SolarWinds object you want to add as a group member. b. Check the checkbox of the SolarWinds object and then click Add to Group. 11. If you want to dynamically select group members based on shared properties, follow these steps: a. Click Add dynamic query. b. Type a name for the query in the Dynamic query object name field. c. Select a SolarWinds object type in the SolarWinds Object is list. d. Click Add Condition to specify further selection properties. Note: Use the question mark (?) character as a multiple character wildcard. Use the underscore (_) character as a single character wildcard.
178 Managing Groups and Dependencies
e. Click Preview to verify that the dynamic query is selecting your intended objects. f. Click Save.
12. Continue adding individual SolarWinds objects or dynamic queries until you have finished building your group. 13. Click Create Group.
Editing Groups
You can edit the properties of an existing group or add and remove objects. These are separate editing tasks. To edit properties of an existing group: 1. Click Start > All Programs > SolarWinds > Orion Web Console. 2. Click Settings in the top right of the web console. 3. Click Manage Groups in the Node & Group Management grouping of the SolarWinds Website Administration page. 4. Check the group you want to edit, and then click Edit Properties. 5. Edit the Name and Description of the selected group, as appropriate. 6. If you want to manage the members of the selected group, click Add & Remove Objects. For more information about managing group members, see Managing Group Members on page 179. Note: Expand the Contains summary for the selected group to see all member objects in the group. 7. If you want to configure the calculation of displayed group status or the frequency with which group status is refreshed, expand Advanced, select a Status rollup mode, and then provide a Refresh frequency. Note: For more information about status rollup for groups, see Managing the Display of Group Status on page 180. 8. Click Submit.
2. Click Settings in the top right of the web console, and then click Manage Groups in the Node & Group Management grouping of the SolarWinds Website Administration page. 3. Check the group you want to edit, and then click Add & Remove Objects.
Deleting Groups
Deleting an existing dependency is a straightforward process, as shown in the following procedure. To delete a group: 1. Click Start > All Programs > SolarWinds > Orion Web Console. 2. Click Settings in the top right of the web console, and then click Manage Groups in the Node & Group Management grouping of the SolarWinds Website Administration page. 3. Check the group you want to delete, and then click Delete.
Show Worst Status ensures that the worst status in a group of objects is displayed for the whole group. The following table indicates how the Show Worst Status option operates:
Object States (Up, Warning, Down) Group Status (Down)
Mixed Status shows Warning ensures that the status of a group displays the worst warning-type state in the group. If there are no warning-type states, but the group contains a mix of up and down states, then a Mixed Availability ( ) warning status is displayed for the whole group. The following table indicates how the Mixed Status shows Warning option operates:
Object States Group Status (Critical) (Critical) (Mixed Availability)
The following procedure configures the method used to determine group status. To configure the method used to determine the status of a selected group: 1. Click Start > All Programs > SolarWinds > SolarWinds Web Console. 2. Click Settings in the top right of the web console, and then click Manage Groups in the Node & Group Management grouping of the SolarWinds Website Administration page. 3. Check the group you want to edit, and then click Edit Properties. 4. Expand Advanced, and then select a Status rollup mode, as follows: a. If you want the group to roll up the worst status of the group members, select Show Worst Status. b. If you want the group to roll up the best status of the group members, select Show Best Status. c. If you want the group to display a warning status if the group members have a mixture of different statuses, select Mixed Status shows warning. 5. Click Submit.
Managing Dependencies
Dependencies in SolarWinds allow you to account for topological constraints on your network. These constraints may be either the result of the design of a specific device, or the result of the physical architecture of your network itself. SolarWinds offers an Unreachable status to account for the case when a device may appear to be down when its status is actually indeterminate, due to another device being down or unresponsive.
Managing Groups and Dependencies 181
Likewise, SolarWinds also makes it possible to define dependencies among distinct devices, as in the case of a subnet of devices on your network that depends on a single WAN link to connect with the rest of your network. In this case, if you have defined a group consisting of the devices in this dependent subnet, you can then define a dependency where the dependent subnet is a child group to the parent router that is serving as the WAN link to the rest of your network. For more information about groups, see Managing Groups and Dependencies" on page 177. The power of dependencies becomes evident when considering alerts. If you have an alert configured to trigger when a monitored object is down, you only want that alert to trigger if a monitored objects is positively down. In other words, you do not want an down object alert to trigger for an object that is not actually down. Without dependencies, all monitored objects on a monitored node that is unresponsive to ICMP queries will also report as down. With dependencies in use, these child objects will instead display as Unreachable, saving you the hassle of sorting through numerous false alerts resulting from the failure of a single node to respond promptly to a status query. Refer to the following sections for more information: Creating a Dependency Editing a Dependency Deleting a Dependency Viewing Alerts on Child Objects
Creating a Dependency
Creating a new dependency is a straightforward process of selecting the parent and children objects, as shown in the following procedure. To create a dependency: 1. Click Start > All Programs > SolarWinds > SolarWinds Web Console. 2. Click Settings in the top right of the web console, and then click Manage Dependencies in the Node & Group Management grouping of the SolarWinds Website Administration page. 3. Click Add new dependency. 4. On the Select Parent page, complete the following steps: a. Use the Show only: and Group by: selection fields to customize the list of displayed objects and groups. Note: The properties listed in the Group by selection field are dynamic.
182 Managing Groups and Dependencies
b. Select the parent object or group in the main pane, and then click Next. Note: If you want to define a dependency so that the reported states of child objects are dependent on the status of multiple parent objects, create a group including all parent objects, and then select it on this view. For more information, see Creating Groups on page 177. 5. On the Choose Child page, complete the following steps: a. Edit the Dependency name, as appropriate. b. Use the Show only: and Group by: selection fields to customize the list of displayed objects and groups. Note: Properties listed in the Group by: selection field are dynamically dependent on the selection in the Show only: field. c. Select the child object or group in the main pane, and then click Next. Note: If you want to define a dependency so that the reported states of multiple child objects are dependent on the status one or more parent objects, create a group including all child objects, and then select it on this view. For more information, see Creating Groups on page 177. 6. On the Review Dependency view, review the current settings for the configured dependency. Notes: If any advanced alerts are configured on parent or child objects, they will be listed on this view. Click + to expand alert details. In the event that a parent object is down, all alerts configured on any child objects in a dependency on the down parent object are automatically suppressed. 7. Click Submit to accept the dependency definition.
Editing a Dependency
Editing an existing dependency is a straightforward process, as shown in the following procedure. To edit an existing dependency: 1. Click Start > All Programs > SolarWinds > SolarWinds Web Console. 2. Click Settings in the top right of the web console, and then click Manage Dependencies in the Node & Group Management grouping of the SolarWinds Website Administration page. 3. Check the dependency you want to edit, and then click Edit.
4. On the Select Parent page, complete the following steps: a. Use the Show only: and Group by: selection fields to customize the list of displayed objects and groups. Note: Properties listed in the Group by: selection field are dynamically dependent on the selection in the Show only: field. b. Select the parent object or group in the main pane, and then click Next. Note: If you want to define a dependency so that the reported states of child objects are dependent on the status of multiple parent objects, create a group including all parent objects, and then select it on this view. For more information, see Creating Groups on page 177. 5. On the Choose Child page, complete the following steps: a. Edit the Dependency name, as appropriate. b. Use the Show only: and Group by: selection fields to customize the list of displayed objects and groups. Note: Properties listed in the Group by: selection field are dynamically dependent on the selection in the Show only: field. c. Select the child object or group in the main pane, and then click Next. Note: If you want to define a dependency so that the reported states of multiple child objects are dependent on the status one or more parent objects, create a group including all child objects, and then select it on this view. For more information, see Creating Groups on page 177. 6. On the Review Dependency view, review the current settings for the configured dependency. Notes: If any advanced alerts are configured on parent or child objects, they will be listed on this view. Click + to expand alert details. If a parent object is down, all alerts configured on any child objects in a dependency on the down parent object are automatically suppressed. 7. Click Submit to accept the dependency definition.
Deleting a Dependency
Deleting an existing dependency is a straightforward process, as shown in the following procedure. To delete an existing dependency: 1. Click Start > All Programs > SolarWinds > SolarWinds Web Console.
184 Managing Groups and Dependencies
2. Click Settings in the top right of the web console, and then click Manage Dependencies in the Node & Group Management grouping of the SolarWinds Website Administration page. 3. Check the dependency you want to delete, and then click Delete. 4. Click Yes to confirm deletion of the selected dependency.
Chapter 9
Managing Accounts
SolarWinds Web Console user accounts, permissions, and views are established and maintained with the SolarWinds Account Manager. When Advanced Customization is enabled on the SolarWinds Website Settings page, you can use Account Manager to customize menu bars and views for different users. For more information, see Customizing Views" on page 108. Notes: This guide assumes that Advanced Customization has been enabled. If it has not been enabled, the range of options available on the pages referenced in the following sections is much more limited. For more information, see Setting Account Limitations on page 192. To prevent issues with web console accounts, your SQL Server should not be configured with the no count connection option enabled. The no count option is set in the Default connection options area of the Server Properties > Connections window of SQL Server Management Studio Refer to the following sections for more information: Creating Accounts Editing User Accounts
Creating Accounts
New SolarWinds Web Console user accounts may be created by any web console administrator. The following procedure creates a new web console user account. To create a new user account: 1. Log in to the SolarWinds Web Console as an administrator. 2. Click Settings in the top right of the web console. 3. Click Manage Account in the Accounts grouping of the SolarWinds Website Administration page. 4. Click Add New Account. 5. Select the type of account you want to add, and then click Next.
6. If you selected SolarWinds individual account, complete the following steps: a. Provide a User Name and a Password for the SolarWinds individual account. b. Confirm the password, and then click Next. c. Define user settings and privileges, as appropriate. For more information, see Editing User Accounts on page 188. 7. If you selected Windows individual account, complete the following steps: a. Provide the User Name and Password for a user that has administrative access to your Active Directory or local domain. b. In the Search for Account area, enter the User name of the Active Directory or local domain user for whom you want to create a new web console account, and then click Search. c. In the Add Users area, select the users for whom you want to create new web console accounts, and then click Next. 8. If you selected Windows group account, complete the following steps: a. Provide the User Name and Password for a user that has administrative access to your Active Directory or local domain. b. In the Search for Account area, enter the Group name of the Active Directory or local domain group for which you want to create a new web console account, and then click Search. c. In the Add Users area, select the users for whom you want to create new web console accounts, and then click Next. When the new account is created, the Edit User Account view displays, showing all configurable account options. For more information about editing account settings, see Editing User Accounts on page 188.
The following sections and procedures detail the configuration of user accounts. Note: To reset a password, click Change Password at the bottom of the page. User Account Access Settings Setting Account Limitations Defining Pattern Limitations Setting Default Account Menu Bars and Views
9. If you want to allow the user to manage nodes directly from the SolarWinds Web Console, set Allow Node Management Rights to Yes. Note: By default, node management rights are not granted. For more information about node management in the SolarWinds Web Console, see Managing Nodes from the Web Console" on page 91. 10. If you want to allow the user to customize views, set Allow Account to Customize Views to Yes. Note: By default, customized view creation is not allowed. Changes made to a view are seen by all other users that have been assigned the same view. 11. Designate whether or not to Allow Account to Clear Events and Acknowledge Alerts. 12. Select whether or not to Allow Browser Integration. Note: Browser integration can provide additional functionality, including access to right-click menu options, depending on client browser capabilities. 13. If you want to enable audible alerts through the client browser, select a sound from the Alert Sound list. Note: By default, sounds are stored in the Sounds directory, located at C:\Inetpub\SolarWinds\NetPerfMon\Sounds. Sounds in .wav format that are added to this directory become available as soon as the Edit User Account page refreshes. 14. Provide the maximum Number of items in the breadcrumb list. Note: If this value is set to 0, all available items are shown in breadcrumb dropdown lists.
Following the initial alert sound, you will receive an audible alert every time an alert is encountered that was triggered later than the latest alert that has already been viewed. For example, a user logs in and sees a group of alerts with trigger times ranging from 9:01AM to 9:25AM, and the user receives an audible alert. If the user
Managing Accounts 191
browses to a new page or allows the current page to auto-refresh, a new alert sounds if and only if an alert triggered later than 9:25AM is then displayed. To enable audible web alerts: 1. Log in to the SolarWinds Web Console as an administrator. 2. Click Settings in the top right of the web console. 3. Click Manage Accounts in the Accounts grouping of the SolarWinds Website Administration page. 4. Select the account you want to configure. 5. Click Edit. 6. Select the sound file you want to play when new alerts arrive from the Alert Sound list. Note: By default, sounds are stored in the Sounds directory, located at C:\Inetpub\SolarWinds\NetPerfMon\Sounds. Sounds in .wav format that are added to this directory become available as soon as the Edit User Account page refreshes. 7. Click Submit.
To set user account limitations: 1. Log in to the SolarWinds Web Console as an administrator. 2. Click Settings in the top right of the web console, and then click Manage Accounts in the Accounts group of the SolarWinds Website Administration page. 3. If you want to limit an individual user account, complete the following steps: a. On the Individual Accounts tab, check the account you want to limit. b. Click Edit.
c. Click Add Limitation in the Account Limitations section. d. Select the type of limitation to apply, and then click Continue. Notes: Because SolarWinds NetFlow Traffic Analyzer (NTA) initially caches account limitations, it may take up to a minute for account limitations related to SolarWinds NTA to take effect in SolarWinds NTA. Account limitations defined using the Account Limitation Builder display as options on the Select Limitation page. Account limitations can be defined and set using almost any custom properties. For more information, see Creating Account Limitations on page 303. e. Define the limitation as directed on the Configure Limitation page that follows. For more information about defining pattern-type limitations, see Defining Pattern Limitations on page 194. 4. If you want to limit a group account, complete the following steps: Note: Limitations applied to a selected group account only apply to the group account and not, by extension, to the accounts of members of the group. a. On the Groups tab, check the group account you want to limit. b. Click Edit. c. Click Add Limitation in the Account Limitations section. d. Select the type of limitation to apply, and then click Continue. Notes: Because SolarWinds NetFlow Traffic Analyzer (NTA) initially caches account limitations, it may take up to a minute for account limitations related to SolarWinds NTA to take effect in SolarWinds NTA. Account limitations defined using the Account Limitation Builder display as options on the Select Limitation page. Account limitations can be defined and set using almost any custom properties. For more information, see Creating Account Limitations on page 303. e. Define the limitation as directed on the Configure Limitation page that follows. For more information about defining pattern-type limitations, see Defining Pattern Limitations on page 194. 5. Click Add Limitation in the Account Limitations section. 6. Select the type of limitation to apply from the list, and then click Continue. Notes: Account limitations defined using the Account Limitation Builder display as options on the Select Limitation page. Account limitations can be defined and set
Managing Accounts 193
using almost any custom properties. For more information, see Creating Account Limitations on page 303. Because SolarWinds NetFlow Traffic Analyzer (NTA) initially caches account limitations, it may take up to a minute for account limitations related to SolarWinds NTA to take effect in SolarWinds NTA. 7. Define the limitation as directed on the Configure Limitation page that follows. For more information about defining pattern-type limitations, see Defining Pattern Limitations on page 194.
You may also group operators using parentheses, as in the following example.
(*foo* EXCEPT *b*) AND (*all* OR *sea*) matches seafood and footfall, but not football or Bigfoot.
To set default menu bar and view options: 1. Log in to the SolarWinds Web Console as an administrator. 2. Click Settings in the top right of the web console, and then click Manage Accounts in the Accounts grouping of the SolarWinds Website Administration page. 3. Select the account that you want to configure, and then click Edit. 4. Scroll down to Default Menu Bar and Views. 5. Select a Home Tab Menu Bar from the available list.
Note: This is the default menu bar displayed when you click Home in the SolarWinds Web Console. If you are editing a user account that must have administrator privileges, set the Home Tab Menu Bar to Admin. 6. Select an Application Tab Menu Bar from the available list. Note: This is the default menu bar displayed when you click Applications in the SolarWinds Web Console. If you are editing a user account that must have administrator privileges, select Admin. 7. Select a Virtualization Tab Menu Bar from the available list. Note: This is the default menu bar displayed when you click Virtualization in the SolarWinds Web Console. If you are editing a user account that must have administrator privileges, select Admin. 8. If you have installed any additional SolarWinds modules, select a SolarWinds Module Tab Menu Bar from each available list. Note: This step configures the default menu bar displayed when you click the tab corresponding to an installed module in the SolarWinds Web Console. If you are editing an account that must have administrator privileges, select Admin. 9. Select a Home Page View. Note: If no Home Page View is specified, the default is designated to be the same as the page that is specified in the Default Summary View field below. 10. If the Home Page View you have selected refers to a specific network device, select a Default Network Device by clicking Edit and selecting from the list of available devices on the next page. Note: If the Home Page View you have selected does not require a specific network device, SolarWinds will select a device to display, automatically. 11. Select a Default Summary View for the account. Note: This is typically the same as the Home Page View. 12. If you want all reports to be available for the account, select \Reports from the Report folder list in the Default Menu Bars and Views area. Note: If you are creating a new user, you must designate the Report Folder the new account is to use to access SolarWinds reports. By default, no report folder is configured for new users. The Reports directory is located in the SolarWinds SAM installation directory: C:\Program Files\SolarWinds\Orion\. 13. If you want to designate default Node, Volume, and Group Details Views for this account, expand SolarWinds General Settings, and then select appropriate Node Detail, Volume Detail, and Group Detail Views.
14. If you want to designate default Virtualization Summary Manager, Cluster Details, and Datacenter Details Views for this account, expand Integrated Virtual Infrastructure Monitor Settings, and then select appropriate default views. 15. Click Submit.
To configure an account report folder: 1. Log in to the SolarWinds Web Console as an administrator. 2. Click Settings in the top right of the web console, and then click Manage Accounts in the Accounts group of the SolarWinds Website Administration page. 3. Select the account you want to configure, and then click Edit. 4. If you want all reports to be available for the account, select \Reports from the Report folder list in the Default Menu Bars and Views area. Note: If you are creating a new user, you must designate the Report Folder the new account is to use to access SolarWinds reports. By default, no report folder is configured for new users. The Reports directory is located in the SolarWinds SAM installation directory: C:\Program Files\SolarWinds\Orion\. 5. Click Submit.
Application Summary View Select the default view. Components Details View Select the default view. Components Details View Select the default view. SAM User Role Select User or Admin. Note: The SAM User Role allows you to define a SAM Administrator role independent of an Orion Administrator role. Real Time Process Explorer Allows you to select whether or not a user can use the Real Time Process Explorer. Temperature Unit - Allows you to select the default temperature unit displayed; Fahrenheit or Celsius. This will affect all charts that display temperature for the current user.
Node Details View - This view is used when details about a single Network Node are displayed.
Volume Details View - This view is used when details about a single physical or logical Volume are displayed. Group Details View - This view is used when details about a single Group are displayed.
Virtualization Manager Summary View - This view is the target of the "VMware Summary" link in the page header. Cluster Details View - This view is used when details about a single Cluster are displayed. Datacenter Details View - This view is used when details about a single Data Center are displayed
Chapter 10
2. Click Settings in the top right of the web console. 3. Click Polling Settings in the Settings group.
Polling Intervals
The following settings configure default polling intervals. To apply poller settings, click Re-Apply Polling Intervals. Default Node Poll Interval Devices are regularly polled to determine status and response time on this designated interval. By default, this interval is 120 seconds. Default Volume Poll Interval Volumes are regularly polled to determine status and response time on this designated interval. By default, this interval is 120 seconds. Default Rediscovery Interval Your entire network is polled on this interval to detect any re-indexed devices. Monitored network devices are also checked for IOS upgrades permitting EnergyWise support. By default, this interval is 30 minutes. Lock custom values This option is enabled by default. Enabling this option automatically saves any polling customizations made on the SolarWinds Polling Settings view.
Default Node Statistics Poll Interval Device performance statistics are regularly polled on this interval. By default, this interval is 10 minutes. Default Volume Statistics Poll Interval Volume performance statistics are regularly polled on this interval. By default, this interval is 15 minutes.
Network
The following settings configure ICMP and SNMP requests. ICMP Timeout All ICMP (ping) requests made by the SolarWinds poller time out if a response is not received within the period designated. By default, this period is 2500ms. ICMP Data This string is included within all ICMP packets sent by SolarWinds. SNMP Timeout All SNMP requests made by the SolarWinds poller time out if a response is not received within the period designated. By default, this period is 2500ms. SNMP Retries If a response to an SNMP poll request made by the SolarWinds poller is not received within the configured SNMP Timeout, the SolarWinds poller will conduct as many retries as designated by this value. By default, this value is 2.
Baseline Calculation (advanced) Upon startup, SolarWinds can calculate a baseline for the transmission rates of the various elements of your network. This baseline is used as a starting point for any comparison statistics. For more information, see Calculating a Baseline on page 205. Allow Secure Data on Web (advanced) In the interest of security, sensitive information about your network is not viewable in the SolarWinds Web Console. However, if your network is properly secured, you may check this option to allow the viewing of community strings and other potentially sensitive information within the web console. Note: This setting does not affect the display of custom reports that you export to the web. For more information see Creating and Viewing Reports on page 353. Node Warning Level Devices that do not respond to polling within this designated period of time display as Down in the web console. By default, this value is 120 seconds. Counter Rollover This option sets the type of counter SolarWinds SAM is to use. For more information, see Handling Counter Rollovers on page 105.
Percent Packet Loss: The second method is a more complicated calculation that effectively bases the availability of a selected node on its packet loss percentage. As in the Node Status method, the selected node is polled for status. If it responds within the Default Node Poll Interval defined on the SolarWinds Polling Settings view, a value of 100 is averaged with the previous 10 availability records. For more information, see Orion Polling Settings on page 202. The result of the Percent Packet Loss calculation is a sliding-window average. To calculate node availability over a selected time period, the sum of all results in the Response Time table for the selected node over the selected time period is divided by the selected time period, providing an average availability over time. Note: The Percent Packet Loss method introduces a historical dependency into each availability node record. In general, it is best to leave calculations based on Node Status unless you specifically need node availability based on packet loss.
Calculating a Baseline
Much of the raw data that SolarWinds SAM polls from nodes is provided initially as counter values. If you do not need statistics immediately, or if you do not want SolarWinds SAM to calculate a baseline at startup, disable baseline calculation at startup by setting the Baseline Calculation option on the SolarWinds Polling Settings view to False. For more information, see Configuring Polling Engine Settings on page 201. Note: Baseline calculation requires significant data gathering and processing. Until baseline calculation is completed, both SolarWinds SAM server performance and the CPU performance of some of network routers may be adversely affected.
To reassign nodes to a different polling engine: 1. Click Start > All Programs > SolarWinds > Advanced Features > SolarWinds Service Manager. 2. Click Shutdown Everything. Note: Confirm that you stop the SolarWinds Network Performance Monitor Service on all polling engines. 3. Click Start > All Programs > SolarWinds > Advanced Features > Monitor Polling Engines. 4. Click Servers > Poller Load Balancing. 5. Select the nodes you want to reassign. Note: Use Shift + click to highlight multiple consecutive rows, and use Ctrl + click to highlight multiple non-consecutive rows. 6. Click Polling Engines > Move Selected Nodes to *, substituting the target polling engine for *. The node is reassigned, and it reflects the name of the polling engine in the polling engine column. 7. Click Start > All Programs > SolarWinds > Advanced Features > SolarWinds Service Manager to restart SolarWinds services.
3. In the Calculations and Thresholds group, set the Node Warning Level to an appropriate interval, in seconds. Note: The default Node Warning Level interval is 120 seconds. 4. Click Submit.
12. On your SolarWinds server, click Start > Run, type regedit, and then click Ok. 13. Expand HKEY_LOCAL_MACHINE > SOFTWARE > SolarWinds.Net > SWNetPerfMon. 14. Right-click Settings, and then click New > String Value. 15. Enter Response Time Retry Count as the New Value. 16. Right-click Response Time Retry Count, and then click Modify. 17. In the Value data field, enter the CurrentValue provided in the query above, and then click Ok. 18. Close the Registry Editor. 19. Click Start > All Programs > SolarWinds > Advanced Features > SolarWinds Service Manager. 20. Click Start Everything.
Chapter 11
Virtualization
SolarWinds Integrated Virtual Infrastructure Monitoring (IVIM) built into SolarWinds SAM lets you monitor today's modern network fabric of virtual networks, virtualized data centers, and private clouds. The deep visibility into your virtualized environments helps you ensure that network performance helps and not hinders your virtualization projects SolarWinds SAM v5.2+ is capable of monitoring VMware ESXi and ESX Servers versions 3.5 and higher as well as Microsoft's Hyper-V.
Note: A node can either be a VMware ESX/vCenter server or Hyper-V server, not both.
VMware Monitoring
Monitor your entire VMware virtual infrastructure from the highest to the lowest level: vCenter datacenter cluster ESX hosts individual virtual machines. Track availability and performance metrics including CPU, memory, storage, and network bandwidth utilization Virtual Machine Auto-Summary Automatically discover identify and monitor new virtual machines added to any VMware host server or updated during vMotion. Virtualization Alerting and Reporting SolarWinds' native alerting and reporting capabilities extend seamlessly to your virtual infrastructure. Refer to the following sections for more information:
Virtualization 209
Requirements for Monitoring ESXi and ESX Servers Managing VMware Credentials in the Web Console Adding Virtual Servers for Monitoring Virtualization Summary Viewing ESX Host Details Changing Polling Orders for ESX Servers
VMware API
SolarWinds SAM uses the VMware API to poll most performance data from devices running ESXi and ESX Server versions 3.5 and 4.0. For more information about creating required credentials, see Creating ESX Server Credentials for Orion on page 215. VMware Tools must be installed on all ESXi and ESX Servers you intend to monitor. VMware Tools is not required on virtual machines running on monitored ESXi and ESX servers, but additional information, including IP addresses, are made available when VMware Tools is installed on virtual machines hosted by monitored ESXi and ESX Servers.
VMware Tools
The following table provides a summary of the methods used by SolarWinds SAM to monitor VMware ESX Servers.
3.5 Detection as ESX Server Volumes Interfaces CPU Memory SNMP SNMP SNMP SNMP N/A N/A N/A N/A 3i 4 VMware API SNMP SNMP SNMP SNMP N/A SNMP (partial) SNMP SNMP 4i
210 Virtualization
Notes:
C:\Program Files\VMware\VMware vSphere CLI\Perl\bin is the default location of the vSphere Perl\bin directory.
Replace ip_address with the IP address of your ESXi server, and replace cstring with the community string you are adding. For most environments, the community string public should be sufficient. b. Enter an appropriate user name at the prompt. Note: For most environments, root should be sufficient. c. Enter the associated password at the prompt.
Virtualization 211
3. Use the vSphere CLI to enable SNMP on your ESXi server, as indicated in the following procedure: a. In the Perl\bin directory of your vSphere installation, execute the following script to add an appropriate community string:
perl ..\..\bin\vicfg-snmp.pl --server ip_address -c cstring
Note: Replace ip_address with the IP address of your ESXi server, and replace cstring with the community string you are adding. For most environments, the community string public should be sufficient. b. Enter an appropriate user name at the prompt. Note: For most environments, root should be sufficient. c. Enter the associated password at the prompt. d. In the Perl\bin directory of your vSphere installation, execute the following script to enable SNMP:
perl ..\..\bin\vicfg-snmp.pl --server ip_address E
Note: Replace ip_address with the IP address of your ESXi server. e. Enter an appropriate user name at the prompt. Note: For most environments, root should be sufficient. f. Enter the associated password at the prompt.
212 Virtualization
3. Locate the rocommunity setting and replace the default community string public with an appropriate read-only community string for your environment. Note: Use commas to separate multiple community strings. 4. Save snmpd.conf, and then close your editor. Note: If you are using nano, press Ctrl+X to close nano, and then enter Y to save snmpd.conf. 5. Enter chkconfig snmpd on to enable SNMP when you reboot your ESX Server. 6. Enter esxcfg-firewall -e snmpd to allow SNMP through the ESX Server firewall. 7. Enter service snmpd start to start the SNMP service. 8. Confirm that SNMP polling is enabled on your ESX Server by entering the following command:
snmpwalk -v1 -c cstring localhost .1.3.6.1.4.1.6876 | grep 6876.1
Note: Replace cstring with the community string you provided above. 9. After entering the snmpwalk command, your ESX Server should return information similar to the following:
SNMPv2-SMI::enterprises.6876.1.1.0 = STRING: "VMware ESX Server" SNMPv2-SMI::enterprises.6876.1.2.0 = STRING: "3.5.0" SNMPv2-SMI::enterprises.6876.1.3.0 = OID: SNMPv2SMI::enterprises.6876.60.1.3.5.0 SNMPv2-SMI::enterprises.6876.1.4.0 = STRING: "153875"
Note: The MIB OID SNMPv2-SMI::enterprises.6876.1.4.0 returns the build number for your product, so it may not be the same as the build number displayed above.
Virtualization 213
To enable SNMP on ESX Server version 4.0: 1. Log in to your ESX Server using an account with administrative privileges. 2. Open snmp.xml in a text editor. Notes: The default location for snmp.xml is root/etc/vmware/snmp.xml. To use the default text editor, nano, in a default ESX Server version 4 environment, enter nano /etc/vmware/snmp.xml at the prompt. 3. Locate the communities tag, and then replace the default community string public with an appropriate read-only community string for your environment. Note: Use commas to separate multiple community strings. 4. Locate the enable tag, and then confirm it is set to true. 5. Locate the port tag and confirm it is set to 171. 6. Locate the targets tag and confirm it is set to 127.0.0.1@162/cstring. Note: Replace cstring with the community string you provided above. 7. Save snmp.xml, and then close your editor. Note: If you are using nano, press Ctrl+X to close nano, and then enter Y to save snmp.xml. 8. Enter service snmpd stop to confirm that the SNMP service is stopped. 9. Open snmpd.conf in a text editor. Notes: The default location for snmpd.conf is root/etc/snmp/snmpd.conf. To use the default text editor, nano, in a default ESX Server version 4 environment, enter nano /etc/snmp/snmpd.conf at the prompt. 10. Edit snmpd.conf to include the following two lines:
view systemview included .1.3.6.1.4.1.6876 proxy -v 1 -c cstring 127.0.0.1:171 .1.3.6.1.4.1.6876
Note: Replace cstring with the community string you provided above. 11. Save snmpd.conf, and then close your editor. Note: If you are using nano, press Ctrl+X to close nano, and then enter Y to save snmpd.conf. 12. Enter service mgmt-vmware restart to restart the mgmt-vmware service.
214 Virtualization
13. Enter service snmpd start to start the SNMP service. 14. Enter chkconfig snmpd on to enable SNMP when you reboot your ESX Server. 15. Enter esxcfg-firewall -e snmpd to allow SNMP through the ESX Server firewall. 16. Confirm that SNMP polling is enabled on your ESX Server by entering the following command:
snmpwalk -v1 -c cstring localhost .1.3.6.1.4.1.6876 | grep 6876.1
Note: Replace cstring with the community string you provided above. 17. After entering the snmpwalk command, your ESX Server should return information similar to the following:
SNMPv2-SMI::enterprises.6876.1.1.0 = STRING: "VMware ESX" SNMPv2-SMI::enterprises.6876.1.2.0 = STRING: "4.0.0" SNMPv2-SMI::enterprises.6876.1.4.0 = STRING: "208167"
Note: The OID SNMPv2-SMI::enterprises.6876.1.4.0 returns your product build number, so it may not be the same as the build number above.
Virtualization 215
5. On the Add New user window, complete the following procedure: Note: The User Name and Password provided in this step must be provided either in your initial network discovery or whenever you use Web Node Management to add the current ESX Server to SolarWinds SAM for monitoring. a. Provide both a Login and a User Name for the SolarWinds SAM polling engine. b. Enter and confirm a Password. c. Click Ok. 6. Open the Permissions tab. 7. Right-click the Permissions view, and then click Add Permission. 8. On the Assign Permissions window, click Add. 9. Select the user you just created, and then click Add. 10. Click Ok on the Select Users and Groups window. 11. Select an appropriate role in the Assigned Role area, and then click Ok on the Assign Permissions window. The credential you have created is now available to use for monitoring your ESX Server. For more information about adding your ESX Server to the SolarWinds database for monitoring, see Managing VMware Credentials in the Web Console on page 216.
216 Virtualization
Virtualization Summary
The Virtualization Summary view shows the overall status of your virtualized infrastructure. To view the Virtualization Summary: 1. Log in to the SolarWinds Web Console. 2. Point to the Virtualization tab and then click Virtualization Summary. The Virtualization Summary view is pre-configured to display the following resources:
Top XX Hosts by CPU Load Top XX Hosts by Percent Memory Used VMware Assets Top XX Hosts by Number of Running VMs Top XX Hosts by Network Utilization VMware Asset Summary
Virtualization 217
To change the properties or contents of any resource, click Edit in the resource box.
To change the properties or contents of any resource, click Edit in the resource box.
218 Virtualization
If the ESX server returns the message, Unable to establish session with all provided credentials, check the following: Verify the VMware credentials in the VIM are correct Verify the account belongs to the root user group
Virtualization 219
Hyper-V Monitoring
Sam 5.2 and higher natively supports monitoring of Microsoft's Hyper-V server and its guests. By default, the statistic collection interval is set to ten minutes. Note: A node can either be a VMware ESX/vCenter server or Hyper-V server, not both.
220 Virtualization
Ensure that core networking, Windows Management Instrumentation (WMI), and RPC traffic can traverse the firewall. Allow the WBEM Scripting Locator to be called remotely. SolarWinds provides a group policy and a PowerShell script to perform the WBEM registry changes.
Modifying the Windows Firewall You must allow core networking, WMI, and RPC traffic through the firewall of the monitored server. The following procedure walks you through allowing this traffic through the Windows Firewall on Windows 2008 R2. Notes: If you have restricted the range of dynamic RPC ports, you must ensure that each host is able to access that port range. If you are connecting to Hyper-V hosts through a DMZ or hardware firewall, you must open the corresponding rules and ports on the hardware.
To allow the correct traffic through the Windows firewall, you must perform the following steps: 1. Ensure the core networking rules are enabled 2. Enable the Windows Management Instrumentation (DCOM-In) rule 3. Create a new rule to open the RPC ports Ensure the Core Networking rules are enabled You must ensure that the core networking rules are enabled to collect information successfully from Hyper-V hosts. Note: If the rule has a green icon with a checkmark in front of it, the rule is enabled. To allow core networking traffic through the Windows Firewall on Windows 2008 R2: 1. Log on to the computer you want to monitor with an administrator account.
Virtualization 221
2. Navigate to Start > Administrative Tools >Windows Firewall with Advanced Security. 3. Click Inbound Rules in the left navigation pane. 4. Ensure that all Core Networking rules are enabled. If not, select the disabled rule and then click Enable Rule in the Action menu. Enable the Windows Management Instrumentation (DCOM-In) rule You must ensure that the Windows Management Instrumentation (DCOM-In) rule is enabled to collect information successfully from Hyper-V hosts. Note: After enabling the Windows Management Instrumentation (DCOM-In) rule, common WMI checks indicate that WMI is not enabled. This is expected behavior. To allow WMI traffic through the Windows Firewall on Windows 2008 R2: 1. Log on to the computer you want to monitor with an administrator account. 2. Navigate to Start > Administrative Tools >Windows Firewall with Advanced Security. 3. Click Inbound Rules in the left navigation pane. 4. Click Windows Management Instrumentation (DCOM-In), and then click Enable Rule in the Action menu. Create a new firewall rule to open the RPC ports You must open the RPC ports to collect information successfully from Hyper-V hosts. This is best done by creating a new firewall rule. To open the RPC ports on Windows 2008 R2: 1. Log on to the computer you want to monitor with an administrator account. 2. Navigate to Start > Administrative Tools > Windows Firewall with Advanced Security. 3. Click Inbound Rules in the left navigation pane. 4. Click Actions > New Rule 5. In Rule Type, select Custom and click Next. 6. Select This program path and enter
%SystemRoot%\System32\dllhost.exe in the text box.
7. In Services, click Customize to ensure that Apply to all programs and services is selected, and click OK.
222 Virtualization
8. Click Next 9. In Protocol type, select TCP. 10. In Local port, select RPC Dynamic Ports. 11. In Remote port, select All Ports. 12. Click Next. 13. Apply to any local and remote IP addresses and click Next. 14. In Action, ensure that Allow the connection is selected and click Next. 15. Select all profiles (Domain, Private, and Public) and click next. 16. Enter a name, such as SAM WMI Dynamic Ports. 17. Click Finish The new rule will now appear in the list of inbound rules.
Virtualization 223
Virtualization Summary Method: Warning: If Hyper-V polling is disabled, historical data will be lost. To retain historical data, select Unmanage. When you choose to remanage the node, all historical data will be available. 1. In the web console, click the Virtualization tab. 2. In the Virtualization Assets resource. Click Virtualization Settings.
224 Virtualization
Note: You can temporarily enable/disable polling of Hyper-V by selecting a node from the list and clicking either Disable Hyper-V Polling or Enable Hyper-V Polling. If you check a disabled node, the Enable Polling button will become enabled. The converse is also true. 5. Check or uncheck Hyper-V and then click Submit.
226 Virtualization
Chapter 12
Refer to the following sections for more information: Understanding Component Monitors and Application Monitor Templates
Building Component Monitors and Templates 287
Choosing Component Monitors and Templates Based on Protocol Requirements for Component Monitors and Templates that use WMI Monitoring External Nodes Understanding the Credentials Library
Using Application Monitor Templates Managing Assigned Application Monitors Working with Component Monitors Scripting Custom Component Monitors Custom Application Monitor Template Example: Creating a SolarWinds SAM Template Conversion Value Available Data Transformations
Assigned Component Monitors Assigned component monitors are created by assigning Application Monitor templates to server nodes. Each actively monitors its assigned node according to its settings. Component monitors inherit these initial settings from the template. If you make a change to a template, that same change is rolled out to all assigned Application Monitors based on the template. You can override the template settings at any time, breaking the inheritance relationship between the component monitor and its template. For example, the user name and password usually differ for each node, and you would select a different credential for each assigned Application Monitor, thus overriding the template setting for the Credentials field. To restore the inheritance relationship between a component monitor and its template, click Inherit From Template next to the setting. Continuing the car analogy, when you assign the Dodge Charger template to a Dodge Charger vehicle, you now have a set of assigned component monitors for monitoring the vehicles tire pressures, engine RPM, and so forth. Assigned Application Monitors An assigned Application Monitor runs its assigned component monitors at regular intervals, and then uses the status results from the component monitors to determine an overall status for the application. If some of the component monitors are up and others are down, the Application Monitor follows the Status Rollup Mode setting in the SolarWinds Web Console Settings to show either the worst status of the group or a warning status. The difference between an assigned Application Monitor and a template is that the template is only a blueprint and does not perform any monitoring on its own. Only after assigning the template to a server node does SolarWinds SAM conduct any actual monitoring on the node. To complete the car example, you assign the Dodge Charger template to all the Dodge Charger vehicles to create the assigned Application Monitor for determining the overall status for your Dodge Charger fleet. For example, the fleet may be 95% available at a given time due to warnings for some of the cars.
Citrix XenApp 5.0 ICA Session WMI Counters Citrix XenApp 5.0 Presentation Server WMI Counters Citrix XenApp 5.0 Services Errors in Application Event Log Exchange 2007 Exchange 2007 Client Access Role Services Exchange 2007 Client Access Role WMI Counters Exchange 2007 Common WMI Counters Exchange 2007 Edge Transport Role Services Exchange 2007 Hub Transport Role Services Exchange 2007 Hub Transport Role WMI Counters Exchange 2007 Mailbox Role Services Exchange 2007 Mailbox Role WMI Counters Exchange 2007 Unified Messaging Role Services Exchange 2007 WMI Counters Exchange 2010 Client Access Role Services Exchange 2010 Common Performance Counters Exchange 2010 Edge Transport Role Services Exchange 2010 Hub Transport Role Services Exchange 2010 Mailbox Role Services Exchange 2010 Unified Messaging Role Services Exchange Server 2000 and 2003 Internet Information Services SolarWinds Server SharePoint Server (MOSS) 2007 SharePoint Services (WSS) 3.0 SQL Server 2005 Database SQL Server 2008 Database Windows Print Services Windows Server 2003-2008
Select Applications To keep the time it takes to scan to a minimum, we recommend you initially scan for only a limited number of application templates. To see more application templates, select a different template group from the Show Only list. To adjust the template assignment criteria, expand Advanced Scan Settings and move the slider to the desired setting: Exact Match All the components must match to assign the template. Strong Match Most of the components must match to assign the template. Partial Match Some of the components must match to assign the template. Minimal Match At least one component must match to assign the template. Enter Credentials Some application templates require credentials either to access restricted resources, or to run within the context of a specific user. To scan for these templates, add the necessary credentials to the list. If a template you are scanning for requires credentials, the credentials in this list are tried in the order in which they appear. Warning!: Credentials are tried several times over the course of a scan, so an incorrect password is likely to lock out an account. To avoid potential account lockouts that affect actual users, we recommend you create and use service accounts. A service account is an account that is created specifically for the purpose of providing credentials to use for SolarWinds monitoring. With service accounts, no actual user is affected by an account lockout if a password should be entered incorrectly. If you have domains sharing user names with different passwords, we recommend you run separate application discoveries for each domain. Review & Start Scan Review the summary for the scan. If the automatic discovery matches templates that are already assigned to the node, by default the template is not assigned a second time. If you want to assign duplicate templates, select Yes, Assign Anyway from the Do you want to assign duplicates list.
Click Start Scan to begin the scan. The scan runs in the background. You are notified by a message near the top of the window when scanning is completed. Click View results to see the results of the scan. Add UX Monitors You cannot scan for user experience (UX) monitors, but you can assign them to nodes manually. Adding monitors from this page does not affect your scan.
4. Click Manage Templates. 5. Select the tag by which to filter the templates. 6. Check the check box next to the template you want to assign. 7. Click Assign to Node. 8. Select the server node or nodes to which you want to apply the Application Monitor template, and then click Next. 9. If suitable credentials already exist, choose the credential from the Choose Credential list. 10. If suitable credentials do not exist, choose <New Credential> from the Choose Credential list, and then add the new credential by filling out the credential details. 11. Click Test to test the credentials and component monitors against the test node. 12. If the test fails, troubleshoot the problem based on the error messages, and then retest the node. 13. If the test passes, click Assign Application Monitors. 14. Review the information for the assigned Application Monitor and then click Done.
Note: Setting a polling frequency below 30 seconds can result in erratic monitor behavior. 7. If you want to turn on extended debug information to assist Customer Support, expand Advanced and then turn Debug logging On and specify the Number of log files to keep. Here you can also select either 32bit or 64bit from the dropdown list entitled, Platform to run polling job on. Note: Do not turn on Debug logging unless directed by Customer Support. 8. Click Add Component Monitor. 9. Expand the component groups and check all the component monitors you want to add. Note: You can select multiple component monitors of the same type to be added by entering a number in the field next to the check box for the component monitor and then checking the check box. 10. Click Submit. 11. Configure the component monitor settings, and then click Submit. Creating New Templates Using the Browsing Method To create a new template using the browsing method: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Browse for Component Monitor. 5. Select the component monitor type that you want to browse, then click Next. 6. Type the IP address of the node you want to browse, or click Browse and select the node from the list. 7. If suitable credentials already exist, choose the credential from the Choose Credential list. 8. If suitable credentials do not exist, choose <New Credential> from the Choose Credential list, and then add the new credential by filling out the credential details. 9. Click Next. 10. If you selected a performance counter monitor type, select a performance object from Performance Object to populate the list.
Building Component Monitors and Templates 241
11. Check the check boxes next to one or more found items to add as a component monitor. 12. Click Next. 13. Configure the component monitor properties, and then click Next. Note: You can specify the name of a specific process to monitor by entering the name in the Process Name field. 14. Select New Application Monitor Template. 15. Type a name for your template in the Application Monitor Template Name field. 16. Click Next. 17. If you want to assign the template to nodes, select the nodes. 18. If you only want to create the template, do not select any nodes. 19. Click Next, and then click Ok, Create.
Managing Templates
You can create a new template or manage existing templates by using the commands on the SAM Settings page: Creating Templates Assign to Node Editing Templates Copying Templates Exporting and Importing Templates Locally or Using Thwack Deleting Templates Tagging Templates Creating Templates You can create a new template by specifying the name of the template and then adding the desired component monitors. To create an application template: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings.
4. Click Manage Templates. 5. Click Create New Template. See Creating New Templates Using the Traditional Method for information on completing the new template. Assign to Node You can create an assigned Application Monitor by assigning template(s) to nodes. To create an assigned Application Monitor by assigning template(s) to nodes: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Templates. 5. Check the check box for the template(s) you want to assign. 6. Click Assign to Node. 7. Specify the node(s) to monitor and then click Next. 8. If suitable credentials already exist, choose the credential from the Choose Credential list. 9. If suitable credentials do not exist, choose <New Credential> from the Choose Credential list, and then add the new credential by filling out the credential details. 10. Click Test to test the credentials and component monitors against the test node. 11. If the test fails, troubleshoot the problem based on the error messages, and then retest the node. 12. If the test passes, click Assign Application Monitors. Editing Templates You can modify an existing template by adding or removing its component monitors. You can then save it to a new template by changing the template name if desired. To edit an application template: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab.
Building Component Monitors and Templates 243
3. Click SAM Settings. 4. Click Manage Templates. 5. Check the application template you want to edit, and then click Edit. 6. If you are creating a new template by modifying an existing template, specify the name for your new template in the Template Name field. 7. Specify the values for the Polling Frequency and Polling Timeout fields. Note: Setting a polling frequency below 30 seconds can result in erratic monitor behavior. 8. To turn on extended debug information to assist Customer Support, expand Advanced and then set Debug logging On and specify the Number of log files to keep. Here you can also select either 32bit or 64bit from the dropdown list entitled, Platform to run polling job on. Note: Do not turn on Debug logging unless directed by Customer Support. 9. Click Add Component Monitor. 10. Expand the component groups and check all the component monitors you want to add. Note: You can select multiple component monitors of the same type to be added by entering a number in the field next to the check box for the component monitor and then checking the check box. 11. Click Submit. 12. Remove component monitors if desired by clicking Delete. 13. Configure the component monitor settings, and then click Submit.
Multi-Edit Templates
Multiple component monitors within a template can be edited simultaneously. As indicated by the toolbar, multiple monitors can be selected to: Assign Credentials, Test, Set Test Node, Disable, and Delete. The monitors selected do not to be of the same type when performing a multiple monitor edit. When performing a multiple monitor edit, the correct buttons will become enabled and/or disabled based on your selection. The Multi-Edit button allows you to change the options of two or more monitors of the same type, simultaneously. To enable the Multi-Edit button, two or more monitors of the same type must be selected. Once multiple monitors of the same type are selected, the Multi-Edit button becomes enabled. In the illustration below, three monitors (Services) are checked and the Multi-Edit button is enabled:
Once the Multi-Edit button is pressed, a pop-up window is dispalyed with editing options specific to the type of monitor selected. For example, the Fetching Method for the three Services selected can be changed from RPC to WMI, as shown below:
Note: Different types of monitors will have different options available for editing.
Copying Templates After successfully creating a complicated template, instead of having to recreate it over for a similar application, consider copying the template. This will allow you to only modify those properties that differ. To copy an application template: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Templates. 5. Check the application template you want to copy, and then click Copy. Exporting and Importing Templates Locally or Using Thwack You can export and import templates to and from your file system for your own use, or to the SolarWinds community site (thwack.com) where templates can be shared with the network engineering community. Note: thwack.com import and export operations require Internet connectivity to thwack.com and thwack.api.solarwinds.com. In addition, thwack export operations require a valid thwack.com user account. To export a template: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Templates. 5. If you want to export a template to a file, complete the following procedure: a. Check the application template you want to export, and then click Import/Export > Export as File. b. Confirm that you want to save the file by clicking Save. c. If you are prompted for a path, specify or browse to one and then click Save.
6. If you want to export the template to thwack.com, complete the following procedure: a. Click Share Now to open a browser to the Application Monitor Templates area of thwack, where you can upload your newly exported application template. b. Click Sign in and then type your thwack.com user name and password. c. Click Upload a File and then specify the file pathname to your newly exported application template. To import a template from a file: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Templates. 5. Click Import/Export > Import. 6. Click Browse and select the template file, then click Open. 7. Click Submit. Note: If you import a template with the same name as one of your existing templates, the name of the imported template is modified by appending (n) to the name, where n is an integer. For example, assume you save the template named Tomcat Server Template (shipped with SAM) to a file. If you then import the saved template Tomcat Server Template from the file, the imported template is renamed as Tomcat Server Template (1). If you import the same template again, the next imported template is named Tomcat Server Template (2), and so on. This renaming protects you from accidentally overwriting an existing template. To import a template from thwack: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Shared thwack templates. 5. Check the template(s) you want to import, and then click Import. Then enter your thwack User Name and Password and click Log In. 6. A dialog is displayed informing you that the import operation was successful. Click Close to close the dialog or click View Imported Templates to view the results.
Building Component Monitors and Templates 247
Note: If you import a template with the same name as one of your existing templates, the name of the imported template is modified by appending (n) to the name, where n is an integer. For example, assume you save the template named Tomcat Server Template (shipped with SAM) to a file. If you then import the saved template Tomcat Server Template from the file, the imported template is renamed as Tomcat Server Template (1). If you import the same template again, the next imported template is named Tomcat Server Template (2), and so on. This renaming protects you from accidentally overwriting an existing template. Deleting Templates If you no longer need a template, you can delete it. Deleting a template also deletes all the data associated with it, so ensure you no longer need either the template or the associated data before deleting the template. Notes: Deleting a template also deletes all of its assigned applications, both modified and unmodified. To speed user interface interaction, data is not immediately removed from the database, but systematically updated every few minutes in the background. To delete a template: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Templates. 5. Check the template(s) you want to delete, and then click Delete. 6. Confirm you want to delete the template(s) by clicking Yes. Tagging Templates Tags are descriptive labels that help you classify and sort your application templates on the Manage Application Monitor Templates page. The application templates included in SolarWinds SAM have already been tagged with several descriptive labels you can modify as you see fit. To add tags: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings.
248 Building Component Monitors and Templates
4. Click Manage Templates. 5. Select the templates you want to tag. 6. Click Tags. 7. If you want to add existing tags, follow these instructions: a. Click Add existing tag(s). b. Select the tags from the list. 8. If you want to add new tags, follow these instructions: a. Click Add new tag(s). b. Type the tags in the Add new tag(s) field, separating multiple tag entries with commas. 9. Click Submit. To remove tags: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Templates. 5. Select the templates you want to tag. 6. Click Tags. 7. Click Remove tag(s). 8. Select the tags from the list. 9. Click Submit.
3. Click SAM Settings. 4. Click Manage Application Monitors. 5. Click the group containing the application you want to remanage. 6. Check the application(s) you want to remanage, and then click Remanage. -or1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click an assigned Application Monitor in any resource to view its SAM Application Details View page. 4. Click Remanage in the Application Details section.
6. Select the desired component monitor(s) to add to the new template. 7. Click Create New Template, specify the information for the new template, and then click Submit. Refer to the section Creating New Templates on page 240 for details about specifying the template information. 8. To add additional component monitor(s) to add to the new template, click Add Component Monitor. 9. Expand the component groups and check all the additional component monitors you want to add. Note: You can select multiple component monitors of the same type to be added by entering a number in the field next to the check box for the component monitor and then checking the check box. 10. Click Submit. 11. Configure the component monitor settings, and then click Submit. The new template is added to the list of all Application Monitor Templates. Assigning Component Monitors to a Node To quickly assign component monitors to a node: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Assigned Component Monitors. 5. Select the desired component type or assigned Application Monitor whose component monitors you want to list. 6. Select the desired component monitor(s) to assign to a node. 7. Click Assign to Node. 8. Enter the name for the application, polling frequency, and polling timeout. 9. If you want to turn on extended debug information to assist Customer Support, expand Advanced, set Debug logging On, and specify the Number of log files to keep. Here you can also select either 32bit or 64bit from the dropdown list entitled, Platform to run polling job on.
Note: Do not turn on Debug logging unless directed by Customer Support. 10. Click Next. 11. Select the nodes to which you want to assign the Application Monitor, and then click Next. 12. If suitable credentials already exist, choose the credential from the Choose Credential list. 13. If suitable credentials do not exist, choose <New Credential> from the Choose Credential list, and then add the new credential by filling out the credential details. 14. Click Test to test the credentials and component monitors against the test node. 15. If the test fails, troubleshoot the problem based on the error messages, and then retest the node. 16. If the test passes, click Assign Application Monitors. Copying Assigned Component Monitors to an Assigned Application Monitor To quickly copy component monitors to an assigned Application Monitor: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Assigned Component Monitors. 5. Select the desired component type or assigned Application Monitor whose component monitors you want to list. 6. Select the desired component monitor(s) to copy to an assigned Application Monitor. 7. Click Copy to Assigned Application Monitor. 8. Select the desired Application Monitor(s) to copy to and click Submit. 9. Click Ok to acknowledge the successful copy. Copying Assigned Component Monitors to an Application Monitor Template To quickly copy component monitors to an Application Monitor template:
1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Assigned Component Monitors. 5. Select the desired component type or assigned Application Monitor whose component monitors you want to list. 6. Select the desired component monitor(s) to copy to an assigned Application Monitor. 7. Click Copy to Application Monitor Template. 8. Select the desired template(s) to copy to and click Submit. 9. Click Ok to acknowledge the successful copy. Editing Assigned Application Monitors To edit the assigned Application Monitor for a component monitor: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Assigned Component Monitors. 5. Select the desired component type or assigned Application Monitor whose component monitors you want to edit. 6. Select the desired component monitor whose assigned Application Monitor you want to edit. 7. Click Edit Assigned Application Monitor. 8. Edit the desired settings and then click Submit. The edited Application Monitor is displayed in the list of Assigned Application Monitors. Deleting Assigned Application Monitors To delete an assigned component monitor: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Assigned Component Monitors.
5. Select the desired component type or assigned Application Monitor whose component monitor(s) you want to delete. 6. Select the desired component monitor(s) that you want to delete. 7. Click Delete. 8. Click Yes to confirm the deletion of the component monitor(s).
6. Check the check box next to the component monitors you want in the new template. 7. Click Create New Template, specify the information for the new template, and then click Submit. Refer to the section Creating New Templates on page 240 for details about specifying the template information. Creating Assigned Application Monitors from Existing Component Monitors To create assigned Application Monitors from existing component monitors: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Templates. 5. Click Manage Component Monitors (within Templates), near the top right corner of the window. 6. Check the check box next to the component monitors you want in the assigned Application Monitors. 7. Click Assign to Node. 8. Specify the name for the application, polling frequency, and polling timeout. 9. If you want to turn on extended debug information to assist Customer Support, expand Advanced, set Debug logging On, and specify the Number of log files to keep. Here you can also select either 32bit or 64bit from the dropdown list entitled, Platform to run polling job on. Note: Do not turn on Debug logging unless directed by Customer Support. 10. Click Next. 11. Select the nodes for which you want to create the assigned Application Monitors, and then click Next. 12. If suitable credentials already exist, choose the credential from the Choose Credential list. 13. If suitable credentials do not exist, choose <New Credential> from the Choose Credential list, and then add the new credential by filling out the credential details.
258 Building Component Monitors and Templates
14. Click Test to test the credentials and component monitors against the test node. 15. If the test fails, troubleshoot the problem based on the error messages, and then retest the node. 16. If the test passes, click Assign Application Monitors. Copying a Component Monitor To copy a component monitor to a template or an assigned Application Monitor: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Manage Templates. 5. Click Manage Component Monitors (within Templates), near the top right corner of the window. 6. Check the check box next to the component monitors you want to copy. 7. Click Copy to. 8. If you want to copy to an assigned Application Monitor, click Copy to Assigned Application Monitor. 9. If you want to copy to a template, click Copy to Application Monitor Template. 10. Check the check boxes next to the template or assigned Application Monitors to which you wish to copy the component monitors, and then click Submit.
The following sections provide information and guidance to help you create some of the more complicated types of component monitors. Creating a Linux/Unix Script Monitor Creating a Windows Script Monitor Creating a Nagios Script Monitor Creating a Windows PowerShell Monitor For general information about the settings for each component monitor, click the More Information help link in the SolarWinds SAM component monitor description. Note: SolarWinds fully supports scripts written and provided by the company; however, we do not provide customer support for custom scripts written by outside sources. SolarWinds does provide sample scripts that we do support located at: C:\Program Files\SolarWinds\Orion\APM\Sample-Script Monitors. For information on using Data Transformations, refer to the following sections: Conversion Value Available Data Transformations
14. Click Get Script Output. SAM will then test the script by executing it and parse its output, then return the values. 15. Click Save. 16. Specify the critical and warning thresholds. 17. Click Submit. Here is a sample Perl script using the Linux/Unix component monitor returning multiple output pairs, in this case, two: Note: The code in red shows where the output pairs are defined.
#!/usr/bin/perl if (@ARGV[0] =~ /\bhelp\b/) { print "MemoryUsage.pl SNMPver community hostname\n"; print "SNMPver - version of SNMP protocol\n"; print "community - community name of SNMP protocol\n"; print "hostname - Target host\n"; exit 1; } # Get hostname and trim newline $localhost = `hostname`; $localhost =~ s/\s*$//g; $hostname = shift || $localhost; $community = shift || "public"; $version = shift || "v1"; $results = ""; $MIB_TotalMemory = "UCD-SNMP-MIB::memTotalReal.0"; #$MIB_TotalMemory = "UCD-SNMP-MIB::memTotalReal.0"; $outres = "snmpget -$version -c $community $hostname $MIB_TotalMemory |"; open(OUTMEM,$outres) || die "Unable read pipe\n"; while ($line = <OUTMEM>) { if ($line =~ /\bINTEGER\b/) { $indval = index($line,"="); $indval = index($line,":",$indval); $val = substr($line,$indval+1,length($line) $indval); $val =~ s/[a-zA-Z\/\n ]//g; print "Message.1: Available memory at host \"$hostname\": $val in kB\n"; print "Statistic.1: $val\n"; print "Message.2: Again, the available memory at host \"$hostname\": $val in kB\n"; print "Statistic.2: $val \n";
Linux/Unix Scripts Linux/Unix scripts are uploaded by SSH and then run on the target node using the string from the Command Line field. You can use the following variable in the command line field: ${SCRIPT} Replaced with the script body. You can use the following variables in the script body field: ${IP} Replaced with the target nodes IP address. ${USER} Replaced with the user name from the credential. ${PASSWORD} Replaced with the password from the credential. Example Scripts There are several sample scripts installed with SolarWinds SAM you can use to create Linux/Unix script component monitors. These sample scripts are installed on your SolarWinds SAM server, in the folder:
C:\Program Files\SolarWinds\Orion\APM\SampleScriptMonitors\LinuxSc ripts
Scripts Must Report Status Through Exit Codes Scripts must report their status by exiting with the appropriate exit code:
For example, if you want to inform SolarWinds SAM that a Script reports Up status, you would exit the script using code similar to the following, where 0 reports Up:
Wscript.quit(0)
Scripts with Text Output Scripts report additional details by sending text to the scripts standard output. In APM 4.0.2 and earlier, each line of output contained a single detail in the following format:
DetailType:Value # Script output comment Message: The directory contains too many files. Statistic: 5
While this is still true, SAM now supports multiple values returned by a script using the following format.
Statistic.Name1: x Message.Name1: abc Statistic.Name2: y Message.Name2: abc
Detail Type
Required
Meaning A numeric value used to determine how the monitor compares to its set thresholds. This must be an integer value, (negative numbers are supported).
Statistic
Yes
Message
No
There is a limit of ten Statistic and Message pairs for the script. These can be placed anywhere in the script output. The Statistic and Message names you give must contain valid letters and/or numbers. Note: A maximum of 10 output pairs can be returned. If you have exceeded the maximum allowed, remove the excess output pairs or they will simply be ignored. Sample output:
# Script comment: This shows two pairs. Ten pairs are possible. Statistic.CPU: 31.08 Message.CPU: svchost.exe cpu usage Statistic.RAM: 1234.56 Message.RAM: svchost.exe ram usage
For information on creating a Nagios Script Monitor, see "Creating a Nagios Script Monitor" on page 273.
Enable Component This option determines whether or not the component is enabled. Disabling this component leaves it in the application as deactivated and does not influence application availability or status. Credential for Monitoring Select a Windows credential that is both a user who can log on to the SolarWinds SAM server, and has sufficient rights on the target node to do whatever the script needs to do. For example, if the script does something with WMI, the credentials also need WMI rights on the target node. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential.
Script Engine This field allows you to specify the scripting language to be used. The default value is vbscript. Below is a list of scripting engines that the Windows Script Host supports: Name VBScript JScript PerlScript ooRexxScript PythonScript TclScript ActivePHPScript RubyScript Object Rexx engine Delphi scripting engine Roll-Up This option allows you to choose how you would like the monitor to report the returned results based on the output provided by the script. With the ability to have multiple values returned, selecting how your scripts report back to you offers more flexibility. The default selection is Show worst status. For more information, see Managing the Display of Group Status on page 180. Script This field allows you to enter the script you want to run on the target node. To enter your script, click the Edit button that reveals the script editing window. Script Arguments This field is in the script editing window and allows you to specify arguments to pass to the script. You may include the variables ${IP}, ${USER}, and ${PASSWORD}, which are replaced respectively by the IP address of the target node, the credential user name, and the credential password. Body This field is in the script editing window and allows you to enter your script via typing or pasting. File Extensions .vbs .js .pls .rxs .pys .tcls .phps .rbs Availability Installed by default Installed by default Freeware Freeware Freeware Freeware Freeware Freeware Commercial Commercial
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts" Creating a Windows Script Monitor You can create a Windows Script monitor to have SolarWinds SAM run a script using Windows Script Host. Windows Script Host comes with VBScript and Jscript, but can be extended with other scripting languages. Scripts run on the SolarWinds SAM server and use the credentials you specify. The script must both return an exit code and output a text string containing a statistic value conforming to the specifications described later in this section. Note: Format the Statistic value to use the same decimal separator as the SolarWinds SAM server. The SolarWinds SAM server uses the decimal separator set by its Microsoft Windows regional settings. To adapt an existing Visual Basic script to a Windows Script Monitor in a new template: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click the Applications tab. 3. Click SAM Settings. 4. Click Create a New Template underneath Application Monitor Templates. 5. Type a name for your template in the Template Name field. 6. If you want to turn on extended debug information to assist Customer Support, expand Advanced and then set Debug logging On and specify the Number of log files to keep. Here you can also select either 32bit or 64bit from the dropdown list entitled, Platform to run polling job on. Note: Do not turn on Debug logging unless directed by Customer Support. 7. Click Add Component Monitor. 8. Expand the Custom Component Monitors group, and then check Windows Script Monitor. 9. Click Submit. 10. Select credentials with the appropriate permissions to run the script on the SolarWinds SAM server, and that also has appropriate permissions to do whatever else the script requires.
268 Building Component Monitors and Templates
11. Copy the Visual Basic script into the Script Body field. 12. Type any script arguments into the Script Arguments field. 13. Specify the critical and warning thresholds. 14. Click Submit. Macros for Script Arguments Specify script arguments in the Script Arguments field if needed. You can use the following variables as script arguments: ${IP} This is replaced with the target nodes IP Address. ${USER} This is replaced with the user name from the credential set. ${PASSWORD} This is replaced with the password from the credential set. Scripts Must Report Status Through Exit Codes Scripts must report their status by exiting with the appropriate exit code:
Exit Code 0 1 2 3 Any other value Meaning Up Down Warning Critical Unknown
For example, if you want to inform SolarWinds SAM that a VBScript reports Up status, you would exit the script using code similar to the following, where 0 reports Up:
Wscript.quit(0)
Scripts with Text Output Scripts report additional details by sending text to the scripts standard output. In APM 4.0.2 and earlier, each line of output contained a single detail in the following format:
DetailType:Value # Script output comment Building Component Monitors and Templates 269
Administrator Guide SolarWinds Server & Application Monitor Message: The directory contains too many files. Statistic: 5
While this is still true, SAM now supports multiple values returned by a script using the following format.
Statistic.Name1: x Message.Name1: abc Statistic.Name2: y Message.Name2: abc
Detail Type
Required
Meaning A numeric value used to determine how the monitor compares to its set thresholds. This must be an integer value, (negative numbers are supported).
Statistic
Yes
Message
No
There is a limit of ten Statistic and Message pairs for the script. These can be placed anywhere in the script output. The Statistic and Message names you give must contain valid letters and/or numbers. Sample output:
# Script comment: This shows two pairs. Ten pairs are possible. Statistic.CPU: 31.08 Message.CPU: svchost.exe cpu usage Statistic.RAM: 1234.56 Message.RAM: svchost.exe ram usage
Example Scripts Below is a sample vbscript that returns two values; the total number of files in a folder, and twice the total number of files in the same folder. The code that represents these two values are bold, To use this script, copy and paste the following code into the Script Body field. In the Scripts Arguments field, type in C:\Windows, or any other folder you want to monitor.
If fso.FolderExists( path ) Then Set objDir = fso.GetFolder( path ) If( IsEmpty( objDir ) = True ) Then WScript.Echo "Message: Object Not Initialized" WScript.Echo "Statistic: 0" WScript.Quit( 1 ) End If Set objFiles = objDir.Files If( IsEmpty( objFiles ) = true) Then WScript.Echo "Message: Object Not Initialized" WScript.Echo "Statistic: 0" WScript.Quit( 1 ) End If WScript.Echo "Message.Total: " & CInt( objFiles.Count ) & " files in this folder." WScript.Echo "Statistic.Total: " & CInt( objFiles.Count ) WScript.Echo "Message.Twice: " & CInt( objFiles.Count*2 ) & " = twice the number files in this folder." WScript.Echo "Statistic.Twice: " & CInt( objFiles.Count*2 ) WScript.Quit( 0 ) Else WScript.Echo( "Message: Folder Not Found" ) WScript.Echo "Statistic: 0" WScript.Quit( 1 ) End If
There are several examples of Windows Script component monitors included in templates. These include: File Count, File Modified, LDAP Connection Monitor, Run 3rd Party Application, and Windows Event Log Count.
Sample scripts are installed on your SolarWinds SAM server, in the folder:
C:\Program Files\SolarWinds\Orion\APM\SampleScriptMonitors\Windows Scripts
For another example of a Windows Script component monitor, see Monitoring Large Directories on page 76.
If the Use Aggressive Host Checking option is enabled, return codes of 1 will result in a host state of DOWN, otherwise return codes of 1 will result in a host state of UP. Your Nagios script must exit with a valid return code and a line of text output. The exit code determines the status of the component. If the exit code is 0 (Ok), the component status may be further modified by thresholds from the optional statistics. To return up to ten optional statistics, separate the statistics from the status message with the pipe (|) symbol using the following syntax:
statusMessage [|'statisticName'=value]
Below is an example of valid output with a status message and two statistics:
The script ran. | 'CPU%'=75.2 'MemoryRemainingInKB'=600784
Statistic The statistic for this component monitor is the value returned by the script. For more information, see http://nagios.sourceforge.net/docs/3_0/pluginapi.html.
Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Component Type This describes the type of monitor you are using. Enable Component This option determines whether or not the component is enabled. Disabling this component leaves it in the application as deactivated and does not influence application availability or status. Credential for Monitoring Select a credential that can access the Linux or Unix server over SSH and that has sufficient rights to run scripts. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Port Number This field allows you to specify the port number used for the SSH connection. The default value is 22. Script Working Directory This field allows you to specify the working directory of the script process. Check Type This determines how the return code is evaluated. Status Roll-Up This option allows you to choose how you would like the monitor to report based on the output provided by the script. The default selection is Show worst status. For more information, see Managing the Display of Group Status" on page 180.
Command Line This field is in the script editing window and allows you to specify the shell command run after the SSH connection is established. The default command line value perl ${SCRIPT} arg1 arg2 attempts to run in a Perl interpreter the script defined in the Body field using the parameters arg1 arg2. Note: The length of the Command Line field is limited to 266 characters for Solaris systems, minus the length of the ${SCRIPT} variable after being resolved to a file name such as the following: APM_937467589.pl. Since the length of the file name will typically be around 16 characters, this means that the actual user Command Line input cannot be longer than 266 16, or 250 characters (not including the length of the 9 characters for the ${SCRIPT} variable itself). If you need to pass a longer command line to the target node, you can create a shell script on the target node (for example: myscript.sh) that contains the long command line and place the call to this script in the Command Line field, for example: /opt/sw/myscript.sh Body This field is in the script editing window and allows you to enter your script via typing or pasting. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
11. Select the Execution Mode to use: Local Host can run scripts only locally, that is, on the SolarWinds SAM server. Remote Host can execute scripts remotely (on the remote target node to which the Windows PowerShell monitor is assigned) using the Windows Remote Management (WRM) system component. WRM should be configured separately to get it working with the Windows PowerShell monitor. 12. Copy the following PowerShell script, which uses the Get-WmiObject call to measure the average ReadOperationCount for the lsass.exe process, into the Script Body field:
$avg = Get-WmiObject win32_process -ComputerName '${IP}' -Credential '${CREDENTIAL}' | Where-Object {$_.Name -eq "lsass.exe" } | Measure-Object -property ReadOperationCount -Average; Write-Host 'Statistic: ' exit(0) $avg.Average
The PowerShell code does the following: a. Reads the average ReadOperationCount information for the process lsass.exe from the computer whose IP address is specified by the variable ${IP}using the credential specified by the variable ${CREDENTIAL}. Note: The user name from the Credential for Monitoring that is specified is stored automatically in the ${CREDENTIAL} variable by the monitor. Therefore the ${CREDENTIAL} variable should not be placed in the Script Arguments field, since it is set automatically. When the script is run by powershell, since no password has been provided, it prompts for a password and the password from the Credential for Monitoring that is specified is provided automatically by the Windows Powershell monitor. b. Writes the statistic information gathered by the script. c. Exits the script.
Note: The script does no error checking. 13. Enter the following Script Arguments: Use the token ${IP}and the IP address will be filled in with the IP address of the target node. You can then access the value in the script body using the variable ${IP}. For example, if you type the following for Script Arguments:
${IP}
the PowerShell script will be able to access the IP address for the target node using the variable ${IP} in the script body. 14. Select Run the script under specified account to enable impersonation with the component's credentials. (This works only in local script execution mode.) 15. Select Count Statistic as Difference to change the statistic to be the difference in query values between polling cycles. 16. Change the Statistic Warning Threshold to greater than 800. 17. Change the Statistic Critical Threshold to greater than 1000. 18. Click Set test node. 19. Browse the tree view, select the desired target node for the PowerShell script, and then click SELECT. 20. Click Test. 21. If the test fails, see Troubleshooting the Lsass.exe PowerShell Monitor. 22. If the test passes, click Submit. 23. Click All in the Select tag to filter by list. 24. Locate the Lsass.exe PowerShell Monitor. Beneath the listed templates, locate the Page control. Click the right arrow twice to scroll to page 3. 25. Click the check box next to Lsass.exe PowerShell Monitor. 26. Click Assign to Node. 27. Expand the tree view and select the target node which you tested the script with in step 18. 28. Click Next. 29. Since you already assigned credentials and tested them in the template, check the check box next to Inherit credentials from template. 30. Click Test to confirm the credentials and component monitor against the test node.
278 Building Component Monitors and Templates
31. Click Assign Application Monitors. 32. Click Done. Troubleshooting the Lsass.exe PowerShell Monitor Verify that you are entering the user name and password of an administratorlevel account. If you think you have entered an incorrect credential, correct the mistake and then retest. Make sure that the RPC server is available and that the Windows PowerShell execution policy is not set to Restricted (the default setting). You can check the execution policy by entering the following command at the PowerShell command prompt:
Get-ExecutionPolicy
If you are having trouble using the Windows PowerShell Monitor, see the following KB article for some useful tips: http://knowledgebase.solarwinds.com/kb/questions/2203
9. Expand the folders by clicking the arrows (or [+]) to expand the tree view folder structure. From here you can drill down to select the attributes you want by checking them. 10. Click Next. Now you are able to edit the JMX Component Monitor properties. For more information, see "JMX Monitor" on page 597. For more information, see "JMX" on page 681.
6. If you want to turn on extended debug information to assist Customer Support, expand Advanced, set Debug logging On, and specify the Number of log files to keep. Here you can also select either 32bit or 64bit from the dropdown list entitled, Platform to run polling job on. Note: Do not turn on Debug logging unless directed by Customer Support. 7. Click Add Component Monitor. 8. Expand the Network Protocol Component Monitors list, and then check TCP Port Monitor. 9. Click Submit. 10. Click Rename and then type a name for the TCP port monitor. For example, type SolarWinds SAM SQL Server Port. Then click Ok. 11. Ensure the Port Number field corresponds to the port used to communicate with the SolarWinds SAM SQL Server instance. By default, this is port 1433. 12. Click Add Component Monitor. 13. Expand the Process and Service Component Monitors, and then check Windows Service Monitor and click Submit. 14. Click Rename and then type a name for the SolarWinds Alerting Engine monitor. For example, type SW Alerting Engine. Then click Ok. 15. Select the credential set you want to use when accessing the Windows service information. For more information about creating a credential set, see Understanding the Credentials Library on page 234. 16. Type the name of the SolarWinds Alerting Engine service in the Net Service Name field. Note: This field is the Service name of the service to monitor. You can find the Service name on Windows systems by clicking Start > Administrative Tools > Services and then locating the desired service. Right-click the service and select Properties from the context menu. The Service name is the value of the Service name field in the Properties dialog. For the SolarWinds Alerting Engine, this is typically SolarWindsAlertingEngine. 17. Repeat Steps 12 through 16 for the following SolarWinds SAM Windows services: SolarWinds Network Performance Monitor SolarWinds Job Engine v2 SolarWinds Job Scheduler SolarWinds Module Engine
282 Building Component Monitors and Templates
SolarWinds Syslog Service SolarWinds Trap Service 18. Click Add Component Monitor. 19. Expand the User Experience Component Monitors list, and then check HTTP Monitor. 20. Click Rename and then type a name for the HTTP port monitor. For example, type SolarWinds Web Console. Then click Ok. 21. Ensure the Port Number field corresponds to the port you use for the SolarWinds Web Console port. 22. Click Submit.
Conversion Value
Some monitors now offer the option to mathematically convert returned values through the use of Data Transformations. Checking the Convert Value checkbox opens the formula box that enables you to perform various mathematical functions. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. The Custom Conversion option offers more flexibility when manipulating returned values. This option allows you to use the basic arithmetic operators; +, -, *, /, along with built-in functions for more advanced conversions. For a list of these functions, see Available Data Transformations" on page 284. Following is a real world example for converting bytes into megabytes using a predefined formula, or data transformation. In this case, XtoMega, was used to convert bytes to megabytes.
With the XtoMega formula applied, the data transforms from 318767104 bytes to 304 megabytes, which is much easier to read.
Note: The Retrieve Current Value button tests the application and does not apply the data transformation. Instead, the original statistic value will be returned.
Eulers Number
E()
Pi
Pi() Round({value}, {number of decimal places}) Truncate({value},{numbe r of decimal places}) Sqrt({value}) Pow({base value}, {exponent value}) CToF({value})
Rounding
FToC({value}) XToKilo({value}) XToMega({value}) XToGiga({value}) XToTera({value}) KiloToMega({value}) KiloToGiga({value}) KiloToTera({value}) MegaToGiga({value}) MegaToTera({value}) GigaToTera({value}) TeraToKilo({value}) TeraToMega({value}) TeraToGiga({value})
Provides the Celsius result originally presented in Fahrenheit Provides the number of Kilobytes originally presented in Bytes Provides the number of Megabytes originally presented in Bytes Provides the number of Gigabytes, originally presented in Bytes Provides the number of Terabytes, originally presented in Bytes Provides the number of Megabytes, originally presented in Kilobytes Provides the number of Gigabytes, originally presented in Kilobytes Provides the number of Terabytes, originally presented in Kilobytes Provides the number of Gigabytes, originally presented in Megabytes Provides the number of Terabytes, originally presented in Megabytes Provides the number of Terabytes, originally presented in Gigabytes Provides the number of Kilobytes, originally presented in Terabytes Provides the number of Megabytes, originally presented in Terabytes Provides the number of Gigabytes, originally presented in Terabytes
X to Megabyte
X to Gigabyte
X to Terabyte Kilobyte to Megabyte Kilobyte to Gigabyte Kilobyte to Terabyte Megabyte to Gigabyte Megabyte to Terabyte Gigabyte to Terabyte Terabyte to Kilobyte Terabyte to Megabyte Terabyte to Gigabyte
charted information allows you to get a quick overview of what is being monitored and may answer why certain unexpected events are occurring.
The Multiple Statistic Chart can be added to either the Application Details page or the SAM Component Details page. To add the Multiple Statistic Chart to either page, take the following steps: 1. Drill down to either the Application Details page or the SAM Component Details page. 2. Click Customize Page on the far top right of the page. 3. Click the green [+] to the right of the column in which you want to add this chart. 4. Select and expand SAM Charts - Historical charts for SAM. 5. Check Multiple Statistic Chart, and then click Submit, then click Done. To configure the Multiple Statistic Chart, take the following steps: 1. Once the chart is on your Details page, click Edit at the top right of the chart.
2. From this page, you can 33several options to choose from, including: x) Title: This allows you to change the title of your chart. xi) Select a Time Period: This allows you provide a range for your chart. xii) Select a Sample Interval: This allows you to select how often the chart is updated. xiii) Chart All or Selected Statistics: This allows you to chart certain or all aspects of what you intend to monitor. For more information, see "Creating a Windows Script Monitor" on page 268.
Chapter 13
Last 25 Application Events Provides a list of the last twenty-five events associated with applications. For more information about creating alerts for these events, see Creating Alerts on page 305. thwack Community Latest Application Monitor Templates Provides a list of the newest Application Monitor templates that have been added to the thwack community web site. Click a template to open its download web page. Top XX Components by Statistic Data Provides a list of the monitors with the highest reported statistic data values. Because comparing disparate statistic measurements is of limited use, we suggest you create Statistic Data resource containing filters to limit the statistic sources. For example, you can show the statistic values only of the mail queue size of your Exchange servers. Top XX Components by Response Time Provides a list of the monitors with the slowest response time on the selected node. Top XX Processes by CPU Load Provides a list of the monitors consuming the most CPU on the selected node. Top XX Processes by Physical Memory Provides a list of the monitors consuming the most physical memory on the selected node. Top XX Processes by Virtual Memory Provides a list of the monitors consuming the most virtual memory on the selected node. SAM Sample Map Provides a sample map for SolarWinds SAM. All Groups Displays information for the selected SAM Groups.
Custom Object Resource Provides information for an object you select. Allows you to monitor a specific node, volume, application and component resources in a summary view. For example, you can now create a custom object resource to monitor Application Availability in a Network Summary view. For more information about a resource, click Help in the resource.
Application Availability Provides a bar chart of the application availability percentage. To modify the chart, click the title of the chart. Ensure you adjust your polling to less than the interval you want displayed in charts. Not adjusting your polling will result in gaps in your charts. For more information about a resource, click Help in the resource.
f Component Statistics Provides a number of gauges that pertain to the selected component. Response time is provided for port components. CPU load, physical memory, and virtual memory gauges are provided for process and service components. Note: SNMP process components do not include the virtual memory gauge. Component Details Provides a number of details about the component, including application status, component status, component type, component-specific properties, last up time, next poll time, and any warning or critical thresholds.
Component Availability Provides a chart of component availability. To modify the chart, click the chart title. Ensure you adjust your polling to less than the interval you want displayed in charts. Not adjusting your polling will result in gaps in your charts. Last 25 Component Events Provides the last 25 events specific to the component. Min/Max Average Response Time Provides a chart of the minimum, maximum, and average response times of the component. To modify the chart, click the chart title. This chart is available for port components only. Ensure you adjust your polling to less than the interval you want displayed in charts. Not adjusting your polling will result in gaps in your charts. Min/Max Average CPU Load Provides a chart of the minimum, maximum, and average CPU loads of the component. To modify the chart, click the chart title. This chart is available for access and process components only. Ensure you adjust your polling to less than the interval you want displayed in charts. Not adjusting your polling will result in gaps in your charts. Min/Max Average Physical Memory Provides a chart of the minimum, maximum, and average physical memory of the component. To modify the chart, click the chart title. This chart is available for access and process components only. Ensure you adjust your polling to less than the interval you want displayed in charts. Not adjusting your polling will result in gaps in your charts. Min/Max Average Virtual Memory Provides a chart of the minimum, maximum, and average virtual memory of the component. To modify the chart, click the chart title. This chart is available for access and process components only. Ensure you adjust your polling to less than the interval you want displayed in charts. Not adjusting your polling will result in gaps in your charts. Min/Max Average Statistic Data Provides a chart of the minimum, maximum, and average statistic data of the component. To modify the chart, click the chart title. This chart is available for access and process components only. Ensure you adjust your polling to less than the interval you want displayed in charts. Not adjusting your polling will result in gaps in your charts.
Viewing Application and Component Performance and Status 293
6. Click Submit. 7. Click Done on the Customize Node Details page. 8. Navigate to a node with which you have associated an application and review the new resources.
Linux Summary information for applications with Linux in the application name. Summary View Filtering Criteria Each summary view may be filtered by only one view limitation entry, but some view limitation entries allow you to select more than one criteria. For example, the Group of Application Names limitation allows you to select multiple application names. In addition to the standard view limitations of SolarWinds common components, the following view limitations are also available in SolarWinds SAM: Application Name Pattern Limit the view to an assigned application or applications fitting a certain naming pattern. Enter the naming pattern and then click Submit. The asterisk (*) is a valid wildcard for this view limitation type. Group of Application Names Limit the view to a group of assigned applications that share the same application names. You may select multiple application names for this group. Select the applications from the list and then click Submit. Specific Applications Limit the view to individual applications assigned to specific nodes. Select the assigned applications, and then click Submit. To create a Filtered Applications Summary view based on the default SAM Application Summary view: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click Settings near the top right corner of the window, and then click Manage Views. 3. Select SAM Application Summary and then click Copy. 4. Select Copy of SAM Application Summary and then click Edit. 5. Click Edit in the View Limitation section. 6. Select a view limitation and click Continue. For example, Application Name Pattern. 7. Enter the view limitation criteria and then click Submit. For example:
*Oracle*
8. Enter a new name for this summary view and then click Update. For example: SAM Oracle Application Summary
296 Viewing Application and Component Performance and Status
9. Click Done. To add a summary view menu item to the menu bar in the Applications tab: 1. Log on to your SolarWinds Web Console with an Administrator account. 2. Click Settings near the top right corner of the window, and then click Manage Views. 3. Select the summary view you want to add and then click Edit. For example: SAM Oracle Application Summary. 4. Click Preview. 5. On the preview page, make note of the URL field of the browser. For example, http://SolarWinds/SolarWinds/SummaryView.aspx?viewid=27 6. Click Settings near the top right corner of the window, and then click Customize Menu Bars. 7. Click Edit in the Admin Menu Bar section. 8. Scroll to the bottom of the Available Items list and then click Add. 9. Enter a name for the menu item. For example: Oracle 10. Enter the URL of the summary view. 11. Click Ok. 12. Drag the new menu item from the Available Items list to the Selected Items list and then click Submit.
To customize the default SAM application details view: 1. Find an Application Monitor that is using the default view by following these steps: a. Click Settings and then click SAM Settings. b. Click Manage Application Monitors. c. Find an assigned Application Monitor without a Custom View. d. Return to Applications > SAM Summary. 2. Click the Application Monitor to view its application details page. 3. Click Customize Page. 4. Proceed with your customizations. Custom Application Details View You can select and create a custom application details view. This custom view is applied at the template level. Applications inherit the custom view setting from their templates in the same way as other template settings. To customize an application details view for an assigned Application Monitor: 1. Click Settings and then click SAM Settings. 2. Click Manage Application Monitors. 3. Check the check box next to an Application Monitor and then click Edit Properties. 4. Click Modify Template Settings in the field Custom Application Details View. 5. Select Yes, use <TemplateName> Details View in the field Custom Application Details View, where TemplateName is the name of the selected Application Monitor template. 6. Click Submit. 7. Click the name of the assigned Application Monitor to view its application details page. 8. Click Customize Page. 9. Proceed with your customizations. After creating a customized application details view for a template, you can change the Custom Application Details View setting in the template properties to switch between the default view and the custom view.
Managing Custom Application Details Views For each template or application based upon a template, you can select either the default application details view or the template's custom details view. To select a view for a template: 1. Click Settings and then click SAM Settings. 2. Click Manage Templates. 3. Check the check box next to a template and then click Edit. 4. If you want applications based on this template to use the default view, set Custom Application Details View to No, use Default Application Details View. 5. If you want applications based on this template to use the custom view, set Custom Application Details View to Yes, use <TemplateName> Details View, where TemplateName is the name of the selected template. 6. Click Submit. To select a view for an application: 1. Click Settings and then click SAM Settings. 2. Click Manage Application Monitors. 3. Check the check box next to an Application Monitor and then click Edit Properties. 4. Click Modify Template Settings in the field Custom Application Details View. 5. If you want this application to use the default view, set Custom Application Details View to No, use Default Application Details View. 6. If you want this application to use the custom view, set Custom Application Details View to Yes, use <TemplateName> Details View, where TemplateName is the name of the selected template. 7. Click Submit.
Node Tooltips
Hover over To see Current status of the node (up, down, warning, unplugged, or unmanaged) Note: SolarWinds SAM now supports the ability to include applications in calculation of node child status. So if node is up, but application on that device is down, you will see a child status icon indicating there is a problem. The IP address currently assigned to the selected node The vendor icon and vendor description of the selected node The measured average response time of the selected node as of the last node poll The percent of all transmitted packets that are lost by the selected node as of the last node poll The percent of available processing capacity on the selected node that is currently used as of the last node poll The percent of available memory on the selected node that is currently used as of the last node poll Number of running VMS and total VMS Status of the ESX Host
Node Status
IP Address Machine Type Average Response Time Packet Loss CPU Load Memory Used # of Running VMS ESX Host Status
Application Tooltips
Hover over App Name App Status Server Status Components with Problems To see The name of the application. The status of the application (up, down, unknown, warning, or critical). Operational status of the server (up, down, warning, unplugged, or unmanaged). List of the components with problems and their statuses.
Note: The Network Event Log is maintained as part of the Nightly Database Maintenance plan defined within the Database Settings area of the SolarWinds Polling Setting page in the SolarWinds Web Console. Records are kept for the number of days specified Events Retention field (the default is 30 days). For more information, see Orion Polling Settings on page 202. To view event details in the Web Console: 1. Click Start > All Programs > SolarWinds > SolarWinds Web Console. 2. Log in to the SolarWinds Web Console, and then click Events in the Views toolbar. 3. If you want to filter your events view by object, select the Network Object or Type of Device to which you want to limit your view in the Filter Devices area. 4. If you want to limit your events view to show only events of a specific type, select the appropriate Event Type in the Filter Events area. 5. If you only want to see events from a specific period of time, complete either of the following options: Select a predefined period from the Time Period menu. Select Custom from the Time Period menu, and then click the appropriate fields to provide Begin and End dates and times. 6. In the Show X Events field, provide the maximum number of events you want to view. 7. If you want to show all events, including events that have already been cleared, check Show Cleared Events. 8. Click Refresh to complete your events view configuration.
5. Check individual events to acknowledge or click Select All. 6. Click Clear Selected Events.
Chapter 14
4. Select a Custom Property. Notes: If Custom Property is empty, you need to define a custom property. For more information, see Creating Custom Properties on page 453. The remaining boxes are populated automatically, based upon your selection. 5. Choose a Selection Method. Note: This is the selection format that will appear when you are choosing values for the account limitation through the web Account Manager. For more information, see Setting Account Limitations on page 192. 6. If you want to include your own description of your account limitation, type your description over the default text provided in the Description field. 7. Click Ok. Your newly defined account limitation is added to the top of the table view. You may now use the new limitation in the SolarWinds Web Console Account Manager. For more information, see Setting Account Limitations on page 192.
Chapter 15
Creating Alerts
SolarWinds SAM provides application and component alerts you can use with SolarWinds Advanced Alert Manager to actively monitor and respond to detected issues. Note: Only advanced alerts may be used for SolarWinds SAM-specific purposes. Basic alerts cannot be configured to trigger on SolarWinds SAM conditions or events. Refer to the following sections for more information: Configuring SolarWinds SAM Alerts
8. Click the remaining asterisk (*) in the statement Component Status is equal to *. 9. Type Critical in the list box. To set up the alert trigger action: 1. Click the Trigger Actions tab. 2. Click Add New Action. 3. Select Log the Alert to the NetPerfMon Event Log, and then click Ok. 4. Type "The component" in the message field, and then click Insert Variable. 5. Select APM:Component from the Variable Category list, select ComponentName from the Select A Variable list, and then click Build Selected Variable. 6. Type "of node" in the message field, and then click Insert Variable. 7. Select General from the Variable Category list, select NodeName from the Select A Variable list, and then click Build Selected Variable. 8. Type "is" in the message field, and then click Insert Variable. 9. Select APM:Component from the Variable Category list, select ComponentStatus from the Select A Variable list, and then click Build Selected Variable. Note: The full message should read "The component ${ComponentName} of node ${NodeName} is ${ComponentStatus}. 10. Click Ok to close the Log Alert window. 11. Click Ok to close the Edit Alert window. 12. Click Done to close the Manage Alerts window. If any of your components go into a critical state, you will now see a line item for each in the SolarWinds SAM Event Log. Example 2: Displaying Root Cause of Group Status in SolarWinds SAM Alert This example sets up an alert that is triggered when the group is Down, displays the root cause for the groups status in the alert, and logs the alert to the NetPerfMon event log. To set up this alert trigger condition: 1. Click New in the Manage Alerts window. 2. Type Alert me and show the root cause for the groups status in the Name of Alert field.
Alerting and Reporting 307
3. Click the Trigger Condition tab. 4. Select Group from the Type of Property to Monitor list. 5. Click Add, and then click Simple Condition from the shortcut menu. 6. Click the first asterisk (*) in the statement * is equal to *. 7. Point to Group and then click Group Status in the shortcut menu. 8. Click the remaining asterisk (*) in the statement Group Status is equal to *. 9. Type Down in the list box. To set up the alert trigger action: 1. Click the Trigger Actions tab. 2. Click Add New Action. 3. Select Log the Alert to the NetPerfMon Event Log, and then click Ok. 4. Type "Group" in the message field, and then click Insert Variable. 5. Select Group from the Variable Category list, select ContainerName from the Select A Variable list, and then click Build Selected Variable. 6. Type "is" in the message field, and then click Insert Variable. 7. Select Group from the Variable Category list, select ContainerStatusName from the Select A Variable list, and then click Build Selected Variable. 8. Type " because " in the message field, and then click Insert Variable. 9. Select Group from the Variable Category list, select StatusRootCause from the Select A Variable list, and then click Build Selected Variable. Note: The full message should read "Group ${ContainerName} is ${ContainerStatusName} because ${StatusRootCause}. 10. Click Ok to close the Log Alert window. 11. Click Ok to close the Edit Alert window. 12. Click Done to close the Manage Alerts window. If any of your groups go into a Down state, you will now see a line item for each that displays the first-level root cause of the group status for the alert in the SolarWinds SAM Event Log. For example, Group g3 is Down because Internet Information Services on TESTBED is Down.
Note: SolarWinds SAM does not recurse into a sub-group with problems to locate the root cause for the problem status ${StatusRootCause}. For example, if an object 2 levels deep inside a sub-group is actually responsible for the problem status, SolarWinds SAM will not recurse all the way down inside the sub-group to name the actual object that is responsible for the problem. It simply reports the sub-groups name and its status.
Component Status This allows you to alert on Critical, Down, Unknown, Up, and Warning status. Response Time This allows you to alert on response time. Statistic Data This allows you to alert on statistic data.
Process (Service) Name This allows you to alert on the process or service name. For example: dns.exe, or AlertingEngine. Process Instance Count This allows you to alert on the instance count of a process. Percent CPU This allows you to alert on the percentage of CPU in use. Percent Physical Memory This allows you to alert on the percentage of physical memory in use. Percent Memory Used This allows you to alert on the percentage of total memory in use. Percent Virtual Memory This allows you to alert on the percentage of virtual memory in use. Virtual Memory Used This allows you to alert on the amount of virtual memory in use, in bytes. Application Monitor Alerting properties Below are alert possibilities: Application Name This allows you to select the names of currently configured application templates as values. Application Status This allows you to select whether the application is in a Critical, Down, Unknown, Up, or Warning status.
Application Monitor Variables for Alerts SolarWinds SAM adds the following variables to the core SolarWinds Orion variables when selecting APM-Application as the property type. For a complete list of Core variables, see "SolarWinds Variables and Examples" on page 469.
Application Variable Definition Hyperlink to application details page that is either the current alert triggered on or the details page of the application that the component that triggered the alert belongs to. Provides the status of the application. Provides a commadelimited list of components in a down, unknown, warning, or critical state. List of components that are not up along with component status included formatted with html tags. Html formatting is used for send e-mail action to provide improved appearance of listed components. List of components that are not up along with component status included. Formatted with html tags for events that appear on the web console. Provides a commadelimited list of all components and their current status. List of components with component status included formatted with html tags. Html formatting is used for send e-mail action to provide improved appearance of listed components. List of components with component status Formatted with html tags for events that appear on the web console.
${APM:ApplicationDetailsURL}
${Availability}
${ComponentsWithProblems}
${ComponentsWithProblemsFormatted}
${ComponentsWithProblemsFormattedHtml}
${ComponentsWithStatus}
${ComponentsWithStatusFormatted}
${ComponentsWithStatusFormattedHtml}
${ID}
${LastTimeUp}
${Name}
${NodeID}
${SystemSummaryFormatted}
${SystemSummaryFormattedHtml}
${TimeStamp}
Component Monitor Variables for Alerts SolarWinds SAM adds the following variables to the core SolarWinds Orion variables when selecting APM-Component as the property type.
Component Monitor Variable ${APM:ComponentDetailsURL} ${ApplicationId} ${ApplicationName} ${ApplicationStatus} ${ComponentId} ${ComponentMessage} ${ComponentName} ${ComponentStatus} ${ComponentType} Definition Hyperlink to component details page that is the current alert triggered on. Provides the unique numeric identifier of the application. This value is analogous to the node ID. Provides the name of the monitored application. Provides the status of the application. Provides the numeric component ID of the specific application. Message sent when alerting on component status. Provides the name of the component, for example, SW Module Engine. Provides the status of the specific component. Provides the numeric component type. For more information, see SolarWinds SAM Alerts on page 309.
${UserDescription}
${UserNotes} ${VirtualMemoryUsed}
a. Select Alert on Network Node, and then select the parent node of the volume against which you want to test the action. b. Select Select Volume on ParentNode, and then select the volume against which you want to test the action. 8. To test an alert trigger action, click Test Alert Trigger. 9. To test an alert reset action, click Test Alert Reset. 10. When the test completes, as indicated by the test log, click Done. Confirm that the expected action occurred as a result of the selected alert trigger or reset.
1. Log in to the SolarWinds Web Console using an account that has been granted alert acknowledgement privileges. Note: For more information about access privileges for SolarWinds Web Console users, see User Account Access Settings on page 190. 2. Click Alerts on the Views toolbar. 3. To limit the list of alerts to only those dealing with a single device, select the specific device from the Network Object list. Note: This option is only available if alerts fire on multiple network devices. 4. To limit the list of alerts to only those dealing with a single type of device, select the device type from the Type of Device list. Note: This option is only available if SolarWinds is monitoring multiple types of network devices. 5. To limit the list of alerts to only those of a single type, select the specific alert type from the Alert Name list. Note: This option is only available when multiple types of SolarWinds SAM alerts have been triggered. 6. Confirm the number of alerts displayed in the Show Alerts field. 7. If you want acknowledged alerts to remain in the Alerts view, even after they have been acknowledged, check Show Acknowledged Alerts. 8. Click Refresh to update the alerts list with your new settings. 9. Check Acknowledged next to the alerts you want to acknowledge. 10. Click Acknowledge Alerts.
Clickable links in alert messages provide more information about triggered alerts.
second.
-h = This is help text.
To manually determine the Component ID number, go to the Component Details View in the Web Console. The number after AM: in the URL of the page is the Component ID. For example:
http://localhost/SolarWinds/SAM/MonitorDetails.aspx?NetObject=AM:1 1
Using the Preconfigured Restart a Service Alert The SolarWinds Alert Manager includes a pre-configured alert called Restart a Service that has a recovery action to restart a service if a Windows service component monitor is down. You must enable this alert manually because it is disabled by default. To enable the Restart a Service alert: 1. Click Start > All Programs > SolarWinds > Alerting, Reporting, and Mapping > Advanced Alert Manager. 2. Click Configure Alerts. 3. Check Restart a Service. 4. Click Done.
3. Click New.
The Edit Alert window displays, providing an array of configurable alerting options, including trigger and reset conditions, suppressions, and date and time limitations. The following sections provide more information about configuring alert options.
4. To copy or edit an existing alert, select an alert from the list, and then click Copy or Edit, as appropriate.
5. Click General, type the name of your alert in the Name of Alert field, and then type a description of your alert in the description field.
7. Type the Alert Evaluation Frequency and select Seconds, Minutes, or Hours from the list to set the checking interval for your alert.
8. Click Trigger Condition to set the trigger condition for your alert. For more information, see Setting a Trigger Condition for an Advanced Alert on page 322.
4. To copy or edit an existing alert, select an alert from the list, and then click Copy or Edit, as appropriate. 5. Click Trigger Condition. 6. Select the Type of Property to Monitor from the list. Note: The following image is a screen capture from a SolarWinds Network Performance Monitor installation. Other modules will look similar, but different objects may be present.
7. If you select Custom SQL Alert, complete the following steps: a. Select the object on which you want to alert in the Set up your Trigger Query field. b. Provide your custom SQL in the field below the object selection query. c. To delay the trigger of this alert, provide the value and unit of your desired alert trigger delay. d. To confirm your provided SQL, click Validate SQL. 8. If you select a type of monitored object, complete the following steps: a. Generate trigger conditions in the text field by selecting appropriate descriptors from the linked context menus and by clicking Browse () on the left of the text field. b. Click the linked text to select the number of conditions that you want to apply (all, any, none, not all). For more information about linked text conditions, see Understanding Condition Groups on page 330.
c. Click Browse () to view the following condition options: Note: The has changed condition is only valid for the Last Boot, IOS Version, and IOS Image Family device characteristics.
To generate a condition based on a comparison of device states, click Add a Simple Condition.
To generate a condition based on a comparison of device fields and values, click Add a Complex Condition. To define more conditions, click Add a Condition Group. To remove a selected condition, click Delete Current Condition. To change the order of your conditions, click Move Down or Move Up, as appropriate. d. To add a condition, click Browse (), and then click Add ConditionType, as appropriate for the condition you want to add. e. To delete a condition, click Browse (), next to the condition you want to delete, and then click Delete Current Condition. Notes: Conditions may be exported for use with other alerts by clicking Export Conditions and saving as appropriate. Click Import Conditions to import existing conditions from other alerts. Imported trigger conditions automatically overwrite any existing trigger conditions.
f.
To specify a time duration for the condition to be valid, type the interval and select Seconds, Minutes, or Hours from the list. Note: You may need to delay alert trigger actions until a condition has been sustained for a certain amount of time. For example, an alert based on CPU load would not trigger unless the CPU Load of a node has been over 80% for more than 10 minutes. To set up a sustained-state trigger condition, at the bottom of the Trigger Condition tab, provide an appropriate amount of time the alert engine should wait before any actions are performed. By default, the alert triggers immediately, if the trigger condition exists. The maximum alert action delay is eight hours after the trigger condition is met.
8. Click Browse () to view the following condition options: To generate a condition based on a comparison of device states, click Add a Simple Condition. To generate a condition based on a comparison of device fields and values, click Add a Complex Condition. To further define condition application, click Add a Condition Group. To remove a selected condition, click Delete Current Condition. To change the order of your conditions, click Move Down or Move Up. 9. To add a condition, click Add, and then select the type of condition you want to add. 10. To delete a condition, select the condition from the condition list, and then click Delete. Notes: Conditions may be exported for use with other alerts by clicking Export Conditions and saving as appropriate. Conditions from other alerts may be imported to the current alert by clicking Import Conditions. Warning: Imported trigger conditions automatically overwrite any existing trigger conditions. Because there are many situations where the reset conditions are the opposite of, or are very similar to, the trigger conditions, SolarWinds has provided a function that copies the trigger conditions to the reset conditions. Click Copy From Trigger to add the trigger condition. 11. To specify a time duration for the condition to be valid, type the time interval and select Seconds, Minutes, or Hours from the list. Note: It is often appropriate to delay alert reset actions until a condition has been sustained for a certain amount of time. For example, an alert based on node status would not reset until the node has been up for more than five minutes. To establish a sustained-state reset condition, provide an appropriate interval at the bottom of the Reset Condition tab for the amount of time that the alert engine should wait before any actions are performed. The default setting is to reset the alert immediately, once the reset condition exists. The maximum interval between when the trigger condition first exists and when the corresponding alert action is performed is eight hours. 12. When done, click OK.
To further define the application of your conditions, click Add a Condition Group. To remove a selected condition, click Delete Current Condition. To change the order of your conditions, click Move Down or Move Up. 9. To add a condition, click Add and then select the type of condition you want to add. 10. To delete a condition, select the condition from the condition list, and then click Delete. Note: Conditions may be exported for use with other alerts by clicking Export Conditions and saving as appropriate. Conditions from other alerts may be imported to the current alert by clicking Import Conditions. Warning: Imported conditions automatically overwrite existing conditions. 11. If you are finished configuring your advanced alert, click Ok.
1. Click Start > SolarWinds > Alerting, Reporting, and Mapping > Advanced Alert Manager. 2. Click View > Configure Alerts. 3. Click New or select an alert from the list, and then click Copy or Edit, as appropriate. 4. Click Trigger Actions. 5. To add a new advanced alert action, click Add New Action, and then select the actions you want to occur when the alert triggers. 6. To edit an existing advanced alert action, select the existing alert action, and then click Edit Selected Action. 7. Follow the instructions to configure each action. Note: Depending on the type of action selected, different options will be displayed to configure the alert action. For more information about individual alert actions, see Alerting and Reporting" on page 305. 8. To delete an action, select the action and then click Delete Selected Action. 9. When done, click OK.
7. Follow the instructions to configure each action. Note: Depending on the type of action selected, different options display configuring the alert action. For more information about individual alert actions, see Escalated Advanced Alerts" on page 349. 8. To delete a selected action, click Delete Selected Action. 9. When done, click OK.
Alert Escalation
When editing any trigger or reset action, use the Alert Escalation tab, if it is available, to define additional alert action options. Depending on the alert action being configured, any or all of the following options may be available on the Alert Escalation tab: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay the execution of the alert action, check Delay the execution of this Action and then provide an appropriate interval that the alert engine should wait after the alert condition is met before the alert action is executed. For more information, see Escalated Advanced Alerts on page 349.
condition in the group must be true before the alert is triggered. In the following example, there are three conditions within the condition group: Node Status is equal to Up Percent Loss is greater than or equal to 75 CPU Load is greater than or equal to 85
330 Alerting and Reporting
This alert will not trigger unless the Node is Up, packet loss is greater than or equal to 75%, and CPU load is greater than or equal to 85%. When setting the condition group to all, picture every condition as being separated by an and statement. So, in this example, the alert trigger would read:
Alert when: (Node Status = Up) and (Percent Loss >= 75) and (CPU Load >= 85)
Any Condition Group Changing the condition group to Trigger Alert when any of the following apply changes the logic to or statements. In this example, changing the condition group to any would change the alert trigger to:
Alert when: (Node Status = Up) or (Percent Loss >= 75) or (CPU Load >= 85)
In this situation, if any of the three conditions become true, the alert will trigger. None Condition Group Changing the condition group to Trigger Alert when none of the following apply means that all conditions in the group must be false before the alert is triggered. In this example the alert trigger would read:
Alert when: (Node Status = Down) and (Percent Loss <= 75) and (CPU Load <= 85)
Each condition is separated by an and statement just like the all condition group; however, the conditions have been inverted (Node Status = Down instead of Node Status = Up). Not All Condition Group Changing the condition group to Trigger Alert when not all of the following apply means that any condition in the group must be false before the alert is triggered. So, in this example the alert trigger would read:
Alert when: (Node Status = Down) or (Percent Loss <= 75) or (CPU Load <= 85)
Each condition is separated by an or statement just like the any condition group; however, the conditions have been inverted (Node Status = Down instead of Node Status = Up).
Note: The states of Down and Unreachable are not equivalent. They are two distinct states. For example: If the trigger condition, Status is not equal to Up, is met, an alert will be triggered for Unreachable applications.
5. Click Refresh to update the Current Events window with the latest events and column IDs. 6. To acknowledge a network event, click X next to the event. Active Alerts Window The Active Alerts window of the Advanced Alert Manager shows network alerts with their descriptions and other information from the alerts log. To use the Active Alerts window to view active network alerts: 1. Click Start > All Programs > SolarWinds > Alerting, Reporting, and Mapping > Advanced Alert Manager. 2. Click View > Active Alerts. 3. Select one of the Group By criteria for grouping alerts: Alert Name, Object Type, Object Name, Alert State, Acknowledged, Acknowledged By, or No Grouping. 4. Click Include, and then check the types of alerts that you want to view: Acknowledged, Trigger Pending, Triggered, or Reset Pending. 5. To change the viewable category columns in the Current Events window, click Include > Select Alert Columns, and then complete the following procedure: a. Select column IDs from the All Columns field. b. Click the right arrow to move your column IDs into the Selected Columns field. c. If there are any column IDs in the Selected Columns field that you do not want to view, select them, and then click the left arrow to move your selected column IDs to the All Columns field. d. Click the up or down arrows to change the order of your selected columns accordingly. e. Position the slider to set the Alert View refresh rate. f. When done, click OK.
6. Click Refresh to update the Active Alerts window with the latest alerts and column IDs. 7. Click Configure Alerts to change the settings for individual alerts. For more information, see Creating and Viewing Reports" on page 353. 8. To acknowledge an active alert, check the alert in the Acknowledged column. Note: As soon as the alert is acknowledged, the user information and date/time
Alerting and Reporting 333
is recorded in the database. Alert Viewer Settings Alert views in the SolarWinds Advanced Alert Manager are configured in the Alert Viewer Settings window, as presented in the following procedure. To configure alert views in the Advanced Alert Manager: 1. Click Start > All Programs > SolarWinds > Alerting, Reporting, and Mapping > Advanced Alert Manager. 2. Click File > Settings. Note: The Configure Alerts tab of the Alert Viewer Settings window displays all available network alerts, and from this window you can create, copy, edit, and delete alerts. 3. Click Alert View Columns. 4. Select the information titles that you want to see about your alerts from the All Columns list. 5. Click the right arrow to transfer them to the Selected Columns list. Note: The Selected Columns list provides a list of all the information that the Alert Viewer will show for each active alert. 6. To remove titles from the Selected Columns list, select titles that you want to remove from the active view in the Selected Columns list, and then click the left arrow. 7. To rearrange the order in which the different pieces of alert information are presented in the Alert Viewer, select titles from the Selected Columns list and use the up and down arrows to arrange the titles accordingly. 8. Position the slider at the bottom of the tab to set the Alert View refresh rate. 9. Click Event View Columns. 10. Select the information titles that you want to see about events from the All Columns list. 11. Click the right arrow to transfer them to the Selected Columns list. Note: The Selected Columns list provides a list of all the information that the Alert Viewer will show for each recorded event. 12. To remove titles from the Selected Columns list, select titles that you want to remove from the active view in the Selected Columns list, and then click the left arrow.
13. To rearrange the order in which the different pieces of event information are presented in the Alert Viewer, select titles from the Selected Columns list and use the up and down arrows to arrange the titles accordingly. 14. Position the slider at the bottom of the tab to set the Event View refresh rate. 15. Enter the number of events that you want to see in the Event View.
Sending a Windows Net Message Sending an SNMP Trap Using Get or Post URL Functions Dial Paging or SMS Service
8. Type the Hostname or IP Address of your SMTP Server and the designated SMTP Port Number. Note: The SMTP server hostname or IP address field is required. You cannot send an email/page alert without identifying the SMTP server. 9. To use SSL/TLS encryption for your alert email, check Enable SSL. 10. If your SMTP server requires authentication, check This SMTP Server requires Authentication. 11. Click Time of Day. 12. Enter the time period over which you want to activate your alert action, and then select the days on which you want to activate your alert action. 13. To enable alert escalation, click the Alert Escalation tab, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval the alert engine should wait after the alert condition is met before the alert action is executed. 14. When done, click OK.
Playing a Sound
SolarWinds can be configured to play a sound upon alert trigger or reset. The following procedure configures a sound to play for an advanced alert. Note: Due to restrictions on Windows service applications, the Play a Sound action is not available to SolarWinds installations on either Windows 7 or Windows Server 2008 and higher. To configure a play sound action for an advanced alert: 1. Click Play Sound. 2. Specify a sound file for the alert trigger by doing either of the following in the Sound file to play field: Type the complete directory path and file name. Click Browse () to navigate your file system and select the target file.
3. Click the musical note button to the right of either text field to test the sound file you have specified. 4. Click Time of Day. 5. Enter the time period over which you want to activate your alert action, and then select the days on which you want to activate your alert action. 6. To enable alert escalation, click Alert Escalation, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval the alert engine should wait after the alert condition is met before the alert action is executed. 7. When done, click OK.
d. To define the SQL variable to copy to the clipboard, check Define SQL Variable, and then click Insert Variable From Above List. e. Click Build Selected Variable. Note: For more information about messages that use variables, see SolarWinds Variables and Examples" on page 469. 4. Click Time of Day. 5. Enter the time period over which you want to activate your alert action. 6. Select the days on which you want to activate your alert action. 7. To enable alert escalation, click the Alert Escalation tab, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval the alert engine should wait after the alert condition is met before the alert action is executed. 8. When done, click OK.
b. Select a Variable Category. c. Select the variable you want to add. d. To change the parser, check Change Parser, and then select the parser you want to use. e. To define the SQL variable to copy to the clipboard, check Define SQL Variable, and then click Insert Variable From Above List. f. Click Build Selected Variable. Note: For more information about messages that use variables, see SolarWinds Variables and Examples" on page 469. 6. Click Time of Day. 7. Enter the time period and select the days over which you want to activate your alert action. 8. To enable alert escalation, click Alert Escalation, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval the alert engine should wait after the alert condition is met before the alert action is executed. 9. When done, click OK.
c. Select the variable you want to add. d. To change the parser, check Change Parser, and then select the parser you want to use. e. To define the SQL variable to copy to the clipboard, check Define SQL Variable, and then click Insert Variable From Above List. f. Click Build Selected Variable. Note: For more information about messages that use variables, see SolarWinds Variables and Examples" on page 469. 4. Click Time of Day. 5. Enter the time period and select the days over which you want to activate your alert action. 6. To enable alert escalation, click Alert Escalation, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval the alert engine should wait after the alert condition is met before the alert action is executed. 7. When done, click OK.
Note: For more information, see Using the SolarWinds Web Console Message Center" on page 145. 4. Select Facility of your alert Syslog message. Note: For more information, see Using the SolarWinds Web Console Message Center" on page 145. 5. Type the Syslog Message you want to send. 6. To insert a variable into the Message field, complete the following procedure: a. Click Insert Variable. b. Select a Variable Category. c. Select the variable you want to add. d. To change the parser, check Change Parser, and then select the parser you want to use. e. To define the SQL variable to copy to the clipboard, check Define SQL Variable, and then click Insert Variable From Above List. f. Click Build Selected Variable. Note: For more information on the use of variables, see Syslog Alert Variables." 7. Click Time of Day. 8. Enter the time period over which you want to activate your alert action. 9. Select the days on which you want to activate your alert action. 10. To enable alert escalation, click Alert Escalation, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval the alert engine should wait after the alert condition is met before the alert action is executed. 11. When done, click OK.
3. Specify a VB script to execute either by typing the complete path and name of the VB script into the VB Script to execute field or by clicking Browse () to browse your folder structure and select the script. 4. Click Time of Day, and then enter the time period and select the days on which you want to execute the selected VB script. 5. Click Alert Escalation, and then check any of the following options, as appropriate for your alert: To disable the script when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the script repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay script execution, check Delay the execution of this Action, and then provide an appropriate interval the alert engine should wait after the alert condition is met before the script executes. 6. When done, click OK.
Note: Messaging is disabled if both Subject and URL fields are empty. 6. ITo insert a variable into the Subject field, click the location of the new variable, and then complete the following procedure: a. Click Insert Variable, select a Variable Category, and then select the variable to add. b. To change the parser, check Change Parser, and then select the parser you want to use. c. To define the SQL variable to copy to the clipboard, check Define SQL Variable, and then click Insert Variable From Above List. d. Click Build Selected Variable. Note: For more information on the use of variables, see Syslog Alert Variables," on page 426. 7. Provide the URL of your alert email. Note: Messaging is disabled if both Subject and URL fields are empty. 8. If the web server of the URL you want to email requires user access authentication, provide both the Web Server UserID and the Web Server Password in the Optional Web Server Authentication area. 9. Click Time of Day, and then enter the time period and select the days when you want to activate your alert action. 10. To enable alert escalation, click Alert Escalation, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly, as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval for the alert engine to wait after the alert condition is met before executing the alert action. 11. When done, click OK.
Note: The only operating systems supporting Windows Net Messaging on which SolarWinds supports SolarWinds installations are Windows Server 2003 and Windows XP. SolarWinds only supports evaluation installations of SolarWinds on Windows XP. To configure SolarWinds to send a Windows Net message upon alert: 1. Click Send a Windows Net Message, and then click Ok. 2. On the Net Message tab, enter the Computer Name or IP Address of the machine where you want to send a Windows Net message upon an alert trigger or reset. 3. To send the message to all computers in the domain or workgroup of your target computer, check Send to all Computers in the Domain or Workgroup. 4. Enter the Windows Net message you want to send in the Message to send field. 5. On the Time of Day tab enter the time period and select the days on which you want to activate your alert action. 6. To enable alert escalation, open the Alert Escalation tab, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly, as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval for the alert engine to wait after the alert condition is met before executing the alert action. 7. When done, click OK.
2. On the SNMP Trap tab, in the SNMP Trap Destinations field, enter the IP addresses of the servers to which you want to send your generated SNMP traps. Note: Use commas to separate multiple destination IP addresses. 3. Select the type of trap to send on alert trigger from the Trap Template list. Note: Some trap templates may use an alert message. You may change any provided text, if you want, but it is important that you understand the use of variables beforehand. For more information on the use of variables, see Syslog Alert Variables," on page 426. 4. Enter the SNMP Community String for your network in the designated field. 5. On the Time of Day tab enter the time period and select the days on which you want to activate your alert action. 6. To enable alert escalation, open the Alert Escalation tab, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly, as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval for the alert engine to wait after the alert condition is met before executing the alert action. 7. When done, click OK.
5. On the Time of Day tab enter the time period and select the days on which you want to activate your alert action. 6. To enable alert escalation, open the Alert Escalation tab, and then check any of the following options, as appropriate for your alert: To disable the action when the alert has been acknowledged, check Do not execute this Action if the Alert has been Acknowledged. To execute the action repeatedly, as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered and then provide an appropriate action execution interval. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval for the alert engine to wait after the alert condition is met before executing the alert action. 7. When done, click OK.
1. Immediately, as soon as SolarWinds SAM recognizes an alert condition, SolarWinds SAM generates both an email and a page that are sent to one of the two technicians. An entry is also recorded in the SolarWinds events log. 2. If the alert is not acknowledged in the SolarWinds Web Console within 20 minutes, a second alert is fired, generating another email and another page, both sent to both technicians. An entry is also recorded in the SolarWinds events log. 3. If the second alert is not acknowledged within 20 minutes, SolarWinds SAM fires a third alert that sends both an email and a page to both technicians and to the IT manager. An entry is also recorded in the SolarWinds events log. Escalated alerts ensure that everyone on the WidgetCo IT staff is notified of any significant network alert conditions within 45 minutes without burdening the IT manager with excessive alert notifications. The following section provides a procedure to create a similar escalated alert scheme.
Trigger Condition for an Advanced Alert on page 322. 8. Select Node as the Type of Property to Monitor. 9. Confirm that the linked text in the alert definition field displays all. Note: Click the linked text to select the number of conditions that you want to apply (all, any, none, not all). For more information about linked text conditions, see Understanding Condition Groups on page 330. 10. Click Browse (), and then click Add a Simple Condition. 11. Click the first asterisk (*), and then select Network Nodes > Node Details > Node Name. 12. Confirm that is equal to is the linked condition text in the trigger definition. Note: Click the linked text to select the condition you want to apply (equal, greater, less, ). For more information about linked text conditions, see Understanding Condition Groups on page 330. 13. Click the second asterisk (*), and then select your production web server from the list of monitored nodes. 14. Click Add, and then click Simple Condition. 15. Click the first asterisk (*) in the second condition, and then select Network Nodes > Node Status > Node Status. 16. Confirm that is equal to is the linked condition text in the second trigger definition. Note: Click the linked text condition to select the condition you want to apply (equal, greater, less, ). For more information about linked text conditions, see Understanding Condition Groups on page 330. 17. Click the second asterisk (*) in the second condition, and then select Down. 18. To apply any reset conditions to your escalated alert, click Reset Condition, and then provide appropriate conditions. For more information, see Setting a Reset Condition for an Advanced Alert on page 325. 19. To apply any alert suppressions to your escalated alert, click Alert Suppression, and then provide appropriate suppression conditions. For more information, see Setting a Suppression for an Advanced Alert on page 327. 20. To restrict when your escalated alert is valid, click Time of Day, designate the Valid Time of Day for your escalated alert, and then select the Days of the Week on which your escalated alert is valid. For more information, see Setting the Monitoring Period for an Advanced Alert on page 328. Note: By default, your escalated alert is always valid. 21. Click Trigger Actions, and then click Add New Action.
Alerting and Reporting 351
22. Select Send an E-mail / Page, and then click Ok. 23. Click E-mail/Pager Addresses, and then complete the To, CC, BCC, Name, and Reply Address fields for your Level 1 contact. Note: You must provide at least one email address in the To field. When entering multiple addresses in a field, y separate addresses with a comma. 24. Click Message, and then type the Subject and Message of your escalated alert email. Notes: Messaging is disabled if both Subject and Message fields are empty. For more information about variables in email subjects and messages, see Sending an E-mail / Page on page 336. 25. Click SMTP Server, and then provide the Hostname or IP Address of your SMTP Server and the designated SMTP Port Number. Note: The SMTP server hostname or IP address field is required. You cannot send an email/page alert without identifying the SMTP server. 26. If your SMTP server requires authentication, check This SMTP Server requires Authentication. 27. To restrict when your escalated alert is valid, check Execute this Action only between specific hours, and then configure the appropriate settings. Note: By default, your escalated alert is always valid. For more information, see Setting the Monitoring Period for an Advanced Alert on page 328. 28. Click Alert Escalation. 29. Check Do not execute this Action if the Alert has been Acknowledged. 30. To execute the action repeatedly as long as the trigger condition exists, check Execute this Action repeatedly while the Alert is Triggered, and then provide an appropriate action execution interval. 31. To delay alert action execution, check Delay the execution of this Action, and then provide an appropriate interval the alert engine should wait after the alert condition is met before the alert action is executed. Note: Typically, if you are configuring the first level alert, you should leave this option unchecked. If you are configuring the second level alert, check this option and provide the desired delay between the first and second notifications. If you are configuring the third level alert, check this option and provide the desired delay between the first and third notifications. 32. Click OK.
33. If you want your escalated alert to perform any actions upon reset, click the Reset Action tab, and then configure appropriate actions. For more information, see Setting a Reset Action for an Advanced Alert on page 329. 34. When done, click OK.
Report Writer also enables custom SolarWinds SAM report creation, as necessary, using criteria and conditions you choose. When you have finished editing your reports, you can view them through the Web Console and print them with the click of a button. A report scheduling application is available to all customers with a current maintenance agreement. This tool schedules automatic email reports that can be sent to individual users or groups of users. Log in to the customer portal of www.solarwinds.com and download the Report Scheduler. Report Writer capabilities are further enhanced when they are used in conjunction with the Custom Property Editor. Custom properties are available for report sorting and filtering. Refer to the following sections for more information: Using Predefined SolarWinds SAM Reports Viewing SolarWinds Server & Application Monitor Reports Filtering and Grouping Data in Resources SQL Syntax SWQL Syntax (Semantic Web Query Language)
Current Memory Utilization of each Component Generates a report including the node, application, component, actual and percent of physical and virtual memory used. Current Status of each Application Generates a report including the application and its status, for example, up or down. Current Status of each Component Generates a report including the node, application, component, and the individual status of the component, for example, up or down. Current Hardware and Hardware Sensor Status The following reports are predefined for reporting hardware sensor status: Current Hardware Status Generates a report that includes all hardware and their current status. Current Status of each Hardware Sensor Generates a report that includes the status of hardware sensors. Daily Application Availability The following reports are predefined for reporting daily monitored application availability: Application Availability Last Month Generates a report that includes all applications and their average availability over the last month. Application Availability This Month Generates a report that includes all applications and their average availability during the current month. Application Availability This Year Generates a report that includes all applications and their average availability over the last year.
Hardware Health Power Consumption Cost Calculations The following reports are predefined for reporting power consumption cost calculations: Historical Hardware Sensor Power Consumption Cost Calculations - Last 7 Days Generates a report that includes hardware sensor power consumption cost calculations over the last seven days. Historical Hardware Sensor Power Consumption Cost Calculations - Last Day Generates a report that includes hardware sensor power consumption cost calculations over the last day. Historical Hardware Sensor Power Consumption Cost Calculations - Last Month Generates a report that includes hardware sensor power consumption cost calculations over the last month. Node Total Power Consumption Cost Calculations Generates a report that includes node total power consumption cost calculations. Historical Application CPU and Memory Reports The following reports are predefined for reporting historical data on your monitored applications: CPU Load for each Application Monitor Last Month Displays the average CPU load for each monitor, grouped by node and application name, through the previous month. CPU Load for each Application Monitor This Month Displays the average CPU load for each monitor, grouped by node and application name, for the current month. CPU Load for each Application Monitor This Year Displays the average CPU load for each monitor, grouped by node and application name, through the previous month. Memory Load for each Application Monitor Last Month Displays the average memory load for each monitor, grouped by node and application name, through the previous month.
356 Alerting and Reporting
Memory Load for each Application Monitor This Month Displays the average memory load for each monitor, grouped by node and application name, for the current month. Memory Load for each Application Monitor This Year Displays the average memory load for each monitor, grouped by node and application name, through the previous month. Historical Hardware Sensor Daily Availability The following reports are predefined for reporting historical data on hardware sensor availability: Hardware Sensor Availability - Last Month Generates a report that includes all hardware sensor availability for the last month. Hardware Sensor Availability - This Month Generates a report that includes all hardware sensor availability for the current month. Hardware Sensor Availability - This Year Generates a report that includes all hardware sensor availability for the last year. Historical Hardware Sensor Statistic The following reports are predefined for reporting historical data on hardware sensor statistics: Hardware Sensor Statistic - Last Month Generates a report that includes all sensor statistic activity for the last month. Hardware Sensor Statistic - This Month Generates a report that includes all sensor statistic activity for the current month. Hardware Sensor Statistic - This Year Generates a report that includes all hardware sensor availability for the current year.
Historical Reports The following reports are predefined for reporting historical data on page file usage: Page File Usage - Last 7 Days Generates a report that includes all page file usage for the last seven days. Page File Usage - Last Month Generates a report that includes all page file usage for the last month. Page File Usage - This Month Generates a report that includes all page file usage for the current month.
6. If you want to open a predefined report, select one from the list in the left pane of the main window. Note: SolarWinds Server & Application Monitor supplies the following predefined reports: Current Application and Component Status Average Response Time of each Component Current CPU Load of each Component Current Memory Utilization of each Component Current Status of each Application Current Status of each Component Daily Application Availability Application Availability Last Month Application Availability This Month Application Availability This Year Historical Application CPU and Memory Reports: CPU Load for each Application Monitor Last Month CPU Load for each Application Monitor This Month CPU Load for each Application Monitor This Year Memory Load for each Application Monitor Last Month Memory Load for each Application Monitor This Month Memory Load for each Application Monitor This Year Historical Reports Page File Usage Last 7 Days Page File Usage Last Month Page File Usage This Month
7. If you want to create a new report, click File > New Report. Note: For more information on how to use the SolarWinds Report Writer application, see Creating and Modifying Reports" on page 373.
SQL Syntax
Some resources allow you to filter data using the SQL syntax described below. Wildcards The wildcard character in SQL syntax is: %. Example: Node.Caption Like 'AX3%' Filtering by Custom Property The property syntax to filter by custom property is: dataType.CustomProperty.propertyName Example filter to only show nodes with the custom property City that matches Atlanta:
Node.CustomProperty.City = 'Atlanta'
Filtering by Built-in Properties Many properties have the same name between data types. To prevent ambiguity, SolarWinds SAM prefixes the property names with the data type. Examples Example filter to show only data from processes with the name svchost.exe:
pe.Name like 'svchost.exe'
Example filter to show data only from component monitors named Server Load Monitor:
Monitor.Name like 'Server Load Monitor'
Example filter to show data from Process Monitor SNMP (type 8) component monitors:
Monitor.ComponentType = 8
Filtering by Status To filter by the status, you must know the valid status levels.
Level 0 Status Unknown
Filtering by Custom Property The property syntax to filter by custom property is: dataType.CustomProperties.propertyName Example filter to only show nodes with the custom property City that matches Atlanta:
Node.CustomProperties.City = 'Atlanta'
Filtering by Built-in Properties Many properties have the same name between data types. To prevent ambiguity, SolarWinds SAM prefixes the property names with the data type. Examples Example filter to show data from Cisco devices:
Node.Vendor = 'Cisco'
Example filter to show data from Process Monitor SNMP type component monitors:
Monitor.ComponentType = 8
Filtering by Status To filter by the status property, you must know the valid status levels.
Level 0 1 2 3 14 Status Unknown Up Down Warning Critical
Availability Current Node Status Current Volume Status Daily Node Availability Events Historical CPU and Memory Reports Historical Response Time Reports Historical VMware ESX Server Reports Groups: Current Groups and Groups Members Status Groups: Daily Group Availability Groups: Group Availability (with members) Groups: Historical Groups Status Historical Volume Usage Reports Inventory
Availability
The following network availability reports are provided by default with SolarWinds. Availability Last Month Displays the IP address and average availability of all monitored nodes over the last month. Availability This Year Displays the IP address and average availability of all monitored nodes over the last year. Availability Yesterday Displays the IP address and average availability of all monitored nodes over the previous day. Availability of Entire Network Last Month Displays the availability of all monitored nodes on the entire network over the last month. Top 25 Percent Down Last Month Displays the top 25 nodes, by percent downtime, over the last month.
Alerting and Reporting 365
Availability - This Year Displays the IP address and average daily availability of all monitored nodes over the last 12 months.
Events
The following network events reports are provided by default with SolarWinds. All Down Events Displays a list of all events in the database involving nodes that have stopped responding to polling over the last 12 months. For each down event, this report displays the down event date and time, the node name and IP address, and a verbal statement of the down event. Down Events - Windows Devices Displays a list of all events in the database involving Windows devices that have stopped responding to polling over the last month. For each down event, this report displays the down event date and time, the node name, and a verbal statement of the down event. Last 250 Events Displays the last 250 events involving any monitored device. For each event, this report displays the event date and time, the node involved, and a message describing the event. Nodes that went down - Last 24 Hours Displays a list of all nodes that have stopped responding over the last 24 hours. For every event of a node going down, this report displays the event date and time, an icon representing the current node status, the node name, and a verbal statement of the down event. Triggered Alerts - Last 30 Days Displays a list of all triggered alerts over the past 30 days. For each triggered alert event, this report displays the date and time of the alert trigger, the node that triggered the alert, and a message describing the triggered alert event. Triggered and Reset Alerts - Last 30 Days Displays a list of all triggered and reset alerts over the past 30 days. For each triggered or reset alert event, this report displays the date and time of the alert event, the node that triggered or reset the alert, and a message describing the alert event.
Percent of Memory by VM for Last Month For each monitored VMware ESX Server, this report displays the average daily memory load on the ESX Server due to each hosted VM for the last month. Percent of Time Running vs. Stopped For each monitored VMware ESX Server, this report displays both the percentage of time that each hosted VM has been running and the percentage of time that each hosted VM has been stopped.
Group Availability (with members) Last Month Group Availability (with members) Last Month Group Availability (with members) This Month Group Availability (with members) This Month Group Availability (with members) This Year Group Availability (with members) This Year
Inventory
The following network inventory reports are provided by default with SolarWinds. All Disk Volumes For all monitored volumes, this report displays the volume type and size, available space on the volume, amount of the available space that is currently used, and the peak amount of the available space that has been used on the volume, with the month in which peak usage occurred, over the last 12 months. Volumes are listed beneath their respective parent nodes.
Device Types Displays a list of monitored machine types and the number of each type that are currently monitored. IOS Versions of Cisco Devices For all monitored Cisco devices, this report displays the device name, machine type, and Cisco IOS Version and Image.
Viewing Reports
All reports, custom or predefined, are available for viewing in both the SolarWinds Web Console and in Report Writer, as shown in the following procedures: Viewing Reports in the Orion Web Console Viewing Reports in the Orion Report Writer Note: By default, no report folder is configured for newly created users. If a new user is not seeing reports, you may need to select a Report Folder for the new user. For more information, see Configuring an Account Report Folder on page 197. Viewing Reports in the SolarWinds Web Console The following procedure opens reports for viewing in the SolarWinds Web Console. To view reports in the SolarWinds Web Console: 1. Click Start > All Programs > SolarWinds > SolarWinds Web Console. 2. Log in to the SolarWinds Web Console, and then click Home > Reports. 3. Select a report group name to expand the report group. 4. Click the title of the report you want to view, and it displays directly in the web console browser. It is also possible to include a report within a web console view as a Report from SolarWinds Report Writer resource. For more information about adding the Report from SolarWinds Report Writer resource, see Editing Views on page 109. Viewing Reports in the SolarWinds SAM Report Writer The following procedure opens reports for viewing in the SolarWinds SAM Report Writer. To view reports with SolarWinds SAM Report Writer:
Alerting and Reporting 371
1. Click Start > All Programs > SolarWinds > Alerting, Reporting, and Mapping > Report Writer. 2. If report groups are not already expanded in the left pane, click [+] next to a report group name to expand the group, and then click the title of the report you want to view. 3. Click Preview.
Zoom views Note: Double-click a preview to zoom in and double-right-click to zoom out. Print report Design Mode Use Design mode to create new reports and modify or rename existing reports. The options available for both creating and modifying reports are the same. Design mode options are also dynamic, based upon the type of report, included report data, and report presentation. Available options differ according to the type of report that you are designing, but all reports require that you select the data to include and decide how that data will be sorted, ordered, filtered, and presented.
Field Formatting Options Tab General Options Tab The General tab opens by default and shows titling and display options. To configure General options: 1. Specify the Report Group, Report Title, Subtitle, and Description. Note: If you use an existing report group name, the new report is added to that existing group in the left pane of the main window. 2. Select the display Orientation of your report. 3. If you are configuring an historical report and you do not want to group data by days, clear Group historical data by days. Note: By default, data in some availability and historical reports is grouped by days when displayed in the SolarWinds Web Console. Data grouping by days is not viewable in Report Viewer. 4. If you do not want to make this report available on your SolarWinds Web Console, clear Make this Report available from the SolarWinds website. Note: By default, most reports are made available for display in the SolarWinds Web Console. For more information, see Customizing Views on page 108. Select Fields Options Tab The Select Fields tab allows you to select the data fields in a report. To select and configure fields: 1. Click Select Fields. 2. If you are creating a new report or adding fields to an existing report, click the ellipsis, select Add a new field, and then dynamically define each new report field as follows: a. Click the asterisk after Field:, and then select the type of information to include in the current report field. b. To sort the data in the current field, click the sort asterisk and select a sort order. c. To perform an operation on the data in the current field, click the function asterisk and select an operation. 3. If you are modifying an existing report, click the Field, sort, or function that you want to change and select a new value as follows. a. Click the asterisk after Field:.
b. Select the type of information to include in the current report field. c. To sort the data in the current field, click the sort asterisk and select a sort order. d. To perform an operation on the data in the current field, click the function asterisk and select an operation. 4. To test your selections as you assemble your report, click Execute SQL Query to view the current query results. 5. To delete a field or rearrange the order of the fields that are listed in your report, select a field, click Browse (), and then select the appropriate action. Note: Unchecked fields are not displayed in your report, but their sort and function configurations are retained. 6. To preview your report, click Preview. Filter Results Options Tab The Filter Results tab allows you to generate filter conditions for field data by selecting appropriate descriptors from the linked context menus. Results filters are configured as follows. To configure results filters: 1. Click Browse (), and then select from the following options: Select Add a new elementary condition to generate a condition that is based on a direct comparison of network object data fields. Select Add a new advanced elementary condition to generate a condition based on a comparison of device data fields and values. Select Add a new complex condition to define a condition that filters other defined conditions. Select Delete current condition to remove a selected condition. Select Move current condition forward or Move current condition backward to change the order of your conditions accordingly. Note: The lists of available linked descriptors are dynamically generated in consideration of all other variables within the same condition. For more information about condition groups and their application, see Understanding Condition Groups on page 330. 2. Check or clear individual filter conditions to enable or disable their application, respectively, to your report.
Top XX Records Options Tab The Top XX tab allows you to limit the number of records that are shown in your report to either a top number or a top percentage of all results. Top XX options are configured as shown in the following procedure. To configure Top XX records: 1. To show all records in your report, select Show All Records. 2. To specify a truncated list of eligible items for your report, complete the following steps: a. select either Show only the Top number Records or Show the Top percentage % of Records b. Provide appropriate number or percentage values. Time Frame Options Tab The Time Frame options tab allows you to limit the scope of your report to a specific period of time. To configure Time Frame options, select a Named, Relative, or Specific Time Frame, and then select or provide required values. Notes: If you receive a SQL Timeout error message, you may edit the timeout setting in the SWNetPerfMon.db file. By default, this file is located in the C:\Program Files\SolarWinds\Orion directory Since the Relative Time Frame is continuously variable, reports run with it may show different results, even if they are run close together in time. Summarization Options Tab The Summarization tab allows you to generate summaries of your results over specific periods of time. Summarization options are configured as follows. To configure results summarization: 1. If you do not want to summarize your results, confirm that Do not Summarize the Results is selected. 2. To summarize your results, complete the following steps: a. Select Summarize the Results by Hour, Date, Month, and so on, and then select the summarization period. b. Specify the location of the summary field for your report. c. Select a location for the Summary Date/Time field.
Report Grouping Options Tab The Report Grouping tab allows you to group results by field descriptor within your report. Add, edit and delete report groups to organize the data in your report. Establish and edit report groups as follows. To add and edit report groups: 1. To add a new report group, select a field from the list to define your group, and then click Add Report Group to add your selected field to the Report Groups list. Note: Use up and down arrows to change the grouping order accordingly. 2. To edit an existing report group, select the field from the Report Groups list, and then click Edit Report Group. 3. The following options may be changed as needed: The Group Header is the text that designates groups on your report. The Web URL is the dynamic location of your published report with respect to your SolarWinds Web Console. Font size, face, color, and background may all be modified by clicking associated ellipses. Alignment may be left, center, or right. Check Transparent Background for better results when publishing your report to the Web. If you want to change the grouping order, use the up and down arrows to change the grouping order accordingly. Field Formatting Options Tab The Field Formatting tab allows you to customize the format of the various results fields in your report. To format results fields, select the field you want to format, and then edit labels and select options as appropriate. Notes: The formatting options available for each field may be different according to the nature of the data contained in that field. Check Hidden Field to hide any field in your report. To view your changes at any time, click Preview.
Refer to the following sections for more information: Creating a Scheduled Report Job Using SolarWinds Report Scheduler with HTTPS Troubleshooting the SolarWinds Report Scheduler Creating a Scheduled Report Job The following procedure creates a scheduled report job for regularly printed or emailed SolarWinds reports. To schedule a report: 1. Click Start > All Programs > SolarWinds > SolarWinds Web Console. 2. Click Reports. 3. Click [+] as required to locate the report you want to schedule. 4. Click the name of the report you want to schedule.
5. Copy the URL of the report you want to schedule. 6. Click Start > All Programs > SolarWinds > Alerting, Reporting, and Mapping > SolarWinds Report Scheduler. 7. Click Edit > Add New Job. 8. Provide a job name for this scheduled report, and then click Continue. 9. Paste the URL of the report you want to schedule into the link field. 10. If you need to provide Windows login credentials to view the report you are scheduling, click the NT Account login tab, and then provide the user account details needed to log in. 11. To create a printable report that excludes the SolarWinds Web Console banner and menu bar, on the SolarWinds Web Login tab, check Retrieve a Printable Version of this Page. 12. If the report you are scheduling requires a SolarWinds user account, on the SolarWinds Web Login tab, check Send SolarWinds Username / Password in URL, and then provide the required user credentials to view the SolarWinds report. 13. Click Continue. 14. Configure the scheduling for your report job, and then click Continue.
15. To email the report, complete the following procedure: a. Confirm that either Email the Web Page (as HTML) or Email the Web Page (as PDF) are selected, and then click Continue. b. Provide required email addresses and a subject in the appropriate fields on the Email To tab. c. Provide a name and reply address on the Email From tab. d. On the SMTP Server tab, type the hostname or IP address and confirm the port number of the server used to send email from the SolarWinds server. e. Click Continue. 16. To print the report, complete the following steps: a. Select Print the Web Page, and then click Continue. b. Select the Printer, Orientation, and number of Copies you want to print. c. Click Continue. 17. Enter the user name and password for the Windows account that will email the report. 18. Click Continue. 19. Add any additional comments or notes about this job, and then click Finish. Using SolarWinds Report Scheduler with HTTPS If you are using HTTPS to view reports in the SolarWinds Web Console, your HTTPS server may require the SolarWinds Report Scheduler to provide a trusted certificate before the requested report may be printed or sent. To use SolarWinds Report Scheduler with HTTPS, either provide valid certificates to all users accounts requesting reports from the HTTPS server using SolarWinds Report Scheduler or disable certificate checking in each of the browsers used by your SolarWinds Report Scheduler users, as shown in the following procedure. To disable certificate checking: 1. If you are configuring Internet Explorer, complete the following steps: a. Open Internet Explorer on the user computer. b. Click Tools > Internet Options, and then click the Advanced tab.
c. In the Security section, confirm that the following options are cleared: Check for publishers certificate revocation Check for server certificate revocation (requires restart) Warn about invalid site certificates d. Click Ok. 2. If you are configuring Mozilla Firefox, complete the following steps: a. Open Mozilla Firefox on the user computer. b. Click Tools > Options. c. Click Advanced, and then click the Encryption tab. d. In the Protocols area, clear both Use SSL 3.0 and Use TLS 1.0. e. In the Certificates area, select Select one automatically, and then click Validation. f. Clear the option Use the Online Certificate Status Protocol (OCSP) to confirm the current validity of certificates, and then click Ok.
Troubleshooting the SolarWinds Report Scheduler The following known issues have been encountered while using the SolarWinds Report Scheduler: Printing Web Pages from Report Scheduler SolarWinds Report Scheduler and Internet Explorer Enhanced Security Printing Web Pages from Report Scheduler If any warning dialogs are open on the SolarWinds server when a web page is scheduled for printing in Report Scheduler, the print job may not complete. To ensure that print jobs configured in the Report Scheduler complete, confirm the following:
Print the Web Page is selected when the scheduled task is configured in Report Scheduler. All open dialogs, including SWToolset.exe and javascript warnings, are closed. All scheduled print tasks are configured to run even when the current user is not logged in. SolarWinds Report Scheduler and Internet Explorer Enhanced Security When Internet Explorer (IE) Enhanced Security Configuration is installed, SolarWinds report Scheduler may hang intermittently when attempting to perform a scheduled report print job. To address this issue, complete either of the following procedures: (Recommended) Add the SolarWinds Web Console as a trusted site in your browser. For more information about Internet Explorer Enhanced Security Configuration and adding sites to the trusted sites list, see the Microsoft document, "Adding Sites to the Enhanced Security Configuration Zones. Uninstall IE Enhanced Security Configuration.
Exporting Reports
SolarWinds Report Writer gives you the ability to present your created reports in any of the following industry-standard formats: Comma-delimited (*.csv, *.cdf) Text (*.txt) HTML (*.htm, *.html) MIME HTML, with embedded images (*.mhtml) Excel spreadsheet (*.xls) Adobe PDF (*.pdf) Image (*.gif) The following procedure presents the steps required to export an open report from SolarWinds Report Writer into any of the previously listed formats.
Alerting and Reporting 381
To export a report from Report Writer: 1. Select a report to export by clicking any of the following: Select a report from the file tree in the left pane File > Open to open an existing report File > New Report to create a new report. For more information about creating reports, see Creating and Viewing Reports on page 353. 2. Select File > Export and then click the format in which you want to export your report: 3. Check the fields in your open report that you want to export into the selected format, and then click Ok. 4. Select a location to save your file. 5. Provide a File name, and then click Save.
4. Type My Reports in the Report Group field, and then enter Last Weeks Availability as the Report Title.
5. Select Portrait for the paper orientation, and then confirm that Make this Report available from the SolarWinds website is checked.
8. Click the Field asterisk, and then select Network Nodes > Node Details > Node Name.
10. Click the Field asterisk, and then select Network Nodes > Node Status > Status Icon. Note: While this field makes a distinct visual difference for a report viewed in color, it will make little or no difference if printed in black and white.
11. Click Browse (), and then select Add a new field. 12. Click the Field asterisk, and then select Network Nodes > Node Status > Status.
13. Click Execute SQL Query to view the report data in the preview window. Note: The report preview should show information about both current and historical status. Current status entries must be relabeled to avoid confusion.
15. Click Status in the Select a Field list, and then change the Column Header entry to Current Status.
16. Click Status_Icon in the Select a Field list, and then change the Column Header entry to Current Status. 17. Click Execute SQL Query. Note: Column widths are adjustable. To change a column width, place your cursor on the column divider and drag it to a different position. 18. Click Select Fields.
19. Click the sort asterisk on the Status field line, and then select descending.
20. Click Execute SQL Query to confirm your choice. 21. Click Browse (), and then select Add a new field. 22. Click the Field asterisk, and then select Historical Response Time and Availability > Availability.
23. Click the Sort asterisk on the new line, and then select ascending. 24. Click Execute SQL Query to view the report. 25. Click Time Frame.
26. Select Relative Time Frame, type 7 in the text field, and then select Days from the list.
27. To break down the report day-by-day, click Summarization and specify your choices.
28. To filter your report, click Filter Results and specify filter rules, as on the Select Fields tab.
Chapter 16
Hardware monitoring is achieved by polling via SNMP or WMI, depending upon the node. For SNMP and WMI nodes, hardware monitoring must be enabled manually through SAM's web console. For more information, see "Adding Server Hardware Monitoring" on page 394. If you run a scheduled Network Sonar Discovery of your existing servers, SAM will automatically collect any servers that support hardware health information the next time the discovery runs. For more information, see: "Managing Scheduled Discovery Results" on page 166 Note: Only SAM administrators can enable hardware health monitoring.
________________________
HP Insight Management WBEM Providers for Windows Server 2003/2008 is an optional component for HP System Insight Manager that must be installed for SAM to monitor hardware via WMI. This component can be found using the following link: HP Insight Management WBEM Providers for Windows Server 2003/2008 Additionally, you may need to install the HP ProLiant Support Pack for Windows. This link can be found here: HP Proliant Support Pack
Dell does not make array and hard disk health information visible from WMI managed nodes. To monitor storage health on Dell servers, use SNMP. IBM's ServeRAID Manager must be installed on IBM X-Series servers for storage hardware health information to be displayed in SolarWinds SAM. Installation instructions can be found using the following links: IBM's ServeRAID Manager MegaRAID Storage Management Application (Optional: Only needed for MegaRAID Controller support.)
Note: Port 5989 must be opened when polling VMware servers using the CIM protocol.
392 Monitoring Hardware Health
If you run a scheduled Network Sonar Discovery of your existing servers, SAM will automatically collect any servers that support hardware health information the next time the scheduled discovery runs. For more information, see: "Managing Scheduled Discovery Results" on page 166. "Virtualization" on page 209.
Dell 1311
IBM 423
For example: Navigating to https://10.186.16.100:1311 in your web browser will take you to the Dell OpenManage Server Administrator page on the remotely monitored host. ___________________________________
If HP Insight Management WBEM Providers for Windows Server 2003/2008 is installed for HP System Insight Manager, the Data Source in the SIM web interface will read "WBEM." If this component is not installed, the Data Source will read "SNMP." The IBM Director web-based access is an optional component for version 6.x and is not installed by default.
For information on troubleshooting hardware health polling, see "Troubleshooting Hardware Health" on page 547.
Manually Add Hardware Monitoring To add hardware health monitoring without using the Add Node wizard, follow these steps: 1. Click the Home tab in the SAM web console. 2. In the All Nodes group, click the node you want to monitor. 3. In the Node Details group of the Node Details page, click the List Resources button as shown below:
Here you can select the available hardware you want to monitor by checking the appropriate boxes and then clicking Submit. To disable hardware monitoring, navigate back to this screen and uncheck Hardware Health of Servers, then click Submit. For information on troubleshooting hardware health polling, see "Troubleshooting Hardware Health" on page 547.
Hardware Details
Once you have chosen the hardware you want to monitor, the Hardware Health Details group appears on the Node Details page and looks similar to the following illustration, providing general information about your hardware and its status:
Note: This view will be hidden if hardware monitoring is disabled. For more information, see "Current Hardware Health Status" on page 397. For information on troubleshooting hardware health polling, see "Troubleshooting Hardware Health" on page 547.
Note: The default temperature measurement is in degrees, Fahrenheit (F). To change this to Celsius (C), from the web console, navigate to Settings > Manage Accounts > Select Account > Edit. The Temperature Unit dropdown menu can be found under the Server & Application Monitor Settings category.
Monitoring Hardware Health 397
Clicking a server icon in the Overview Chart, as highlighted above in red, will bring up a list of the servers with the indicated status, as shown below. From here, you can navigate to the Details page of each server by clicking any icon in the list.
Different default thresholds exist for different items in the Hardware Monitoring Agent Software. Some of these thresholds may be accessible and open to editing, some may not. Consult your Hardware Monitoring Agent Software user guide for specific information about editing thresholds. You can manually define alerting thresholds for any hardware sensor or category in the Advanced Alert Manager. For information, see: "Manually Changing Alert Thresholds" on page 404. "Accessing Hardware Monitoring Agent Software" on page 393.
Clicking the chart itself opens the following screen which allows you to edit multiple, self-explanatory settings pertaining to the Hardware Chart.
Click Submit to save the settings. Note: The Raw Data button will deliver the chart data by downloading an Excel spreadsheet. The Chart Data button displays the data in a web page. For information on troubleshooting hardware health polling, see "Troubleshooting Hardware Health" on page 547.
For a list of hardware variables, see "Hardware Specific Variables" on page 482. For information on Alerting and Reporting, see "Configuring SolarWinds SAM Alerts" on page 306. For information on troubleshooting hardware health polling, see "Troubleshooting Hardware Health" on page 547.
For a list of hardware variables, see "Hardware Specific Variables" on page 482. For information on Alerting and Reporting, see "Configuring SolarWinds SAM Alerts" on page 306. For information on hardware health alerting, see "Alerting on Hardware Health" on page 403. For information on troubleshooting hardware health polling, see "Troubleshooting Hardware Health" on page 547.
Chapter 17
Notes: Only SAM administrators can enable and disable the RTPE. The User Name and Command Line columns are hidden by default. Using the RTPE on a node monitored via ICMP which has no working component will require you to select Windows credentials manually. Consider promoting the selected node to SNMP or WMI to avoid this prompt. For more information, see: "Promoting a Node from ICMP to SNMP Monitoring" on page 98. "Promoting a Node from ICMP to WMI Monitoring" on page 100.
To navigate to the Node Details page: 1. Click the Home tab in the SAM web console. 2. In the All Nodes group, click a node. Note: The Real-Time Process Explorer button will not be available on the Node Details page in situations where the Top 10 lists are hidden, or when an assigned application template does not contain an SNMP Process Monitor or WMI/Windows Service Monitor. Clicking Real-Time Process Explorer will open the RTPE in a new window and will be sorted by the Top 10 category. For example, clicking the Real-Time Process Explorer button from the Top 10 Monitored Processes by CPU Load category will open the RTPE window with the processes sorted by CPU usage. The same is true for each Top 10 category. Note: Pop-ups must be enabled in your browser to view the Real Time Process Explorer.
Application Details page The RTPE window can be accessed from the Application Details page, as highlighted below:
To navigate to the Application Details page: 1. Click the Home tab in the SAM web console. 2. In the All Applications group, click an Application. Component Details page On the Component Details page, the Real-Time Process Explorer button can be found by the Management field, as highlighted in the following illustration:
To navigate to the Component Details page: 1. Click the Home tab in the SAM web console. 2. In the All Applications group, click an Application. 3. Click a Component.
Five seconds
Up to two minutes
Notes: Windows servers do not update their SNMP statistics more frequently than every two minutes. It takes at least two updates to these statistics to provide an accurate calculation. This means data displayed in the RTPE via SNMP can take up to four minutes to display. If this is unacceptable, consider changing the protocol to WMI. SNMP uses significantly less bandwidth than WMI.
____________________________________
Information on certain processes may not be exposed which can result in certain rows being blank.
Each column can be sorted by clicking the column head or hovering over the column name and clicking the dropdown arrow. Columns can also be added or removed this way. Each column can also be resized and/or re-arranged by dragging the separators between each column head to change the width, or the column heads themselves to change their position. Note: By default, all available columns, with the exception of the User Name and Command Line, are shown for the top ten running processes. To show all running processes, click the Show All button at the bottom-left of the window. To show a set number of running processes, change the number in the text box next to the Show All button from 10 to any number that suits your needs. To pause polling of processes, click the Pause Polling button at the top-left of the window. To end a process, check the box next to the process you want to end and then click End Process. For Windows based nodes, you can change the credentials used by clicking the Use Different Credentials button to bring up the credential library dialog box. Clicking the button will re-poll the running processes.
If you want to monitor a process that is not currently being monitored, click Start monitoring. From here, you will be taken to the Edit Properties section of the Browse for Component Monitor wizard. At this point, you can begin customizing the selected component monitor.
Monitoring Processes in Real-Time 409
For more information, see "Browse for Component Monitor" on page 151.
These alerts can be found in the Alert Manager as highlighted in the following illustration:
As with all alerts, these three can be customized to suit your needs by selecting an alert via the checkbox and clicking the Edit button. For more information, see "Adding Alert Actions" on page 335. Note: Alerts may lag if you are monitoring hardware via SNMP. It takes at least two updates to these statistics to provide an accurate calculation, meaning an alert can take up to four minutes to reach its recipient. If this is unacceptable, consider changing the protocol to WMI, which updates every five seconds. Also consider adjusting the trigger time to a value greater than two minutes. For more information, see "Using the Real Time Process Explorer" on page 408.
Variable
-n -count -sort
Definition Defines the ID of a Node (NodeID), which will be polled. Defines the number of processes to show. Defines the criteria to use for the selection of top processes. Possible values: Process CPU
Definition
Processor time. This is the default value if the command line argument is not specified. Process physical memory. Process virtual memory. Process disk I/O per second.
-activeObject
Defines timeout for polling in seconds. Defines AlertDefID of associated triggered alert. If this argument is provided, then alert notes are updated with the results from polling. Defines the ActiveObject property of the associated triggered alert. If this argument is not provided, NodeID is used.
Example 1: This example will return the top 20 processes with the highest virtual memory consumption running on the host with node ID 123.
SolarWinds.APM.RealTimeProcessPoller.exe -n=123 -count=20 sort=VirtualMemory -timeout=300
Example 2: This example uses the Execute an External Program alert action:
SolarWinds.APM.RealTimeProcessPoller.exe alert=${AlertDefID} -n=${NodeID} -
Example 3: This example uses the Execute an External Program alert action for an alert defined for the Volume object type:
SolarWinds.APM.RealTimeProcessPoller.exe -n=${NodeID} alert=${AlertDefID} -activeObject=${NetObjectID} -sort=VirtualMemory
Chapter 18
To configure the Syslog port: 1. Log on to your SolarWinds server using an account with administrative privileges. 2. Open SyslogService.exe.config in a text editor. Note: By default, SyslogService.exe.config is located in C:\Program
Files\SolarWinds\Orion\.
4. Edit value="514" as required to indicate the port on which your monitored devices are configured to send Syslog messages to your SolarWinds server. 5. Save SyslogService.exe.config.
Syslog Resources
SolarWinds SAM provides the following Syslog-related resources for inclusion within web console views. Advanced Syslog Counts Every Syslog message has a designated severity. For more information about Syslog severities, see Syslog Severities on page 428. The Advanced Syslog Counts resource groups by severity all Syslog messages received by the currently viewed node. For each severity, this resource provides the number of received Syslog messages. Advanced Syslog Parser The Advanced Syslog Parser resource provides a comprehensive view of the Syslog messages most recently received by the viewed node. The most recent messages of each severity are listed. For more information about Syslog severities, see Syslog Severities on page 428. Advanced Syslog Summary The Advanced Syslog Summary resource groups by message type all Syslog messages received by the currently viewed node, where the message type is
416 Monitoring Syslog Messages
encoded in the Syslog message packet. For each message type, this resource provides the severity, the hostname or IP address of the message originator, and the total number of Syslog messages received. Last 25 Syslog Messages The Last 25 Syslog Messages resource provides a list of the last 25 syslog messages that have been sent by monitored network devices to the viewed node. For each message, this resource presents the date and time the message was sent, the hostname and IP address of the device sending the message, and the message text. Clicking the hostname, IP address, or message text opens the corresponding Object Details page, providing extensive diagnostic information about the monitored network object sending the message. Clicking Edit opens the Edit Last 25 Syslog Messages page where you can set the maximum number of displayed messages, select the time period for viewing messages, and establish filters to limit the messages this resource displays. For more information, see Using Node Filters on page 146. Syslog Summary The Syslog Summary resource lists the number of Syslog messages received by the viewed node from monitored network devices over a specified period of time.
Note: For more information, see Syslog Severities on page 428. 6. If you want to filter your Syslog messages table by facility, select the facility to which you want to limit your view in the Select Facility field. Note: For more information, see Syslog Facilities on page 427. 7. If you want to limit your Syslog messages table to show only messages of a designated type, type the appropriate string in the Message Type field. 8. If you want to limit your Syslog messages table to show only messages containing a designated pattern, provide the appropriate string in the Message Pattern field. Note: An asterisk (*) is required as a wildcard character, both before and after the pattern string, unless the provided pattern is any of the following: The beginning of the message The end of the message The full message 9. If you only want to see Syslog messages from a specific period of time, select a time period from the Time Period menu. 10. Confirm the number of messages displayed in the Show Messages field. 11. If you want cleared or acknowledged messages to remain in the Syslog view, check Show Cleared Messages. 12. Click Refresh to update the Syslog messages list with your new settings.
5. If you want to view messages that meet your search criteria as they arrive, select a number for the Auto Refresh every number seconds field. Note: Auto Refresh is only available when you are viewing current messages. The Date/Time Range must be set to Today, Last 24 Hours, Last 2 Hours, or Last Hour.
8. If you want to limit the rule to only specific message types or text within a Syslog message, on the Message tab enter rules as appropriate for Message Type Pattern and Syslog Message Pattern. Notes: Use the examples listed on this tab to format the list properly. When Use Regular Expressions in this Rule is checked, regular expressions can be used in place of like statements. For more information about using regular expressions in SolarWinds SAM, see Regular Expression Pattern Matching on page 471. 9. If you want to apply specific severity or facility types, on the Severity / Facility tab check the severity and facility types you want to apply. Note: By default, all message severities and facilities are selected. For more information about Syslog severities and facilities, see Syslog Message Priorities on page 427. 10. If you want to limit rule application to within a specific period of time, select the Time of Day tab, check Enable Time of Day checking, enter the time period, and then check the days of the week on which to apply the rule. Notes: Enabling Time of Day checking creates more overhead for the CPU. Messages received outside the specified timeframe will not trigger alerts. 11. If you want to suppress alert actions until a specified number of messages arrive that match the rule, complete the following procedure: a. Select the Trigger Threshold tab. b. Check Define a Trigger Threshold for this Rule. c. Enter option values as appropriate. Note: When Suspend further Alert Actions for is checked, alert actions are not sent until the specified amount of time has expired. Once the time period has expired, only new alerts are sent. All alerts suppressed during the time period are discarded. 12. Configure Syslog alert actions on the Alert Actions tab, as shown in the following steps: a. If you are associating a new action to the rule, click Add New Action. For more information about available actions, see Available Syslog Alert Actions on page 423. b. If you want to edit an existing action for the rule, select an action from the list, and then click Edit Selected Action.
422 Monitoring Syslog Messages
c. Configure the action as appropriate. For more information about available actions, see Available Syslog Alert Actions on page 423. Note: Syslog alerts use a unique set of variables.
Previous reboot was at ${LastBoot-Previous}. Alert: ${NodeName} has exceptionally high response time. Average Response Time is ${AvgResponseTime} and is varying from ${MinResponseTime} to ${MaxResponseTime}. Current packet loss for ${NodeName} is ${%Loss}. Average Response time is ${AvgResponseTime} and is varying from ${MinResponseTime} to ${MaxResponseTime}. Alert: The SNMP Community string used to query ${NodeName} has been changed from ${CommunityPrevious} to ${Community}. SolarWinds uses the new Community String to query ${NodeName}.
d. If you need to delete an action, select the action, and then click Delete Action. e. Use the arrow buttons to set the order in which actions are performed. Note: Actions are processed in the order listed, from top to bottom. f. Click Ok to save all changes and return to Syslog Viewer Settings.
13. Use the arrow buttons to arrange the order in which the rules are applied. Note: Rules are processed in the order they appear, from top to bottom.
Modify the Syslog Message Modify the severity, facility, type, or contents of a Syslog message. Log the Message to a file Allows you to specify a file and a series of variables with which to tag Syslog messages sent to the file. Ensure you have already created the log file you want to use. The alert cannot create a file. Windows Event Log Write a message to local or remote Windows Event Logs. Forward the Syslog message Specify the IP address or hostname and the port to forward a Syslog event. Send a new Syslog message Trigger a new Syslog message, sent to a specific IP address or hostname, on a specific port, with a customizable severity, facility, and message. Send an SNMP Trap Allows you to send a trap to an IP address following a specific trap template and using a specific SNMP community string. Play a sound Allows you to play a sound when a matching Syslog message is received. Text to Speech output Define the speech engine, speed, pitch, volume, and message to read. Execute an external program Allows you to specify an external program to launch using a batch file. This action is used when creating real time change notifications in SolarWinds SAM. Execute an external VB Script Allows you to launch a VB Script using the selected script interpreter engine and a saved script file. Send a Windows Net Message Allows you to send a net message either to a specific computer or to an entire domain or workgroup. Note: The only operating systems supporting Windows Net Messaging on which SolarWinds supports SolarWinds installations are Windows Server
424 Monitoring Syslog Messages
2003 and Windows XP. SolarWinds only supports evaluation installations of SolarWinds on Windows XP. Send an E-mail / Page Send an email from a specified account to a specified address, using a specific SMTP server, and containing a customizable subject and message. Stop Processing Syslog Rules Stops the processing of Syslog rules for the matching Syslog message.
Syslog Facilities
The facility value indicates which machine process created the message. The Syslog protocol was originally written on BSD Unix, so Facilities reflect the names of UNIX processes and daemons, as shown in the following table. Note: If you are receiving messages from a UNIX system, consider using the User Facility as your first choice. Local0 through Local7 are not used by UNIX and are traditionally used by networking equipment. Cisco routers, for example, use Local6 or Local7.
Number 0 1 2 3 4 5 6 7 8 9 Source kernel messages user-level messages mail system system daemons security/authorization messages messages generated internally by Syslog line printer subsystem network news subsystem UUCP subsystem clock daemon Number 12 13 14 15 16 17 18 19 20 21 Source NTP subsystem log audit log alert clock daemon local use 0 (local0) local use 1 (local1) local use 2 (local2) local use 2 (local3) local use 2 (local4) local use 2 (local5)
Syslog Severities
The following table provides a list of Syslog severity levels with descriptions and suggested actions for each.
Number 0 1 Severity Emergency Alert Suggested Actions A "panic" condition affecting multiple applications, servers, or sites. System is unusable. Notify all technical staff on call. A condition requiring immediate correction, for example, the loss of a backup ISP connection. Notify staff who can fix the problem. A condition requiring immediate correction or indicating a failure in a primary system, for example, a loss of a primary ISP connection. Fix CRITICAL issues before ALERT-level problems. Non-urgent failures. Notify developers or administrators as errors must be resolved within a given time. Warning messages are not errors, but they indicate that an error will occur if required action is not taken. An example is a file system that is 85% full. Each item must be resolved within a given time. Events that are unusual but are not error conditions. These items might be summarized in an email to developers or administrators to spot potential problems. No immediate action is required. Normal operational messages. These may be harvested for network maintenance functions like reporting and throughput measurement. No action is required. Information useful to developers for debugging an application. This information is not useful during operations.
Critical
Error
Warning
Notice
6 7
Informational Debug
Chapter 19
4. If you want to filter your traps table by device type, select the device types you want to view in the Type of Device field. 5. If you want to limit your traps table to show only traps of a designated type, select the appropriate type in the Trap Type field. 6. If you want to limit your traps table to show only traps originating from a specific IP address, type the IP Address in the Source IP Address field. 7. If you want to limit your traps table to show only traps with a designated community string, select the appropriate community string in the Community String field. 8. If you only want to see traps from a specific period of time, select the time period from the Time Period menu. 9. Confirm the number of traps displayed in the Show Traps field. 10. Click Refresh to update the Traps view with your new settings.
4. On the Displayed Columns tab, use the arrow keys to select and order the fields of information you want to see in the Current Traps view. 5. If you do not need the domain name from your trap messages, check Remove Domain Name from DNS Lookups on the Message Parsing tab. Note: Checking this option will remove the domain name from your trap messages, and this will help to reduce the size of your database.
regular expressions in SolarWinds SAM, see Regular Expression Pattern Matching on page 471. 10. If you want the rule limited on the basis of content within the Trap Details field, click Trap Details, and then enter a Trap Details Pattern. Note: When Use Regular Expressions in this Rule is checked, regular expressions can be used in place of like statements. For more information about using regular expressions in SolarWinds SAM, see Regular Expression Pattern Matching on page 471. 11. If you want the rule limited to specific community strings, click Community String, and then enter appropriate patterns in the Community String Pattern field. Notes: When Use Regular Expressions in this Rule is checked, regular expressions can be used in place of like statements. For more information about using regular expressions in SolarWinds SAM, see Regular Expression Pattern Matching on page 471. 12. Click Conditions, and then generate trigger conditions for rule application in the text field as follows: Select appropriate object identifiers and comparison functions from the linked context menus. Click Browse () to Insert an OR condition, to Insert an AND condition, or to Delete a condition as necessary. Note: For more information about conditions and condition groups, see Understanding Condition Groups on page 330. 13. If you want to limit rule application to within a specific period of time, click Time of Day, check Enable Time of Day checking, enter the time period, and then select days of the week on which to apply the rule. Notes: Enabling Time of Day checking creates more overhead for the CPU. Messages received outside the specified timeframe will not trigger alerts. 14. If you want to suppress alert actions until a specified number of traps arrive that match the rule, click Trigger Threshold, check Define a Trigger Threshold for this Rule, and then enter option values as appropriate. Note: When Suspend further Alert Actions for is checked, alert actions are not sent until the specified amount of time has expired. Once the time period has expired, only new alerts are sent. All alerts that are suppressed during the time period will never be sent. 15. Click Alert Actions.
Monitoring SNMP Traps 433
16. If you are associating a new action to the rule, click Add New Action, and then select an action from the list to configure. For more information about adding alert actions, see Adding Alert Actions on page 335. 17. If you are editing an existing action for the rule, select an action from the list, click Edit Action, and then configure the action. For more information about adding alert actions, see Adding Alert Actions on page 335. 18. Use the arrow buttons to set the order in which actions are performed. Note: Actions are processed in the order they appear, from top to bottom. 19. If you need to delete an action, select the action, and then click Delete Action. 20. Click Ok to save all changes and return to Trap Viewer Settings. 21. Use the arrow buttons to arrange the order in which the rules are applied. Note: Rules are processed in the order they appear, from top to bottom.
Forward the Trap Allows you to specify the IP address or hostname and the port on which to forward the trap. Specify the IP address or hostname of the trap destination and the port on which the trap should be sent. Check Include Source Address to include the IP address of the trap source. Play a sound Allows you to play a sound when a matching SNMP trap is received. Text to Speech output Allows you to define a specific speech engine, the speed, pitch, volume, and message to read. Execute an external program Allows you to specify an external program to launch using a batch file. This action is used when creating real time change notifications in SolarWinds SAM. Execute an external VB Script Allows you to launch a VB Script using the selected script interpreter engine and a saved script file. Send a Windows Net Message Allows you to send a Windows Net message either to a specific computer or to an entire domain or workgroup. Note: The only operating systems supporting Windows Net Messaging on which SolarWinds supports SolarWinds installations are Windows Server 2003 and Windows XP. SolarWinds only supports SolarWinds evaluations on Windows XP. Send an E-mail / Page Allows you to send an email from a specified account to an address, using a specific SMTP server, and containing a customizable subject and message. Stop Processing Trap Rules Stops the processing of SNMP trap rules for the matching trap.
Note: Trap alerts may also use any valid node variables. For more information about node alert variables, see Orion Variables and Examples on page 469.
Chapter 20
Adding a Server
If you have not already designated a database for use with SolarWinds as a backup or supplement, use the following steps to add a SQL server to the Database Manager. Once added, your selected server and associated databases display in the tree structure in the left pane of Database Manager.
Managing the SolarWinds SAM Database 439
To add a SQL server to Database Manager: 1. Click Start > All Programs > SolarWinds > Advanced Features > Database Manager. 2. Click File > Add Server. 3. Select from the SQL Server list or enter the IP address of the SQL server. 4. Select the login style. Note: You may choose to Log in using Windows NT Integrated Security to automatically pass the Windows user ID and password to the SQL server, or select Log in using an SQL Server userid and password to use a separate login. Upon selecting the latter option, the window changes to provide fields to enter the separate SQL Server User Name and Password that you want to use. 5. Click Connect to Database Server.
Restoring a Database
The following steps restore a database that you have backed up. To restore a database from backup: 1. Click Start > All Programs > SolarWinds > Advanced Features > Database Manager. 2. If the SQL Server hosting your SolarWinds database is not listed in the left pane, you must add the SQL Server hosting your SolarWinds database. For more information, see Adding a Server on page 439. 3. Click + in the left pane to expand the SQL Server hosting your SolarWinds database, and then click your SolarWinds database. 4. Click Database > Restore Database. 5. Click Browse () to navigate to the database that you want to restore, or enter a valid SQL backup database name and path. Note: Typically, the default location for a SolarWinds database backup is C:\Program Files\SolarWinds\. 6. Click Verify to ensure that you have selected a valid SQL database. Notes: When you select a database, the remaining fields are completed for you. The Database Name field is populated with the name that SQL Server uses to refer to the specified database. The remaining two fields display the data ( .mdf) and transaction log (.ldf) files for the database. You can change the values provided. Database Manager does not create directories. You may only specify a path that already exists. You also cannot restore a database that is currently in use. 7. Click Ok to restore the selected database.
2. If the SQL Server hosting your SolarWinds database is not listed in the left pane, you must add the SQL Server hosting your SolarWinds database. For more information, see Adding a Server on page 439. 3. Click + in the left pane to expand the SQL Server hosting your SolarWinds database, and then click your SolarWinds database. 4. Click Database > Compact Database. Note: Upon completion, Database Manager displays a window comparing the size of the database before and after compaction. If the sizes are the same, there may not be enough free space in the database to rearrange data. If you need to free up more space for database compaction to occur, see Compacting Individual Tables on page 442.
To view database details: 1. Click Start > All Programs > SolarWinds > Advanced Features > Database Manager. 2. If the SQL Server hosting your SolarWinds database is not listed in the left pane, you must add the SQL Server hosting your SolarWinds database. For more information, see Adding a Server on page 439. 3. Click + in the left pane to expand the SQL Server hosting your SolarWinds database, and then click your SolarWinds database. Note: SolarWinds Orion is the default name of the SolarWinds database. 4. Click Database > Database Details. Notes: The Properties tab provides general statistics and descriptions of the selected database. The Tables tab shows a list of the tables in the selected database and their respective sizes. 5. If the Last Backup field on the Properties tab is blank, you have not generated a backup of the selected database. For more information about scheduling a recommended regular database backup, see Creating a Database Maintenance Plan on page 445.
5. Click Table > Table Details. Note: The Properties tab includes general statistics relating to the table size and creation date; the Columns tab describes the columns in the table, table keys, and field types; and the Indexes tab lists indexes used within the table. 6. If you want to query the open table, click Query in the tool bar. Warning: Special care should be taken while editing database values as you can easily compromise the integrity of your database. For more information, see Editing Database Fields on page 444. Note: A default SQL statement is provided, as well as radio buttons for displaying the data in read or read/write view.
9. If you want to edit table fields, select Read/Write at the top of the window, and then edit fields as necessary. 10. If you use the same SQL query often, you can save time by making the query a favorite, as follows: a. Enter the query in the query field. b. Click Add to Favorites. c. Enter a name for the command, and then click Ok. Note: Database Manager saves the command with the name that you have provided. You can now use this command again, directly, by clicking Paste from Favorites.
Detaching a Database
Detaching a database removes its reference from the SQL Server, allowing you to safely move files to different locations. Database Manager allows you to detach a database and leave the data files of a database intact, as shown in the following procedure. Note: SolarWinds does not recommend using the Detach Database option to migrate a database from one SQL Server to another. For more information, see Migrating your Database on page 450. To detach a database: 1. Click Start > All Programs > SolarWinds > Advanced Features > Database Manager. 2. If the SQL Server hosting your SolarWinds database is not listed in the left pane, you must add the SQL Server hosting your SolarWinds database. For more information, see Adding a Server on page 439. 3. Click + in the left pane to expand the SQL Server hosting your SolarWinds database, and then click your SolarWinds database. Note: SolarWinds Orion is the default name of the SolarWinds database. 4. Click Database > Detach Database from the menu.
Note: SQL Server Agent must be running to execute database maintenance. To create a database maintenance plan: 1. Click Start > All Programs > SolarWinds > Advanced Features > Database Manager. 2. If the SQL Server hosting your SolarWinds database is not listed in the left pane, you must add the SQL Server hosting your SolarWinds database. For more information, see Adding a Server on page 439. 3. Click + in the left pane to expand the SQL Server hosting your SolarWinds database, and then click your SolarWinds database. Note: SolarWinds Orion is the default name of the SolarWinds database. 4. Click Database > Database Backup Schedule. 5. Select to run the backup either once a Day or once a Week. 6. If you to want to run the backup once a week, choose the Backup Day. 7. Set the Backup Time. 8. Click Next. 9. If you want to compact and shrink the database before the backup, check Compact and Shrink Database before Backup. Note: SolarWinds recommends both that you perform database compaction weekly and that you compact and shrink databases before backups. 10. Enter the path to the directory where you would like to place backup files or click Browse () and then navigate to an appropriate directory. 11. If you want to keep backup reports, check Generate a backup report each time the backup Job runs, and then enter the path to the directory where you would like to Place Backup reports or click Browse () and then navigate to an appropriate directory. 12. Click Finish.
Notes: Your specific environment may require additional configuration. You may need to contact your database administrator to gain access to SQL Server Management Studio for your SolarWinds database. The following procedure clears historical maintenance records and creates a backup of your SolarWinds database. In general, however, SolarWinds recommends that you contact your database administrator and reference the Microsoft documentation provided with SQL Server for instructions on using SQL Server Management Studio to manage your SolarWinds database. To use SQL Server Management Studio to manage your SolarWinds database: 1. Click Start > Microsoft SQL Server > SQL Server Management Studio. 2. Click View > Object Explorer. 3. Expand the SQL Server instance containing your SolarWinds database in the Object Explorer pane on the left. Note: Expand the Databases folder for any instance to confirm included databases. By default, the SolarWinds database is named SolarWinds Orion. 4. Expand the Management folder, right-click the Maintenance Plans folder, and then click Maintenance Plan Wizard. 5. Click Next to start the SQL Server Maintenance Plan Wizard. 6. Provide an appropriate Name and Description for your maintenance plan. 7. Click Browse () next to the Server field. 8. Check your SQL Server\Instance, and then click Ok. Note: If your SQL Server\Instance is not in the list, provide it manually. 9. Select the authentication type that is used to connect to the SQL server, and, if required, provide appropriate User name and Password credentials. Note: Use the same authentication type and credentials you provided in the SolarWinds Configuration Wizard to access your SolarWinds database. 10. Check Clean Up History and Back Up Database (Full) Note: When a task is clicked, the Maintenance Plan Wizard provides a brief task description. 11. Click Next. 12. Set the order of task execution, top to bottom, by selecting tasks and clicking Move Up and Move Down as needed.
Note: The following steps assume the Clean Up History task precedes the Back Up Database (Full) task. 13. Click Next when the task execution order is set. 14. On the Define Cleanup History Task view, check the types of historical data to delete, and then set the threshold age for historical data removal. 15. Click Next. 16. On the Database Back Up (Full) view, complete the following steps: a. Click the Databases field. b. Select These databases. c. Check your SolarWinds database. 17. Click Ok. 18. Select Database in the Backup component area. 19. In the Destination area, complete the following steps: a. Select Disk. b. Select Create a backup file for every database. c. Click Browse () to select an appropriate database backup file destination with sufficient free space. 20. Click Next. 21. On the Select Plan Properties view, click Change. 22. Configure the database maintenance job schedule as follows: a. Provide an appropriate Name for the new job schedule. b. Select Recurring as the Schedule type. c. Check Enabled, and then select Daily in the Occurs field. d. Provide an off-peak network usage time in the Occurs once at field. e. Select a Start date, and then select No end date. 23. Click Ok. 24. Click Next, and then check Write a report to a text file. 25. Click Browse () to select an appropriate maintenance report file destination. 26. Review wizard results, click Finish, and then, when the wizard successfully finishes, click Close.
For additional help with using SQL server Management Studio, visit the Microsoft Support Website at http://support.microsoft.com.
Database Maintenance
The primary tasks that are available for maintaining a SQL database are data summarization and database compaction. Data summarization occurs automatically as a part of the nightly maintenance program. You can also run database maintenance on demand from the Windows Start menu.
15. Close the Database Manager. 16. Click Start > All Programs > SolarWinds > Configuration and AutoDiscovery > Configuration Wizard. 17. Specify the newly restored database in the Database Setup section of the wizard. 18. When prompted, click Yes to use the existing database.
Chapter 21
3. If you want to add predefined properties, complete the following procedure: a. Select Add Predefined Properties. b. Check Show Advanced Properties to view additional predefined properties. c. Check the properties you want to add, and then click Ok. 4. If you want to generate a completely new custom property, complete the following procedure: a. Select Build a Custom Property from scratch. b. Select the SolarWinds database table to which you want to add the new custom property. c. Provide the new Property Name. Notes: To ensure full custom property functionality, do not leave the Property Name field empty. Although most non-alphanumeric characters used in custom property names are replaced by underscores (_) when names are stored in the SolarWinds database, SolarWinds recommends against using non-alphanumeric characters in custom property names. Hash characters (#) are not allowed in any property name. d. Select the Property Type. e. Enter a Max. Text length. Note: Regardless of the value provided in this field, SolarWinds SAM does not support custom properties defined with more than 4000 characters. f. Click Ok.
3. Check each property you want to remove. 4. If you are satisfied with your selections, click Ok.
Note: Click the cell to enable a menu. Use the menu items to select the target field that you want your data to populate. 12. If you have specified all cell matches between your data and the SolarWinds database, click Import. 13. If your import is successful, confirm the count of successfully imported rows, and then click Ok.
and the text of the Filter Active / No Active Filter now displays Filter Active, indicating that the filter is being applied to the currently viewed properties.
Appendix A
The SolarWinds Module Engine must also be restarted before the Polling Engine Mode setting takes effect. For more information, see To configure the additional polling engines to be poller-aware: on page 463.
Nodes are assigned to particular polling engines by selecting the desired Polling Engine when adding a node using the Add Node wizard. Note: The option to select the Polling Engine when adding a node is not displayed until the Polling Engine Mode is set to Poller-Bound. An additional method for assigning nodes to polling engines is to use the Poller Load Balancing option in the Monitor Polling Engines tool. For more information, see To assign nodes to polling engines: on page 464.
5. Chose a destination location (or accept the default), and then click Next. 6. Click Next to start copying files. 7. Click Finish to complete the Installation Wizard. 8. Click Enter Licensing Information to enter your license, or click Continue Evaluation. 9. Review the Configuration Wizard Welcome page, and then click Next. 10. Configure the database for your environment by selecting the appropriate SQL Server database and Authentication information, and then click Next. 11. Configure the database by selecting Use an existing database, and then selecting the name of the SQL Server database for the SolarWinds SAM server. Then click Next. 12. Select whether to Create a new account, or Use an existing account, and then enter the account information. Then click Next. 13. If the Website Settings page is displayed, configure the IP Address, Port, and Website Root Directory as appropriate and select whether you want to enable automatic login. Then click Next. 14. Ensure that all the services displayed in the Service Settings page are checked, including the SAM Job Engine Plug-in, and then click Next. 15. Review the Configuration wizard Summary page, and then click Next. 16. Click Finish to complete the Configuration Wizard. To configure the additional polling engines to be poller-aware: 1. If this is the first additional poller you have installed, complete the following procedure: a. Log on to your SolarWinds Web Console with an Administrator account. b. Click the Applications tab. c. Click SAM Settings. d. Click Data and Database Settings. e. Select Poller-Bound as the Polling Engine Mode. f. Click Submit.
g. Log on to the SolarWinds SAM server with a Windows administrator account. h. Click Start > All Programs > SolarWinds > Advanced Features > Orion Service Manager. i. Select SolarWinds Module Engine, and then click Restart.
Additional Polling Engine and Web Console 463
j.
If you encounter any issues with the additional polling engine, rerun the Configuration Wizard on the SolarWinds SAM server.
To assign nodes to polling engines: You can assign nodes to the polling engines by selecting the desired Polling Engine in the Add Node wizard. You can also perform Poller Load Balancing using the Monitor Polling Engines tool to assign nodes to polling engines. Click Start > All Programs > SolarWinds > Advanced Features > Monitor Polling Engines. Then click Servers > Poller Load Balancing to display a dialog where you can assign nodes to particular polling engines. For more information, see Understanding How Polling Engines Work" on page 459.
9. Specify the appropriate information on the Database Settings window, and then click Next. 10. Specify the appropriate database to use, and then click Next. Ensure you have stopped your polling engines before continuing. 11. Specify the appropriate database account on the Database Account window, and then click Next. 12. Select the IP address, port, and Website root directory on the Website Settings window, and then click Next. 13. Review the configuration summary, and then click Next. 14. Click Finish to complete the Configuration Wizard. Copying the Default Reports Additional Web Console installations do not include the default SAM reports. To ensure your default SAM reports are available on your Additional Web Console install, copy the Reports folder to your Additional Web Console server. This folder is typically C:\Program Files\SolarWinds\Orion\Reports.
Appendix B
Appendix C
Variable Modifiers
The variables in the following sections can be modified by appending any of the variable modifiers in the following table.
Variable Modifier -Raw -Previous -Cooked -PreviousCooked Description Displays the raw value for the statistic. For example, if Transmit Bandwidth is set to 10 Mbps, then the raw value would be10000000. The cooked value would be 10 Mbps. Displays the previous value for the statistic before the Alert was triggered Displays the cooked value for the statistic. For example, if Transmit Bandwidth is set to 10 Mbps, then the raw value would be 10000000 and cooked value would be 10 Mbps. Displays the previous cooked value for the statistic before the Alert was triggered
0.633 0.238 0.142 0.119 0.176 0.131 0.127 0.169 0.223 0.291 0.236 0.124 0.072 0.197 0.105 0.138 0.233 0.374 0.290 0.871 0.433 0.248 0.242 0.169 0.116 0.121 0.427 0.249 0.223 0.231 0.336 0.014 0.442 0.197 0.125 0.108 0.244 0.264 0.190 0.471 0.033 0.228 0.942 0.219 0.076 0.331 0.227 0.849 0.323 0.221 0.196 0.223 0.642 0.197 0.385 0.098 0.263 0.174 0.690 0.571 0.233 0.208 0.242 0.139 0.186 0.331 0.124 0.249 0.643 0.481 0.936 0.124 0.742 0.497 0.085 0.398 0.643 0.074 0.590 0.771 0.833 0.438 0.242 0.092 0.376 0.231 0.627 0.249 0.663 0.181 0.636 0.224 0.342 0.697 0.285 0.108 0.211 0.074 0.490 0.271 0.133 0.338 0.242 0.519 0.376 0.331 0.227 2. When reordered from high to low: 0.971 0.942 0.936 0.871 0.849 0.833 0.771 0.742 0.697 0.690 0.663 0.643 0.643 0.642 0.636 0.633 0.627 0.623 0.590 0.571 0.519 0.497 0.490 0.481 0.471 0.442 0.438 0.433 0.427 0.398 0.390 0.385 0.376 0.376 0.374 0.342 0.338 0.336 0.331 0.331 0.331 0.323 0.291 0.290 0.285 0.281 0.274 0.271 0.264 0.263 0.249 0.249 0.249 0.248 0.244 0.243 0.242 0.242 0.242 0.242 0.238 0.236 0.233 0.233 0.231 0.231 0.228 0.227 0.227 0.224 0.223 0.223 0.223 0.221 0.219 0.211 0.208 0.198 0.197 0.197 0.197 0.196 0.190 0.186 0.185 0.181 0.176 0.174 0.169 0.169 0.149 0.142 0.139 0.138 0.136 0.133 0.131 0.127 0.125 0.124 0.124 0.124 0.121 0.119 0.116 0.108 0.108 0.105 0.098 0.097 0.092 0.085 0.076 0.074 0.074 0.072 0.042 0.033 0.024 0.014 3. Drop the first 6, as these equal the top 5% of the values: 0.771 0.742 0.697 0.690 0.663 0.643 0.643 0.642 0.636 0.633 0.627 0.623 0.590 0.571 0.519 0.497 0.490 0.481 0.471 0.442 0.438 0.433 0.427 0.398 0.390 0.385 0.376 0.376 0.374 0.342 0.338 0.336 0.331 0.331 0.331 0.323 0.291 0.290 0.285 0.281 0.274 0.271 0.264 0.263 0.249 0.249 0.249 0.248 0.244 0.243 0.242 0.242 0.242 0.242 0.238 0.236 0.233 0.233 0.231 0.231 0.228 0.227 0.227 0.224 0.223 0.223 0.223 0.221 0.219 0.211 0.208 0.198 0.197 0.197 0.197 0.196 0.190 0.186 0.185 0.181 0.176 0.174 0.169 0.169 0.149 0.142 0.139 0.138 0.136 0.133 0.131 0.127 0.125 0.124 0.124 0.124 0.121 0.119 0.116 0.108 0.108 0.105 0.098 0.097 0.092 0.085 0.076 0.074 0.074 0.072 0.042 0.033 0.024 0.014 4. The 95 percentile is 0.771.
th
\+ matches + \xA9 matches when using the Latin-1 code page. \r\n matches a DOS/Windows CRLF line break.
Any character except ^,-,],\ add that character to the possible matches for the character class. \ (backslash) followed by any of ^,-,],\ - (hyphen) except immediately after the opening [
\d, \w and \s
Anchors
Anchors Description Matches at the start of the string to which the regular expression pattern is applied. Matches a position rather than a character. Most regular expression flavors have an option to make the caret match after line breaks (i.e. at the start of a line in a file) as well. Matches at the end of the string to which the regular expression pattern is applied. Matches a position rather than a character. Most regular expression flavors have an option to make the dollar match before line breaks (i.e. at the end of a line in a file) as well. Also matches before the very last line break if the string ends with a line break. Matches at the start of the string to which the regular expression pattern is applied to. Matches a position rather than a character. Never matches after line breaks. Matches at the end of the string to which the regular expression pattern is applied. Matches a position rather than a character. Never matches before line breaks, except for the very last line break if the string ends with a line break. Matches at the end of the string to which the regular expression pattern is applied. Matches a position rather than a character. Never matches before line breaks. Example ^. matches a in abc\ndef. Also matches d in "multi-line" mode.
^ (caret)
$ (dollar)
\A
\Z
\z
Quantifiers
Quantifiers ? (question mark) Description Makes the preceding item optional. The optional item is included in the match, if possible. Makes the preceding item optional. The optional item is excluded in the match, if possible. This construct is often excluded from documentation due to its limited use. Repeats the previous item zero or more times. As many items as possible will be matched before trying permutations with fewer matches of the preceding item, up to the point where the preceding item is not matched at all. Repeats the previous item zero or more times. The engine first attempts to skip the previous item before trying permutations with ever increasing matches of the preceding item. Repeats the previous item once or more. As many items as possible will be matched before trying permutations with fewer matches of the preceding item, up to the point where the preceding item is matched only once. Repeats the previous item once or more. The engine first matches the previous item only once, before trying permutations with ever increasing matches of the preceding item. Repeats the previous item exactly n times. Repeats the previous item between n and m times. Will try to repeat m times before reducing the repetition to n times. Repeats the previous item between n and m times. Will try to repeat n times before increasing the repetition to m times. Repeats the previous item at least n times. Will try to match as many items as possible before trying permutations with fewer matches of the preceding item, up to the point where the preceding item is matched only m times. Repeats the previous item between n and m times. The engine first matches the previous item n times before trying permutations with ever increasing matches of the preceding item. Example abc? matches ab or abc abc?? matches ab or abc
??
* (star)
*? (lazy star)
#NAME?
+? (lazy plus)
{n} where n is an integer >= 1 {n,m} where n >= 1 and m >= n {n,m}? where n >= 1 and m >= n
a{3} matches aaa a{2,4} matches aa, aaa or aaaa a{2,4}? matches aaaa, aaa or aa
Dot
Dot Character . (dot) Description Matches any single character except line break characters \r and \n. Example . matches x or most any other character
Word Boundaries
Word Boundary Description Matches at the position between a word character (anything matched by \w) and a non-word character (anything matched by [^\w] or \W) as well as at the start and/or end of the string if the first and/or last characters in the string are word characters. Matches at the position between two word characters (i.e the position between \w\w) as well as at the position between two non-word characters (i.e. \W\W). Example
\b
\B
Alternation
Alternation Character | (vertical bar or pipe) | (vertical bar or pipe) Description Causes the regular expression engine to match either the part on the left side or the part on the right side. Can be strung together into a series of options. The vertical bar has the lowest precedence of all operators. Use grouping to alternate only part of the regular expression. Example abc|def|xyz matches abc, def or xyz abc(def|xyz) matches abcdef or abcxyz
Regular Expression Pattern Matching Examples The following examples illustrate uses of regular expression pattern matching.
snmp-server community public
Finds any line that includes the text snmp-server community public. There can be text before and/or after the string on the same line.
service tcp-keepalives-in.*\n(.*\n)*.*service tcp-keepalives-out
Finds the first line service tcp-keepalives-in and then looks for service tcp-keepalives-out on any line after that. The regular expression string .*\n(.*\n)*.* is used to search any number of lines between strings.
access-list 105 deny.*tcp any any eq 139 log
Finds the line with access-list 105 deny, followed by any number of characters of any type, followed by tcp any any eq 139 log on the same line. The regular expression string .* finds any character and any number of characters on the same line. This expression can be used to find spaces, tabs, numbers, letters, or special characters.
ntp clock-period \d*
Finds any line that includes ntp clock-period, followed by any number. The regular expression string \d* will find any number at any length, such as 3, 48, or 2394887.
user \x2a
Finds any line that includes user *. The regular expression string \x, followed by a hexadecimal value, specifies an individual character. In this example, \x2a represents the asterisk character, which has a hexadecimal value of 2a.
General
The following are valid, general advanced alert variables.
General Variable ${Acknowledged} ${AcknowledgedBy} ${AcknowledgedTime} ${AlertTriggerCount} ${AlertTriggerTime} ${Application} ${CR} ${Copyright} ${ObjectName} ${Release} ${Version} Description Acknowledged status Who the alert was acknowledged by Time the alert was acknowledged Count of triggers Date and time of the last event for this Alert. (Windows control panel defined Short Date and Short Time) SolarWinds application information Line Feed Carriage Return Copyright information Description/Name of the object in the alert Release information Version of the SolarWinds software package
Date/Time
The following are valid date and time variables.
Date/Time Variable ${AMPM} ${AbreviatedDOW} ${D} ${DD} ${Date} ${DateTime} ${DayOfWeek} ${DayOfYear} ${H} ${HH} ${Last2Hours} ${Last24Hours} ${Last7Days} ${LastHour} ${LocalDOW} ${LocalMonthName} ${LongDate} ${M} ${MM} ${MMM} ${MMMM} ${MediumDate} ${Minute} ${S} ${Second} ${Time} ${Today} ${Year} ${Year2} ${Yesterday} Description AM/PM indicator Current day of the week. Three character abbreviation. Current day of the month Current day of the month (two digit number, zero padded) Current date. (Short Date format) Current date and time. (Windows control panel defined Long Date and Long Time format) Current day of the week. Numeric day of the year Current hour Current hour. Two digit format, zero padded. Last two hours Last 24 hours Last seven days (Short Date format) Last hour Current day of the week. Localized language format. Current month name in the local language. Current date. (Long Date format) Current numeric month Current month. Two digit number, zero padded. Current month. Three character abbreviation. Full name of the current month Current date. (Medium Date format) Current minute. Two digit format, zero padded. Current second. Current second. Two digit format, zero padded. Current Time. (Short Time format) Today (Short Date format) Four digit year Two digit year Yesterday (Short Date format)
Group Variables
The following are valid group variables.
Group Variable ${GroupDetailsURL} Description URL of the Group Details view for a selected group
${GroupStatusCalculatorID}
${GroupStatusCalculatorName}
SQL Query
Any value you can collect from the database can be generated, formatted, or calculated using a SQL query as a variable. To use a SQL query as a variable in SolarWinds SAM, use ${SQL:{query}} as shown in the following example that returns the results of the SQL query Select Count(*) From Nodes:
${SQL:Select Count(*) From Nodes} SolarWinds Variables and Examples 477
Status Variables
When using the ${Status} variable with a monitored object, status values are returned, as appropriate. The following table provides a description for each status value.
Status Value 0 1 2 3 4 5 6 7 8 9 10 11 12 14 15 16 17 19 22 24 25 26 27 28 Description Unknown Up Down Warning Shutdown Testing Dormant Not Present Lower Layer Down Unmanaged Unplugged External Unreachable Critical Mixed Availability Misconfigured Could Not Poll Unconfirmed Active Inactive Expired Monitoring Disabled Disabled Not Licensed
Node Variables
The following are valid node variables.
Node Variable ${AgentPort} ${Allow64BitCounters} ${AvgResponseTime} ${BlockUntil} Description Node SNMP port number Node allows 64-bit counters (1), or not (0) Average node response time , in msec, to ICMP requests Day, date, and time until which node polling is blocked
${BufferBgMissThisHour}
${BufferBgMissToday}
${BufferHgMissThisHour}
${BufferHgMissToday}
${BufferLgMissThisHour}
${BufferLgMissToday}
${BufferMdMissThisHour}
${BufferSmMissToday} ${Caption} ${Community} ${Contact} ${CPULoad} ${CustomPollerLastStatisticsPoll} ${CustomPollerLastStatisticsPollSuccess} ${Description} ${DNS} ${DynamicIP} ${EngineID}
${Severity}
${SNMPV2Only} ${SNMPV3AuthKey} ${SNMPV3AuthKeyIsPwd} ${SNMPV3AuthMethod} ${SNMPV3Context} ${SNMPV3PrivKey} ${SNMPV3PrivKeyIsPwd} ${SNMPV3PrivMethod} ${SNMPV3Username} ${SNMPVersion} ${StatCollection} ${Status} ${StatusDescription} ${StatusLED} ${SysName} ${SysObjectID} ${SystemUpTime} ${TotalMemory} ${UnManaged} ${UnManageFrom} ${UnManageUntil} ${Vendor} ${VendorIcon}
Volume Variables
The following are valid volume variables.
Volume Variable ${Caption} Description User friendly volume name
${APM_HardwareAlertData.SensorsWithStatus}
${APM_HardwareAlertData.SensorsWithProblems}
Node Hardware Type The following are valid node hardware type variables:
Hardware Variable ${APM_HardwareTypeAlertData.HardwareTypeStatus} ${APM_HardwareTypeAlertData.HardwareTypeStatusDescription} ${APM_HardwareTypeAlertData.TypeName} ${APM_HardwareTypeAlertData.NodeName} Description Rollup status for this hardware type Current hardware description Type of hardware (Fan, Battery, and so on.) Name of the node Comma separated list of all child hardware components and their statuses Comma separated list of all child hardware components (in status other than "Up") and their statuses
${APM_HardwareTypeAlertData.SensorsWithStatus}
${APM_HardwareTypeAlertData.SensorsWithProblems}
Node Hardware Sensor The following are valid node hardware sensor variables:
Hardware Variable ${HardwareTypeStatus} ${HardwareTypeStatusDescription} ${CategoryName} ${NodeName} ${SensorUniqueName} ${SensorDisplayName} ${SensorValue} ${SensorUnit} ${SensorOrionStatus} ${SensorOrionStatusDescription} ${SensorOriginalStatus} ${SensorMessage} Description Status of the parent object Description of the status of the parent object Name of the parent hardware type (Fan, Battery, and so on.) Name of the node Unique name of the sensor Display name of the sensor Value returned from the last poll Sensor unit (Degree F, Watts, and so on.) Sensor status Sensor status description Original status returned by the remote node Message or error message from the last poll
Appendix D
Network Atlas
Network Atlas is a powerful tool for creating custom maps and network diagrams. The maps created in Network Atlas enable users to view a graphical depiction of their network in the SolarWinds Web Console. You can also use Network Atlas maps to create your own network documentation, which can then be printed and exported as needed.
What is in a Map?
Map objects can be SolarWinds SAM applications and components. The numerous presentation options for your network maps include: A large set of predefined background colors, textures, and images for use in your maps, and the ability to use your own custom background graphics The ability to project real time weather or natural disaster maps onto your network maps using linked web graphics as a background The ability to customize the shape, size, color, and style of map links to illustrate the status or the relative bandwidth of associated objects The ability to show map objects in multiple styles to display application status Map nesting that selectively reveals increasing levels of map detail with the status of child objects on nested maps bubbled up to the parent map Linked Backgrounds The linked backgrounds feature allows you to create maps with backgrounds sourced directly from the Internet. Using a linked background, you can create maps that include dynamic weather information relevant to your distributed network sites. For more information, see Selecting a Background Image. AutoArrange AutoArrange options allow you to quickly structure or reorganize objects on your map. For more information, see Selecting Automatic Layout Styles."
Example Maps
The following figures are examples of the types of maps you can create using Network Atlas.
7. If you have previously installed Network Atlas, you may be prompted to change, repair or remove your installation. Click Repair, and then click Repair again on the Ready to repair window. 8. If you are installing Network Atlas for the first time, complete the following steps: a. Accept the terms in the license agreement, and then click Next. b. Provide an appropriate installation destination folder, and then click Next. c. Click Install on the Ready to Install window. 9. Click Finish when the Setup Wizard completes. For more information about starting Network Atlas and creating a new map, see Creating a Basic Map.
d. If you are connecting to a SolarWinds EOC server, select EOC as the Connect to target. e. Click Connect.
2. If you are adding objects to an existing map, complete the following steps: a. Click the Network Atlas button ( b. Click Open Map. c. Navigate to your existing map, and then click Open. 3. Expand and navigate the node tree in the left pane to locate the network nodes and monitored objects you want to add to your map. Note: All monitored applications, application components, and volumes associated with monitored nodes, in addition to other maps listed in the left pane, are available as map objects. Click [+] to expand any listed node and object types and view associated volumes and/or applications. 4. Drag selected objects onto the drawing area. Notes: If you want to add all the objects of a selected type on a selected node to your map in a single operation, click [+] next to the node name to reveal all its associated monitored network objects, and then drag all objects in the desired object group onto the drawing area. A checkmark ( your map. ) next to a node indicates you have already added it to ).
To view details about a map object, hover over it with the mouse pointer. To locate a specific map object in your map, click its network resource in the left pane. This selects the map object.
3. Click an object with the line drawing tool to begin drawing the link 4. Click and drag as needed to set optional anchor points along the link path. 5. Click a second object to finish drawing the link. 6. If you want the links connecting your mapped objects to communicate the status of connected interfaces, complete the following steps: a. Right-click a link, and then select Properties. b. Select Status in the left pane of the Link Properties page. c. Drag the appropriate interface objects from the left pane of the SolarWinds Network window to the link status assignment areas.
Note: Use multiple anchor points to create more complex shapes and curves. To use object link anchor points: 1. Click Select in the Tools group or click the middle mouse button.
Adding a Background
You can select colors, textures, and locally-hosted or Internet-hosted images to serve as your map backgrounds: Selecting a Background Color Selecting a Background Texture Selecting a Background Image Clearing the Background
Selecting a Background Color Network Atlas supports 24-bit color backgrounds. To set a map background color: 1. Click Home. 2. Click Background > Background Color ( ).
3. Select a color from the palette, or click More Colors to select a custom color. Selecting a Background Texture Network Atlas also provides numerous colored textures that can serve as map backgrounds. To set a map background textures: 1. Click Home. 2. Click Background > Background Texture ( ).
3. Enter appropriate values for the Width and Height of your map in the Map Size in Pixels area. Note: The default values are the smallest area bounding the existing map objects and labels. 4. Select a texture to apply as your map background, and then click OK.
Selecting a Background Image Network Atlas allows you to use images as your map background. The source of the background image can be a graphics file on your hard drive or a URL link to a graphics file on the Internet in any of the following graphics formats: Graphics Interchange Format (.gif, non-animated) Tagged Image File Format (.tiff) Joint Photographic Experts Group (.jpg) Microsoft Windows Bitmap (.bmp) Portable Network Graphics (.png) Linked backgrounds are updated when the map is accessed or when the browser page is refreshed. In a typical use case, a linked background is used to provide weather data from an Internet weather service on a network map. Notes: Files used for linked backgrounds must be continuously accessible by URL reference. Files used for static backgrounds must be available within the local file system. Background images you supply display at their full size in the SolarWinds Web Console, so consider their dimensions. You may rescale images within the application, but images displayed at full scale provide optimal quality. In determining map size and resolution, consider web page layouts and potential display screen resolutions. Example background images are in the NetworkAtlas Backgrounds folder located in your default shared documents folder. Clicking Background Image always starts you in this background images folder. To select a background image: 1. Click Home. 2. If you want to use a background image from disk, click Background > Background Image ( ), and then navigate to the image you want to use. 3. If you want to use a background image from the Internet, complete the following steps: Notes: In the web console, map background images linked from the Internet are refreshed with the SolarWinds Web Console refresh.
If the SolarWinds SAM server is behind a web proxy, the proxy settings entered into Microsoft Internet Explorer are used to create the Internet connection. If the web proxy requires authentication, you cannot link directly to the background image. A workaround is to write a script that periodically downloads the Internet image and saves it to a folder on the web server. You can then specify the saved image as the linked background image. a. Click Background > Linked Background ( b. Type the URL of the image you want to use. c. Click Validate. d. Click OK. Clearing the Background To clear the current map background, click Home, and then click Background > Clear Background ( ). ).
Saving Maps
Network Atlas saves your maps directly to the server to which you are connected. Note: To save a map to your hard drive instead of your SolarWinds server, click > Export > Export Map. To save a map: 1. Click the Network Atlas button ( ), and then click Save.
2. If you are saving the map for the first time, name the map, and then click OK. 3. If you want to save your map to your hard drive, complete the following steps: a. Click > Export > Export Map.
b. Navigate to an appropriate location on your hard drive. c. Provide a File name, and then click Save.
Opening Maps
Maps are loaded from the SolarWinds server to which you are connected. They appear in the left pane of the Network Atlas window. To open a map,
498 Network Atlas
1. Click [+] to expand the Maps group in the left pane of the Network Atlas window. 2. Double-click the map you want to open.
Displaying Map Object Metrics Adding Independent Map Objects and Floating Labels Changing the Appearance of Map Objects Changing the Appearance of Links Changing the Appearance of Labels Linking Map Objects to URLs Linking or Embedding Maps in Web Pages
Click View, and then select the type of zoom you want to use from the Zoom group.
The map of Oklahoma can then become a parent map to a network diagram.
Each child map can include a view of the objects, either devices or other maps, deployed on it. Any nested objects can then be clicked to view the next level of map detail, until the level of the final network device is reached and all available network information is displayed. Note: The total number of objects on a map, including those displayed on child maps, affects how fast the map loads in the SolarWinds Web Console. If your maps load slowly, decrease the number of map objects. To create a nested map: 1. Drag a map from the Maps group in the left pane onto the parent map, and then position the map icon appropriately. 2. If you want the status of a child map to also indicate the status of its child objects, complete the following steps: a. Right-click the child map icon on the map, and then select Properties. b. Check Include child status on the Status properties page, and then click OK. The object status icon now includes the secondary status indicator.
To change the thresholds of the metrics: 1. Right-click the map object, and then select Properties. 2. Click Metrics to view the Metrics properties page. 3. If you want to change the warning or critical threshold for a metric, click the threshold value, and then type a new value. 4. If you want to ignore a metric, uncheck the metric. 5. Click OK. Notes: The secondary status indicator respects the SolarWinds web console Status Rollup Mode setting for displaying status.
All child objects and selected metric thresholds are taken into account to determine secondary status.
2. Click Graphic Styles in the left column. 3. Select an appropriate default style for each available map object. Changing the representation of selected map objects opens up another level of graphical information. For example, you can set an object icon to display a mainframe graphic, visually designating the type of device being monitored. You can then select a status style, such as 3D Pad Underneath, to illustrate the map object status. To change the representation of selected map objects: 1. Right-click a map object, and then select Properties. 2. Click Appearance in the left column of the Properties page. 3. If you want the map object to appear as a fixed-size, LED-type graphic, complete these steps: a. Select SolarWinds LED Status Icon. b. Select a style from the SolarWinds LED Status Icon Style list, and then click OK. 4. If you want the map object to appear as a scalable shape, complete these steps: a. Select Shape b. Select a style from the Shape Style list, and then click OK. c. Drag a corner handle on the map object to resize the shape. 5. If you want the map object to appear as a scalable graphic, complete these steps. a. Select Graphic. b. Click Select Graphic, select an appropriate graphic, and then click OK. c. Select a status style from the Graphic Style list, and then click OK. d. Drag a corner handle on the map object to resize the graphic.
Icons that you paste into Network Atlas are saved to the SolarWinds database, and made available for reuse in other maps under the "Imported" icon grouping. Pasted icons saved to the SolarWinds database can be accessed and used by remote instances of Network Atlas. To paste a custom icon into Network Atlas: 1. Open the icon image in a graphics program such as Visio or Photoshop. 2. Copy the image to the Windows clipboard with the Copy command. 3. Open the desired map in Network Atlas. 4. Paste the image as new object following these steps: a. Right-click on the map and then click Paste. b. Select Paste the image from the Clipboard as a new object. c. Enter a name for the this new image in the Please enter a name for the new image field. d. Click OK. Icons added in this manner are also saved on the SolarWinds SAM server in the path %APPDATA%\SolarWinds\NetworkAtlas\Maps\Orion\<orion server address>\NetObjects\Imported. %APPDATA% is typically C:\Documents and Settings\<logged on user>\Application Data for Windows XP, and C:\Users\<logged on user>\AppData\Roaming for Windows Server 2008. To delete a custom icon: 1. Determine which file on the SolarWinds SAM server contains the icon (for example, mypicture.wmf). 2. Add .del to the file name (for example, mypicture.wmf.del) 3. Start Network Atlas on the SolarWinds SAM server to delete the icons from the database.
To add custom icons from graphics files: 1. On your SolarWinds SAM server, create the folder:
%APPDATA%\SolarWinds\NetworkAtlas\Maps\Orion\<orion server ad dress>\NetObjects\User Graphics. %APPDATA% is typically C:\Documents and Settings\<logged on user>\Application Data for Windows XP, and C:\Users\<logged on user>\AppData\Roaming for Windows Server 2008.
2. Copy the graphics files to this folder. 3. Start Network Atlas on the SolarWinds SAM server to finalize the additional icons. After copying the graphics files to their location, you can assign them as an icon as you would any other graphic image. To assign a custom icon to an object: 1. Right-click the object on the map, and then click Select Graphic. 2. Select User Graphics in the left pane. 3. Select your desired graphic image, and then click OK.
6. Click OK. Note: The color setting only changes the color of links that have Up status.
orionServer This is the IP address or host name of your SolarWinds SAM server. mapName This is the display name of the map. If the map display name contains space characters, substitute %20 for the spaces when specifying the name.
Use ${CR} to enter a carriage return. To add additional information to map object tool tips: 1. Log on to SolarWinds SAM as an administrator. 2. Click Edit in the Network Map resource. 3. Click Customize map tooltips. 4. Type the variables and any text you want to add in the text field for the appropriate map object type. 5. Click Submit. Example Custom SolarWinds Node Tooltip Enter this custom node tooltip definition in the Orion.Nodes field to display node location and contact information: Orion.Nodes
Location: ${Location}${CR}Contact: ${Contact}
For more information about available tooltip variables, see Network Atlas Tooltip Variables."
Orthogonal Emphasizes compact drawings and uses only horizontal and vertical edges. Objects are enlarged if necessary to provide enough space for edge connections. Use orthogonal layouts for maps that need to depict multiple clusters in a space-efficient manner. Tree Emphasizes parent and child relationships. Child objects are arranged farther from the root object than their parent objects. Use tree layouts for maps that have a central control object. Reorganize Moves all mapped objects back to the center of the map view. Arrange Labels Restores the default relative position of all object labels. To arrange map objects according to a layout style: 1. Click Edit. 2. Click an appropriate layout style from the AutoArrange group.
Map Properties
The Map Properties window allows you to configure options regarding the following aspects of your map: Setting the Map Up Status Threshold Overriding Account Limitations Setting the Map Up Status Threshold The UP status threshold is the percentage of map objects that must be in an up state on a given map for the map to be represented as up on the parent map. To set the percentage of map objects that determine Up status of a map: 1. Right-click any empty portion of the map, and then select Map Properties. 2. Slide the Map status will be UP slider to configure an appropriate up state threshold on the Map Properties page.
Overriding Account Limitations For security reasons, you may wish to prevent web console users who have account limitations from seeing network nodes on the map they are not allowed to see. By hiding the restricted nodes and links, users with account limitations remain unaware that the nodes even exist. To hide nodes from users who have account limitations: 1. Right-click any empty portion of the map, and then select Map Properties. 2. Select Remove nodes that users do not have permission to view. If you choose to reveal restricted nodes to all users, all web console users can see the restricted nodes, but users with account limitations cannot retrieve any additional information about the restricted node. To reveal nodes to all users: 1. Right-click any empty portion of the map, and then select Map Properties. 2. Select Allow all users to view all nodes on this map. Note: A SolarWinds SAM user with account limitations, but who has permission to run and use the Network Atlas application, can change this setting in the map and see the presence of restricted nodes. Although the user cannot retrieve any information regarding the restricted nodes, this can still be considered a security risk. If this is a concern, do not give node management permissions to SolarWinds SAM users who have account limitations.
Map Defaults The options in this section allow you to set a device threshold for the overall map status. The status indicator reflects the state of many objects at once; therefore, SolarWinds recommends that the map status be set at 100%. At this setting, when any device on a map or sub-map is down, the problem status will be indicated. Node Tree The options in this section allow you to customize the view of the node tree located on the left pane of the Network Atlas main window. Some users find it helpful to display the status icons of each node and interface, while others find the vendor network node and interface icons more useful. You may also specify that node names and/or IP addresses be included in the display. Graphic Styles The options in this section allow you to select the default graphical styles for Network Atlas. You can change the default style types for network objects, and you can select a color scheme for Network Atlas itself.
Application Variables
The following application variables are valid for use in Network Atlas tooltips.
Variable ${ApplicationID} ${ApplicationTemplateID } ${JobId} ${Name} ${NodeID} ${Status} ${StatusDescription} ${UnManaged} Description Internal unique identifier of the application Internal unique identifier of the parent template Internal unique identifier of the SolarWinds Job Engine task associated with this application Application name Internal unique identifier of assigned node Numerical application status code. For more information see Status Icons and Identifiers in the SolarWinds Network Performance Monitor Administrator Guide. User friendly application status States if application is currently unmanaged
General Variables
The following general variables are valid for use in Network Atlas tooltips.
Variable ${Acknowledged} ${AcknowledgedBy} ${AcknowledgedTime} ${AlertTriggerCount} ${AlertTriggerTime} ${Application} ${Copyright} ${CR} ${ObjectName} ${Release} ${Version} Description Acknowledged status Who the alert was acknowledged by Time the alert was acknowledged Count of triggers Date and time of the last event for this Alert. (Windows control panel defined Short Date and Short Time) SolarWinds application information Copyright information Line Feed Carriage Return Description/Name of the object in the alert Release information Version of the SolarWinds software package
Node Variables
The following node variables are valid for use in tooltips.
Variable ${AgentPort} ${Allow64BitCounters} ${AvgResponseTime} ${BlockUntil} ${Caption} ${Community} ${CPULoad} ${CustomPollerLastStati sticsPoll} ${CustomPollerLastStati sticsPollSuccess} ${DateTime} ${Description} ${DNS} ${DynamicIP} ${EngineID} ${External} ${GroupStatus} Description Node SNMP port number Node allows 64-bit counters (1), or not (0) Average node response time , in msec, to ICMP requests Day, date, and time until which node polling is blocked User friendly node name Node community string Node CPU utilization rate at last poll Day, date, and time of last poll attempt on node Day, date, and time that node was last successfully polled Current date and time. (Windows control panel defined Long Date and Long Time format) Node hardware and software Fully qualified node name If node supports dynamic IP address assignment via BOOTP or DHCP (1); static IP address return (0) Internal unique identifier of the polling engine to which node is assigned States if node is currently designated as external Filename of status icon for node and its interfaces
Volume Variables
The following volume variables are valid for use in Network Atlas tooltips.
Variable ${Caption} ${FullName} ${LastSync} ${NodeID} ${Status} ${StatusLED} ${VolumeAllocationFailuresThisHour} ${VolumeAllocationFailuresToday} ${VolumeDescription} ${VolumeID} ${VolumeIndex} ${VolumePercentUsed} ${VolumeResponding} ${VolumeSize} ${VolumeSpaceAvailable} ${VolumeSpaceUsed} ${VolumeType} ${VolumeTypeIcon} Description User friendly volume name User friendly volume name including captions of parent node and interface Time and date volume last synchronized in database and memory models Internal unique identifier of parent node Numerical volume status: (0=Unknown, 1=Up, 2=Shutdown, 3=Testing) Filename of volume status icon Number of volume allocation errors for this volume in last hour Number of volume allocation errors for this volume in current day User friendly volume description Internal unique identifier of volume Unique index of volume within the parent node Percentage of volume currently in use (Y) = volume is currently responding to SNMP queries Size of volume, in bytes Total space available on volume, in bytes Total space used on volume, in bytes Volume type, as reported by hrStorageType OID (Removable Disk/Fixed Disk/Compact Disc/Virtual Memory/RAM/etc) Filename of icon for volume type
Wireless Variables
The following wireless variables are valid for use in Network Atlas tooltips.
Variable ${WirelessAP} ${ WirelessLastStatPoll } ${ WirelessPollInterval } ${ WirelessStatBlockUntil } Description States if node is being polled by the wireless poller (1) or not (0) Date and time node last polled by wireless poller Interval, in minutes, between wireless polling attempts on node Date and time node may be polled again by wireless poller
Group Variables
The following group variables are valid for use in Network Atlas tooltips.
Variable ${ContainerID} ${DetailsURL} ${Frequency} ${IsDeleted} Description Designated identifier for a mapped group URL of the Group Details view for a mapped group Interval on which group membership is evaluated and group snapshots are taken. When a group is marked for deletion, it is not deleted immediately. If a group is marked for deletion but not yet deleted, ${IsDeleted} returns 1. The date and time of the last change made to the definition of a group. This does not include changes made to group members resulting from dynamic queries. The name assigned to the mapped group SolarWinds product appropriate to the mapped group type Name of roll-up logic calculator that evaluates status of the mapped group based on member statuses. 0 = Mixed, 1 = Worst, 2 = Best. The Worst method reports group status as the worst status of any of its members. The Mixed method reports group status as Warning when members are of multiple different statuses. The Best method reports group status as the best status of any of its members. Status of the mapped group. For more information, see Managing the Display of Group Status in the SolarWinds Common Components Administrator Guide. Name of roll-up logic calculator that evaluates status of the mapped group based on member statuses. 0 = Mixed, 1 = Worst, 2 = Best. The Worst method reports group status as the worst status of any of its members. The Mixed method reports group status as Warning when members are of multiple different statuses. The Best method reports group status as the best status of any of its members. Uri used by SolarWinds Information Service (SWIS) to refer to the selected group member within the web console. URL of the Group Details view for a mapped group
${RollupType}
${Status}
${StatusCollector}
${Uri} ${WebUri}
For a complete list of SAM specific variables, "Configuring SolarWinds SAM Alerts" on page 306.
Appendix E
same time. The Server & Application Monitor Account or User ID and Passwords must then be set up to match the Account or User ID and Passwords that are used for the Domain and/or Local computer security. Use the following procedure to enable IIS NT Security for logging in to the SolarWinds Web Console with Windows Pass-through Security. Note: When authenticating users with Windows Security, ensure your SolarWinds server uses the NetBIOS domain name, instead of the fully qualified domain name. To enable IIS NT security for Windows Pass-through Security: 1. If you are using NT Domain Authentication Format for pass-through accounts, create these pass-through accounts in the SolarWinds Web Console Account Manager using Domain\UserID as the User Name, as follows:
Washington\Edward StLouis\Bill
Note: For more information about creating accounts using the SolarWinds Web Console Account Manager, see Creating New Accounts on page 187. 2. If you are using Local Computer Authentication Format for pass-through accounts, create these accounts in the SolarWinds Web Console Account Manager using Computer\UserID as the User Name, as follows:
SolarWindsS2\Edward Server3\JonesR
Note: For more information about creating accounts using the SolarWinds Web Console Account Manager, see Creating New Accounts on page 187. 3. Click Start > Control Panel > Administrative Tools > Internet Information Services (IIS) Manager. 4. If you are using Windows Server 2003, complete the following steps: a. Expand Internet Information Services > Local Computer > Web Sites in the left pane. b. Select SolarWinds NetPerfMon. c. Click Action > Properties. d. Click the Directory Security tab. e. Click Edit within the Authentication and access control area. f. Clear Enable anonymous access.
g. Check Integrated Windows authentication in the Authenticated access group. h. Click Ok to close the Authentication Methods window. i. j. Click Apply, if available, and then click Ok to close the SolarWinds NetPerfMon Properties window. Collapse Internet Information Services > Local Computer > Web Sites.
k. Collapse Internet Information Services > Local Computer in the left pane. l. Click Action > All Tasks > Restart IIS.
m. Confirm that Restart Internet Services on Local Computer is selected, and then click Ok. n. Close the IIS Manager. 5. If you are using Windows Server 2008, complete the following steps: a. Click Start > Administrative Tools > Server Manager. b. Expand Roles. c. Click Web Server (IIS). d. In the Role Services area, confirm that Web Server > Security > Windows Authentication is installed. e. If Windows Authentication is not installed, click Add Role Services, check Web Server > Security > Windows Authentication, click Next, and then complete the service installation. f. Click Start > Administrative Tools > Internet Information Services (IIS) Manager.
g. Select your SolarWinds server in the left pane. h. Click Authentication in the IIS group of the main pane. i. j. Right-click Anonymous Authentication, and then click Disable. Right-click Windows Authentication, and then click Enable.
k. Click your SolarWinds server, and then click Restart in the Actions pane. 6. Close the IIS Manager. 7. Log in to the SolarWinds Web Console using the Windows account credentials you have already established.
Provide the hostname or IP address of your SolarWinds server as the DOMAIN. Provide your SolarWinds User ID as the USER, and then provide your SolarWinds user account password as the PASSWORD. Warning: HTTP requests are not encrypted, so User IDs and Passwords sent in HTTP requests are not secure. For more information about enabling HTTPS on your SolarWinds server, consult www.microsoft.com.
Appendix F
Troubleshooting
If you have problems with a SolarWinds product, the causes are usually related to an incorrect configuration or corrupted files. The suggestions listed in this section can often clear up these problems. Additionally, you can visit our knowledge base repository for articles to help remedy specific issues. The address is: http://knowledgebase.solarwinds.com/kb/ You can also talk to other users as well as the SolarWinds staff by logging on to thwack.com Back Up Your Data As a first step in any troubleshooting procedure, you should back up your SolarWinds database. For more information, see Creating Database Backups on page 440. Verify Program Operation SolarWinds runs many components at the same time to deliver a view of your network status. Confirm that the following components are running on your SolarWinds server:
Troubleshooting 525
Services: Message Queuing Net.Tcp Port Sharing Service SNMP Trap Service SolarWinds Alerting Engine service SolarWinds Collector Data Processor, Management Agent, and Polling Controller services SolarWinds Information Service SolarWinds Job Engine and Job Engine v2 SolarWinds Job Scheduler SolarWinds Network Performance Monitor Service. All SolarWinds products use this service. It is not exclusive to SolarWinds SAM. SolarWinds Product services SolarWinds Information Service SolarWinds Module Engine SolarWinds Syslog and Trap Services SQL Server Internet Information Service (IIS) Stop and Restart Many problems disappear when programs are restarted. Stopping and restarting Internet Information Service (IIS) may eliminate web page problems. Problems with polling or data gathering may be eliminated by stopping and restarting the SolarWinds Network Performance Monitor Service using the available shutdown tool that you can locate as follows: Click Start > All Programs > SolarWinds > Advanced Features > Orion Service Manager. For a complete refresh of the system, reboot the computer. Run the Configuration Wizard Running the Configuration Wizard, which refreshes files on the web server and performs checks on the structure of your database, may solve many problems. Note: Before you run the Configuration Wizard, you should close all open applications and stop the SolarWinds Network Performance Monitor Service in
526 Troubleshooting
the Windows Services Control Panel. It will be restarted by the Wizard at the end of its process. Using Full Variable Names If you are having difficulty acquiring expected values from a selected variable, using the ${VariableName}format, it may be helpful to include the database table name within the variable name, as in ${Nodes.IP_Address}.
If these conditions cannot be met, the WMI component monitors in SAM show an Unknown status. Examples of some issues that can prevent these conditions from being met include, but are not limited to: Trying to connect to a remote computer where you do not have local Administrator rights. A firewall blocking the WMI traffic. An operating system that is not configured for WMI. Mistyping the credential password in the SAM component monitor. To help diagnose and fix these issues and others, we can test the WMI services, the remote WMI connections, and the SolarWinds SAM component configuration to discover and correct the issues that can prevent your WMI component monitors from functioning correctly. The topics in this guide are as follows:
Troubleshooting 527
WMI Troubleshooting Flowchart for SolarWinds SAM. Provides a flowchart of the troubleshooting decisions described in this guide. Testing Local WMI Services. Ensures WMI is running correctly on the target computer. Testing Remote WMI Connections. Ensures the WMI connection to the target computer is not being blocked, ignored, or rejected. Testing SolarWinds SAM Component Configuration. Ensures you are properly configuring the WMI component credentials in SolarWinds SAM.
528 Troubleshooting
Troubleshooting 529
530 Troubleshooting
4. Enter root\cimv2 in the field at the top of the dialog box next to the Connect button.
Troubleshooting 531
8. Select the Recursive radio button without entering a superclass name, and then click OK.
9. If the WMI class you are querying appears in this list, local WMI services are functioning correctly. Skip to the next topic and test remote WMI.
532 Troubleshooting
10. If the list does not appear or does not contain the desired WMI class, WMI is not functioning correctly. Continue reading this section for guidance on repairing WMI services on the target server. 11. Click the Close button, and then click Exit.
534 Troubleshooting
4. Enter \\Target_Primary_IP_Address\root\cimv2 in the field at the top of the dialog box. Replace Target_Primary_IP_Address in the above example with the actual Hostname or Primary IP Address of the target server.
5. Enter the user name in the User field, the password in the Password field, and NTLMDOMAIN:NameOfDomain in the Authority field. Replace NameOfDomain with the domain of the user account specified in the User field. 6. Click Connect. 7. Click Enum Classes.
Troubleshooting 535
8. Select the Recursive radio button without entering a superclass name, and then click OK.
9. If the WMI class list appears, remote WMI is functioning correctly. Skip to the next topic and test your SAM credentials.
536 Troubleshooting
10. If the list does not appear, remote WMI is not functioning correctly. Continue reading this topic for guidance on restoring remote WMI connections on the target server, and retest remote WMI after completing each troubleshooting step. 11. Click the Close button, and then click Exit.
1. Log on to the target server with an administrator account. 2. Click Start, click Run, type services.msc, and then press ENTER. 3. Scroll the list to Remote Procedure Call (RPC) 4. Right-click Remote Procedure Call (RPC), and then click Start on the shortcut menu.
Configure Distributed Component Object Model (DCOM) and User Account Control (UAC)
If the target computer is running Windows Vista or Windows Server 2008, you may be required to make settings changes to allow remote WMI requests (http://msdn.microsoft.com/en-us/library/aa822854(VS.85).aspx). Item DCOM WMI Namespaces Need Default and Limits permissions edited to allow the following actions: Local launch (default permission) Remote launch (default permission) Local activation (limits permission) Remote activation (limits permission) For more information, see Enabling DCOM Modify the CIMV2 security to enable and remote enable the account used to access the server or workstation through WMI. You must ensure the security change applies to the current namespace and sub-namespaces. For more information, see Enabling Account Privileges in WMI Remote UAC access token filtering must be disabled when monitoring within a workgroup environment. For more information, see Disabling Remote User Account Control for Workgroups
538 Troubleshooting
Enabling DCOM
WMI uses DCOM to communicate with monitored target computers. Therefore, for Server & Application Monitor to use WMI, DCOM must be enabled and properly configured. To enable DCOM permissions for your Server & Application Monitor credentials: 1. Log on to the target server with an administrator account. 2. Navigate to Start > Control Panel > Administrative Tools > Component Services. You need to switch to the Classic View of the Control Panel to use this navigation path. You can also launch this console by double-clicking comexp.msc in the /windows/system32 directory. 3. Expand Component Services > Computers. 4. Right-click My Computer, and then select Properties. 5. Select the COM Security tab, and then click Edit Limits in the Access Permissions grouping. 6. Ensure the user account you want to use to collect WMI statistics has Local Access and Remote Access, and then click OK. 7. Click Edit Default, and then ensure the user account you want to use to collect WMI statistics has Local Access and Remote Access, 8. Click OK. 9. Click Edit Limits in the Launch and Activation Permissions grouping. 10. Ensure the user account you want to use to collect WMI statistics has Local Launch, Remote Launch, Local Activation, and Remote Activation, and then click OK. 11. Click Edit Default, and then ensure the user account you want to use to collect WMI statistics Local Launch, Remote Launch, Local Activation, and Remote Activation. 12. Click OK.
Troubleshooting 539
1. Log on to the computer you want to monitor with an administrator account. 2. Navigate to Start > Control Panel > Administrative Tools > Computer Management > Services and Applications. You need to switch to the Classic View of the Control Panel to use this navigation path. 3. Click WMI Control, and then right-click and select Properties. 4. Select the Security tab, and then expand Root and click CIMV2. 5. Click Security and then select the user account used to access this computer and ensure you grant the following permissions:
Enable Account Remote Enable
6. Click Advanced, and then select the user account used to access this computer. 7. Click Edit, select This namespace and subnamespaces in the Apply to field, and then click OK. 8. Click OK on the Advanced Security Settings for CIMV2 window. 9. Click OK on the Security for Root\CIMV2 window. 10. Click Services in the left navigation pane of Computer Management. 11. Select Windows Management Instrumentation in the Services result pane, and then click Restart.
540 Troubleshooting
4. Expand
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Po licies\System.
5. Locate or create a DWORD entry named LocalAccountTokenFilterPolicy and provide a DWORD value of 1. Note: To re-enable remote UAC, change this value to 0.
For more information, see "Additional Polling Engine and Web Console" on page 459.
Troubleshooting 541
After you click Set Component Credentials to set the component credentials, you must also click Submit at the bottom of the page.
542 Troubleshooting
Repair the WMI Repository according to this KB article: http://knowledgebase.solarwinds.com/kb/questions/633/Error+message+%22Inv alid+Class%22+when+using+WMI+monitors Note: Vista and Windows 2008 have a built-in method for repairing the WMI repository. Open an Administrator command prompt and run: winmgmt /salvagerepository If you are using APM prior to version 4 and using WMI, try the following: There are three required WMI queries for service monitoring to work: SELECT * FROM Win32_Service SELECT * FROM Win32_Process SELECT * FROM Win32_PerfRawData_PerfProc_Process You can test these by going to Start > Run > WBEMTEST on the SolarWinds server. 1. Click on Connect. 2. In the whitespace at the top, you should have \\ipaddress\root\CIMV2 3. For user and password, fill in the credentials used in APM. 4. For Authority, type in NTLMDOMAIN: and enter your domain. 5. Click Connect. 6. Click Query 7. Enter the above three queries, one at a time. More often than not, the culprit is the last query. If your problem still exists, try the following: 1. Re-sync the counters by opening a command prompt and typing: winmgmt /resyncperf 2. Check to make sure performance counters are not disabled: http://thwack.com/forums/68/application--servermanagement/21/application-performancemonitor/23124/win32perfrawdataperfprocpro/ Note: WMI is an operating system component. If the previous steps do no work, you may need to contact Microsoft for further information.
Troubleshooting 543
544 Troubleshooting
Note: Regardless of where you actually install SolarWinds, some common files may be installed where the operating system of your SolarWinds server are located. To redefine default system temporary directories: 1. Log on to your SolarWinds server as a user with administrative rights. 2. Right-click My Computer, and then click Properties. 3. Click Advanced, and then click Environment Variables. 4. Select the variable name representing the directory you want to redefine, click Edit, and then provide a new path as the Variable value for the selected temporary directory variable.
Troubleshooting 545
Administrator Guide SolarWinds Server & Application Monitor netsh interface tcp set global autotuninglevel=disabled
5. Close the command prompt window, and then restart your SolarWinds server.
546 Troubleshooting
The Hardware Monitoring Agent software, (provided by the vendor), is installed on the remote server. This applies for both SNMP and WMI. Required software can be found at "Monitoring Hardware Health" on page 391. For VMware, the minimum requirements are as follows: ESX server version 3.5, 4.0, 4.1, ESXi version 5.0, vCenter version 4.0, 4.1, 5.0.
The folllowing systems have been verified to work properly with SAM's hardware monitoring features. Note: Other systems may work as well. Dell PowerEdge M610, R210, R610, R710, R900, 1950, 2850, 2950, 2970, 6850 HP ProLiant DL320 G4, DL360 G3, DL360 G4, DL380 G4, DL380 G6, ML570 G3 IBM IBM System x3550, System x3550 M2, System x3550 M3, System x3650, System x3650 M2, System x3650 M3, x3850, eServer 306m Note: IBM's ServeRAID Manager software must be installed on IBM XSeries servers for storage hardware health information to be displayed in SolarWinds SAM. HPs WBEM providers are required for HP servers polled via WMI. Installation instructions can be at "Monitoring Hardware Health" on page 391.
Troubleshooting 547
Note: Dell does not make array and hard disk health information visible from WMI managed nodes. To monitor storage health on Dell servers, use SNMP.
548 Troubleshooting
2. Verify the Hardware Monitoring Agent software is installed on the remote server and running. For verification instructions, see "Accessing Hardware Monitoring Agent Software" on page 393. 3. Determine if SNMP responds for the proper OID. Below are the correct OIDS for each vendor: For HP: For Dell: For IBM: 1.3.6.1.4.1.232.2.2.2.1.0 1.3.6.1.4.1.674.10892.1.300.10.1.8.1 1.3.6.1.4.1.2.6.159.1.1.60.3.1
To determine if the remote server responds to the correct OID, you can use the MIB browser from SolarWinds Engineers Toolset, which can be downloaded from http://www.solarwinds.com/downloads/. Additionally, you can use other applications capable of making SNMP requests.
If you do not have a tool for checking OIDs on the remote server, you can create an SNMP walk by using the SNMPWalk.exe installed with SAM, normally located at C:\Program Files (x86)\SolarWinds\Orion\SnmpWalk.exe. SNMPWalk.exe will be used in this demonstration.
Using SNMPWalk.exe:
1. Start SNMPWalk.exe and type in the IP address of the remote server and the community string for SNMP. 2. Click Scan. 3. After completing the scan, save the SNMP walk in a text file. 4. Open the text file and manually search for the OIDs. If the Remote Server does not respond on this OID, the Hardware Monitoring Agent software may not be properly configured. Check to see if the Hardware Monitoring Agent software has imported the correct MIBs as outlined in the following table.
550 Troubleshooting
For information on verifying Hardware Monitoring Agent software, see "Accessing Hardware Monitoring Agent Software" on page 393.
HP CPQSTDEQ-MIB CPQSINFO-MIB CPQIDA-MIB CPQHLTH-MIB CPQSTSYS-MIB CPQIDE-MIB Dell MIB-Dell-10892 StorageManagement-MIB IBM IBM-SYSTEM-HEALTH-MIB IBM-SYSTEM-ASSETID-MIB IBM-SYSTEM-LMSENSOR-MIB IBM-SYSTEM-MEMORY-MIB IBM-SYSTEM-POWER-MIB IBM-SYSTEM-PROCESSOR-MIB IBM-SYSTEM-RAID-MIB ADAPTEC-UNIVERSALSTORAGE-MIB
Troubleshooting 551
2. Connect from the problematic node (either the SAM server or the additional poller server) to the remote server using wbemtest.exe. 3. Click Connect. 4. In the Namespace field enter: For IBM and HP enter: \\RemoteServerIpAddress\root For Dell enter: \\RemoteServerIpAddress\root\cimv2
552 Troubleshooting
6. Click Connect. 7. Once connected, click Query from the main screen. The Query dialog appears. 8. Enter: select * from __Namespace
Replace Namespace with the following: For HP nodes, replace Namespace with HPQ For Dell node replace Namespace with Dell For IBM node replace Namespace with IBMSD
Troubleshooting 553
9. If the proper Namespace is found, connect to this Namespace. \\RemoteServerIpAddress\root\IBMSD for IBM. \\RemoteServerIpAddress\root\HPQ for HP. \\RemoteServerIpAddress\root\cimv2\Dell for Dell.
10. Run a Query for specific information. Select Manufacturer, Model, SerialNumber from CIM_Chassis If the test was not successful, re-install the platform or Hardware Monitoring Agent software on the remote server with the latest release.
554 Troubleshooting
3. Use the illustration below to determine how your VMWare is being polled.
Troubleshooting 555
556 Troubleshooting
Appendix G
"Oracle User Experience Monitor" on page 612 "Performance Counter Monitor" on page 617 "POP3 Monitor" on page 620 "POP3 User Experience Monitor" on page 622 "Process Monitor - SNMP" on page 624 "Process Monitor - WMI" on page 626 "RADIUS User Experience Monitor" on page 628 "Service Status SNMP" on page 630 "SSL Certificate Expiration Date Monitor" on page 638. "SMTP Monitor" on page 632 "SNMP Monitor" on page 633 "SQL Server User Experience Monitor" on page 635 "TACACS+ User Experience Monitor" on page 640 "TCP Port Monitor" on page 642 "Tomcat Server Monitor" on page 644 "VMware Performance Counter Monitor" on page 647 "Web Link Monitor" on page 651 "Windows Event Log Monitor" on page 654 "Windows PowerShell Monitor" on page 658 "Windows Script Monitor" on page 661. "WMI Monitor" on page 665.
Unicast This is the default DHCP Discovery Request Type. The broadcast flag is not set, the ciaddr (Client IP Address) is set to the local address, and the giaddr (Relay Agent IP Address) is not set. The DHCP client sends a unicast DHCP DISCOVER to the DHCP server IP address and the UDP Request Port (defaults to 67). The DHCP server then sends a unicast DHCP Offer to the ciaddr address and the UDP Response Port (defaults to 68). This option can be used to monitor DHCP servers on the same subnet as the SolarWinds SAM server or on a different subnet. Broadcast The broadcast flag is set, the ciaddr (Client IP Address) is set to the local address, and the giaddr (Relay Agent IP Address) is not set. The DHCP client sends a unicast DHCP DISCOVER to the DHCP server IP address and the UDP Request Port (defaults to 67). The DHCP server then sends a broadcast DHCP Offer to the UDP Response Port (defaults to 68). This option can be used to monitor DHCP servers on the same subnet as the SolarWinds SAM server Relay Agent The broadcast flag is not set, the ciaddr (Client IP Address) is set to the local address, and the giaddr (Relay Agent IP Address) is set to the local address. The DHCP client sends a unicast DHCP DISCOVER to the DHCP server IP address and the UDP Request Port (defaults to 67). The DHCP server then sends a unicast DHCP Offer to the giaddr (Relay Agent IP Address) and the UDP Request Port (defaults to 67). This option can be used to monitor DHCP servers on the same subnet as the SolarWinds SAM server or on a different subnet. Note: You can use the Broadcast or Relay Agent DHCP discovery request type to handle the issue with some DHCP servers (for example Internet Systems Consortium DHCP Server) that do not send a DHCP Offer back to the SolarWinds SAM Server IP address. They send it to the newly leased IP address (the IP address being offered) instead. To handle this issue, set the DHCP Discovery Request Type to either Broadcast or Relay Agent. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see "Configuring SolarWinds SAM Alerts" on page 306.
Include Subdirectories Determines whether the contents of subdirectories are included in the disk space usage calculations for the directory size. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see "Configuring SolarWinds SAM Alerts"
Expect All Matches Specifies that the result of the DNS query must include all expected entries to be considered a successful test. If this checkbox is not checked, a single match indicates a successful test. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see "Configuring SolarWinds SAM Alerts"
Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Current Snapshot Checksum This field is the calculated checksum against which SolarWinds SAM is comparing the monitored file. To calculate a new checksum, click Update Checksum. Select and upload a file for snapshot creation This field is the local path to a file on the user's computer (where the web browser is running) used to calculate the checksum against which the monitored file is compared. Click Browse to open a Windows Choose File dialog from which you can select the file directly. Click Update Checksum to calculate the new checksum. Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
File Extensions Filter Specifies which files to include in the count based on the file extension. You can specify multiple file extensions separated by commas or spaces. To include all files, specify *. Example for counting all files regardless of file extension File Extensions Filter: * Example for counting files with .exe, .dll, and .bat extensions File Extensions Filter: exe, dll, bat File Attributes Filter Specifies which files to include in the count based on the file attributes. The default value is All Files. Include Subdirectories Specifies the file count should also include files located inside subdirectories Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
FTP Monitor
This component monitor tests the ability of an FTP server to accept incoming sessions and respond with the correct codes. Statistic This component monitor does not compute a statistic. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Port Number This field is the port number used for FTP sessions. The default value is 21. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring Select a credential that can log on to the FTP server. For example, to monitor an anonymous FTP server, select or add a credential containing anonymous as the user name and your email address as the password. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Port Number This field is the port number used for FTP sessions. The default value is 21. Url Allows you to specify the URL of the file you want to monitor. The URL can include the variable ${IP} which represents the target node's IP address, and the variable ${PORT} which represents the value in the Port Number field. Use Proxy This checkbox allows you to use a web proxy to access the web site. Proxy Address This field allows you to specify the address of a web proxy to access the web site. Passive Mode This checkbox allows you to monitor the file using passive mode FTP. This mode is typically used to circumvent a firewall that would otherwise filter the incoming connection to the SolarWinds SAM server.
Current Snapshot Checksum This field is the calculated checksum against which SolarWinds SAM is comparing the monitored file. To calculate a new checksum, click Update Checksum. Select and upload a file for snapshot creation This field is the local path to a file on the SolarWinds SAM server that is used to calculate the checksum against which the monitored file is compared. Click Browse to open a Windows Choose File dialog from which you can select the file directly. Click Update Checksum to calculate the new checksum. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
In the example code, the actual login input tag name is "nick, but testing the component monitor results in an error similar to the following:
Response page matches login error keywords Page contains 1 form(s). Form 'login_form' inputs: ( 'cust_id' 'nick' 'pswd' );
Administrator Guide SolarWinds Server & Application Monitor Assumed form with name = login_form as login form Assumed login input: name = status, password input: name = pswd
The error status message informs you that the component monitor incorrectly assumed the input tag with the name "status" was the login input. Recognizing this error, you correct it by adding the correct tag name "nick" to the list of keywords in the Login Control Keywords field:
(login)|(name)|(email)|(nick)
Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring Select a credential that can log on to the web site. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Port Number This field is the port number used for HTTP forms-based login sessions. The default value is 80. Url Allows you to specify the URL you want to monitor. The SolarWinds SAM variable ${IP} contained in the default value for this field attempts to monitor a web site at the IP address of the assigned node. Use Proxy This checkbox allows you to use a web proxy to access the web site. Proxy Address This field allows you to specify the address of a web proxy to access the web site.
584 Component Monitor Types
Ignore CA Errors If checked, this indicates that Certificate Authorization (CA) errors will be ignored. Ignore CN Errors If checked, this indicates that Common Name (CN) errors will be ignored. Accept Compression If checked, indicates that compression is supported. Login Form Keywords This field lists the expected keywords that identify an HTML login form. The keywords are matched against the name attribute of the <form> tags found in the HTML of the login page. Each keyword in this list must be enclosed in parentheses '( )', and then separated from other keywords by a vertical bar '|'. The default keywords are: (login)|(auth)|(email). Login Control Keywords This field lists the expected keywords that identify the form's user name input element. The keywords are matched against the name attribute of the <input> tags found in the HTML of the login page. Each keyword in this list must be enclosed in parentheses '( )', and then separated from other keywords by a vertical bar '|'. The default keywords are (login)|(name)|(email). Password Control Keywords This field lists the expected keywords that identify the form's password input element. The keywords are matched against the name attribute of the <input> tags found in the HTML of the login page. Each keyword in this list must be enclosed in parentheses '( )', and then separated from other keywords by a vertical bar '|'. The default keywords are (password)|(pwd)|(passwd)|(psswd)|(pswd). Login Failed Regular Expression This field contains the regular expression for matching an unsuccessful login. This expression may appear anywhere in the HTML source of the page. Login Success Keywords This field contains the regular expression for matching a successful login. This expression may appear anywhere in the HTML source of the page.
Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
HTTP Monitor
This component monitor tests a web server's ability to accept incoming sessions and transmit the requested page. The component monitor can optionally search the delivered page for specific text strings and pass or fail the test based on that search. The HTTP Monitor measures the time it takes the HTTP get for the page referenced in the component monitor to load. This response time is measured in milliseconds. Note: If a web page redirects to another page, the response time measures the entire time from the original request until the last redirected page is loaded. Statistic This component monitor does not compute a statistic. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring If the web site is password-protected, select a credential that can access the web site. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. If the web site is not password protected, do not specify a credential. Port Number The port used for the web site. The default value is 80.
Url This field allows you to specify the URL you want to monitor. The SolarWinds SAM variables contained in the default value for this field attempt to monitor a web site at the IP address of the assigned node ${IP} and on the port specified in the Port Number field ${PORT}. Proxy Servers: To prevent proxy servers from caching the monitored URL, you can append a unique query string to the URL with the ${TimeStamp} variable. Example "cache buster" for simple URL:
http://${IP}:${Port}/?_cb=${TimeStamp}
Follow Redirect This checkbox allows you to specify the component monitor to automatically follow server-side redirects. Use Proxy This checkbox allows you to use a web proxy to access the web site. Proxy Address This field allows you to specify the address of a web proxy to access the web site. User Agent This field allows you to emulate a specific user agent or browser type when contacting the web site. For example, to emulate Internet Explorer version 7, type Mozilla/4.0 (compatible; MSIE 7.0b; Windows NT 6.0). For more information about user agent strings, see http://www.useragentstring.com Search String This field contains the text string indicating successful page retrieval. If the specified string is found in the web page content, the monitor is considered up.
Note: The search string is not case-sensitive. Fail if Found This checkbox allows you to reverse the default behavior of the search string. If the search string is found in the web page content, the monitor is considered down instead of up. Head Request This field allows you to ensure the web site responds to the HTTP protocol, but without checking the validity of the web page content. Search strings are ignored if you select this option. Accept Compression If checked, indicates that compression is supported. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
HTTPS Monitor
This component monitor tests a web server's ability to accept incoming sessions over a secure channel and then transmit the requested page. The component monitor can also test the security certificate. The HTTPS Monitor measures the time it takes the HTTPS get for the page referenced in the component monitor to load. This response time is measured in milliseconds. Note: If a web page redirects to another page, the response time measures the entire time from the original request until the last redirected page is loaded. Statistic This component monitor does not compute a statistic. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring If the web site is password-protected, select a credential that can access the web site. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Port Number The port used by the web site. The default value is 443.
Url This field allows you to specify the URL you want to monitor. The SolarWinds SAM variables contained in the default value for this field attempt to monitor a web site at the IP address of the assigned node ${IP} and on the port specified in the Port Number field ${PORT}. Proxy Servers: To prevent proxy servers from caching the monitored URL, you can append a unique query string to the URL with the ${TimeStamp} variable. Example "cache buster" for simple URL:
http://${IP}:${Port}/?_cb=${TimeStamp}
Follow Redirect This checkbox allows you to specify the component monitor to automatically follow server-side redirects. Use Proxy This checkbox allows you to use a web proxy to access the web site. Proxy Address This field allows you to specify the address of a web proxy to access the web site. Certificate Subject This field allows you to specify the X.509 certificate subject (DN). Use spaces ( ) or commas (,) to separate the different subject fields. Semicolons, commas with spaces after them, and newline or carriage returns are not acceptable separators. Ignore CA Errors This checkbox allows you to specify the component monitor to ignore the certificate authority (CA). Ignore CN Errors This checkbox allows you to specify the component monitor to ignore the certificate name (CN).
User Agent This field allows you to emulate a specific user agent or browser type when contacting the web site. For example, to emulate Internet Explorer version 7, type Mozilla/4.0 (compatible; MSIE 7.0b; Windows NT 6.0). For more information about user agent strings, see http://www.useragentstring.com Search String This field contains the text string indicating successful page retrieval. If the specified string is found in the web page content, the monitor is considered up. Note: The search string is not case-sensitive. Fail if Found This checkbox allows you to reverse the default behavior of the search string. If the search string is found in the web page content, the monitor is considered down instead of up. Head Request This checkbox allows you to ensure the web site responds to the HTTPS protocol, but without checking the validity of the web page content. Search strings are ignored if you select this option. Accept Compression If checked, indicates that compression is supported. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
IMAP4 Monitor
This component monitor tests the ability of an IMAP4 server to accept incoming connections and respond with the correct code. Statistic This component monitor does not compute a statistic. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Port Number This field is the port number used for IMAP4 sessions. The default value is 143. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Send Email From This field allows you to specify the From address of the test email message. Send Email To This field allows you to specify the recipient of the test email message. The recipient should have a mailbox on the IMAP4 server you are monitoring. IMAP4 Port This field is the port number used for IMAP 4 sessions. The default value is 143. For Secure IMAP (IMAP4-SSL), use port 585. For IMAP4 over SSL (IMAPS), use port 993. IMAP4 Encryption This list allows you to select an encryption protocol to connect to IMAP4 servers that support SSL or TLS encryption. SMTP Server This field allows you to specify the SMTP server that sends the test email message. SMTP Port This field is the port number used for SMTP sessions. The default value is 25. Use Credentials for SMTP This checkbox allows you to use the user name and password from Credentials for Monitoring to connect to SMTP servers that support or require authentication. SMTP Encryption This list allows you to select an encryption protocol to connect to SMTP servers that support SSL or TLS encryption. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data.
Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
JMX Monitor
This template tests the overall performance of a Java Application Server Prerequisites: The JMX connector must be enabled on the Java application server. Credentials: You may need either JMX credentials or none at all. This depends on the credentials required based on the configuration of your Java application server. For more information, see Configuring Java Applications Servers for JMX" on page 687. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Component Type This describes the type of monitor you are using. Enable Component This option determines whether or not the component is enabled. Disabling this component leaves it in the application as deactivated and does not influence application availability or status. Credential for Monitoring This allows you to set JMX credentials for querying MBeans. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Port Number This field allows you to specify the port number used for JMX connections. Protocol This field allows you to choose between using Remote Method Invocation (RMI) and Invocation over Internet Inter-Orb Protocol (IIOP). Note: RMI should be correctly referred to as RMI/JRMP and IIOP as RMI/IIOP based on JMX Specifications.
URL Path This field is for the last part of the JMX service URL. This follows hostname:portnumber and begins with a slash. For example:
service:jmx:rmi:///jndi/rmi://HostName:portnumber/jmxrmi
Object Name This field is for the unique string identifier of an MBean in the form of
<domain-name>:<key property>.
Attribute Name This field is for the name of an MBean attribute. Key This is used for monitoring composite attributes, which consist of key:value pairs. Note: SAM only supports monitoring of numerical data type attributes. Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
598 Component Monitor Types
LDAP Search Root Specifies the LDAP root or suffix to use for the search. LDAP Filter Specifies the search parameters of the LDAP query. The default LDAP Filter value is (&(objectClass=Person)(cn=someuser)), and it searches for all
entries that have objectClass=Person and cn=someuser.
Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Command Line This field allows you to specify the shell command run after the SSH connection is established. The default command line value perl ${SCRIPT} arg1 arg2 attempts to run in a Perl interpreter the script defined in the Script Body field using the parameters arg1 arg2. Note: The length of the Command Line field is limited to 266 characters for Solaris systems, minus the length of the ${SCRIPT} variable after being resolved to a file name such as the following: APM_937467589.pl. Since the length of the file name will typically be around 16 characters, this means that the actual user Command Line input cannot be longer than 266 16, or about 250 characters (not including the length of the 9 characters for the ${SCRIPT} variable itself). If you need to pass a longer command line to the target node, you can create a shell script on the target node (for example myscript.sh) that contains the long command line, and place the call to this script in the Command Line field, for example:
/opt/sw/myscript.sh
Script Body This field allows you to specify the script you want to run on the Linux or Unix server. For more information, see Creating a Linux/Unix Script Monitor on page 261. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
a. Sends an email to the user mailbox via SMTP. The email has a unique temporary subject name that starts with APM_prefix. b. Connects to the user mailbox through MAPI, then searches the emails by Subject. c. If it does not find the email it is looking for, it waits and then searches again. It will stop when: it finds the email, the timeout is reached, or the maximum number of attempts is reached.
d. Once it finds the email, the monitor deletes it from the user inbox. e. The monitor collects the total round trip time for the email and compares it with the thresholds set. f. Once it knows the round trip time, status is given according to where it falls with regard to the thresholds set.
If the email is not found within the timeout or the maximum number of attempts, or SMTP or MAPI reported an error, SolarWinds SAM will mark the monitor as down. 3. Emails the monitor sends are deleted from user inboxes, but only if the monitor successfully connected via MAPI. If the SMTP call succeeded, but MAPI failed, the email remains in the user inbox. 4. It is not currently possible to use the monitor without SMTP and send the email from the same server the monitor is running on via MAPI. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring Select a credential that is both a user who can log on to the SolarWinds SAM server, and that has an Exchange account on the MAPI server. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential.
Send Email From This field allows you to specify the From address of the test email message. Send Email To This field allows you to specify the recipient of the test email message. The recipient should have a mailbox on the MAPI server you are monitoring. MAPI Profile Name Allows you to specify the name of the MAPI profile SMTP Server This field allows you to specify the SMTP server that sends the test email message. SMTP Port This field is the port number used for SMTP sessions. The default value is 25. Use Credentials for SMTP This checkbox allows you to use the user name and password from Credentials for Monitoring to connect to SMTP servers that support or require authentication. SMTP Encryption This list allows you to select an encryption protocol to connect to SMTP servers that support SSL or TLS encryption. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Component Monitor Types 605
If the Use Aggressive Host Checking option is enabled, return codes of 1 will result in a host state of DOWN, otherwise return codes of 1 will result in a host state of UP. Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Command Line This field is in the script editing window and allows you to specify the script you want to run on the target node followed by the arguments. To enter your script, click the Edit button that reveals the script editing window. For more information, see http://nagios.sourceforge.net/docs/3_0/pluginapi.html. Body This field is in the script editing window and allows you to enter your script via typing or pasting. Status Roll-Up This option allows you to choose how you would like the monitor to report based on the output provided by the script. The default selection is Show worst status. For more information, see "Managing the Display of Group Status" on page 180. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts". For more information, see Creating a Nagios Script Monitor" on page 273.
NNTP Monitor
This component monitor tests the ability of an NNTP server to accept incoming connections and respond with the correct code. Statistic This component monitor does not compute a statistic. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts". Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Port Number This field is the port number used for NNTP connections. The default value is 119. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts".
Connection String This field allows you to specify the ODBC connection string for the database. If you do not know the connection string to your ODBC-accessible database, you can look it up on http://www.connectionstrings.com. The connection string may include the variables ${IP}, ${USER}, and ${PASSWORD}, which are replaced respectively by the IP address of the database server, the credential user name, and the credential password. If you are using the ODBC User Experience Monitor instead of the SQL Server User Experience monitor for a SQL Server database that is not using the default port 1433, perform the following to create a connection string. To create the SQL Server connection string: 1. Using notepad, create an empty .udl file. 2. Double-click the .udl file to open the Data Link Properties dialog. Click Next to navigate from tab to tab and configure and test your ODBC connection. Note: Remember to select the desired database provider on the Provider tab, in this case the provider for SQL Server. 3. If the option is present for the provider, check the allow saving password option, as this will ensure that the connection string contains the password when you next retrieve it. 4. When you are finished, and have tested that the connection works, click Ok. 5. Open the .udl file again in Notepad, and retrieve the connection string. For additional information about creating and configuring Universal Data Link (.udl) Files, refer to the MSDN article. Sql Query This field allows you to specify the SQL query used to test the database. The retrieved data is then used as the component monitor statistic. You may enter up to 4,000 characters. Query Timeout The amount of time, in seconds, until the SQL query will timeout. Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles.
Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring Select a database credential that can access the database. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Port Number This field allows you to specify the port number used to communicate with the Oracle database. The default value for this field is 1521. Sql Query This field allows you to specify the SQL query used to test the database. The retrieved data is then used as the component monitor statistic. You may enter up to 4000 characters. Destination Point Type This option tells SolarWinds SAM whether you are accessing the database by its Oracle System ID (SID) or by its service name. SID Select this to access the database by its System ID. Service_Name Select this to access the database by its service name. Though we call this option 'net service name', do not enter the net service name. Destination Point Name This field allows you to specify either the service name or the SID to access the Oracle database over a network. Do not enter the net service name. To determine the name or SID of the database, refer to the tnsnames.ora Oracle configuration file or ask your database administrator.
Component Monitor Types 613
Example of a service name as a destination point name Destination Point Name: sales.us.example.com Destination Point Type: SERVICE_NAME
tnsnames.ora: ORA11 = (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = 127.0.0.1)(PORT = 1521)) ) (CONNECT_DATA = (SERVICE_NAME = sales.us.example.com) ) )
Example of a SID as a destination point name Destination Point Name: ORA11DATABASE Destination Point Type: SID
tnsnames.ora: ORA11 = (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = 127.0.0.1)(PORT = 1521)) ) (CONNECT_DATA = (SID = ORA11DATABASE) ) )
Oracle Driver Type Allows you to select the driver from the dropdown list. Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value."
Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts" Scenario: SAM requires two additional components in order to monitor Oracle databases: Oracle's Instant Client SolarWinds Oracle Plug-in.
The steps below should result in a successfully tested and monitored database. 1. The first item to install is the Oracle Instant Client Basic. (In this scenario, we will also install the Instant Client ODBC and SQLPlus packages). http://www.oracle.com/technetwork/database/features/instantclient/index-097480.html Download the version specific to your architecture: Instant Client Package - Basic (the core Instant Client).
Component Monitor Types 615
Instant Client Package - ODBC (ODBC functionality, requires additional configuration). Instant Client Package - SQLPlus (SQLPlus functionality).
2. Create the directory where the products will be stored. (i.e.: c:\Oracle) 3. Unzip the files into the created directory and preserve the path. ( i.e.:
Instantclient_11_2).
4. Modify your path to reference the directory that the Instant Client files were extracted to:
5. 6.
Log out to ensure Windows identifies the variables you defined. Create a TNSNAMES.ora file and save it in to
c:\oracle\instantclient_11_2. (Note: An example of TNSNAMES.ora
can be found at: http://www.orafaq.com/wiki/Tnsnames.ora) 7. Install the SolarWinds Oracle Plug-in: Log in to the SolarWinds Customer Portal Click on Additional Components Click on Download Server & Application Monitor Components Click on the Oracle Client Run and install the OracleClientInstaller.exe file
Log in to SolarWinds and browse to the SAM Monitor: Each application item was set up using a SERVICE_NAME point type, with the database name as the Destination Port Name. The User ID to be used for this test cannot be limited or restricted, otherwise it will return errors. Test each component monitor.
Component Type Identifies the component type as a Performance Counter Monitor. Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring Select a Windows credential that has RPC access to the target node. This is typically a Windows administrator-level credential. Count statistic as difference This option changes the statistic to be the difference in counter values between polling cycles. Counter Enter the name of the performance counter. For example: % Processor Time. Instance Enter the instance name of the performance counter. For example: _Total. If the performance counter has multiple instances, you can monitor each instance separately by creating a Performance Counter Monitor for each instance. For example, the performance counter % Processor Time has two instances if you have a dual-CPU system: 0 for the first CPU and 1 for the second CPU. You can create a separate Performance Counter Monitor to monitor each instance of the counter. Category Enter the category of the performance counter. All performance counters are assumed to exist within the root/CIMV2 namespace. For example: Processor. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value."
Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
POP3 Monitor
This component monitor tests the ability of a POP3 server to accept incoming connections and respond with the correct code. This component monitor uses the following ports when used with a Microsoft Exchange mail server: 102 X.400 MTA 110 POP3 119 NNTP 143 IMAP4 389 LDAP 563 POP3 over SSL. 636 LDAP over SSL. 993 IMAP4 over SSL. 995 POP3 over SSL. Statistic This component monitor does not compute a statistic. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Port Number This field is the port number used for POP3 connections. The default value is 110. For Secure POP3 (SSL-POP) use port 995.
Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
SMTP Server This field allows you to specify the SMTP server that sends the test email message. SMTP Port This field is the port number used for SMTP sessions. The default value is 25. Use Credentials for SMTP This checkbox allows you to use the user name and password from Credentials for Monitoring to connect to SMTP servers that support or require authentication. SMTP Encryption This list allows you to select an encryption protocol to connect to SMTP servers that support SSL or TLS encryption. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Physical Memory Threshold These fields allow you to set warning and critical threshold conditions based on the amount of physical memory in use by the monitored process. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Command Line Filter This optional field allows you to select which instances of a process you want to monitor, based on the command line arguments of the process. This is a text match and partial matches are also valid. Example to monitor only instances launched with myOption=NorthAmerica Command Line Filter: myOption=NorthAmerica Example to monitor any instances launched with America in any argument Command Line Filter: America Process Name This field allows you to specify the process name you want to monitor. If you do not know the process name, SolarWinds SAM can help you find processes to monitor using the Browse for Component Monitor wizard. For more information, see "Creating New Templates Using the Browsing Method. CPU Threshold These fields allow you to set warning and critical threshold conditions based on the percentage of CPU resources in use by the monitored process. Physical Memory Threshold These fields allow you to set warning and critical threshold conditions based on the amount of physical memory in use by the monitored process. Virtual Memory Threshold These fields allow you to set warning and critical threshold conditions based on the amount of virtual memory in use by the monitored process. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Response Time Threshold These fields allow you to set warning and critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
SMTP Monitor
This component monitor tests the ability of an SMTP server to accept incoming connections and respond with the correct code. Statistic This component monitor does not compute a statistic. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Port Number This field is the port number used for SMTP connections. The default value is 25. For Secure SMTP (SSMTP), use port 465. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
SNMP Monitor
This component monitor uses the SNMP protocol to retrieve an entry in a Management Information Base (MIB) by its Object Identifier (OID), and returns the value of the entry as a statistic. Statistic Value of the entry retrieved from the MIB. Field Descriptions Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts" Component Type Describes how the component monitor works. Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Method Type Get - A manager-to-agent request to retrieve the value of a variable or list of variables. Desired variables are specified in variable bindings (values are not used). Retrieval of the specified variable values is to be done as an atomic operation by the agent. A Response with current values is returned. Get Next - A manager-to-agent request to discover available variables and their values. Returns a Response with variable binding for the lexicographically next variable in the MIB. The entire MIB of an agent can be walked by iterative application of GetNextRequest starting at OID 0. Rows of a table can be read by specifying column OIDs in the variable bindings of the request. Object Identifier (OID) Specify the OID of the entry in the MIB you want to retrieve.
Custom SNMP port (set to 0 to use default SNMP port) This field is the port number of the custom SNMP port. Set this field to 0 to use the default SNMP port defined in the Nodes properties. Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
SQL Server Instance This field allows you to specify the SQL Server instance required to access the SQL Server database. Enter only the instance name. Do not prefix the instance name with the server name. To access the default instance, leave this field blank. Initial Catalog This field allows you to specify the initial database (catalog) for the connection. Use Windows Authentication first, then SQL authentication Select this checkbox to access a SQL Server that supports or requires Windows Authentication, and specifies that the credential is a Windows credential instead of a SQL Server credential. Query Timeout Allows you to specify when this query should timeout in seconds. The default timeout period is 30 seconds. Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data.
Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring Select a credential that can access the password-protected portion of the web site. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Port Number This field allows you to specify the port number used by the web site. The default value for this field is 8080. Url Allows you to specify the URL you want to monitor. The SolarWinds SAM variables ${IP} and ${PORT} contained in the default value for this field attempts to monitor a web site at the IP address of the assigned node. Tomcat Variables Name Specifies the Tomcat server variable to monitor. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data.
Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Component Type Identifies the component type as a VMware Performance Counter Monitor. Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring Select a VMware credential that can access the VMware API. This is typically a vCenter/ESX Server administrator-level credential. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Note: Read-Only credentials are sufficient since VMware objects are accessed solely in read-only mode. Port Number Port number to use for VMware API. The default is 443. Url URL to use for connecting to the VMware API. Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Entity Type Select one of the following: Cluster Compute Resource (only applicable if you are monitoring VirtualCenter Server) Data object that aggregates the computation resources of its associated Host System objects into one single computation resource for use by virtual machines. The cluster services such as HA (High Availability), DRS (Distributed Resource Scheduling), and EVC (Enhanced vMotion Compatibility), enhance the usefulness of this single computation resource. This Entity Type is specific to vCenter systems. Host System Managed object type that provides access to a virtualization host platform. Resource Pool Represents a set of physical resources which may be a single host, a subset of a host's resources, or resources spanning multiple hosts. You can subdivide Resource pools by creating child resource pools. In order to run, a virtual machine must be associated as
a child of a resource pool. In a parent/child hierarchy of resource pools and virtual machines, the root resource pool is the single resource pool that has no parent pool. Virtual Machine Managed object type for manipulating virtual machines, including templates that can be repeatedly deployed as new virtual machines. This object type provides methods for configuring and controlling a virtual machine.
Entity Name Specifies the VMware entity name to monitor, for example VirtualMachine1. For VMs, you can view these values using the VMware console. This field may contain the special ${VMWARE_ENTITY_NAME} variable. When the monitor runs, this variable will be resolved to the first available entity on a target host with the desired Entity Type (for example, the first Host System). For more information, refer to the Multiple systems case in step 11 of the section Monitoring VMware Performance Counters on page 69. Group Specifies the VMware group to which the counter belongs, for example: CPU, memory, and so forth. Counter Specifies the VMware counter to fetch, for example: coreUtilization, and so forth. Note: Click Browse for Component Monitor on the SAM Settings page to browse the counters available for monitoring, including their groups, rollup types, and instance names. Then select one of the following component monitor types, depending on what you want to monitor: VMware ESX Performance Counter Monitor monitors performance counters for ESX servers VMware vCenter Performance Counter Monitor monitors performance counters for vCenter servers Rollup Type Specifies the way to roll up the VMware counter data, for example: average, latest, summation, and so forth. Instance Specifies the instance to be fetched, for example: 0, 1, 2, and so forth.
Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Exclusion Filter Allows you to create an exclusion filter if there are links the component monitor should not attempt to validate. It is a text matching filter. Example that excludes any links to .png graphics files Exclusion Filter: png Ignore External Links This option excludes external links from validation. External links are links that do not link back to the same second-level domain as the original URL. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Custom Log to Monitor Enter the log names as they appear in the Windows event log viewer. Separate multiple log names with commas. Example: Internet Explorer, SolarWinds.net Match Definition Select Any error in log generates a match if that is sufficient for your needs, or select Custom to further restrict the match criteria. Log Source Enter a log source to further restrict the match criteria or leave the field blank to match all possible log sources. Event ID Select the desired option to further restrict the match criteria for event IDs or leave the field blank to find all possible event IDs: Find all IDs match all event IDs Match only specific IDs match all event IDs listed (separate multiple IDs with commas) Note: When you use multiple event IDs separated by commas, the logic used to combine these event IDs is OR, so all events that contain one of the event IDs listed are matched. Exclude specific IDs exclude all event IDs listed (separate multiple IDs with commas) Event Type Select Any Event to match any event type in the log, or select a specific event type to further restrict the match criteria. User who generated Events Enter a user name to further restrict the match criteria. Leave this field blank to match any users. Enter "N/A" to select only events with no specific user. Include events Select With Keywords Below to specify keywords or phrases as the match criteria. Select Matching Regular Expression Below to specify regular expressions that match text that appears in the events. For information about the regular expressions syntax, see .NET Framework Regular Expressions, http://msdn.microsoft.com/enus/library/hs600312%28VS.80%29.aspx.
Component Monitor Types 655
Exclude events Select With Keywords Below to specify keywords or phrases as the match criteria. Select Matching Regular Expression Below to specify regular expressions that match text that appears in the events. For information about the regular expressions syntax, see .NET Framework Regular Expressions, http://msdn.microsoft.com/enus/library/hs600312%28VS.80%29.aspx. Number of past polling intervals to search for events: Enter the number of polling intervals worth of time you want to search the event logs. For example, to always search the past 20 minutes of event logs, you could set the application polling interval to five minutes and then set the Number of Past Polling Intervals to four (4 x 5mins = 20mins). Fractional values are valid. Collect Detailed Data of Matched Events Message and other details of matched events will be available for viewing and alerting when enabled. If a match is found in a polling period, component is: Select whether a found match should set the component status to Up or to Down. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
The PowerShell monitor handles requests from PowerShell for the credentials to run the script and resolves them using the selected Credential for Monitoring. However some PowerShell commands used in scripts require the use of the ${CREDENTIAL} variable. See the note in the Script Body section below regarding the use of the ${CREDENTIAL} variable. Execution Mode This field allows you to specify where to run the PowerShell script: Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Run the script under specified account Select this option to enable impersonation with the component's credentials. (This works only in local script execution mode.) Local Host can run scripts only locally, that is, on the SolarWinds SAM server. This is the default value. Remote Host can execute scripts remotely (on the selected target node) using the Windows Remote Management (WRM) system component. WRM should be configured separately to get it working with the Windows PowerShell monitor. If Remote Host is selected, the following options are available: Use HTTPS Protocol if checked, specifies that the secure HTTPS protocol should be used to send and receive WS-Management protocol requests and responses. Otherwise the HTTP protocol is used. URL Prefix specifies a URL prefix on which to accept HTTP or HTTPS requests. The default is wsman. Port Number specifies the TCP port for which this listener is created. For WinRM 1.1 and earlier, the default HTTP port is 80. For WinRM 2.0, the default HTTP port is 5985. Script Body This field allows you to specify the PowerShell script you want to run. For more information, see Creating a Windows PowerShell Monitor" on page 276. Note: You can use the ${CREDENTIAL} variable in the script where the credentials are required, as shown in the following example:
Administrator Guide SolarWinds Server & Application Monitor $avg = Get-WmiObject win32_process -ComputerName '${IP}' Credential '${CREDENTIAL}' | Where-Object {$_.Name -eq "lsass.exe" } | Measure-Object -property ReadOperationCount -Average;
Some PowerShell commands (such as Get-WmiObject as shown in the example above) require the use of this ${CREDENTIAL} variable. Therefore, the user name from the specified Credential for Monitoring is stored automatically in the ${CREDENTIAL} variable for you by the monitor. As a result, the ${CREDENTIAL} variable should not be placed in the Script Arguments field, since it is set automatically. When the script is run by PowerShell, since no password has been provided, it prompts for a password and the password from the specified Credential for Monitoring is provided automatically by the monitor. Script Arguments This field allows you to specify arguments to pass to the script. You may include the variable ${IP}, which is replaced by the IP address of the target node. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}.
Script Engine This field allows you to specify the scripting language to be used. The default value is vbscript. Below is a list of scripting engines that the Windows Script Host supports: Name VBScript JScript PerlScript ooRexxScript PythonScript TclScript ActivePHPScript RubyScript Object Rexx engine Delphi scripting engine Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Script This field allows you to enter the script you want to run on the target node. To enter your script, click the Edit button that reveals the script editing window. Script Arguments This field is in the script editing window and allows you to specify arguments to pass to the script. You may include the variables ${IP}, ${USER}, and ${PASSWORD}, which are replaced respectively by the IP address of the target node, the credential user name, and the credential password. Body This field is in the script editing window and allows you to enter your script via typing or pasting. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts" File Extensions .vbs .js .pls .rxs .pys .tcls .phps .rbs Availability Installed by default Installed by default Freeware Freeware Freeware Freeware Freeware Freeware Commercial Commercial
Net Service Name This field is the Service name of the service to monitor. You can find the Service name on Windows systems by clicking Start > Administrative Tools > Services and then locating the desired service. Right-click the service and select Properties from the context menu. The Service name is the value of the Service name field in the Properties dialog. CPU Threshold These fields allow you to set warning and critical threshold conditions based on the percentage of CPU resources in use by the monitored process. Physical Memory Threshold These fields allow you to set warning and critical threshold conditions based on the amount of physical memory in use by the monitored process. Virtual Memory Threshold These fields allow you to set warning and critical threshold conditions based on the amount of virtual memory in use by the monitored process. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
WMI Monitor
Formerly known as the WMI Performance Counter Monitor, this component monitor uses WMI communication to obtain the result of a WMI Query Language (WQL) query. The typical result retrieves the performance data calculated by WMI providers such as the Windows operating system or Microsoft Exchange Server. All WQL queries are run within the root/CIMV2 namespace. Note: Named instances of SQL Server may have custom class names that do not match the built-in templates. You must manually change the class name in any WMI Monitor monitoring a named SQL Server instance. For example, if the named instance is "NAMED, you must change Win32_PerfFormattedData_MSSQLSERVER_SQLServerBufferManager to Win32_PerfFormattedData_MSSQLNAMED_SQLNAMEDServerBufferManager. Statistic The statistic for this component monitor is the value of the first row and column of the data retrieved by the query. Optionally, the statistic may be set as the difference in query values between polling cycles by checking the option for Count statistic as difference. Note: the Count statistic as difference option is applicable only for monitors whose counter value increases consistently during each polling interval. Examples of when this option is not applicable include cases such as the following: Counter values sometimes increase and sometimes decrease from one polling interval to another (typical behavior for many counters) Counter values consistently decrease from one polling interval to another In these cases where the option is not applicable, negative statistic data values will be replaced with zero (0), and the counter monitor will show 0 as the statistic data value in resources and 0 as the value on statistic data charts for this interval. Field Description Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. For more information, see Configuring SolarWinds SAM Alerts"
Component Monitor Types 665
Enable Component Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status. Credential for Monitoring Select a Windows credential that has WMI rights on the target node. This is typically a Windows administrator-level credential. WMI Namespace Specifies the name of the namespace within which all WQL queries are run. The default value is root\CIMV2. WQL Query Type the WQL query you want to run on the target node. This is typically a performance counter Query, but it can be any WQL query. All WQL queries are run within the root/CIMV2 namespace. Count Statistic as Difference Changes the statistic to be the difference in query values between polling cycles. Convert Value Checking the Convert Value checkbox opens the formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the dropdown lists to manipulate the returned value, or you can select the Custom Conversion option. For more information, see Conversion Value." Statistic Warning Threshold This field allows you to specify when a threshold that indicates a warning level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 15.
Statistic Critical Threshold This field allows you to specify when a threshold that indicates a critical level has been breached. Logical operators are in the dropdown followed by a blank field for you to enter the value of this threshold. For example: Less
than 5.
User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}. For more information, see Configuring SolarWinds SAM Alerts"
Appendix H
Filter Syntax
There are two slightly different filter syntax types: Structured Query Language (SQL) syntax and SolarWinds Query Language (SWQL) syntax. The two main differences between SQL and SWQL are: The SWQL wildcard character is %. The SQL wildcard character is *. If the resource you are trying to filter creates its list by joining two tables together that contain properties that share the same name, you cannot filter on that property unless you attach a particular SQL table name to the beginning of the property name. The same is true also for SWQL queries, except you must look up the SWQL name and use that as a prefix insteadof a SQL table name.
SQL or SWQL? It is not always obvious whether a resource requires SQL syntax or SWQL syntax filters. Generally, the resources that have most recently been added to SolarWinds Orion use SWQL syntax, while the oldest ones require SQL syntax. Look for additional guidance at the bottom of the Edit Resource page in the form of words such as "SWQL query" or "SQL query".
Filtering by Built-in Properties Use the SWQL table name for selecting properties for your queries. Examples Example filter to show data from Cisco devices:
Node.Vendor = 'Cisco'
Example filter to show data from Process Monitor SNMP type component monitors:
Monitor.ComponentType = 8
Filtering by Status To filter by the status property, you must know the valid status levels.
Level 0 1 2 Status Unknown Up Down
Example filter to show data only from component monitors named Server Load Monitor:
Monitor.Name like 'Server Load Monitor'
Filtering by Status To filter by the status, you must know the valid status levels.
Level 0 1 2 3 14 Status Unknown Up Down Warning Critical
EOC Filters
All Enterprise Operations Console (EOC) resources use SWQL filtering. Alert Resource Filters
Resource Global Last XX Active Alerts SQL Table Name EOC.Alert2 EOC.Orion SWQL Name Alert Orion
Global Top XX Process Monitors by Virtual Memory Total Application by Type for Each Local Orion
Events Filters
Resource Global Events Summary SQL Table Name EOC.Event EOC.EventType EOC.Orion EOC.Event EOC.EventType EOC.Node EOC.Orion SWQL Name Event EventType Orion Event EventType Node Orion
Inventory Filters
Resource Number of Interfaces by Type Number of Nodes by Device Type Number of Nodes by IOS/OS SQL Table Name EOC.Interface EOC.Node EOC.Orion EOC.Node EOC.Orion EOC.Node EOC.Orion SWQL Name I Node Orion Node Orion Node Orion
EOC Filters
Resource Global Top XX Errors & Discards This Hour Global Top XX Error & Discards Today Global Top XX Interfaces by percent utilization Global Top XX Interfaces by Relative Multicast Packet Rate Global Top XX Interfaces by Traffic Global Top XX Nodes by Average Response Time Global Top XX Nodes by CPU Load SQL Table Name EOC.Interface EOC.Node EOC.Orion EOC.Interface EOC.Node EOC.Orion EOC.Interface EOC.Node EOC.Orion EOC.Interface EOC.Node EOC.Orion EOC.Interface EOC.Node EOC.Orion EOC.Node EOC.Orion EOC.Node EOC.Orion SWQL Name I N Orion I N Orion I Node Orion I N Orion I Node Orion Node Orion Node Orion
IP SLA Filters
Resource SQL Table Name EOC.AlertStatus EOC.AlertDefinition EOC.IpSla.Operation EOC.IpSla.OperationType EOC.Orion EOC.AlertStatus EOC.AlertDefinition EOC.IpSla.Operation EOC.IpSla.OperationStatus EOC.IpSla.OperationType EOC.IpSla.Site EOC.IpSla.Site EOC.Node EOC.Orion EOC.Node EOC.Node EOC.Orion EOC.Voip.Link EOC.Voip.Site EOC.Voip.Site EOC.Voip.UdpResultDetail EOC.Node EOC.Node EOC.Orion EOC.Voip.Link EOC.Voip.Site EOC.Voip.Site EOC.Voip.UdpResultDetail EOC.Node EOC.Node EOC.Orion EOC.Voip.Link SWQL Name AlertStatus AlertDefinition IpSlaOperation IpSlaOperationType Orion AlertStatus AlertDefinition IpSlaOperation ipSlaOperationStatus IpSlaOperationType SourceSite TargetSite Node Orion N1 N2 O L S1 S2 D N1 N2 O L S1 S2 D N1 N2 O L
NCM Filters
Resource Global Configuration Manager Nodes SQL Table Name EOC.NCM.ConfigArchive EOC.NCM.Nodes EOC.Node EOC.Orion EOC.NCM.ConfigArchive EOC.NCM.Nodes EOC.Node EOC.Orion EOC.NCM.CacheDiffResults EOC.NCM.ComparisonCache EOC.NCM.Nodes EOC.Node EOC.Orion SWQL Name ConfigArchive NCMNode Node Orion ConfigArchive NCMNode Node Orion CacheDiffResults ComparisonCache NCMNode Node Orion
NTA Filters
Resource Global Last XX Traffic Analysis Events SQL Table Name EOC.Event EOC.EventType EOC.Node EOC.Orion EOC.Interface EOC.NetFlow.Source EOC.Node EOC.Orion EOC.NetFlow.Engine EOC.Orion SWQL Name EventType Event Node Orion I S N O S O
Wireless Filters
Resource Global Wireless Clients SQL Table Name EOC.Node EOC.Orion EOC.Wireless.Interface EOC.Node EOC.Orion EOC.Wireless.Interface EOC.Node EOC.Orion EOC.Wireless.Client SWQL Name N O WI N O WI N O WC
Top XX Access Points by Number of Clients Top XX Wireless Clients by Traffic Rate
Global Down Nodes Global High Errors & Discards Today Global Node Status by Site Global Nodes with High CPU Load Global Nodes with High Memory Utilization Global Nodes with High
SysLog Filters
Resource SysLog Summary SQL Table Name EOC.Orion EOC.SysLog SWQL Name Orion SysLog
Trap Filters
Resource Global Trap Resource SQL Table Name EOC.Orion EOC.Trap SWQL Name Orion Trap
IVIM Filters
All Integrated Virtual Infrastructure Management (IVIM) resources use SWQL filtering. Virtualization Summary
Resource Top 10 VMware Hosts by Percent Memory Used Top 10 VMware Hosts by Network Utilization Top 10 VMware Hosts by CPU Load Top 10 VMware Hosts by Number of Running VMs SQL Table Name Orion.VIM.Hosts Orion.Nodes Orion.VIM.Hosts Orion.Nodes Orion.VIM.Hosts Orion.Nodes Orion.VIM.Hosts Orion.Nodes SWQL Name h n hosts n h n hosts nodes
Datacenter Details
Resource Top 10 VMware Hosts by Percent Memory Used Top 10 VMware Hosts by Network Utilization Top 10 VMware Hosts by CPU Load Top 10 VMware Hosts by Number of Running VMs SQL Table Name Orion.VIM.Hosts Orion.Nodes Orion.VIM.Hosts Orion.Nodes Orion.VIM.Hosts Orion.Nodes Orion.VIM.Hosts Orion.Nodes SWQL Name hosts nodes hosts nodes hosts nodes hosts nodes
Cluster Details
Resource Top 10 Managed VMware Guests by Current Response Time Top 10 Managed VMware Guests by Percent Memory Used Top 10 Managed VMware Guests by CPU Load Top 10 Managed VMware Guests by Network Usage SQL Table Name Orion.VIM.VirtualMachines Orion.VIM.Hosts Orion.Nodes Orion.NodesStats Orion.VIM.VirtualMachines Orion.VIM.Hosts Orion.Nodes Orion.VIM.VirtualMachines Orion.VIM.Hosts Orion.Nodes Orion.VIM.VirtualMachines Orion.VIM.Hosts Orion.Nodes SWQL Name vms hosts nodes stats vms hosts n vms hosts n VM H n
Appendix I
JMX
JMX is an acronym for Java Management Extensions and allows remote clients to connect to a Java Virtual Machine (JVM). Using JMX, you can manage and monitor running applications in a JVM environment. Using Java, management of applications in a virtual machine is done through the use of Managed Beans, or MBeans. MBeans are the soul of JMX. MBeans are the controllable end-points of an application where remote clients can watch application activity as well as control them. The MBean represents a resource running in the JVM, such as an application. They can be used for collecting statistics like performance, resource usage, problems, and so on. To monitor a Java Virtual Machine through JMX, add the following argument into the java command that publishes the platform MBean server to your local environment for monitoring.
Dcom.sun.management.jmxremote
JConsole
A common tool used to monitor a JVM is JConsole. JConsole is a free graphical monitoring tool used to monitor JVMs, which can be found here: http://sourceforge.net/projects/jconsole/ JConsole is not necessary to use the JMX component monitor within SAM. The information provided here concerning JConsole is an introduction to using Java as a means of monitoring. Detailed information on how to use JConsole can be found by navigating to the following link: http://java.sun.com/developer/technicalArticles/J2SE/jconsole.html Once you have downloaded and installed JConsole, you can run it by navigating to the folder where it was installed. Typically, the JConsole.exe is located at:
C:\Program Files\Java\jdk1.7.0_02\bin\JConsole.exe.
Double-click JConsole.exe to start the program. Following is a screenshot of JConsole running, before being logged in:
To login to JConsole: 1. Select either the Local Process option or the Remote Process option. 2. Highlight your option by clicking on it. 3. Complete the credential fields (Username & Password). 4. Click Connect.
After you are successfully logged in, click on the tab entitled MBeans. Clicking the MBeans tab brings you to this screen:
From here, you can drill down to any MBean you want by expanding the folder tree in the left pane of the window. Select any MBean (file in the tree) to have information about it displayed in the right pane. These MBeans are what SolarWinds SAM uses when polling information from the JVM.
To add a JMX Monitor to a node using the wizard: 1. From the web console, click SAM Settings. 2. Click Browse for Component Monitor. 3. Select JMX Monitor from the dropdown list. 4. Click Browse to find the node you want to monitor. 5. Choose a credential from the Credential Library or create a new one using the Username and Password fields. Note: For step 6, the defaults are sufficient for most environments. If they are not, you can change them to suit your environment. 6. Add the Port number, Protocol type, URL path, and Credentials for the remaining fields.
7. Click Next. The following MBean selection screen appears: Note: Only values that return numerical data can be monitored. String data is not supported at this time. Non-numerical data will be shown without a check box when selecting MBeans to poll from within SAM, as illustrated below:
8. Expand the folders by clicking the arrows (or [+]) to expand the tree-view folder structure. From here you can drill down to select the attributes you want by checking them. 9. Click Next. Now you are able to edit the JMX Component Monitor properties. Following is an illustration of how polled MBeans will look when successfully added and implemented within SAM:
If you choose not to use the wizard, you must manually enter values for each JMX monitor, as shown in the illustration below. Entering the correct information can be complicated and cumbersome. This method is best suited for an administrator who is very familiar with the Java environment.
Windows Command Line 1. Open the file %TOMCAT_HOME%\bin\catalina.bat and add the following lines into the Debug, Run and Start sections where %TOMCAT_HOME% is the path of your Tomcat installation:
set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.jmxremote" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.port=8686" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.ssl=false" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.authenticate=false" :doDebug set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.jmxremote" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.port=8686" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.ssl=false" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.authenticate=false" shift :doRun set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.jmxremote" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.port=8686" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.ssl=false" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.authenticate=false" shift :doStart set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.jmxremote" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.port=8686" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.ssl=false" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.authenticate=false" shift
Linux 1. Open $TOMCAT_HOME/bin/catalina.sh and then add the following lines into the Debug, Run and Start sections, where %TOMCAT_HOME% is the path to your Tomcat installation:
JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote" JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote.port=8686" JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote.ssl=false" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.authenticate=false " if [ "$1" = "debug" ] ; then JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.port=8686" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.ssl=false" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.authenticate=false " if $os400; then elif [ "$1" = "run" ]; then JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.port=8686" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.ssl=false" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.authenticate=false " shift elif [ "$1" = "start" ] ; then JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.port=8686" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.ssl=false" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.authenticate=false " if [ ! -z "$CATALINA_PID" ]; then
2.
Configuring JBoss (tested on versions 5.0.1, 5.1, and 6.0) Windows Service 1. Edit %JBOSS_HOME%\bin\run.bat by adding the following lines, where %JBOSS_HOME% is the path to your JBoss installation:
set "JAVA_OPTS=%JAVA_OPTS% Djavax.management.builder.initial=org.jboss.system.server.jmx.M BeanServerBuilderImpl" set "JAVA_OPTS=%JAVA_OPTS% -Djboss.platform.mbeanserver" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.port=8686" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.ssl=false" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.authenticate=false" rem Setup JBoss specific properties set JAVA_OPTS=-Dprogram.name=%PROGNAME% %JAVA_OPTS% set "JAVA_OPTS=%JAVA_OPTS% Djavax.management.builder.initial=org.jboss.system.server.jmx.M BeanServerBuilderImpl" set "JAVA_OPTS=%JAVA_OPTS% -Djboss.platform.mbeanserver" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.port=8686" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.ssl=false" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.authenticate=false"
3. Go to the Windows Services console. 4. Right-click JBoss Application Server service. 5. Click Properties. 6. Click the Log On tab and then select Log on as this account. 7. Click Browse, find the user Administrator, and then type the Administrator password twice. 8. Click Ok.
9. Start the JBoss service. Windows Command Line 1. Edit %JBOSS_HOME%\bin\run.bat by adding the following lines, where %JBOSS_HOME% is the path to your JBoss installation:
set "JAVA_OPTS=%JAVA_OPTS% Djavax.management.builder.initial=org.jboss.system.server.jmx.M BeanServerBuilderImpl" set "JAVA_OPTS=%JAVA_OPTS% -Djboss.platform.mbeanserver" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.port=8686" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.ssl=false" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.authenticate=false" rem Setup JBoss specific properties set JAVA_OPTS=-Dprogram.name=%PROGNAME% %JAVA_OPTS% set "JAVA_OPTS=%JAVA_OPTS% Djavax.management.builder.initial=org.jboss.system.server.jmx.M BeanServerBuilderImpl" set "JAVA_OPTS=%JAVA_OPTS% -Djboss.platform.mbeanserver" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.port=8686" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.ssl=false" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.jmxremote.authenticate=false"
Linux 1. Edit $JBOSS_HOME/bin/run.sh by adding the following lines, where $JBOSS_HOME$ is the path to your JBoss installation:
JAVA_OPTS="$JAVA_OPTS Djavax.management.builder.initial=org.jboss.system.server.jmx.M BeanServerBuilderImpl" JAVA_OPTS="$JAVA_OPTS -Djboss.platform.mbeanserver " JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote.port=8686" JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote.ssl=false" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.authenticate=false " # Setup JBoss specific properties JAVA_OPTS="${JAVA_OPTS:+$JAVA_OPTS -Dprogram.name=$PROGNAME}" JAVA_OPTS="${JAVA_OPTS:--Dprogram.name=$PROGNAME}" JAVA_OPTS="$JAVA_OPTS Djavax.management.builder.initial=org.jboss.system.server.jmx.M BeanServerBuilderImpl" JAVA_OPTS="$JAVA_OPTS -Djboss.platform.mbeanserver " JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote.port=8686" JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote.ssl=false" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.jmxremote.authenticate=false "
2. Run JBoss by running $JBOSS_HOME/bin/run.sh. For more information, see "JMX" on page 681.
Configuring GlassFish (tested on version 3.1) 1. Run the GlassFish Application Server. 2. Open a web browser and then navigate to: http://hostname:4848, where hostname is the name of your GlassFish server. 3. In the left panel, click Configurations: server-config. 4. In the main window, click JVM settings. 5. Click the JVM Options tab. 6. Click Add JVM Option and then type Djava.rmi.server.hostname=yourhostname.com in the blank field, where yourhostname.com is the hostname of your GlassFish server. 7. Click Add JVM Option and then type Dcom.sun.management.jmxremote.ssl=false in the blank field. 8. Click Add JVM Option and then type Dcom.sun.management.jmxremote.authenticate=false in the blank field. 9. Click Save. 10. Restart the GlassFish server. By default, GlassFish uses JMX on port 8686. To change the JMX port you should find the jmx-connector section in: %GLASSFISH_HOME%\glassfish\domains\<your_domain>\config\dom ain.xml, where %GLASSFISH_HOME% is the path where GlassFish is installed, then change the port value. For more information, see "JMX" on page 681.
Configuring IBM WebSphere (tested on version 7.0) IBM WebSphere uses its own JDK installed at %WEBSHERE_HOME%\java, where %WEBSHERE_HOME% is the path of your WebSphere installation. Configure the IBM JDK in the following manner: 1. Go to the $JAVA_HOME/jre/lib/management folder. 2. Edit management.properties by adding the following: com.sun.management.jmxremote.port=8686 com.sun.management.jmxremote.ssl=false com.sun.management.jmxremote.authenticate=false 3. Run the IBM WebSphere Application Server. 4. Open a web browser and then navigate to: https://hostname:9043, where hostname is the name of the IBM WebSphere server. 5. In the left pane, click Applications and WebSphere Enterprise Applications. 6. Check to see if PerfServletApp.ear is in the list. If it is, skip to step 12. If not, continue to step 7. 7. In the left pane, click Applications and New Application. 8. Click New Enterprise Application. 9. Select Local File System and then click Browse. 10. Find the WebSphere directory here: AppServer > InstallableApps > PerfServerletApp.ear. 11. Click Next multiple times until you installation is complete. 12. In the left pane, click Monitoring and Tuning and Performance Monitoring Infrastructure(PMI). 13. Select your server. In the Configuration tab, enable the PMI and set All Statistics. 14. Set All Statistics in the Run time Tab. 15. Save all changes. 16. In the left panel, click Expand Servers and Server types. 17. Click WebSphere Application Servers.
694 Configuring and Integrating
18. In the main window, click your server. 19. In the Server Infrastructure section, expand Java and Process Management. 20. Click Process Definition. 21. In the Additional Properties section, click Java Virtual Machine. 22. In Generic JVM Arguments, add the following:
-Djavax.management.builder.initial= Dcom.sun.management.jmxremote
23. Save all changes. 24. Go to the Windows Services console. 25. Right click the IBM Websphere service. 26. Click Properties. 27. Click the Log On tab and then select Log on as this account. 28. Click Browse, find the user Administrator, and then type the Administrator password twice. 29. Click Ok. 30. Restart the IBM WebSphere Application Server. For more information, see "JMX" on page 681.
Configuring Oracle WebLogic (tested on version 10.3.4.0) Note: To add support for a WebLogic server, please refer to this KB article: http://knowledgebase.solarwinds.com/kb/questions/2687/Adding+support+for+a+ WebLogic+server+to+poll+MBeans. Windows 1. Edit the following file, where %MIDDLEWARE_HOME% is the path of your WebLogic installation:
%MIDDLEWARE_HOME%\C:\Oracle\Middleware\user_projects\domains\<y our_domain>\bin\setDomainEnv.cmd
Warning: This file is created by the Configuration Wizard. Your changes to this script will be lost the next time you use the configuration wizard. 2. Restart WebLogic Server. Linux 1. Edit the following file, where %MIDDLEWARE_HOME% is the path of your WebLogic installation:
$MIDDLEWARE_HOME/user_projects/domains/<your_domain>/bin/setDom ainEnv.sh
Warning: This file is created by the Configuration Wizard. Your changes to this script will be lost the next time you use the configuration wizard. 2. Restart the WebLogic Server.
Note: If you are having difficulty configuring Weblogic to work with Java and/or SNMP, the JMX Java options may not be set in the proper place for your setup of Weblogic. Some implementations of Weblogic, under Windows, require the Java JMX options to be placed in a registry key, as opposed to the setDomainEnv.cmd file. For information on this method of configuration , refer to the following knowledge base article: http://knowledgebase.solarwinds.com/kb/questions/3264/Cannot+get+Java+Web logic+APM+template+to+work+in+APM+4.2 For more information, see "JMX" on page 681.
10. Grant access to the snmp.acl file only for the Administrator. To grant access only for the Administrator, refer to this topic at the following location: http://download.oracle.com/javase/6/docs/technotes/guides/management/sec urity-windows.html Linux 1. Download the JDK from the Oracle website: http://www.oracle.com/technetwork/java/javase/downloads/index.html (tested on JDK SE 6, update version 24). 2. Unpack and run the JDK. In this case, the JDK was installed into the /usr/java/jdk1.6.0_24 folder. 3. Move this folder to /usr/local. 4. In the /usr/local/ directory, create a symbolic link to jdk1.6.0_24 named Java. Now the JDK is installed in /usr/local/jdk1.6.0_24 and linked to /usr/local/java. 5. Add the /usr/local/java/bin folder to the system path. (If it is only for your account, add it in .bash_profile file in your home directory). In Slackware, it should be in the .profile file. To make it a system wide environment, add it in the /etc/profile. 6. Edit a line in .bash_profile to be similar to:
PATH=$PATH:$HOME/bin:/usr/local/java/bin. The path will be
automatically set at boot time. To set the path immediately, use the command:
$ export PATH=$PATH:/usr/local/java/bin
8. Add a variable to the system with the path pointing to the JDK installation folder. 9. Add the following lines to the /etc/profile file. Syntax dependencies may be different in various Linux distributions. This example is shown for the CentOS system:
export JAVA_HOME=/usr/java/jdk1.6.0_24 export PATH=$PATH:/usr/java/jdk1.6.0_24
To set this immediately, run the export commands in your shell. Or, logout then log back in to your system. 10. Go to the $JAVA_HOME/jre/lib/management folder and rename the snmp.acl.template file to snmp.acl.
Configuring and Integrating 699
11. Edit snmp.acl by removing all lines and writing the following:
acl = { { communities = public, private access = read-only managers = localhost, SAM-server } }
Where SAM-server is the hostname of your SAM server. 12. Grant access to the snmp.acl file only for the root user. Run the following commands as the root user in your shell:
# chown root.root $JAVA_HOME/jre/lib/management/snmp.acl # chmod 600 $JAVA_HOME/jre/lib/management/snmp.acl
Testing a Standalone JVM in Linux You can test that your JVM can respond to SNMP queries by adding
-Dcom.sun.management.snmp.port=1161 Dcom.sun.management.snmp.interface=0.0.0.0 to the java command line.
Example:
java -Dcom.sun.management.snmp.port=1161 Dcom.sun.management.snmp.interface=0.0.0.0 some_java_applet
In another window/shell, run the following command to test SNMP and the JDK configurations:
snmpwalk -v 2c -c public 127.0.0.1:1161 1.3.6.1.4.1.42.2.145.3.163.1.1.2.11
For more information, see "JMX" on page 681. Configuring Apache Tomcat (tested on version 7.0) Windows Service 1. Open Tomcat configuration: Start > All Programs > Apache Tomcat > Configure Tomcat. 2. Open the Java tab, and then add the following lines to the Java Options box: -Dcom.sun.management.snmp.port=1161 -Dcom.sun.management.snmp.interface=0.0.0.0 3. Click Apply. 4. Go to the Windows Services console. 5. Right-click the Apache Tomcat service.
700 Configuring and Integrating
6. Click Properties. 7. Click the Log On tab, and then select Log on as this account. 8. Click Browse, find the user Administrator and type the Administrator password twice. 9. Click Ok. 10. In the Tomcat Configuration window, return to the General tab, and then start the service. Windows Command Line 1. Open the file %TOMCAT_HOME%\bin\catalina.bat and add the following lines into the Debug, Run and Start sections (where %TOMCAT_HOME% is the path to your Tomcat installation):
set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.snmp.port=1161" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.interface=0.0.0.0" :doDebug set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.snmp.port=1161" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.interface=0.0.0.0" shift :doRun set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.snmp.port=1161" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.interface=0.0.0.0" shift :doStart set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.snmp.port=1161" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.interface=0.0.0.0" shift
1. Open $TOMCAT_HOME/bin/catalina.sh and then add the following lines into Debug, Run and Start sections (where %TOMCAT_HOME% is the path to your Tomcat installation):
JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.snmp.port=1161" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.snmp.interface=0.0.0.0" if [ "$1" = "debug" ] ; then JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.snmp.port=1161" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.snmp.interface=0.0.0.0" if $os400; then elif [ "$1" = "run" ]; then JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.snmp.port=1161" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.snmp.interface=0.0.0.0" shift elif [ "$1" = "start" ] ; then JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.snmp.port=1161" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.snmp.interface=0.0.0.0" if [ ! -z "$CATALINA_PID" ]; then
3. Run $TOMCAT_HOME/bin/startup.sh command to start Tomcat. For more information, see "JMX" on page 681. Configuring JBoss (tested on versions 5.0.1, 5.1, and 6.0) Windows Service 1. Edit %JBOSS_HOME%\bin\run.bat by adding the following lines (where %JBOSS_HOME% is the path to your JBoss installation):
set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.snmp.port=1161" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.interface=0.0.0.0" rem Setup JBoss specific properties set JAVA_OPTS=-Dprogram.name=%PROGNAME% %JAVA_OPTS% set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.snmp.port=1161" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.interface=0.0.0.0"
5. Go to the Windows Services console 6. Right-click JBoss Application Server service. 7. Click Properties. 8. Click the Log On tab and then select Log on as this account. 9. Click Browse, find the user Administrator, and then type the Administrator password twice. 10. Click Ok. 11. Start the JBoss service. Windows Command Line 2. Edit %JBOSS_HOME%\bin\run.bat by adding the following lines (where %JBOSS_HOME% is the path to your JBoss installation):
set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.port=1161"set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.interface=0.0.0.0" rem Setup JBoss specific properties set JAVA_OPTS=-Dprogram.name=%PROGNAME% %JAVA_OPTS% set "JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.snmp.port=1161" set "JAVA_OPTS=%JAVA_OPTS% Dcom.sun.management.snmp.interface=0.0.0.0"
2. Start JBoss by running %JBOSS_HOME%\bin\run.bat. Linux 1. Edit $JBOSS_HOME/bin/run.sh by adding the following lines (where $JBOSS_HOME$ is the path to your JBoss installation):
JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.snmp.port=1161" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.snmp.interface=0.0.0.0" # Setup JBoss specific properties JAVA_OPTS="${JAVA_OPTS:+$JAVA_OPTS -Dprogram.name=$PROGNAME}" JAVA_OPTS="${JAVA_OPTS:--Dprogram.name=$PROGNAME}" JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.snmp.port=1161" JAVA_OPTS="$JAVA_OPTS Dcom.sun.management.snmp.interface=0.0.0.0"
2. Run JBoss by running $JBOSS_HOME/bin/run.sh. For more information, see "JMX" on page 681.
Configuring and Integrating 703
Configuring GlassFish (tested on version 3.1) 1. Run the GlassFish Application Server. 2. Open a web browser and then navigate to: http://hostname:4848 where hostname is the name of your GlassFish server. 3. In the left panel, click Configurations: server-config. 4. In the main window, click JVM settings. 5. Click the JVM Options tab. 6. Click Add JVM Option and then type Dcom.sun.management.snmp.port=1161 in the blank field. 7. Click Add JVM Option and then type Dcom.sun.management.snmp.interface=0.0.0.0 in the blank field. 8. Click Save. 9. Restart the GlassFish server. For more information, see "JMX" on page 681. Configuring IBM WebSphere (tested on version 7.0) IBM WebSphere uses its own JDK, installed at %WEBSHERE_HOME%\java (where %WEBSHERE_HOME% is the path to your WebSphere installation).Configure the IBM JDK in the following manner: 1. Go to the $JAVA_HOME/jre/lib/management folder. 2. Rename the snmp.acl.template file to snmp.acl. Edit snmp.acl by replacing its content with the following: acl = { { communities = public, private access = read-only managers = localhost, SAM-server } } 3. WhereSAM-server is the hostname of your SAM server. 4. Grant access to the snmp.acl file only for the root user. Run the following commands as the root user in your shell:
# chown root.root $JAVA_HOME/jre/lib/management/snmp.acl # chmod 600 $JAVA_HOME/jre/lib/management/snmp.acl
6. Open a web browser and then navigate to: https://hostname:9043 where hostname is the name of the IBM WebSphere server. 7. In the left panel, click Expand Servers and Server types. 8. Click WebSphere Application Servers. 9. In the main window, click your server. 10. In the Server Infrastructure section, expand Java and Process Management. 11. Click Process Definition. 12. In the Additional Properties section, click Java Virtual Machine. 13. In Generic JVM Arguments, add the following:
-Dcom.sun.management.snmp.port=1161 Dcom.sun.management.snmp.interface=0.0.0.0
14. Click Ok. 15. Click, Save and then click Ok. 16. Click Save. 17. Go to the Windows Services console. 18. Right click the IBM Websphere service. 19. Click Properties. 20. Click the Log On tab and then select Log on as this account. 21. Click Browse, find the user Administrator, and then type the Administrator password twice. 22. Click Ok. 23. Restart the IBM WebSphere Application Server. For more information, see "JMX" on page 681. Configuring Oracle WebLogic (tested on version 10.3.4.0) Windows Oracle WebLogic uses its own JDK installed in %MIDDLEWARE_HOME%\jdk* (where %MIDDLEWARE_HOME% is the path to your WebLogic installation). 1. Go to the $JAVA_HOME/jre/lib/management folder 2. Rename the snmp.acl.template file to snmp.acl.
4. Grant access to the snmp.acl file only for the Administrator. To grant access only for the Administrator,see: http://download.oracle.com/javase/6/docs/technotes/guides/management/sec urity-windows.html 5. Edit the following file:
%MIDDLEWARE_HOME%\C:\Oracle\Middleware\user_projects\domains\<y our_domain>\bin\startWebLogic.cmd
WARNING: This file is created by the Configuration Wizard. Your changes to this script will be lost the next time you use the configuration wizard. 6. Restart WebLogic Server. Linux Oracle WebLogic uses its own JDK which in $MIDDLEWARE_HOME/jdk* (where $MIDDLEWARE_HOME is the path to your WebLogic installation). 1. Go to the $JAVA_HOME/jre/lib/management folder. 2. Rename the snmp.acl.template file to snmp.acl. 3. Edit snmp.acl by replacing its content with the following:
706 Configuring and Integrating
Administrator Guide SolarWinds Server & Application Monitor acl = { { communities = public, private access = read-only managers = localhost, SAM-server } }
Where SAM-server is the hostname of your SAM server. 4. Grant access to the snmp.acl file only for the root user. Run the following commands as the root user in your shell:
# chown root.root $JAVA_HOME/jre/lib/management/snmp.acl # chmod 600 $JAVA_HOME/jre/lib/management/snmp.acl
WARNING: This file is created by the Configuration Wizard. Your changes to this script will be lost the next time you use the configuration wizard. 6. Restart the WebLogic Server.
MAPI
Messaging Application Programming Interface (MAPI) is a Microsoft Windows program that enables you to send email from within a program. Programs that use MAPI include word processors, spreadsheets, and graphics applications. Programmers who are using Microsoft's Active Server Page (ASP) technology access MAPI by using Microsoft's Collaboration Data Objects (CDO). The CDO library comes with Microsoft's Internet Information Server (IIS). MAPI functions can be accessed by Visual Basic programmers. CDO - http://www.microsoft.com/download/en/details.aspx?id=1004 A "session" is a specific connection between the client and the MAPI program. MAPI defines the following three services: Address book: A database that contains addressing information. Transport: Supports communication between different devices. Message store: Stores messages that consists folders and subfolders.
Simple MAPI is a subset of 12 functions which enable developers to add basic messaging functionality. Extended MAPI allows complete control over the email system. Note: With regard to the SAM monitor, this document will concentrate only on the mail function.
What the MAPI monitor does: 1. This component monitor waits for the email to arrive based on the default job timeout of 20 minutes. If the email does not arrive within this period, SolarWinds SAM marks the monitor as Down. 2. The monitor goes through the following steps with respect to the mail flow: g. Sends an email to the user mailbox via SMTP. The email has a unique temporary subject name that starts with APM_prefix. h. Connects to the user mailbox through MAPI, then searches the emails by Subject. i. If it does not find the email it is looking for, it waits and then searches again. It will stop when: 1. It finds the email; 2. The timeout is reached; 3. The maximum number of attempts is reached. Once it finds the email, the monitor deletes it from the user inbox. The monitor collects the total round trip time for the email and compares it with the thresholds set. Once it knows the round trip time, status is given according to where it falls with regard to the thresholds set.
j. k. l.
If the email is not found within the timeout or the maximum number of attempts, or SMTP or MAPI reported an error, SolarWinds SAM will mark the monitor as down. 3. Emails are posted using SMTP. If the MAPI probe works, emails will be deleted successfully, if not, emails will accumulate. 4. It is not currently possible to use the monitor without SMTP and send the email from the same server the monitor is running on via MAPI. Field Descriptions of the MAPI Monitor: Description This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which will then be automatically saved. The variable to access this field is ${UserDescription}. Enable Component Determines whether the component is enabled.
Credential for Monitoring Select a credential that is both a user who can log on to the SolarWinds SAM server, and that has an Exchange account on the MAPI server. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential. Send Email From This field allows you to specify the From address of the test email message. Send Email To This field allows you to specify the recipient of the test email message. The recipient should have a mailbox on the MAPI server you are monitoring. MAPI Profile Name Allows you to specify the name of the MAPI profile SMTP Server This field allows you to specify the SMTP server that sends the test email message. SMTP Port This field is the port number used for SMTP sessions. The default value is 25. Use Credentials for SMTP This checkbox allows you to use the user name and password from Credentials for Monitoring to connect to SMTP servers that support or require authentication. SMTP Encryption This list allows you to select an encryption protocol to connect to SMTP servers that support SSL or TLS encryption. Response Time Warning Threshold This field allows you to set the warning threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. Response Time Critical Threshold This field allows you to set critical threshold conditions based on the response time. The response time is the time in milliseconds it takes
SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. User Notes This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}.
Troubleshooting MAPI
The following procedures will help you troubleshoot MAPI issues relating to SAM. MAPI Probe Diagnostic Checklist Install CDO or Outlook CDO can be found here: http://www.microsoft.com/download/en/details.aspx?id=1004. If you would like to install CDO, uninstall your entire MS Office installation. Uninstalling Outlook only is not sufficient. The MAPI probe may be unstable when running with Outlook installed. If this is the case, uninstall Office then download and install CDO.
Check the MAPI profile The MAPI profile does not need to exist. The probe should create it and also update the existing profile with the required settings. However, there may be issues with an existing or created profile. The default Outlook profile is called Outlook. If this profile does not work, create a profile with the MFCMapi free tool, availabe at: http://mfcmapi.codeplex.com/. 1. In the MFCMapi tool, navigate to Profile > Advanced Profile > Launch Profile Wizard, keeping the defaults on the first dialog. 2. Set the profile as default. 3. Update the profile name of the newly created profile in the MAPI probe. Use MFCMapi to find the profile name: Navigate to Profile > Show Profiles for verification.
Check probe settings Check that Send Email To: is correctly filled out in the component settings. The Mapi Profile Name must match the actual profile name. Use the MFCMapi tool if you are not sure about the name. Credentials used for the probe must be eligible to open the mailbox. It is required to add the user to the local Administrators group, otherwise the probe can fail with insufficient privileges.
Mailbox recommendations Use a clean mailbox created for monitoring purposes. A mailbox full of email is problematic as it takes a lot more time for the probe to search through all of the emails. The MAPI probe deletes obsolete, undeleted messages sent by the probe in the past to keep the mailbox clean.
Advanced Troubleshooting
SolarWinds.APM.MAPI.exe Command Line Arguments To analyze issues with the MAPI probe more closely, run the MAPI executable from the command line. The following arguments can be used: Command
-s <subject>
Explanation The subject text of searched in an email. Use quotes for a subject containing spaces. Server hostname / IP address.
Timeout in ms for watchdog. Exchange profile name. Exchange user name Maximum number of search attempts. Turns on debug logging. Remove all historical messages from the MAPI probe. Messages from the MAPI probe get stuck in the mailbox if the probe fails to delete them. Wait time between search attempts.
-w
In SAM v5.0+:
-subjectmatchsubstring: This enables a substring subject match. The target
mail subject is expected to match the substring of the subject setting. An exact match is expected by default. This is useful for matching emails returned by bouncers, which can add Re: to the mail subject. Note: This command is not listed in the configuration file.
For example:
SolarWinds.APM.MAPI.exe -debug -s "test subject" -u domain\user.name -server exchange -p Outlook -t 10000
Important: Run the executable as the user owning the mailbox. To do this, start a new cmd.exe and run the following command.
runas /user:domain\user.name cmd.exe
This will ask for a password and start a new cmd.exe with that user account. Test the MAPI executable from this console. The MAPI probe is also configurable via the SolarWinds.APM.MAPI.exe.xml file. Settings in this file take precedence over any command line arguments. See the following:
<settings> <!-- c:\logs will not be made by this program, it must exist to enable logging --> <logdirectory>c:\logs</logdirectory> <logenable>false</logenable> <logkeepall>true</logkeepall> <enablewatchdog>true</enablewatchdog> <mapimaxwaitlogoff>2500</mapimaxwaitlogoff> <dologoff>true</dologoff> <!-<debug>false</debug> <removeall>true</removeall> <subjectpattern>^APM_MAPITestEmail__GUID:[0-9a-fA-F]{8}-[09a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fAF]{12}$</subjectpattern> <delaybetweenattempts>500</delaybetweenattempts> --> </settings>
Command
Logdirectory
Explanation Path to the directory where logs from the MAPI executable will be written. This directory must exist otherwise no logs will be written. Enable log file logging. Set false for deleting the log file after a successful run, (i.e. email was found and deleted; all log files are preserved by default
Configuring and Integrating 717
Logenable Logkeepall
Command
Explanation (true).)
Enablewatchdog
Enable or disable watchdog which kills the MAPI processing thread if it does not finish in a given time. Prevents processing for a long time. Number of milliseconds to wait for logoff before the MAPI process ends. This setting is used after an error during MAPI processing and between attempts to retrieve probe mail. Set to false to skip logoff and closing the MAPI session. True for debugging information and detailed logging to the log file or console. Remove all obsolete messages from the mailbox matching the subjectpattern regular expression. The SAM probe always tries to enable this setting from the command line. Regular expression pattern for deleting obsolete probe messages. Use together with
removeall =true
Mapimaxwaitlogoff
Dologoff
Debug
Removeall
Subjectpattern
Delaybetweenattempts
Delay in milliseconds.
substring of the subject. This is useful for matching emails returned by bouncers, which can add Re: to the mail subject. During initial analysis, it is typically required to update logdirectory (or create C:\logs) and set logenable to true. Other arguments are passed from the command line.
718 Configuring and Integrating
Oracle
This section is designed to give you a basic introduction to the Oracle database model and its use with SolarWinds SAM. For more detailed information on Oracle, seek resources outside of this guide.
Storage
The Oracle RDBMS stores data in the form of tablespaces and physically in the form of ("datafiles"). Tablespaces can contain various types of memory segments, such as Data Segments, Index Segments, etc. Segments are made up of one or more extents. Extents make up groups of continuous data blocks. Data blocks are the basic units of data storage. Newer versions of the database include a partitioning feature, which allows tables to be partitioned based on different sets of keys. Oracle tracks its data storage using the information stored in the System tablespace. The System tablespace contains the data dictionary, indexes and clusters. A data dictionary consists of a collection of tables that has information about all user objects. Beginning with version 8i, the Oracle RDBMS also supports locally managed tablespaces which can store space management information in their own headers rather than in the System tablespace.
Disk files
Disk files primarily consist of the following types:
Data and index files: These files are necessary for the physical storage, which can be made up of the data dictionary, user data, or index data. These files may be managed manually or by Oracle itself, Note: A datafile has to belong to exactly one tablespace, whereas a tablespace can consist of multiple datafiles. Redo log files: These consist of all changes to the database used to recover from an instance failure. Note: These files are stored multiple times for security in case of a catastrophic failure. The identical redo log files are part of the same group. Undo files: These are datafiles which contain undo information and are used for recovery. Archive log files: These files are copies of the redo log files and stored at different locations. These files are necessary. Tempfiles: These datafiles are used for temporary storage data. Control file: This file is necessary for database startup. This file records the physical structure of a database and holds the names and locations of redo log files, the time stamp of the database creation, the current log sequence number, checkpoint information, and so forth.
Credentials: An Oracle user name and password with read access to the Oracle views: dba_free_space, v$sysstat, v$rowcache, v$librarycache, v$sgastat, and v$session. Note: Some required settings information will be needed. See Getting the Required Settings, on page 22.
Installing ODP.Net
The following instructions describe the recommended method for monitoring Oracle databases using ODP. Net. Uninstall any other version of the Oracle Client before proceeding. Ensure that SolarWinds Basic Lite Oracle Client is not installed. Verify that the following directory does not exisit or is empty: C:\Program Files (x86)\Solarwinds\Orion\APM\OracleClient\. If it is not empty, stop all Orion services and remove this directory before you continue with your installation. Note: ODP. Net is not part of SolarWinds SAM and may need to be downloaded from the Oracle website, which requires free registration. Download the 32-bit version of ODP.Net, even if SAM is installed on a 64-bit version of Windows. 1. You can use the following link to download ODP.Net: http://www.oracle.com/technetwork/topics/dotnet/index-085163.html If you do not want to register with Oracle, you can use the Basic Lite Client which can be downloaded by logging in to your SolarWinds customer portal. Location and installation instructions can be found at, "Installing the Basic Lite Oracle Client" on page 727.
Following is a screenshot of Oracle's website with the both the 32 and 64-bit versions highlighted. Download the 32-bit version. Note: You can download the 64-bit version. Installing this version will require you to poll jobs using the 64-bit option within SAM.
2. Next, download ODAC with Oracle Developer Tools for Visual Studio, as shown below. This installation package comes with its own installer:
3. Accept the License Agreement and then select the latest version when prompted. You will be asked for your Oracle username and password. If you have not already done so, register for free with Oracle to obtain these needed credentials.
4. Login to SAM using an administrator account. 5. Copy the downloaded file to the SAM computer then extract the contents and run setup.exe. 6. When setup.exe runs, go to the next step and select the first option as shown below. (This option contains what is necessary for SAM to be able to monitor an Oracle database server.) Note: If the Oracle server is being polled from an additional poller, then this software needs to be installed on that additional poller as well.
8.
Either install everything or select the following two components: Oracle Data Provider for .Net Oracle Instant Client
Restart all Orion services by navigating to: Start > SolarWinds Orion > Orion Service Manager. Note: Restarting of the services is necessary because the Oracle installer added its installation directory (c:\app\Administrator\... by default) to the Path variable. 11. From the Service Manager, click Shutdown Everything. 12. When all services have stopped, click Start Everything and wait for the services to begin.
4. Copy the downloaded file to the SAM computer and extract OracleClientInstaller.exe from the zip archive. 5. Run the installer under an administrator account.
6. After the installer window closes, navigate to the SAM installation directory, typically: C:\Program Files\SolarWinds\Orion, and ensure that the subfolder, APM\OracleClient was created successfully and contains the five files as shown below:
7. Check the file properties of each .dll file to ensure that the account under which the SolarWinds JobEngine v2 service runs has high enough privileges to load these libraries.
8. Restart all Orion services by navigating to Start > SolarWinds Orion > Orion Service Manager. Note: Restarting of the services is necessary because the Oracle installer added its installation directory (c:\app\Administrator\... by default) to the Path variable. 9. From the Service Manager, click Shutdown Everything. 10. When all services are stopped, click Start Everything and wait for the services to begin.
4. At the Add Application Monitors step, select the Oracle Database Template. Do not test it. At this stage the application template requires further configuration which cannot be done from this page. Testing at this point will result in a failure.
5. Go to the last step of the wizard and click OK, ADD NODE.
6. You will be redirected to the Manage Nodes page. Search for the newly added Oracle server and click on it to go to its Node Details view.
7. Search for the Applications resource on this view and click on the Oracle Application to go to its Application Details View.
8. On the Application Details View, notice the Oracle Database is in an Unknown state. This is because it is not properly configured. Click on Edit Application Monitor to begin configuring these settings.
9. Expand each monitor by clicking the [+] icon to the left of each component monitor in the list.
10. The correct settings for the fields, Destination Point Type and Destionation Point Name (highlighted above) should be provided by the administrator of the Oracle server. This example is testing against the Oracle 10g Express Edition, which is configured to have the name "XE."
11. Repeat steps 9-10 for each monitor in this template. The Oracle driver type must correspond with the installed Oracle Client software (as described earlier in the Prerequisites for Oracle Server Monitoring section on page 4). The following table shows which combinations work together. Oracle Client package Oracle Driver Type setting in Web UI Microsoft .NET Data Oracle Data Provider Provider for .NET (MS_ORACLECLIENT) (ODP.NET) Works Works
Full Oracle Data Provider for .NET (ODP.NET) Basic Lite Oracle Client (from SolarWinds Customer Portal)
Works
2. Search for the Oracle Database Template, select it by checking the box next to the name. 3. Click Assign to Node.
4. Next, search for Oracle. 5. Once found, check the nodes you want to add. 6. Click the green arrow to add it to the Selected Nodes column..
8. Click Next. 9. Select the credentials to be used and then click Assign Application Monitors. Note: Do not test the application now. This application is not properly configured. There are settings specific to the Oracle server which will be set later.
11. Expand each monitor by clicking the [+] icon to the left of each component monitor in the list.
12. The correct settings for the fields Destination Point Type and Destination Point Name (highlighted above) should be provided by the administrator of the Oracle server. This example is testing against the Oracle 10g Express Edition, which is configured to have the name "XE."
13. Repeat steps 11-12 for each monitor in this template. Use the following table for reference: Oracle Client package Oracle Driver Type setting in Web UI Microsoft .NET Data Oracle Data Provider Provider for .NET (MS_ORACLECLIENT) (ODP.NET) Works Works
Full Oracle Data Provider for .NET (ODP.Net Basic Lite Oracle Client (from SolarWinds Customer Portal)
Works
3. Once you have located this file, open the file and follow these steps to extract the required information. a. Locate the section in the file that describes the options for the database instance you want to monitor. For the most part, this section will contain the settings for Protocol, Host, and Port as shown in the examples bulleted below. b. Once you locate this section, extract the following settings and use them in the Oracle User Experience Monitor: Protocol Must be TCP. This how SAM connects to the remote Oracle Server. Host Must match the IP address (or hostname, which resolves to that IP) of the Oracle server node in SAM. Port Use this setting for the Port Number field of Oracle User Experience Monitor.
742 Configuring and Integrating
Service_Name If this is present in the tnsnames.ora configuration section, then select the value for the Service_Name for the Destination Point Type field of the Oracle User Experience Monitor. SID If this is present in the tnsnames.ora configuration section, then select the SID value for for the the Destination Point Type field of the Oracle User Experience Monitor. Service_Name or SID settings in tnsnames.ora also defines a connection point name (after the "=" character), which needs to be used for the Destination Point Name field of the Oracle User Experience Monitor. Example 1: Following is a sample tnsnames.ora file from the Oracle Server 10g Express Edition. Highlighted are the settings mentioned previously.
Example 2:
Here is what the configuration of the Oracle User Experience Monitor should look like when completed correctly using Example 1:
Here is what the configuration of the Oracle User Experience Monitor should look like when completed correctly using Example 2:
Troubleshooting
If the Oracle User Experience Monitor does not work properly, explore the following troubleshooting sections. Oracle Client Driver and Server Compatibility SAM is Unable to Load the Oracle Client Driver Using Process Explorer to Determine if SAM is Loading the Correct Oracle Client Library Using Process Monitor to Determine Why the Oracle Client fails Oracle User Experience Monitor is Unable to Connect to the Oracle Server Using the Oracle SQL*Plus Tool to Troubleshoot Connectivity Issues:
Note: Many of these troubleshooting procedures are used by SolarWinds support technicians.
Oracle Client Driver and Server Compatibility Notes: Oracle Client drivers are not forward and backwards compatible with all Oracle database servers. Oracle Data Provider for .NET (ODP.NET) 11.2.0.3.0 is compatible only with Oracle Server 9.2 and higher.
Monitoring two different versions of Oracle Server might not be possible if there is no appropriate driver which would be able to connect to both server versions. If this is the case, have the second version of the Oracle Client on an additional poller and assign the nodes there.
SAM is Unable to Load the Oracle Client Driver Following is a screenshot of this error:
Troubleshooting Steps: Make sure that the Oracle Client was installed on the SAM computer or on the appropriate additional poller. Do not deploy two different Oracle Client Driver versions on the SAM computer. If the above was unsuccessful, follow these troubleshooting steps:
1. Download Process Explorer and install it on the SAM computer. 2. Run Process Explorer and look for the JobEngineWorker2.exe processes, (which belongs to SAM). This can be identified by the command line argument, "SolarWinds.APM.Probes."
3. Display the JobEngineWorker2.exe properties to ensure that the environment variable ORACLE_HOME exists and points to the correct location where the Oracle Client is installed.
The example below shows ORACLE_HOME set to the APM\OracleClient directory. This computer has the Basic Light Oracle Client installed (not the full ODP.NET version).
Using Process Explorer to Determine if SAM is Loading the Correct Oracle Client Library To determine if SAM is loading the correct Oracle Client Library, follow these steps: 1. In Process Explorer, navigate to View > Show Lower Pane. Then, navigate to View > Lower Pane View > DLLs.
2. Locate the JobEngineWorker2.exe (which belongs to SAM) and see if the oci.dll file is displayed in the DLL list in the lower pane. 3. Verify that the path is set to the correct directory.
This step needs to be done for each JobEngineWorker2.exe instance that belongs to SAM. This can be identified by the command line argument, "SolarWinds.APM.Probes."
Using Process Monitor to Determine Why the Oracle Client Fails If the Oracle Client is not visible in Process Explorer, perform the following steps to determine from which directory SAM is trying to load the Oracle Client: 1. Download Process Monitor from the following link: http://technet.microsoft.com/en-us/sysinternals/bb896645. 2. Start Process Monitor and define Filter.
4. Click OK. 5. Restart the JobEngine v2 service and wait for it to fully restart. 6. Go to the Oracle Database Edit page and test one of the components. 7. Wait until the test is finished and then stop the trace (File > Capture Events). 8. Analyze the results. There will be information about SWJobEngineWorker2.exe trying to find the oci.dll file, (which is part of the Oracle Client), revealing a list of directories it was searching for and whether or not it was successful. The Load Image event indicates whether or not SAM was able to load that library successfully. This may fail if the architecture of this library does not match the architecture of the polling job (as defined on the Application Edit page in SAM).
Below is sample output when the Oracle Client is not installed and therefore not found:
Here you can see which directories are being searched to locate the file. Below you can see that the full Oracle Client was installed:
Here you can see SAM was not able to load the Oracle Client because it does not match the platform of the polling job. In this case, the Oracle Database application is set to run as 64-bit, but the 32-bit version of the Oracle Client was installed. You can also see that SAM finds the oci.dll and opens it to read from it, but it detects that this is the wrong platform. Consequently, there is no Image Load operation:
Oracle User Experience Monitor is Unable to Connect to the Oracle Server Following is a screenshot of this error:
Troubleshooting steps: 1. Make sure a firewall is not blocking communication between SAM and Oracle computers. 2. Verify the configuration of the Oracle User Experience Monitor.
Use a third party tool, SQL*Plus, to try and connect to the Oracle Server using the same settings that SAM is using. Refer to the section, "Using the Oracle SQL*Plus Tool to Troubleshoot Connectivity Issues." Using the Oracle SQL*Plus Tool to Troubleshoot Connectivity Issues: The following steps demonstrate how to use SQL*Plus to check the following: Connectivity issues to the Oracle Server from the SAM computer. You are using the correct and valid Oracle endpoint, ( i.e. Service_Name or SID). You are using correct and valid Oracle credentials. You have credentials with enough permission to query Oracle system views. Note: This is required for troubleshooting the Oracle Database default template. The Oracle SQL*Plus tool is included in the Oracle Data Provider for .NET (ODP.NET) package. This package should be installed first as described in the, Installing ODP.N, section. Once installed, navigate to the installation directory and ensure that the sqlplus.exe file exists.
Connecting to an Oracle Server Using Simple Syntax 1. Run cmd.exe and navigate to the directory where sqlplus.exe is located. 2. Run the following command to test simple syntax:
sqlplus <UserName>/<Password>@<OracleServerNameOrIP>/<Servi ceNameOrSid>
where
<UserName> is the username of the account used by the Oracle User
address.
<ServiceNameOrSid> is the Oracle endpoint Service_Name or SID
value as defined in the Oracle User Experience Monitor settings. For example:
sqlplus SYSTEM/[email protected]/XE
This is used to connect to the XE instance on the Oracle Server running on 10.199.2.219 under the System account using Password1 as the password.
SqlPlus will show information on whether or not the connection was successful. If the connection was unsuccessful, the error message should contain the reason why it failed. If the connection was successfully established, then the prompt, SQL>, is shown.
Connecting to the Oracle Server Using Full Oracle Connection Syntax To more accurately simulate how SAM is connecting to the Oracle Server, run SQL*Plus using the full Oracle connection syntax , which is the equivalent of using the tnsnames.ora syntax:
sqlplus <UserName>/<Password>@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(H OST=< OracleServerNameOrIP>)(PORT=<PortNumber>)))(CONNECT_DATA=(<EndPointType>=< ServiceNameOrSid>)))
where
<UserName> is the username of the account used by the Oracle User
Credential Library.
<OracleServerNameOrIP> is the Oracle Server hostname or IP address. <PortNumber> is the specified TCP port where the Oracle endpoint
listens.
<EndPointType> specifies the type of Oracle endpoint. This value must
be either Service_Name or SID. This should match the Oracle User Experience Monitor settings in SAM.
<ServiceNameOrSid> is the Oracle endpoint Service_Name or SID value
For Example:
sqlplus SYSTEM/Password1@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP) (HOST=10.199.1.219)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=XE)))
Note: This example is used without specifying the password on the command line (Sqlplus will prompt for a password.)
sqlplus SYSTEM @(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=10.199.1.2 19)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=XE)))
Using SQL*Plus to connect using this method must be tried if SAM is unable to connect to the Oracle Server. If the connection does not work from SQL*Plus, then it will not work from SAM. Executing queries using SQL*Plus 1. Connect to the Oracle Server as described in previous sections. Ensure SQL*Plus shows the SQL> prompt.
If this query is successful, the next step is to try the same query as used in the Oracle User Experience Monitor in SAM. 3. Type the SQL query used by the Oracle User Experience Monitor and put a semicolon at the end. Note: Semicolons are required in SQL*Plus. 4. Press Enter to run the query.
This query may fail if you do not have privileges to access these SQL tables or views. If this is the case, you should connect to the Oracle Server using the Oracle administrator account (System) and execute the query under this account. If this works, then the issue is permissions related and needs to be changed or a different account should be used in SAM for monitoring.
PowerShell
The ability to employ PowerShell scripts within SAM is a powerful advantage for system administrators. This document merely provides an introduction to PowerShell, as well as its role with SAM. Windows PowerShell is a command-line shell created for system administrators. PowerShell includes an interactive prompt and a scripting environment that can be used independently or in combination. PowerShell is built on top of the .NET Framework Common Language Runtime (CLR) and the .NET Framework, and accepts and returns .NET Framework objects. PowerShell also introduces the cmdlet. A cmdlet is a simple command that can manipulate objects in PowerShell. Cmdlets have a unique format -- a verb and noun separated by a dash (-), such as Get-Help. You can use each cmdlet separately or in combination to perform complex tasks. PowerShell includes more than one hundred cmdlets, and you can write your own. PowerShell gives you access to the file system on the computer. In addition, PowerShell providers enable you to access other data stores, such as the registry, for example. Things you should know about PowerShell: PowerShell does not process text. Instead, it processes objects based on the .NET Framework. PowerShell comes with a set of built-in commands with a consistent interface.
3. On the target server, open a command prompt as an Administrator and enter the following:
winrm quickconfig winrm set winrm/config/client @{TrustedHosts="IP_ADDRESS"}
where IP address is the IP address of your SAM server. Once you have successfully completed these steps, PowerShell will be able to properly communicate with SAM. Exchange 2010 Management Tools Many SAM PowerShell components rely on Exchange Management Tools. Both the 2007 and 2010 editions are acceptable. If you plan to monitor Exchange 2007 then you must use the Exchange 2007 Management Tools. If you plan to monitor Exchange 2010 then you will need to install the Exchange 2010 Management Tools. Exchange Management Tools must be installed on the SAM server and any additional poller that will poll using PowerShell scripts. Any snap-ins that PowerShell may require must also be installed in the same location. To ease PowerShell plug-in management in a multi-poller environment, you may prefer to assign nodes with PowerShell templates to a single polling engine. Exchange 2010 Management Tools will be used for the following instructions:
Installation of Exchange Management Tools To install Exchange Management Tools on your Windows computer, you first need to configure the pre-requisite components. 1. Open the Control Panel, click on Programs and then click Turn Windows Features On or Off. 2. Enable the features shown below:
3. Download the Exchange Server 2010 SP1 installation files and extract them to a temporary folder on your computer. 4. From that folder launch Setup.exe. (If your computer is missing the .NET Framework, visit Microsoft.com to download and install it. Additionally, Steps 1 and 2 of the Exchange Server 2010 SP1 installation will prompt you to install pre-requisites if they are missing, as shown in the following illustration.)
5. If needed, install the pre-requisites for Exchange Server 2010 SP1. If not, click on Step 3 from the install screen and choose Install only languages from the DVD.
6. Choose language options for installing Exchange Server 2010 SP1 on Windows.
7. Next, click on Step 4 from the install screen to begin the installation.
8. Begin the installation of Exchange Server 2010 SP1 on Windows. 9. Click Next at the introduction page, then Accept the license agreement. 10. Click Next, then choose your preference for Error Reporting. 11. Click Next. 12. At the Installation Type page, select Custom Exchange Server Installation, and also check the box to Automatically install Windows Server roles and features required for Exchange Server. 13. Click Next.
14. Select the Management Tools role and then click Next.
64-bit vs. 32-bit Using the 64-bit (x64) or 32-bit (x86) version of PowerShell depends on how your target server and applications are configured. Ideally, both machines should be running on the same platform to get the most out of PowerShell. Platform Scenarios For the most part, you will not encounter any differences between the 64-bit and 32-bit versions of PowerShell; however, each version of the shell, in some cases, can only load matching snap-ins. This means you should use the correct 64-bit or 32-bit version of any snap-ins you plan to use. Below are some guidelines to help you determine which version of PowerShell you should use for your particular monitoring environment: If SAM is installed on a 64-bit sever and polling a 64-bit machine, you should poll using the 64-bit version of PowerShell. If SAM is installed on a 64-bit sever and polling a 32-bit machine, you should poll using the 32-bit version of PowerShell. If SAM is installed on a 32-bit sever and polling a 32-bit machine, you should poll using the 32-bit version of PowerShell. If SAM is installed on a 32-bit server and polling a 64-bit machine, you may encounter some errors. You should install SAM on a 64-bit server if you need to poll 64-bit machines.
Note: There may be instances where installed software on a 64-bit machine may have added its own cmdlets into the 32-bit version of PowerShell. If this is the case, you should use 32-bit polling. On Windows machines, you can determine the platform you are using by rightclicking My Computer and clicking Properties. Troubleshooting PowerShell Snap-In Compatibility The most common issue with PowerShell is the incompatibility of the snap-ins with the platform of PowerShell being used; meaning both PowerShell and its snap-ins should both be either 64-bit or 32-bit. When running your script in SAM, typical errors of this type resemble the following:
In order to diagnose and correct this problem, verify that the snap-ins are properly registered by doing the following. 1. Find the following registry path:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\PowerShell\1\PowerShe llSnapIns
Notice the ApplicationBase path is C:\Program Files\Microsoft\Exchange Server\bin not C:\Program Files (x86). The C:\Program Files (x86) path would suggest 32-bit PowerShell extensions are registered.
2. Open PowerShell though the GUI and check to see if the process is running in 32-bit mode. This is denoted by the *32 next to the process name. Since this is a 64-bit server with the 64-bit Exchange Management installed, PowerShell should not have a "*32" next to the process name. It should look similar to the image below.
4. Run get-PSSnapin registered. You should see the snap-in listed as shown below:
5. Now you should be able to execute a PowerShell command such as Get-MailboxDatabase -Server {exchange server hostname} and have it return results similar to the following:
6. Your snap-in module has properly been registered. SAM templates that use PowerShell will now work properly.
In this example, the Exchange 2007-2010 Mailbox Send and Receive Statistics with PowerShell template is used. This template tracks Exchange Mailbox Send/Receive statistics of Exchange 2007-2010 servers with the Mailbox role using PowerShell scripts.
The following screen appears once you have selected a template to edit, revealing the individual component monitors as well as details about the template:
The following documentation accompanies this template: Prerequisites: PowerShell 2.0 and Exchange Management Tools 2007 or 2010 installed on the SAM server. The Exchange server must have an Exchange Mailbox role. The SAM server and the Exchange server must be in the same domain. Credentials: The credentials must be an Exchange Administrator (Organization Manager) account with at least view-only permissions. Note: Before using this template, under the Advanced tree collapse [+], you should set the correct platform; either 32-bit or 64-bit, from the dropdown menu. The default it set to 32-bit. For all PowerShell component monitors: You must specify the correct name of your Exchange user and server in the Script Arguments field of the corresponding PowerShell Monitor. If you fail to do this, the counter will return with an error of "Undefined" status. For example: If the name of your Exchange server is exchange.mydomain.com, and the user you want to monitor is [email protected], the value in the Script Arguments field should be the following: [email protected],exchange.mydomain.com. To see the names of your Exchange servers, run the following PowerShell command in the Exchange Management Shell: Get-ExchangeServer To see the names of the users, run the following PowerShell command in Exchange Management Shell: Get-Mailbox To examine and edit an individual PowerShell component monitor within the template, click the plus sign [+] to the left of the monitor. For example: Number of items received by specific user during last month.
The following details about the selected component monitor are revealed:
Using a PowerShell script, the monitor in this example is designed to return the number of items received by a specific user during the last month. In order to use this monitor, you will need to change the Script Arguments field from the default example of, [email protected],server.domain.sw to something that will suit your needs for your particular environment. You can do this by clicking the Edit button (highlighted above).You also have the ability to alter the pre-defined script that comes with PowerShell component monitors. Note: Unless otherwise directed by the documentation, you should not need to edit pre-defined scripts.
Once you have changed the Script Arguments field, click Submit to begin using the component monitor within the template. The output for this script using the SAM monitor, Number of items received by specific user during last month, should be similar to the following illustration:
The output for the script using only PowerShell should be similar to the following illustration:
Variables are used for storing information. In SAM, variables are prefixed with "$", as highlighted below. The following code snippet from the above code calculates a numerical value and then stores it in the variable $stat. In the illustration below, the variable's value is reported as 9356, as highlighted in the Statistic column's output.
Text and variables within quotes indicate information that may be visible to the user. When made visible, the variables in the message will be replaced with the values the variables store. The variables are highlighted below in both the code and the output:
With these same lines of code, Message: and Statistic: refer to the columns where the information will be placed:
Scripts Must Report Status Through Exit Codes Scripts must report their status by exiting with the appropriate exit code. The exit code is used to report the status of the monitor, which is seen by the user through the interface. The following table explains the exit codes and their values:
Exit Code 0 1 2 3 Any other value Meaning Up Down Warning Critical Unknown
The two exit codes in this example are conditional, meaning either one or the other will be triggered based on a certain outcome. When Exit 0; (status of Up) is reported, the message and statistic are displayed and the monitor shows a status of Up. When Exit 1; (status of Down) is reported, the message and statistic are not displayed and a status of Down is reported. If you want to inform SolarWinds SAM that a PowerShell script reports an Up status, you would exit the script using Exit 0; Scripts with Text Output Scripts report additional details by sending text to the scripts standard output. SAM supports multiple values returned by a script using the following format. There is a limit of 10 Statistic and Message pairs for the script. These can be placed anywhere in the script output. The Statistic and Message names you give must contain valid letters and/or numbers.
Detail Type Required Meaning A numeric value used to determine how the monitor compares to its set thresholds. This must be an integer value, (negative numbers are supported).
Statistic
Yes
Message
No
For more information, refer to the following sections: "Creating a Windows PowerShell Monitor" on page 276. For more information about Windows PowerShell, visit: http://technet.microsoft.com/en-us/library/bb978526.aspx. For a complete list of available PowerShell cmdlets, visit: http://technet.microsoft.com/en-us/library/ee692945.aspx
Windows PowerShell 2.0 NET framework 2.0 SP1 or later Windows Remote Management (WinRM) 2.0
All of the above are installed by default on Windows 7 and Windows Server 2008 R2. However, earlier versions of Windows will require you to download the updates from Microsoft website and install them yourself. PowerShell 2.0 and WinRM 2.0 are included as a part of Windows Management Framework download and are available for Windows XP, Windows Server 2003, Windows Vista and Windows Server 2008. To be able run scripts and commands on remote computers, the user performing remote script execution must be: a member of the administrators group on the remote machine or should be able to provide administrator credentials at the time of remote execution or should have access the PS session configuration on the remote system
Also, on client OS versions of Windows such as Windows Vista and Windows 7, network location must be set either to Home or Work. WS-Management may not function properly if the network location for any of the network adapters is set to public.
SSL Certificate: This is required if we are going to secure our WinRM connection. Listener: Inside WinRM, a listener needs to be set up that listens on the network port Windows PowerShell the Remoting Server uses to communicate. Firewall Exception: A firewall exception is needed that allows outside requests to reach the WinRM service; WinRM Service: This service receives requests from other computers and needs to be running.
Create a Self-signed Certificate You will need an SSL certificate to use a secure WinRM connection. WinRM HTTPS requires a local computer Server Authentication Certificate with a CN matching the IP address that is not expired or revoked to be installed. There are two well-known tools available to create self-signed certificates; MakeCert.exe and SelfSSL.exe. MakeCert.exe is for testing purposes only and comes with Visual Studio. SelfSSL.exe is a part of the Internet Information Services (IIS) 6.0 Resource Kit Tools. SelfSSL.exe will be used in this example. The following commands should be executed on the Remoting Server computer. This is the target node to be used with the SAM PowerShell monitor.
1. Download Internet Information Services (IIS) 6.0 Resource Kit and start setup:
3. Select only the SelfSSL.exe tool (if you have no need for the additional components):
5. Change the current location on SelfSSL install path. Typically the path is C:\Program Files (x86)\IIS Resources\SelfSSL:
6. Enter the following command to create a self-signed certificate. Replace the parameters with actual values, as explained below. Note: Ignore the following possible error message: Error opening metabase: 0x80040154. This indicates that IIS 6.0 compatibility mode may not be installed.
selfssl.exe /N:CN=<Local Server IP Address> /V:<Certificate time to live in days> /P:<WinRM listener port> /T /Q
<Local Server IP Address> This is the IP address of the Remoting Server node. Use the IP address and not the computer name. SAM uses this IP address when the probes are run; <Certificate time to live in days> This is the time interval, in days, for which the certificate remains valid; <WinRM listener port> This is the port on which the HTTPS listener will be created. The default value for the WinRM HTTPS listener port is 5986; /T This option adds the self-signed certificate to the Trusted Root Certificates list; /Q Quiet mode. This will prevent you from be prompted when SSL settings are overwritten. For example:
selfssl.exe /N:CN=192.168.0.198 /V:3600 /P:5986 /T /Q
7. Verify that certificate was created properly. Start the Management Console (MMC.exe):
8. Add the Certificates snap-in and verify that the recently created selfsigned certificate is listed in both the Personal and Trusted Root Certificate Authorities storages.
9. Follow the red steps in the graphic, 1 through 4, to select the Certificates: snap-in
12. Verify that the certificate is in Trusted Root Certificate Authorities storage:
13. Open the created certificate by double-clicking it. 14. On the Details page, select and copy the Thumbprint field value:
15. Copy the values highlighted above to the clipboard. These copied values will be used in creating a Listener in the following section.
Create a WinRM HTTPS Listener Create the Windows Remote Management Listener and bind it to the certificate using the following steps: 1. Open a Command Prompt as an administrator from the Start menu, (right-click):
2. The following command should be executed on the Remoting Server computer. This is the target node which will be used with the SAM PowerShell monitor. It is also the computer where the self-signed certificate was created in the previous section. 3. Enter the following command with the parameters replaced with actual values, as explained below:
winrm create winrm/config/Listener?Address=<IP Address used to bind listener>+Transport=HTTPS @{Hostname=<The name or IP of your remoting server>;CertificateThumbprint=<Paste from the previous step and remove the spaces>;Port=<Port number>}
<IP Address used to bind listener> - To bind the certificate to the Listener, specify the Remoting Server's local IP address. You can use the wildcard, (*), symbol to allow listening on all available local addresses; <The name or IP of your remoting server> - The Remoting Server's node name or IP address; <Paste from the previous step and remove the spaces> Paste the self-signed certificate thumbprint created in steps 13-14 of the previous section; <Port number> - This is the port number for the Listener. You can specify the default WinRM HTTPS port of 5986. For example:
790 Configuring and Integrating
Administrator Guide SolarWinds Server & Application Monitor winrm create winrm/config/Listener?Address=IP:192.168.0.171+Transport= HTTPS @{Hostname="192.168.0.198";CertificateThumbprint="6aa47ed 7356fb0f1e3b434850a7bb51ed40b0d3a";Port="5986"}
4. Once the command has been successfully executed, the output will look similar to the following illustration:
Adding a Firewall Exception The following steps will create a in-bound exception for the Windows firewall using WinRM HTTPS port 5986. 1. Open a Command Prompt as an administrator from the Start menu, (right-click):
2. Enter the following command with the parameters replaced with actual values, as explained below:
netsh advfirewall firewall add rule name="<Rule name>" protocol=TCP dir=in localport=<Port number> action=allow
<Rule name> - This is the name of the rule shown in the Windows Firewall under Advanced Security > Inbound Rules; <Port number> - This is the port number in use for the Listener that was created in the previous section. For example:
netsh advfirewall firewall add rule name="WinRM via HTTPS - Open Port 5986" protocol=TCP dir=in localport=5986 action=allow
3. Locate the created certificate and right-click on it then select All Tasks > Export
792 Configuring and Integrating
4. The Certificate Export Wizard will be launched: 5. Select, No, do not export the private key, the click Next.
8. Click Finish.
Transferring the Certificate 1. Now you need to transfer the certificate. On the Remoting Client, open the Management Console.
3. Follow the red steps in the graphic, 1 through 4, to select the Certificates snap-in:
5. Locate Trusted Root Cetrification Authorities, right click on it, then navigate to All Tasks > Import.
6. The Certificate Import Wizard will be launched. Find the file to import and then click Next.
7. Select, Place all Certificates in the following Store. The store is "Trusted Root Certification Authorities."
PS> Set-ItemProperty HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Sy stem LocalAccountTokenFilterPolicy 1 -Type DWord PS> Start-Service WinRM
4. Turn off the WinRM service and revert the value of the LocalAccountTokenFilterPolicy registry entry:
PS> Stop-Service WinRM PS> Set-ItemProperty HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\Sy stem LocalAccountTokenFilterPolicy 0 -Type DWord
Your client is now able to access other systems remotely using Windows PowerShell remoting and is no longer limited to Kerberos and machines inside a domain.
Enter a simple script in the monitor for testing by clicking Edit, for example:
write "Statistic.RemoteMachineName: 0"; write "Message.RemoteMachineName: $env:computername"; exit 0;
Note: This script is printing the computer name (the machine on which this is executed).
Create an application based on our template and assign it to the Remoting Server target node:
Examine the script output. Done correctly, you should see the name of the Remote Server node in the output, not the SAM server, ( i.e. the script was executed remotely).
You now have a PowerShell monitor configured to execute scripts remotely via secure WinRM connection.
LDAP
Lightweight Directory Access Protocol (LDAP) is a protocol for accessing directory servers. In other words, LDAP is a directory, not a database. There are no rows or tables in LDAPs directory and there are no relational links. The result is a simple yet structured directory design that is easy to navigate. Every object in LDAP can contain one or more sub-objects, much like the folder and sub-folder relationship used in Windows operating systems. LDAP runs directly over TCP port 389 by default. It is used to store information about users, including the network privileges assigned to each user. Revoking or changing privileges can be done from one entry in the LDAP directory, rather than at many machines across the network. LDAP also supports SSL and TLS for security.
DNs work in reverse order, meaning the most specific node is on the left of the path syntax. Typical example of a DN:
CN=SomeUser,OU=SomeContainer,DC=SomeDomain,DC=com
Each RDN is a child of the object whose RDN is to its right. The object deepest in the tree in this DN example is the object, CN=SomeUser. Each RDN is composed of two parts: the name of the attribute that provides the primary name of the object, and the value of that attribute. In this example, CN, which stands for Common Name, is the name of the attribute that provides the primary name for objects of its class. SomeUser is the value of this attribute. There are also RDN attributes for OU (Organizational Unit) and DC (Domain Component).
Configuring and Integrating 805
Like any file system, the name for an object in an LDAP container must be unique. Thus, CN=Kate uniquely identifies this object within its container, OU=CustomerSupport. As a result, the entire DN uniquely identifies this particular object in the entire directory tree. Search Operation The most important operation in LDAP is the ability to search. This is how objects are found in the directory tree and how values are read. The syntax is somewhat different from more familiar query syntaxes such as SQL. However, LDAP is also much simpler than SQL with SQL's joins, sub-queries, ordering, and grouping. An LDAP query is composed of four basic parts: a search root, a search scope, a filter, and a list of attributes to return. There are more parameters and options, but these basic four are enough for most cases. Search Root The search root determines the place in the tree from which the search will start. This value is passed as a DN in string format. To search the entire directory, pass the DN of the object that is the root of the tree. To search lower in the hierarchy, specify a lower-level DN. Search Filter The search filter determines which objects will be returned in the query. It is analogous to the Where clause in a SQL statement. Each object in the scope of the query will be evaluated against the filter to determine whether or not it matches. Objects that do not meet the filter criteria are eliminated from the search.
Wildcard
(givenName=Ka*)
Advanced Examples of LDAP Syntax: You need a filter to find all objects that are in NYC or Austin, and that have the first name of "Kate." This would be:
(&(givenName=Kate)(|(l=NYC)(l=Austin)))
You have received 9,360 events in the Application log and you need to find all of the objects that are causing this logging event. In this case, you need to find all of the disabled users (msExchUserAccountControl=2) that do not have a value for msExchMasterAccountSID. This would be: (&(msExchUserAccountControl=2)(!msExchMasterAccountSI D=*)) Note: Using the ! operator with the * operator will look for objects where that attribute is not set to anything.
The LDAP Monitor supports LDAP version 2, which is the most commonly supported version. Most LDAP version 3 servers will support LDAP version 2 client requests. How this Monitor Works: 1. It creates an instance of the LDAP Connection class using the specified directory identifier. 2. It configures the connection which can be encrypted. 3. It establishes an LDAP connection and passes user authentication with the bind operation. 4. It prepares and sends an LDAP search request. LDAP Search Root and LDAP Filter monitor settings are used. 5. It reads and proceeds with an LDAP response. The monitor returns the number of found entries as statistic data. It also calculates and shows the server response time.
Realm (User Domain): This is the user's domain (e.g. for DC=solarwinds,DC=com the realm would be solarwinds).
LDAP Search Root: This is the place in the LDAP tree that you want to start your search. (e.g. The Users folder, as illustrated below):
This example is based on the Active Directory Domain Controller lab.rio. The LDAP search root would be CN=Users,DC=lab,DC=rio because the context name Folder is Users, and the domain DC is lab.rio. In general, you may specify just the domain root (DC=lab,DC=rio) to begin a search because the monitor always applies the SearchScope.Subtree request option. The query will search the entire domain tree for the requested object from the specified root. LDAP Filter: This describes the search condition for an LDAP query and matching attributes.
Credentials Credentials should be used without the domain because the Realm field is defined with this information. LDAP Monitor Statistics. The following illustrates typical field entries for a working LDAP User Experience monitor within SAM:
In the illustration below, the Statistic and the Response Time values are highlighted. A statistic of 1 is returned indicating that 1 user was found that matched the filter criteria. This query took 259 milliseconds, as indicated by the Response Time value of 259.
Index
Index
6
64-bit counters 105 email a web page 344 executing an external program 343, 424, 435 flagging traps 434 GET/POST 348 logging alerts to a file 338, 424 logging alerts to NetPerfMon Event Log 340 logging alerts to Windows Event Log 339, 424 logging traps to a file 434 logging traps to Windows Event Log 434 modifying Syslog message 424 playing a sound 337, 424, 435 send email/page 336, 425, 435 send SNMP trap 347, 424 send Windows Net messages 346, 424, 435 sending syslog messages 341, 424 sending traps 435 syslog See the SolarWinds Orion Common Components Administrator Guide tag message 423 tag trap 434 text-to-speech 346, 424, 435 traps 434, See the SolarWinds Orion Common Components Administrator Guide visual basic scripts 435 Visual Basic scripts 343, 424 activating APM license 48 Active Directory 143, See the SolarWinds Orion Common Components Administrator Guide Add a node 82 Add Application Monitors 170 add new view 87 adding
9 A
95 percentile calculations definition 469 Accessing RTPE 406 account limitations 192, See the SolarWinds Orion Common Components Administrator Guide creating 303 deleting 304 introduction 303 maps 513 pattern 194 removing 304 viewing reports 389 account list 84 Account Manager 84 accounts editing users 188 new user 187 acknowledging events in the Web Console 301 Syslog messages in Syslog Viewer 419 Syslog messages in the Web Console 418 actions 423, 434, See the SolarWinds Orion Common Components Administrator Guide advanced alerts 328 alert See the SolarWinds Orion Common Components Administrator Guide creating 305 dial pager 349 dial SMS 349 discard message 423 discard trap 434
812 Index
th
alert actions 335 database servers 439 devices in the Web Console 92 Adding server Hardware Monitoring 394 additional poller installing 462 understanding 459 Additional Polling Engines See the SolarWinds Orion Common Components Administrator Guide Additional Web Server See the SolarWinds Orion Common Components Administrator Guide additional website 464 Advanced Alert Manager Active Alerts 333 creating alerts 319, 320 Current Events 332 escalation 330 monitoring period 328 overview 332 reset actions 329 reset conditions 325 settings 334 suppressions 327 time of day 328 trigger actions 328 trigger conditions 322 advanced alerts See alerts acknowledging (Web Console) 316 adding actions 335 alert trigger 322 configuration See the SolarWinds Orion Common Components Administrator Guide creating 319, 320 escalated 349 escalation 330, See the SolarWinds Orion Common Components Administrator Guide monitoring period 328 reset actions 329 reset conditions 325
suppressions 327 testing actions 315 time of day 328 trigger actions 328 trigger conditions 322 advanced options maps 509 alert custom SQL 322 alert actions dial pager 349 discard message 423 discard trap 434 email a web page 344 executing an external program 343, 424, 435 flagging traps 434 GET/POST 348 logging alerts to a file 338, 424 logging alerts to NetPerfMon Event Log 340 logging alerts to Windows Event Log 339, 424 logging traps to a file 434 logging traps to Windows Event Log 434 modifying Syslog message 424 playing a sound 337, 424, 435 send email/page 336, 425, 435 send SNMP trap 347, 424 send Windows Net messages 346, 424, 435 sending Syslog messages 341, 424 sending traps 435 SMS 349 tagging message 423 tagging traps 434 text-to-speech 346, 424, 435 visual basic scripts 435 Visual Basic scripts 343, 424 alert suppressions advanced 327 alert trigger advanced alerts 322
Index 813
alert variables See the SolarWinds Orion Common Components Administrator Guide advanced alert engine 475 Date/Time (advanced) 476 date/time (Syslog) 486 date/time (traps) 488 examples (basic) 486 general (advanced) 475 group (advanced) 476 HW (advanced) 482 modifiers 469 node (advanced) 478 other (Syslog) 487 other (traps) 487 SQL query (advanced) 477 status (advanced) 478 Syslog 426, 486 Syslog (date/time) 426 Syslog (other) 427 traps 435, 487 traps (date/time) 436 traps (other) 436 volume (advanced) 481 alerts acknowledging (Web Console) 316 adding actions 335 advanced See the SolarWinds Orion Common Components Administrator Guide audible web 191 condition groups 330 creating 85, 305 deleting 85 disabling 85 editing 85 enabling 85 escalated 349 escalation example 349 executing an external program 343, 424, 435 log files 338, 424 logging to NetPerfMon Event Log 340 logging to Windows Event Log 339, 424
814 Index
mobile device view 317 mobile view See the SolarWinds Orion Common Components Administrator Guide on child objects of dependencies 185 playing a sound 435 testing actions 315 types 309 variables, application monitor 312 variables, component monitor 313 viewing in the Web Console 316 visual basic scripts 435 Visual Basic scripts 343, 424 windows service, restarting 318 alignment tools maps 510 allocation failures charts 128 anchor points 495 APM activating license 48 common components requirements 9 installing 43 licensing 53 running 52 standalone 9 upgrading 23 APM license summary 155 APM licensing 53 APM settings 88 APM thwack forum 155 application component monitors variables 515 application details view customizing 297 Application Discovery 158, 169 application monitor See applications application monitor templates See application templates application summary views, customizing 295 application templates 230 assigning 239, 243 creating 240, 242
editing 243 managing 242 using 237 applications adding 170 creating 227, 243 editing 250 monitoring 289 Orion example 281 remanaging 251 unmanaging 251 variables 515 what is an application 2 Applications tab 90 assigned application monitors 230 assigned component monitors 230 audible web alerts 191 authentication See the SolarWinds Orion Common Components Administrator Guide Windows 143 autoarrange maps 511 automatic login DirectLink 524 introduction 521 URL pass-through 524 Windows pass-through 521 availability calculation 204 charts 127 Available Product Updates 86
B
background image 497 Background Image 497 backgrounds maps 496 banner configuration 123 basic alerts See alerts adding actions 335 breadcrumbs 89, 90
C
calculating availability 204
calculation availability 203 baseline 203 Changing Threshold Values 398 charts allocation failures 128 availability 127 configuration See the SolarWinds Orion Common Components Administrator Guide CPU load 127 custom chart view 128 custom node 126 custom volume 128 data export options 129 disk usage 128 font size 129 memory usage 127 nodes 126 packet loss 127 percent loss 127 printing options 128 response time 127 sample intervals 129 size 129 time periods 129 titles 129 volume sizes 128 volumes 128 child status icon 299 choosing monitors and templates by protocol 232 color scheme 84, 123 command line filter 63 common tasks 55 compacting database tables 442 databases in Database Manager 441 component monitor library 253 component monitors 230 adding single or multiple 240 Linux/Unix Script 261 Windows Script 265 condition groups 330 all 330
Index 815
any 331 none 331 not all 331 Configs tab 90 configuration web console resources 113 configuring audible web alerts 191 database compression 154 reports folders 197 settings 79, 91, 149 contacting sales iv SolarWinds iv technical support iv user forums iv counter rollover 203 counter rollovers 105 CPU load charts 127 threshold 106 creating account limitations 303 alerts, advanced 319, 320 backup databases 440 custom properties 453 custom properties filters 457 dependencies 182 escalated alerts 350 user accounts 187 creating application monitors 243 creating application templates 240, 242 credentials See credentials library restoring security certificate 38 credentials library adding credentials 234 deleting credentials 234 editing credentials 234 understanding 234 VMware 216 critical thresholds 230 custom application details view 297 custom object resource 291, See also the SolarWinds Orion Common Components Administrator Guide
816 Index
Custom Object Resource 136 custom properties See the SolarWinds Orion Common Components Administrator Guide creating a property 453 creating filters 457 Custom Property Editor 453 Custom Property Editor settings 456 deleting 454 deleting filters 458 editing 456 filters 457 importing data 455 introduction 453 removing 454 removing filters 458 settings 456 Custom Property Editor 354 custom SQL alerts 322 Custom Summary 136 customize menu bars 84 customizing color scheme 84 menu bars 84 Customizing Hardware Chart 401, 402
D
data export charts 129 security 105, 202 database compression 154 grooming 154 maintenance 202, See the SolarWinds Orion Common Components Administrator Guide management See the SolarWinds Orion Common Components Administrator Guide Database Manager See the SolarWinds Orion Common Components Administrator Guide database details 89 in Database Manager 442
database maintenance 449 introduction 449 migrating a database 450 Database Manager adding a server 439 backup databases 440 compacting a database 441 compacting database tables 442 database details 442 detaching a database 445 editing fields 444 introduction 439 maintenance plan 445 restoring a database 441 table details 443 date variables 516 debug enable advanced debugging for support 240 debug logging for support 240, 250 definition account limitation 303 availability 204 custom property 453 deleting account limitations 304 custom properties 454 custom properties filters 458 dependencies 184 devices from the Web Console 95 deleting assigned application monitors 252 dependencies See the SolarWinds Orion Common Components Administrator Guide alerts on child objects 185 creating new 182 deleting 184 editing 183 introduction 181 managing 83 detaching a database 445
device discovery See the SolarWinds Orion Common Components Administrator Guide devices adding in the Web Console 92 deleting from the Web Console 95 poll now 102 rediscover 102 DHCP User Experience Monitor 559 DirectLink See the SolarWinds Orion Common Components Administrator Guide DirectLink automatic login 524 directories temporary 544 Directory Size Monitor 562 discarding syslog messages 423 traps 434 discovering applications 158, 169 discovery 158 results 165 scheduled results 166 Discovery Central 82, 157 Network Discovery 157 Discovery Ignore List 167 disk usage charts 128 disk usage threshold 106 distributing objects maps 511 DNS Monitor - TCP 564 DNS Monitor - UDP 565 DNS User Experience Monitor 566 documentation conventions iv library v Download Speed Monitor 568 dynamic groups 177
E
editing custom properties 456 dependencies 183 groups 179 editing application templates 243
Index 817
editing device properties in the web console 97 editing user accounts 188 element 15 email a web page 344 Enabling SNMP ESXi 211 Engineers Toolset 139 escalated alerts 349 creation 350 example 349 escalation advanced alerts 330 ESX API polling
settings 203
ESX Host Details 218 ESX HW Troubleshooting 219 ESX Server enabling SNMP on version 3.5 212 enabling SNMP on version 4.0 213 ESX Servers See the SolarWinds Orion Common Components Administrator Guide adding 217 creating credentials 215 monitoring requirements 210 polling methods 210 ESXi enabling SNMP 211 monitoring requirements 210 polling methods 210 event summary adding to web console 115 events acknowledging in the Web Console 301 viewing in the Web Console 300 Events view 300 exporting databases 450 external nodes 234 external websites 85, 137
fields editing in Database Manager 444 File Age Monitor 570 File Change Monitor 572 File Count Monitor 574 File Existence Monitor 576 File Size Monitor 577 filtering APM Application Summary Views 295 custom properties 457 filtering a node list resource 119 filters defining 360 SQL syntax 361 SWQL syntax 362 find processes, services, and performance counters 69, 72, 241 FIPS support 13 font size charts 129 FTP Monitor 579 FTP User Experience Monitor 580
G
general variables 517 GET alerts 348 gridlines maps 510 grouping nodes in a resource 121 groups See the SolarWinds Orion Common Components Administrator Guide combining applications 83 creation 177 deleting 180 dependencies 180 dynamic 177 editing 179 managing 83 status display 180 using 83
F
facility 427
818 Index
H
Hardware Alerting 403
Hardware Alerting thresholds 404 Hardware Chart 400 Hardware Details 396 Hardware Health 396, 397 Home tab 90 how it works 5 how to add component monitors 240 add credentials 234 assign application monitor templates 239 change configuration 79, 91, 149 change database settings 154 create an Orion application 281 create application monitors 243 create application templates 240, 242 create applications 227 create Linux/Unix Script component monitors 261 create Windows Script component monitors 265 delete credentials 234 edit application templates 243 edit assigned application monitors 250 edit credentials 234 enable debug logging for support 250 enable Orion Node Details application resources 294 view reports 358 HTTP 147 HTTP Form Login Monitor 583 HTTP Monitor 587 HTTPS scheduled reports 379 HTTPS Monitor 590
I
ICMP promoting to SNMP 98 promoting to WMI 100 settings 203 ignored devices 167 IIS
enabling See the SolarWinds Orion Common Components Administrator Guide on Windows Server 2003 16 on Windows Server 2008 20 on Windows Vista 20 on Windows XP 16 IMAP4 Monitor 593 IMAP4 User Experience Monitor 594 importing custom properties data 455 databases 450 independent labels 503 nodes 503 installing additional pollers 462 APM 43 on remote computer 491 Orion Network Atlas 491 requirements 491 installing APM 43 integrated remote desktop 148 Integrated Virtual Infrastructure Monitoring 209 interface links in maps 495 interfaces adding in the Web Console 92 deleting from the Web Console 95 editing properties in the web console 97 poll now 102 polling intervals 202 polling statistics intervals 202 unpluggable 97 viewing resources in the web console 101 Internet Explorer security settings 53 IVIM 209
L
large directories, monitoring 76 layouts
Index 819
circular 511 hierarchical 511 orthogonal 511 symmetrical 511 tree 511 LDAP User Experience Monitor 599 library v license details 89 License Manager See the SolarWinds Orion Common Components Administrator Guide licensing See the SolarWinds Orion Common Components Administrator Guide component monitors 53 software license key 48 viewing components in license 53 licensing APM 53 limitations account 192 pattern 194 linking URLs maps 508 links anchor points 495 status 495 Linux/Unix Script component monitors 261 Linux/Unix Script Monitor 601 List Resources 101 load balancing 205, See the SolarWinds Orion Common Components Administrator Guide log files number to keep 240 logging alerts to a file 338, 424 alerts to NetPerfMon Event Log 340 alerts to Windows Event Log 339, 424 traps to a file 434 traps to Windows Event Log 434
M
maintaining a database 449 maintenance plan 445 manage accounts 84
820 Index
manage advanced alerts 85 manage assigned component monitors 253 manage component monitors within templates 257 manage dependencies 83 manage groups 83 manage nodes 83, 101 manage templates 242 manage views 87 Management Studio 446 managing application monitors 249 manually assign application monitors 239 MAPI User Experience Monitor 603, 709 maps adding map objects 494 adding to web console 113 backgrounds 496 creating 493 examples 489 icon styles 513 label appearance 507 layout 511 line styles 513 link 495 linking URLs 508 list resource 114 map defaults 513 nested 501 node tree 513 objects list resource 114 settings 513 system requirements 491 memory swapping 104 memory usage charts 127 menu bar customizing 297 using 295 menu bars account defaults 195 custom 122 customization See the SolarWinds Orion Common
Components Administrator Guide Message Center 145 metrics maps 502 migrating databases 450 mobile alerts view See the SolarWinds Orion Common Components Administrator Guide mobile devices acknowledging alerts 317 viewing alerts 317 modifying syslog messages 424 monitoring memory 104 period (advanced alerts) 328 Monitoring Hardware Health 391 monitoring large directories 76 monitoring requirements 15 Monitoring the RTPE 409 moving servers 38 multiple monitors of same type adding to template 240
N
Nagios Script Monitor 273 nested maps 501 Net messages 346, 424, 435 NetPerfMon Event Log alerts 340 Network Discovery getting started 158 ignored results 167 results 165 scheduled results 166 network links 506 network settings 203 Network Sonar Discovery 82, See the SolarWinds Orion Common Components Administrator Guide Network tab 90 NNTP Monitor 608 node child status, calculating 299, 300 node details resources enabling 294
node graphics maps 503 node maintenance mode 104 node management poll now 102 rediscover 102 states 101 node metrics 502 node warning interval 206 nodes adding 82 adding in the Web Console 92 availability 204 custom charts 126 deleting from the Web Console 95 discovering 82 editing properties in the web console 97 filtering a resource list 119 grouping in a resource 121 managing 83 poll now 102 polling intervals 202 polling statistics intervals 202 reassigning to polling engines 205 rediscover 102 variables 517 viewing resources in the web console 101 NotePage 349 NotePager Pro 349 notification bar 144 number of log files to keep 250
O
ODBC User Experience Monitor 609 Oracle User Experience Monitor 612 Orion application example 281 Orion core details 89 Orion Network Atlas installing 491 Orion Polling Settings 202 Orion Product Team Blog 86 Orion Report Scheduler 377 Orion thresholds 88
Index 821
P
packet loss calculation 107 charts 127 packet loss reporting 207 paging alerts 349 pattern limitations 194 percent loss charts 127 percent memory used threshold 107 percent packet loss threshold 107 Performance Counter Monitor 617 troubleshooting 617 playing a sound 337, 424, 435 poll ESX server directly 218 poll now 102 poller aware 461, 462 load balancing 462 selecting 56, 57 unaware 460, 462 understanding 459 pollers configuration 201 settings 202 polling settings See the SolarWinds Orion Common Components Administrator Guide polling engine mode 154 local-only 154 poller-bound 154 polling engines 89 configuration 201 load balancer 205 load balancing See the SolarWinds Orion Common Components Administrator Guide management 201 reassigning nodes 205 settings 202 web console view 201 polling intervals response time 202
822 Index
status 202 polling settings node warning interval 206 polling settings 88 polling settings packet loss reporting 207 polling statistics intervals 202 polling through 218 POP3 Monitor 620 POP3 User Experience Monitor 622 POST alerts 348 printing charts 128 process diagram 227 Process Monitor - SNMP 624 Process Monitor - WMI 626 processes monitoring 63, 240 product updates downloading 125 viewing 124 promoting nodes from ICMP to SNMP 98 promoting nodes from ICMP to WMI 100 properties maps 512 protocol for monitors and templates 232
R
RADIUS User Experience Monitor 628 Real Time Polling 405 realtime change detection 424, 435 rediscovery 102 regular expressions eamples 474 remanaging assigned application monitors 251 remote access HTTP 147 SSH 147 Telnet 147 remote desktop 148 remote installation 491 removing
account limitations 304 custom properties 454 custom properties filters 458 Report Scheduler 354, See the SolarWinds Orion Common Components Administrator Guide Report Writer creating reports 353 using 358 using custom properties 354 using predefined reports 354 reports See the SolarWinds Orion Common Components Administrator Guide account limitations 389 adding to web console 118 alerts 367 availability 365, 366 component availability 74 CPU 368 creating 353 creating a report 373 current groups and groups members 369 current status 354 custom, creating 74 daily availability 355, 356 design mode 373 device types 370 disk space 370 down events 367 down nodes 366 events 367 example 382 exporting 381 field formatting options 377 field options 374 filter results options 375 folder 197 footers 381 formats 381 general options 374 getting started 372 group availability 369 group availability with members 369
group member status 369 group status 369 grouping options 377 groups and group member status 369 headers 381 historical groups status 370 historical status 356, 357, 358 included 358 interface bandwidth 370 interface types 370 inventory 370 IOS versions 370 last 250 events 367 list resource 118 modifying a report 373 node response time 366 node status 366 predefined 354, 364 preview mode 372 response time 368 scheduling 378 SQL query 382 summarization options 376 time frame options 376 top XX records options 376 using custom properties 354 viewing 358 virtual machine CPU utilization 368 virtual machine memory utilization 368 virtual machine running time 368 virtual machine traffic 368 VMware ESX Server 368 volume status 366 volume usage 370 volumes 370 website-only 464 Reports view 371 requirements monitored devices 15 Orion database server 12 Orion server hardware 10 Orion server software 10
Index 823
SNMP monitoring 15 virtual machines 11 virtual servers 11 VMware Servers 15 requirements for component monitors using WMI 232 requirements for templates using WMI 232 reset actions (advanced alerts) 329 conditions (advanced alerts) 325 resources active application alerts 289, 291 additional node details 294 all applications tree 289 all groups 290 APM sample map 290 application availability 292 application details 291 application health overview 289 applications with problems 289 component availability 293 component details 292 component statistics 292 components 291 configuration 113 custom HTML 117 Custom Object 136 custom object resource 291 custom text 117 event summary 115 last 25 application events 290 last xx application events 291 last xx component events 293 map objects list 114 maps 113 maps list 114 min/max average CPU load 293 min/max average physical memory 293 min/max average response time 293 min/max average statistic data 293 min/max average virtual memory 293 process and service monitors 291
824 Index
reports 118 reports list 118 Syslog 416 top xx components by response time 290 top xx components by statistic data 290 top xx processes by CPU load 290 top xx processes by physical memory 290 top xx processes by virtual memory 290 user-defined links 116 response calculation 107 response time charts 127 threshold 107 restarting a Windows service 318 restoring databases 441 rollover 105 root cause displaying in alert for group 305 RTPE Alerts 411 running Orion APM 52
S
sample intervals adjust 129 scan nodes for applications 237 scheduled discovery See the SolarWinds Orion Common Components Administrator Guide ignored results 167 managing results 166 scheduling node maintenance 104 Script Engine 662 scripting custom component monitors 260 security maps 513 security certificate 38 security of data 105, 202 sending email/page 336, 425, 435 SNMP trap 347, 424 syslog messages 341, 424
traps 435 server requirements 15 sizing 15 Server & Application Monitor adding map objects 494 starting 493 service accounts 170, 238 Service Status - SNMP 630 setting account defaults 195 account limitations 192 pattern account limitations 194 settings charts See the SolarWinds Orion Common Components Administrator Guide discovery See the SolarWinds Orion Common Components Administrator Guide web console See the SolarWinds Orion Common Components Administrator Guide website See the SolarWinds Orion Common Components Administrator Guide severity 428 shared thwack templates 155 site logo configuration 123 SMS alerts 349 SMTP Monitor 632 SNMP monitoring requirements 15 SNMP settings 203 SNMP ESX Server version 3.5 212 SNMP ESX Server version 4.0 213 SNMP Monitor 633 snmp traps See traps software license key enabling 48 SolarWinds
contacting iv website iv spoofing network packets 425 SQL query as a variable 477 Server Management Studio 446 variables 477 SQL Server tempdb 544 SQL Server User Experience Monitor 635 SQL syntax 361 SSH 147 SSL alert email 336 SSL CEM 638 standalone product 9 starting 493 status groups 180 maps 512 status indicators 467 status variables 478 StatusRootCause 305 summarization 449 suppression advanced alerts 327 SWQL syntax 362 Syslog See the SolarWinds Orion Common Components Administrator Guide acknowledging messages in Syslog Viewer 419 acknowledging messages in the Web Console 416, 418 alert actions 423 alert variables 426, 486 alerts 341, 421, 424 daemons 427 facility 427 filters 421 forwarding messages 425 messages in the Web Console 416 monitoring 415 port configuration 415
Index 825
priority value 427 processes 427 resources 416 searching messages 419 server settings 420 severity 428 view 417 viewing messages in Syslog Viewer 419 viewing messages in the Web Console 417 syslog variables See the SolarWinds Orion Common Components Administrator Guide System Manager availability calculation 204 node maintenance 104
T
tables compacting 442 details 443 tabs 90 TACACS+ User Experience Monitor 640 tagging syslog messages 423 traps 434 TCP Port Monitor 642 Telnet 147 TEMP 544 tempdb 544 testing alert actions 315 text-to-speech 346, 424, 435 thresholds 106, 203 configuration 108 CPU load 106 critical 230 disk usage 106 percent memory used 107 percent packet loss 107 response time 107 warning 230 Thwack iv thwack.com
integration See the SolarWinds Orion Common Components Administrator Guide time variables 516 time of day advanced alerts 328 time periods charts 129 TLS alert email 336 TMP 544 Tomcat Server Monitor 644 Toolset integration 139, See the SolarWinds Orion Common Components Administrator Guide adding programs 141 configuration 140 tooltips maps 508 trap variables See the SolarWinds Orion Common Components Administrator Guide Trap Viewer 430 settings 431 traps See the SolarWinds Orion Common Components Administrator Guide alert actions 432 alert actions 347, 424 alert variables 435, 487 alerts 432, 435 alerts actions 434 community string 432 conditions 432 defined 429 DNS hostname 432 email/page 435 executing an external program 435 filters 432 log files 434 logging to Windows Event Log 434 playing a sound 435 port 430 protocol 429
826 Index
searching 431 text-to-speech 435 time of day 432 Trap Viewer configuration 430 Trap Viewer settings 431 trigger thresholds 432 viewing 430 viewing in the Web Console 429 visual basic scripts 435 Traps view 429 trigger actions advanced alerts 328 trigger conditions advanced alerts 322 troubleshooting 525 temporary directories 544 variables 527 Windows Server 2008 performance 545 Windows Vista performance 545 troubleshooting Windows performance counters 617
reports folder 197 views 195 user forums iv user-defined links 116 Using the RTPE 408
V
variables 515, See the SolarWinds Orion Common Components Administrator Guide advanced alerts 475 application component monitors 515 applications 515 basic alerts 469 date 516 Date/Time (advanced alerts) 476 date/time (Syslog alerts) 486 date/time (trap alerts) 488 examples (basic alerts) 486 full names 527 general 517 general (advanced alerts) 475 group (advanced alerts) 476 HW(advanced alerts) 482 introduction 469 node (advanced alerts) 478 nodes 517 other (Syslog alerts) 487 other (trap alerts) 487 SQL query (advanced alerts) 477 status (advanced alerts) 478 Syslog alerts 426, 486 Syslog alerts (date/time) 426 Syslog alerts (other) 427 time 516 trap alerts 435, 487 trap alerts (date/time) 436 trap alerts (other) 436 volume (advanced alerts) 481 volumes 519 vCenter 218 viewing alerts (Web Console) 316 device resources (Web Console) 101 events (Web Console) 300
Index 827
U
understanding applications 2, 230 credentials library 234 resources 289 Universal Device Pollers transformations 284 unmanage nodes 101 unmanaging assigned application monitors 251 unplugged interfaces 97 upgrading moving servers 38 upgrading APM 23 URL pass-through automatic login 524 user accounts access settings 190 creating 187 editing 188 limitations 192 menu bars 195 pattern limitations 194
Syslog messages (Web Console) 417 traps (Web Console) 429 views account defaults 195 Alerts 316 by device type 112 copying 112 creating 109 Custom Summary 136 customizing 108 deleting 112 editing 109 exporting to PDF 131 menu bars 122 Message Center 145 Orion Poller Settings 201 product updates 124 Reports 371 Syslog 417 Traps 429 Virtualization Summary 217 views by application type 87, 153 views by device type 87 virtual machines See the SolarWinds Orion Common Components Administrator Guide hosting Orion See the SolarWinds Orion Common Components Administrator Guide monitoring See the SolarWinds Orion Common Components Administrator Guide Virtualization settings 83 Virtualization Summary 217 Virtualization tab 90 virtualization thresholds 88 visual basic scripts 435 Visual Basic scripts 343, 424 vMotion 209 VMware adding ESX Servers 217 credentials library 216 ESX Servers See the SolarWinds Orion Common Components Administrator Guide
828 Index
monitoring requirements 15 VMware monitoring 69, 647 wizard 69 VMware Performance Counter Monitor 647 VMware tools 217 VMware Tools 15 VMware wizard 69 volumes adding in the Web Console 92 custom charts 128 deleting from the Web Console 95 polling intervals 202 polling statistics intervals 202 size charts 128 variables 519 viewing resources in the web console 101
W
warning thresholds 230 web console 79 breadcrumbs 90 configuring resources 113 navigation 89 notification bar 144 tabs 90 views See the SolarWinds Orion Common Components Administrator Guide Web Console accounts See the SolarWinds Orion Common Components Administrator Guide acknowledging alerts 316 Active Directory 143 adding a map 113 adding devices 92 adding interfaces 92 adding nodes 92 adding volumes 92 Admin login 143 administration See the SolarWinds Orion Common Components Administrator Guide Alerts view 316
banner 123 changing passwords 104 clearing configurations 142 color scheme 123 configuration See the SolarWinds Orion Common Components Administrator Guide configuring product updates 124 copying views 112 creating accounts 187 creating configuration backups 142 creating views 109 custom HTML 117 custom text 117 data security 105, 202 deleting devices 95 deleting interfaces 95 deleting nodes 95 deleting views 112 deleting volumes 95 downloading product updates 125 editing accounts 188 editing device properties 97 editing views 109 event summary resource 115 Events view 300 exporting views to PDF 131 external websites 137 filtering a node list resource 119 grouping nodes in a resource 121 interface tooltips 96, 299 login 143 map objects list resource 114 maps list resource 114 menu bars 122 Message Center 145 node management states 101 node tooltips 96, 299 poll now 102 polling engines 201 promoting nodes from ICMP to SNMP 98 promoting nodes from ICMP to WMI 100
rediscover 102 Reports 371 reports list resource 118 reports resource 118 restoring configuration backups 142 site logo 123 Syslog 416 thresholds 106 Toolset integration 139 Traps 429 user-defined links resource 116 view customization 108 viewing alerts 316 viewing device resources 101 Views by Device Type 112 Windows Authentication 143 Web Console Configuration 141 Web Console Configuration 141 web console settings 88 Web Link Monitor 651 website 464 Windows Event Log alerts 339, 424, 434 memory 104 Net messages 346, 424, 435 pass-through automatic login 521 Windows Authentication 143, See the SolarWinds Orion Common Components Administrator Guide Windows Event Log Monitor 654, 658 Windows PowerShell Monitor creating 276 Windows Script component monitors 265 Windows Script Monitor 606 Windows Server 2008 slow performance 545 Windows Service Monitor 663 Windows Vista slow performance 545 WMI requirements for 232 WMI Monitor 665
Index 829
Z
zoom
maps 501
830 Index