CA SiteMinder® Federation Standalone Guide › Restore Federation System Configuration

Restore Federation System Configuration

This section contains the following topics:

How To Restore a System to a Previous Configuration

How To Restore a System to a Previous Configuration

You can restore a system configuration by reverting to a previously backed-up configuration. If a current configuration is experiencing problems, reverting to a previous configuration can be useful.

The process for reverting to a previous configuration is as follows:

1. Back up the existing CA SiteMinder® Federation Standalone configuration for the system that you want to restore.
2. Run the Configuration wizard on this system using the same settings that were in place when you created the backup configuration.

   When you run the Configuration wizard, the settings must remain the same.

   The following settings must match the original configuration:

   • Deployment Settings

     Select the same deployment mode (proxy or standalone) for the new system.

   • Port numbers

     Specify the same ports that the backed-up system uses.

   • Virtual Host Name

     If the system used a virtual host when initially configured, use the same virtual host name. Additionally, make the appropriate entries in the host file for the system.

   • SiteMinder Connector

     If the system used the CA SiteMinder® Connector, select the CA SiteMinder® Connector again.

3. Import the backed-up configuration to the system.

The following sections detail the process.

Back up an Existing Configuration

A backup of your configuration is useful for to recover or migrate your federation system.

Note: This procedure applies to version 12.52 SP1 and higher.

To back up a configuration, export the configuration data. The XPSExport tool, included with the product, lets you export the configuration data to an XML file.

Important! During the export process, federation transactions cannot process successfully.

Follow these steps:

1. Open a command window.
2. Enter the following command to export the configuration:

   XPSExport export_file_name -xe -xp -passphrase passphrase

   export_file_name

   Names the output file that results from the export. The output from XPSExport is in XML format, therefore, the file name must end with the extension .xml.

   passphrase

   Specifies the passphrase that is required to encrypt sensitive data. The passphrase must be at least eight characters and must contain at least one digit, one uppercase and one lowercase letter. If the passphrase contains a space, then it must be enclosed in quotes.

   NOTE: If you do not want to enter the passphrase directly, leave it off the command. XPSExport then prompts you for a passphrase and a passphrase confirmation, which is not echoed to the screen.

The export produces an XML file that contains encrypted configuration data. Use this file to restore the configuration.

Revert to a Backed-up Configuration

If you experience problems with an existing CA SiteMinder® Federation Standalone configuration, revert to a previously backed up configuration on the same system.

To restore a configuration, use the XPSImport tool shipped with the product to import an XML file.

Important! Follow the import steps exactly as outlined. Do not access the Certs & Keys tab in the Administrative UI until the procedure is complete.

Follow these steps:

1. Establish a new database instance for federation data.

   Important! Do not use an existing database for this step. The import fails if you do.

2. Run the Configuration Wizard, specifying the new database instance when prompted.

   Use the same settings for this new configuration that were used for the original configuration. These settings include:

   • Deployment Mode
   • Port numbers
   • Virtual Host Name
   • CA SiteMinder® Connector
3. Stop the federation services according to your platform.

   Windows

   Use the stop shortcut. If you logged in as a network user and not a local administrator, right-click the shortcut and select Run as administrator.

   Select Start, All Programs, CA, Federation Standalone, Stop services.

   UNIX

   1. Open a command window.
   2. Run the following script:

      federation_install_dir/fedmanager.sh stop

      Note: Do not stop and start the services as the root user.

4. Restore all configuration data using the XPSImport command:

   XPSImport export_file_name -passphrase passphrase

   export_file_name

   Names the XML file that resulted from the export of the original configuration. The filename should end with the extension .xml.

   passphrase

   Specifies the passphrase required to decrypt sensitive data. It must be at least eight characters and must contain at least one digit, one upper case and one lower case letter. If the passphrase contains a space, then it must be enclosed in quotes.

5. Re-run the Configuration Wizard.

   Use the same settings for this new configuration that were used for the original configuration. These settings include:

   • Deployment Mode
   • Port numbers
   • Virtual Host Name
   • SiteMinder Connector
6. (Optional) If the SiteMinder Connector was enabled in the original configuration, reestablish the Connector by doing the following:
   1. Log in to the Administrative UI.
   2. Click the Infrastructure tab and select Deployment Settings.
   3. Reconfigure the Connector settings using the same values that were used by the original configuration.
   4. Click Register Host to reregister the federation system with the Policy Server.

The configuration is restored to its original state.