Installing IMS Administration Foundation

IMS Administration Foundation is introduced in UMS1.1.0.13 (UI81668) by its APAR PH47708. To work with and manage IMS on your subsystems, you must have IMS Administration Foundation installed and configured properly.

1. To stop the Unified Management Server started task, run the following command:

   /S <stc>,ACTION=STOP

   where <stc> is the name of the started task. The default name is IZPSRV. You might have configured a different value during UMS installation.
2. Complete the following steps to prepare a UMS configuration member for IMS Administration Foundation in the UMS PARMLIB. The PARMLIB is the data set that was created by UMS. For details on PARMLIB, see the following topics:
   • Step 2: Setting up installation
   • Populating IZPUMSPM PARMLIB
   • Changing PARMLIB location
   1. Locate the JCL member IZPEXPIN in the JCL library RUNHLQ.JCLLIB that was created as part of UMS. For details on the RUNHLQ variable and how the RUNHLQ.JCLLIB data set is created, see Performing SMP/E installation tasks and Step 2: Setting up installation.
   2. Edit the existing IZPEXPIN, or copy the IZPEXPIN with a new member name and edit the new member as follows:
      • On the following line, specify the z/OS UNIX System Services (USS) directory where Unified Management Server read/write data is located, as specified by IZP_UMS_VARDIR.

        //SET1 SET UMSVLOC='#izp_ums_vardir'

      • On the following line, specify the z/OS USS directory where IMS Administration Foundation was installed by SMP/E. The default location is /usr/lpp/IBM/afn/<vrm>/bin.

        IZP_EXPERIENCE_LOC=#exp_install_location

   3. Submit the JCL.
3. If you receive a return code other than 0, examine the output, correct errors, and resubmit the job.
4. Confirm that a new UMS configuration members IZPIMFPM and IZPIMSPM have been created in the UMS PARMLIB.
5. To configure IMS Administration Foundation, specify the following parameters in IZPIMFPM in YAML format. You can use the parameter values in the original IZPIMFPM member as a sample for specifying parameter values in YAML format.

   imsUtilExeclib

   Specifies the EXEC library SAFNEXEC that was installed by IBM IMS Tools Base for z/OS using SMP/E. This is a required parameter.

   Example:
   imsUtilExeclib: 
   - HLQ.SAFNEXEC 

   imsToolsLoadlib

   Specifies the IMS Tools load module libraries to be used for backend IMS Tools processing. This is an optional parameter. If you want to register at least one IMS data sharing group for which the IMS catalog is not used, you must specify the SHKTLOAD load module library that was installed by IMS Tools Base for z/OS. If you want to use the DBD and PSB map features, you must specify the SHPSLMD0 load module library of IBM IMS Library Integrity Utilities for z/OS. For details of the relationship between IMS Administration Foundation features, IMS Tools products, prerequisite setup, and configuration for servers provided by the IBM IMS Tools Base for z/OS, see IMS Administration Foundation and IMS Tools.

   Example:
   imsToolsLoadlib: 
   - HLQ.SHKTLOAD
   - HLQ.SHPSLMD0

   imsToolsServers

   Specifies the IBM IMS Tools Base servers that are used to provide the following features:

   • Reports for a DBD
   • Statistics for a DBD, a HALDB partition, or a DEDB area
   • Database exceptions and databases with exceptions
   • DBD and PSB map features

   This parameter is optional. If it is specified, all of the following three sub parameters must be specified as a group in YAML format:

   • dai

     Specifies the host address of the TCP server of IBM IMS Tools Base for z/OS Distributed Access Infrastructure (DAI). All of the following sub parameters must be specified:

     • address

       Specifies the host address or IP address of the TCP server. If the secure connection is used by specifying true for the sub parameter sslConnection, consult your security administrator on how to specify the host address.

     • port

       Specifies the port number of the TCP server.

     • sslConnection

       Specifies if the port is secured by the TLS protocol. If the port is secured, specify true. If the port is not secured, specify false. If the port is secured, the UMS server must be able to access at least the root CA certificate that was used to sign the DAI server's certificate chain. If the root CA certificate is missing in the truststore to be used by the UMS server, import the CA certificate into the truststore file or connect the CA certificate to the key ring to be used by the UMS server. For details, see Setting up security for IMS Tools TCP server.

   • itkb

     Specifies the IBM IMS Tools Base IMS Tools Knowledge Base (IMS Tools KB) server. The following sub parameter must be specified:

     • xcfGroupName

       Specifies the XCF group name of the IMS Tools KB server group to be used.

   • ad

     Specifies the IBM IMS Tools Base Autonomics Director (AD) server. The following sub parameter must be specified:

     • xcfGroupName

       Specifies the XCF group name of the AD server group to be used. This is the name prefixed with the character string “IAV” and followed by the string that is specified by the XCFGROUP parameter in the IAVPCOM member of the PROCLIB for the subject AD server. For example, if XCFGROUP=ADM00 is specified, specify the xcfGroupName parameter as shown in Example 1 below.

   If two or more pairs of IMS Tools KB server and AD server are used, you can repeat the group of these sub parameters. Multiple pairs of IMS Tools KB server and AD server can share a same DAI TCP server. For details of configuration options for IBM IMS Tools Base servers, see IBM IMS Tools Base for z/OS Configuration Guide.

   Example 1: Specifying a single set of IMS Tools KB server and AD server with a DAI TCP server
   imsToolsServers: 
   - dai:
        address: localhost
        port: 5123 
        sslConnection: false
     itkb:
        xcfGroupName: FPQSERVR
     ad:
        xcfGroupName: IAVADM00
   

   Example 2: Specifying two sets of IMS Tools KB server and AD server with a single common DAI TCP server
   imsToolsServers: 
   - dai:
        address: zos1.example.com
        port: 5123 
        sslConnection: true
     itkb:
        xcfGroupName: FPQSRVR1
     ad:
        xcfGroupName: IAVADM01
   - dai:
        address: zos1.example.com
        port: 5123 
        sslConnection: true
     itkb:
        xcfGroupName: FPQSRVR2
     ad:
        xcfGroupName: IAVADM02

   Example 3: Specifying two sets of IMS Tools KB server and AD server with different DAI TCP servers
   imsToolsServers: 
   - dai:
        address: zos1.example.com
        port: 5123 
        sslConnection: true
     itkb:
        xcfGroupName: FPQSRVR1
     ad:
        xcfGroupName: IAVADM01
   - dai:
        address: zos2.example.com
        port: 5123 
        sslConnection: true
     itkb:
        xcfGroupName: FPQSRVR2
     ad:
        xcfGroupName: IAVADM02

6. Edit the IZPIMSPM member. The following parameters are used by IMS Administration Foundation:

   imsTempDatasetHLQ

   Specifies the high-level qualifier (HLQ) for temporary data sets that are created during operations of jobs submitted by the Unified Management Server for IMS Administration Foundation functions. The value must be 1 to 8 characters in length.

   This is an optional parameter. If this parameter is not specified, the DBA user ID that was specified by the IZP_PKCS11_DBA_USERNAME parameter of the PARMLIB member IZPUMSPM for Unified Management Server is used as the HLQ for temporary data sets.

7. Set up IMS OM command security for the stared task ID used for the auxiliary address space of the Zowe cross-memory server. For details, see Security setup for the auxiliary address space of Zowe cross-memory server.
8. Set up IMS Connect security if you want to use either of the following features:
   • IMSplex, IMS, and IMS Connect pages
   • IMS command processor
   • IMS SQL processor

   For details of the setup, see the topic Setting up security for IMS Connect servers.

9. Set up resource access permissions for UMS users and the UMS DBA user ID. For details, see Security setup for IMS Administration Foundation.
10. To start Unified Management Server, run the following command:

    /S <stc>

    where <stc> is the name of the started task (the default is IZPSRV).
11. In a supported browser, log in to Zowe at the following URL and open IBM Unified Experience for z/OS.

    https://<hostname>:<port>/ZLUX/plugins/org.zowe.zlux.bootstrap/web/#/

    where <hostname> and <port> are the host name (or IP address) and port of the Zowe host computer.