Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 5.10.0 - Upgrade Guide


Welcome to One Identity Safeguard for Privileged Sessions (SPS) version 5 F10 and thank you for choosing our product. This document describes the upgrade process from existing SPS installations to SPS 5 F10. The main goal of this paper is to help system administrators in planning the migration to the new version of SPS.


Read the entire document thoroughly before starting the upgrade.

This document covers the One Identity Safeguard for Privileged Sessions 5 F10 product.

Versions and releases of SPS

As of June 2011, the following release policy applies to One Identity Safeguard for Privileged Sessions:

  • Long Term Supported or LTS releases (for example, SPS 4 LTS) are supported for 3 years after their original publication date and for 1 year after the next LTS release is published (whichever date is later). The second digit of the revisions of such releases is 0 (for example, SPS 4.0.1). Maintenance releases to LTS releases contain only bugfixes and security updates.

  • Feature releases (for example, SPS 4 F1) are supported for 6 months after their original publication date and for 2 months after a succeeding Feature or LTS release is published (whichever date is later). Feature releases contain enhancements and new features, presumably 1-3 new features per release. Only the last feature release is supported (for example, when a new feature release comes out, the last one becomes unsupported in 2 months).

For a full description of stable and feature releases, open the SPS product page on the Support Portal and navigate to Product Life Cycle & Policies > Product Support Policies > Software Product Support Lifecycle Policy.


Downgrading from a feature release is not supported. If you upgrade from an LTS release (for example, 4.0) to a feature release (4.1), you have to keep upgrading with each new feature release until the next LTS version (in this case, 5.0) is published.

Prerequisites for upgrading SPS

This section describes the requirements and steps to perform before starting the SPS upgrade process.

  • You must have a valid software subscription to be able to download the new version of SPS, and also the new license file.

  • You will need a support portal account to download the required ISO image. Note that the registration is not automatic, and might take up to two working days to be processed.

  • Back up your configuration and your data.

    For more information on creating configuration and data backups, see "Data and configuration backups" in the Administration Guide.

  • Export your configuration.

    For more information, see "Exporting the configuration of SPS" in the Administration Guide.

  • Verify that SPS is in good condition (no issues are displayed on the System Monitor).

  • Optional: If you have core dump files that are necessary for debugging, download them from Basic Settings > Troubleshooting > Core files. These files are removed during the upgrade process.

If you have a high availability cluster:

  • Verify that you have IPMI access to the slave node. You can find detailed information on using the IPMI interface in the following documents:

    For SPS T4 and T10, see the X9 SMT IPMI User's Guide. For SPS T1, see the SMT IPMI User's Guide.

  • On the Basic Settings > High Availability page, verify that the HA status is not degraded.

If you are upgrading SPS in a virtual environment:

  • Create a snapshot of the virtual machine before starting the upgrade process.

  • Configure and enable console redirection (if the virtual environment allows it).

Notes and warnings about the upgrade

The following is a list of important notes and warnings about the upgrade process and changes in SPS 5 F10.


Due to a change in the underlying database, the upgrade process removes all risk scores generated earlier by One Identity Safeguard for Privileged Analytics. Sessions initiated after the upgrade will be scored again.

  • SSLv3 encryption is not supported in SPS version 5.10 and later. This has the following effects:

    • You cannot configure SPS if your browser does not support at least TLSv1.

    • If you are auditing HTTP, Telnet or VNC sessions that use TLS encryption, the client- and server applications must support at least TLSv1.

  • Support for X.509 host certificates is deprecated. This feature will be removed from SPS version 6 LTS (6.0). One Identity recommends using public keys instead.

  • Support for DSA keys is deprecated. This feature will be removed from SPS version 6 LTS (6.0). One Identity recommends using RSA keys instead.


Due to a bug in the SPS 5.7 release, in order to upload this firmware to an installation running SPS version 5.7, you have to upload the new image on the web interface and then activate it in the console menu. From SPS version 5.8 or SPS version 5.9, direct upgrade is possible on the web interface.


As part of the upgrade, SPS upgrades its session database. This involves the following processes:

  • The first phase of the upgrade happens before SPS boots up and takes about 10-20 minutes. During this time, no production traffic goes through SPS, and SPS functionality is inaccessible. Rebooting or shutting down SPS at this stage of the upgrade may result in data loss. You can check the status of the upgrade process through either the console or the boot-time HTTP server, which allows you to view boot console log messages through your browser.
  • Depending on the size of the session database, the second phase can take several days or even weeks to finish. You can check the status of the upgrade process through the System Monitor on the web interface of SPS.

    This second phase of the upgrade is running in the background and consumes minimal resources. All functionality of SPS is accessible and SPS works as normal. The only limitation during this phase is that the session database used when searching on the REST API and the new Search interface is incomplete. The upgrade process starts with the most recent sessions and works its way backward in time until it reaches the oldest sessions. The classic search is unaffected.

If there are any errors during the upgrade, contact our Support Team.


Following the upgrade, support for less than 1024-bit SSH keys is lost.


SPS 5 F4 and later versions use a new encryption algorithm to encrypt the recorded audit trails (AES128-GCM). This change has the following effects:

  • If you are using external indexers to index your audit trails, you must upgrade them to the latest version. Earlier versions will not be able to index encrypted audit trails recorded with SPS 5 F4 and later.

  • To replay an encrypted audit trail recorded with SPS 5 F4 or later, you can use the latest version of the Safeguard Desktop Player application, or the browser-based player of SPS. You cannot replay such audit trails using earlier versions of Safeguard Desktop Player, nor any version of the Audit Player application.


It is no longer possible to search for screen contents indexed by the old Audit Player on the new search UI and the REST interface. Searching in session metadata (such as IP addresses and usernames) and in extracted events (such as executed commands and window titles that appeared on the screen) remains possible.

As the old Audit Player was replaced and deprecated as an indexing tool during the 4.x versions, this should only affect very old sessions. Sessions that were processed by the new indexing service will work perfectly. If you wish to do screen content searches in historical sessions, contact our Support Team.


The Basic Settings > Local Services > Required minimum version of encryption protocol option is removed as of One Identity Safeguard for Privileged Sessions (SPS) version 5.8.0.

Regardless of the TLS version you configured previously, SPS will uniformly use TLS version 1.2.

This change might have the effect that using old (likely unsupported) browsers, it will not be possible to access the web interface of SPS.


Command detection and window title detection in content policies have changed and they are case-insensitive as of One Identity Safeguard for Privileged Sessions (SPS) version 5.8.0. In earlier versions, both used to be case-sensitive.


You can now use an Authentication Policy with GSSAPI and a Usermapping Policy in SSH connections. When an SSH Connection Policy uses an Authentication Policy with GSSAPI, and a Usermapping Policy, then SPS stores the user principal as the Gateway username, and the username used on the target as the Server username.

Note that this change has the following side effect: when using an Authentication Policy with GSSAPI, earlier versions of SPS used the client-username@REALM username to authenticate on the target server. Starting with version 5.9.0, it uses the client-username as username. Configure your servers accordingly, or configure a Usermapping Policy for your SSH connections in SPS.

Upgrading from SPS 5.0.0 or later


Physical SPS appliances based on Pyramid hardware are not supported in 5 F1 and later feature releases. Do not upgrade to 5 F1 or later on a Pyramid-based hardware. The last supported release for this hardware is 5 LTS, which is a long-term supported release.

If you have purchased SPS before August, 2014 and have not received a replacement hardware since then, you have Pyramid hardware, so do not upgrade to SPS 5 F1 or later. If you have purchased SPS after August 2014, you can upgrade to 5 F1.

If you do not know the type of your hardware or when it was purchased, complete the following steps:

  1. Login to SPS.

  2. Navigate to Basic Settings > Troubleshooting > Create support bundle, click Create support bundle, and save the file.

  3. Open a ticket at

  4. Upload the file you downloaded from SPS in Step 1.

  5. We will check the type of your hardware and notify you.

Upgrade path to SPS 5 F10

Upgrading to SPS 5 F10 is tested and supported using the following upgrade path:

  • The latest SPS 5 LTS maintenance version (for example, 5.0.x) -> SPS 5 F10

    Always upgrade to the latest available maintenance version of SPS 5 LTS before upgrading to SPS 5 F10.

  • The latest maintenance versions of the previous three feature releases (in this case, SPS 5 F6 or later) -> SPS 5 F10

    Always upgrade to the latest available maintenance version of the feature release before upgrading to SPS 5 F10.

From older releases, upgrade to 5 LTS first. For details, see How to upgrade to One Identity Safeguard for Privileged Sessions 5 LTS.

Self Service Tools
Knowledge Base
Notifications & Alerts
Product Support
Software Downloads
Technical Documentation
User Forums
Video Tutorials
RSS Feed
Contact Us
Licensing Assistance
Technical Support
View All
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating