Skip to main content
Version: Atlas v5.1

Custom SPL Commands

Overview​

Atlas Custom SPL Commands is an in-product reference for the custom SPL commands included with Atlas. It gives Splunk users a single place to discover available commands, understand their inputs, and review working examples before incorporating them into searches.

The dashboard is useful when you want to extend a search with Atlas functionality without having to memorize command syntax or switch between Splunk documentation and your search. Open Custom SPL Commands from Power Utilities to browse the available commands.

Custom SPL Commands does not require separate utility-level configuration in Atlas Settings.

Capabilities​

  • Find commands by keyword or workflow category.
  • Review command syntax, options, defaults, and descriptions.
  • Copy syntax and example SPL into Splunk Search.
  • Review sample results before adapting a command to your environment.

Custom SPL Commands Dashboard​

The dashboard lists the available commands as expandable rows. Each row identifies the command name, its command type, and a brief description of what it does. Use the controls at the top of the page to narrow the list, then expand a command to review its details.

Filters and navigation​

Use the Search field to filter commands by name or keyword. As you enter text, the command list updates to show matching results. Use the category filters to focus on commands for a particular workflow:

  • All: every available command.
  • Scheduling: commands that help interpret or evaluate scheduled-search timing.
  • Search Execution: commands that support search orchestration.
  • Knowledge Objects: commands that help work with knowledge objects and expanded search content.
  • REST Calls: commands that interact with Splunk REST endpoints.

The count in each filter shows how many commands are available in that category.

Command details and actions​

Select the expand arrow beside a command to open its reference panel. The panel shows the command syntax, including required and optional arguments, and an options table with defaults and descriptions. It also provides a sample SPL search and example results so you can understand the expected output before adapting it to your environment.

Use the copy control to copy syntax or an example into Splunk Search, then replace sample fields and values with those that apply to your environment. Review the options table before running the search so that required fields, defaults, and command behavior are clear.

caution

Some commands can interact with Splunk REST endpoints. Review the command options and confirm that you have the appropriate permissions before using commands that create, update, or delete Splunk objects.