query_userid_password

The query_userid_password command returns information about user ID / password pairs for use with APPC and CPI-C conversation security, or about profiles for a defined user ID and password. This command can be used to obtain information about a specific user ID / password pair or about multiple pairs, depending on the options used.

This command returns password information in clear text. Be careful how you use this command to ensure that unauthorized users are not given access to password information.

Supplied Parameters

Parameter name           Type        Length    Default
[query_userid_password]
num_entries              decimal               1
list_options             constant              LIST_INCLUSIVE
user_id                  character   10        (null string)

Supplied parameters are:

num_entries

Maximum number of user ID / password pairs for which data should be returned. You can specify 1 to return data for a specific user ID / password pair, a number greater than 1 to return data for multiple user ID / password pairs, or 0 to return data for all user ID / password pairs.

list_options

The position in the list of user ID / password pairs from which SNAplus2 begins to return data.

Possible values are:

FIRST_IN_LIST: Start at the first entry in the list
LIST_INCLUSIVE: Start at the entry specified by the user_id parameter
LIST_FROM_NEXT: Start at the entry immediately following the entry specified by the user_id parameter

user_id

User ID for which information is required or the user ID to be used as an index into the list of user ID/password pairs. This ID is a type-AE character string. The user ID is ignored if list_options is set to FIRST_IN_LIST.

Returned Parameters

Parameter name           Type           Length
user_id                  character      10
description              character      31
profile                  character      10

(Up to ten profiles can be returned on the profile parameter.)

If the command executes successfully, SNAplus2 returns the following parameters:

user_id: User identifier.
description: A text string describing the user ID and password, as specified in the definition of the user ID and password.
profile: Each line is a profile associated with the 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.

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_USERID: The list_options parameter was set to LIST_INCLUSIVE to list all entries starting from the supplied user ID, but the user_id parameter value was not valid.

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.