7.2.4. Migrating RSM from a Previous Version

RSM's built-in migration utility enables you to automatically transfer RSM configurations, queue definitions and application settings from one version of RSM to another, eliminating the need to reconfigure RSM or manually move files every time you upgrade to a new version. You can choose to migrate all items, or specific items.

Important:

The migration utility supports migration from version 18.0 or later.
If you have previously set up a custom Ansys RSM Cluster (ARC), and would like to migrate ARC-related settings and ARC node configurations, you will need to run the ARC migration command in addition to running the RSM migration utility described here. For more information see Migrating an ARC Setup from a Previous Version (arcconfig migration).

To perform a migration:

On the cluster submit host, log into an account with administrative privileges.
If you have not already done so, install the new product version.

Run the appropriate command below, appending the desired operator and options from the accompanying tables.

Windows: Run the following command in the [RSMInstall]\bin directory:

rsm.exe migration {operator} -v123 [-preview] [-verbose] [-silent]

Linux: Run the following command in the [RSMInstall]/Config/tools/linux directory:

rsmutils migration {operator} -v123 [-preview] [-verbose] [-silent]

Table 7.3: Operators for Migration

Operator	Usage
config	Migrate RSM configurations and queues.
settings	Migrate RSM settings in the RSM\Config\Ans.Rsm.AppSettings.config file. (To see which settings will be migrated, refer to the new version's RSM\Config\migration\Rsm.AppSettings.Migrate.config file.)
all	Migrate everything (configurations, queues, and settings).

Table 7.4: Options for Migration

Option	Usage
-v123	(Required) Specify the version that you are migrating, so that the migration command knows which files to look for. Replace the `123` with the version that you are migrating (for example, enter `-v241` for version 2024 R1). Note: The oldest version that you can migrate is version 18.0.
-preview	Display a list of the items that will be migrated, without actually performing the migration.
-verbose	Display more detailed information about the migration and its progress.
-silent	Perform the migration without confirmation prompts. Useful for scripting.

Example

In the following example we are migrating cluster configurations, queues and settings from version 2024 R1 to version 2024 R2.

By using the -preview option we can see that 4 configurations, 8 queues and 1 setting will be migrated:

C:\Program Files\ANSYS Inc\v242\RSM\bin>rsm.exe migration all -v241 -preview -verbose
v242 settings located at C:\Program Files\ANSYS Inc\v242\RSM\Config\Ans.Rsm.AppSettings.config
v241 settings located at C:\Program Files\ANSYS Inc\v241\RSM\Config\Ans.Rsm.AppSettings.config

v242 configuration directory: C:\Users\atester\AppData\Roaming\Ansys\v242\RSM
v241 configuration directory: C:\Users\atester\AppData\Roaming\Ansys\v241\RSM

v242 existing configuration:
   1 Cluster Configurations
      localhost
   1 Queues
      Local

NOTE: Existing Cluster Configurations and Queues may be overwritten.

v241 configuration to migrate:
   4 Cluster Configurations
      localhost
      Custom
      WinHPC
      LSF
   8 Queues
      Normal
      HighMem
      Local
      Reserved
      Mech-HPC
      Fluent-HPC
      CFX-HPC
      Test-LSF

v242 settings located at C:\Program Files\ANSYS Inc\v242\RSM\Config\Ans.Rsm.AppSettings.config
v241 settings located at C:\Program Files\ANSYS Inc\v241\RSM\Config\Ans.Rsm.AppSettings.config

Settings to migrate located at C:\Program Files\ANSYS Inc\v242\RSM\Config\migration\
Rsm.AppSettings.Migrate.config

Skipping DiskSpaceLowWarningLimitGb = 2.0
Skipping ServiceLogCleanupAgeDays = 5
Skipping AlternateAllowedPrompt = empty
Skipping LauncherXmlRpcEnabled = true
Skipping XmlRpcMaxConcurrentRequests = 10
Skipping ProxyXmlRpcPortRange = 50000-50100
Skipping ProxyXmlRpcLogMessagePrefix = [P]
Skipping CompressionThresholdMb = 0
Skipping CleanupTimeSpan = 00:10:00
Skipping FinishedJobHistoryCleanupTimeSpan = 02:00:00
Skipping FailedJobHistoryCleanupTimeSpan = 1.00:00:00
Skipping CancelJobHistoryCleanupTimeSpan = 00:10:00
Skipping JobHistoryCleanupIntervalTimeSpan = 00:10:00
Skipping ConfigurationDirectory = empty
Skipping JobHistoryDirectory = empty
Skipping IdleTimeoutMinutes = 10
Migrating PortRange from empty to 2000-9000
Skipping NumberPortsPerUser = 10
Skipping SocketTransfererPortRange = empty
Skipping SocketTransfererListenerIpAddress = empty
Skipping DirectoryPermissionMask = empty
Skipping FilePermissionMask = empty
Skipping UserProxyShareName = RSM
Skipping FileTransferBufferSize = 100000
Skipping FileTransferMaxRetries = 1
Skipping ServiceLogEnabled = true
Skipping ServiceLogDirectory = empty
Skipping ServiceLogEnabled = false
Skipping ServiceLogDirectory = empty
Skipping Configuration.EnableClusterQueueEdit = true
Skipping EnableRsmLocale = false
Skipping EnableUTF8Encoding = false
Skipping EnableRsmLocale = false
Skipping EnableUTF8Encoding = false
1 settings to migrate.

C:\Program Files\ANSYS Inc\v242\RSM\bin>

Note: If a configuration, queue or setting already exists in the new version, and the content or value is different in the new version, that item will be overwritten. Otherwise, if the content or value is the same, migration of that item will be skipped.

To verify that configurations and queues have been successfully migrated, you can issue the config list command, as described in Listing RSM Configurations and Queues, or simply open the RSM Configuration application and review the configurations in the HPC Resources list. To verify that settings have been migrated, refer to Editing RSM Application Settings (rsm.exe | rsmutils appsettings).