How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I export and import Service configurations for AM (All versions)?

Last updated Apr 13, 2021

The purpose of this article is to provide information on exporting and importing your Service configuration for AM. These options are used when making changes to your service configuration file. Additionally, exporting the service configuration is commonly used by Administrators and Support to validate configuration settings.


3 readers recommend this article

Overview

You can use the following approaches to export and import service configurations:

Amster

You can use Amster to export and import configurations as detailed in:

With Amster, it is also possible to import a Service configuration that was created in a different version of AM. For example, you can export a configuration from AM 6 and import it into AM 6.5.

Note

If you have custom modules, you must ensure you have installed and registered the custom module first as detailed in How do I import Service configurations in AM (All versions) using Amster when there are custom modules?

ssoadm

You can export and import service configuration using ssoadm as follows:

Note

You cannot import a Service configuration that was created in a different version of AM using ssoadm.

Export

You can export your Service configurations using the following ssoadm command:

$ ./ssoadm export-svc-cfg -u [adminID] -f [passwordfile] -e [secretkey] -o [outputfile]

replacing [adminID], [passwordfile], [secretkey] and [outputfile] with appropriate values, where [secretkey] can be any value and is used to encrypt passwords from the configuration. You must then use the same key when importing the configuration through ssoadm import-svc-cfg.

Import

You can import your Service configurations using the following ssoadm command:

$ ./ssoadm import-svc-cfg -u [adminID] -f [passwordfile] -e [secretkey] -X [XMLfile]

replacing [adminID], [passwordfile], [secretkey] and [XMLfile] with appropriate values, where [secretkey] is the same value you used when you exported the configuration.

Restart the web application container in which AM runs to update the configuration.

Known issues

The following known issues may prevent you from exporting or importing Service configurations using ssoadm:

See Also

How do I collect all the data required for troubleshooting AM and Agents (All versions)?

Troubleshooting AM and Agents

Maintenance Guide › Backing Up Configurations

Related Training

N/A

Related Issue Tracker IDs

N/A


Copyright and Trademarks Copyright © 2021 ForgeRock, all rights reserved.