The query_mode_definition command returns information about modes, including SNA-defined
modes. This command can be used to obtain summary or detailed information
about a specific mode or about multiple modes, depending on the
options used.
This command returns information about the definition of the
modes, not about their current usage; use query_mode to obtain information about the current usage of a mode
by local and partner LUs. Modes are ordered by name length and then
by ASCII lexicographical ordering for names of the same length.
This command does not return information about the default
COS name that will be used for any unrecognized mode names; use query_mode_to_cos_mapping for information about the default COS name.
Supplied Parameters |
 |
Parameter name Type Length Default
[query_mode_definition]
num_entries decimal 1
list_options constant SUMMARY + LIST_INCLUSIVE
mode_name character 8 (null string)
|
Supplied parameters are:
- num_entries
Maximum number of modes for which data should be returned.
You can specify 1 to return data for a
specific mode, a number greater than 1 to
return data for multiple modes, or 0 (zero)
to return data for all modes.
- list_options
The level of information required for each entry
and the position in the list of modes from which SNAplus2 begins
to return data.
Specify the level of information required with one of the
following values:
- SUMMARY
Summary information only
- DETAIL
Detailed information
Use a + character to combine this value
with 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 mode_name parameter
- LIST_FROM_NEXT
Start at the entry immediately following the entry specified
by the mode_name parameter
- mode_name
Mode name that designates the network properties
for a group of sessions. This parameter is ignored if list_options is set to FIRST_IN_LIST. This
name is a type-A character string.
Returned Parameters: Summary Information |
|
Parameter name Type Length
mode_name character 8
description character 31
|
If the command executes successfully and you specified SUMMARY as
the list_options parameter value, SNAplus2 returns the following parameters:
- mode_name
Mode name.
- description
A text string describing the mode, as specified
in the definition of the mode.
Returned Parameters: Detailed Information |
|
Parameter name Type Length
mode_name character 8
description character 31
max_ru_size_upp decimal
receive_pacing_win decimal
default_ru_size constant
max_neg_sess_lim decimal
plu_mode_session_limit decimal
min_conwin_src decimal
cos_name character 8
auto_act decimal
min_conloser_src decimal
max_ru_size_low decimal
max_receive_pacing_win decimal
|
If the command executes successfully and you specified DETAIL as
the list_options parameter value, SNAplus2 returns the following parameters:
- mode_name
Mode name.
- description
A text string describing the mode, as specified
in the definition of the mode.
- max_ru_size_upp through max_receive_pacing_win
For information about these parameters, see “define_mode”.
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.
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_MODE_NAME
The list_options parameter was set to LIST_INCLUSIVE to
list all entries starting from the supplied name, but the mode_name parameter value was not valid.
Printable version
