Splunk® SOAR (On-premises)

Develop Apps for Splunk SOAR (On-premises)

The classic playbook editor will be deprecated soon. Convert your classic playbooks to modern mode.
After the future removal of the classic playbook editor, your existing classic playbooks will continue to run, However, you will no longer be able to visualize or modify existing classic playbooks.
For details, see:
This documentation does not apply to the most recent version of Splunk® SOAR (On-premises). For documentation on the most recent version, go to the latest release.

Optional: Set up a development environment for

It is a good practice to develop your apps in a separate environment than your production deployment. You can use the Splunk SOAR (On-premises) virtual machine image (also called an OVA) to set up a local development environment.

For instructions on how to install Splunk SOAR (On-premises), see How can Splunk SOAR (On-premises) be installed?.

Set up the dev environment

Once the virtual machine image file is downloaded, you must load it in your virtual machine software of choice, then set both the root and user passwords. Remote root login is disabled, so you need to use SSH as the user account the use sudo to get root access.

The firewall is pre-configured to allow SSH connections.

SSH to Splunk SOAR

localmachine:~ alice$ ssh user@192.0.2.255
user@192.0.2.255's password:
[user@localhost ~]$ sudo su -
[sudo] password for user:
[root@localhost ~]#

Set the hostname

Optionally, you can set the hostname of the virtual machine to make accessing it easier:

[root@localhost ~]# hostname appdev
[root@localhost ~]#

User 'phantom'

It's good practice to use a non-root user for app development. The user phantom is already created for your deployment and can be used for this purpose. You should set a password for this user account.

Set the password for the user phantom:

[root@localhost ~]# passwd phantom
Changing password for user phantom.
New password:
Retype new password:
passwd: all authentication tokens updated successfully.
[root@localhost ~]# 

Exit and login as phantom.

[root@localhost ~]# exit
logout
[user@localhost ~]$ exit
logout
Connection to 192.0.2.255 closed.
mymbp:~ alice$ ssh phantom@192.0.2.255
phantom@192.0.2.255's password:
[phantom@appdev ~]$
Last modified on 25 March, 2022
Splunk SOAR apps overview   Create an app with the App Wizard

This documentation applies to the following versions of Splunk® SOAR (On-premises): 5.1.0, 5.2.1


Was this topic useful?







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