Skip to content
This repository

Splunk Resource Kit for Powershell

branch: master
README.md

Splunk PowerShell Resource Kit

The Splunk PowerShell Resource Kit enables IT administrators to manage their Splunk topology, configure Splunk internals, and engage the Splunk search engine from their PowerShell session.

Example Uses

Here are a few of the tasks enabled by the Resource Kit:

  • Determine or change the status of Splunk services across a set of Splunk servers in parallel.
  • Force one or more Splunk servers to reload their configuration, in parallel.
  • Deploy multiple Splunk forwarders to all active hosts in a Windows domain.
  • Retrieve a list of Splunk server classes, optionally filtered by last deployment client connection time, associated applications, or matching patterns.
  • Issue a Splunk search and format the retrieved events as a table, a list, or in a windowed grid view.

Installation

  1. Download the source code repository. Unblock the ZIP archive and extract it to a folder. (You can alternatively clone the GitHub repository)
  2. Open the folder to which you extracted or cloned the source code.
  3. Run install.bat. This will copy the Splunk PowerShell module into your module path.

To verify the Splunk module is available, open PowerShell and type:

get-module Splunk

You should see output similar to the following:

ModuleType Name                      ExportedCommands                                                           
---------- ----                      ----------------                                                           
Script     splunk                    {... 

Documentation

Most of the documentation leaves in the "Splunk PowerShell Resource Kit Cookbook", which we highly recommend you read. You can find it here at Docs/Splunk PowerShell Resource Kit.docx

Resources

You can find anything having to do with developing on Splunk at the Splunk developer portal:

  • COMING SOON

You can also find full reference documentation of the REST API:

For a gentle introduction to the Splunk product and some of its capabilities:

  • COMING SOON

Community

How to contribute

We aren't ready to accept code contributions yet, but will be shortly. Check this README for more updates soon.

Support

Contact Us

You can reach the Dev Platform team at devinfo@splunk.com

License

The Splunk PowerShell Resource Kit is licensed under the Apache License 2.0. Details can be found in the file LICENSE.

Something went wrong with that request. Please try again.