Moogsoft Docs

SolarWinds LAM Reference

This is a reference for the SolarWinds LAM . The SolarWinds LAM configuration file is located at $MOOGSOFT_HOME/config/solarwinds_lam.conf

It contains the following sections and properties:

Monitor

name : Name of the LAM.

Type : String
Required : Yes
Default : "SolarWinds Monitor" . Do not change.

class : Class of the LAM.

Type : String
Required : Yes
Default : "CSolarWindsMonitor" . Do not change.

targets : Top-level container for defining one or more target SolarWinds sources. You can specify the configuration for each target. If you don't specify a request_interval the target uses the globally defined interval.

Type : JSON Object
Required : Yes
Default : N/A

request_interval : Length of time to wait between requests, in seconds. You can override this value by setting request_interval in individual targets.

Type : Integer
Required : Yes
Default : 60

url : SolarWinds request URL including host and port.

Type : String
Required : Yes
Default : " https://0.0.0.0:17778/SolarWinds/InformationService/v3/Json/Query "

user : Username of the account used to connect to your SolarWinds server.

Type : String
Required : Yes
Default : N/A

password : Password of the account used to connect to your SolarWinds server.

Type : String
Required : If you are not using encrypted_password
Default : N/A

encrypted_password : If you are using an encrypted password, enter it into this field and comment the password field. SolarWinds LAM uses either password or encrypted_password . If you specify both, it uses the encrypted_password value. See Moog Encryptor for more information.

Type : String
Required : If you are not using password
Default : N/A

timeout : Length of time to wait before halting a connection or read attempt, in seconds.

Type : Integer
Required : Yes
Default : 120

disable_certificate_validation : Specifies whether to disable SSL certificate validation. If set to true t he data transmission between Moogsoft AIOps and your SolarWinds server is not protected by the encryption protocol.

Type : Boolean
Required : Yes
Default : False

path_to_ssl_files : Path to the directory that contains the SSL certificates. You can use a relative path based upon the $MOOGSOFT_HOME directory. For example the default config indicates $MOOGSOFT_HOME/config .

Type : String
Required : If disable_certificate_certification = false
Default : "config"

server_cert_filename : Name of the SSL root CA file. Must reside in the location contained in path_to_ssl_files

Type : String
Required : If disable_certificate_certification = false
Default : N/A

client_key_filename : Name of the SSL client key file.

Type : String
Required : If disable_certificate_certification = false
Default : N/A

client_cert_filename : Name of the SSL client certificate.

Type : String
Required : If disable_certificate_certification = false
Default : N/A

ssl_protocols : Sets the allowed SSL protocol.

Type : Array
Required : If disable_certificate_certification = false
Valid protocols : SSLv3, TLSv1, TLSv1.1, TLSv1.2
Default : [ "TLSv1.2" ]

overlap_identity_fields : A list of payload tokens the LAM uses to identify duplicate events when SolarWinds returns all open events and not just updated events. After the requests_overlap period the LAM treats events with the same overlap_identity_fields as duplicate events. The LAM identifies duplicates for each payload event in the previous request only. Identification is b ased on the token names of the returned payload, not the mapped names. For example, including $signature refers to this value in the payload, not event.value("signature") .

Type : String
Required
: No
Default : [ "NodeID", "EventID", "EventTypeName", "Message" ]

requests_overlap : I f events meet the overlap_identity_fields matching criteria during this interval (in seconds), they are not t reated as duplicates. Used to ensure that Moogsoft AIOps does not miss valid events.

Type : Integer
Required : No
Default : N/A

request_query_params : Query to select SolarWinds events. Use the $from and $to properties to define the time period. Define t he date format in params_date_format . The LAM URL encodes the parameters.

Type : String
Required : If requests_overlap is enabled
Default : N/A
Example :

request_query_params :
{
	query :
	"SELECT NodeName, NodeID, MachineType, Vendor, NodeDescription, IPAddress, Location, Severity, EventID,
	ToLocal(EventTime) AS EventTime, NetworkNode, NetObjectID, EventTypes.Name AS EventTypeName,
	EventTypes.Notify AS EventNotify, Message, Acknowledged, NetObjectType 
	FROM Orion.Events 
	INNER JOIN Orion.Nodes ON NodeID=NetworkNode 
	INNER JOIN Orion.EventTypes ON Events.EventType=EventTypes.EventType 
	WHERE Events.EventTime>=ToLocal(\'$from\')  
	AND Events.EventTime<ToLocal(\'$to\') 
	ORDER BY Events.EventTime"                             
}

params_date_format : Date format to use in request_query_params properties $from and $to .

Type : String
Required : Yes
Default : "yyyy-MM-dd'T'HH:mm:ss"

enable_epoch_converter : Defines whether to use an epoch timestamp instead of a machine timestamp.

Type : Boolean
Required : Yes
Default : False

results_path : Location of the JSON results objects in the data structure.

Type : String
Required : Yes
Default : "results"

num_threads : Number of worker threads to use.

Type : Integer
Required : No
Default : The number of available CPUs, up to a maximum of 8

Agent

name : Identifies events the SolarWinds LAM sends to the Message Bus.

Type : String
Required : Yes
Default : "SolarWinds"

capture_log : Location of the SolarWinds LAM's capture log file. The capture log contains the raw data the LAM receives. See Configure Logging for more information.

Type : String
Required : No
Default : N/A

Log Config

configuration_file : File that specifies the configuration of the SolarWinds LAM's process log. The process log records the activities of the LAM as it ingests raw data. See Moogsoft AIOps Component Logs for more information.

Type : String
Required : No
Default : "$MOOGSOFT_HOME/config/logging/integrations.log.json"

SolarWinds LAMbot

The SolarWinds LAMbot file is located here:

$MOOGSOFT_HOME/bots/lambots/SolarWindsLam.js

It contains the following configurable property:

useNodeSeverity : Whether the Moogsoft AIOps event severity is defined by the SolarWinds node severity in addition to the event message content. If you set this to True, define the conditions in the LAMbot.

Type : Variable
Required : Yes
Default : False