SetTagsBySearch

Search entries in the war room for the pattern text, and set tags to the entries found.

python · UpdateEntriesBySearch

Details

IDSetTagsBySearch
Languagepython
From Version6.0.0
Docker Imagedemisto/python3:3.12.8.3296088
TagsUtility

README

Search entries in the war room for the pattern text, and set tags to the entries found.


Script Data

Name Description
Script Type python
Tags Utility

Inputs

Argument Name Description
incident_id The incident ID to search entries from. If not given, the current incident is used.
action The action to the entries.
tags The list of tags to set
filter_categories The list of categories of source entries
filter_options The options to filter entries
filter_tags The tags to filter entries
filter_entry_types The list of entry type of source entries
filter_entry_formats The list of entry format of source entries
filter_user_type The user type to filter entries by who created them
algorithm The pattern matching algorithm
pattern The pattern text to search
exclude_pattern The pattern text to exclude entries matched
node_paths The list of node path of entries to search from
case_insensitive true if the pattern is matched in case-insensitive, false otherwise.
dry_run true if it only search the entries and doesn’t update, false otherwise.
summary The flag to control the output of results

Outputs

There are no outputs for this script.

commonfields:
  id: SetTagsBySearch
  version: -1
contentitemexportablefields:
  contentitemfields:
    fromServerVersion: ''
name: SetTagsBySearch
script: ''
type: python
tags:
- Utility
comment: Search entries in the war room for the pattern text, and set tags to the entries found.
enabled: true
args:
- name: incident_id
  description: The incident ID to search entries from. If not given, the current incident is used.
- name: action
  required: true
  auto: PREDEFINED
  predefined:
  - add
  - replace
  description: The action to the entries
  defaultValue: add
- name: tags
  required: true
  description: The list of tags to set
- name: filter_categories
  auto: PREDEFINED
  predefined:
  - commandAndResults
  - playbookTaskResult
  - playbookTaskStartAndDone
  - playbookErrors
  - justFound
  - deleted
  - incidentInfo
  - chats
  - evidence
  - notes
  - attachments
  description: The list of categories of source entries
  isArray: true
- name: filter_tags
  description: The tags to filter entries
- name: filter_entry_formats
  auto: PREDEFINED
  predefined:
  - html
  - table
  - json
  - text
  - dbotCommandResponse
  - markdown
  description: The list of entry format of source entries
- name: filter_entry_types
  auto: PREDEFINED
  predefined:
  - NOTE
  - ERROR
  description: The list of entry type of source entries
- name: filter_user_type
  auto: PREDEFINED
  predefined:
  - dbot
  - user
  description: Filter entries by type of who created them
- name: filter_options
  auto: PREDEFINED
  predefined:
  - first_entry
  - last_entry
  - exclude_this_entry
  description: The options to filter entries
  isArray: true
  defaultValue: exclude_this_entry
- name: algorithm
  auto: PREDEFINED
  predefined:
  - basic
  - wildcard
  - regex
  description: The pattern matching algorithm
  defaultValue: basic
- name: pattern
  required: true
  description: The pattern text to search
- name: exclude_pattern
  description: The pattern text to exclude entries matched
- name: node_paths
  auto: PREDEFINED
  predefined:
  - Contents
  description: The list of node path of entries to search from
  defaultValue: Contents
- name: case_insensitive
  auto: PREDEFINED
  predefined:
  - 'true'
  - 'false'
  description: true if the pattern is matched in case-insensitive, false otherwise.
  defaultValue: 'false'
- name: dry_run
  auto: PREDEFINED
  predefined:
  - 'true'
  - 'false'
  description: true if it only search the entries and doesn't update, false otherwise.
  defaultValue: 'false'
- name: summary
  auto: PREDEFINED
  predefined:
  - quiet
  - basic
  - verbose
  description: The flag to control the output of results
  defaultValue: basic
scripttarget: 0
subtype: python3
dockerimage: demisto/python3:3.12.8.3296088
runas: DBotWeakRole
fromversion: 6.0.0
tests:
- No tests (auto formatted)