eyeshare integrating with solarwinds npm · the supported versions of solarwinds are 10.7,...
TRANSCRIPT
2
LEGAL NOTICE .................................................................................................................................... 4
ABOUT AYEHU SOFTWARE TECHNOLOGIES........................................................................................ 5
ABOUT THIS DOCUMENT ................................................................................................................... 6
REQUIREMENTS ................................................................................................................................. 7
MODULE OPERATION ......................................................................................................................... 7
INTEGRATION ARCHITECTURE ............................................................................................................ 7
MODULE INSTALLATION..................................................................................................................... 8
REQUIREMENTS ......................................................................................................................... 8
INSTALLATION PROCESS – NEW INSTALL ........................................................................................ 8
INSTALLATION PROCESS – UPDATE ............................................................................................... 9
MODULE CREATION AND CONFIGURATION ..................................................................................... 12
DEVICE CREATION .................................................................................................................... 12
MODULE GENERAL SETTINGS ..................................................................................................... 12
SERVER SETTINGS .................................................................................................................... 13
FILTER SETTINGS ...................................................................................................................... 15
MAPPING ............................................................................................................................... 16
Fields ............................................................................................................................................. 16
VARIABLES USAGE ........................................................................................................................... 18
CONDITION ............................................................................................................................. 18
ACTIVITY ................................................................................................................................ 19
ACTIVITIES........................................................................................................................................ 19
SOLARWINDS NPM ACKNOWLEDGE ALERT ................................................................................. 20
SOLARWINDS NPM GET ALERT ................................................................................................. 21
SOLARWINDS NPM GET NODE ................................................................................................. 22
SOLARWINDS NPM MANAGE NODE .......................................................................................... 23
SOLARWINDS NPM UNACKNOWLEDGE ALERT ............................................................................. 23
3
SOLARWINDS NPM UNMANAGE NODE ...................................................................................... 24
CONFIGURATION FILE ...................................................................................................................... 25
LOG SETTINGS ......................................................................................................................... 25
OTHER SETTINGS ..................................................................................................................... 26
TROUBLESHOOTING ......................................................................................................................... 27
TEST CONNECTION FAILURE ....................................................................................................... 27
TIPS 30
RECOVERY WORKFLOW ............................................................................................................ 30
4
Legal Notice
© 2016 Ayehu Software Technologies Ltd ("Ayehu").
The contents of Ayehu's publications, whether found on this website and/or in the
form of an eBook and/or any other form of publication (collectively the
"Publications"), are owned and copyrighted by Ayehu.
A single copy may be printed solely for personal and non-commercial use.
No part of the publication may be altered, reproduced, distributed, or transmitted in
any form or by any means, including photocopying, recording, or other electronic or
mechanical methods, without the prior written consent of Ayehu, except in the case
of brief quotations embodied in critical reviews and certain other noncommercial
uses permitted by law.
Any printed and/or electronically displayed (or any other such similar form of display
available) material (the "Materials") must contain the following copyright notice:
"Copyright © 2016 Ayehu Software Technologies Ltd. All Rights Reserved." and any
other copyright or other proprietary rights notices which were contained on the
Materials. Any other use of the Materials, either in whole or in part for any other
reason is expressly prohibited, unless prior written consent is obtained from Ayehu.
For the avoidance of any doubt, "Ayehu" and the names of all Ayehu Software
Technologies Ltd products and services referenced in this document are copyrighted
to Ayehu.
Other products' and/or companies' names referenced in the Materials may be the
trademarks of their respective owners.
5
About Ayehu Software Technologies
Ayehu was founded in 2007 to develop and market innovative solutions for the
prevalent problem of network and IT system downtime. Ayehu’s flagship product,
EYESHARE, significantly reduces MTTR by bridging the gap between critical business
situations and relevant human resources.
Contact details:
Ayehu Software technologies, Ltd.
26 Harokmim Street
Holon, 5885849, Israel.
Tel: +972 (0)3 649 50 70
Website: http://www.ayehu.com
email: [email protected]
6
About this Document
This document describes the eyeShare – SolarWinds NPM integration components,
module configuration and activities.
The following style conventions are used in this document:
Convention Use
Calibri Regular text
Calibri Bold Names of menus, commands, buttons, and other elements of the
User interface.
Calibri Italic Special terms; the first time they appear.
Notes offering an additional explanation or a hint on how to
overcome a common problem.
Warnings indicating potentially damaging User operations and
explanations on how to avoid them.
7
Requirements
Supported Version
The supported version of eyeShare for this integration is Ayehu eyeShare 4.6 (and
above), with a SolarWinds NPM Module license.
The supported versions of SolarWinds are 10.7, SolarWinds NPM 11.5, SolarWinds
NPM 11.5.2, SolarWinds SAM 6.2.0 and SolarWinds SAM 6.2.2.
User Access
The SolarWinds eyeShare module user has to have DB_Owner permissions on the
SolarWinds database.
Server Time
Times and time zones on eyeShare and Solarwinds servers must be synchronized.
Module Operation
The SolarWinds NPM Module provides a bidirectional communication channel
between SolarWinds NPM and eyeShare. Once the Module is defined and available,
eyeShare pulls new alerts and alert updates, translates them into incidents and
displays them in eyeShare Dashboard. Alerts recovered in the SolarWinds NPM
console trigger incident closure in eyeShare.
The integration is performed directly with the SolarWinds database.
Integration Architecture
8
Module Installation
Requirements
1. One of the following operating systems:
Windows 2008 Server 64-bit
Windows 2012 Server 64-bit
2. Software: .Net Framework 3.5.1 and 4.5.1 installed.
3. The user running the installation should be an Administrator of the target host.
Installation Process – New Install
1. Run the eyeShare installer.
2. In the Setup Type step select Custom and click Next.
3. Expand Integration Packs branch and select This feature will be installed on local hard drive for for eyeShare SolarWinds Server. Then click Next.
9
4. Continue the installation as described in the Installation Guide.
Installation Process – Update
For instances already running eyeShare 4.6 and above, proceed with the following steps to add the SolarWinds integration module:
1. Execute eyeShare.exe, and click Next.
To run the installer as the Administrator, right click the executable and select
“Run as administrator”
10
2. Choose Modify and click Next.
3. Expand Integration Packs branch and select This feature will be installed on local hard drive for eyeShare SolarWinds Server. Then click Next.
11
4. Click Install.
5. A success notice will appear at the end of the installation process.
12
Module Creation and Configuration
Device Creation
1. In eyeShare Studio, access Incident Management Devices, and click New.
2. Set the SolarWinds Database server name and IP Address.
3. The device’s name must be available within the DNS or include the IP Address.
4. Click OK.
Module General Settings
1. In eyeShare Studio, access Configuration Modules, and click New.
2. In the Module Selection window, select SolarWinds NPM.
3. Configure the Module’s general settings:
13
In the Name field, enter a meaningful name for the new Module (e.g.,
"SolarWinds NPM Module").
In the Description field, enter a description of the new Module.
From the Device field, select the Device on which the Module is installed.
This is the device on which the “SolarWinds NPM Server” service is
installed and not the device where the actual SolarWinds NPM is installed.
In the Port field, enter the port through which the SolarWinds NPM Module
operates.
From the Monitor field, select the Module's monitoring option: select “Yes” if
you wish that eyeShare Server to monitor the Module’s availability.
Click Configuration.
Server Settings
To configure the server settings of the SolarWinds NPM Module:
14
From the Device field, select the Device on which the SolarWinds database is
installed.
If the SolarWinds database name is not the default name, change it in the
Solarwinds configuration file.
In the Port field, enter the port to the SolarWinds NPM server database.
In the User Name field, enter a user with DB_Owner permissions to the
SolarWinds NPM database.
In the Password field, enter the password of the selected user.
Click Test Connection. If the connection was tested successfully, proceed to
the next step. Otherwise, refer to the Troubleshooting section.
15
Filter Settings
In the Filter Settings window you may determine which alerts are forwarded to the
eyeShare server. You can create several filters, each containing a number of
conditions. The operator between two filters is “Or” and the operator within a filter
is “And”.
Click Add to add a new filter and new filter categories, and then click Update:
16
Mapping
In the Mapping window you may translate SolarWinds NPM properties into eyeShare
variables and objects.
The window is divided into three sections: Fields, Severity, and State.
The following checkboxes are located at the bottom of the Mapping window:
When checked, every time an alert is updated the rule base is checked to find a
matching rule.
When checked, incoming alerts and tickets are processed but an eyeShare incident is
not created.
In case of a tag that holds a condition that matches the message properties,
the mapping window is ignored.
Fields
In this section you can translate SolarWinds NPM properties into eyeShare variables.
Click Optional Properties to add eyeShare properties to the list, or to remove them
from it.
17
18
Variables usage
When the SolarWinds NPM Module is available, related variables are discovered in
eyeShare and can be used to define conditions or used by any activity.
In eyeShare, the name of the “Severity” SolarWinds NPM variable is “_Severity”
and the name of the “State” SolarWinds NPM variable is “_State”.
Condition
To use SolarWinds NPM variables in a condition, in the condition window select the
Variables radio button, and then select the SolarWinds NPM Module’s name from
the list.
All imported SolarWinds NPM variables will then appear in the Standard Object Type
list:
19
Activity
To use SolarWinds NPM variables in an activity, click the Add Variable button ( )
in the activity (or, alternatively, press Alt+V). From the Type list field select the
SolarWinds NPM Module’s name.
All imported SolarWinds NPM variables will then appear in the Name list:
Activities
To use the SolarWinds NPM activities, open the Workflow designer window from
eyeShare Studio, and expand the SolarWinds NPM category from the toolbox. Then
drag the relevant activity to the designer area.
To learn more about the eyeShare Workflow designer please refer to the eyeShare
Workflow User Guide.
20
SolarWinds NPM Acknowledge Alert
This activity acknowledges an alert in SolarWinds NPM.
Output: Success/Failure.
21
SolarWinds NPM Get Alert
This activity gets a list of alerts according to the selected criteria.
Click Add to add filters to the list, and Edit to modify existing filters.
Output: a resultSet of the matching alerts.
Variables cannot be added to the Value field in the Filter Settings window
using Alt+V. To use a variable, type in %variable_name% manually.
22
SolarWinds NPM Get Node
This activity gets a list of nodes which match the selected criteria and their
properties.
Output: a resultSet of the matching nodes.
23
SolarWinds NPM Manage Node
This activity sets a node in “Managed” state.
Output: Success/Failure.
SolarWinds NPM Unacknowledge Alert
This activity unacknowledges an alert in SolarWinds NPM.
Output: Success/Failure.
24
SolarWinds NPM Unmanage Node
This activity sets a node in “Unmanaged” state.
Output: Success/Failure.
25
Configuration File
The following settings are available within the eyeShare SolarWinds NPM module configuration file - eyeShare SolarWinds NPM Server.exe.config, located in the directory of the eyeShare SolarWinds NPM Module executable, assigned to the Windows service eyeShare SolarWinds NPM Server.
{eyeShare Install Directory}\eyeShare SolarWinds NPM Server
The Default location is C:\Program Files\eyeShare\eyeShare SolarWinds NPM Server\eyeShare SolarWinds NPM Server.exe.config
In order for updates to take effect, restart the Module’s Windows Service.
Log Settings
The following setting define the eyeShare Module logging:
<add key="LogLevel" value="1"/>
Default: value="1"
Defines the level of details captured and written to the module log file:
1 – Critical errors are written to the log file
2 - Critical and warning errors are written to the log file
3 – All log levels are written to the log file
<add key="LogsDirectory" value=""/>
Default: value=""
Defines the log file path. The default path is the one set during the installation.
<add key="LogFileName" value=""/>
Default: value=""
Defines the log file name. The default name is “eyeShare_SolarWinds NPMServer_DDMMYYYY.log”. For example: eyeShare SolarWinds NPMServer_17092015.log
<add key="LoggingDateFormat" value="MM/dd/yyyy HH:mm:ss"/>
Default: value="MM/dd/yyyy HH:mm:ss"
Defines the date and time format written to log file entries.
<add key="LogNumberOfDaysToPreserve" value="14"/>
Default: value="14"
Defines the number of days log files are kept prior to auto deletion.
26
Other Settings
<add key="RepeatCount" value="-1"/>
Default: value = “-1”
Sets the number of duplicated alerts that the CA Spectrum Module pulls.
When set to “-1” the module pulls an unlimited number of duplicated alerts.
Each repeated alert is translated into an incident instance in eyeShare. When
set to any number greater than “0” the module pulls duplicated alerts
according to the specified number. For example, if the parameter is set to “5”
the module pulls the first alert and the following 5 duplicated alert. If
multiple identical alerts are generated between the pulling intervals only one
alert is pulled and one new incident instance is created in eyeShare.
<add key="QueueDelay" value="1000"/>
Default: value = “1000” (milliseconds)
Sets the eyeShare Server pulling interval from the module’s alert queue.
<add key="DisregardRecovery" value="False"/>
Default: value = “False”
Determines whether or not recovery alerts are ignored by the module.
<add key="RecoveryResolutionState" value="Up"/>
Default: value = “Up”
Determines the “Recovery” resolution state as it is being sent by SolarWinds.
<add key="DefaultAcknowledgedByUser" value="eyeShare"/>
Default: value = “eyeshare”
The user which will be listed in the “AcknowledgeBy” field in SolarWinds when
acknowledging an alert from the “SLNPM Acknowledge” activity.
<add key="DBName" value="SolarWindsOrion"/>
Default: value = “SolarWindsOrion”
The database name that the module will use when testing the connection to the SolarWinds
module.
27
Troubleshooting
Test Connection failure
1. Error: “Could not connect to net.tcp://ServerName: 11026./ The connection
attempt lasted for a time span…” ( “ServerName” represents the device you
have listed in the General Settings window).
Explication and/or Solution: SolarWinds NPM Module is not installed on
“ServerName”, or service “eyeShare SolarWinds NPM Server” service is not
running. If the specified server is incorrect then select the correct server
where the component is installed. If the server name is correct then start the
service (or restart it if it is already started). If the service does not exist install
it on the selected server.
28
2. Error: “A network-related or instance-specific error occurred while
establishing a connection to SQL Server”.
Explication and/or Solution: No connectivity to the database server, or the
device that was selected in the Server Settings window either does not have
SolarWinds NPM installed or SolarWinds NPM services are not running on it.
3. Error: “Error checking services”
Explication and/or Solution: This error indicates a timeout while waiting for a
response from SolarWinds NPM. This timeout may occur due to a false user
name or password, a temporary network problem or any other delay.
4. Error: “Cannot open database “SolarWindsOrion” requested by the login. The
login failed.
Explication and/or Solution: This error indicates lack of connectivity with the
database server. To resolve the case, verify the following:
29
a. The port you specified in the module configuration window is the
configured TCP/IP port to connect to the SolarWinds database (verify
the port is open).
b. The correct SolarWinds database name is set in the module’s
configuration file.
c. The correct user name and password to connect to the SolarWinds
module are used in the module’s configuration window.
30
Tips
Recovery Workflow
If you want to trigger a Workflow when an alert is recovered, select the relevant
option from the following list and perform the following steps:
The closed record complies with the original record’s condition:
1. In eyeShare Studio, go to Rules, and open the relevant rule.
2. Add a recovery workflow to the row of the original condition.
For example: if the condition to execute a Workflow when getting a record is
“Severity = Critical”, the Workflow in the Workflow field is executed when
the record is opened, and the Workflow in the Recovery Workflow field is
executed when the record is closed.
The closed record does not comply with the original record’s condition:
1. In eyeShare Studio, go to Rules, and open the relevant rule.
2. Create a new condition that complies with the closed record.
3. Add a recovery workflow to the new condition.
For Example: if the condition to execute a Workflow when getting a record is
“State = Down”, the Workflow in the Workflow field is executed when the
record is opened; however, recovered records do not comply with this
31
condition. In this case, add another condition - “State = Up” - and add a
recovery Workflow executed when the record is recovered.