Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 5.8.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

Troubleshooting plugins

On the default log level, SPS logs everything that the plugin writes to stderr. SPS logs the communication with the plugin on debug log level.


SPS periodically creates reports on the activity of the administrators, its system information, as well as the processed traffic. In addition, you can use the connection database for creating custom reports from connection statistics.

These reports are available in Portable Document (PDF) format by selecting Reporting > Reports from the Main Menu. The reports are displayed on a search interface. For more information on using and customizing this interface, see Using the internal search interface.

The reports are also sent to the e-mail address set at Basic Settings > Management > Mail settings > Send reports to, unless specified otherwise in the configuration of the report.


If the Basic Settings > Management > Mail settings > Send reports to address is not set, the system report is sent to the SPS administrator's e-mail address.

Figure 255: Reporting > Reports — Browsing reports

Reports can be generated for fixed periods:

  • Daily reports are generated every day at 00:01.

  • Weekly reports are generated every week on Monday at 00:01.

  • Monthly reports are generated on the first day of every month at 00:01.

You can also generate a partial report if necessary, for details, see Generating partial reports.

To access the reports from the SPS web interface, the user must have the appropriate privileges (for custom reports, the default requirement is membership in the search group). In addition, individual reports might have different access requirements configured. For more information on configuring user rights, see Managing user rights and usergroups.

The following information is available about the reports:

  • Download: A link to download the report.

  • Name: Name of the report.

  • Interval: The length of the reported period, for example week, month, and so on.

  • Report from: The start of the reported interval.

  • Report to: The end of the reported interval.

  • Generate time: The date when the report was created.


Use the time bar to find reports that contain a particular period. If you select a period (for example click on a bar), only those reports will be displayed that contain information about the selected period.

Contents of the operational reports

The operational reports of SPS are available in Adobe Portable Document Format (PDF), and contain the following information:

  • Configuration changes: Lists the number of SPS configuration changes per page and per user. The frequency of the configuration changes is also displayed on a chart.

  • Main reports: Contains statistics about the total traffic that passed SPS, including the number of sessions that passed for every connection policy, the used usernames, clients, and servers, and so on.


    Connections that are still in progress when the report is generated are excluded from the report. Sessions that are being indexed and reporting jobs are listed in the Sessions with in progress indexing or reporting jobs section of the report.

  • Reports by connection: Contains separate statistics about every connection policy configured on SPS.

  • System health information: Displays information about the filesystem and network use of SPS, as well as the average load.

Configuring custom reports


To configure a report, create a chapter and assign any of the existing subchapters to it. The following sources (statistics or other queries) are available as reporting subchapters:

To configure SPS to create custom reports, complete the following steps with a user that has read & write/perform access to the Reporting > Content subchapters privilege.

For more information on configuring user rights, see Managing user rights and usergroups.

  1. Login to the SPS web interface, and navigate to Reporting > Configuration.

    Figure 256: Reporting > Configuration — Configuring custom reports

  2. Click and enter a name for the custom report.

  3. Select Table of contents > Add Chapter, enter a name for the chapter, then click OK. Repeat this step to create further chapters if needed.

  4. If you want to have the logo of your organization on the cover page of the report (instead of the One Identity logo), select Choose new logo > Browse, select your logo file, then click Upload. You can upload GIF, JPEG, and PNG images. SPS will automatically resize the image to fit on the cover page.

  5. Select Add Subchapter to add various reports and statistics to the chapter. The available reports will be displayed in a pop-up window.

    • Subchapters created from indexed contents of audit trails are listed under Misc.

    • Subchapters created from custom statistics are listed under Search statistics.

    • Subchapters created from custom database queries are listed under Advanced statistics.

    • Subchapters created from search queries are listed under Search-based subchapters.

    Figure 257: Reporting > Configuration > Add Subchapter — Adding subchapters to reports


    When creating a subchapter that searches for keywords in HTTP, only the timestamp of the results will be visible in the report, without data.

  6. Use the arrows to change the order of the subchapters if needed.

  7. Select how often shall SPS create the report from the Generate this report every field. Weekly reports are created on Mondays, while monthly reports on the first day of the month. If you want to generate the report only manually, leave this field empty.

  1. By default, members of the report group can access the custom reports via the SPS web interface. To change this, enter the name of a different group into the Reports are accessible by the following groups field, or click to grant access to other groups.


    Members of the listed groups will be able to access only these custom reports even if their groups does not have read access to the Reporting > Reports page. However, only those reports will be listed, to which their group has access to.

  2. By default, SPS sends out the reports in e-mail to the address set in the Basic Settings > Management > Mail settings > Send reports to field.


    If this address is not set, the report is sent to the SPS administrator's e-mail address.

    • To disable e-mail sending, unselect the Send reports in e-mail option.

    • To e-mail the reports to a different address, select Recipient > Custom address, and enter the e-mail address where the reports should be sent. Click to list multiple e-mail addresses if needed.

  3. Click Commit.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating