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

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 VMware Carbon Black Cloud
SHA256 checksum (vmware-carbon-black-cloud_110.tgz) 62d96a4a60b6499d64edaf652bcc420892fd36def77c3e5e3bc3b24ac85c423a SHA256 checksum (vmware-carbon-black-cloud_103.tgz) 4674c4bcdde29184a6dcbe1fc714d127a9febcd11ff9be2ee8478c8df4a1f2b0 SHA256 checksum (vmware-carbon-black-cloud_100.tgz) 2be0fd86c90870dbef365cb13d85be53dbac248f2520085e5344eadf5784110d
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

VMware Carbon Black Cloud

Splunk AppInspect Passed
Admins: Please read about Splunk Enterprise 8.0 and the Python 2.7 end-of-life changes and impact on apps and upgradeshere.
The VMware Carbon Black Cloud App for Splunk is a single application to integrate your endpoint and workload security features and telemetry directly into Splunk dashboards, workflows and alert streams.

This application connects with any Carbon Black Cloud offering and replaces the existing product-specific Carbon Black apps for Splunk. This app provides a unified solution to integrate Carbon Black Cloud Endpoint and Workload offerings with Splunk Enterprise, Splunk Cloud, and Splunk Enterprise Security (ES). Out-of-the-box, this app provides holistic visibility into the state of your endpoints and workloads through customizable dashboards and alert feeds in Splunk.

For distributed Splunk environments, please use the Input Add-on (https://splunkbase.splunk.com/app/5333/) and the Technology Add-on (https://splunkbase.splunk.com/app/5334/).

VMware Carbon Black Cloud Documentation


About VMware Carbon Black Cloud

Author VMware and Aplura, LLC.
App Version 1.1.0
App Build 38
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.

Support and resources

Questions and answers

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.

Diagnostics Generation

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

Installation and Configuration

Software requirements

Splunk Enterprise system requirements

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.

Deployment Guide

Note: Installing the VMware CBC TA or IA on the same node as the App may result in instability or errors.

Data Onboarding

The VMware Carbon Black Cloud App offers two methods to ingest various data. More detailed configuration instructions are included in Table 1 below.

  • Event Forwarder

    • 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

  • Built-In Input

    • Use the VMware Carbon Black Cloud App (or Input Add-on via a Heavy Forwarder), which leverages VMware Carbon Black REST APIs to pull data into Splunk


  1. Deploy the Apps and/or Add-ons per the Deployment Guide above.

  2. Create the index(s) for your data

    1. One index for the Carbon Black Cloud data

    2. One index for the results of the Alert Actions

  3. Navigate to the Administration > Application Configuration menu, VMware CBC Base Configuration tab.

    1. Update the index names to those created above
  4. Configure a proxy if needed from the Proxies tab

  5. 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.

  6. 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.

  7. 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

    1. 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.

    2. First, configure the Enrich CB Analytics Events Alert Action from the Alert Actions tab.

    3. 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.

  8. To ingest Audit Logs, select an API Token configured at step 6 on Audit Log Inputs tab

  9. To ingest Live Query results, select an API Token configured at step 6 on Live Query Inputs

  10. To ingest vulnerability assessment information, select an API Token configured at step 6 on the Vulnerabilities Inputs tab

  11. Add API tokens in the Alert Actions & Custom Commands tabs

    1. A description of each can be found in Tables 2 and 3

    2. Note: The Alert Actions tab defaults to showing 10 rows. Change to 20 rows to see all alert actions at once.

  12. The Administration > Application Health Overview menu shows errors during processing and can be very useful during troubleshooting

  13. 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.

  1. Identify the built-in data inputs, alert actions, and commands you intend to use.

  2. Reference Tables 1, 2, and 3 below to identify the required API Key Access Levels and RBAC Permissions.

  3. 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.

    1. 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.

    2. 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).

      1. For Custom Access Levels create one API key with Access Level set to Custom, then select the Access Level you created

      2. If needed, create one API key with the Access Level set to Live Response

      3. If needed, create one API key with the Access Level set to API

  4. 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 orgs.alerts (Read) Alert Schema
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.manage (Read) LiveQuery Result Schema
Vulnerabilities Inputs Vulnerability assessment data including identified CVEs, metadata, and impacted assets. Requires VMware Carbon Black Cloud Workload Protection Custom vulnerabilityAssessment.data (Read) Vulnerabilty Schema

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 orgs.watchlist (Create,Update)
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 ubs.org.sha256 (Read)
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 device.quarantine (Execute)
Remove IOCs from a Watchlist Removes IOCs from a report in a watchlist. Requires VMware Carbon Black Cloud Enterprise EDR Custom orgs.watchlist (Update, Delete)
Un-quarantine Removes the specified device(s) from the quarantined state, allowing them to communicate normally on the network. Custom device.quarantine (Execute)
Dismiss Alert Dismisses the specified alert in Carbon Black Cloud Custom org.alerts.dismiss (Execute)
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 org.search.events (Create, Read)
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 org.search.events (Read, Execute)
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 livequery.manage (Create, Read)
Update Device Policy Updates the policy associated with the specified device. Example: move a device to a more restrictive policy during incident investigation Custom device.policy (Update)
Ban Hash Prevents a sha256 hash from being executed in Carbon Black Cloud. Currently requires Endpoint Standard; Enterprise EDR support expected CY21Q2. Custom org.reputations (Create)

Table 3: Access Level Permissions for Commands

Custom Command Name Description Access Level and Permission
VMware CBC Device Info (cbcdvcinfo) Gets real-time information about a CBC device. See Custom Commands section below for usage and best practices Custom device (Read)
VMware CBC Hash Info (cbchashinfo) Gets real-time information about a sha256 hash, such as the number of devices that observed the file. Requires Enterprise EDR. Custom ubs.org.sha256 (Read)

Release Notes

Version 1.1.0
March 1, 2021

Version 1.1.0
- 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

- Improvements
- Events Dashboard performance improvements
- Update Top 10 CB Analytics panel
- Stability improvements in Alerts Inputs

Version 1.0.3
Dec. 14, 2020

Documentation Update

Version 1.0.0
Nov. 18, 2020

Initial Release


Subscribe Share

AppInspect Tooling

Splunk AppInspect evaluates Splunk apps against a set of Splunk-defined criteria to assess the validity and security of an app package and components.

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 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.

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.