Splunk® IT Service Intelligence

Event Analytics Manual

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Integrate ITSI with Splunk SOAR (On-premises)

Integrate IT Service Intelligence (ITSI) and Splunk SOAR (On-premises) to automatically resolve issues in your IT environment. Splunk SOAR (On-premises) is an orchestration, automation, and response platform designed to help scale your IT and security operations. Splunk SOAR (On-premises) lets you automate tasks, orchestrate workflows, and support a broad range of NOC and SOC functions. For more information, see About Splunk SOAR (On-premises) in the About Splunk SOAR (On-premises) manual.

With the ITSI integration with Splunk SOAR (On-premises), you can send episodes directly to Splunk SOAR (On-premises) and run custom playbooks to resolve issues in your IT environment. This functionality lets you automate simple and complex IT operations workflows to increase service availability and operational efficiency. The following diagram shows the end-to-end workflow of ingesting data into ITSI, triaging and routing issues with Event Analytics, and sending the issues to Splunk SOAR (On-premises) to be automatically resolved:

This image shows the four stages of the ITSI Splunk SOAR (On-premises) integration. The first step is collecting data and ingesting it into ITSI. The second step is triaging and routing events to Splunk SOAR (On-premises) through ITSI Service Insights and Event Analytics. The third step is automatically resolving episodes in Splunk SOAR (On-premises). The fourth step is updating or escalating the issue in third-party software such as ServiceNow or Remedy.

When you send an ITSI episode to Splunk SOAR (On-premises), the episode itself is mapped to a container in Splunk SOAR (On-premises) and the notable events within the episode are mapped as artifacts of the container. The ITSI episode ID is mapped to the source ID of the Splunk SOAR (On-premises) container. The container then runs an associated playbook that performs the appropriate remediation steps.

Deployment requirements

You must have the following versions of these associated apps to integrate ITSI with Splunk SOAR (On-premises):

Link to app Version
Splunk Enterprise 7.3.3 or later
IT Service Intelligence (ITSI) 4.7.0 or later
Splunk App for SOAR 1.0.0 or later

Step 1: Create an automation user in Splunk SOAR (On-premises)

The automation user is a default internal service account used by Splunk SOAR (On-premises) for running automated playbooks and asset actions, such as data ingestion. The automation user provides REST authentication tokens that you can use to read and write data to the REST backend and perform other useful activities.

For instructions on adding an automation user, see Create an automation user in Splunk SOAR (On-premises) in the Administer SOAR (On-premises) manual.

Step 2: Configure the Splunk App for SOAR Export

Perform the following steps to configure Splunk Enterprise to work with Splunk App for SOAR Export.

Install the Splunk App for SOAR Export

Download and install version the Splunk App for SOAR Export from Splunkbase.

Configure Splunk App for SOAR Export capabilities in Splunk Enterprise

You must provide specific capabilities to the admin role so Splunk administrators can set up the Splunk SOAR (On-premises) integration.

  1. Within Splunk Enterprise, navigate to Settings > Roles (or Settings > Access controls > Roles in Splunk Enterprise versions earlier than 8.1.0).
  2. Select the admin role.
  3. On the Capabilities tab, verify that the admin role has the following capabilities:
    • admin_all_objects
    • phantom_read
    • phantom_write
    • list_storage_passwords
  4. Click Save.

Disable HTTPS certificate validation

Configure HTTPS certificate validation by editing the phantom.conf Splunk App for SOAR Export configuration file.

Prerequisites

  • Only users with file system access, such as system administrators, can disable HTTPS certificate validation in Splunk SOAR (On-premises).
  • Review the steps in How to edit a configuration file in the Splunk Enterprise Admin Manual.

Never change or copy the configuration files in the default directory. The files in the default directory must remain intact and in their original location.

  1. Create a local version of the phantom.conf file at $SPLUNK_HOME/etc/apps/phantom/local/.
  2. Add the following stanza to disable HTTPS certificate validation:
    [verify_certs]
    value = false
    
  3. Save the file and restart your Splunk software.

Configure Splunk SOAR (On-premises)

Provide the automation user's REST API authorization token value to Splunk SOAR (On-premises). For more information, see Edit an automation user to view the REST API authorization token and associated assets.

Step 3: Configure IT Service Intelligence

After you configure Splunk SOAR (On-premises), configure your ITSI environment to send episodes to Splunk SOAR (On-premises).

Create correlation searches

A correlation search is a recurring search that scans multiple data sources for defined patterns. You can configure a correlation search to generate a notable event, also known as an alert, when the search results meet specific conditions. As correlation searches begin to generate notable events, the events are grouped into episodes using the notable event aggregation policies you configure in the next step.

Configure several correlation searches to bring in data to ITSI that you want to aggregate and send to Splunk SOAR (On-premises). For instructions on creating correlation searches, see Overview of correlation searches in ITSI.

Configure aggregation policies to send episodes to Splunk SOAR (On-premises)

Notable event aggregation policies group notable events into episodes and organize them in Episode Review. They also let you take automatic actions on an episode, such as sending it to Splunk SOAR (On-premises), when certain trigger conditions are met.

Configure the action rules of one or more aggregation policies in your environment to send episodes to Splunk SOAR (On-premises). For more information about configuring action rules, see Configure episode action rules in ITSI.

  1. On the ITSI main menu, click Configuration > Notable Event Aggregation Policies and open an existing policy.
  2. Go to the Action Rules tab.
  3. Click +Add Rule or expand an existing action rule.
  4. Provide an If condition.
    The following image shows the best practice, which is to send an episode to Splunk SOAR (On-premises) immediately after it's created, when the first event is added:
    This image shows the first step of aggregation policy action rules configuration. The IF statement reads "If the number of events in the episode is exactly equal to 1".
  5. For the THEN condition, choose the action called Send to Phantom. The following example action rule sends an episode to Splunk SOAR (On-premises):
    This image shows the second step of aggregation policy action rules configuration. The THEN statement reads "Then send to Phantom" and includes a Configure button.
  6. Click Configure and configure the following Phantom fields:
    Field Description
    Phantom Server The Splunk SOAR (On-premises) server to send the episode to. Create and configure a Splunk SOAR (On-premises) server in the Phantom App for Splunk.
    Phantom Label Splunk SOAR (On-premises) determines which playbooks to run for an ingested event based on the label associated with the event. Specify a label here to determine which playbooks to run. You can associate one or more labels to a playbook.

If you change the Phantom label after you initially create the aggregation policy, a new event with the new label is created in Splunk SOAR (On-premises). Future notable events that are grouped by the aggregation policy are sent to that event.

Last modified on 04 August, 2022
PREVIOUS
Integrate ITSI with Splunk On-Call (VictorOps)
  NEXT
Set up custom episode actions in ITSI

This documentation applies to the following versions of Splunk® IT Service Intelligence: 4.7.0, 4.7.1, 4.7.2, 4.7.3, 4.7.4, 4.8.0 Cloud only, 4.8.1 Cloud only, 4.9.0, 4.9.1, 4.9.2, 4.9.3, 4.9.4, 4.9.5, 4.9.6, 4.10.0 Cloud only, 4.10.1 Cloud only, 4.10.2 Cloud only, 4.10.3 Cloud only, 4.10.4 Cloud only, 4.11.0, 4.11.1, 4.11.2, 4.11.3, 4.11.4, 4.11.5, 4.11.6, 4.12.0 Cloud only, 4.12.1 Cloud only, 4.12.2 Cloud only, 4.13.0, 4.13.1, 4.13.2, 4.14.0 Cloud only, 4.14.1 Cloud only, 4.14.2 Cloud only, 4.15.0


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