Maintenance Tools Guide

Use maintenance tools for interacting with the Splunk DB Connect API.

The maintenance tools are located in the following directory $SPLUNK_HOME/etc/apps/splunk_app_db_connect/tools.

These tools provide utilities for interacting with the Splunk DB Connect API. They extend core functionality by automating common maintenance tasks that are typically performed manually.

Requirements

  • Python: 3.9 or higher

  • Splunk Enterprise: 9.0 or higher

  • Splunk DB Connect: 4.3.0 or higher

Tools

When you run the tools, you are prompted to select which tool to execute. Regardless of the tool selected, you must provide the following connection details:

  • Host: Hostname or IP address of the Splunk instance

  • Management Port: Splunk management port (default: 8089)

  • Credentials: Username and password for the Splunk instance

  • Splunk DB Connect Port: Port assigned to Splunk DB Connect (Task Server)

Input Copier

Input Copier automates the cloning of inputs from one database connection to another.

Prerequisites:

The following parameters are required:
  • Source Connection: Name of the connection to copy inputs from.

  • Destination Connection: Name of the connection to copy inputs to.

Use the Input Copier

Perform the following steps, to use the Input Copier:
  1. Navigate to the tools directory in your Splunk DB Connect installation.

  2. Run the main script: python tools.py.

Contribute

You are encouraged to extend these tools and share new use cases with the community.

Support

These tools are supported by Splunk in their original, unmodified form only. Any customer modifications, extensions, or custom logic are not supported.