define_userid_password

The define_userid_password command defines a user ID / password pair for use with APPC and CPI-C conversation security, or adds profiles for a defined user ID and password.

Supplied Parameters

Parameter name                Type              Length        Default
[define_userid_password]
define_type                   constant                        ADD_USER
user_id                       character         10
description                   character         31            (null string)
password                      character         10
profile                       character         10            (null string)

(Up to ten profile parameters can be specified.)

Supplied parameters are:

define_type

Specifies how this command is to be used. Possible values are:

ADD_USER: Add a new user, or change the password for an existing user.
ADD_PROFILES: Add profiles to an existing user id/password record.

user_id

User identifier. This name is a type-AE character string. Some CPI-C implementations have a maximum user ID length of eight characters. If you specify a user ID of nine or ten characters, CPI-C applications running on other systems may not be able to access applications on the SNAplus2 system using this user ID and password.

description

A text string describing the user ID and password. SNAplus2 uses this string for information only. It is stored in the node's configuration file and returned on the query_userid_password command.

password

User's password. This password is a type-AE character string. Some CPI-C implementations have a maximum password length of eight characters. If you specify a password of nine or ten characters, CPI-C applications running on other systems may not be able to access applications on the SNAplus2 system using this user ID and password.

When you type in this parameter on the command line, the value you type in is immediately replaced by the encrypted version of the password. Therefore, the value you supply for the password parameter is never displayed on the command line.

profile

Profile associated with user. Each profile is a type-AE character string.

If a remote TP uses the user ID and password specified for this command when attaching to the local TP, the profile specified on the Attach (if any) must match one of the profile names defined for this command. Consult the System Administrator running the remote TP to determine if profiles are used. For each profile used, specify the profile name as one of the profile parameters on this command. In most cases, profile names are not used, therefore you do not need to specify them on this command.

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_PASSWORD: The password parameter contained a character that was not valid.
INVALID_PROFILE: One or more of the specified profile values were not valid.
INVALID_USERID: The user_id parameter contained a character that was not valid.
NO_PROFILES: The command was used to add profiles to an existing user, but no profiles were specified.
UNKNOWN_USER: The command was used to add profiles to an existing user, but the user_id parameter did not match an existing user ID.

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.