Shared Services Backup and Recovery

Background........................................................................................................................................... 1 Known Issue ......................................................................................................................................... 2 Possible Causes................................................................................................................................. 3 Workarounds..................................................................................................................................... 4 Backing Up Shared Services ................................................................................................................ 4 Recovering from a Corrupted State ...................................................................................................... 5 Regular Recovery ............................................................................................................................. 5 Recovering from Catastrophic Failures ............................................................................................ 5

Background
Hyperion System 9 Shared Services ships with an embedded open-source LDAP server (OpenLDAP). OpenLDAP stores provisioning information, such as a list of users, their roles, and related information. In Windows environments, OpenLDAP is installed as the Hyperion SharedService9 OpenLDAP service, as shown in the Windows service control manager:

Shared Services Backup and Recovery

The OpenLDAP process (slapd) is shown running in the Windows task manager:

Known Issue
The Shared Services OpenLDAP service may become corrupted if it is not shut down properly. Corruption may happen if: The machine is forcibly shut down without a proper Windows shutdown. The OpenLDAP process is terminated from within Windows task manager. The OpenLDAP process is terminated when data is being written to the database. On laptops, the laptop lid is closed, causing the system to go into suspend mode.

Shared Services Backup and Recovery

Possible Causes OpenLDAP uses a file-based database (called BerkeleyDB, or BDB) to store its content. The OpenLDAP data files are stored in: c:\Hyperion\SharedServices\9.0\openLDAP\var\openldap-data

If you forcibly shut down the OpenLDAP system, the database is left in an inconsistent state from which it cannot recover when you try to restart the OpenLDAP service. If the service is corrupted, the following message is returned when you try to start it.

If the OpenLDAP service is corrupted, you cannot logon to Shared Services or any other System 9 products. The following error is returned when you attempt to log on as a valid user:

Shared Services Backup and Recovery

Workarounds Do not terminate the OpenLDAP service (slapd process) from the Windows task manager. Always properly shut down the operating system before shutting down the machine to ensure that all services are properly shut down. On laptops, shut down the Shared Services Windows service as well as the OpenLDAP service before putting the system in hibernate mode. These services can be stopped from the Windows service control manager or from the Windows Start menu item Stop Shared Services as shown below.

In development or demo environments, try running OpenLDAP as a process rather than running it as a service, described below.

Running OpenLDAP as a Process from the Command Line Navigate to the OpenLDAP folder in your Shared Services installation. The default location is: c:\Hyperion\SharedServices\9.0\openLDAP Command (debug mode): slapd -d 1 -f slapd.conf Command (production mode): slapd -f slapd.conf

Backing Up Shared Services

If the OpenLDAP database is corrupted, you can use the recover utilities provided as part of the Shared Services installation to recover existing data. In production environments, we recommend doing periodic backups of Shared Services data to ensure that the system can be recovered in cases of catastrophic failure. Detailed instructions for backing up the Shared Services environment and data are documented on page 183 (Appendix C) of the Hyperion System 9 Shared Services Installation Guide.

Shared Services Backup and Recovery

Recovering from a Corrupted State

Berkeley DB (BDB) provides a database recovery tool (db_recover) that recovers OpenLDAP data. Detailed instructions for recovering BDB data from a corrupted database are documented in Recovering the OpenLDAP Database Data section of Appendix C (page 187) of the Hyperion System 9 Shared Services Installation Guide. The documentation for db_recover is in: c:\Hyperion\SharedServices\9.0\openLDAP\bdb\docs Regular Recovery If you cannot start the OpenLDAP service, always run the db_recover utility: 1. Open a command window and navigate to the OpenLDAP data folder: c:\Hyperion\SharedServices\9.0\openLDAP\var\openldap-data 2. Run the db_recover utility: c:\Hyperion\SharedServices\9.0\openLDAP\bdb\bin\db_recover This utility attempts to recover the database from the files present in the system at the time of failure, if they are sufficient to perform recovery. If files are missing, the utility identifies the missing log file(s) and fails. If this happens, the files need to be recovered from a backup copy, and then perform recovery again. Recovering from Catastrophic Failures 1. Perform the regular recovery process as described above. 2. If regular recovery is successful, log on to Shared Services to determine if the database has been restored properly without data loss. If regular recovery fails, or if there is data loss during regular recovery, you must restore the BDB database from a backup copy. You must have a backup of BDB data and log files in order to restore the OpenLDAP environment in cases of catastrophic failure.

Shared Services Backup and Recovery

To recover from a catastrophic failure: 1. Back up the current BDB data and log files stored in: c:\Hyperion\SharedServices\9.0\openLDAP\var\openldap-data 2. Restore all database and log files from the backup. The system now has a snapshot of data at the time of backup and the log files since the time of the backup. 3. Navigate to the BDB data folder and run the db_recover utility with the c option. BDB attempts to recover the database from the backup copy of the database files and the log files written since the database file snapshot was made.

Shared Services Backup and Recovery