fteDeleteScheduledTransfer (delete a scheduled file transfer)
Purpose
Use the fteDeleteScheduledTransfer command to delete a WebSphere® MQ File Transfer Edition scheduled transfer that you have previously created either using the command line or the WebSphere MQ Explorer.Specify the optional -p parameter for this command only if you want to use configuration options different from your defaults. If you do not specify -p, the configuration options defined in wmqfte.properties are used. See Configuration options for more information.
Syntax
fteDeleteScheduledTransfer >>-fteDeleteScheduledTransfer-----------------------------------> >--+------------------------------+-----------------------------> '- -p--(configuration_options)-' >--+------------------------+-- -agentName--(agent_name)--------> '- -m--(agent_qmgr_name)-' >--schedule_ID-------------------------------------------------><
Parameters
- -p (configuration_options)
- Optional. If you have more than one coordination queue manager,
use this parameter to explicitly specify which scheduled transfer
you want to delete. Use the name of a non-default coordination queue
manager as the input for this parameter. The command then uses the
configuration options associated with this non-default coordination
queue manager.
If you do not specify this parameter, the configuration options based on the default coordination queue manager are used.
- -m (agent_qmgr_name)
- Optional. The name of the queue manager that the source agent is connected to. If you do not specify this parameter, the agent's queue manager is determined from the configuration options in use.
- -agentName (agent_name)
- Required. The name of the source agent that you want to delete the scheduled transfer from.
- schedule_ID
- Required. The ID of the scheduled transfer that you want to delete.
You can find the schedule ID by running the fteListScheduledTransfers command against the name of the source agent.
- -? or -h
- Optional. Displays command syntax.
Example
In this example, a scheduled transfer on source agent AGENT2 with the ID 27 is deleted:fteDeleteScheduledTransfer -agentName AGENT2 27
Return codes
- 0
- Command completed successfully.
- 1
- Command ended unsuccessfully.