Image_Query_DM

Input Parameters:
input_length
function_name_length
function_name
authenticated_userid_length
authenticated_userid
password_length
password
target_identifier_length
target_identifier
Response 1 – Immediate Request Verification:
request_id
Response 2 – Output Parameters:
output_length
request_id
return_code
reason_code
image_record_array_length
image_record_array (1)
image_record_structure (2)
image_record_length
image_record
Note:
  1. An array consists of zero or more of its components.
  2. A structure consists of one set of its components.

Purpose

Use Image_Query_DM to obtain a virtual image’s directory entry.

Input Parameters

input_length
(int4) The total length of all input parameters (after this one).
function_name_length
(int4) Length of function_name – in this case, 14.
function_name
(string,14,char43) The API function name – in this case, 'Image_Query_DM'.
authenticated_userid_length
(int4) Length of authenticated_userid.
authenticated_userid
One of the following:
  • (string,1-8,char42) The userid under whose authority to perform the function (AF_INET requests).
  • (string,0-8,char42) The userid under whose authority to perform the function (AF_IUCV requests).

Note that authenticated_userid is optional for AF_IUCV requests. See Client Authentication for more information.

password_length
(int4) Length of password.
password
One of the following:
  • (string,1-200,charNA) The password or passphrase to be used for authentication (AF_INET requests).
  • (string,0-200,charNA) The password or passphrase to be used for authentication (AF_IUCV requests).

Note that password is optional for AF_IUCV requests. See Client Authentication for more information.

target_identifier_length
(int4) Length of target_identifier.
target_identifier
(string,1-8,char42) The name of the image being queried.

Response 1 -- Immediate Request Verification

request_id
(int4) The identifier of the request.

Response 2 -- Output Parameters

output_length
(int4) The total length of all output parameters (after this one).
request_id
(int4) The identifier of the request (same as returned in immediate request verification above).
return_code
(int4) The return code.
reason_code
(int4) The reason code.
image_record_array_length
(int4) Length of image_record_array.
image_record_array
(array) An array consisting of zero or more instances of image_record_structure, as follows:
image_record_structure
(structure) A structure consisting of one set of image_record_length and image_record, as follows:
image_record_length
(int4) Length of image_record.
image_record
(string,1-80,charNA) A record from the virtual image's directory entry.

Usage Notes

  1. See the "Creating and Updating a User Directory" chapter in z/VM: CP Planning and Administration for more information on the directory format and on specific directory statements.

Return and Reason Codes

RC RC Name RS RS Name Description
0 RC_OK 0 RS_NONE Request successful
24 RCERR_SYNTAX pprr pprr Syntax error in function parameter
100 RCERR_AUTH 8 RS_AUTHERR_ESM Request not authorized by external security manager
    12 RS_AUTHERR_DM Request not authorized by directory manager
    16 RS_AUTHERR_SERVER Request not authorized by server
120 RCERR_USER_PW_BAD 0 RS_NONE Authentication error; userid or password not valid
400 RCERR_IMAGEDEF 4 RS_NOT_FOUND Image definition not found
500 RCERR_DM 8 RS_NOT_AVAILABLE Directory manager is not available
592 RCERR_ASYNC_DM nnnn opid Asynchronous operation started - product-specific asynchronous operation ID
596 RCERR_INTERNAL_DM nnnn psrc Internal directory manager error - product-specific return code
900 RCERR_SERVER 12 RS_FUNCTION_NOT_VALID Specified function does not exist
    20 RS_PARM_LIST_NOT_VALID Total length does not match the specified input data
    24 RS_SFS_ERROR Error accessing SFS directory
    36 RS_LENGTH_NOT_VALID Specified length was not valid, out of valid server data range