 |
» |
|
|
|
The query_emulator_user_def command returns information about 3270 users or 5250
users defined in a SNAplus2 configuration file. It can return summary
or detailed information about a single user or multiple users, depending
on the options used. The command returns information about the definition
of this user in the configuration file, not on the user's current
usage of the emulation program. You can use query_3270_user and query_3270_user_sessions to obtain information about a user's current 3270 emulation
usage. This command is not associated with a particular node because emulation
program users are defined as domain resources. Supplied Parameters | |
Parameter name Type Length Default
[query_emulator_user_def]
num_entries decimal 1
list_options constant LIST_INCLUSIVE
user_name character 32 (null string)
session_name character 8 (null string)
emulator_type constant ALL
|
Supplied parameters are : - num_entries
Maximum number of users for which data should be returned.
You can specify 1 to return data for a
specific user, a number greater than 1 to
return data for multiple users, or 0 (zero)
to return data for all users. If detailed information about user sessions is being returned,
this number includes partial entries (for which a session name is
specified, so that the returned data does not include the user definition
or the user's first session). - list_options
The level of information required for each entry
and the position in the list of users 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 session for the first user in
the list - LIST_INCLUSIVE
Start at the entry specified by the supplied user
name and session name, or start at the first session for the specified
user if no session name is specified - LIST_FROM_NEXT
If a session name is specified, start at the session immediately
following the specified session. If no session name is specified,
start at the first session for the specified user
- user_name
The name of the user or group for whom information
is required, or the name to be used as an index into the list of
users. This parameter is ignored if list_options is set to FIRST_IN_LIST. The
name is character string of 1-32 locally displayable characters. - session_name
The name of the session on which information is required.
To return information starting with a specific session name for
the specified user, set this parameter to the session name. To return
information starting at the first session for the specified user,
do not specify this parameter. - emulator_type
Specify whether to filter the returned information
by session type. Possible values are: - 3270_SESSION
Return information only about 3270 sessions. - 5250_SESSION
Return information only about 5250 sessions. - ALL
Return information about all sessions regardless
of session type.
Returned Parameters: Summary Information | |
Parameter name Type Length
user_name character 32
|
If the command executes successfully and you specified SUMMARY as
the list_options parameter value, the following parameter is returned: - user_name
The name of the user or group.
Returned Parameters: Detailed Information | |
Parameter name Type Length
user_name character 32
description character 31
style_file character 8
num_sessions decimal
max_act_sessions decimal
view_rtm constant
alert_permission constant
change_lu constant
change_style constant
user_is_group constant
|
{3270_session_data}
session_name character 8
description character 31
lu_name character 8
session_type constant
model_override constant
|
{5250_session_data}
session_name character 8
description character 31
local_lu_alias character 8
plu_alias character 8
fqplu_name character 17
mode_name character 8
session_type constant
|
If the command executes successfully and you specified DETAIL as
the list_options parameter value, the following parameters are returned: - user_name
The name of the user or group. - description
An optional string of 0-31 characters. - style_file
The name of this user's default style file. This
name is a string of 1-8 characters; for a HP-UX environment,
the actual file name used is the name specified here with the extension .stu (3270) or .stx (5250) appended to it. For a Windows environment, refer
to the emulator documentation for details about style file naming conventions. - num_sessions
The total number of sessions (3270, 5250, or both) defined
for the user. - max_act_sessions
The maximum number of sessions (3270, 5250, or both) that
this user can access simultaneously. Possible values are: - 0
The user cannot access 3270 emulation. - 1-10
The user can access a maximum number of sessions simultaneously
specified by this value. - 0xFFFFFFFF
The user can access an unlimited number of sessions.
- view_rtm
Specifies whether the user has permission to view response
time monitor (RTM) data. This parameter also determines whether
the last transaction time indicator (LTTI) is displayed on the 3270
status line. Possible values are: - YES
The user can view RTM data. The LTTI is displayed. - NO
The user cannot view RTM data. The LTTI is not displayed.
- alert_permission
Specifies whether the user has permission to send
3270 user alerts. Possible values are: - YES
The user can send 3270 user alerts. - NO
The user cannot send 3270 user alerts.
- change_lu
Specifies whether the user has permission to change the
mapping of 3270 sessions to LUs (either by remapping the sessions
from within the 3270 user interface, or by specifying LU names on
the command line when starting the 3270 emulation program). Possible
values are: - YES
The user can change the mapping of 3270 sessions
to LUs. - NO
The user cannot change the mapping of 3270 session
to LUs.
- change_style
Specifies whether the user has permission to load
or modify 3270 style files. Possible values are: - ADVANCED
The user can specify a style file name when starting the
3270 emulation program and can create or modify style files using
the 3270 emulation program's menu interface. - NORMAL
The user can specify a style file name when starting the
3270 emulation program and can create or modify style files using
the 3270 emulation program's menu interface. The user cannot modify
the default style file specified by the style_file parameter.
The 3270 emulation program does not distinguish between the
two values ADVANCED and NORMAL;
to prevent users from modifying the default style file, set the
permissions on this file so that users do not have write access
to it. - INITIAL
The user was given permission to specify a style
file name on the command line when the 3270 emulation program was
started, but not to load, create, or modify style files from within
the menu interface. - RESTRICTED
The user is restricted to the default style file
specified by the style_file parameter and cannot create or modify style files.
- user_is_group
Specifies whether the user_name parameter identifies HP-UX user names or HP-UX group
names. Possible values are: - YES
The user_name parameter identifies a group name. Any user in this
group will use this emulator user record unless there is an explicit
record for the user's user name. - NO
The user_name parameter identifies a user name.
If the command requested information about user sessions,
a 3270_session_data or 5250_session_data subrecord is returned for each session. For more information
about these subrecords, see “define_emulator_user”. 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_EMULATOR_USER
The list_options parameter was set to LIST_INCLUSIVE,
but the user_name parameter did not match the name of any defined user. - INVALID_SESSION_NAME
The list_options parameter was set to LIST_INCLUSIVE,
but the session_name parameter did not match a session name defined for
the specified user.
|
Printable version
