Splunk® Phantom (Legacy)

Administer Splunk Phantom

Acrobat logo Download manual as PDF

Splunk Phantom 4.10.7 is the final release of Splunk's Security Orchestration, Automation, and Response (SOAR) system to be called Splunk Phantom. All later versions are named Splunk SOAR (On-premises). For more information, see the Splunk SOAR (On-premises) documentation.
Acrobat logo Download topic as PDF

View related data using aggregation rules

Define aggregation rules to view related data in a single location. Artifacts matching a defined rule are copied to a new container.

To view aggregation rules, follow these steps:

  1. From the main menu, select Administration.
  2. Select Product Settings > Aggregation.

The Aggregation page shows a list of all container labels defined on your system. The number inside the parentheses next to each label is the number of rules defined for that label. Container labels can be created with an ingestion asset or by manually adding them on the Event Settings subtab. For example, in a production environment, you might pick a source label from an ingestion asset such as "Events" or "Email" and create a destination label such as "Aggregated Events" that makes it clear that containers with that label are aggregated.

Add a new aggregation rule

In this scenario, we want to aggregate artifacts with matching sourceAddress CEF fields. For events from numerous products, these fields are often the sender's IP address on a packet or connection that triggered an alert and represent an attacker's IP address. The name sourceAddress is not related to the source or destination label concept. It's a different kind of source. We want to give the rule a meaningful name using the "Source" and "Destination" labels in our example.

Follow this procedure to create an example aggregation rule:

  1. From the Aggregation page, click + Aggregation Rule.
  2. Specify sourceAddress - Email to Events as the name of the rule.
  3. Select email from the drop-down list in the Source Label field.
  4. Select events from the drop-down list in the Destination Label field.
  5. Select Exact from the Match field to aggregate on the exact contents of the CEF field. You can click on the plus (+) icon to add additional match rules.
  6. Select sourceaddress in the CEF field. You can start typing the field name to search through the list of available field names.
  7. If you have multiple tenants, select the right tenants from the Applies to field. The default is All tenants.
  8. Click Save.

This screen image shows the Aggregation page. The Source label has a 1 in parentheses next to it, indicating that there is one aggregation rule for this label.

On the Aggregation page, the 1 in parentheses next to email means there is one rule under the label email.

Edit an existing aggregation rule

After completing the previous example, perform the following steps to edit an existing aggregation rule in Splunk Phantom.

  1. Click on any existing rule. In this example, click email to view a summary of the aggregation rule.
  2. Click Edit to make changes to the rule.
  3. Click the trash can icon to remove the rule.

Click + Aggregation Rule to create a new rule. If you create a new rule from the email label rule page, the new rule will automatically populate the Source Label field with email.

By default, rules apply to all tenants. Only one rule per source label and tenant combination is allowed. "All Tenants" counts as a named tenant for this purpose. If you need to have another rule for the label "email", pick a specific tenant from the drop-down list, then create a second rule with source label "email".

Using multiple matches in an aggregation rule

An aggregation rule can have multiple match lines. The following image shows an aggregation rule with an exact match on both sourceaddress and destinationaddress.

This screen image shows the Aggregation Rule page. There are two match statements in this rule, one for sourceaddress and the second for destinationaddress.

In this example, both the sourceaddress and destinationaddress must match for it to be aggregated into the same container. If you treat sourceaddress as the attacker's IP address, and destinationaddress as the victim's IP address, then this means you have artifacts being aggregated in the same destination container for only the exact same attacker and victim. So with a victim IP address of, there is one destination container for attacker IP address and victim IP address, and a different container for attacker IP address and victim IP address

CEF fields are matched even if there is no value. For example, if you have artifacts with a destinationaddress of and no sourceaddress, they are still aggregated together into a destination container.

Last modified on 21 October, 2020
Configure multiple tenants on your instance
Define tasks using workbooks

This documentation applies to the following versions of Splunk® Phantom (Legacy): 4.8, 4.9, 4.10, 4.10.1, 4.10.2, 4.10.3, 4.10.4, 4.10.6, 4.10.7

Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters