 |
» |
|
|
|
The query_3270_user_sessions command returns information about a 3270 emulation user's
current sessions. The command can return summary or detailed information
about a single session or multiple sessions, depending on the options
used. You can use query_emulator_user_def to obtain information about the configuration file definition
of a 3270 user (such as session limits and access to 3270 functions)
and query_3270_user to obtain general information about the user's 3270 emulation
program usage. This command must be issued to a running node. Supplied Parameters | |
Parameter name Type Length Default
[query_3270_user_sessions]
num_entries decimal 1
list_options constant SUMMARY + LIST_INCLUSIVE
user_name character 32
system_name character 64 (null string)
user_pid decimal 0
lu_name character 8 (null string)
|
Supplied parameters are: - num_entries
Maximum number of user sessions for which data should
be returned. You can specify 1 to return
data for a specific user session, a number greater than 1 to return
data for multiple user sessions, or 0 (zero)
to return data for all user sessions. - list_options
The level of information required for each entry
and the position in the list of user sessions 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 combination
of the user_name, system_name, and user_pid parameters - LIST_FROM_NEXT
Start at the entry immediately following the entry specified
by the combination of the user_name, system_name, and user_pid parameters
- user_name
The name of the 3270 user for whom session information
is required; this name is an a string of 1-32 locally displayable
characters. This parameter must be specified. - system_name
The computer name for which 3270 user session information
is required; this name is a string of 1-64 locally displayable
characters. If all SNAplus2 components are running on one computer, there
is no need to specify the computer name. Otherwise, if no computer
name is specified, SNAplus2 returns the first entry it finds for
the specified user name; you do not need to specify the computer
name unless the specified user is using the 3270 emulation program
on more than one computer. - user_pid
The process ID of the 3270 emulation program for which
session information is required.If the SNAplus2 system includes
only one server, this parameter is required only if the user is
using more than one copy of the 3270 emulation program. If there are
multiple servers and no process ID is specified, SNAplus2 returns
the first entry it finds for the specified user name; you do not
need to specify the process ID unless the specified user is using
more than one copy of the 3270 emulation program on the computer
specified by the system_name parameter. If you specify this parameter, you must
also specify the system_name parameter. - lu_name
The name of the LU used by the 3270 session for
which information is required, or the LU name to be used as an index
into the list of sessions. This parameter is ignored if list_options is set to FIRST_IN_LIST; all sessions
for the combination of the user_name, system_name, and user_pid parameters are returned.
Returned Parameters: Summary Information | |
Parameter name Type Length
lu_name character 8
|
If the command executes successfully and you specified SUMMARY as
the list_options parameter value, the following parameter is returned: - lu_name
The LU used by the 3270 session.
Returned Parameters: Detailed Information | |
Parameter name Type Length
lu_name character 8
nau_address decimal
|
If the command executes successfully and you specified DETAIL as
the list_options parameter value, the following parameters are returned: - lu_name
The LU used by the 3270 session. - nau_address
The NAU address of the LU used by the 3270 session.
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_3270_USER
The user_name, system_name, or user_pid parameter was not set to a valid value. - INVALID_3270_SESSION
The lu_name parameter was not set to a valid value.
|
Printable version
