|Author||VMware and Aplura, LLC.|
|Vendor Products||VMware Carbon Black Cloud|
|Has index-time operations||false|
|Creates an index||false|
|Implements summarization||If configured, the Data model will generate accelerations.|
VMware Carbon Black Cloud allows a Carbon Black Cloud administrator or analyst to interact with the CBC product.
Access questions and answers specific to VMware Carbon Black Cloud at https://answers.splunk.com . Be sure to tag your question with the name of the app: Carbon Black Cloud Splunk App.
Support Offered: Splunk Answers, Community Engagement, Carbon Black Support
View all API and integration offerings on the Developer Network along with reference documentation, video tutorials, and how-to guides.
Use the Developer Community Forum to discuss issues and get answers from other API developers in the Carbon Black Community.
Report bugs and change requests to Carbon Black Support.
If a support representative asks for it, a support diagnostic file can be generated. Use the following command to generate the file. Send the resulting file to support.
$SPLUNK_HOME/bin/splunk diag --collect=app:vmware_app_for_splunk
Because this App runs on Splunk Enterprise, all of the Splunk Enterprise system requirements apply.
The Splunk CIM Add-on is a required pre-requisite.
Note: Installing the VMware CBC TA or IA on the same node as the App may result in instability or errors.
The VMware Carbon Black Cloud App offers two methods to ingest various data. More detailed configuration instructions are included in Table 1 below.
Configure the VMware Carbon Black Cloud Event Forwarder to stream data into an AWS S3 bucket
Use the AWS Add-on for Splunk to pull the data from AWS S3 into Splunk
Deploy the Apps and/or Add-ons per the Deployment Guide above.
Create the index(s) for your data
One index for the Carbon Black Cloud data
One index for the results of the Alert Actions
Navigate to the Administration > Application Configuration menu, VMware CBC Base Configuration tab.
Configure a proxy if needed from the Proxies tab
If you are using the Event Forwarder to ingest Alerts and Events, configure the forwarder and AWS add-on for S3, setting the index to the event type for data ingest specified in step 3. Details on this are in a later section Configuring Event Forwarder & S3 Inputs.
If you are using the built-in inputs, alert actions, or commands you will need to configure API token information for each organization and access level. View the Authorization section below for details.
If using the Alerts API instead of the Event Forwarder, use the Alerts Inputs tab to configure the types of Alerts to ingest. Select the API Token configured in the previous step and with the permissions specified in Table 1 below
You can use the Enrich CB Analytics Events Alert Action to automatically fetch Enriched Events following a CB Analytics Alert. Enriched Events provide valuable alert context such as the process _cmdline.
First, configure the Enrich CB Analytics Events Alert Action from the Alert Actions tab.
Then open the Splunk > Alerts menu, find the included CB Analytics - Ingest Enriched Events Splunk Alert, and add the VMwareCBC Enrich CB Analytic Events Alert Action.
To ingest Audit Logs, select an API Token configured at step 6 on Audit Log Inputs tab
To ingest Live Query results, select an API Token configured at step 6 on Live Query Inputs
To ingest vulnerability assessment information, select an API Token configured at step 6 on the Vulnerabilities Inputs tab
Add API tokens in the Alert Actions & Custom Commands tabs
A description of each can be found in Tables 2 and 3
Note: The Alert Actions tab defaults to showing 10 rows. Change to 20 rows to see all alert actions at once.
The Administration > Application Health Overview menu shows errors during processing and can be very useful during troubleshooting
The Administration > Application Usage menu provides insights into which Splunk users are using the app
For built-in data inputs, alert actions, and commands, create API Keys with the correct permissions in the Carbon Black Cloud and then configure Splunk to use those keys.
Identify the built-in data inputs, alert actions, and commands you intend to use.
Reference Tables 1, 2, and 3 below to identify the required API Key Access Levels and RBAC Permissions.
Generate API Keys in the Carbon Black Cloud console under Settings > API Access. Refer to the VMware Carbon Black Cloud Authentication Guide for additional guidance.
Access Level: If you are using any functions that require an Access Level Type Custom, create a Custom Access Level with the with the permissions required for the Inputs and Actions you want to use. The tables below list the necessary permissions that must be included in your Custom Access Level for each Action.
API Keys: You may need multiple API Keys depending on the Actions you want to use because a different API key is required for each Access Level Type used (Custom, API, Live Response).
For Custom Access Levels create one API key with Access Level set to Custom, then select the Access Level you created
If needed, create one API key with the Access Level set to Live Response
If needed, create one API key with the Access Level set to API
On the Splunk API Token Configuration tab, enter the API information and give the record a meaningful API Name. Youll use this to configure Alert Inputs and Actions.
Table 1: Access Level Permissions for Data Inputs
|Inputs||Description||Access Level and Permissions||Data Schema|
|Alerts API||Recommendation is to use the event forwarder to ingest alerts when possible. Otherwise, alerts can be ingested via the Alerts API.||Custom
|Audit Logs Inputs||Carbon Black Cloud Audit Logs, such as when a user signs-in or updates a policy||API or Live Response||Audit Log Schema|
|Live Query Inputs||LiveQuery Run and Result data. Requires VMware Carbon Black Cloud Audit & Remediation||Custom
||LiveQuery Result Schema|
|Vulnerabilities Inputs||Vulnerability assessment data including identified CVEs, metadata, and impacted assets. Requires VMware Carbon Black Cloud Workload Protection||Custom
Table 2: Access Level Permissions for Adaptive Responses
|Alert Action Name||Action Descriptions||Access Level Type and Permission|
|Add IOCs to a Watchlist||Adds specified IOC(s) to a specified report in a watchlist. Requires VMware Carbon Black Cloud Enterprise EDR||Custom
|Get File Metadata||Retrieves file metadata, such as the number of devices the hash was observed on, from the specified sha256 file hash. Requires VMware Carbon Black Cloud Enterprise EDR||Custom
|Kill Process||Remotely kills a process on the devices specified in the search||Live Response|
|List Processes||Remotely lists processes on the specified device. Example: If an Analytics alert did not terminate the process, identify if the suspicious process is still running on the device.||Live Response|
|Quarantine Devices||Quarantines the specified device and prevents suspicious activity and malware from affecting the rest of your network. The device can only communicate with Carbon Black Cloud until unquarantined||Custom
|Remove IOCs from a Watchlist||Removes IOCs from a report in a watchlist. Requires VMware Carbon Black Cloud Enterprise EDR||Custom
|Un-quarantine||Removes the specified device(s) from the quarantined state, allowing them to communicate normally on the network.||Custom
|Dismiss Alert||Dismisses the specified alert in Carbon Black Cloud||Custom
|Enrich CB Analytics Events||Searches and ingests the Enriched Events that are associated with the CB Analytics alert. Intended for use with the CB Analytics - Ingest Enriched Events Splunk Alert. Requires VMware Carbon Black Cloud Endpoint Standard||Custom
|Process GUID Details||Fetches the most up to date, detailed metadata associated with the specified process GUID. Example: learn more about the process that triggered a Watchlist alert, such as parent and process cmdline Example: learn more about the process that triggered a Watchlist alert.||Custom
|Run Livequery||Creates a new LiveQuery Run. Example: Automatically get the logged in users on an endpoint after a credential scraping alert. Requires VMware Carbon Black Cloud Audit & Remediation||Custom
|Update Device Policy||Updates the policy associated with the specified device. Example: move a device to a more restrictive policy during incident investigation||Custom
|Ban Hash||Prevents a sha256 hash from being executed in Carbon Black Cloud. Currently requires Endpoint Standard; Enterprise EDR support expected CY21Q2.||Custom
Table 3: Access Level Permissions for Commands
|Custom Command Name||Description||Access Level and Permission|
|VMware CBC Device Info (
||Gets real-time information about a CBC device. See Custom Commands section below for usage and best practices||Custom
|VMware CBC Hash Info (
||Gets real-time information about a sha256 hash, such as the number of devices that observed the file. Requires Enterprise EDR.||Custom
- New Features
- Data Input - Audit Logs
- Data Input - Live Query Results
- Data Input - Vulnerability Assessment
- Dashboard - Devices
- Dashboard - Processes
- Dashboard - Vulnerabilities
- Alert Action - Run Live Query
- Alert Action - Dismiss Alert
- Alert Action - Update Device Policy
- Alert Action - Process GUID Details
- Alert Action - Ban Hash
- Alert Action - Enrich CB Analytic Events
- Command - CBC Device Info
- Command - CBC Hash Info
- Events Dashboard performance improvements
- Update Top 10 CB Analytics panel
- Stability improvements in Alerts Inputs
Splunk AppInspect evaluates Splunk apps against a set of Splunk-defined criteria to assess the validity and security of an app package and components.
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 and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.