Chat now with support
Chat with Support

One Identity Safeguard for Privileged Passwords 6.7 - Administration Guide

Introduction System requirements and versions Using API and PowerShell tools Using the virtual appliance and web management console Cloud deployment considerations Setting up Safeguard for Privileged Passwords for the first time Using the web client Getting started with the desktop client Using the desktop client Search box Privileged access requests Toolbox Accounts Account Groups Assets Asset Groups Discovery Entitlements Partitions Settings
Access Request settings Appliance settings Asset Management settings Backup and Retention settings Certificates settings Cluster settings Enable or Disable Services settings External Integration settings Messaging settings (desktop client) Password Management settings Safeguard Access settings SSH Key Management settings
Users User Groups Disaster recovery and clusters Administrator permissions Preparing systems for management Troubleshooting Frequently asked questions Appendix A: Safeguard ports Appendix B: SPP 2.7 or later migration guidance Appendix C: SPP and SPS join guidance Appendix D: Regular Expressions SPP Glossary About us

Appliance settings

Use the Appliance settings to view general information about the appliance, run diagnostic tools, and reset or update the One Identity Safeguard for Privileged Passwords hardware appliance.

Safeguard for Privileged Passwords can be set up to use a virtual appliance. For more information, see Using the virtual appliance and web management console.

web client: Navigate to Settings | Appliance.

desktop client: Navigate to Administrative Tools | Settings | Appliance.

One Identity Safeguard for Privileged Passwords provides the following information to help you resolve many common problems you may encounter as you deploy and use your appliance.

Table 120: Appliance settings
Setting Description

Appliance Diagnostics

Where you execute a trusted, secure diagnostics package to help solve a configuration issue, synchronization issue, clustering issue, or other internal issues.

Appliance Information

Where you view general information about the appliance, as well as its performance utilization and the memory usage.


web client

Where you enable or disable debug logging to a syslog server.

Enable or disable A2A and audit log stream

desktop client

Where you enable or disable the Application to Application functionality and the Audit Log Stream Service.

web client: To enable or disable services, see Enable or Disable Services settings. A2A is not in the web client but Audit Log Stream Service is in the web client.

Factory Reset

Available on hardware only not a virtual machine.

Where you perform a factory reset to revert your appliance to its original state when it first came from the factory.

Licensing settings

Where you add or update a Safeguard for Privileged Passwords license.

Lights Out Management (BMC)

Available on hardware only not a virtual machine.

Where you enable and disable lights out management, which allows you to remotely manage the power state and serial console to Safeguard for Privileged Passwords using the baseboard management controller (BMC).

Network Diagnostics

Where you run diagnostic tests on your appliance.

Networking Where you view and configure the primary network interface, and if applicable, the sessions network interface.
Operating System Licensing

Available on virtual machine only not via hardware.

Where you configure the operating system for the virtual appliance.

SSH Algorithms

Where you configure SSH Algorithms to manage account passwords and SSH keys.

Patch Updates

web client

Where you upload and install a patch update file.

desktop client: Updates


web client

Where you shut down or restart your appliance in the web client.

desktop client:

Support bundle

Where you create a support bundle containing system and configuration information to send to One Identity Support to analyze and diagnose issues with your appliance.


Where you enable Network Time Protocol (NTP) and set the primary and secondary NTP servers. A replica in the cluster will always reference the primary appliance as its NTP server.

You can also manually set the time on a primary but not a cluster.

CAUTION: Manually setting the time should be done with caution. Time changes can cause critical data loss.

Patch Updates

desktop client

Where you upload and install an update file.

web client: Patch Updates

In addition to the appliance options, One Identity Safeguard for Privileged Passwords provides these troubleshooting tools:

Table 121: Additional troubleshooting tools
Tool Description

Activity Center

desktop client

View the details of specific events or user activity. For more information, see Activity Center.
LCD status messages Use the LCD screen on the appliance to view the status of the appliance as it is starting up or shutting down. For more information, see LCD status messages.
Recovery Kiosk (Serial Kiosk) A terminal or laptop connected directly to the appliance to view basic appliance information, restart the appliance remotely, shut down the appliance, reset the bootstrap administrator’s password to its initial value, perform a factory rest, or to generate and send a support bundle to a Windows share. For more information, see Recovery Kiosk (Serial Kiosk).

Appliance Diagnostics

Appliance Administrators can execute a trusted, secure appliance diagnostics package to help solve issues with configuration, synchronization, and clustering, as well as other other internal challenges. The appliance diagnostics package is available from the web Support Kiosk, not the Serial Kiosk (Recovery Kiosk). The appliance diagnostics package can be used even when the appliance is in quarantine. To protect against external threats, Safeguard rejects illegitimate appliance diagnostics packages. The manifest file in the appliance diagnostics package lists criteria that may include the minimum Safeguard version, appliance ID, and expiration time-stamp UTC. New product code and database changes are not included in an appliance diagnostics package.

web client: Navigate to Settings | Appliance | Appliance Diagnostics.

desktop client: Navigate to Administrative Tools | Settings | Appliance | Appliance Diagnostics.

  1. The state of the appliance displays (for example, Online). Click Refresh to update the state.
  2. If no appliance diagnostics package has been loaded, click Upload Diagnostics, select the appliance diagnostics package file that has an .sgd extension, then click Open.
    • If the upload criteria is not met, the appliance diagnostics package is not uploaded and a message like the following displays: The minimum Safeguard version needed to run this diagnostic package is <version>.
    • If the upload is successful, the Diagnostic Package Information displays with the Status of Staged. You can:
      • Select Execute and wait until the Status changes to Completed or Error.
      • Select Remove to delete the appliance diagnostics package and the associated log file.
  3. Once uploaded, you can perform these activities.
    • If the Expiration Date has not passed, you can select Execute to execute the appliance diagnostics package again.
    • Select Delete to delete the appliance diagnostics package, the associated log file, and stop any appliance diagnostics package that is running. Before uploading a different appliance diagnostics package, you must delete the current one because there can be only one appliance diagnostics package per appliance.
    • Select Download Log to save the log file. Audit log entries are available through the Activity Center during and after execution and are part of the appliance history. A log is also available during and after execution until the diagnostic package has been deleted.

Appliance Information

It is the responsibility of the Operations Administrator or the Appliance Administrator to monitor the status of the appliance.

To go to Appliance Information:

  • web client: Navigate to  Settings | Appliance | Appliance Information.

  • desktop client: Navigate to Administrative Tools | Settings | Appliance | Appliance Information.

To refresh:

  • web client: Select the number of seconds to refresh in Refresh every 30 seconds . A refresh is started immediately when the value is changed and the next refresh is scheduled based on the selected value.
  • desktop client: Click Refresh to update the information.

The following information displays.

Table 122: Appliance properties
Property Description
Appliance Name

The name of the appliance.
The Appliance Administrator can modify the name. Click Edit to enable the Appliance Name text box. Enter a new appliance name and click Save.


web client

The appliance network server IP address.

Client Version

desktop client

The version of the Safeguard for Privileged Passwords desktop client application.
Appliance Version The version of the Safeguard for Privileged Passwords Appliance.

Operating System Version

desktop client

The version of the operating system that is running on the appliance.

Operating System Level

desktop client

The level of the operating system.

Uptime The amount of time (hours and minutes) the appliance has been running.

Last Boot Date

web client

The last date the appliance was booted up.

General tab information

Disk is a graphical display of the amount of used and free disk space. When the disk usage is over 80%, the log reflects: DiskUsageWarningEvent.

Table 123: General tab
Property Description
Manufacturer The system manufacturer.
Model The system model.
Bios Description The system bios description.
Bios Serial Number The system's bios serial number.
Serial Number The media access control address (MAC address) assigned to the network interface for communications.
Ship Date The appliance ship date.
Processor The processor information.
Virtual Memory The virtual memory allocation.
Physical Memory

The physical memory allocation.

TLS 1.2 only

Click this toggle to disable earlier versions of the Transport Layer Security (TLS) protocol and use only TLS v1.2.

NOTE: You must reboot your appliance after enabling TLS 1.2 only.

web client: enabled and disabled

desktop client: enabled and disabled


From the desktop client: Use the General tab, Power section to perform the following:

From the web client, see Power to shut down or restart an appliance via  Settings | Appliance | Power.

Performance tab
Table 124: Performance tab
Property Description

Total CPU and Core_n

web client


desktop client

Displays the CPU information and the performance utilization of your appliance.
Memory Displays the memory usage of your appliance; what is currently in use and what is free.

Disk Space

web client

Displays the disk space used and free.

Shutting down the appliance

You can power down an appliance from the Windows desktop client, web client, or directly from the appliance itself.

Caution: Rebooting the appliance causes a service outage for any current users.

desktop client: To shut down an appliance

  1. Navigate to Administrative Tools | Settings | Appliance | Appliance Information.
  2. On the General tab, under Power, type a Reason for shutting down the aAppliance then click Shut Down.
  3. To confirm your action, enter the words Shut Down in the box and click OK.
  4. The One Identity Safeguard for Privileged Passwords Appliance LCD screen displays LCD service terminating.

web client: To shut down an appliance

You can shut down your appliance from the web client via  Settings| Appliance| Power. For more information, see Power.

Appliance: Shut down from the appliance

You can use the Red X button on the front panel of the appliance to shut it down. Press and hold the Red X button for four seconds until it displays POWER OFF.

Caution: Once the Safeguard appliance is booted, DO NOT press and hold the Red X button for more than 13 seconds. This will hard power off the appliance and may result in damage.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating