fteSetupCommands: create the MFT command.properties file

The fteSetupCommands command creates the Managed File Transfer command.properties file. This properties file specifies the details of the queue manager that connects to the IBM® MQ network when you issue commands.

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.

Purpose

Use the fteSetupCommands command to create a command.properties file in the coordination queue manager configuration directory. The command uses the MQ_DATA_PATH environment variable and the installation.properties file to determine where to locate the command.properties file. Ensure that you have already created and configured a coordination queue manager before you issue the fteSetupCommands command.

For more information about properties files, see The MFT command.properties file.

Syntax

fteSetupCommands

Read syntax diagramSkip visual syntax diagramfteSetupCommands -connectionQMgr connection_qmgr_name-connectionQMgrHostconnection_qmgr_host-connectionQMgrPortconnection_qmgr_port-connectionQMgrChannelconnection_qmgr_channel-credentialsFilefilePath-useridusername-pconfiguration_options-f

Parameters

-connectionQMgr (connection_qmgr_name)
Required. The name of the queue manager used to connect to the IBM MQ network to issue commands.

-connectionQMgrHost (connection_qmgr_host)
Optional. The host name or IP address of the connection queue manager.

If you do not specify the -connectionQMgrHost parameter, a bindings mode connection is assumed. Therefore, this parameter is required if you are using a client mode connection.

If you specify a value for the -connectionQMgrHost parameter but do not specify values for the -connectionQMgrPort and -connectionQMgrChannel properties, a port number of 1414 and a channel of SYSTEM.DEF.SVRCONN are used by default.

-connectionQMgrPort (connection_qmgr_port)
Optional. The port number used to connect to the connection queue manager in client mode. If you specify the -connectionQMgrPort parameter, you must also specify the -connectionQMgrHost parameter.

-connectionQMgrChannel (connection_qmgr_channel)
Optional. The channel name used to connect to the connection queue manager. If you specify the -connectionQMgrChannel parameter, you must also specify the -connectionQMgrHost parameter.

-p (configuration_options)
Optional. This parameter determines the set of configuration options that is used to set up a command queue manager. Use the name of a non-default coordination queue manager as the input for this parameter. The fteSetupCommands command then uses the set of properties files associated with this non-default coordination queue manager.

If you do not specify this parameter, the set of configuration options based on the default coordination queue manager is used.

-credentialsFile (filePath)
Optional. The full file path of an existing or new credentials file, to which the IBM MQ authentication details are added.

This command supports the addition of a set of IBM MQ authentication details, to a named Managed File Transfer credentials file. Use this command when IBM MQ connection authentication has been enabled. If you update the existing details, you must use the -f force parameter.

-userid (username)
Optional. The user ID used to associate the credential details. If you do not specify a user ID, the credential details will apply to all users. You must also specify the -credentialsFile parameter.
-f
Optional. Forces an overwrite of the existing command.properties file with the details specified in this command.

-? or -h
Optional. Displays command syntax.

Example


fteSetupCommands -connectionQMgr QM_NEPTUNE -connectionQMgrHost 9.146.157.241
-connectionQMgrPort 1414 -connectionQMgrChannel SYSTEM.DEF.SVRCONN

Return codes

0
Command completed successfully.
1
Command ended unsuccessfully.