Get started with the Splunk Cloud Services CLI
The includes the Splunk Cloud Services (SCloud) command-line tool making it easy to make API calls directly to DSP services. You can use
scloud to interact with APIs such as the Ingest service.
Starting in 1.2.0, the includes both the Splunk Cloud Services CLI 1.0.0 and Splunk Cloud Services CLI 4.0.0. By default, the Splunk Cloud Services CLI 4.0.0 is used when running the base
./scloud command. The table below details the main differences between the two versions, but there are several other differences between Splunk Cloud Services CLI 1.0.0 and Splunk Cloud Services CLI 4.0.0. For the most comprehensive Splunk Cloud Services CLI help, use the
./scloud help command for the desired Splunk Cloud Services CLI version. Best practices are to use Splunk Cloud Services CLI 4.0.0, as it supports the latest DSP features, but 1.0.0 can still be used with many of the existing APIs.
|Splunk Cloud Services CLI 1.0.0||Splunk Cloud Services CLI 4.0.0|
|Global configurations are saved in an
||Global configurations are saved in an |
|Flags are set using a single hyphen
||Most flags are set using a double hyphen |
|Settings that accept boolean values must be quoted. See the
||Settings that accept boolean values cannot be quoted. See the |
|Not applicable.||You can now perform CRUD operations on jobs with the |
Configure the Splunk Cloud Services CLI
How you configure the Splunk Cloud Services CLI varies depending on what version of the Splunk Cloud Services CLI you are using. Best practices are to use the Splunk Cloud Services CLI 4.0.0, as it supports the latest DSP features, but the Splunk Cloud Services CLI 1.0.0 can still be used with many of the existing APIs.
All of the Splunk Cloud Services CLI documentation examples for DSP 1.2.0 use the latest version of the Splunk Cloud Services CLI.
See Configure SCloud in version 1.1.0 of the Install and administer the Data Stream Processor guide if you want to configure and use the Splunk Cloud Services CLI 1.0.0 with DSP 1.2.0. If you want to use the Splunk Cloud Services CLI 1.0.0, make sure you either explicitly use
scloud.v1 for each Splunk Cloud Services CLI command, or update the
scloud symlink to point to
Follow these steps to configure the Splunk Cloud Services CLI 4.0.0.
- From the DSP directory of the master node, set
DSP_HOSTto that node's IP address.
- Run the following script by copy and pasting the following text in the command line.
cat << EOF > ~/.scloud.toml env = "prod" host-url = "https://$DSP_HOST:31000" auth-url = "https://$DSP_HOST:31000" tenant = "default" username = "dsp-admin" insecure = true EOF
Settings that accept boolean values no longer need to be enclosed in quotes in the Splunk Cloud Services CLI 4.0.0. Make sure that
insecure = truedoes not have surrounding quotes.
Verify that the Splunk Cloud Services CLI tool has been configured properly
Follow these steps to verify that the Splunk Cloud Services CLI has been configured successfully for your DSP environment.
- From the DSP installer directory, login to the Splunk Cloud Services CLI.
When prompted, use the
dsp-adminpassword printed during the DSP installation. If needed, you can display the default password by typing
sudo ./print-loginon one of your nodes.
The Splunk Cloud Services CLI doesn't return your login metadata or access token. If you want to see your access token you must log in to the Splunk Cloud Services CLI using the verbose flag:
./scloud login --verbose.
- (Optional) From the DSP homepage, click on Build Pipeline and select the Splunk Firehose to Splunk Index template.
- (Optional) Click Start Preview.
- Try ingesting an event.
./scloud ingest post-events --format raw <<< 'test'
Update your Splunk Cloud Services CLI password
You can change the
dsp-admin password that you use to login to the Splunk Cloud Services CLI and the DSP UI. This script does not update the password for other users.
- From the master node, run the reset password script.
- Enter your new password.
- Log in to the Splunk Cloud Services CLI with your new password.
The syntax for the Splunk Cloud Services CLI is as follows:
./scloud [-u <username>] [-p <password>] [-tenant <tenant>] [-no-prompt]<command> <subcommand> [params]
scloud has the following additional commands. For subcommands and more information, run
./scloud help or
./scloud <command> help.
The ./scloud help command returns a list of services, some of which are not compatible with the Data Stream Processor. The services detailed below are the services specific to the Data Stream Processor.
Manage users and admins
Cluster configuration options
This documentation applies to the following versions of Splunk® Data Stream Processor: 1.2.0, 1.2.1-patch02, 1.2.1, 1.2.2-patch02, 1.2.4