Step 3: Prepare for z/OSMF server initialization

This topic describes the actions that you must perform so that the z/OSMF server is initialized during system IPL.

Started procedures for the z/OSMF server

IBM supplies the z/OSMF started procedures in your order, as follows:
  • ServerPac and CustomPac orders: IBM supplies the z/OSMF procedures in the SMP/E managed proclib data set. In ServerPac and SystemPac, the data set is named SYS1.IBM.PROCLIB, by default.
  • CBPDO orders: For a CBPDO order, the SMP/E-managed proclib data set is named SYS1.PROCLIB. However, the z/OS installer might have renamed this data set.

The z/OSMF started procedures are IZUANG1, IZUSVR1, and IZUINSTP. Be sure to use the z/OS V2R3 level of the z/OSMF started procedures because the IZUANG1 and IZUSVR1 procedures are different from those used for prior releases.

The IZUINSTP procedure is new in z/OS V2R3; it is used by the z/OSMF server for communicating with z/OS components. Do not modify IZUINSTP.

Note: Another started procedure, IZUSVR2, is provided in SYS1.SAMPLIB. If you choose not to autostart the z/OSMF server, the IZUSVR2 procedure can be used for starting the z/OSMF server manually.

Place the started procedures in a data set that is in the IEFPDSI concatenation that is used by the system to find started procedures before the primary subsystem (JES) initializes. It is recommended that this data set is the same data set that is used by JES to find started procedures after JES initializes.

Existing z/OSMF installations using older levels of the IZUANG1 and IZUSVR1 procedures must replace or update them from the new ones that are part of z/OS V2R3. Otherwise, the z/OSMF server might not start on a z/OS V2R3 system.

Logon procedure for the z/OSMF REST interfaces

IBM supplies a default logon procedure, IZUFPROC, in the PROCLIB data set. The procedure is used internally by the z/OSMF REST interfaces. Review the procedure to ensure that it is suitable for use in your environment.

Ensure that the SMP/E-managed PROCLIB data set resides in the JES PROCLIB concatenation that is used for TSO/E logon procedures. Or, copy IZUFPROC to a data set that is in the JES PROCLIB concatenation. For more information. For more information, see z/OS TSO/E Customization.

Note: z/OSMF uses the ISPEXEC load module in the ISPF library SISPLOAD. If your installation does not include the SISPLOAD data set in the link list, you must add SISPLOAD to the ISPLLIB DD concatenation in the logon procedure.
If you prefer, you can use a different logon procedure, if it provides the same function as the shipped IZUFPROC procedure. Specifically, the logon procedure must contain, at a minimum:
  • All of the DD statements from IZUFPROC; these must reference the system data sets that contain the z/OS UNIX REXX exec programs and ISPF libraries.
  • The PROC statement must specify the z/OSMF root code directory path on the ROOT variable, for example: ROOT='/usr/lpp/zosmf'

    If your installation configured z/OSMF to use another path for the root code directory, specify that path instead. The path must be enclosed in quotation marks, begin with a forward slash ('/'), and be fully qualified (it cannot be relative). Mixed-case file system names are allowed.

  • If your installation uses permanent (non-temporary) data set for ISPFPROF, the logon procedure must be configured to allow profile sharing.
  • The PROC statement must specify the Language Environment message file (MSGFILE), which is used for storing runtime messages from the z/OS data set and file REST services. For details, see Output messages file.

The topic IZUPRMxx reference information describes options for the TSO/E logon procedure that can be specified on the COMMON_TSO statement. You can specify a different TSO/E logon procedure name, account number, and address space region size, or use the default specifications.

The defaults should be adequate for most z/OS installations. If you specify alternative values, you must ensure that the z/OSMF user and z/OSMF administrator security groups are authorized to use the logon procedure name and account number that you specify. Also, ensure that the address space region size is at least 50 MB, and that your SMFLIMxx parmlib member and IEFUSI exit allow TSO/E users to use this amount of memory.

All z/OSMF users must have TSO segments that are defined in your installation's security database. Failure to have a TSO segment causes some z/OSMF functions not to work.

Output messages file

The z/OS data set and file REST services write runtime messages to a common output messages file. The messages describe error conditions and suggest possible solutions to the errors. By default, these messages are written to SYSOUT.

Your installation can select another destination for message output by using the Language Environment MSGFILE runtime option. In the logon procedure that is used by the z/OS data set and file REST services, ensure that the message file ddname is specified, as follows:
  • If your installation does not specify a message file ddname, you must ensure that the SYSOUT DD statement is specified in the logon procedure. For example:
    //SYSOUT   DD SYSOUT=H
  • If your installation uses the Language Environment MSGFILE runtime option, you must ensure that the logon procedure is changed accordingly.
    To view the current MSGFILE definition on your system, you can use the following command:
    D CEE,ALL
    Which displays output, such as the following:
    PARMLIB(CEEPRM60)               MSGFILE(LEMSG,FBA,121,0,NOENQ)
    In this example, the message file ddname is LEMSG (not SYSOUT). Thus, you would modify the logon procedure, as follows:
    //LEMSG   DD SYSOUT=H
    Or, to write the data to a specific data set, you can modify the logon procedure, as follows:
    //LEMSG DD DSN=YOUR.CREATED.DATASET,DISP=OLD

    In this example, the diagnostic logs are written to the data set that you specify. Ensure that the data set is created with the format FBA,121,0,NOENQ.