Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Command Modular Input
MD5 checksum (command-modular-input_11.tgz) 487ae0689e3292b62d55cb8040c1db16 MD5 checksum (command-modular-input_10.tgz) 666a088a5593f4a68fa05fc9a65cde07 MD5 checksum (command-modular-input_10beta.tgz) d3696c5fdd9ec2034c3971a4c16f2d10
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

Command Modular Input

Overview
Details
This is a Splunk Modular Input for executing commands and indexing the output.
It is quite simply just a wrapper around whatever system commands/programs that you want to
periodically execute and capture the output from ie: (top, ps, iostat, tshark, tcpdump etc...). It will work on all supported Splunk platforms.

Splunk Command Modular Input v1.1

by Damien Dallimore , damien@baboonbones.com
November 2013


Overview

This is a Splunk Modular Input for executing commands and indexing the output.
It is quite simply just a wrapper around whatever system commands/programs that you want to periodically execute and capture the output from ie: (top, ps, iostat, tshark, tcpdump etc...). It will work on all supported Splunk platforms.

Dependencies

  • Splunk 5.0+
  • Supported on Windows, Linux, MacOS, Solaris, FreeBSD, HP-UX, AIX

Setup

  • Untar the release to your $SPLUNK_HOME/etc/apps directory
  • Restart Splunk

Custom Output Handlers

You can provide your own custom Output Handler. This is a Python class that you should add to the
command_ta/bin/outputhandlers.py module.

You can then declare this class name and any parameters in the Command Input setup page.

Streaming vs Non Streaming Command Output

Some commands will keep STD OUT open and stream results.For these scenarios ensure you check the "streaming output" option on the setup page.

Environment variables

Environnment variables in the format $VARIABLE$ can be included in the command name and command arguments and they will be dynamically substituted ie: $SPLUNK_HOME$

Logging

Any modular input errors will get written to $SPLUNK_HOME/var/log/splunk/splunkd.log

Troubleshooting

  • You are using Splunk 5+
  • You have permissions to execute the command
  • The command is on the system PATH if you're just specifying the command name
  • The path to the command is correct if you're specifying the full path to the command
  • The command arguments are correct
  • The command is installed
  • You have configured timestamping for the sourcetype correctly
  • Look for any errors in $SPLUNK_HOME/var/log/splunk/splunkd.log

Release Notes

Version 1.1
Nov. 16, 2013

Environment variables in the format $VARIABLE$ can be included in the command name and command arguments and they will be dynamically substituted ie: $SPLUNK_HOME$

Version 1.0
Oct. 31, 2013

1.0 release. No functional changes.

Version 1.0beta
June 23, 2013

78
Installs
1,972
Downloads
Share Subscribe LOGIN TO DOWNLOAD

Subscribe Share

Splunk Certification Program

Splunk's App Certification program uses a specific set of criteria to evaluate the level of quality, usability and security your app offers to its users. In addition, we evaluate the documentation and support you offer to your app's users.

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 50GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps and add-ons from Splunk, our partners and our community. Find an app or add-on for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
© 2005-2017 Splunk Inc. All rights reserved.
Splunk®, Splunk>®, Listen to Your Data®, The Engine for Machine Data®, Hunk®, Splunk Cloud™, Splunk Light™, SPL™ and Splunk MINT™ are trademarks and registered trademarks of Splunk Inc. in the United States and other countries. All other brand names, product names, or trademarks belong to their respective owners.