fteMigrateLogger: migrate an FTE 7.0 database logger to MQ 7.5 or later

If you want to migrate the configuration of an existing stand-alone database logger from IBM® WebSphere® MQ File Transfer Edition 7.0.1 or later to IBM WebSphere MQ 7.5 or later, use the fteMigrateLogger command.

You cannot use this command to migrate a Java EE database logger: instead use the information in Migrating a Java EE database logger.
Note: If you are migrating from IBM WebSphere MQ 7.0 or later, and want to continue using the FTE_CONFIG environment variable, you 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 IBM WebSphere MQ 7.0.
Important: [UNIX, Linux, Windows]On IBM MQ for UNIX, Linux®, and Windows, 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, you will receive the error message BFGCL0502E: You are not authorized to perform the requested operation. and the command will not run.
[z/OS]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).
  • [V9.0.0.1 May 2017]Be a member of the group named in the BFG_GROUP_NAME environment variable (if one is named).
  • [V9.0.0.1 May 2017]Have no value set in the BFG_GROUP_NAME environment variable when the command is run.

If you have configured a stand-alone database logger to run as a Windows service, you cannot migrate that logger's configuration using the fteMigrateLogger command. If you run the fteMigrateLogger command on a logger configured to run as a Windows service, the command produces an error and does not continue. Alternatively, if you include the -f parameter, the command completes but produces a warning.

Before you run the fteMigrateLogger command, stop the database logger whose configuration you want to migrate on IBM WebSphere MQ File Transfer Edition 7.0.

If you run the command with the -f parameter, only the information about the logger is refreshed. If a required file is missing, the command fails. Specifically, the following properties files and .mqsc file associated with the logger configuration are migrated:

Table 1. Files migrated by the fteMigrateLogger command
Name of the file migrated by the fteMigrateLogger command Information
wmqfte.properties The wmqfte.properties file is based on installation.properties in IBM WebSphere MQ 7.5 or later
command.properties  
coordination.properties  
coordination_queue_manager.mqsc  
databaselogger.properties or other properties file specified using the -file parameter The databaselogger.properties is used to create the logger.properties file in IBM WebSphere MQ 7.5 or later.
The fteMigrateLogger command migrates the files for the installation, coordination, and command queue managers and copies them to IBM WebSphere MQ 7.5 or later provided that the files do not already exist on the target version. If the files already exist, they are not copied as part of the command.

Syntax

fteMigrateLogger

Read syntax diagramSkip visual syntax diagram fteMigrateLogger -loggerName logger_name -config configuration_directory -credentialPath credentials_path  -file properties_file -f-pconfiguration_options

Parameters

-loggerName logger_name
Required. The name that you want to give to the migrated logger configuration in IBM WebSphere MQ 7.5 or later. For more information about logger names, which are new for IBM WebSphere MQ 7.5 see logger_name parameter.

-config configuration_directory
Required. The path to the configuration directory for the installation that the logger configuration is being migrated from.

-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. 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.
-file properties_file
Optional. Specifies the database logger properties file to migrate. This parameter is required only if the properties file does not use the following default name and path: configuration_directory/coordination_qmgr_name/databaselogger.properties

-f
Optional. Forces migration even if some of the configuration files that are typically migrated conflict with the existing configuration. For example, if there is a mismatch a between the database logger properties files on IBM WebSphere MQ File Transfer Edition and the properties files on IBM WebSphere MQ 7.5 or later, specifying the -f parameter means this mismatch is ignored.

-p configuration_options
Optional. This parameter determines the set of configuration options that is used to locate the logger configuration to migrate. Use the name of a set of configuration options as the value of the -p parameter. By convention, this is the name of a coordination queue manager. If you do not specify this parameter, the default set of configuration options is used. For more information, see MFT configuration options on Multiplatforms.

-? or -h
Optional. Displays command syntax.

Example

In this example, the configuration of a stand-alone database logger located in /var/ibm/WMQFTE/config is migrated to IBM WebSphere MQ 7.5 and is named FTELOGGER1:
fteMigrateLogger -loggerName FTELOGGER1 -config /var/ibm/WMQFTE/config 
-credentialPath /home/user1/FTELOGGER1

Return codes

0
Command completed successfully.
1
Command ended unsuccessfully.
For more information about return codes, see Return codes for MFT.

After running the fteMigrateLogger command

To verify the migration, after you have successfully run the fteMigrateLogger command, start the database logger whose configuration you have migrated on IBM WebSphere MQ 7.5 or later, using the fteStartLogger command.