 |
» |
|
|
|
The query_3270_user command returns information about users of the SNAplus2
3270 emulation program. The command can return summary or detailed
information about a single user or multiple users, depending on
the options used. It returns information about the user's current usage
of 3270 emulation, not on the definition of this user in the configuration
file; use query_emulator_user_def to obtain information about the configuration file definition
(such as session limits and access to 3270 functions), and query_3270_user_sessions to obtain detailed information about individual sessions. This command must be issued to a running node. Supplied Parameters | |
Parameter name Type Length Default
[query_3270_user]
num_entries decimal 1
list_options constant SUMMARY + LIST_INCLUSIVE
scope constant USER
user_name character 31 (null string)
system_name character 63 (null string)
user_pid decimal 0
|
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. - 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 entry in the list - LIST_INCLUSIVE
Start at the entry specified by the combination
of the scope, 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 scope, user_name, system_name, and user_pid parameters
- scope
The range of 3270 emulation users for which information
is to be returned. This parameter is used in conjunction with the list_options parameter to specify which entries are required. The scope parameter specifies whether to filter the returned information
by one or more of the user_name, system_name, and user_pid parameters. Possible values are: - USER
Return information about all 3270 emulation programs running
with the specified user name, or about all 3270 users if no name
is specified. - SYSTEM
Return information about 3270 emulation programs running
on the specified computer. - USER_AT_SYSTEM
Return information about all 3270 emulation programs running
with the specified 3270 user name on the specified computer. - USER_PROCESS
Return information about a specific copy of the
3270 emulation program, identified by the 3270 user name, computer
name, and process ID.
- user_name
The name of the 3270 user for whom information is required,
or the name to be used as an index into the list of users. The user
name is a string of 1-31 locally displayable characters.
This parameter is ignored if list_options is set to FIRST_IN_LIST. - system_name
The computer name for which 3270 user information
is required; this name is a string of 1-63 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, or unless the scope is set to USER_PROCESS. - user_pid
The process ID of the 3270 emulation program for which
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. If the process ID is not required, set it to 0 (zero).
Returned Parameters: Summary Information | |
Parameter name Type Length
user_name character 31
system_name character 63
user_pid decimal
|
If the command executes successfully and you specified SUMMARY as
the list_options parameter value, the following parameters are returned: - user_name
The name of the 3270 user. - system_name
The computer name on which the 3270 emulation program
is running. - user_pid
The process ID of the 3270 emulation program.
Returned Parameters: Detailed Information | |
Parameter name Type Length
user_name character 31
system_name character 63
user_pid decimal
user_uid decimal
user_gid decimal
user_gname character 31
user_session_count decimal
user_start_time character 26
|
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 3270 user. - system_name
The computer name on which the 3270 emulation program
is running. - user_pid
The process ID of the 3270 emulation program. - user_uid
The HP-UX user ID with which the 3270 emulation program
is running. - user_gid
The HP-UX group ID with which the 3270 emulation program
is running. - user_gname
The HP-UX group name with which the 3270 emulation
program is running. - user_session_count
The number of sessions currently active for this
copy of the 3270 emulation program. You can use query_3270_user_sessions to obtain detailed information about these sessions. - user_start_time
The time at which the user started the 3270 emulation program
(this may be earlier than the start time for the first session).
On HP-UX, this value is a character string in the format generated
by the HP-UX function ctime()(); for example, Thu Nov 24 17:01:12 1994.
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.
|
Printable version
