Run Indicator Extraction in the CLI - Administrator Guide - Cortex XSIAM - Cortex - Security Operations

Cortex XSIAM Administrator Guide

Product
Cortex XSIAM
Creation date
2024-02-26
Last date published
2024-05-22
Category
Administrator Guide
Abstract

Use reputation commands, extractindicators command, or the enrichIndicators command in the CLI.

In the Alert War Room CLI you can run the following commands at the alert level to extract and enrich indicators:

  • !extractIndicators

    If you want to extract indicators from non-War-Room-entry sources (such as extracting from files), use the !extractIndicators command from the Alert War Room CLI. The command does not create indicators but extracts them only. Use the command to do the following:

    • Validate regex: Test a specific string to see if the relevant indicators are extracted correctly, such as a URL.

    • In a playbook or automation. The command extracts indicators in a playbook or automation non-war-room-source, and potentially also creates and enriches them (if required).

    You can extract from the following:

    • A specified entry (an entry ID)

    • Investigation (Investigation ID)

    • Text

    • File path

    For example, type !extractIndicators text="some text 1.1.1.1 something" Auto extract=inline. The entry text contains the text of the indicators, which is extracted and enriched. You can also extract indicators by adding the auto-extract parameter with the script and the mode for which you are setting it up. For example, !ReadFile entryId=826@101 auto-extract=inline. Usually, when using the CLI, you want to disable indicator extraction. For example, if you return internal/private data to the War Room, and you do not want it to be extracted and enriched in third-party services, add auto-extract=none to your CLI command.

  • !enrichIndicators

    The !enrichIndicators command is usually used when you want to batch enrich indicators. This command works on existing indicators only (it does not create them on its own). When running the command, the relevant enrichment command is triggered (such as !ip), which is based on the indicator type that is found. The data is saved to context and to the indicator.

    Note

    Triggering enrichment on a substantial amount of indicators can take time (since it's activating all enrichment integrations per indicator) and can result in performance degradation.

  • Reputation commands (such as !ip)

    This command can work on existing and non-existing indicators. If extraction is on, the data is saved both to the indicator and the alert’s context. If not, then just to the context because the mapping flow is always triggered in enrichment commands. The default configuration is set to none in playbook tasks for extraction.

    The indicator does not need to exist to run the reputation command, as the command uses a third-party threat intel integration, such as Unit 42, IPinfo, etc. You can also click the Enrich indicator button in the indicator layout.