integrating with solarwinds · the solarwinds npm module provides a bidirectional communication...

19
3/18/2019 Integrating with SolarWinds – Ayehu Support Center https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 1/19 Ayehu Support Center > Working with Ayehu Next Generation > Modules and Integrations Integrating with SolarWinds Kiril Shmukler Updated 4 months ago Follow Applies To: Ayehu NG Requirements Supported Version Supported Ayehu NG version: Ayehu NG 1.0 (Build 163+) with Solarwinds NPM Module license Supported SolarWinds versions (MS SQL Server Database): SolarWinds NPM 11.5 and Above SolarWinds SAM 6.2 and Above User Access The user of the integration module has DB_Owner permissions on the SolarWinds MS SQL Server database. Server Time Search Articles in this section

Upload: others

Post on 10-Mar-2020

21 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 1/19

Ayehu Support Center > Working with Ayehu Next Generation > Modules and Integrations

Integrating with SolarWinds

Kiril ShmuklerUpdated 4 months ago

Follow

Applies To: Ayehu NG

Requirements

Supported Version

Supported Ayehu NG version:

Ayehu NG 1.0 (Build 163+) with Solarwinds NPM Module license

Supported SolarWinds versions (MS SQL Server Database):

SolarWinds NPM 11.5 and AboveSolarWinds SAM 6.2 and Above

User Access

The user of the integration module has DB_Owner permissions on the SolarWinds MS SQL Serverdatabase.

Server Time

Search🔍

Articles in this section ▾

👤

Page 2: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 2/19

Times and time zones on Ayehu NG and SolarWinds database servers must be synchronized.

Module Operation

The SolarWinds NPM Module provides a bidirectional communication channel between SolarWindsNPM and Ayehu NG.  The connection between Ayehu NG and SolarWinds is performed directly withthe SolarWinds backend MS SQL Server database. Once the Module is defined and available, AyehuNG pulls new alerts and alert updates, translates them into incidents and displays them as incidents.Alerts recovered in the SolarWinds NPM console trigger incident closure in Ayehu NG.

Module Installation

Execute the installation file and follow the installation wizard instructions.

Requirements

1. One of the following operating systems:

Windows 2012 Server R2 64-bit

Windows 2016 Server R2 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 Ayehu NG

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 harddrive for Ayehu NG SolarWinds NPM Server. Then click Next.

4. Continue the installation as described in the Installation Guide.

Installation Process – Update

For instances already running Ayehu NG 1 and above, proceed with the following steps to add theSolarWinds integration module:

1. Execute AyehuNG.exe, and click Next. To run the installer as the Administrator, right-click theexecutable and select “Run as administrator”

Page 3: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 3/19

2. Choose Modify and click Next.

3. Expand Integration Packs branch and select This feature will be installed on local harddrive for Ayehu NG SolarWinds NPM Server. Then click Next.

4. Click Install.

5. A success notice will appear at the end of the installation process.

Module Creation and Configuration

 Module General Settings

In Ayehu NG, access Configuration >Modules, and click New.

In the New Module configuration window:

Define the module

Under Name enter the name you’d like to call this module (e.g. SolarWinds).

If desired, add a description of the module in the Description field.

Page 4: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 4/19

des ed, add a desc pt o o t e odu e t e esc pt o e d.

Under Type select SolarWinds NPM.

For Mode select Local if the SolarWinds module is local to your instance, and Remote ifit is installed remotely.

Check the Monitor checkbox if you want the SolarWinds module to be monitored bythe Comm Server and its status reported.

Define Module Instances

You can have multiple SolarWinds instances defined under the same Module, for highavailability and redundancy purposes.

For each instance, you must select a Device from the drop-down where the integrationmodule was installed and enter the Port through which it will communicate. 

If you have not predefined a Device within Incident Configuration, you may clickthe plus sign to add a new Device directly from this screen (Enter in a Name and IPAddress within the configuration, where the Name must be resolvable within DNS(FQDN) or IP Address)

                                   

Once you’ve defined the module and any module instances as desired, click Save.

Define Module Connection Parameters 

After clicking Save once the previous sections have been defined, click on the downarrow in the Connection Parameters section

                          

Connection Parameters

Alternate SolarWinds Database Name

For SolarWinds database installations not using the default database name "SolarWindsOrion",please reference the following support article for instructions on how to connect with a customdatabase name:

Connecting to SolarWinds using custom DB name

Page 5: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 5/19

In the Device field, select from the drop-down where the SolarWinds MS SQL database isinstalled. 

If you have not predefined a Device within Incident Configuration, you may click the plussign to add a new Device directly from this screen (Enter in a Name and IP Addresswithin the configuration, where the Name must be resolvable within DNS (FQDN) or IPAddress)

                 

In the Port field, enter the port through which the SolarWinds MS SQL database is accessed.

Default: 1433

In the User name and Password fields, enter db_owner credentials

Note: Lower DB permissions may be assigned based on functionality requirements fromreading, creating and/or updating alerts.

Click Test Connection. If the connection was tested successfully, proceed to the next step -Forms. Otherwise, refer to the Troubleshooting section and search for your error.

Click Save again to complete this section of the configuration

Form

Once the SolarWinds module has been fully defined, you may now enable the module to monitor foralerts and define the filtering and mapping options.  To do this, click on the expand icon (upper rightcorner) in the module definition screen.

Page 6: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 6/19

From the Forms tab, a single row displaying the name Default should be listed.  Click the binocularsicon to discover fields associated with SolarWinds alerts.

Once discovery is complete the icon will change from binoculars to circular arrows to denote thatfields have been discovered.

Check the box in the Monitoring column (third column from the left in the table) in order totell Ayehu NG to monitor for alerts.

By default the Execute Workflow on Every Update checkbox will also be checked

When checked, every time an alert is updated the rule base is checked to find amatching rule.

By default the Bypass Incident Check is not checked.

When checked, incoming alerts are processed but an Ayehu NG incident is not created.

The Monitoring Interval will be automatically filled with 10, which means that every 10seconds Ayehu NG will reach out to SolarWinds to check for updates. In a high volumeenvironment, we recommend you change this to anywhere between 30 and 60 seconds.

Filters

In the Filters window you may determine which alerts are discovered. You can create several filters,each containing a number of conditions. The operator between multiple filters is “Or” and theoperator within a filter is “And”. To get all requests of a specific form do not create any filters.

Page 7: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 7/19

operator within a filter is And . To get all requests of a specific form do not create any filters.

While still on the Forms tab, click on the default to select it, then click the Filters tab. 

In the Name column on the Filters table enter the name of the filter you want to create theneither hit ENTER key or click the check-mark icon to display the Filter Columns section. 

In the Filter Columns table:

In the Name column select one of the discovered SolarWinds alert fields to base thefiltering on. 

In the Relation column choose the type of relationship you want in the filter. Possibleoptions are Equals, Contains, and Starts with, but may be limited based on the field typechosen.

In the Value column choose the values to capture with this filter. In our case we want toget all high priority issues so we will choose High as the value.

Mapping

In the Mapping window you may translate SolarWinds properties into Ayehu NG Incidents.

The window is divided into three sections: Fields, Severity, and State.

Page 8: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 8/19

Fields

In this section you can translate SolarWinds properties into Ayehu NG variables.  The SolarWindsproperties list (Integration column) is updated automatically based on the discovery complete in aprior step.

 

Page 9: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 9/19

To add a field, click on an empty row in the table and select the field name from the drop down list.To remove a field, click on the X.

Severity

At the moment, you may only assign a static severity with SolarWinds alerts:

Static Severity: All alerts open an Ayehu NG incident with the selected static severity.

 

State

At the moment, you may only assign a static state with SolarWinds alerts:

Static State: All alerts open an Ayehu NG incident with the selected static state. When using a staticstate, closing/clearing an alert in SolarWinds does not close the Ayehu NG incident, and vice versa.

 

Activities

Page 10: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 10/19

To use the SolarWinds activities, open the Workflow Designer by opening the top navigation barand clicking on it under the Builder section. Search, browse or click + to find the desired activity andadd it to the design area.

 

SolarWinds NPM Acknowledge Alert

This activity acknowledges an active alert in SolarWinds.

 

Output:  Success/Failure

Page 11: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 11/19

 

SolarWinds NPM Add Note

This activity adds a note to an active alert in SolarWinds.

 

Output:  Success/Failure

Page 12: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 12/19

SolarWinds NPM Get Alert

This activity gets a list of active SolarWinds alerts according to the selected criteria.

Select the Output format and Output type depending on how you’d like to see the valuesdisplayed.

Filters are applied (by the activity) to alerts which contain values in the specified field.

Since retrieving the translation of fields’ data from SolarWinds might take a while, it is recommendedthat the filters of this activity are as specific as possible.

 

Output: A result set or json message of all matching alerts.

Page 13: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 13/19

SolarWinds NPM Get Node

This activity gets a list of nodes according to selected criteria. 

Filters are applied (by the activity) to nodes which contain values in the specified field.

Since retrieving the translation of fields’ data from SolarWinds might take a while, it is recommendedthat the filters of this activity are as specific as possible.

 

Output: A result set of all matching nodes.

Page 14: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 14/19

SolarWinds NPM Manage Node

This activity sets a node in "Managed" state and allows the option to schedule the start at specificdate/time.  When Scheduled is unchecked the node is immediately set to "Managed" state uponexecution.

 

 

Output: Success/Failure

Page 15: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 15/19

SolarWinds NPM Unacknowledge Alert

This activity un-acknowledges an active alert in SolarWinds.

 

Output: Success/Failure

Page 16: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 16/19

SolarWinds NPM UnManage Node

This activity sets a node in “Un-managed” state.

Requires selecting the Time interval from the drop-down list and for all options but "No Limit"entering the time value within the Recurrence field.  Also allows options to schedule action whenScheduled is checked and a specific date and time is entered.

 

Output: Success/Failure

Page 17: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 17/19

Troubleshooting

Module is down

If the Module is down, go to Configuration -> Modules->Integrations

Open at SolarWinds NPM module Settings.

Open at Connection Parameters and click on Test Connection.

If the test is successful – SolarWinds NPM module in status “Up” when test connection issuccessful and that you license contains "SolarWinds NPM" in the Modules section

If the test fails – error message “Failed Test Connection” displayed confirm the connectionparameters were entered correctly then continue with troubleshooting section

 

Error: “A network-related or instance-specific error occurred while establishing a connection to SQLServer”.

Page 18: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 18/19

Explication and/or Solution: No connectivity to the database server, or the device that wasselected in the Connection Parameters section either does not have SolarWinds NPM databaseinstalled or SolarWinds NPM services are not running on it.

 

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. Toresolve the case, verify the following:

1. The port you specified in the module connection parameters section is the configured TCP/IPport to connect to the SolarWinds database (verify the port is open).

2. If using a custom SolarWinds database name, the steps from support article (Connecting toSolarWinds using custom DB name) were completed and module was restarted.

3. The correct user name and password to connect to the SolarWinds module are used in themodule’s connection parameters.

 

Activity Error

Error: An activity displays the error “Unable to communicate with SolarWinds NPM Module”.

Root Cause and/or Solution: SolarWinds NPM Module is in Down status, check troubleshootingstep “Module is down”.

 

Was this article helpful?

✓ Yes ✕ No

0 out of 0 found this helpful

Have more questions? Submit a request

Return to top ⬆

Page 19: Integrating with SolarWinds · The SolarWinds NPM Module provides a bidirectional communication channel between SolarWinds NPM and Ayehu NG. The connection between A yehu NG and SolarWinds

3/18/2019 Integrating with SolarWinds – Ayehu Support Center

https://support.ayehu.com/hc/en-us/articles/360011421573-Integrating-with-SolarWinds 19/19

Recently viewed articles

Integrating with Slack

Related articles

Integrating with BMC Remedyforce

Integrating with Ayehu NG Web Services

Integrating with Slack

Integrating with ServiceNow

Integrating with SolarWinds

Comments0 comments

Be the first to write a comment.

Ayehu Support Center