SolarWinds
SolarWinds
Solar Winds is a NOC monitoring tool
The steps of this plugin have been tested on SolarWinds Orion SAM 6.6 for Server and Application Monitoring (SAM)
Prerequisites:
Solarwinds instance and access details.
Running Solarwinds-Orion-SAM-6.6 instance with valid access details.
Get Alerts
Description
The plugin is designed to get alerts of particular type either All Alerts or only Active Alerts.
Prerequisites: Solarwinds instance and access details
Configurations
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
2
Server Name
Provide the Solarwinds instance name/IP/hostname.
Port
The port number of the Solarwinds instance should be provided. Port number should only be an integer.
3
Username
The username of Solarwinds instance to authenticate.
Password:
4
Checkbox: Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
5
Password
The Password to the username to authenticate. Password is encrypted and not stored in the .psw file. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.
If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.
Input:
No.
Field Name
Description
Input:
1
Alert Type(String)
Select Alert Type either All or Active. This field is mandatory.
2
Button: Get Fields
Clicking on this button populates Alerts fields/attributes of the particular selected Alert Type in the ‘Field Name’ Field in the table below.
3
Field Name(String)
The name of the particular field/attribute that has to be fetched should be selected. Multiple fields can be selected from the list displayed on click. The selected fields will be the output parameters of this plugin. Choosing at least one field/attribute is mandatory.
(e.g. for Active Alerts we could fetch fields/attributes such as,
AlertActiveID, AlertObjectID,Acknowledged, AcknowledgedBy, AcknowledgedDataTime, AcknowledgedNote, TriggeredDateTime, TriggeredMessage, NumberOfNotes, LastExecutedEscalationLevel
(e.g. for All Alerts we could fetch fields/attributes such as,
AlertObjectID, AlertID, EntityUri, EntityType, EntityCaption, EntityDetailsUrl, EntityNetObjectId, RelatedNodesUri, RelatedNodeUrl, RelatedNodeId, RelatedNodeDetsilsUrl, RelatedNodeCaption, RelatedEntityUri, RelatedEntityType, TriggeredCount, LastTriggeredDateTime, Context, AlertNode etc.)
- Get Fields button does not work for the previous step fields. The button only works with static values and environment variables.
- Every time the “Alert Type field changes. The “Get Fields” button needs to be clicked and the field list needs to be updated accordingly.
Get Nodes
The plugin is designed to get nodes configured on SolarWinds.
Prerequisites: SolarWinds instance and access details.
Configurations
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
2
Server Name
Provide the Solarwinds instance name/IP/hostname.
Port
The port number of the Solarwinds instance should be provided. Port number should only be an integer.
3
Username
The username of Solarwinds instance to authenticate.
Password:
4
Checkbox: Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
5
Password
The Password to the username to authenticate. Password is encrypted and not stored in the .psw file. Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.
If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.
Input:
No.
Field Name
Description
Input:
1
Button: Get Fields
Clicking on this button populates fields/attributes in the ‘Field Name’ Field in the table below for all the Server and Application Nodes.
2
Field Name (String)
The name of the particular field/attribute that has to be fetched should be selected in the table. Multiple fields can be selected from the list displayed above upon click. The selected fields will be the output parameters of this plugin. Choosing at least one field/attribute is mandatory.
(e.g. for Nodes we could fetch fields/attributes such as,
NodeID, NodeName, DisplayName, Category, NodeDescription, IP Address to name just a few.)
Note:-
- Get Fields button does not work for the previous step fields. The button only works with static values and environment variables.
- Every time the “Get Fields” button needs to be clicked and the field list needs to be updated accordingly.
Acknowledge Alerts
Description
The plugin is designed to Acknowledge Alerts.
Prerequisites: Solarwinds instance and access details.
Configurations
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection configuration:
2
Server Name
Provide the Solarwinds instance name/IP/hostname.
3
Port
The port number of the Solarwinds instance should be provided. Port number should only be an integer.
4
Username
The username of Solarwinds instance to authenticate.
Password:
5
Checkbox: Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
6
Password
The Password to the username to authenticate. Password is encrypted and not stored in the .psw file.Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.
If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.
Input:
No.
Field Name
Description
Input:
1
AlertObjectID
AlertObjectID of the alert to be acknowledged. This field is not mandatory.
2
Button: GetAlertObjectID
Clicking on this button populates the AlertObjectID’s of the Alerts. This field is not mandatory.
3
Acknowledge Note
Acknowledge Note for the alert to be acknowledged. This field is not mandatory.
Note:-
- Get Fields button does not work for the previous step fields. The button only works with static values and environment variables.
- Every time the “Get Fields” button needs to be clicked and the field list needs to be updated accordingly.
Output:
No.
Field Name
Description
1
Result
This is an output field to hold the result of the successful plugin execution (AlertObjectID has been handled successfully).
Default Value is “Result” when no values for this field are passed.
Execute SWQL Query
The plugin is designed to execute Solarwinds SWQL queries
Prerequisites:
In addition to the general perquisites mentioned at SolarWinds plugin level, SWQL studio.
Configurations
No.
Field Name
Description
1
Step Name
Name of the step. This name has to be unique in a single workflow.
Connection:
2
Server Name
Provide the Solarwinds instance name/IP/hostname.
3
Port
The port number of the Solarwinds instance should be provided. Port number should only be an integer.
4
Username
The username of Solarwinds instance to authenticate.
Password:
5
Checkbox: Accept Value as variable/static
Leave checkbox unchecked to accept Password value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Password field to appear as Text box.
6
Password
The Password to the username to authenticate. Password is encrypted and not stored in the .psw file.
Password is entered using a widget. The widget handles both Text Var(static value or environment variable) and Combo(drop down containing values from previous steps). This field is mandatory.
If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps.
Button:
7
Test Connection
Test connection with username and password provided. Verifies whether the connection is available or not.
Server name, Port number, username and password are mandatory.
Note: Test Connection Button does not work if the connection fields are populated from previous steps.
Input Tab:
No.
Field Name
Description
Input Field:
1
SWQL Query
The SWQL Query based on which required SolarWinds data will be retrieved. This field is mandatory. SWQL query should be valid.
Following are some sample queries on different objects,
- select top 1000 AlertActiveID, AlertObjectID, Acknowledged, AcknowledgedBy, AcknowledgedDateTime, AcknowledgedNote, TriggeredDateTime, TriggeredMessage, NumberOfNotes, LastExecutedEscalationLevel From Orion.AlertActive
- SELECT AlertHistoryID, EventType, Message, TimeStamp, AccountID, AlertActiveID, AlertObjectID, ActionID FROM Orion.AlertHistory
- SELECT NodeID, Caption, IPAddress, Status FROM Orion.Nodes ORDER BY Caption
Common Buttons:
No.
Field Name
Description
Buttons:
1
OK
On click of this button. It will check the field values. If any required field values are missing then it will display validation error message.
If all the required field values are provided then it will save the field values.
2
Cancel
On click of this button, it will cancel the window and do not save any values