SolarWinds Orion

this readme file provides information and instructions on how to use the solarwinds connector, which allows you to retrieve information from solarwinds using swql queries the solarwinds connector allows you to retrieve data from solarwinds using swql queries with this connector, you can easily get solarwinds data into your turbine instance requirements to use the solarwinds connector integration, you will need access to a solarwinds instance knowledge of swql queries for more information, see the official solarwinds documentation a api token for the solarwinds instance capabilities the solarwinds connector provides the following capabilities get query (swql) retrieve alert list retrieve event list notes https //documentation solarwinds com/en/success center/sam/content/sam api poller methods htm configurations http bearer authentication authenticates using bearer token configuration parameters parameter description type required url a url to the target host ie " https //localhost 17778 " string required token the api token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get query (swql) use solarwinds query language (swql) to query your solarwinds orion platform for specific information endpoint url /solarwinds/informationservice/v3/json/query method get input argument name type required description parameters query string optional parameters for the get query (swql) action headers object optional http headers for the request headers user agent string optional http headers for the request headers host string optional http headers for the request headers accept string optional http headers for the request headers content type string optional http headers for the request headers content length string optional http headers for the request input example {"parameters" {"query" "select uri from orion pollers order by pollerid with rows 1 to 3 with totalrows"},"headers" {"user agent" "curl/7 20 0 (i386 pc win32) libcurl/7 20 0 openssl/0 9 8l zlib/1 2 3","host" "localhost 17778","accept" " / ","content type" "application/json","content length" "130"}} output parameter type description status code number http status code of the response reason string response reason phrase headers object http headers for the request response object output field response response totalrows number output field response totalrows response results array result of the operation response results uri string result of the operation output example {"status code" 200,"reason" "ok","headers"\ null,"response" {"totalrows" 13,"results" \[{},{},{}]}} retrieve alert list retrieves a list of alerts based on the filter values provided in the command arguments endpoint url /solarwinds/informationservice/v3/json/query method get input argument name type required description alert id array optional a comma separated list of alert ids type array optional a comma separated list of the type of property to monitor for example node, ipam iprequests, orion discoverylogs, apm component, ipam networks, orion nodesforecastcapacity, apm application, orion volumesforecastcapacity, orion nodesforecastcapacity, etc severity array optional a comma separated list of severity levels possible values are information, warning, critical, serious, and notice sort key string optional key by which the response will be sorted for example alertid, alertactiveid, alertobjectid, triggereddatetime, triggeredmessage, acknowledgeddatetime, engineid, name, objecttype, etc default is alertactiveid sort order string optional order by which the response will be sorted possible values are ascending and descending default is ascending page number optional the page number from which to retrieve alerts by default, the per page limit is 50 alerts you can change change this value in the limit argument default is 0 limit number optional the number of records to be retrieved default is 50 input example {"alert id" \[1,2,3],"type" \["ipam iprequests"],"severity" \["information"],"sort key" "alertid","sort order" "ascending","page" 0,"limit" 50} output parameter type description status code number http status code of the response reason string response reason phrase solarwinds object output field solarwinds solarwinds alert array output field solarwinds alert solarwinds alert alertactiveid number unique identifier solarwinds alert alertid number unique identifier solarwinds alert alertmessage string response message solarwinds alert alertobjectid number unique identifier solarwinds alert alertrefid string unique identifier solarwinds alert canned boolean output field solarwinds alert canned solarwinds alert configurationdescription string output field solarwinds alert configurationdescription solarwinds alert context string output field solarwinds alert context solarwinds alert enabled boolean output field solarwinds alert enabled solarwinds alert entitycaption string output field solarwinds alert entitycaption solarwinds alert entitynetobjectid string unique identifier solarwinds alert entitytype string type of the resource solarwinds alert entityuri string output field solarwinds alert entityuri solarwinds alert frequency number output field solarwinds alert frequency solarwinds alert instancesiteid number unique identifier solarwinds alert instancetype string type of the resource solarwinds alert lastedit string output field solarwinds alert lastedit solarwinds alert lasttriggereddatetime string time value solarwinds alert name string name of the resource solarwinds alert notifyenabled boolean output field solarwinds alert notifyenabled solarwinds alert objecttype string type of the resource output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "tue, 19 dec 2023 20 37 23 gmt"},"reason" "ok","json body" {"solarwinds" {"alert" \[]}}} retrieve event list retrieves a list of events on the filter values provided in the command arguments endpoint url /solarwinds/informationservice/v3/json/query method get input argument name type required description acknowledged boolean optional whether to retrieve events that are acknowledged if true, then retrieves all acknowledged events possible values are true and false event id array optional a comma separated ist of event ids event type array optional a comma separated list of event types for example warning, informational, node up, etc node array optional to retrieve events of specific nodes sort key string optional key by which the response will be sorted for example eventid, eventtime, message, timestamp, eventtypename, node, etc default is eventid sort order string optional order by which the response will be sorted possible values are ascending and descending default is ascending page number optional the page number from which retrieve events by default, the per page limit is 50 events you can change this value in the limit argument default is 0 limit number optional the maximum number of records to be retrieved default is 50 input example {"acknowledged"\ true,"event id" \[1],"event type" \["warning"],"node" \["win mv956au5bsn"],"sort key" "eventid","sort order" "ascending","page" 0,"limit" 50} output parameter type description status code number http status code of the response reason string response reason phrase solarwinds object output field solarwinds solarwinds event array output field solarwinds event solarwinds event acknowledged boolean output field solarwinds event acknowledged solarwinds event engineid number unique identifier solarwinds event eventid number unique identifier solarwinds event eventtime string time value solarwinds event eventtype number type of the resource solarwinds event eventtypename string name of the resource solarwinds event instancesiteid number unique identifier solarwinds event instancetype string type of the resource solarwinds event message string response message solarwinds event netobjectid number unique identifier solarwinds event netobjecttype string type of the resource solarwinds event networknode number output field solarwinds event networknode solarwinds event node string output field solarwinds event node solarwinds event timestamp array output field solarwinds event timestamp solarwinds event uri string output field solarwinds event uri output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "tue, 19 dec 2023 20 37 23 gmt"},"reason" "ok","json body" {"solarwinds" {"event" \[]}}} response headers header description example content length the length of the response body in bytes 140 content type the media type of the resource application/json date the date and time at which the message was originated tue, 19 dec 2023 20 37 23 gmt