fteDeleteTemplates: delete an MFT template
Use the fteDeleteTemplates command to delete an existing Managed File Transfer template from a coordination queue manager.
Purpose
The fteDeleteTemplates command removes one or more file transfer templates from a coordination queue manager. When you run this command a request is passed to the IBM MQ system to remove the templates from the coordination queue manager so that the templates are no longer available to the IBM MQ Explorer or the command line. The templates we are deleting might continue to be accessed for a brief interval after the command completes until the IBM MQ system actions the request.
We can run the fteDeleteTemplates command from any system that can connect to the IBM MQ network and subsequently route to the coordination queue manager. Specifically for the command to run, we must have installed Managed File Transfer on this system and we must have configured this system's Managed File Transfer to communicate with the IBM MQ network. If no connectivity details are available, the agent queue manager details are used for connection instead, provided these details are available.
Specify the optional -p parameter for this command only if we want to use a set of configuration options different from your default set. See Configuration options for more information.
Syntax
fteDeleteTemplates
Parameters
- -p (configuration_options)
- Optional. This parameter determines the set of configuration options
to use to delete the template. By convention use the name of a non-default
coordination queue manager as the input for this parameter. The command
then uses the set of properties files associated with this non-default
coordination queue manager.
If we do not specify this parameter, the set of configuration options based on the default coordination queue manager is used.
- -mquserid (userID)
- Optional. Specifies the user ID to authenticate with the coordination queue manager.
- -mqpassword (password)
- Optional. Specifies the password to authenticate with the coordination queue manager. We must also specify the -mquserid parameter. If you specify -mquserid, but do not specify -mqpassword, we will be prompted to supply the associated password. The password will not be displayed.
- (template_names)
- Required. Specify one or more template names that we want to delete. Specify the name as displayed by the fteListTemplates command.
- -? or -h
- Optional. Displays command syntax.
Example
In this example, the template STANDBY is deleted:fteDeleteTemplates STANDBY
Return codes
- 0
- Command completed successfully.
- 1
- Command ended unsuccessfully.
Parent topic: MFT commands
Related reference
- fteCreateTemplate: create new file transfer template
- fteListTemplates: list available MFT transfer templates
Related information