icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.
Log4Shell Vulnerability: Information and guidance for you. Get resources.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Vectra SaaS Add-on for Splunk
SHA256 checksum (vectra-saas-add-on-for-splunk_100.tgz) fe8112c00e218ff727a54ff6e16878f7adef9018c888c665f17a4604cc7b93e4
To install your download
To install apps and add-ons from within Splunk Enterprise
  1. Log into Splunk Enterprise.
  2. On the Apps menu, click Manage Apps.
  3. Click Install app from file.
  4. In the Upload app window, click Choose File.
  5. Locate the .tar.gz file you just downloaded, and then click Open or Choose.
  6. Click Upload.
  7. Click Restart Splunk, and then confirm that you want to restart.
To install apps and add-ons directly into Splunk Enterprise
  1. Put the downloaded file in the $SPLUNK_HOME/etc/apps directory.
  2. Untar and ungzip your app or add-on, using a tool like tar -xvf (on *nix) or WinZip (on Windows).
  3. Restart Splunk.
After you install a Splunk app, you will find it on Splunk Home. If you have questions or need more information, see Manage app and add-on objects.

Flag As Inappropriate

splunk

Vectra SaaS Add-on for Splunk

Splunk Cloud
Overview
The Vectra SaaS Add-on for Splunk pulls account scoring and account detection data from the Vectra SaaS platform, does CIM mapping and maps the account scoring and account detection event fields to corresponding Vectra Syslog event fields.

Release Notes

Version 1.0.0
July 13, 2022

Vectra SaaS Add-on for Splunk

OVERVIEW

  • The Vectra SaaS Add-on for Splunk pulls account scoring and account detection data from the Vectra SaaS platform, does CIM mapping and maps the account scoring and account detection event fields to corresponding Vectra Syslog event fields.
  • Author - Vectra AI
  • Version - 1.0.0

COMPATIBILITY MATRIX

  • Splunk version: 8.1.x, 8.2.x and 9.0.x
  • Python version: Python3
  • OS Support: Linux (Centos, Ubuntu) and Windows
  • Browser Support: Chrome, Firefox

RELEASE NOTES

Version: 1.0.0

  • Added data collection for Vectra SaaS account scoring events.
  • Added data collection for Vectra SaaS account detection events.
  • Added CIM mapping for account detection events.
  • Mapped fields of Vectra SaaS API account scoring and account detection events to corresponding Vectra syslog event fields.

RECOMMENDED SYSTEM CONFIGURATION

TOPOLOGY AND SETTING UP SPLUNK ENVIRONMENT

This Add-on can be set up in two ways:

  1. Standalone Mode
    • Install the Vectra SaaS Add-on for Splunk.
    • Follow all the steps mentioned in Add-on Setup section to configure the Add-on.
  2. Distributed Environment
    • Add-on resides on Search Head machine need not require any configuration here.
    • Add-on needs to be installed and configured on the Heavy Forwarder system.
    • Execute the following command on Heavy Forwarder to forward the collected data to the indexer. /opt/splunk/bin/splunk add forward-server <indexer_ip_address>:9997
    • On the Indexer machine, enable event listening on port 9997 (recommended by Splunk).
    • Add-on needs to be installed on Search Head for CIM mapping.

NOTE : For the distributed environment, only indexes of the Forwarder would be shown in the input configuration page.

INSTALLATION

  • Follow the below-listed steps to install the Add-on from the bundle:
    • Download the App package.
    • From the UI navigate to Apps->Manage Apps.
    • In the top right corner select Install app from file.
    • Select Choose File and select the App package.
    • Select Upload and follow the prompts.

OR

  • Directly from the Find More Apps section provided in Splunk Home Dashboard.

OR

  • Download the App package.
  • Extract downloaded app package directly into $SPLUNK_HOME/etc/apps/ folder.

CONFIGURATION

Add-on Setup

  1. Configure the account from which the data needs to be collected. Detailed steps and information for Account Configuration can be found in Account section.
  2. Users can also configure settings corresponding to the Proxy or Logging in their respective sections.

Account

  • Navigate to the Vectra SaaS Add-on for Splunk-> Configuration -> Account tab, fill in the details asked and click "Save". Field descriptions are as below:.
Vectra SaaS Account parameters Description
Account name* Name of the account
Host Name* Vectra SaaS API client portal url without scheme (http:// or https://)
Client ID* Vectra SaaS API client id
Client Secret Key* Vectra SaaS API client secret key

Note: * denotes required fields

Proxy (Optional)

  • Navigate to Vectra SaaS Add-on for Splunk -> Configuration -> Proxy tab, fill in the details asked and click "Save". Field descriptions are as below:
Field Name Field Description
Enable Enable/Disable proxy
Proxy Type* Type of proxy
Host* Hostname/IP Address of the proxy
Port* Port of proxy
Username Username for proxy authentication (Username and Password are inclusive fields)
Password Password for proxy authentication (Username and Password are inclusive fields)

Note: * denotes required fields

Logging

  • Navigate to Vectra SaaS Add-on for Splunk -> Configuration -> Logging tab, select the prefered "Log level" value from the dropdown and click "Save".

Create Data Input

  • Navigate to Vectra SaaS Add-on for Splunk -> Inputs. Click on "Create New Input", one dropdown will open with options:
    • Account Scoring Input
    • Account Detection Input
  • Select an option and the pop-up will open accordingly.
  • Provide the required information related to input and click on Add to configure the input. Field descriptions are as below:

Account Scoring Input

Field Name Field Description
Name* Unique name for the data input
Interval* Time interval of input in seconds
Index* Index where data will be stored
Vectra SaaS Account* Account that you have configured in "Configuration" tab
Historical Data Checkbox to pull historical data

Note: * denotes required fields

Account Detection Input

Field Name Field Description
Name* Unique name for the data input
Interval* Time interval of input in seconds
Index* Index where data will be stored
Vectra SaaS Account* Account that you have configured in "Configuration" tab
Historical Data Checkbox to pull historical data

Note: * denotes required fields

UNINSTALL & CLEANUP STEPS

  • Remove $SPLUNK_HOME/etc/apps/TA-Vectra-SaaS
  • Remove $SPLUNK_HOME/var/log/Splunk/ta_vectra_saas_.log*.
  • To reflect the cleanup changes in UI, Restart Splunk Enterprise instance

TROUBLESHOOTING

General Checks

  • To troubleshoot Vectra SaaS Add-on for Splunk, check $SPLUNK_HOME/var/log/Splunk/ta_vectra_saas*.log or user can search index="_internal" source=*ta_vectra_saas*.log query to see all the logs in UI. Also, user can use index="_internal" source=*ta_vectra_saas*.log ERROR query to see ERROR logs in the Splunk UI.
  • Note that all log files of this Add-on will be generated in $SPLUNK_HOME/var/log/Splunk/ directory.
  • Add-on icons are not showing up: The Add-on does not require restart after the installation in order for all functionalities to work. However, the icons will be visible after one Splunk restart post installation.

Data Collection

  • If data collection is not working then ensure that the internet is active (On a proxy machine, if proxy is enabled).
  • Check ta_vectra_saas_account_scoring_input_<input_name>.log file for account scoring events, ta_vectra_saas_account_detection_input_<input_name>.log file for account detection events for any relevant error messages.

END USER LICENSE AGREEMENT

SUPPORT

Copyright: (c) 2022 Vectra AI, Inc. All rights reserved.


Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.