Note on usage
Function: Cancel asynchronous requests
User group: FT user and FT administrator
Functional description
You can use the ftcanr command to cancel asynchronous requests which are in the course of being processed or which are waiting to be processed in the request queue. As an FT user, you can only cancel requests entered under your own login name.
The FT administrator can cancel any requests. In addition, as administrator you can delete requests unconditionally, i.e. without negotiating with the partner system.
If file transfer requests have already been started, the status of the destination file may be undefined.
Format
ftcanr -h |
[ -f ]
[ -ua=<user ID> | @a ]
[ -ini=l | -ini=r | -ini=lr | -ini=rl ]
[ -pn=<partner 1..200> ]
[ -fn=<file name 1..512> ]
<request ID 1..2147483647> [<request ID 1..2147483647> ...] | @a
Description
-h
Displays the command syntax on the screen. Entries after the -h are ignored.
-f
Allows you to delete the request unconditionally from the local request queue, i.e. without negotiation with the partner system. Note that this can cause requests with an undefined state to arise in the partner's request queue.
You can only call this option as FT administrator. The precondition is that the request was first cancelled with ftcanr without the option -f.
-ua=user ID | @a
You use -ua to indicates the user ID for which requests are to be cancelled.
user ID
The user can only specify his/her own login name.
The FT administrator can specify any login name.
@a
This option is only significant for the FT administrator. The FT administrator can specify @a to cancel the requests of all the login names.
-ua= not specified
Your login name is used as the selection criterion. Exception: The FT administrator has called the command and specified transfer IDs. In this case, the default is @a.
-ini=l | -ini=r | -ini=lr | -ini=rl
You use -ini to indicate the initiating party for which you want to cancel requests. You can specify l, r, lr, rl:
l
Only requests initiated locally are cancelled.
r
Only requests initiated remotely are cancelled.
lr, rl
Both local and remote requests are cancelled.
-ini not specified
The initiator is not used as a selection criterion (corresponds to lr or rl).
-pn=partner
You use -pn to specify the partner system for which you want to cancel requests. Partner is the name or address of the partner system. You should specify the partner in the same form as in the request allocation or as in the output from the ftshwr command.
-fn=file name
You use -fn to specify the name of the file for which requests are to be cancelled. Requests which access this file in the local system are cancelled.
You must specify the file name which was used when the request was issued and which is output for the ftshwr command. Wildcards are not permitted in file names.
request ID1 [request ID2] [request ID3] ... | @a
For request ID, enter the number of the request to be cancelled. Leading zeros may be omitted. The request identification request ID may be obtained from the request receipt acknowledgment displayed on the screen, or using the ftshwr command if you have forgotten the request ID. You can also specify a number of request identifications at the same time.
If, in addition to request ID, you specify other selection criteria, a request with the specified request ID is only cancelled if it also satisfies the other conditions.
@a specified as request ID
@a selects all requests.
If request IDs were specified and the other selection criteria specified are not satisfied by the requests, the request is not cancelled and the following new error message is issued:
ftcanr: Request request ID not found
request ID is the identification of the last unsuitable request.
Examples
The asynchronous request with request identification 65546 should be deleted.
ftcanr 65546All local requests to the partner ux1 which relate to the file file1 should be deleted.
ftcanr -pn=ux1 -fn=file1 -ini=l @a