Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 6.0.11 - Administration Guide

Preface Introduction The concepts of One Identity Safeguard for Privileged Sessions (SPS) Cloud deployment considerations 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) Using SPS with SPP 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 Glossary

Connection backup

The connection backup, also known as data backup contains the audit files and connection metadata of a connection. It can be configured as a scheduled policy and is saved to a backup server.

For details on how to perform a connection backup of a connection, see: Creating data backups. It is a three-step process:

  1. Configure a system backup. Restoring a data backup works only if a matching system configuration and metadata is available, that is, if a system backup is restored first.

  2. Create a backup policy at Policies > Backup & Archive/Cleanup > Backup policies.

  3. Navigate to <Protocol name> Control > Connections. Select the connection you want to back up. Select the previously created backup policy in the Backup policy field.

For details on how to restore the configuration and data of One Identity Safeguard for Privileged Sessions (SPS) from a complete backup, for example, after a hardware replacement, see: Restoring SPS configuration and data.

The connection backup is used for

  • Saving the created audit trail files and indexing metadata of a connection to a remote share. This is a copy operation in terms of data files.

  • Recovery: In case of a hardware replacement, creating configuration export, system backup and connection backups is essential.

  • Migration: Creating a machine identical to another SPS machine.

The connection backup contains the following

  • The audit trails of the connection, that is, the .zat files storing the recorded activities of the administrators. For details on audit trails, see Audit Policies.

  • The index of the audit trail that makes the content of the audit trail searchable. For details on indexing audit trails, see Indexing audit trails.

 NOTE:

Audit trails and index files are large. This means that backing up a connection requires a significant amount of free hardware space. Make sure you have enough free hardware space for those connections that you want to back up.

Connection archive

The connection archive, also known as data archive contains the audit files and connection metadata of a connection. In terms of contents, it is similar to a connection backup. It can be configured as a scheduled policy and is saved to an archive server. Archiving transfers data from One Identity Safeguard for Privileged Sessions (SPS) to an external storage solution, cleanup removes (deletes) old files. Archived data can be accessed and searched, but cannot be restored (moved back) to the SPS appliance.

For details on how to perform a connection archive of a connection, see: Archiving or cleaning up the collected data. It is a two-step process:

  1. Create an archive policy at Policies > Backup & Archive/Cleanup > Archive/Cleanup policies.

  2. Navigate to <Protocol name> Control > Connections. Select the connection you want to archive. Select the previously created archive policy in the Archive/Cleanup policy field.

 Caution:

Hazard of data loss Never delete an Archive Policy if data has been archived with it. This will make the already archived data inaccessible.

Do not "remake" an Archive Policy (that is, deleting an Archive Policy and then creating another one with the same name but different parameters). This will make data inaccessible, and identifying the root cause of the issue complicated.

If you want to change the connection parameters (that is when you perform a storage server migration), you must make sure that the share contents and file permissions are kept unmodified and there are no archiving or backup tasks running.

On the other hand, if you want to add a new network share to your archives, proceed with the following steps:

  1. Create a new empty SMB/NFS network share.

  2. Create a new Archive Policy that points to this network share.

  3. Modify your Connection Policy(es) to archive using the newly defined Archive Policy.

  4. Make sure to leave the existing Archive Policy unmodified.

It is also safe to extend the size of the network share on the server side.

The connection archive is used for

  • Moving the created audit trail files and indexing metadata of a connection to a remote share. This is a move operation in terms of data files. Archived data can be accessed and searched, but cannot be restored (moved back) to the SPS appliance.

  • Freeing up hardware space on SPS.

The connection archive contains the following

  • The audit trails of the connection, that is, the .zat files storing the recorded activities of the administrators. For details on audit trails, see Audit Policies.

  • The index of the audit trail that makes the content of the audit trail searchable. For details on indexing audit trails, see Indexing audit trails.

Support bundle

To track down support requests, the One Identity Support Team might request you to collect system-state and debugging information. This information is collected automatically, and contains log files, the anonymized excerpt of the configuration export file of One Identity Safeguard for Privileged Sessions (SPS), and various system-statistics. To generate a support bundle, navigate to Basic Settings > Troubleshooting > Create support bundle.

The exported file is a zip-compressed archive.

The name of the exported file is debug_info-<hostname>YYYYMMDDHHMM. Sensitive data like key files and passwords are automatically removed from the configuration files.

For details on how to create a support bundle, see: Collecting logs and system information for error reporting.

The support bundle is used for

  • Collecting a snapshot of the past week's system-state information for the One Identity Support Team for troubleshooting and debugging purposes.

  • Collecting information about a specific error by generating data for a defined time interval where the event that causes the error is reproduced. This is also used by the One Identity Support Team for troubleshooting and debugging purposes.

The support bundle contains the following

  • Debug logs, Connection logs and OS logs of the past week, one file per day. If there are too many events in a day, the log file in the support bundle only contains a truncated version of the connection logs. In this case, the complete log file is only accessible at /var/log/messages-<day>.

  • An excerpt of the configuration export file:

    • The anonymized version of the configuration XML file

    • Plugins

  • System-state information (for example, version details, statistics, memory usage, system warnings, and so on).

  • List of core files. This list might indicate previous system crashes.

  • RAID controller information.

  • Upgrade logs

  • Dashboard data

Debug logs

To increase the log level of the non-connection-related events, for example, to add the commands executed by the One Identity Safeguard for Privileged Sessions (SPS) web interface to the logs, enable debug level logging at Basic Settings > Management > Verbose system logs > Enable.

These logs are accessible at /var/log/scb-<day>.

The debug logs are used for

  • Our Support Team uses this to investigate the reasons behind a web user interface-related issue.

The debug logs contain the following

  • Logs generated by the SPS web interface.

  • System daemon logs.

  • Logs of periodic cron jobs.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating