splunk
Ubiquiti UNMS add-on for Splunk
Splunk Labs
Overview
Details
This add-on collects data from Ubiquiti UNMS via REST API
SUPPORT / REQUESTS:
- Contact via email: djackson@splunk.com
- Hours: Weekday business hours (Australia, east coast)
INSTALLATION:
- The add-on needs to be installed on a heavy forwarder only. Either install via Splunk web UI or extract in $SPLUNK_HOME/etc/apps directory.
- After installation, go to app configuration menu and add-on settings and enter UNMS address / hostname and a token (see below for token details).
- Go to app inputs and enable the ones you want.
SUPPORT / CONFIGURATION:
- Tested with UNMS 1.1.6 & 1.2.7
- You will need the UNMS IP address / hostname and a token.
- To get a UNMS token, login to UNMS, go to settings, then users. Under API tokens, select "CREATE NEW API TOKEN." Make sure you copy this to clipboard (and save somewhere).
- This add-on currently only runs GET requests (it does not make any changes via UNMS).
SOURCETYPES:
- For a complete list of available data from UNMS, navigate to: https://<unms_host>/nms/api-docs/
- Current sourcetypes (6) available in add-on:
unms:sites - Manage sites and clients (former endpoints), their pictures and network structure.
unms:devices - Configuration and monitoring for all devices.
unms:devices:interfaces - Return list of device interfaces.
unms:datalinks - Data Links between devices.
unms:outages - View devices outages.
unms:logs - View devices log lines.
CONTRIBUTORS:
Dean Jackson
Release Notes
Version 1.2.2
Nov. 11, 2020
Changes/fixes:
- New icon
- Fixed configuration / add-on settings, there were invalid fields shown in version 2.2.1
- Tested with UNMS 1.2.7
Version 1.2.1
July 2, 2020
Changed icons.
Version 1.2.0
May 20, 2020
Initial release.