fteMigrateConfigurationOptions: migrate an FTE V7.0 configuration to MQ V7.5 or later

The fteMigrateConfigurationOptions command migrates a set of configuration options from WebSphere MQ File Transfer Edition Version 7.0 and copies them to IBM WebSphere MQ Version 7.5 or later, provided that the files do not already exist on the target version. If the files already exist, a message is output and the command does not continue.

Note: If we are migrating from WebSphere MQ File Transfer Edition Version 7.0, and want to continue using the FTE_CONFIG environment variable, we can do so without changing the FTE_CONFIG value. You can perform a standard migrate, but BFG_DATA must not be set, and FTE_CONFIG must be set as used in Version 7.0. Important: On IBM MQ for Multiplatforms, only users who are IBM MQ administrators (and members of the mqm group) can run this command. If you try to run this command as a user who is not an IBM MQ administrator, we will receive the error message BFGCL0502E: You are not authorized to perform the requested operation. and the command will not run. On z/OS systems, the user must satisfy (at least) one of these conditions in order to run the migrate command:

Be a member of the mqm group (if the mqm group is defined on the system).
Be a member of the group named in the BFG_GROUP_NAME environment variable (if one is named).
Have no value set in the BFG_GROUP_NAME environment variable when the command is run.

Syntax

fteMigrateConfigurationOptions

Parameters

-config (configuration_directory)

Required. The path to the configuration directory for the installation that we are migrating from. For example, C:\Documents and Settings\All Users\Application Data\IBM\WMQFTE\config

-credentialPath (credentials_path)

Required. Defines the location to migrate the credential information to. This parameter can either be a directory path where existing credential files are present or a new location to receive a new credential file.

This parameter is used for migrating password properties for the SSL/TLS key store and trust store properties that are present in the agent.properties, coordination.properties, and command.properties files from a version of the product earlier than IBM WebSphere MQ Version 7.5 to Version 7.5 or later.

Before Version 7.5, the password property, for example coordinationSslTrustStorePassword, used to be present in the coordination.properties file, but was moved to the MQMFTCredentials.xml file in Version 7.5. In order move the password property from the coordination.properties file to the MQMFTCredentials.xml file, the -credentialsPath is used. When this option is used the fteMigrateConfigurationOptions command looks in the coordination.properties file for "coordinationSslTrustStorePassword" and, if it is present, migrates the property to the MQMFTCredentials.xml file.

For z/OS platforms this can be a pre-existing partitioned data set extended (PDSE), either with existing members to be updated, or without existing members to include a new member for these credentials.

Note: If a PDSE is used, it must be variable block.

-configurationOptionsName (configuration_options_name)

Required. The name of the set of configuration options that you want to migrate. We can migrate multiple sets of configuration options by using the asterisk character (*) to represent zero or more characters. We can use an asterisk with a string. For example, to migrate all sets of configuration options with names beginning with IBM, use this parameter as follows: -configurationOptionsName IBM*.

Examples

In this example, all configurations in the directory C:\Documents and Settings\All Users\Application Data\IBM\WMQFTE\config are migrated. The directory path is enclosed in double quotation marks:

fteMigrateConfigurationOptions -config "C:\Documents and Settings\All Users\Application Data\IBM\WMQFTE\config" 
-credentialPath "C:\Documents and Settings\user1\configurationoptions" -configurationOptionsName *

Return codes

0: Command completed successfully.
1: Command ended unsuccessfully.