Splunk® Data Stream Processor

Install and administer the Data Stream Processor

Download manual as PDF

This documentation does not apply to the most recent version of DSP. Click here for the latest version.
Download topic as PDF

Get started with SCloud

SCloud is a command-line tool to make API calls to the Data Stream Processor. You can use scloud to interact with APIs such as the Ingest REST API.


Configure your ~/.scloud file to point to your on-premises DSP instance:

  1. Set DSP_HOST to the IP address or hostname of your master node.
  2. Run the following script by copy and pasting the following text in the command line.
    cat << EOF > ~/.scloud
    env = "prod"
    host-url = "https://$DSP_HOST:31000"
    auth-url = "https://$DSP_HOST:31000"
    tenant = "default"
    username = "dsp-admin"
    insecure = "true"

Verify that the SCloud tool has been configured properly

  1. From the command line, type
    ./scloud login
    When prompted, use the dsp-admin password printed during the DSP installation. If needed, you can get the username and password again by typing sudo ./print-login on one of your nodes.
  2. From the DSP homepage, click on Build Pipeline and select the Splunk Firehose to Splunk Index template.
  3. Click Start Preview.
  4. Try ingesting an event.
    ./scloud ingest post-events -format raw <<<  'test'

Additional commands

The syntax for the Splunk Cloud 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.

Command Description
Identity The identity commands create and manage users and admins, manage tenant memberships, and manage the access to tenant resources granted by the definition of groups, roles, and their corresponding permissions.
Streams The streams command creates and manages Splunk data stream pipelines.
Forwarders The forwarders command interacts with the Splunk forwarder service APIs to create, delete, and view certificates that the forwarders use. It does not control forwarders.
Ingest The ingest command posts event and metric data to the ingest service.
Last modified on 26 March, 2020
Manage users and admins
Kafka encryption and authentication using SSL

This documentation applies to the following versions of Splunk® Data Stream Processor: 1.0.1

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters