Note on usage
Function: Query status of file transfer request
User group: FT user and FT administrator
Alias name: FTSHWREQ
Functional description
The NSTATUS command allows you to request information about FT requests. As with NCANCEL, you can specify selection criteria in order to obtain information about specific FT requests.
FT users can only obtain information about the FT requests they own.
The FT administrator can obtain information about the requests of any owner. For this purpose, he/she must enter the NSTATUS command in FT administration mode.
The owner of requests issued in the local system is the user ID under which they are submitted. The owner of requests issued in the remote system is the user ID in the local system under which the requests are executed.
The scope of information to be output can be selected. By default the following information is output by the system in response to the NSTATUS command:
the transfer ID of the request,
the initiator of the request (local or remote system),
the operating status of the request (see description of operands for more details),
the partner system,
the transfer direction,
the name of the file to be transferred in the local system,
the number of bytes transferred.
By entering INFORMATION=*ALL in the NSTATUS command more information can be obtained. openFT then, in addition to the standard output, outputs the values of further operands of the transfer command that was used to issue the request. Which output parameters are displayed depends on the parameters which were specified for the request.
The complete description of all possible output parameters and values is provided in the section “Description of the long output of NSTATUS”.
The more precise your information request, the fewer irrelevant requests are output.
The specification of INFORMATION=*SUMMARY returns a small table with the number of jobs in the various request states.
Format
NSTATUS / FTSHWREQ |
TRANSFER-ID = *ALL / <integer 1..2147483647> ,SELECT = *OWN / *PARAMETERS(...) *PARAMETERS(...) OWNER-IDENTIFICATION = *OWN / *ALL / <name 1..8> ,INITIATOR = ( *LOC AL, *REMOTE ) / list-poss(2): *LOCAL / *REMOTE ,PARTNER = *ALL (...) / <text 1..200 with-low> *ALL(...) PARTNER-STATE = *ALL / *ACTIVE ,FILE-NAME = *ALL / <filename 1..59> / <c-string 1..512 with-low> ,MONJV = *NONE / ,JV-PASSWORD = *NONE ,STATE = *ALL / *SUSPEND / *LOCKED / *WAIT / *ACTIVE / *CANCELLED / *FINISHED / *HOLD ,GLOBAL-REQUEST-ID = *ALL / <alphanum-name 1..10> ,INFORMATION = *STD / *ALL / *SUMMARY ,OUTPUT = *STDERR (...) / *STDOUT(...) *STDERR (...) / *STDOUT(...) LAYOUT = *STD / *CSV |
Operands
TRANSFER-ID =
Transfer ID of the FT request about which information is required.
TRANSFER-ID = *ALL
Supplies information about all the owner’s FT requests.
The FT user can only obtain information about the current requests he/she owns.
The FT administrator can obtain information about all current FT requests that access his/her system.
TRANSFER-ID = <integer 1..2147483647>
Transfer ID assigned to the local system and output as part of the message confirming acceptance of the request.
SELECT =
Contains selection criteria defining the file transfer requests on which inquiries are to be made. Information on a file transfer request is output if the request satisfies all the specified criteria.
SELECT = *OWN
Provides information on all current file transfer requests for which you are designated as the owner.
SELECT = *PARAMETERS(...)
OWNER-IDENTIFICATION =
Owner of the FT requests. Only the FT administrator can make use of this operand unrestricted.
OWNER-IDENTIFICATION = *OWN
Provides information only on the file transfer requests in the user’s own ID.
OWNER-IDENTIFICATION = *ALL
Provides information on FT requests in all user IDs.
OWNER-IDENTIFICATION = <name 1..8>
Specific user ID about whose file transfer requests information is required. The FT user may only enter his/her own user ID. The specification corresponds to *OWN.
INITIATOR =
Initiator of the file transfer requests concerned.
INITIATOR = ( *LOCAL,*REMOTE )
Provides information on file transfer requests issued in the local system and in remote systems.
INITIATOR = *LOCAL
Provides information on file transfer requests issued in the local system.
INITIATOR = *REMOTE
Provides information on file transfer requests issued in the remote systems.
PARTNER =
Selects file transfer requests carried out with a specified remote system.
PARTNER = *ALL (...)
The partner system is not used as a selection criterion to determine the file transfer requests on which information is to be output.
PARTNER-STATE =
The status of the partner system is used as a selection criterion.
PARTNER-STATE = *ALL
The requests are selected independently of the partner system’s status.
PARTNER-STATE = *ACTIVE
Only the requests to and from the active partners are selected.
PARTNER = <text 1..200 with-low>
Name or an address of a partner system. Information is required on the file transfer requests being executed with this system. For more information on address specifications, see section “Specifying partner addresses”
FILE-NAME =
FT requests that access this file in the local system as a send file or receive file. The file name or library member name must be specified exactly as it appears in the FT request. If %UNIQUE was specified, the file name generated by openFT must be entered as the selection criterion here.
FILE-NAME = *ALL
The file name is not used as a selection criterion to define the file transfer requests on which information is to be output.
FILE-NAME = <filename 1..59> / <c-string 1..512 with-low>
Name of a file. Information is required on the file transfer requests that access this file.
MONJV = *NONE
The parameter is supported for reasons of compatibility only.
JV-PASSWORD = *NONE
The parameter is supported for reasons of compatibility only.
STATE =
Selects those file transfer requests that are in the specified status. The status of a request may change in between entry of the command and information output. This is why the output may include requests that are in a state other than the one selected with STATE.
STATE = *ALL
The status of a request is not used as a selection criterion to define the file transfer requests on which information is to be output.
STATE = *SUSPEND
Requests information on those file transfer requests that are currently in SUSPEND status (= interrupted, e.g. by the command FTMODOPT STATE=*INACTIVE in the remote system or by a high-priority FT request).
STATE = *LOCKED
Requests information on FT requests that are in the LOCKED operating status (= temporarily locked as a result of a longer term resource bottleneck).
STATE = *WAIT
Requests information on those file transfer requests that are currently in WAIT status (= waiting for resources).
STATE = *ACTIVE
Requests information on those file transfer requests that are currently in ACTIVE status (= being processed).
STATE = *CANCELLED
Requests information on those file transfer requests that were canceled and are waiting for negotiation with the communications partner to be concluded. These requests are visible only to the FT administrator.
STATE = *FINISHED
Requests information on those file transfer requests that are currently in FINISHED status (= terminated or aborted, but where the user has not yet been informed).
STATE = *HOLD
Requests information on those FT requests that are currently in HOLD status (= awaiting the specified start time).
GLOBAL-REQUEST-ID =
Selects the FT requests on the basis of the global request identification.
GLOBAL-REQUEST-ID = *ALL
The global request identification is not a search criterion.
GLOBAL-REQUEST-ID = <alphanum-name 1..10>
Requests information on the FT request with a particular global request identification. The global request identification is relevant only for inbound requests of
openFTpartners. It is assigned by the initiator of the request (transfer ID) and transferred to the local system.
INFORMATION =
Scope of the output.
INFORMATION = *STD
Output is summary form and contains the following information (see Description of the shortoutput of NSTATUS):
Transfer ID,
Initiator,
State of the request,
Partner,
Direction of transfer,
Byte count,
File or library member name in the local system.
INFORMATION = *ALL
Output is in full form. In addition to the summary form data, further information is provided on the operands used in the NCOPY command (see Description of the long output ofNSTATUS).
INFORMATION = *SUMMARY
Output is in the form of a specified sum. By specifying INFORMATION=*SUMMARY, you can restrict the output information to a statistic of the currently existing requests. By doing this, the display is arranged according to the conditions in which the requests find themselves. The displayed sum can, of course, exceed the sum of the individual columns, since all requests, even those that still have no request condition, are counted. Information is output about the number of request in each individual processing status (see Descriptionof the summary output of NSTATUS).
OUTPUT =
Output medium.
OUTPUT = *STDERR (...)
Output is performed to SYSTSPRT or to SYSERR if this DDNAME is defined.
OUTPUT = *STDOUT(...)
Output is performed to SYSPRINT.
LAYOUT = *STD
Output is formatted using a standard layout that can be easily read by the user.
LAYOUT = *CSV
Output is supplied in CSV (Character Separated Values) format. This is a widely used tabular format, especially in the PC environment, in which individual fields are separated by a delimiter, which is usually a semicolon “;“ (see section “NSTATUS”).
If selection criteria are specified in the NSTATUS command and no request is found that matches all the specified criteria, the command is acknowledged with the following message:
FTR0504 OPENFT: No requests available for the selection criteria