Note on usage
Function: Cancelling an openFT-Script request
User group: FT user and FT administrator
Functional description
ftcans allows you to cancel openFT-Script requests that have not yet been concluded. You can cancel either a specific openFT-Script request or all the openFT-Script requests for a user. This also cancels any file transfer requests started by the specified openFT-Script requests which are currently running. This may take a little time. The status of the openFT-Script request is then set to "cancelled" to prevent any restart.
If the openFT-Script request that is to be cancelled is currently being processed then the following message is output at stderr:
ftcans: Cancellation request for ftscript id
ftscript id started
If the request has been started but not yet processed then the following message is sent to stderr:
ftcans: ftscript id
ftscript id cancelled.
Format
ftcans -h |
[ -u=<user ID> ] <ftscriptid> | @a
Description
-h
Outputs the command syntax on screen. Any specifications after -h are ignored.
-u=user ID
User ID under which the search for the openFT-Script request that is to be cancelled is performed.
Only FT administrators may input a user ID.
The default value is the calling party's user ID.
ftscriptid
Identification of the openFT-Script request. This is output if the openFT-Script request is started via an ftscript command.
You can use the wildcard symbols ? and * in der ftscriptid. This cancels all openFT-Script requests that match the wildcard pattern.
?
is interpreted as any single character.
*
is interpreted as any number of characters.
If you use wildcards, enclose the ftscriptid specification in single quotes so that the wildcard symbols are not interpreted by the shell.
@a means that all the user's openFT-Script requests are to be cancelled.