MFT commands

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

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.

• Authority to use MFT commands
  
• Tracing MFT commands
  We can trace any of the Managed File Transfer commands to help with problem determination from the command line.
• fteBatch, fteCommon and ftePlatform helper scripts
  The fteBatch, fteCommon and ftePlatform are scripts that are provided by Managed File Transfer in the MQ_INSTALLATION_PATH/bin directory as helper scripts. The fteBatch script is present on z/OS only.
• fteCancelTransfer: cancel an MFT transfer
  Use the fteCancelTransfer command to cancel a Managed File Transfer transfer. We can issue this command against either the source or destination agent for the transfer.
• fteChangeDefaultConfigurationOptions: change default configuration options for MFT
  Use the fteChangeDefaultConfigurationOptions command to change the default configuration options that we want Managed File Transfer to use. The value of the configuration options defines the group of properties files that Managed File Transfer uses.
• fteCleanAgent: clean up an MFT Agent
  Use the fteCleanAgent command to clean up the queues that a Managed File Transfer Agent uses, by deleting messages from the persistent and non-persistent queues used by the agent. Use the fteCleanAgent command if we are having problems starting an agent, which might be caused by information remaining on the queues used by the agent.
• fteClearMonitorHistory: clear resource monitor history
  Use the fteClearMonitorHistory command to clear the history of a resource monitor.
• fteCreateAgent: create an MFT agent
  The fteCreateAgent command creates a Managed File Transfer Agent and its associated configuration.
• fteCreateBridgeAgent: create and configure an MFT protocol bridge agent
  The fteCreateBridgeAgent command creates a Managed File Transfer protocol bridge agent and its associated configuration. Create a protocol bridge agent for each file server that we want to send files to and receive files from.
• fteCreateEnvironment: set up environment for Redistributable Managed File Transfer Agent
  The fteCreateEnvironment command sets the environment variable for the configuration and transfer of files for the Redistributable Managed File Transfer Agent.
• fteCreateCDAgent: create a Connect:Direct bridge agent
  The fteCreateCDAgent command creates a Managed File Transfer Agent and its associated configuration for use with the Connect:Direct bridge.
• fteCreateLogger: create an MFT file or database logger
  Use the fteCreateLogger command to create a Managed File Transfer file or database logger.
• fteCreateMonitor: create an MFT resource monitor
  The fteCreateMonitor command creates and starts a new resource monitor from the command line. We can monitor a resource (for example, the contents of a directory) by using Managed File Transfer so that when a trigger condition is satisfied, a specified task, such as a file transfer, is started.
• fteCreateTemplate: create new file transfer template
  The fteCreateTemplate command creates a file transfer template that we can keep for future use. The only required parameter is the -tn (template_name) parameter. All other parameters are optional, although if we specify a source file specification, we must also provide a destination file. Similarly, if we specify a destination file, we must also specify a source file specification.
• fteCreateTransfer: start a new file transfer
  The fteCreateTransfer command creates and starts a new file transfer from the command line. This command can start a file transfer immediately, schedule a file transfer for a future time and date, repeat a scheduled transfer one or more times, and trigger a file transfer based on certain conditions.
• fteDefine: generate configuration scripts
  Use the fteDefine command to generate the configuration scripts necessary to define the specified objects.
• fteDelete: generate scripts to remove configuration
  Use the fteDelete command to generate the configuration scripts necessary to remove the specified objects.
• fteDeleteAgent: delete an MFT agent and its configuration
  The fteDeleteAgent command deletes a Managed File Transfer Agent and its configuration. If the agent is a protocol bridge agent, the user credentials file is left on the file system.
• fteDeleteLogger: delete an MFT logger and its configuration
  Use the fteDeleteLogger command to delete a Managed File Transfer logger and its configuration. Existing log files associated with the logger can either be retained or deleted.
• fteDeleteMonitor: delete an MFT resource monitor
  Use the fteDeleteMonitor command to stop and delete an existing Managed File Transfer resource monitor using the command line. Issue this command against the resource monitoring agent.
• fteDeleteScheduledTransfer: delete a scheduled MFT transfer
  
• fteDeleteTemplates: delete an MFT template
  Use the fteDeleteTemplates command to delete an existing Managed File Transfer template from a coordination queue manager.
• fteDisplayVersion: display installed version of MFT
  Use the fteDisplayVersion command to display the version of Managed File Transfer that we have installed.
• fteListAgents: list the MFT agents for a coordination queue manager
  Use the fteListAgents command to list all of the Managed File Transfer agents that are registered with a particular coordination queue manager.
• fteListMonitors: list MFT resource monitors
  Use the fteListMonitors command to list all of the existing resource monitors in a Managed File Transfer network using the command line.
• fteListScheduledTransfers: list all scheduled transfers
  Use the fteListScheduledTransfers command to list all of the Managed File Transfer transfers that you previously created using the command line or the IBM MQ Explorer.
• fteListTemplates: list available MFT transfer templates
  Use the fteListTemplates command to list the available Managed File Transfer transfer templates on a coordination queue manager.
• fteMigrateAgent: migrate an FTE V7.0 agent to MQ V7.5 or later
  To migrate an existing agent and its associated configuration from WebSphere MQ File Transfer Edition Version 7.0 to IBM WebSphere MQ Version 7.5 or later, use the fteMigrateAgent command to migrate. This command can be used to migrate a standard agent, a Connect:Direct agent, or a protocol bridge agent. The command can also be used to migrate multiple agents in a single request.
• fteMigrateConfigurationOptions: migrate an FTE V7.0 configuration to MQ V7.5 or later
  The fteMigrateConfigurationOptions command migrates a set of configuration options from WebSphere MQ File Transfer Edition Version 7.0 and copies them to IBM WebSphere MQ Version 7.5 or later, provided that the files do not already exist on the target version. If the files already exist, a message is output and the command does not continue.
• fteMigrateLogger: migrate an FTE V7.0 database logger to MQ V7.5 or later
  To migrate the configuration of an existing stand-alone database logger from WebSphere MQ File Transfer Edition Version 7.0.1 or later to IBM WebSphere MQ Version 7.5 or later, use the fteMigrateLogger command.
• fteModifyAgent: run an MFT agent as a Windows service
  The fteModifyAgent command modifies an existing agent so that it can be run as a Windows service. This command is only available on Windows.
• fteModifyLogger: run an MFT logger as a Windows service
  Use the fteModifyLogger command to modify a Managed File Transfer logger so that it can be run as a Windows service. We can use this command only on Windows platforms, and we must first stop the logger by using the fteStopLogger command.
• fteObfuscate: encrypt sensitive data
  The fteObfuscate command encrypts sensitive data in credentials files. This stops the contents of credentials files being read by someone who gains access to the file. From IBM MQ Version 9.2, the command has been enhanced to improve the encryption.
• ftePingAgent: check whether an MFT agent is active
  The ftePingAgent command pings a Managed File Transfer agent to determine whether the agent is reachable and, if so, whether it is able to respond to a simple query.
• fteRAS: run RAS gathering tool
  The fteRAS command runs the RAS gathering tool to collect MustGather data.
• fteSetAgentLogLevel: set MFT protocol bridge agent log level
  Use the fteSetAgentLogLevel command to enable or disable diagnostic information logging for file transfers between a Managed File Transfer protocol bridge agent and FTP/SFTP/FTPS file servers.
• fteSetAgentTraceLevel: modify current trace level for an agent
  Use the fteSetAgentTraceLevel command to modify the current trace level for an agent dynamically.
• fteSetLoggerTraceLevel: modify current trace level for a logger
  Use the fteSetLoggerTraceLevel command to modify the current trace level for a Managed File Transfer logger dynamically.
• fteSetProductId: set z/OS SCRT recording product id
  The fteSetProductId is used to set the product type against which Managed File Transfer usage is to be recorded for the installation. This command is valid only on z/OS.
• 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 we issue commands.
• fteSetupCoordination: set up properties files and directories for coordination queue manager
  The fteSetupCoordination command creates properties files and the coordination queue manager directory for Managed File Transfer.
• fteShowAgentDetails: display MFT agent details
  Use the fteShowAgentDetails command to display the details of a particular Managed File Transfer Agent. These are the details that are stored by the agent's Managed File Transfer coordination queue manager.
• fteShowLoggerDetails: display MFT logger details
  Use the fteShowLoggerDetails command to display the details of a particular Managed File Transfer logger.
• fteStartAgent: start an MFT agent
  The fteStartAgent command starts a Managed File Transfer agent from the command line.
• fteStartLogger: start an MFT logger
  The fteStartLogger command starts a Managed File Transfer logging application.
• fteStopAgent: stop an MFT agent
  Use the fteStopAgent command to either stop a Managed File Transfer agent in a controlled way or to stop an agent immediately if necessary using the -i parameter.
• fteStopLogger: stop an MFT logger
  The fteStopLogger command stops a Managed File Transfer logger.

Parent topic: Managed File Transfer administration reference

Related concepts

• Authority to use MFT commands

Related reference

• Which MFT commands and processes connect to which queue manager
• fteBatch, fteCommon and ftePlatform helper scripts

Related information

• MFT object naming conventions