Calls an external python program that can modify or generate search results. Scripts must be declared in the
commands.conf file and be located in the
$SPLUNK_HOME/etc/apps/<app_name>/bin/ directory. The script is executed using
If you are using Splunk Cloud and want to install a custom script, file a Support ticket. Before being installed, your script is checked to ensure it complies with Splunk requirements for security, data safety, and so on.
script <script-name> [<script-arg>...] [maxinputs=<int>]
- Syntax: <string>
- Description: The name of the scripted search command to run, as defined in the
- Syntax: maxinputs=<int>
- Description: Specifies how many of the input results are passed to the script.
- Default: 100
- Syntax: <string> ...
- Description: One or more arguments to pass to the script. If you are passing multiple arguments, delimit each argument with a space.
script command is effectively an alternative way to invoke custom search commands.
See About writing custom search commands.
The following search
| script commandname
is largely synonymous with
Note: Some functions of the script command have been removed over time. The explicit choice of Perl or Python as an argument is no longer functional and such an argument is ignored. If you need to write Perl search commands you need to declare them as Perl in the
commands.conf file. This is not recommended, as you need to determine a number of underdocumented things about the input and output formats. Additionally, support for explicit filename reference for scripts in the
etc/searchscripts directory has been removed. All search commands must now be declared in the
Run the Python script "myscript" with arguments, myarg1 and myarg2; then, email the results.
... | script myscript myarg1 myarg2 | sendemail email@example.com
Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has using the script command.
This documentation applies to the following versions of Splunk Cloud™: 6.6.3, 7.0.0, 7.0.2, 7.0.3, 7.0.5, 7.0.8, 7.0.11, 7.1.3, 7.1.6, 7.2.3, 7.2.4, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 8.0.0