Jump to content United States-English
HP.com Home Products and Services Support and Drivers Solutions How to Buy
» Contact HP
More options
HP.com home
HP 9000 Networking: HP-UX SNAplus2 Administration Command Reference > Chapter 2 Commands (activate_session to initialize_session_limit)

define_emulator_user

» 

Technical documentation

Complete book in PDF
» Feedback
Content starts here

 » Table of Contents

 » Index

The define_emulator_user command identifies a user of the SNAplus2 system who can use 3270 emulation or 5250 emulation, and it defines the resources available to that user. Use this command to define a new user, to define new sessions for use by an existing user, or to modify the user parameters and session parameters for an existing user. (To delete sessions from an existing user, use delete_emulator_user.)

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
[define_emulator_user]
user_name character 32
description character 31 (null string)
style_file character 8 (null string)
max_act_sessions decimal 10
view_rtm constant NO
alert_permission constant NO
change_lu constant NO
change_style constant NORMAL
user_is_group constant NO
{3270_session_data}
session_name character 8
description character 31 (null string)
lu_name character 8
session_type constant 3270_DISPLAY_MODEL_2
model_override constant YES

(One or more 3270_session_data subrecords may be included.)

{5250_session_data}
session_name character 8
description character 31 (null string)
local_lu_alias character 8
plu_alias character 8 (null string)
fqplu_name character 17 (null string)
mode_name character 8 QPCSUPP
session_type constant 5250_DISPLAY

(One or more 5250_session_data subrecords may be included.)

Supplied parameters are:

user_name

The name of the emulation program user. This name is character string of 1-32 locally displayable characters. Possible values are:

  • The HP-UX user ID of a 3270 or 5250 user on the SNAplus2 computer (or, for a Windows Client user, the user name specified in the SNAplus2 client network data file). The user_is_group parameter must be set to NO.

  • The HP-UX group ID of a group of 3270 or 5250 user on the SNAplus2 computer (or, for a Windows Client user, the group name specified in the SNAplus2 client network data file). The user_is_group parameter must be set to YES.

To set up a default record that will be used by any user not explicitly named in the configuration, specify the record name <DEFAULT> (in uppercase and including the angle bracket characters), and set user_is_group to NO. To restrict use of the emulation program to users and groups that are explicitly named in the configuration, do not specify <DEFAULT>.

When the user starts the emulation program, SNAplus2 checks the user ID against the emulator user records in the configuration to find the correct record, in this order:

  • If the user ID matches a record for a specific user name, the specific user name record is used.

  • If the user ID cannot be matched but the user's group ID matches a record for a group, the group ID record is used.

  • If the user ID and the group ID cannot be matched but there is a <DEFAULT> record defined, the default record is used.

description

An optional string of 0-31 characters. SNAplus2 uses this string for information only. It is stored in the node's configuration file and returned on the query_emulator_user_def command. You can use it to store additional information such as the user's full name, to help distinguish between users.

style_file

The name of this user's default style file. This name is a string of 1-8 characters. For HP-UX systems, the actual file name used is the name specified here with the extension .stu (3270) or .stx (5250) appended to it. For Windows systems, refer to the emulator documentation for details about style file naming conventions.

max_act_sessions

The maximum number of sessions that this user can access simultaneously. (For a 5250-only user, this parameter is ignored.) Use this parameter as follows:

  • To prevent the user from using 3270 emulation, set this parameter to 0 (zero).

  • To restrict the number of sessions that the user can use simultaneously, set this parameter to a value between 1 and 10 (or between 1 and the total number of sessions defined for the user if it is less than 10).

  • To specify no limit, set this parameter to any value above 10.

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. (For a 5250-only user, this parameter is ignored.) Possible values are:

YES

The user has permission to view RTM data. The LTTI is displayed.

NO

The user does not have permission to view RTM data. The LTTI is not displayed.

alert_permission

Specifies whether the user has permission to send 3270 user alerts. (For a 5250-only user, this parameter is ignored.) 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 them from within the 3270 user interface or by specifying LU names on the command line when starting the 3270 emulation program). (For a 5250-only user, this parameter is ignored.) 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, you should set the permissions on this file so that users do not have write access to it.

INITIAL

The user can specify a style file name on the command line when starting the 3270 emulation program, but cannot load, create, or modify style files from within the menu interface. This option enables you to provide a choice of standard initial style files for a user.

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 a group name or a user name. 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.

One or more 3270_session_data subrecords may follow. Each subrecord contains the following additional parameters:

session_name

A name identifying the session. This name is an 8-byte string consisting of locally displayable characters. If the name matches an existing session name defined for this 3270 user, the information for that session is replaced; otherwise, a new session is added.

To define sessions that are initially displayed in the 3270 emulation program's control interface, specify a name in the range SESS0001-SESS0010. These names correspond to the session numbers 1-10 in the control interface. If you use the names SESS0002, SESS0003, and SESS0005, the control interface will display session numbers 2, 3, and 5 using the information defined for these names. (The names SESS0001-SESS0010 are not displayed in the control interface; they are replaced by the long names defined for these sessions in the 3270 style file.)

Sessions that are available for the user to remap to must be given names that are not in the range SESS0001-SESS0010. The user will be able to access these sessions only if the change_lu parameter enables the user to remap sessions.

description

An optional string of 0-31 characters. SNAplus2 uses this string for information only. It is stored in the node's configuration file and returned on the query_emulator_user_def command.

lu_name

Name of the LU or LU pool that this session uses. This name is an 8-byte character string. It must match the name of a type 0-3 LU or an LU pool that has already been defined.

If you assign the session to an LU that is in an LU pool, SNAplus2 will try to use this LU when the session is activated. If the LU is not available, SNAplus2 will attempt to find a free LU from the pool (as though the session had been assigned to the pool).

session_type

Type of the LU or pool (display or printer, and the screen model for display LUs). Possible values are:

3270_DISPLAY_MODEL_2

Display model 2 (80 x 24)

3270_DISPLAY_MODEL_3

Display model 3 (80 x 32)

3270_DISPLAY_MODEL_4

Display model 4 (80 x 43)

3270_DISPLAY_MODEL_5

Display model 5 (132 x 27)

PRINTER

Printer LU (this value is not valid if lu_name specifies an LU pool)

model_override

Specifies whether the user has permission to change the session to use a different screen model from the one specified. Possible values are:

YES

The user can change the screen model.

NO

The user cannot change the screen model.

One or more 5250_session_data subrecords may follow. Each subrecord contains the following additional parameters:

session_name

A name identifying the session. This name is an 8-byte string consisting of locally displayable characters. If the name matches an existing session name defined for this 5250 user, the information for that session is replaced; otherwise, a new session is added.

description

An optional string of 0-31 characters. SNAplus2 uses this string for information only. It is stored in the node's configuration file and returned on the query_emulator_user_def command.

local_lu_alias

LU alias of the local LU that this session uses. This must match the name of an APPC local LU that has already been defined.

plu_alias

LU alias of the partner LU that this session uses.

To indicate that the partner LU is identified by its fully qualified name instead of its LU alias, do not specify this parameter, and specify the fully qualified name in the fqplu_name parameter. For more information, see define_partner_lu.

fqplu_name

Fully qualified name of the partner LU. Specify 3-17 type-A characters that consist of a 1-8 character network name, followed by a period, followed by a 1-8 character partner LU name.

This parameter is used only if the plu_alias parameter is not specified; it is ignored if plu_alias is specified.

mode_name

Name of the mode that this session uses. This name is an 8-byte type-A character string starting with a letter. The mode name must match the name of an APPC mode that has already been defined; it is generally set to the SNA-defined mode name QPCSUPP.

session_type

Type of the 5250 session (display or printer). Possible values are:

5250_DISPLAY

Display session

5250_PRINTER

Printer session

Returned Parameters

No parameters are returned by SNAplus2 when this command executes successfully.

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

No parameter errors occur for this command.

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.

Printable version
Privacy statement Using this site means you accept its terms Feedback to webmaster
© 2001 Hewlett-Packard Development Company, L.P.