The MFT command.properties file

The MFT command.properties file

The command.properties file specifies the command queue manager to connect to when we issue commands and the information that Managed File Transfer requires to contact that queue manager.

The command.properties file is created by the installer or by the fteSetupCommands command. We can use the fteSetupCommands command with the -f flag to change the basic command queue manager properties in this file. To change or add advanced command queue manager properties we must edit the file in a text editor.

Some Managed File Transfer commands connect to the agent queue manager or coordination queue manager instead of the command queue manager. For information about which commands connect to which queue manager, see Which MFT command connects to which queue manager.

The command.properties file is located in the MQ_DATA_PATH/mqft/config/coordination_qmgr_name directory.
The command.properties file contains the following values:

Property name Description Default value

connectionCredentialsKeyFile Name of the file containing the credential key used while encrypting credentials. A string property having no default value.

connectionQMgr The name of the queue manager used to connect to the IBM MQ network. No default

connectionQMgrHost The host name or IP address of the connection queue manager. No default

connectionQMgrPort The port number used to connect to the connection queue manager in client mode. 1414

connectionQMgrChannel The SVRCONN channel name used to connect to the connection queue manager. SYSTEM.DEF.SVRCONN

If we do not specify a value for the connectionQMgrHost property, bindings mode is used by default.

If you specify a value for the connectionQMgrHost property 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.

Property name Description Default value

Code page properties:

connectionCcsid The code page the commands connect to the command queue manager with. If you specify a value for connectionCcsid you must also specify a value for connectionCcsidName. 1208

connectionCcsidName The Java representation of the connectionCcsid. If you specify a value for connectionCcsidName we must also specify a value for connectionCcsid. UTF8

Multi-instance queue manager properties:

connectionQMgrStandby The host name and the port number used for client connections, in IBM MQ CONNAME format, for the standby instance of a multi-instance command queue manager defined by the connectionQMgr property. For example, host_name(port_number) No default

Security properties:

userIdForClientConnect The user ID that gets flowed through the client connections to IBM MQ. If java is specified the user name reported by the JVM is flowed as part of the IBM MQ connection request. The value of this property can be None or java. None

connectionQMgrAuthenticationCredentialsFile The path to the file that contains the MQ connection credentials for connection to the command queue manager. See Create an MFT credentials file and Configure MQMFTCredentials.xml
Further details on creating the Authentication Credentials File are also in Create an MFT credentials file

Further details on creating the Authentication Credentials File are in MFT and IBM MQ connection authentication

Queue properties:

dynamicQueuePrefix For commands that require a response from the agent, this property defines the IBM MQ prefix to use for generating the temporary reply queue name.
The format of the dynamicQueuePrefix property follows the format of the DynamicQName field of the IBM MQ MQOD structure. For more information, see Create dynamic queues.

We can also define this property in the coordination.properties file if we want to use a specific IBM MQ prefix for temporary queues that are generated by WMQFTE.
WMQFTE.*

modelQueueName For commands that require a response from the agent, this property defines the IBM MQ model queue to use for generating the temporary reply queue.
We can also define this property in the coordination.properties file if we want to use a specific IBM MQ model queue for temporary queues that are generated by WMQFTE. For more information, see The MFT coordination.properties file.
SYSTEM.DEFAULT.MODEL.QUEUE

Connection properties:

javaLibraryPath When connecting to a queue manager in bindings mode Managed File Transfer must have access to the IBM MQ Java bindings libraries. By default Managed File Transfer looks for the bindings libraries in the default location defined by IBM MQ. If the bindings libraries are in a different location use this property to specify the location of the bindings libraries. /opt/mqm/java/lib

legacyXMLMessageMQMDFormat
Managed File Transfer command XML messages are now sent to a queue with a blank MQMD format field. Previous versions of the product set the MQMD format field to MQSTR (a text message string). Setting this property to true enables the Managed File Transfer command XML messages to be sent to a queue with MQMD format field of MQSTR.

If the MQMD format field is set to MQSTR, there is potential for Managed File Transfer command XML messages to be corrupted if there are channels in the MQ network with data conversion enabled.
false

Agent properties

failCleanAgentWithNoArguments By default, the value of this property is true, which means that the fteCleanAgent command fails to run if only the agent name parameter is specified. Setting the property to false means that, if only the agent name parameter is set, the behavior of the fteCleanAgent command is equivalent to specifying the -all parameter. true

For SSL properties, see SSL properties for MFT.
Here is an example of the contents of a command.properties file:
connectionQMgr=PLUTO
connectionQMgrHost=kuiper.example.com
connectionQMgrPort=1930
connectionQMgrChannel=SYSTEM.DEF.SVRCONN
In this example, PLUTO is the name of an IBM MQ queue manager that is located on the system kuiper.example.com. The queue manager PLUTO is the queue manager that the Managed File Transfer commands connect to. Parent topic: Managed File Transfer configuration reference

Related reference

Java system properties for MFT
SSL properties for MFT

Related information

MFT configuration options on Multiplatforms
fteSetupCommands: create the MFT command.properties file
fteCleanAgent: clean up an MFT Agent

Last updated: 2020-10-04

Property name	Description	Default value
connectionCredentialsKeyFile	Name of the file containing the credential key used while encrypting credentials.	A string property having no default value.
connectionQMgr	The name of the queue manager used to connect to the IBM MQ network.	No default
connectionQMgrHost	The host name or IP address of the connection queue manager.	No default
connectionQMgrPort	The port number used to connect to the connection queue manager in client mode.	1414
connectionQMgrChannel	The SVRCONN channel name used to connect to the connection queue manager.	SYSTEM.DEF.SVRCONN

Property name	Description	Default value
Code page properties:
connectionCcsid	The code page the commands connect to the command queue manager with. If you specify a value for connectionCcsid you must also specify a value for connectionCcsidName.	1208
connectionCcsidName	The Java representation of the connectionCcsid. If you specify a value for connectionCcsidName we must also specify a value for connectionCcsid.	UTF8
Multi-instance queue manager properties:
connectionQMgrStandby	The host name and the port number used for client connections, in IBM MQ CONNAME format, for the standby instance of a multi-instance command queue manager defined by the connectionQMgr property. For example, host_name(port_number)	No default
Security properties:
userIdForClientConnect	The user ID that gets flowed through the client connections to IBM MQ. If java is specified the user name reported by the JVM is flowed as part of the IBM MQ connection request. The value of this property can be None or java.	None
connectionQMgrAuthenticationCredentialsFile	The path to the file that contains the MQ connection credentials for connection to the command queue manager.	See Create an MFT credentials file and Configure MQMFTCredentials.xml Further details on creating the Authentication Credentials File are also in Create an MFT credentials file Further details on creating the Authentication Credentials File are in MFT and IBM MQ connection authentication
Queue properties:
dynamicQueuePrefix	For commands that require a response from the agent, this property defines the IBM MQ prefix to use for generating the temporary reply queue name. The format of the dynamicQueuePrefix property follows the format of the DynamicQName field of the IBM MQ MQOD structure. For more information, see Create dynamic queues. We can also define this property in the coordination.properties file if we want to use a specific IBM MQ prefix for temporary queues that are generated by WMQFTE.	WMQFTE.*
modelQueueName	For commands that require a response from the agent, this property defines the IBM MQ model queue to use for generating the temporary reply queue. We can also define this property in the coordination.properties file if we want to use a specific IBM MQ model queue for temporary queues that are generated by WMQFTE. For more information, see The MFT coordination.properties file.	SYSTEM.DEFAULT.MODEL.QUEUE
Connection properties:
javaLibraryPath	When connecting to a queue manager in bindings mode Managed File Transfer must have access to the IBM MQ Java bindings libraries. By default Managed File Transfer looks for the bindings libraries in the default location defined by IBM MQ. If the bindings libraries are in a different location use this property to specify the location of the bindings libraries.	/opt/mqm/java/lib
legacyXMLMessageMQMDFormat	Managed File Transfer command XML messages are now sent to a queue with a blank MQMD format field. Previous versions of the product set the MQMD format field to MQSTR (a text message string). Setting this property to true enables the Managed File Transfer command XML messages to be sent to a queue with MQMD format field of MQSTR. If the MQMD format field is set to MQSTR, there is potential for Managed File Transfer command XML messages to be corrupted if there are channels in the MQ network with data conversion enabled.	false
Agent properties
failCleanAgentWithNoArguments	By default, the value of this property is true, which means that the fteCleanAgent command fails to run if only the agent name parameter is specified. Setting the property to false means that, if only the agent name parameter is set, the behavior of the fteCleanAgent command is equivalent to specifying the -all parameter.	true