Splunk SMS & voice alerts- integration manual
Here we describe how to setup Splunk with SMSEagle for SMS & voice (ring and text-to-speech) alerting. The integration uses SMSEagle Hardware SMS Gateway. The process is easy and should take 10-15 minutes to complete.
SMSEagle is an offline hardware SMS gateway. Therefore no external connection to 3rd party system is required. All notifications are generated on-premise and sent directly to a cellular network. This solution can be used in secure installations without Internet access.
SMSEagle Setup
- Create a new user in SMSEagle (menu Users > + Add Users, user access level: “User”).
- Grant API access to the created user:
- click Access to API beside the newly created user
- Enable APIv2
- Generate new token (copy it for later use)
- Add access permissions in section APIv2 Permission for: Send SMS, Make a call
- Save settings
Splunk Setup
- Visit plugin site at Splunkbase. Download tar archive.
- Go to Splunk -> Manage Apps -> Choose File to Upload and Done.
- Restart Splunk
- Go to Apps -> SMSEagle -> Configuration
- Enter SMSEagle URL.The URL should be in form: IP.ADDRESS.OF.SMSEAGLE (for example: 192.168.0.150 or sms.mydomain.com)
- Choose APIv2 as integration method
- Enter SMSEagle API token
That’s it! 😊
Using plugin
Perform a search in Splunk and then navigate to : Save As -> Alert -> Trigger Actions -> Add Actions -> SMSEagle SMS Alerts.
On this dialogue you can enter:
• “Message” – contains SMS text. You may use Splunk custom alert action tokens in this field. The action tokens will be replaced with values from alert. More information can be found in Splunk docs under topic “Advanced options for working with custom alert actions”.
• “Phone Number” or “Phonebook Group name”. “Phone Number” should be in format: country code + number, for example: +1XXXXXXXXXXXXX (Without any _ or any other symbol). “Phone Number” can also be a comma delimited list of numbers. “Phonebook Group name” is a name of a group created in SMSEagle Phonebook.
• “High Priority” – if set to yes, message will have a high priority in SMS sending queue
• “Unicode” – if the Message contains national characters, set “Unicode” to yes
• “Flash” – “No” for normal SMS, “Yes” for flash SMS
• “Date” – (optional) enter date in YYYYmmDDHHMM to schedule it to a particular GMT date time.
Logging
Browse to See triggered Alerts: Settings -> Alert Actions -> SMSEagle SMS Alerts -> View Log Events
Or you can search logs of alerts directly in Splunk : index=_internal sourcetype=”ta:smseagle:sms:alerting:log” action_name=sms_eagle
Explore SMSEagle Demo device
SMSEagle is a hardware & software solution that guarantees a swift delivery of your messages to designated recipients, whether it’s for notifications, alerts, or important updates.
After registering to a demo you get a remote access to our physical device NXS-9750.
- 14-days free trial
- Access to over 20 functionalities
