As an Appliance Administrator, you can use the Factory Reset feature to reset a Safeguard for Privileged Passwords Appliance to recover from major problems or to clear the data and configuration settings on the appliance.
Factory reset is not an option for virtual appliances. You will need to redeploy the appliance.
Caution: Care should be taken when performing a factory reset against a physical appliance, because this operation removes all data and audit history, returning it to its original state when it first came from the factory. Performing a factory reset will reset the BMC/IPMI interface as well the IP address. The appliance must go through configuration again as if it had just come from the factory. For more information, see Setting up Safeguard for Privileged Passwords for the first time.
In addition, performing a factory reset may change the default SSL certificate and default SSH host key.
The appliance resets to the current Long Term Support (LTS) version. For example, if you are using version 6.6 (feature release) or 6.0.6 LTS (maintenance Long Term Support release) and then factory reset, you appliance will reset down to 6.0 LTS and you will have to patch up to your current version. For more information, see Long Term Support (LTS) and Feature Releases.
Factory reset on a clustered appliance
Performing a factory reset on a clustered hardware appliance will not automatically remove the appliance from a cluster. The recommended best practice is to unjoin an appliance from the cluster before performing a factory reset on the appliance. After the unjoin and factory reset, the appliance must be configured again. For more information, see Setting up Safeguard for Privileged Passwords for the first time.
To perform a factory reset
- Go to Factory Reset on hardware (not virtual machine):
- desktop client: Navigate to Administrative Tools | Settings | Appliance | Factory Reset.
- Click Factory Reset.
In the Factory Reset confirmation dialog, enter the words Factory Reset and click OK.
The appliance will go into Maintenance mode to revert the appliance. Once completed, you will be prompted to restart the desktop client. If the appliance was in a cluster, you may need to unjoin the factory reset appliance. The factory reset appliance must be configured again. For more information, see Setting up Safeguard for Privileged Passwords for the first time. In addition, when you log in to the appliance, you will be prompted to add your Safeguard for Privileged Passwords licenses.
You can also perform a factory reset from the Recovery Kiosk or Support Kiosk. For more information, see Performing a factory reset.
It is the responsibility of the Appliance Administrator to manage the Safeguard for Privileged Passwords licenses.
The One Identity Safeguard for Privileged Passwords 3000 Appliance and 2000 Appliance ship with the Privileged Passwords module which requires a valid license to enable functionality.
You must install a valid license. Once the module is installed, Safeguard for Privileged Passwords shows a license state of Licensed and is operational. If the module license is not installed, you have limited functionality. That is, even though you will be able to configure access requests, if a Privileged Passwords module license is not installed, you will not be able to request a password release
Virtual appliance Microsoft Windows licensing
You must license the virtual appliance with a Microsoft Windows license. We recommend using either the MAK or KMS method. Specific questions about licensing should be directed to your Sales Representative. The virtual appliance will not function unless the operating system is properly licensed.
Licensing setup and update
To enter licensing information when you first log in
The first time you log in as the Appliance Administrator, you are prompted to add a licenses. The Success dialog displays when the license is added.
On the virtual appliance, the license is added as part of Initial Setup. For more information, see Setting up the virtual appliance.
To configure reminders for license expiration
To avoid disruptions in the use of Safeguard for Privileged Passwords, the Appliance Administrator must configure the SMTP server, and define email templates for the License Expired and the License Expiring Soon event types. This ensures you will be notified of an approaching expiration date. For more information, see Enabling email notifications.
Users are instructed to contact their Appliance Administrator if they get an "appliance is unlicensed" notification.
As an Appliance Administrator, if you receive a "license expiring" notification, apply a new license.
To update the licensing file
Licensing update is only available using a virtual machine, not via the hardware.
web client: To perform licensing activities
Go to the licensing page:
- Navigate to Settings| Appliance| Licensing.
- To upload a new license file, click Upload a new license file and browse to select the current license file.
- To remove the license file, select the license and click Remove selected license.
desktop client: To perform licensing activities
- Navigate to Administrative Tools | Settings | Appliance | Licensing.
- To upload a new license file, click Add License and browse to select the license file.
- To update a license file, select the license then select Update License in the lower left corner of a module's licensing information pane, select the license file, and click Open.
Lights Out Management (BMC)
The Lights Out Management feature allows you to remotely manage the power state and serial console to Safeguard for Privileged Passwords using the baseboard management controller (BMC). When a LAN interface is configured, this allows the Appliance Administrator to power on an appliance remotely or to interact with the Recovery Kiosk.
The Appliance Administrator can enable and configure the Lights Out Management feature. When Lights Out Management is enabled, the Appliance Administrator can set or change the password and modify the network information for the baseboard management console (BMC). When disabled, Safeguard for Privileged Passwords immediately resets the password to a random value and resets the network settings to default values.
Lights Out Management is only available using hardware (not a virtual machine). You can access Lights Out Management in the following ways:
- desktop client: Navigate to Administrative Tools | Settings | Appliance | Lights Out Management (BMC).
- Use the virtual appliance Support Kiosk, Lights Out Managment (BMC). For more information, see Support Kiosk.
LAN interface required
This feature requires a LAN interface to be enabled and configured. One Identity Safeguard for Privileged Passwords's BMC supports the following LAN interfaces to provide this functionality:
- IPMI v2
- Serial over Lan
It is strongly recommended that the LAN interface only be enabled in trusted environments.
To enable Lights Out Management
A static IP address will need to be assigned and a network cable will need to be connected to the IPMI ethernet port on the back of the appliance. This is in addition to the standard X0 network interface.
- Navigate to Administrative Tools | Settings | Appliance | Lights Out Management (BMC).
- Click the Enable Lights Out Management toggle to enable or disable this feature. Set toggle on or toggle off.
- Once enabled, enter the following information about the BMC:
- IP address: The IPv4 address of the host machine.
- Netmask: The network mask IPv4 address.
- Default Gateway: The default gateway IPv4 address.
Click the Set BMC Admin Password button to set the password for the host machine.
Maximum password length: 20 characters.
NOTE: If this feature was previously enabled, you will see an Update BMC Admin Password button instead. Optionally, click the Update BMC Admin Password button to reset the password for the host machine.
- Click OK to save the settings on the host machine.
Accessing the BMC
Once Lights Out Management is enabled in Safeguard for Privileged Passwords, you can access the BMC via:
- SSH to connect to the IPMI port to remotely manage the power state and serial console to Safeguard for Privileged Passwords
- Web browser
The SPP Kiosk Console can be accessed via Putty, Linux command line, or your preferred SSH Client.
- Connect to the IP assigned to the IPMI interface and login with the Admin user. (Default credentials are ADMIN/admin)
- At the prompt run: start /system1/sol1. There may be a delay. Please wait for the connection. A message like the following gives you the instructions to proceed:
->start / system1soll
press <Enter>, <Esc>, and then <T> to terminate session
(press the keys in sequence, one after the other)
- On the menu shown below, navigate using the arrow keys. Press the right arrow to select a menu option, press the left arrow to return to the menu list, press up or down to select a different menu option.
Appliance Information >
Power Options >
Admin Password Reset >
Factory Reset >
Support Bundle >
If the screen freezes, or displays distorted information, you can press CTRL+R or CTRL+D to refresh the screen.
To exit the Kiosk press Enter, then press ESC, then press SHIFT+T. At the prompt, type in exit.
If the appliance is in Quarantine, please generate a Quarantine Bundle from the Kiosk menu and copy the file to a network share. After the bundle is retrieved, perform a Reboot via the Kiosk, to see if the appliance will recover on its own. If it remains in Quarantine, a Factory Reset will likely be necessary. For more information, see Performing a factory reset.
Web browser interface
If you experience difficulty logging in through SSH, web access is also available.
- In your browser, go to the IP address of your IPMI interface. (ie. https://10.10.10.10), and login with your BMC admin account. The default is ADMIN/admin.
- You can attempt to fix the SSH connection, by navigating to Maintenance | Unit Reset | Select Reset. After 60 seconds re-attempt the SSH connection.
- Login to the Kiosk via the web by navigating to Remote Control | Select Launch SOL. (Java is required for this method, the Kiosk will launch in a JNLP window.)
- Use the cursor keys and return to navigate.. Page Up is used for backspace. It is not possible to copy and paste when using the Java viewer.
A reboot from the BMC web browser interface is only a hardware level reboot.
If you need to reboot using the web browser interface:
- Log into the BMC web browser interface.
- Open the Serial over Lan emulator, which opens the Kiosk interface.
- Select reboot from the menu.
See KB 263835: How to remotely access the Kiosk via the Lights Out Management / BMC / IPMI interface.