Transferring data between BMC Helix SSO servers

You can export or import the configuration from one BMC Helix Single Sign-On server to another BMC Helix SSO server by running the data transfer tool from a command line on any local machine.

Data transfer tool usage considerations

Before you export or import the BMC Helix SSO server configuration, consider the following information:

• Use the data transfer tool when you need to export configuration from one BMC Helix SSO server (for example, QA server), and import it to another BMC Helix SSO server (for example, Dev server).
• The data transfer tool is designed to work across the same versions of BMC Helix SSO. You must not export or import data between different versions of BMC Helix SSO server.
• The data transfer tool imports all data, except issued tokens, sessions, authorization codes, and SAML signing and encryption certificates.

• You can import all configurations (including general configuration, launchpad settings, registered OAuth2 clients, administrator users, and tenants), or segments of the configuration (one or more realms with branding, associated local users or groups, and the assignments of those users and groups).

• The import job runs as a single transaction. 

Model change in 22.1 version

Starting from the BMC Helix SSO 22.1 version, data transfer process requires to create a command_import.txt file in the user file system. The data specified in the file is mapped with the the container's directory. When the container starts, all the data from the file is recorded into the container.

To export or import data

1. In your file system, create /opt/datatool/command_import.txt file.
2. Grant this file with the Read, Write and Execute permissions.

3. To execute the export of configuration from the source server, open command_import.txt in edit mode. Add a command for export with a full path and archive file name where exported data will be saved. For example, export /opt/datatool/data/hsso-config-import.zip

4. Save the file.

5. In the command line, run the following command: 

   docker run -v /opt/datatool/:/opt/datatool/data/ \
 --env DB_JDBC_CONNECTION="jdbc:postgresql://172.21.128.1:5432/rsso" \
 --env DB_TYPE="postgres" \
 --env DB_USER="postgres" \
 --env DB_PWD="password" \
aus-harboreg-01.bmc.com/rsso/datatransfer:HSSO_XX.XX.XX-RTM @/opt/datatool/data/command_import.txt

6.  To import data to the target server, open command_import.txt and update it with the import command. Change export to import. Provide the full path to the zip archive file and keep its name the same. Add the sours tenant ID from which data was exported and the target tenant ID to which data will be imported. For example, import /opt/datatool/data/hsso-config-import.zip -s 00000000-0000-0000-0000-000000000000 -t 00000000-0000-0000-0000-000000000000
7. Save the file.
8. In the command line, run the command from step 5.

The description of the docker run command parameters is displayed in the following table:

Available options to import data

Complete one or more of the following tasks to import data. For more details about the command parameters, see Import command parameters.

import <filename> -r <realm_list> -s <source_tenant_ID> -t <target_tenant_ID>

import <filename> --realms <realm_list> --sourcetid <source_tenant_ID> --targettid <target_tenant_ID>

import <filename> -r <realm1>:<realm1NewName>,<realm2>:<realm2NewName> -s <source_tenant_ID> -t <target_tenant_ID>

import <filename> --realms <realm1>:<realm1NewName>,<realm2>:<realm2NewName> --sourcetid <source_tenant_ID> --targettid <target_tenant_ID>

import <filename> -o <oauth_client_IDs_list> -s <source_tenant_ID> -t <target_tenant_ID>

import <filename> --oauthclients <oauth_client_IDs_list> --sourcetid <source_tenant_ID> --targettid <target_tenant_ID>

import <filename> -s <source_tenant_ID> -t <target_tenant_ID>

import <filename> --sourcetid <source_tenant_ID> --targettid <target_tenant_ID>

import <filename> -r <oldRealmName>:<newRealmName>><newTenantValue>,
<oldRealmName>><newTenantValue> -s <source_tenant_ID> -t <target_tenant_ID>

import <filename> -r <oldRealmName>:<newRealmName>><newTenantValue>,
<oldRealmName>><newTenantValue> --sourcetid <source_tenant_ID> --targettid <target_tenant_ID>

Import command parameters

The following table describes the  import command parameters: