Skip to content

splunk get-search-job

List search jobs.

Description

List search jobs.

Synopsis

splunk get-search-job
    --site <site>
    [--count <count>]
    [--sort_key <sort_key>]
    [--sort_dir <sort_dir>]
    <sid>

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: required

count - (int)

     Limit the number of results returned. Set 0 to return all results.
     Example: --count 0
     Default: 0      Attributes: optional

sort_key - (string)

     Field name to use for sorting.
     Example: --sort_key "updated"
     Default: updated      Attributes: optional

sort_dir - (string)

     Response sort order.
     Example: --sort_dir "sort_dir-1"
     Default: _None_      Attributes: optional

     Validation:
         allowed values: asc, desc

sid - (string)

     Individual command to be fetched.
     Example: "sid-1"
     Default: _None_      Attributes: required

Examples

Input:

!splunk get-search-job "1676290380.6"
Output:
UPDATED     SID     SEARCH COMMANDS NAME        EARLIEST TIME   LATEST TIME 
  now     sample       summarize                -              -

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "splunk"
Service Instance
Namespace
Object Type "search"
Object ID sid

Please see Access Control for details.