IMPORTANT

USERS RUNNING THIS COMMAND MUST HAVE THE admin_all_object AND rest_apps_management ROLE CAPABILITIES.

These are very powerful permissions, and should be restricted to admin accounts.

This app logs restart information by default, to change this go into the configuration menu and select a higher logging level (WARN, CRITICAL).

Command Syntax

            | restartinput app=<app> type=<type> input=<input>/script=<script_name>

Description

The restartinput command uses the REST API to restart a specified input or script in an app.

This is useful if an input regularly needs to be restarted, as Splunk's scheduler can be used to automatically restart an input, with no command line access or scripting required.

Examples

            | restartinput app=TA-Your_App type=script script=myScript.sh

This example restarts the script myScript found in the app TA-Your_App.

            | restartinput app=TA-Your_App type=monitor input=lookup.csv

This example restarts a monitored input called lookup.csv from the app context TA-Your_App.

Restartable input types

http
monitor
registry
script
tcp/cooked
tcp/raw
tcp/ssl
udp
win-wmi-collections

A note on modular inputs

Modular input types are often custom. To construct a restart query for a modular input:
Search
| rest /servicesNS/-/-/data/inputs | table title, id
to identify the type (title in the results) value to enter in the command.

Search
| rest /servicesNS/-/<app>/configs/conf-inputs | search title="*<input type from previous search>*" | table title
to identify the input value. These results come directly from your server's input.conf file.

As an example, if you have an app titled TA-Your_App with an input type of your_app and a input titled get_hosts your command would be

            | restartinput app=TA-Your_App type=your_app input=get_hosts

Developer Support

Contact: splunk-app@hurricanelabs.com
Hours: 9 AM - 5 PM Eastern
Closed all major US holidays.

Restart It

0