Note on usage
Function: Display ADM traps
User group: FT administrator, ADM administrator, and users configured as remote administrators on the remote administration server.
Functional description
If you are the FT administrator of the ADM trap server, ftshwatp allows you to obtain information on the ADM traps sent to the ADM trap server and stored in the ADM trap log file there.
If the ADM trap server is also used as remote administration server, both the ADM administrator and the remote administrators can view traps.
If you are the ADM administrator of the remote administration server, you can view all ADM traps.
If you are a remote administrator, you can view "your" ADM traps (locally or with ftadm). This means that you only see the ADM traps of those openFT instances for which you have at least FTOP permission. See the ftshwc command.
The ADM traps are identified by trap IDs. The trap IDs are assigned in ascending sequence. For technical reasons, the numbering sequence is not always unbroken. If no other specifications are made, openFT always outputs the most recent ADM trap. When requested, openFT outputs all the ADM traps up to the number specified in the command.
The ADM traps are stored in the ADM trap log file. The maximum number of stored ADM traps depends on the maximum possible size of the ADM trap log file. If the maximum number of ADM traps is exceeded, the records with the lowest trap ID are overwritten by the current records.
You can choose between three output formats, short output format, detailed output format and CSV output format (Character Separated Value).
The ADM traps are output to standard output.
Format
ftshwatp -h |
[ -rg=[[[[yyyy]mm]dd]hhmm |
#1..999999999999999999 ][- [[[[yyyy]mm]dd]hhmm |
[ #1..999999999999999999 ] ]
[ -src=<partner 1..200> ]
[ -tt=[fts][,][pts][,][ptu][,][rqc][,][rqf][,][rqs] ][ -nb=1.. 9999999 | -nb=@a ]
[ -l | -csv ]
Description
-h
Displays the command syntax on the screen. Entries after the -h are ignored.
-rg=[[[[yyyy]mm]dd]hhmm][-[[[[yyyy]mm]dd]hhmm]
With -rg, you can optionally specify the start or end of a time period.
[[[yyyy]mm]dd]hhmm
If you specify a time as 4 digits, this is interpreted as hours and minutes. 6 digits are interpreted as day (date) and time in hours and minutes, 8 digits as month, day and time in hours and minutes and 12 digits as year, month, day and time in hours and minutes. The largest possible value that can be entered for the date is 20380119 (19th January 2038).
openFT then outputs the ADM traps that lie between the specified limits.
-rg=[[[yyyy]mm]dd]hhmm
The ADM traps that occurred at the specified time are output.
-rg=[[[yyyy]mm]dd]hhmm-[[[yyyy]mm]dd]hhmm
The time period begins with the start time and ends with the second time specified.
If a number is specified with -nb that is smaller than the number of ADM traps in the period, the required number of ADM traps up to the end time is output.
-rg=[[[yyyy]mm]dd]hhmm-
The time period begins at the start time and ends with the most recent ADM trap entry.
If a number is specified with -nb that is smaller than the number of ADM traps in the period, the most recent ADM traps are output.
-rg=-[[[yyyy]mm]dd]hhmm
The time period ends at the specified time.
If a number is specified with -nb that is smaller than the number of ADM traps in the period, the required number of ADM traps up to the end time is output.
-rg=[#1..999999999999999999][-[#1..999999999999999999]]
With -rg, you can optionally specify the start or end of a trap ID range.
#1..999999999999999999
Selection of a trap ID is indicated by the leading # sign. openFT outputs those ADM traps that lie within the specified range.
-rg=#1..999999999999999999
The ADM trap with exactly this trap ID is output. If this ID does not exist (gaps in the numbering are possible), the following message is output: No ADM traps available for the selected criteria.
-rg=#1..999999999999999999-#1..999999999999999999
The range starts with the ADM trap with the first specified trap ID and ends with the second specified trap ID.
If a number is specified with -nb that is smaller than the number of ADM traps in the range, the required number of records up to the end ID is output.
-rg=#1..999999999999999999-
The range starts with the ADM trap for the specified trap ID and ends with the most recent ADM trap.
If a number is specified with -nb that is smaller than the number of ADM traps in the period, the most recent ADM traps are output.
-rg=-#1..999999999999999999
The range ends with the ADM trap with the specified trap ID.
If a number is specified with -nb that is smaller than the number of ADM traps in the range, the required number of ADM traps up to the end ID is output.
-rg not specified
The trap ID range or the time period is not used as a selection criterion, in other words, output starts with the current (most recent) ADM trap.
-src=partner
-src allows you to specify that only those ADM traps are to be displayed that originate from a specific partner. You can specify the name from the partner list or specify the partner address.
-src not specified
The partner name is not used as a selection criterion.
-tt=[fts][,][pts][,][ptu][,][rqc][,][rqf][,][rqs]
-tt allows you to specify the type of ADM traps to be output. You can specify several values separated by commas:
fts
All ADM traps are output that indicate that the asynchronous openFT has started (*FT-START) or stopped (*FT-STOP).
pts
All ADM traps are output that indicate a status change of a partner system (*PART-STATE).
ptu
All ADM traps are output that indicate that a partner system may not be reachable (*PART-UNREA).
rqs
All ADM traps are output that indicate that the amount of requests in the request queue has reached a limit of at least 85% (*RQ-LIM-HIGH) or has fallen below a value of 80% (*RQ-LIM-LOW).
rqf
All ADM traps are output that indicate failed transfer (*TRANS-FAIL).
rqc
All ADM traps are output that indicate successful transfer (*TRANS-SUCC).
-tt not specified
The ADM trap type is not used as a selection criterion.
-nb=1.. 9999999 | @a
-nb allows you to specify the number of ADM traps to be output.
@a for number
-nb=@a outputs all ADM traps that meet the specified selection criteria.
-nb not specified
If -nb is not specified, the output will depend on whether -rg has also been specified or
not:
If -rg is specified, all ADM traps that meet the specified selection criteria are output
(corresponds to -nb=@a).If -rg is not specified, then only one ADM trap is output (corresponds to -nb=1).
-l
-l specifies that the ADM traps are to be output in detailed format.
-csv
-csv specifies that the ADM traps are to be output in CSV format. The values in the output are separated by semicolons.
-csv must not be specified at the same time as -l.
Neither -l nor -csv specified
The ADM traps are output in the default short format.