Getting Data In

List all Search commands within Splunk ?

koshyk
Super Champion

Hi guys,

Is there a way to list all search commands && a short description from Splunk engine? (As mentioned in docs). This is to help develop in corporate mode where there is no internet connection.

| rest /services/data/commands | table title

I tried above commands and it provides some of the commands, but not all.
Is there a way to display all "Splunk search" commands in above manner?

Tags (2)
0 Karma

dtburrows3
Builder

Not sure if this all of them, but I think it should cover any command defined in a searchbnf.conf file.

| rest splunk_server=local /servicesNS/-/-/configs/conf-searchbnf
    | fields + title, shortdesc, description, eai:acl.app, eai:acl.sharing, usage
    | search title="*-command"
    | eval
        command=replace(title, "-command$", "")
    | fields + command, shortdesc, description




somesoni2
Revered Legend

The rest command you mentioned lists only the Python commands (not all built-in commands), and I am not sure there is any dynamic way to get that list and/or descriptions. Best way will be to prepare content with all search commands (count~130). It could be an html/pdf/lookup and will be available for offline use.

0 Karma

lguinn2
Legend

You could save some of the documentation as a PDF:

Search Command Cheat Sheet

If you look at the left bar, you will see a red link for downloading the entire manual as a PDF. Notice that there is both a Cheat Sheet and a Quick Reference Guide that can be downloaded as PDFs as well.

0 Karma

koshyk
Super Champion

thanks Lisa. I was actually looking for automated way using "REST"

0 Karma
Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

Where Innovation Takes Flight: The Splunk4Aviation Flight Sim Lands at .conf26

If you hear someone at .conf26 shouting "gear down, GEAR DOWN" across the show floor, you have found us.  The ...

Turn Cisco Telemetry Into Action with Cisco Data Fabric, powered by the Splunk ...

The surge in machine data is already hitting enterprise budgets, and the agentic era will only intensify it. ...

Persistent Queue at TcpOut — One of Splunk's Most Practical Features

Splunk introduced persistent queueing at the tcpout layer as one of the most practical resilience features in ...