Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 6.0 LTS - Administration Guide

Preface Introduction The concepts of One Identity Safeguard for Privileged Sessions (SPS) The Welcome Wizard and the first login Basic settings
Supported web browsers and operating systems The structure of the web interface Network settings Configuring date and time System logging, SNMP and e-mail alerts Configuring system monitoring on SPS Data and configuration backups Archiving and cleanup Forwarding data to third-party systems Joining to One Identity Starling
User management and access control Managing One Identity Safeguard for Privileged Sessions (SPS)
Controlling One Identity Safeguard for Privileged Sessions (SPS): reboot, shutdown Managing Safeguard for Privileged Sessions (SPS) clusters Managing a high availability One Identity Safeguard for Privileged Sessions (SPS) cluster Upgrading One Identity Safeguard for Privileged Sessions (SPS) Managing the One Identity Safeguard for Privileged Sessions (SPS) license Accessing the One Identity Safeguard for Privileged Sessions (SPS) console Sealed mode Out-of-band management of One Identity Safeguard for Privileged Sessions (SPS) Managing the certificates used on One Identity Safeguard for Privileged Sessions (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 interface Searching session data on a central node in a cluster Advanced authentication and authorization techniques Reports The One Identity Safeguard for Privileged Sessions (SPS) RPC API The One Identity Safeguard for Privileged Sessions (SPS) REST API One Identity Safeguard for Privileged Sessions (SPS) scenarios Troubleshooting One Identity Safeguard for Privileged Sessions (SPS) Configuring external devices Using SCP with agent-forwarding Security checklist for configuring One Identity Safeguard for Privileged Sessions (SPS) Jumplists for in-product help LDAP user and group resolution in SPS Appendix: Deprecated features

Upgrading One Identity Safeguard for Privileged Sessions (SPS)

One Identity Safeguard for Privileged Sessions (SPS) appliances are preinstalled with a Long Term Support (LTS) release. One Identity recommends that you 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. One Identity strongly recommends always installing the latest Revision of the used software Release.

 Caution:

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 One Identity Safeguard for Privileged Sessions (SPS).

    For detailed instructions, refer to Exporting the configuration of One Identity Safeguard for Privileged Sessions (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 secondary node. You can find detailed information on using the IPMI interface in the following documents:

    For Safeguard Sessions Appliance 3000 and 3500, see the X9 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.)

    		 NOTE:

    If you are upgrading to version 6.0 from version 5.0.x, this feature is enabled after the first boot to version 6.0. So during the upgrade to version 6.0, 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.

One Identity strongly recommends 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 One Identity Safeguard for Privileged Sessions (SPS) (single node)

The following describes how to upgrade One Identity Safeguard for Privileged Sessions (SPS) to a newer firmware version. To upgrade SPS without using the web interface, see Firmware update using SSH. One Identity recommends that you always use the latest maintenance release available.

 Caution:

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

 Caution:

Physical SPS appliances based on Pyramid hardware are not supported in 5 F1 and later 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 https://support.oneidentity.com/create-service-request/.

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

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

To upgrade SPS to a newer firmware version

  1. Navigate to Basic Settings > System > Firmwares.

    Figure 102: 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 6.0. 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.

Upgrading a high availability One Identity Safeguard for Privileged Sessions (SPS) cluster

The following describes how to upgrade a high availability One Identity Safeguard for Privileged Sessions (SPS) cluster to a newer firmware version. One Identity recommends that you always use the latest maintenance release available.

 Caution:

If you have nodes with the Search Minion role configured, see Upgrading a high availability One Identity Safeguard for Privileged Sessions (SPS) cluster to avoid a critical error.

 Caution:

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

 Caution:

Physical SPS appliances based on Pyramid hardware are not supported in 5 F1 and later 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 https://support.oneidentity.com/create-service-request/.

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

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

To upgrade a high availability SPS cluster to a newer firmware version

  1. Navigate to Basic Settings > System > 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 6.0. 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 > High availability, and verify that the new firmware is active on the secondary node. This might take a few minutes.

  2. In Basic Settings > High availability > Other node, click Shutdown.

  3. Restart the primary node: click This node > Reboot.

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

  4. Login to the SPS web interface to verify that the primary node 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.

  5. Use the IPMI interface to power on the secondary node.

    The secondary node attempts to boot with the new firmware, and reconnects to the primary node to sync data. During the sync process, certain services (including Heartbeat) are not available. Wait for the process to finish, and the secondary node to boot fully.

  6. Navigate to Basic Settings > High availability and verify that the secondary node is connected, and has the same firmware versions as the primary node.

 Caution:

If you have nodes with the Search Minion role configured, the Search Minion nodes must be upgraded first during high availability cluster upgrade. If you upgrade the Search Master node first, it is possible that a Search Minion node will create a legacy Elasticsearch index before the init script on the Search Master creates a new one. In this case, the Elasticsearch index will contain invalid schema mapping data, therefore as the high availability cluster’s schema changes, the Search Minion nodes cannot push their documents into Elasticsearch, resulting in a critical error.

To avoid the critical error mentioned above, follow the method below to upgrade a high availability SPS cluster with Search Minion nodes to a newer firmware version

  1. Set the Search Master node for upgrade so that it uses the newer firmware version for reboot. To do this, complete steps 1-11 of To upgrade a high availability SPS cluster to a newer firmware version.
  2. Click Shutdown.
  3. Upgrade your Search Minion nodes one after the other, using the method in steps 1-2 above.
  4. Reboot the Search Master node, which will now boot with the newer firmware version.

With this method you detach the Search Minion nodes from the Search Master node and upgrade them separately before any other nodes. As a result, the whole high availability cluster will use the newer firmware version after reboot.

If you have accidentally upgraded the Search Master node first and encounter this critical error, contact our Support Team.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating