Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 5.9.0 - Administration Guide

Preface Introduction The concepts of SPS The Welcome Wizard and the first login Basic settings User management and access control Managing SPS
Controlling SPS: reboot, shutdown Managing Safeguard for Privileged Sessions clusters Managing a high availability SPS cluster Upgrading SPS Managing the SPS license Accessing the SPS console Sealed mode Out-of-band management of SPS Managing the certificates used on SPS
General connection settings HTTP-specific settings ICA-specific settings RDP-specific settings SSH-specific settings Telnet-specific settings VMware Horizon View connections VNC-specific settings Indexing audit trails Using the Search (classic) interface Using the Search interface Searching session data on a central node in a cluster Advanced authentication and authorization techniques Reports The SPS RPC API The SPS REST API SPS scenarios Troubleshooting SPS Configuring external devices Using SCP with agent-forwarding Security checklist for configuring SPS Jumplists for in-product help Third-party contributions About us

Next-hop router monitoring


By default, HA takeover occurs only if the master node stops working or becomes unreachable from the slave node. However, this does not cover the scenario when the master node becomes unaccessible to the outside world while the slave node would be still accessible (for example because it is connected to a different router).

To address such situations, you can specify IP addresses (usually next hop routers) to continuously monitor from both the master and the slave nodes using ICMP echo (ping) messages. One such address can be set up for every interface.

When setting up next hop monitoring, you have to make sure that the master and slave nodes can ping the specified address directly. You can either:

  • Choose the addresses of the redundant-HA SPS interfaces so that they are on the same subnet as the next-hop address

  • Configure the next-hop device with an additional IP-address that is on the same subnet as the redundant-HA SPS interfaces facing it

If any of the monitored addresses becomes unreachable from the master node while being reachable from the slave node (in other words, more monitored addresses are accessible from the slave node) then it is assumed that the master node is unreachable and a forced takeover occurs — even if the master node is otherwise functional.

Naturally, if the slave node is not capable of taking over the master node (for example because there is data not yet synchronized from the current master node) no takeover is performed.

To configure next hop monitoring, complete the following steps.

  1. Navigate to Basic Settings > High Availability > Next hop monitoring.

  2. Select the interface to use for monitoring its next-hop router.

    Figure 100: Basic Settings > High Availability — Configuring next hop monitoring

  3. Enter the IP address to monitor from the current master node (for example the IP address of the router or the switch connected to the interface) into the This node > Next hop IP field of the selected interface. This IP address must be a real IP address that is visible from the interface, and must be on the same local network segment.

    Use an IPv4 address.

  4. Enter the IP address to monitor from the current slave node (for example the IP address of the router or the switch connected to the interface) into the Other node > Next hop IP field of the selected interface. This IP address must be a real IP address that is visible from the interface, and must be on the same local network segment.

    Use an IPv4 address.

  5. Repeat the previous steps to add IP addresses to be monitored from the other interfaces if needed.

  6. Click Commit.


    For the changes to take effect, you have to restart both nodes. To restart both nodes, click Reboot Cluster.

Upgrading SPS

SPS appliances are preinstalled with a Long Term Support (LTS) release, it is recommended to upgrade to the latest LTS maintenance release as soon as possible. Each LTS release is supported for 3 years after original publication date, and for 1 year after the succeeding LTS release is published (whichever date is later). You are encouraged to upgrade to succeeding LTS releases.

Feature Releases provide additional features which are not yet consolidated to an LTS release. To gain access to these features, you may install a supported Feature Release on the appliance, with the following conditions:

  • You cannot roll back to an LTS release from a Feature Release.

  • Feature Releases are released and supported in a timeline of 6 months. You have to keep upgrading SPS to the latest Feature Release to ensure that your appliance is supported.

For both LTS and Feature Releases, One Identity regularly incorporates security patches and bugfixes, and issues updated Revisions of the released product. We strongly recommend always installing the latest Revision of the used software Release.


Downgrading from the latest Feature Release, even to an LTS release, voids support for SPS.

The following sections describe how to keep SPS up to date, and how to install a new license:

Upgrade checklist

The following list applies to all configurations:

  • You have created a configuration backup of SPS.

    For detailed instructions, refer to Exporting the configuration of SPS.

  • You have a valid support portal account.

    To download the required firmware file and license, you need a valid support portal account. Note that registration is not automatic, and might require up to two working days to process.

  • You have downloaded the latest SPS firmware from the Downloads page.

  • You have read the Release Notes of the firmware before updating. The Release Notes might include additional instructions specific to the firmware version.

    The Release Notes are available at the Downloads page.

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

  • Optional: You have exported core dump files, if necessary for debugging, from Basic Settings > Troubleshooting > Core files. These files are removed during upgrade.

If you have a high availability cluster:

  • 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.

  • You have verified on the Basic Settings > High Availability page that the HA status is not degraded.

If you are upgrading SPS in a virtual environment:

  • You have created a snapshot of the virtual machine before starting the upgrade process.

  • You have configured and enabled console redirection (if the virtual environment allows it).

During the upgrade, SPS displays information about the progress of the upgrade and any possible problems in the following places:

  • On the web interface of SPS, at any of the Listening addresses configured at Basic settings > Local Services > Web login (admin and user). (After booting, you are directed to the login screen of SPS.)


    If you are upgrading to version 5 F9 from version 5.0.x, this feature is enabled after the first boot to version 5 F9. So during the upgrade to version 5 F9, you will not be able to see any upgrade logs on the web interface.

  • On the console, which you can monitor with IPMI (ILOM) or console access.

The information displayed in the browser and on the console is the same.

We recommend that you test the upgrade process in a non-production (virtual, and so on) environment first.

Upgrading SPS requires a reboot. We strongly suggest that you perform the upgrade on the production appliance during maintenance hours only, to avoid any potential data loss.

Upgrading SPS (single node)


To upgrade SPS to a newer firmware version, complete the following steps. To upgrade SPS without using the web interface, see Firmware update using SSH. You are recommended to always use the latest maintenance release available.


When upgrading to a new major release (that is, to a new Feature Release or a new Long-Term Supported release), always follow the instructions of the How to upgrade to One Identity Safeguard for Privileged Sessions guide for that release, as it contains more detailed instructions (available at the Safeguard for Privileged Sessions Documentation page).


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.

  1. Navigate to Basic Settings > System > Firmwares.

    Figure 101: Basic Settings > System > Firmwares — Managing the firmwares

  1. Upload the new firmware: Browse for the firmware .iso file and then click Upload.

  2. To read the Upgrade Notes of the uploaded firmware, click on the icon. The Upgrade Notes are displayed in a pop-up window.

  3. Click Test for the new firmware to check if your configuration can be upgraded to version 5 F9. If the test returns any errors, correct them before continuing the upgrade process. If you encounter any problems, contact our Support Team.

  4. Caution:

    Proceed only if the upgrade test is successful.

    Activate the firmware, but do not reboot SPS yet.

  1. Navigate to Basic Settings > System > Traffic Control > This node, and choose Reboot.

    SPS attempts to boot with the new firmware. Wait for the process to complete.

  2. Login to the SPS web interface to verify that the upgrade was successful.

    Navigate to Basic Settings > System > Version details, or check the system log for the version numbers SPS reports on boot. In case you encounter problems, you can find common troubleshooting steps in Troubleshooting.

Related Documents