Note on usage
Function: Show monitoring data
User group: FT user and FT administrator
Alias: FTSHWMON
Description of the function
The SHOW-FT-MONITOR-VALUES command allows you to output the monitoring values from openFT operation on the local system. To do this, monitoring must be activated (see MODIFY-FT-OPTIONS command) and openFT must be activated.
Format
SHOW-FT-MONITOR-VALUES / FTSHWMON |
NAME = *STD / *ALL /<list-poss(100): alphanum-name 1..12> ,POLLING = *NONE / *PARAMETERS(...) *PARAMETERS(...) INTERVAL= 1 /<integer 1..600> ,NUMBER= *UNLIMITED / <integer 1..3600> ,INFORMATION= *VALUES (...) / *TYPE *VALUES(...) DATA= *FORMATTED / *RAW ,OUTPUT= *SYSOUT (...) / *SYSLST(...) *SYSOUT(...) / *SYSLST(...) LAYOUT = *STD / *CSV |
Operands
NAME =
Specifies what monitoring values are to be output.
NAME = *STD
A predefined default set of monitoring values is output, see section “Examples”.
NAME = *ALL
All monitoring values are output.
NAME = <list-poss(100): alphanum-name 1..12>
Here you can enter a list of up to 100 names of monitoring values that are to be output. The name must be one of the short names (see the table in the section Description of themonitoring values).
POLLING =
Specifies the interval at which the monitoring values are to be polled.
POLLING = *NONE
The monitoring values are only polled once.
POLLING =*PARAMETERS
In this structure you specify a time interval and a repetition factor for polling the monitoring values. If an error occurs during polling, further repeated output is canceled.
INTERVAL = 1
The time interval for polling the monitoring values is 1 second.
INTERVAL = <integer 1..600>
Time interval in seconds for polling the monitoring values.
NUMBER = *UNLIMITED
There is no limit to the number of times the monitoring values are polled. You terminate the command by canceling output by pressing K2.
NUMBER = <integer 1..3600>
Here you specify how often the monitoring values are to be polled.
INFORMATION =
Specifies whether the monitoring values themselves or the type of the monitoring values is to be output.
INFORMATION = *VALUES(...)
The measured value is output. You can specify whether the monitoring values are to be output in formatted form or as raw data.
DATA = *FORMATTED
The monitoring values are formatted for visual display, e.g. as throughput, maximum or average.
DATA =*RAW
Raw, unformatted data is output. Monitoring values for the duration of an action are not output.
INFORMATION = *TYPE
Outputs the type and, where applicable, the scaling factor of the monitoring value or the type of the metadata.
The scaling factor is only of significance for some monitoring values and in CSV format if *RAW is not specified. In this case, the output value must be divided by the scaling factor to get the real value. In the case of formatted data in tabular format, the scaling factor 100 specifies that the number is output to 2 decimal places.
The following output values are possible for *TYPE:
*BOOL | Boolean value |
*PERCENT | Percentage |
*INT | Integer number (corresponds to *INT(1)) |
*INT(100) | Integer value with a scaling factor of 100 |
*TIME | Timestamp |
*STRING | Text output for the selection |
OUTPUT =
Output medium.
OUTPUT = *SYSOUT (...)
The data is output to SYSOUT.
OUTPUT = *SYSLST(...)
The data is output to SYSLST.
LAYOUT = *STD
Output is formatted in a form readable by the user.
If the monitoring configuration changes (filters), a new header and a new start time for monitoring is output in standard output format.
LAYOUT = *CSV
Data is output in Character Separated Values format. This is a quasi-tabular format that is in widespread use in the field of PCs and in which the individual fields are separated by semicolons ";" (see section “SHOW-FT-MONITOR-VALUES”).
If the monitoring configuration changes (filters), the new start time for monitoring is shown in a separate column in CSV format.
Command return codes
(SC2) | SC1 | Maincode | Meaning |
51 | 32 | CMD0221 | Internal error. |
88 | 32 | CMD0221 | Error on OPS output. |
1 | 0 | FTR1039 | openFT not active. |
59 | 64 | FTR1059 | Monitoring is not active. |
2 | 0 | FTR2225 | Information output cancelled. |
SC1/2 = subcode 1/2 in decimal format For additional information refer to the section “Command return codes”. | |||
OPS variables
The following table shows the OPS variables for the SHOW-FT-MONITOR-VALUES command, which are output with the operand NAME = *ALL. Values shown in bold are also output with the operand NAME = *STD.
Element | Type | Output |
CURRENT | Struct | |
.DATE | String | yyyy-mm-dd |
.TIME | String | hh:mm:ss |
MON-START | Struct | |
.DATE | String | yyyy-mm-dd |
.TIME | String | hh:mm:ss |
PARTNER-SEL | Struct | |
.OPENFT | String | *YES / *NO |
.FTAM | String | *YES / *NO |
.FTP | String | *YES / *NO |
REQUEST-SEL | Struct | |
.ASYNC | String | *YES / *NO |
.SYNC | String | *YES / *NO |
.LOCAL | String | *YES / *NO |
.REMOTE | String | *YES / *NO |
THROUGHPUT | Struct | |
.NET-BYTES-TOTAL | String | Value |
.NET-BYTES-SEND | String | Value |
.NET-BYTES-RCV | String | Value |
.NET-BYTES-TEXT | String | Value |
.NET-BYTES-BIN | String | Value |
.DISK-TOTAL | String | Value |
.DISK-SEND | String | Value |
.DISK-RCV | String | Value |
.DISK-TEXT | String | Value |
.DISK-BIN | String | Value |
.REQ-TOTAL | String | Value |
.REQ-F-TRANS | String | Value |
.REQ-F-MANAG | String | Value |
.REQ-SUCC | String | Value |
.REQ-ABORT | String | Value |
.REQ-INTR | String | Value |
.ADMIS-FAIL | String | Value |
.FOLLOWUP | String | Value |
.CONN-SUCC | String | Value |
.CONN-FAIL | String | Value |
.CONN-ABORT | String | Value |
DURATION | Struct | |
.REQ-TOTAL-OUTB | String | Value |
.REQ-TOTAL-INB | String | Value |
.REQ-F-TRANS-OUTB | String | Value |
.REQ-F-TRANS-INB | String | Value |
.REQ-F-MANAG-OUTB | String | Value |
.REQ-F-MANAG-INB | String | Value |
.REQ-WAIT | String | Value |
.DNS-OUTB | String | Value |
.DNS-INB | String | Value |
.CONN-ESTABL | String | Value |
.F-OPEN-OUTB | String | Value |
.F-OPEN-INB | String | Value |
.F-CLOS-OUTB | String | Value |
.F-CLOS-INB | String | Value |
.ADMIS-CHECK-OUTB | String | Value |
.ADMIS-CHECK-INB | String | Value |
STATE | Struct | |
.NUM-REQ-ACT-ASYN | String | Value |
.NUM-REQ-ACT-SYN | String | Value |
.NUM-REQ-WAIT | String | Value |
.NUM-REQ-HOLD | String | Value |
.NUM-REQ-SUSPEND | String | Value |
.NUM-REQ-LOCK | String | Value |
.NUM-REQ-FINISH | String | Value |
.CONN-LIM | String | Value |
.NUM-CONN-ACT | String | Value |
.REQ-LIM | String | Value |
.NUM-REQ-QUEUE | String | Value |
.OPENFT-ACT | String | Value |
.FTAM-ACT | String | Value |
.FTP-ACT | String | Value |
.TRACE | String | Value |