query_3270

The query_3270_diag command returns information about the 3270 diagnostics parameters for the SNAplus2 system. The command always returns information about the parameters used to record and display response-time data. Depending on the options used, it can also return data about one or more 3270 user alerts that users can send to the host NetView program.

This command is not associated with a particular node because 3270 diagnostics parameters are defined as domain resources.

If 3270 diagnostics parameters have not been defined, the command returns the default parameters that SNAplus2 uses for response-time data; no alert definitions are returned.

Supplied Parameters

Parameter name         Type        Length      Default
[query_3270_diag]
num_entries            decimal                 0
list_options           constant                LIST_INCLUSIVE
alert_number           decimal                 1

Supplied parameters are:

num_entries

Maximum number of 3270 user alerts for which data should be returned. You can specify 1 to return data for a specific 3270 user alert, a number greater than 1 to return data for multiple 3270 user alerts, or 0 (zero) to return data for all 3270 user alerts.

The default for this command indicates “return all entries,” unlike other query_* commands for which the default is to return a specific entry.

list_options

The position in the list of alerts from which SNAplus2 begins to return data.

Specify one of the following values:

FIRST_IN_LIST: Start at the first entry in the list
LIST_INCLUSIVE: Start at the entry specified by the alert_number parameter
LIST_FROM_NEXT: Start at the entry immediately following the entry specified by the alert_number parameter

If no alerts are being defined, this parameter must be set to FIRST_IN_LIST (or the -a option must be specified on the snapadmin command line, which sets FIRST_IN_LIST).

alert_number

The number of the alert for which information is required, or the number to be used as an index into the list of alerts. Specify a number in the range 1-20. This parameter is ignored if list_options is set to FIRST_IN_LIST.

Returned Parameters

Parameter name           Type           Length     Default
rtm_overflow             constant
rtm_unbind               constant
rtm_timer_option         constant
rtm_thresh1              decimal
rtm_thresh2              decimal
rtm_thresh3              decimal
rtm_thresh4              decimal
num_alerts               decimal

{alert_3270_data}
description              character      51         (null string)
parameter1               character      31         (null string)
parameter2               character      31         (null string)
parameter3               character      31         (null string)

(Up to 20 alert_3270_data subrecords can be included.)

rtm_overflow through num_alerts

The 3270 diagnostics information. For information about these parameters, see “define_3270_diag”.

For each alert, an alert_3270_data subrecord is included. For information about the parameters used in this subrecord, see “define_3270_diag”.

Error Return Codes

If the command cannot be executed, SNAplus2 returns a primary return code to indicate the type of error and a secondary return code to provide specific details about the reason for unsuccessful execution.

Parameter Check

If the command does not execute because of a parameter error, SNAplus2 returns the following parameters:

primary_rc

PARAMETER_CHECK

secondary_rc

Possible values are:

INVALID_ALERT_NUMBER

The list_options parameter was set to LIST_INCLUSIVE or LIST_FROM_NEXT, but one of the following events has occurred:

The alert_number parameter was not in the valid range.
The alert with the specified number has not been defined.
No alerts have been defined.

State Check

No specific state errors, other than those listed in Appendix A “Common Return Codes from snapadmin Commands” occur for this command.

Other Conditions

Appendix A “Common Return Codes from snapadmin Commands” lists combinations of primary and secondary return codes that are common to all commands.

query_3270_diag

Technical documentation

» Table of Contents