Carbon Black Inventory Source

The Carbon Black Inventory Source provides a secure endpoint to receive data from the CB Devices API. It securely stores the required authentication, scheduling, and state tracking information.

See how inventory data is used in Cloud SIEM.

Data collected

Polling Interval	Data
10 hours	Device data

Setup

Vendor configuration

To grant access to your data you'll need to provide credentials from Carbon Black. The Carbon Black Inventory Source requires an API key with Custom access that has read rights to the Devices API, specifically the General Information permission.

Source configuration

When you create a Carbon Black Inventory 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 Inventory Source:

1. 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.
2. On the Collection page, click Add Source next to a Hosted Collector.
3. Search for and select Carbon Black Inventory.
4. Enter a Name for the Source. The description is optional.
5. (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.
6. 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.

7. (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.
8. CB Cloud Domain. Enter your Carbon Black domain, such as dev-prod05.conferdeploy.net. See this knowledge base article to determine which domain to use.
9. API Key. Enter the Carbon Black 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.
10. API ID. Enter your Carbon Black API ID correlated to your API key.
11. Org Key. Enter your Carbon Black Org key, found in your Carbon Black product console under Settings > API Access > API Keys.
12. The Polling Interval is set to 300 seconds by default, you can adjust it based on your needs.
13. When you are finished configuring the Source, click Submit.

Metadata fields

Field	Value	Description
_siemDataType	Inventory	Set when Forward To SIEM is checked.
_siemProduct	Inventory	Set when Forward To SIEM is checked.
_siemVendor	CarbonBlack	Set when Forward To SIEM is checked.
_siemFormat	JSON	Set when Forward To SIEM is checked.

JSON schema

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 Inventory"}	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

The following table shows the config parameters for a Carbon Black Inventory Source.

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.
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":{
      "schemaRef":{
        "type":"Carbon Black Inventory"
      },
      "state":{
        "state":"Collecting"
      },
      "config":{
        "api_id":"********",
        "name":"CB Inv E",
        "domain":"defense.conferdeploy.net",
        "org_key":"ABCDEFG1",
        "polling_interval":600,
        "api_key":"********",
        "fields":{
          "_siemForward":false
        },
        "category":"c2c/cb_inv"
      },
      "sourceType":"Universal"
    }
  }

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "carbon_black_inventory_source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "Carbon Black Inventory"
  }
  config = jsonencode({
      "api_id":"********",
      "name":"CB Inv E",
      "domain":"defense.conferdeploy.net",
      "org_key":"ABCDEFG1",
      "polling_interval":600,
      "api_key":"********",
      "fields":{
        "_siemForward":false
      },
      "category":"c2c/cb_inv"
  })
}
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.