Git Product home page Git Product logo

splunk-toolbox's Introduction

splunk-toolbox

Version 1.2.0

A better wrapper around the Splunk ITSI Rest API and Splunk Core API for anyone feeling the pain Python PyPi PIP package Github Repository

Intended Runtime & Required Packages

** Python V3.x ** see requirements.txt for requirements

Installation in python 3

Installation via pip

If pip3 is your default python package installer on the path (for most it references python2's version of pip...)

pip install splunk_toolbox

If that fails, check your pip --version to see which version of python it is using

Additionally try:

pip3 install splunk_toolbox

Version table

  • 1.0.0 initial PoC/format
  • 1.1.0 added Post update to ITSI Notable Event Group
  • 1.1.1 bugfix & clarification of requirements for post_update_to_notable_event_group
  • 1.1.2 added handler for status code interpretation to post update to notable event group
  • 1.2.0 added splunk retrieve search jobs and save them as XML to the toolbox

Intended to solve stability issues produced by the product itself.

Splunk Toolbox Bio

This is a wrapper around the ITSI API. Where the ITSI API is not functioning, we are using sftp calls instead or core API.

Example Uses

Retrieve active search jobs from ITSI

from splunk_toolbox import splunkInstance

splunk_server = splunkInstance(authPass='mypass')
splunk_server.retrieve_search_jobs(recordSearches=1)

Post updates to ITSI Notable Event Group

from splunk_toolbox import splunkInstance


splunk_server = splunkInstance(authPass='mypass')
payload ={"status":"5"}
splunk_server.post_update_to_notable_event_group(payload=payload, )

Retrieve all Splunk Core Searches on a given server

if record Searches == 1, a file with the name recordedSearches.xml will be generated and saved with todays date and time

from splunk_toolbox import splunkInstance

splunk_server = splunkInstance(host='someIP', authPass='PASS')
splunk_server.retrieve_configured_saved_searches(recordSearches=1)

splunk-toolbox's People

Contributors

gnubyte avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Forkers

dbreddyai

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.