Get started with the Data Stream Processor CLI

The Splunk Data Stream Processor includes its own command-line tool starting in DSP 1.4.0, which lets you administer and configure your DSP deployment. This collection of commands replaces the scripts that previous versions of DSP included in the installer package. See Available commands for all commands.

You must run all DSP CLI commands from the working directory of a controller node. To access the DSP CLI, navigate to the bin subdirectory in the DSP working directory. From there, you can run any DSP CLI commands using the following syntax: dsp <command> [subcommand] [flag]. To get more information about a specific command, its usage, flags, and any applicable subcommands, run the command with the --help flag.

Available commands

Command	Description
admin	Perform administrative operations for the DSP cluster, such as managing credentials, pipelines, and connections.
backup	Generate a backup TAR file of the DSP deployment.
bootstrap	Specify whether you want to skip creating certain resources when installing DSP.
category	View, start, stop, or restart resources in one or more specific categories. A category is a system service like auth, ingest, or pipelines.
completion	Generate the autocompletion script for bash, fish, PowerShell, or zsh shells. See each subcommand's help for details on how to use the generated script.
config	View or edit any DSP configurations that you added.
configure-ui	Configure DSP to enable the UI on the provided DSP host. If you do not set the dsp-host parameter, the command determines the DSP host based on this precedence order: DSP_HOST environment variable Auto-discover the external IP Localhost
create	Create a predefined DSP resource.
deploy	Deploy new configurations or secrets. Whenever you create a new configuration or make changes to an existing configuration, you must deploy the configuration for the changes to take effect.
help	Get help about any command.
install	Install DSP on a Kubernetes k0s cluster.
join	Join a node to a k0s cluster.
join-additional	Join multiple nodes to an existing k0s cluster.
leave	Remove a node from a k0s cluster.
logs	View logs for a specific container or service.
preflights	Perform preflight checks for installation.
print-join	Print the command for joining additional nodes to the cluster.
remove	Remove node from a specified k0s cluster.
report	View logs for a specified pod. These logs are packaged into a TAR file.
restore	Restore a backup TAR file into the cluster.
rolling-reactivate	Deactivate and reactivate all pipelines.
service	List, start, stop, and restart any services installed on the cluster.
smoketest	Run smoke tests on DSP services. You can choose to test all services or test only one or more specified services.
ssh	Start up an SSH server.
status	View a summary of the statuses of your DSP applications and resources.
version	View version information for the DSP cluster, the CLI tool, and the DSP applications installed on the cluster.
wait	Run status checks on the DSP deployments to verify activity.