MFT commands reference

All Managed File Transfer (MFT) commands are listed with links to their detailed descriptions.

Table 1. Managed File Transfer commands and their purpose
Command name	Purpose
Commands for migration:
fteMigrateAgent ¹	Migrate an agent and its configuration from IBM WebSphere MQ File Transfer Edition 7.0.4 to Managed File Transfer for IBM WebSphere MQ 7.5or later
fteMigrateConfigurationOptions ¹	Migrate an IBM WebSphere MQ File Transfer Edition 7.0 configuration to Managed File Transfer for IBM WebSphere MQ 7.5 or later.
fteMigrateLogger ¹	Migrate the configuration of a stand-alone database logger from IBM WebSphere MQ File Transfer Edition 7.0.1 or later to Managed File Transfer for IBM WebSphere MQ 7.5 or later.
Commands for configuration:
fteChangeDefaultConfigurationOptions	Change the default configuration options that you want Managed File Transfer to use
fteCreateAgent	Create a Managed File Transfer Agent
fteCreateBridgeAgent	Create a Managed File Transfer protocol bridge agent
fteCreateCDAgent	Create a Managed File Transfer Connect:Direct bridge agent
fteCreateEnvironment	Set the environment variable for the configuration and transfer of files for the Redistributable Managed File Transfer Agent.
fteCreateLogger	Create a Managed File Transfer logger
fteDefine	Generate the configuration scripts necessary to define the specified objects.
fteDelete	Generate the configuration scripts necessary to remove the specified objects.
fteDeleteAgent	Delete a particular Managed File Transfer Agent
fteDeleteLogger	Delete a Managed File Transfer logger
fteModifyAgent	Windows only. Modify an agent, Connect:Direct bridge agent, or protocol bridge agent to run as a Windows service.
fteModifyLogger	Windows only. Modify the logger to run as a Windows service.
fteSetupCommands	Specify the details of the queue manager that connects to the IBM MQ network when you issue commands
fteSetupCoordination	Configure a Managed File Transfer coordination queue manager
Commands for administration:
fteCancelTransfer	Cancel a file transfer
fteCleanAgent	Clean up the queues used by an agent
fteClearMonitorHistory	Clear the history of a resource monitor
fteCreateMonitor	Create and start a new resource monitor
fteCreateTemplate	Create a transfer template for future use
fteCreateTransfer	Create and start a new file transfer
fteDeleteMonitor	Stop and remove an existing resource monitor
fteDeleteScheduledTransfer	Delete a particular file transfer that you have previously scheduled
fteDeleteTemplates	Delete existing file transfer templates
fteListAgents	List all of the agents registered against a particular coordination queue manager
fteListMonitors	List all of the resource monitors registered against a particular coordination queue manager
fteListScheduledTransfers	List all of the Managed File Transfer transfers that you previously created using the command line or the IBM MQ Explorer.
fteListTemplates	List all the file transfer templates for a coordination queue manager
ftePingAgent	Pings an agent to determine whether the agent is active and able to process transfers.
fteSetProductID	Set z/OS SCRT recording product id
fteShowAgentDetails	Display the details of a particular agent
fteShowLoggerDetails	Display the details of a particular logger
fteStartAgent	Start a particular agent before using it to transfer files
fteStartLogger	Start logger
fteStartMonitor	Start a resource monitor without needing to stop or restart an agent
fteStopAgent	Stop a particular agent
fteStopLogger	Stop logger
fteStopMonitor	Stop a resource monitor without needing to stop or restart an agent
Command for security:
fteObfuscate	Encrypt sensitive data in credentials files.
Commands for troubleshooting:
fteDisplayVersion	Display the product version
fteSetAgentLogLevel	Enable or disable diagnostic information logging for file transfers between a Managed File Transfer protocol bridge agent and FTP/SFTP/FTPS file servers.
fteSetAgentTraceLevel	Set the level of agent trace to run
fteSetLoggerTraceLevel	Set the level of logger trace to run
fteRAS	Run the RAS gathering tool

Notes:

For Continuous Delivery, the fteMigrateAgent, fteMigrateConfigurationOptions and fteMigrateLogger commands are removed at IBM MQ 9.2.1.
These commands are still available for IBM MQ 9.2 Long Term Support.

See Installed MFT command sets for a table showing which commands are installed with which Managed File Transfer offering.

The syntax for each command and its parameters is presented in the form of a syntax diagram called a railroad diagram. For information about how to interpret railroad diagrams, see Syntax diagrams.