delete_emulator

The delete_emulator_user command is used to do one of the following:

Delete the name of a user of the 3270 emulation program or 5250 emulation program, so that this user can no longer use the program.
Delete one or more of the user's sessions but leave the user configured.

Because emulation program users are defined as domain resources, this command is not associated with a particular node.

Supplied Parameters

Parameter name          Type          Length      Default
[delete_emulator_user]
user_name               character     32
delete_options          constant                  DELETE_USER
session_name            character     8           (null string)

(Up to ten session_name parameters can be included.)

Supplied parameters are:

user_name

The name of the 3270 or 5250 user. This name is a string of 1-32 locally displayable characters which must match a previously defined 3270 or 5250 user name.

delete_options

To delete one or more sessions but leave other sessions configured, do not specify this parameter, and specify the session names to be deleted as session_name parameters. Otherwise, specify one of the following values:

3270_SESSION: Delete all 3270 sessions but leave the user configured.
5250_SESSION: Delete all 5250 sessions but leave the user configured.
ALL_SESSIONS: Delete all sessions of both types but leave the user configured.
DELETE_USER: Delete the session named by the value specified for the session_name parameter. If no value is specified for the session_name parameter, delete the user and all the user's sessions.

session_name: The long name of the session. Up to ten session_name parameters can be included. This parameter is ignored unless the delete_options parameter is set to DELETE_USER.

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

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 specified user name did not match any defined user name.
INVALID_USER_SESSION: The specified session name did not match the name of a 3270 session or 5250 session defined for this user.

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.

delete_emulator_user

Technical documentation

» Table of Contents