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.


Purpose

We can either list all scheduled transfers based on source agent names or based on the coordination queue manager.

Specify the optional -p parameter for this command only if we want to use configuration options different from your defaults. If we do not specify -p, the configuration options defined in installation.properties are used. See Configuration options for more information.

When you run the fteListScheduledTransfers command, any scheduled transfer that has a transfer definition with a semantically incorrect date and time combination causes error messages to be displayed. From Version 9.2.0, Fix Pack 1 for Long Term Support, these messages are BFGCL0810E messages that include the schedule ID of the invalid scheduled transfer. We can then run the fteDeleteScheduledTransfer command with the schedule_ID parameter to delete the invalid scheduled transfer.


Syntax

fteListScheduledTransfers

fteListScheduledTransfers -pconfiguration_options-mquseriduserID-mqpasswordpasswordpattern


Parameters

    -p (configuration_options)
    Optional. If we have more than one coordination queue manager, use this parameter to explicitly specify which agents we want to list scheduled transfers for. 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 we do not specify this parameter, the configuration options based on the default coordination queue manager are 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.

    pattern
    Optional. The pattern to use to filter the list of Managed File Transfer scheduled transfers. This pattern is matched against the source agent name. Asterisk (*) characters are interpreted as wildcards that match zero or more characters.

    If we do not specify this parameter, all of the scheduled transfers registered with the coordination queue manager are listed by default.

    -? or -h
    Optional. Displays command syntax.


Example

In this example, all of the scheduled transfers with source agents that match the pattern *2 are listed: 
fteListScheduledTransfers "*2"
This example command produces the following output. The schedule start time and next transfer time are displayed in Coordinated Universal Time (UTC): 
Schedule Identifier:     1 
Source Agent Name:       AGENT2 
Source File Name:        C:/export/Test/workspace/A.exe 
Conversion Type:         binary 
Destination File Name:   C:/import/Test/workspace/B001.zzx 
Destination Agent Name:  AGENT1 
Schedule Start Time:     2008-10-23T16:08+0100 
Next Transfer:           2008-10-23T16:08+0100 
Schedule Time Base:      source 
Repeat Interval:         minutes 
Repeat Frequency:        1 
Repeat Count:            30


Return codes

    0
    Command completed successfully.

    1
    Command ended unsuccessfully.

Parent topic: MFT commands


Related reference


Related information