The MFT command.properties file

The command.properties file specifies the command queue manager to connect to when you 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. You 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 you 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 MFT command.properties file contains the following values:

Table 1. Basic command queue manager properties
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 you 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.

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.

Advanced command properties

Managed File Transfer also provides more advanced command properties. If you want to use any of the following properties, manually edit the command.properties file to add the required advanced properties. When you specify file paths on Windows, ensure the separator character backslash (\) is entered as double backslashes (\\), that is, escaped backslash (\). Alternatively, you can use a single forward slash (/) character as a separator. For more information about character escaping in Java properties files, see the Oracle documentation Javadoc for the Properties class.

Agent properties
Code page properties
Multi-instance queue manager properties
Queue properties
Security properties
SSL properties

Table 2. Advanced command properties: Agent
Property name	Description	Default value
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

Table 3. Advanced command properties: Code page
Property name	Description	Default value
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 you must also specify a value for connectionCcsid.	UTF8

Table 4. Advanced connection properties: Multi-instance queue manager
Property name	Description	Default value
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

Table 5. Advanced command properties: Queue
Property name	Description	Default value
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 Creating dynamic queues. You can also define this property in the coordination.properties file if you 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. You can also define this property in the coordination.properties file if you 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

Table 6. Advanced command properties: Security
Property name	Description	Default value
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 Configuring MQMFTCredentials.xml on Multiplatforms and Configuring MQMFTCredentials.xml on z/OS®. Further details on creating the Authentication Credentials File are in MFT and IBM MQ connection authentication

Table 7. Advanced command properties: SSL/TLS
Property name	Description	Default value
connectionSslCipherSpec	Specifies the protocol, hash algorithm, and encryption algorithm that is used, and how many bits are used in the encryption key, when data is exchanged between the commands and the command queue manager. The value of connectionSslCipherSpec is a CipherSpec name. This CipherSpec name is the same as the CipherSpec name used on the command queue manager channel. A list of valid CipherSpec names is included in SSL/TLS CipherSpecs and CipherSuites in IBM MQ classes for Java and SSL/TLS CipherSpecs and CipherSuites in IBM MQ classes for JMS. connectionSslCipherSpec is similar to connectionSslCipherSuite. If both connectionSslCipherSuite and connectionSslCipherSpec are specified, the value of connectionSslCipherSpec is used.	None
connectionSslCipherSuite	Specifies SSL aspects of how the commands and the command queue manager exchange data. The value of connectionSslCipherSuite is a CipherSuite name. The CipherSuite name maps to the CipherSpec name used on the agent queue manager channel. For more information, see CipherSuite and CipherSpec name mappings. connectionSslCipherSuite is similar to connectionSslCipherSpec. If both connectionSslCipherSuite and connectionSslCipherSpec are specified, the value of connectionSslCipherSpec is used.	None
connectionSslPeerName	Specifies a distinguished name skeleton that must match the name that is provided by the command queue manager. The distinguished name is used to check the identifying certificate that is presented by the command queue manager on connection.	None
connectionSslTrustStore	Specifies the location of the certificates that the commands trust. The value of connectionSslTrustStore is a file path. If it is a Windows file path, the backslash character (\) must be escaped (\\). From IBM WebSphere® MQ 7.5, the value of this property can contain environment variables.	None
connectionSslTrustStoreType	The type of SSL truststore you want to use. JKS and PKCS#12 keystores are supported. The value of this property can be either jks or pkcs12.	jks
connectionSslTrustStoreCredentialsFile	The path to the file that contains the connectionSslTrustStore credentials. From IBM WebSphere MQ 7.5, the value of this property can contain environment variables.	The default value for this property is %USERPROFILE%\MQMFTCredentials.xml on Windows and $HOME/MQMFTCredentials.xml on other platforms.
connectionSslKeyStore	Specifies the location of the private key of the commands. The value of connectionSslKeyStore is a file path. If it is a Windows file path, the backslash character (\) must be escaped (\\). This property is only required if the command queue manager requires client authentication. From IBM WebSphere MQ 7.5, the value of this property can contain environment variables.	None
connectionSslKeyStoreType	The type of SSL keystore you want to use. JKS and PKCS#12 keystores are supported. The value of this property can be either jks or pkcs12. From IBM WebSphere MQ 7.5, the value of this property can contain environment variables.	jks
connectionSslKeyStoreCredentialsFile	The path to the file that contains the connectionSslKeyStore credentials. From IBM WebSphere MQ 7.5, the value of this property can contain environment variables.	The default value for this property is %USERPROFILE%\MQMFTCredentials.xml on Windows and $HOME/MQMFTCredentials.xml on other platforms.
connectionSslFipsRequired	Specifies that you want to enable FIPS support at the level of the command queue manager. The value of this property can be true or false. For more information, see FIPS support in MFT.	false