Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Salt Extension for interacting with Splunk
Salt Extension for interacting with Splunk

Guides

  • Installation
  • Configuration

Provided Modules

  • Execution Modules
    • splunk
    • splunk_search
  • Returner Modules
    • splunk
  • State Modules
    • splunk
    • splunk_search

Reference

  • Changelog
Back to top
View this page

splunk_search¶

Statefully manage Splunk searches.

Usage¶

This state is used to ensure presence of splunk searches.

server-warning-message:
  splunk_search.present:
    - name: This is the splunk search name
    - search: index=main sourcetype=
saltext.splunk.states.splunk_search.present(name, profile='splunk', **kwargs)[source]¶

Ensure a search is present

API Error Search:
  splunk_search.present:
    search: index=main sourcetype=blah
    template: alert_5min

The following parameters are required:

name

This is the name of the search in splunk

saltext.splunk.states.splunk_search.absent(name, profile='splunk')[source]¶

Ensure a search is absent

API Error Search:
  splunk_search.absent

The following parameters are required:

name

This is the name of the search in splunk

Next
Changelog
Previous
splunk
Copyright © 2024 - 2025, EITR Technologies, LLC
Made with Sphinx and @pradyunsg's Furo
On this page
  • splunk_search
    • Usage
    • present()
    • absent()