Carbon Black Cloud Source

The Carbon Black Cloud Source provides a secure endpoint to receive data from the Carbon Black Cloud, Observations Search, Processes Search, and Alerts APIs. It securely stores the required authentication, scheduling, and state tracking information.

tip

The Event Forwarder is recommended by VMWare Carbon Black over APIs for obtaining large amounts of data from Carbon Black Cloud in real time. Sumo Logic recommends using the Event Forwarder in combination with a Sumo Logic Amazon S3 Source instead of a Carbon Black Cloud Source. For details, see how to collect logs for Carbon Black.

Data collected

Polling Interval	Data
5 min	Events data

Setup

Vendor configuration

To grant access to your data you'll need to provide credentials from Carbon Black. There are three APIs this Source collects from and you need to ensure the API Key you provide has permissions to access them. Set your permissions exactly as the following list, do not provide any additional permissions:

org.alerts.notes - create, read
org.alerts - read
org.alerts.dismiss - execute
livequery.manage - create, read
org.search.events - create, read

See the following Carbon Black documents for details on how to authenticate to each API:

Source configuration

When you create a Carbon Black Cloud Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure a Carbon Black Cloud Source:

Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
New UI. In the Sumo Logic top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection.
On the Collectors page, click Add Source next to a Hosted Collector.
Search for and select Carbon Black Cloud.
Enter a Name for the Source. The description is optional.
(Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM.
note
Select Forward to SIEM only if you have Cloud SIEM installed.
(Optional) Fields. Click the +Add Field link to define the fields you want to associate. Each field needs a name (key) and value.
- A green circle with a check mark is shown when the field exists in the Fields table schema.
- An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema it is ignored, known as dropped.
CB Cloud Domain. Enter your Carbon Black Cloud domain, such as dev-prod05.conferdeploy.net. See this knowledge base article to determine which domain to use.
API Key. Enter the Carbon Black Cloud API Key you want to use to authenticate requests. Ensure the key is granted the required permissions for all the APIs listed in the Vendor configuration section.
API ID. Enter your Carbon Black Cloud API ID correlated to your API key.
Org Key. Enter your Carbon Black Cloud Org key, found in your Carbon Black product console under Settings > API Access > API Keys.
(Optional) The Polling Interval is set to 300 seconds by default, you can adjust it based on your needs.
When you are finished configuring the Source, click Submit.

Metadata fields

Field	Value	Description
`_siemVendor`	`CarbonBlack`	Set when Forward To SIEM is checked.
`_siemProduct`	`Cloud`	Set when Forward To SIEM is checked.
`_siemFormat`	`JSON`	Set when Forward To SIEM is checked.
`_siemEventID`	`event_type`	For Alerts API, enter the value of field `id`. For Searches API, enter the value of any of these fields `event_id`, `alert_id`, `process`, `unknown`. Set when Forward To SIEM is checked.

JSON configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details.

Parameter	Type	Value	Required	Description
schemaRef	JSON Object	`{"type":"Carbon Black Cloud"}`	Yes	Define the specific schema type.
sourceType	String	`"Universal"`	Yes	Type of source.
config	JSON Object	Configuration object	Yes	Source type specific values.

Configuration Object

Parameter	Type	Required	Default	Description	Example
name	String	Yes	`null`	Type a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field `_source`.	`"mySource"`
description	String	No	`null`	Type a description of the source.	`"Testing source"`
category	String	No	`null`	Type a category of the source. This value is assigned to the metadata field `_sourceCategory`. See best practices for details.	`"mySource/test"`
fields	JSON Object	No	`null`	JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.	`{"_siemForward": false, "fieldA": "valueA"}`
domain	String	Yes	`null`	Enter your Carbon Black Cloud domain, such as: `dev-prod05.conferdeploy.net`. See this knowledge base article to determine which domain to use.
api_key	String	Yes	`null`	The Carbon Black Cloud API Key you want to use to authenticate requests. Ensure the key is granted the required permissions for all the APIs listed in the above Vendor configuration section.
api_id	String	Yes	`null`	The Carbon Black Cloud API ID correlated to your API key.
org_key	String	Yes	`null`	Your Carbon Black Cloud Org key, found in your Carbon Black product console under Settings > API Access > API Keys.
pollingInterval	Integer	No	300	This sets how many seconds the Source checks for new data. The default is 60 seconds.

JSON example

{
    "api.version":"v1",
    "source":{
      "config":{
        "api_id":"********",
        "name":"CB Cloud",
        "domain":"defense.conferdeploy.net",
        "org_key":"ABCDEFG1",
        "polling_interval":300,
        "api_key":"********",
        "fields":{
          "_siemForward":false
        },
        "category":"c2c/cb_cloud"
      },
      "schemaRef":{
        "type":"Carbon Black Cloud"
      },
      "state":{
        "state":"Collecting"
      },
      "sourceType":"Universal"
    }
  }

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "carbon_black_cloud_source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "Carbon Black Cloud"
  }
  config = jsonencode({
      "api_id":"********",
      "name":"CB Cloud",
      "domain":"defense.conferdeploy.net",
      "org_key":"ABCDEFG1",
      "polling_interval":300,
      "api_key":"********",
      "fields":{
        "_siemForward":false
      },
      "category":"c2c/cb_cloud"
  })
}
resource "sumologic_collector" "collector" {
  name        = "my-collector"
  description = "Just testing this"
}

Download example

FAQ

info

Click here for more information about Cloud-to-Cloud sources.

Data collected​

Setup​

Vendor configuration​

Source configuration​

Metadata fields​

JSON configuration​

Configuration Object​

JSON example​

Terraform example​

FAQ​