Splunk® SOAR (On-premises)

Release Notes

Acrobat logo Download manual as PDF


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.
Acrobat logo Download topic as PDF

Known issues for

Release 5.4.0

Date filed Issue number Description
2024-02-22 PSAAS-16477 Podman does not currently work with redirected image URLs due to Docker Hub authentication token changes

Workaround:
Manually change the image: line in docker-compose.yaml to point to docker.io/phantomsaas/automation_broker:<$SOAR_VERSION>.
2023-09-20 PSAAS-14855 The migration tool for privileged to unprivileged SOAR does not retain known_hosts file.

Workaround:
If any git repos are failing to sync after an privileged to unprivileged migration, follow the steps in Set up a playbook repository using SSH from

Configure a source control repository for your Splunk SOAR (On-premises) playbooks in Administer Splunk SOAR (On-premises).

These steps will add the git server to the known_hosts file of the phantom user in SOAR.

2023-09-14 PSAAS-14784 SOAR gives a "502 bad gateway" error for all SAML logins if a metadata endpoint fails to respond.
2023-08-11 PSAAS-14413 Special characters are removed while downloading the file from Vault
2023-07-24 PSAAS-14158 In a SOAR cluster, playbook blocks using the playbook API that are downstream from a block using the HTTP connector may fail with status 401.

Workaround:
Due to a change in how SOAR user sessions are handled, if the HTTP connector authenticates using different credentials than the playbooks' automation user, the playbook runs' session token is logged out, resulting in further API requests getting a status of 401. This affects active playbooks triggered by ingestion.

There are four possible workarounds.

  1. Update the HTTP connector's asset's authentication fields to use the same automation user that is running the active playbook.
  2. Update the HTTP connector's asset's "Base Url" to point one of the nodes in the cluster instead of the load balancer.
  3. Put the actions run with the HTTP connector in a child playbook.
  4. Use the phantom.requests playbook API without specifying any authentication mechanism instead of using the HTTP connector.

2023-07-19 PSAAS-14125 Users without the "Administrator" role cannot delete an Automation Broker, even when given appropriate permissions.

Workaround:
Use an account with the Administrator role to delete any Splunk SOAR Automation Brokers as needed.
2023-04-28 PSAAS-13290 Toggling delay timer in one block causes all other action blocks to toggle delay timer.

Workaround:
Avoid toggling delay timer for blocks that do not want delays. Instead, reduce the delay to 0 minutes.
2023-04-27 PSAAS-13280 app editor: "Error in 'python3': free(): invalid pointer:" when running test connectivity; similar code does not throw error when run from command line via phenv

Workaround:
Edit the code without the app editor.
2023-04-06 PSAAS-12976 VPE: Manually selecting an asset deletes block configuration

Workaround:
Create a new block and copy the datapaths from the python editor view.
2023-03-09 PSAAS-12621 Missing cluster_phase handling in 5.3.5 and 5.4.0 installers

Workaround:
On all nodes: Edit the following file:

install/operations/deployment_operation.py Add a new line after line 50, in the same code block with matching indentation to surrounding lines: self.options.state.cluster_phase = self.options.cluster_phase After you do this, the installer will no longer encounter the first error.  To start the installer cleanly from scratch, we need to tell the installer to start from a clean state:

  1. Manually edit the .soar file.
  2. Set cluster_phase to ClusterPhase.NONE

Run the installer again with the following flag:

--continue-from PrepSystem

If the .soar file has an invalid ClusterPhase parameter set, services will not start up correctly; the edit to cluster_phase must be run even on standalone on-premises deployments.

2023-03-02 PSAAS-12433 Priv to unpriv migration script can fail if the phantom log folder is/contains symlinks or resides on a different volume than the one /opt/phantom is on
2023-03-02 PSAAS-12434, PSAAS-12851, PSAAS-12548, PSAAS-12549 Priv to unpriv migration can fail if root is not allowed to sudo or if sudo is not present on the system
2023-03-02 PSAAS-12427, PSAAS-12635 Python2 deprecation notice task in the installer fails if there are pipe characters in the repo/playbook/cf names.

Workaround:
Disable/delete any python 2 playbooks before upgrading to >= 5.3.4 or rename the playbooks/repos so that they no longer contain the pipe character.
2023-02-16 PSAAS-12333 Playbooks that open with smart block context warnings will disable the debugger and display 'Discard Changes' button

Workaround:
Save the playbook. The debugger is re-enabled and the Discard Changes button no longer displays.
2023-02-15 PSAAS-12311, PSAAS-12328 Prompt block icon disappear after creating more than one empty questions
2023-01-26 PSAAS-12057 Automation Broker (AB) configuration is ignored in the app editor

Workaround:
If the asset you're using while debugging in the App Editor is configured to use an Automation Broker this setting is ignored. Launching the app/debugging will not route to the automation broker, instead it always runs locally in the cloud instance.

To work around this issue:

  1. Publish the app.
  2. Run the published version of the app.
  3. Clone the published app so we can use the editor again.
  4. Manually change the cloned settings added to the json config.
  5. Delete the published app and its related asset.
  6. (Optional) create a new asset instead of deleting the previous one.
  7. Make the required code modifications.
  8. Repeat the process to debug again.
2023-01-10 PSAAS-11799 Forwarding data to Elastic Search does not work
2023-01-09 PSAAS-11797 App actions fail due to unescaped null characters (PSAAS-10127)
2022-12-09 PSAAS-11423 Custom Function Editor: Not saving data type change

Workaround:
Changing the code forces the type update.
2022-12-05 PSAAS-11328 VPE Empty Variables with inconsistent use of quotes
2022-11-30 PSAAS-11293 VPE: Debugger crashed in 5.4.0; Playbook run fails if it has an action with a 2+ minutes timer

Workaround:
No workaround, you could not use the timer but there are actions taking more than 2 minutes to complete and that cannot be changed.
2022-11-29 PSAAS-11272 Upgrade: nginx failed to start due to dhparams file being deleted during upgrade

Workaround:
  1. Run phenv python ./bin/initialize.py --set-dhparams
  2. Continue the installation with ./soar-install --continue-from=StartPhantom

2022-11-28 PSAAS-11235 SOAR mobile feature is not FIPS compliant

Workaround:
If you require FIPS compliance, turn off the the SOAR Mobile feature in the SOAR Administration settings. From the Home menu, select Administration, then Mobile.
2022-11-23 PSAAS-11233 Cannot register mobile devices on SOAR instances running RHEL8
2022-11-18 PSAAS-11190 VPE: Block Names with Container - A block name with "container" cannot share its results in other blocks in the Visual Editor

Workaround:
Do not use the word 'container' in playbook block names.
2022-11-09 PSAAS-11073 Action run limit not enforced before server restart
2022-11-08 PSAAS-11121 AppUpdate should continue to work with custom apps that have invalid versions

Workaround:
Uninstall the custom apps that are causing the blockage.
  1. To identify those custom apps, run the following script
    
    phenv phantom_shell
    apps = App.objects.filter(disabled=False)
    for app in apps:
      if not app.known_versions:
        print(app)
    
    print('done looking up custom apps')
    
    
  2. Use the AppUpdate wizard to update known app. See Splunk SOAR Connector for a list of apps that you can upgrade with the wizard.
  3. Reinstall those custom apps

Repeat these steps each time you want to upgrade certified apps.

2022-11-03 PSAAS-11049 Search setting failing on test connection.
2022-10-31 PSAAS-11004, PSAAS-11658 VPE: Values entered into custom function/Utility input arguments are deleted or modified

Workaround:
  1. Within the Visual Playbook Editor (VPE), populate a field in the utility block configuration panel.
  2. When complete, close the configuration panel.
  3. Re-open the configuration panel to populate another field.
  4. Repeat until you have completed all necessary fields.

2022-10-31 PSAAS-11001 Wrong results in PB: "NOT IN" clause wrongly returns FALSE in SOAR when there is a null value in its condition
2022-10-19 PSAAS-10818 Clicking "Learn more" link in playbook bulk edit modal opens generic doc link

Workaround:
Follow this link to learn more about on-premises playbooks and the move from Python 2 to Python 3:

What's new in 5.3.4 - Python 2 officially discontinued

2022-10-19 PSAAS-10817 Bulk edit of Python 2 playbook properties is not blocked
2022-10-17 PSAAS-10745 Cleaning up containers via Data Retention or the delete_containers.pyc script doesn't work

Workaround:
No current workaround.
2022-10-13 PSAAS-10703 Default workbook is reset on upgrade if the original default has been removed
2022-10-09 PSAAS-10655 Automation Broker: On-premises: failing to pair AB with global egress proxy
2022-09-26 PSAAS-10454 UI error when navigating to case evidence tab caused by linked container that was removed by retention.

Workaround:
None.
2022-09-07 PSAAS-10107 Status of Case is missing from Report

Workaround:
None known
2022-09-07 PSAAS-10127 Playbooks using Threat Grid or urlscan.io app hang on the detonation action

Workaround:
Upgrade the app you are using.
  1. From the Apps page, click App Updates.
  2. Upgrade the app to the appropriate version:
    • Threat Grid: upgrade to version 2.3.1 or higher
    • urlscan.io: upgrade to version 2.3.0 or higher

2022-08-17 PSAAS-9891 Indicators are visible with labels that roles do not allow
2022-04-29 PSAAS-8776 Investigation page: Widget layout and visibility is not saved via "manage widgets"

Workaround:
none known at this time
2022-04-08 PSAAS-8541 Unreadable characters sporadically appear in UI

Workaround:
Refresh the browser to reload the page.
2021-09-30 PSAAS-5408 /rest/widget_data/top_playbooks_actions endpoint returns invalid playbook_name field with tags

Workaround:
Parse the result manually to exclude the span tags around the playbook name.
Last modified on 22 February, 2024
PREVIOUS
Welcome to 5.4.0
  NEXT
Fixed issues for

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


Was this documentation topic helpful?


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