Program Directory for
IBM Remote System Explorer API (RSE API)

V3.1.1

Program Number 5655-EX1

FMID HAMA100

for Use with
z/OS V02.02.00 or later

Document Date: June 2020

GI13-5400-00

 
Note

Before using this information and the product it supports, be sure to read the general information under "Notices".

© Copyright International Business Machines Corporation 2020. All rights reserved.
Note to U.S. Government Users -- Documentation related to restricted rights -- Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule contract with IBM Corp.


Table of Contents

Figures

Introduction

  • RSE API Description
  • RSE API FMIDs
  • Program Materials

  • Basic Machine-Readable Material
  • Program Publications
  • Optional Program Publications
  • Program Source Materials
  • Publications Useful During Installation
  • Program Support

  • Program Services
  • Preventive Service Planning
  • Statement of Support Procedures
  • Program and Service Level Information

  • Program Level Information
  • Service Level Information
  • Installation Requirements and Considerations

  • Driving System Requirements
  • Machine Requirements
  • Programming Requirements
  • Target System Requirements
  • Machine Requirements
  • Programming Requirements
  • DASD Storage Requirements
  • FMIDs Deleted
  • Special Considerations
  • Installation Instructions

  • Installing RSE API
  • SMP/E Considerations for Installing RSE API
  • SMP/E Options Subentry Values
  • Overview of the installation steps
  • Allocate file system to hold web download package
  • Upload the web download package to the host
  • Extract and expand the compressed SMPMCS and RELFILEs
  • Sample Jobs
  • Create SMP/E environment (optional)
  • Perform SMP/E RECEIVE
  • Allocate SMP/E Target and Distribution Libraries
  • Allocate, create and mount ZFS Files (Optional)
  • Allocate File System Paths
  • Create DDDEF Entries
  • Perform SMP/E APPLY
  • Perform SMP/E ACCEPT
  • Run REPORT CROSSZONE
  • Cleaning Up Obsolete Data Sets, Paths, and DDDEFs
  • Activating RSE API
  • File System Execution
  • Product Customization
  • Notices

  • Trademarks
  • Reader's Comments


    Figures


    Introduction

    This program directory is intended for system programmers who are responsible for program installation and maintenance. It contains information about the material and procedures associated with the installation of IBM Remote System Explorer API (RSE API). This publication refers to IBM Remote System Explorer API (RSE API) as RSE API.

    The Program Directory contains the following sections:

    The rest of this section only applies when RSE API is ordered via Shopz. It does not apply when you downloaded it from the web.
    Select this link to go to the next section: "RSE API Description"

    Before installing RSE API, read the CBPDO Memo To Users and the CBPDO Memo To Users Extension that are supplied with this program in softcopy format and this program directory; after which, keep the documents for your reference. Section "Preventive Service Planning" tells you how to find any updates to the information and procedures in this program directory.

    RSE API is supplied in a Custom-Built Product Delivery Offering (CBPDO, 5751-CS3). The program directory that is provided in softcopy format on the CBPDO is identical to the hardcopy format if one was included with your order. All service and HOLDDATA for RSE API are included on the CBPDO.

    Do not use this program directory if you install RSE API with a SystemPac or ServerPac. When you use one of those offerings, use the jobs and documentation supplied with the offering. The offering will point you to specific sections of this program directory as needed.


    RSE API Description

    IBM Remote System Explorer API (RSE API) is a collection of REST APIs that allow a client to work with various components on the z/OS host system, including MVS data sets, z/OS UNIX files and commands, JES jobs, and more.


    RSE API FMIDs

    RSE API consists of the following FMIDs:

    HAMA100

    Program Materials

    An IBM program is identified by a program number. The program number for RSE API is 5655-EX1.

    Basic Machine-Readable Materials are materials that are supplied under the base license and are required for the use of the product.

    The program announcement material describes the features supported by RSE API. Ask your IBM representative for this information if you have not already received a copy.


    Basic Machine-Readable Material

    The distribution medium for this program is physical media or downloadable files. This program is in SMP/E RELFILE format and is installed by using SMP/E. See "Installation Instructions" for more information about how to install the program.

    The rest of this section only applies when RSE API is ordered via Shopz. It does not apply when you downloaded it from the web.
    Select this link to go to the next section: "Program Publications"

    You can find information about the physical media for the basic machine-readable materials for RSE API in the CBPDO Memo To Users Extension.

    Table 1 describes the program file content for RSE API. You can refer to the CBPDO Memo To Users Extension to see where the files reside on the image.

    Notes:

    1. The data set attributes in this table must be used in the JCL of jobs that read the data sets. However, because the data sets are in IEBCOPY unloaded format, their actual attributes might be different.

    2. If any RELFILEs are identified as PDSEs, ensure that SMPTLIB data sets are allocated as PDSEs.

    Table 1. Program File Content
    Name O
    R
    G
    R
    E
    C
    F
    M
    L
    R
    E
    C
    L
    BLK
    SIZE
    IBM.HAMA100.SMPMCS SEQ FB 80 8800
    IBM.HAMA100.F1 PDSE FB 80 8800
    IBM.HAMA100.F2 PDSE FB 80 8800
    IBM.HAMA100.F3 PDSE VB 8796 8800


    Program Publications

    The following sections identify the basic publications for RSE API.

    Table 2 identifies the basic unlicensed program publications for RSE API. Those that are in softcopy format publications can be obtained from the IBM Publications Center website at https://www.ibm.com/shop/publications/order .

    Table 2. Basic Material: Unlicensed
    Publication Title Form Number Media Format
    IBM Remote System Explorer API (RSE API) Host Configuration Guide SC27-9905-00 See note 1
    Note:

    1. These, and other publications can be obtained from the IBM Explorer for z/OS Knowledge Center, https://www.ibm.com/support/knowledgecenter/SSBDYH/welcome.html.

    Requisite information can be obtained by creating a report for RSE API on https://www.ibm.com/software/reports/compatibility/clarity/index.html.

    Optional Program Publications

    No optional publications are provided for RSE API.


    Program Source Materials

    No program source materials or viewable program listings are provided for RSE API.


    Publications Useful During Installation

    You might want to use the publications listed in Table 3 during the installation of RSE API.

    Table 3. Publications Useful During Installation
    Publication Title Form Number
    IBM SMP/E for z/OS User's Guide SA23-2277
    IBM SMP/E for z/OS Commands SA23-2275
    IBM SMP/E for z/OS Reference SA23-2276
    IBM SMP/E for z/OS Messages, Codes, and Diagnosis GA32-0883

    Note:


    Program Support

    This section describes the IBM support available for RSE API. The service number for RSE API is 0500520.


    Program Services

    Contact your IBM representative for specific information about available program services.


    Preventive Service Planning

    Before you install RSE API, make sure that you have reviewed the current Preventive Service Planning (PSP) information. Review the PSP Bucket for General Information, Installation Documentation, and the Cross Product Dependencies sections. For the Recommended Service section, instead of reviewing the PSP Bucket, it is recommended you use the IBM.PRODUCTINSTALL-REQUIREDSERVICE fix category in SMP/E to ensure you have all the recommended service installed. Use the FIXCAT(IBM.PRODUCTINSTALL-REQUIREDSERVICE) operand on the APPLY CHECK command. See "Perform SMP/E APPLY" for a sample APPLY command.

    If you obtained RSE API as part of a CBPDO, HOLDDATA is included.

    If the CBPDO for RSE API is older than two weeks by the time you install the product materials, you can obtain the latest PSP Bucket information by going to the following website:

    http://www14.software.ibm.com/webapp/set2/psearch/search?domain=psp

    You can also use S/390 SoftwareXcel or contact the IBM Support Center to obtain the latest PSP Bucket information.

    For program support, access the Software Support Website at http://www.ibm.com/software/support/.

    PSP Buckets are identified by UPGRADEs, which specify product levels; and SUBSETs, which specify the FMIDs for a product level. The UPGRADE and SUBSET values for RSE API are included in Table 4.

    Table 4. PSP Upgrade and Subset ID
    UPGRADE SUBSET Description
    ZEXPL311 HAMA100 RSE API


    Statement of Support Procedures

    Report any problems which you feel might be an error in the product materials to your IBM Support Center. You may be asked to gather and submit additional diagnostics to assist the IBM Support Center in their analysis.

    Table 5 identifies the component IDs (COMPID) for RSE API.

    Table 5. Component IDs
    FMID COMPID Component Name RETAIN
    Release
    HAMA100 5655EXP33 RSE API 311


    Program and Service Level Information

    This section identifies the program and relevant service levels of RSE API. The program level refers to the APAR fixes that have been incorporated into the program. The service level refers to the PTFs that have been incorporated into the program.


    Program Level Information

    No APARs have been incorporated into RSE API.

    All resolved APARs of previous releases of RSE API have been incorporated into RSE API.


    Service Level Information

    No PTFs against this release of RSE API have been incorporated into the product package.

    Frequently check the RSE API PSP Bucket for HIPER and SPECIAL attention PTFs against all FMIDs that you must install. You can also receive the latest HOLDDATA, then add the FIXCAT(IBM.PRODUCTINSTALL-REQUIREDSERVICE) operand on your APPLY CHECK command. This will allow you to review the recommended and critical service that should be installed with your FMIDs.


    Installation Requirements and Considerations

    The following sections identify the system requirements for installing and activating RSE API. The following terminology is used:

    In many cases, you can use a system as both a driving system and a target system. However, you can make a separate IPL-able clone of the running system to use as a target system. The clone must include copies of all system libraries that SMP/E updates, copies of the SMP/E CSI data sets that describe the system libraries, and your PARMLIB and PROCLIB.

    Use separate driving and target systems in the following situations:


    Driving System Requirements

    This section describes the environment of the driving system required to install RSE API.

    Machine Requirements

    The driving system can run in any hardware environment that supports the required software.

    Programming Requirements


    Table 6. Driving System Software Requirements
    Program
    Number
    Product
    Name
    Minimum
    VRM
    Minimum
    Service Level
    will satisfy
    these
    APARs
    Included
    in the
    shipped
    product?
    5650-ZOS z/OS V02.02.00 or the lowest supported z/OS level, whichever is more recent N/A No

    Note: SMP/E is a requirement for Installation and is an element of z/OS.

    Note: Installation might require migration to new z/OS releases to be service supported. See https://www-01.ibm.com/software/support/lifecycle/index_z.html.

    RSE API is installed into a file system, either HFS or zFS. Before installing RSE API, you must ensure that the target system file system data sets are available for processing on the driving system. OMVS must be active on the driving system and the target system file data sets must be mounted on the driving system.

    If you plan to install RSE API in a zFS file system, this requires that zFS be active on the driving system. Information on activating and using zFS can be found in z/OS Distributed File Service zSeries File System Administration, SC24-5989.


    Target System Requirements

    This section describes the environment of the target system required to install and use RSE API.

    RSE API installs in the z/OS (Z038) SREL.

    Machine Requirements

    The target system can run in any hardware environment that supports the required software.

    Programming Requirements

    Installation Requisites

    Installation requisites identify products that are required and must be present on the system or products that are not required but should be present on the system for the successful installation of this product.

    Mandatory installation requisites identify products that are required on the system for the successful installation of this product. These products are specified as PREs or REQs.

    RSE API has no mandatory installation requisites.

    Conditional installation requisites identify products that are not required for successful installation of this product but can resolve such things as certain warning messages at installation time. These products are specified as IF REQs.

    RSE API has no conditional installation requisites.

    Operational Requisites

    Operational requisites are products that are required and must be present on the system or products that are not required but should be present on the system for this product to operate all or part of its functions.

    Mandatory operational requisites identify products that are required for this product to operate its basic functions.

    Table 7. Target System Mandatory Operational Requisites
    Program Number Product Name and
    Minimum VRM/Service Level
    5655-EX1 IBM Explorer for z/OS V3.1.1 or later versions
    Note: A subset of the FMIDs from 5655-EX1 have been included in this shipment for your convenience. You may already have these FMIDs from the listed Product Number or from another product which ships these FMIDs.

    Conditional operational requisites identify products that are not required for this product to operate its basic functions but are required at run time for this product to operate specific functions. These products are specified as IF REQs.

    RSE API has no conditional operational requisites.

    Toleration/Coexistence Requisites

    Toleration/coexistence requisites identify products that must be present on sharing systems. These systems can be other systems in a multisystem environment (not necessarily sysplex), a shared DASD environment (such as test and production), or systems that reuse the same DASD environment at different time intervals.

    RSE API has no toleration/coexistence requisites.

    Incompatibility (Negative) Requisites

    Negative requisites identify products that must not be installed on the same system as this product.

    RSE API has no negative requisites.

    DASD Storage Requirements

    RSE API libraries can reside on all supported DASD types.

    Table 8 lists the total space that is required for each type of library.

    Table 8. Total DASD Space Required by RSE API
    Library Type Total Space Required
    in 3390 Trks
    Description
    Target 10 Tracks
    Distribution 895 Tracks
    File System(s) 1950 Tracks
    Web Download 2755 Tracks This row only applies when RSE API is downloaded from the web. It does not apply when you ordered it via Shopz.
    These are temporary data sets, which can be removed after the SMP/E install.

    Notes:

    1. For non-RECFM U data sets, IBM recommends using system-determined block sizes for efficient DASD utilization. For RECFM U data sets, IBM recommends using a block size of 32760, which is most efficient from the performance and DASD utilization perspective.

    2. Abbreviations used for data set types are shown as follows.
      U Unique data set, allocated by this product and used by only this product. This table provides all the required information to determine the correct storage for this data set. You do not need to refer to other tables or program directories for the data set size.
      S Shared data set, allocated by this product and used by this product and other products. To determine the correct storage needed for this data set, add the storage size given in this table to those given in other tables (perhaps in other program directories). If the data set already exists, it must have enough free space to accommodate the storage size given in this table.
      E Existing shared data set, used by this product and other products. This data set is not allocated by this product. To determine the correct storage for this data set, add the storage size given in this table to those given in other tables (perhaps in other program directories). If the data set already exists, it must have enough free space to accommodate the storage size given in this table.

      If you currently have a previous release of this product installed in these libraries, the installation of this release will delete the old release and reclaim the space that was used by the old release and any service that had been installed. You can determine whether these libraries have enough space by deleting the old release with a dummy function, compressing the libraries, and comparing the space requirements with the free space in the libraries.

      For more information about the names and sizes of the required data sets, see "Allocate SMP/E Target and Distribution Libraries".

    3. Abbreviations used for the file system path type are as follows.
      N New path, created by this product.
      X Path created by this product, but might already exist from a previous release.
      P Previously existing path, created by another product.

    4. All target and distribution libraries listed have the following attributes:

    5. All target libraries listed have the following attributes:

    6. All target libraries that are listed and contain load modules have the following attributes:

    The following figures describe the target and distribution libraries and file system paths required to install RSE API. The storage requirements of RSE API must be added to the storage required by other programs that have data in the same library or path.

    Note: Use the data in these tables to determine which libraries can be merged into common data sets. In addition, since some ALIAS names may not be unique, ensure that no naming conflicts will be introduced before merging libraries.

    Table 9. Storage Requirements for RSE API Target Libraries
    Library
    DDNAME
    Member
    Type
    Target
    Volume
    T
    Y
    P
    E
    O
    R
    G
    R
    E
    C
    F
    M
    L
    R
    E
    C
    L
    No.
    of
    3390
    Trks
    No.
    of
    DIR
    Blks
    SHUHSAMP Samples ANY U PDSE FB 80 10 5

    Table 10. RSE API File System Paths
    DDNAME T
    Y
    P
    E
    Path Name
    SHUHZFS X /usr/lpp/IBM/rseapi/IBM

    Table 11. Storage Requirements for RSE API Distribution Libraries
    Library
    DDNAME
    T
    Y
    P
    E
    O
    R
    G
    R
    E
    C
    F
    M
    L
    R
    E
    C
    L
    No.
    of
    3390
    Trks
    No.
    of
    DIR
    Blks
    AHUHSAMP U PDSE FB 80 10 5
    AHUHZFS U PDSE VB 8796 885 5

    The rest of this section only applies when RSE API is downloaded from the web. It does not apply when you ordered it via Shopz.
    Select this link to go to the next section: "FMIDs Deleted"

    The following figures list data sets that are not used by RSE API, but are required as input for SMP/E.

    Table 12. Storage Requirements for RSE API Web Download Data Sets
    Data Set
    Name
    T
    Y
    P
    E
    O
    R
    G
    R
    E
    C
    F
    M
    L
    R
    E
    C
    L
    No.
    of
    3390
    Trks
    No.
    of
    DIR
    Blks
    hlq.IBM.HAMA100.F1 U PDSE FB 80 7 N/A
    hlq.IBM.HAMA100.F2 U PDSE FB 80 7 N/A
    hlq.IBM.HAMA100.F3 U PDSE VB 8796 727 N/A
    hlq.IBM.HAMA100.SMPMCS U SEQ FB 80 19 N/A
    z/OS UNIX file system U zFS N/A N/A 1995 N/A
    Note: These are temporary data sets, which can be removed after the SMP/E install.


    FMIDs Deleted

    Installing RSE API might result in the deletion of other FMIDs. To see which FMIDs will be deleted, examine the ++VER statement in the SMPMCS of the product.

    If you do not want to delete these FMIDs at this time, install RSE API into separate SMP/E target and distribution zones.

    Note: These FMIDs are not automatically deleted from the Global Zone. If you want to delete these FMIDs from the Global Zone, use the SMP/E REJECT NOFMID DELETEFMID command. See the SMP/E Commands book for details.


    Special Considerations

    RSE API has no special considerations for the target system.


    Installation Instructions

    This chapter describes the installation method and the step-by-step procedures to install and to activate the functions of RSE API.

    Please note the following points:


    Installing RSE API

    SMP/E Considerations for Installing RSE API

    Use the SMP/E RECEIVE, APPLY, and ACCEPT commands to install this release of RSE API.

    SMP/E Options Subentry Values

    The recommended values for certain SMP/E CSI subentries are shown in Table 13. Using values lower than the recommended values can result in failures in the installation. DSSPACE is a subentry in the GLOBAL options entry. PEMAX is a subentry of the GENERAL entry in the GLOBAL options entry. See the SMP/E manuals for instructions on updating the global zone.

    Table 13. SMP/E Options Subentry Values
    Subentry Value Comment
    DSSPACE (1200,1200,1400) Space allocation
    PEMAX SMP/E Default IBM recommends using the SMP/E default for PEMAX.

    Overview of the installation steps

    The following steps are required to install IBM Remote System Explorer API (RSE API):

    1. Allocate file system to hold the web download package
      (only applicable for web download, not Shopz orders)

    2. Upload the web download package to the host
      (only applicable for web download, not Shopz orders)

    3. Extract and expand the compressed SMPMCS and RELFILEs
      (only applicable for web download, not Shopz orders)

      Select this link to skip the web download specific steps: "Sample Jobs"

    4. Create SMP/E environment (optional)

    5. Perform SMP/E RECEIVE

    6. Allocate SMP/E target and distribution libraries

    7. Allocate and mount z/OS UNIX file system (optional)

    8. Allocate z/OS UNIX paths

    9. Create DDDEF entries

    10. Perform SMP/E APPLY

    11. Perform SMP/E ACCEPT

    12. Run REPORT CROSSZONE

    Allocate file system to hold web download package

    This section only applies when RSE API is downloaded from the web. It does not apply when it is ordered via Shopz.
    Select this link to skip the web download specific steps: "Sample Jobs"

    The SMP/E input data sets to install IBM Remote System Explorer API (RSE API) are provided as compressed files in HAMA100.pax.Z, which must be uploaded to z/OS as a z/OS UNIX file. You can either create a new z/OS UNIX file system (zFS) or create a new directory in an existing file system to place HAMA100.pax.Z.

    You can use the following sample JCL to create a new file system and directory for the download package.

    //FILESYS  JOB <job information>
    //*
    //* - Provide valid job card information
    //* - Change:
    //*   @zfs_path@
    //*   ----+----1----+----2----+----3----+----4----+----5
    //*              - To the absolute z/OS UNIX path for the download
    //*                package (starting with /)
    //*              - Maximum length is 50 characters
    //*              - Do not include a trailing /
    //*   @zfs_dsn@
    //*              - To your file system data set name
    //*
    //* Your userid MUST be defined as a SUPERUSER to successfully
    //* run this job
    //*
    //CREATE   EXEC PGM=IDCAMS,REGION=0M,COND=(0,LT)
    //SYSPRINT DD SYSOUT=*
    //SYSIN    DD *
      DEFINE CLUSTER ( -
             NAME(@zfs_dsn@) -
             TRK(1995  10) -
             LINEAR -
             SHAREOPTIONS(3) -
             )
    //*
    //         SET ZFSDSN='@zfs_dsn@'
    //FORMAT   EXEC PGM=IOEAGFMT,REGION=0M,COND=(0,LT),
    //            PARM='-aggregate &ZFSDSN -compat'
    //*STEPLIB  DD DISP=SHR,DSN=IOE.SIOELMOD        before z/OS 1.13
    //*STEPLIB  DD DISP=SHR,DSN=SYS1.SIEALNKE       from z/OS 1.13
    //SYSPRINT DD SYSOUT=*
    //*
    //MOUNT    EXEC PGM=IKJEFT01,REGION=0M,COND=(0,LT)
    //SYSEXEC  DD DISP=SHR,DSN=SYS1.SBPXEXEC
    //SYSTSPRT DD SYSOUT=*
    //SYSTSIN  DD *
      PROFILE MSGID WTPMSG
      oshell umask 0022; +
        mkdir -p @zfs_path@
      MOUNT +
        FILESYSTEM('@zfs_dsn@') +
        MOUNTPOINT('@zfs_path@') +
        MODE(RDWR) TYPE(ZFS) PARM('AGGRGROW')
    //*
    

    Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

    Upload the web download package to the host

    This section only applies when RSE API is downloaded from the web. It does not apply when it is ordered via Shopz.
    Select this link to skip the web download specific steps: "Sample Jobs"

    Upload the HAMA100.readme.txt file in text format and the HAMA100.pax.Z file in binary format from your workstation to the z/OS UNIX file system.

    In the following sample dialog, we use FTP from a Microsoft Windows command line to do the transfer. Commands or other information entered by the user are in bold, and the following values are assumed:

    Table 14. User Entered Values
    User enters: Values
    mvsaddr TCP/IP address or hostname of the z/OS system
    tsouid Your TSO user ID
    tsopw Your TSO password
    d: Location of the downloaded files
    @zfs_path@ z/OS UNIX path where to store the files. This matches the @zfs_path@ variable you specified in the previous step.

    C:\>ftp mvsaddr
    Connected to mvsaddr.
    220-FTPD1 IBM FTP CS %version% at mvsaddr, %time% on %date%.
    220 Connection will close if idle for more than 5 minutes.
    User (mvsaddr:(none)): tsouid
    331 Send password please.
    Password: tsopw
    230 tsouid is logged on.  Working directory is "tsouid.".
    ftp> cd @zfs_path@
    250 HFS directory @zfs_path@ is the current working directory
    ftp> ascii
    200 Representation type is Ascii NonPrint
    ftp> put d:\HAMA100.readme.txt
    200 Port request OK.
    125 Storing data set @zfs_path@/HAMA100.readme.txt
    250 Transfer completed successfully.
    ftp: 9316 bytes sent in 0.01 sec. (1366.67 Kb/s)
    ftp> binary
    200 Representation type is Image
    ftp> put d:\HAMA100.pax.Z
    200 Port request OK.
    125 Storing data set @zfs_path@/HAMA100.pax.Z
    250 Transfer completed successfully.
    ftp: 35739648 bytes sent in 1.26 sec. (1040.52 Kb/s)
    ftp> quit
    221 Quit command received. Goodbye.
    

    Extract and expand the compressed SMPMCS and RELFILEs

    This section only applies when RSE API is downloaded from the web. It does not apply when it is ordered via Shopz.
    Select this link to skip the web download specific steps: "Sample Jobs"

    The HAMA100.readme.txt file uploaded in the previous step holds a sample JCL to expand the compressed SMPMCS and RELFILEs from the uploaded HAMA100.pax.Z file into data sets for use by the SMP/E RECEIVE job. The JCL is repeated here for your convenience.

    //EXTRACT  JOB <job information>
    //*
    //*   - Provide valid job card information
    //*   - Change:
    //*       @PREFIX@
    //*       ----+----1----+----2----+
    //*                  - To your desired data set name prefix
    //*                  - Maximum length is 25 characters
    //*                  - This value is used for the names of the
    //*                    data sets extracted from the download-package
    //*       @zfs_path@
    //*       ----+----1----+----2----+----3----+----4----+----5
    //*                  - To the absolute z/OS UNIX path for the
    //*                    download package (starting with /)
    //*                  - Maximum length is 50 characters
    //*                  - Do not include a trailing /
    //*
    //UNPAX    EXEC PGM=IKJEFT01,REGION=0M,COND=(0,LT)
    //SYSEXEC  DD DISP=SHR,DSN=SYS1.SBPXEXEC
    //SYSTSPRT DD SYSOUT=*
    //SYSTSIN  DD *
      oshell cd @zfs_path@/ ; +
        pax -rvf HAMA100.pax.Z
    //*
    //GIMUNZIP EXEC PGM=GIMUNZIP,REGION=0M,COND=(0,LT)
    //*STEPLIB  DD DISP=SHR,DSN=SYS1.MIGLIB
    //SYSUT3   DD UNIT=SYSALLDA,SPACE=(CYL,(50,10))
    //SYSUT4   DD UNIT=SYSALLDA,SPACE=(CYL,(25,5))
    //SMPOUT   DD SYSOUT=*
    //SYSPRINT DD SYSOUT=*
    //SMPDIR   DD PATHDISP=KEEP,
    // PATH='@zfs_path@/'
    //SYSIN    DD *
    
    <GIMUNZIP>
    <ARCHDEF archid="IBM.HAMA100.SMPMCS"
             newname="@PREFIX@.IBM.HAMA100.SMPMCS"/>
    <ARCHDEF archid="IBM.HAMA100.F1"
             newname="@PREFIX@.IBM.HAMA100.F1"/>
    <ARCHDEF archid="IBM.HAMA100.F2"
             newname="@PREFIX@.IBM.HAMA100.F2"/>
    <ARCHDEF archid="IBM.HAMA100.F3"
             newname="@PREFIX@.IBM.HAMA100.F3"/>
    </GIMUNZIP>
    //*
    

    Sample Jobs

    The following sample installation jobs are provided as part of the product to help you install RSE API:

    Table 15. Sample Installation Jobs
    Job Name Job Type Description SMPTLIB Data Set
    HUH1SMPE SMP/E Sample job to create an SMP/E environment (optional) IBM.HAMA100.F1
    HUH2RCVE RECEIVE Sample SMP/E RECEIVE job IBM.HAMA100.F1
    HUH3ALOC ALLOCATE Sample job to allocate target and distribution libraries IBM.HAMA100.F1
    HUH4ZFS ALLOMZFS Sample job to allocate, create mountpoint, and mount zFS data sets IBM.HAMA100.F1
    HUH5MKD MKDIR Sample job to invoke the supplied HUHMKDIR EXEC to allocate file system paths IBM.HAMA100.F1
    HUH6DDEF DDDEF Sample job to define SMP/E DDDEFs IBM.HAMA100.F1
    HUH7APLY APPLY Sample SMP/E APPLY job IBM.HAMA100.F1
    HUH8ACPT ACCEPT Sample SMP/E ACCEPT job IBM.HAMA100.F1
    Note: When RSE API is downloaded from the web, the SMPTLIB data set name will be prefixed by your chosen high level qualifier, as documented in section "Extract and expand the compressed SMPMCS and RELFILEs".

    The rest of this section only applies when RSE API is ordered via Shopz. It does not apply when you downloaded it from the web.
    Select this link to go to the next section: "Create SMP/E environment (optional)"

    You can access the sample installation jobs by performing an SMP/E RECEIVE (refer to "Perform SMP/E RECEIVE") then copy the jobs from the SMPTLIB data set to a work data set for editing and submission. See Table 15 to find the appropriate data set.

    You can also copy the sample installation jobs from the tape or product files by submitting the following job. Before you submit the job, add a job card and change the lowercase parameters to uppercase values to meet the requirements of your site.

    //STEP1    EXEC PGM=IEBCOPY
    //SYSPRINT DD SYSOUT=*
    //IN       DD DISP=SHR,UNIT=SYSALLDA,
    //*           VOL=SER=filevol,
    //            DSN=IBM.HAMA100.F1
    //OUT      DD DISP=(NEW,CATLG,DELETE),UNIT=SYSALLDA,
    //            SPACE=(TRK,(5,5,5)),
    //*           VOL=SER=dasdvol,
    //            DSNAME=jcl-library-name
    //SYSUT3   DD UNIT=SYSALLDA,SPACE=(CYL,(1,1))
    //SYSIN    DD *
      COPY INDD=IN,OUTDD=OUT
      SELECT MEMBER=(HUHMKDIR,HUHMOUNT,HUH1SMPE,HUH2RCVE,HUH3ALOC)
      SELECT MEMBER=(HUH4ZFS,HUH5MKD,HUH6DDEF,HUH7APLY,HUH8ACPT)
    //*
    
    See the following information to update the statements in the previous sample:
    IN:
    filevol is the volume serial of the DASD device where the downloaded files reside.
    OUT:
    jcl-library-name is the name of the output data set where the sample jobs are stored.
    dasdvol is the volume serial of the DASD device where the output data set resides. Uncomment the statment if a volume serial must be provided.

    Create SMP/E environment (optional)

    If you are using an existing CSI, do not run the sample job HUH1SMPE.

    If you choose to create a new SMP/E environment for this install, a sample job is provided or you may choose to use your own JCL. If you choose to use the sample job provided, edit and submit HUH1SMPE. Consult the instructions in the sample job for more information.

    Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

    Perform SMP/E RECEIVE

    If you have obtained RSE API as part of a CBPDO, use the RCVPDO job in the CBPDO RIMLIB data set to receive the RSE API FMIDs, service, and HOLDDATA that are included on the CBPDO package. For more information, see the documentation that is included in the CBPDO.

    You can also choose to edit and submit sample job HUH2RCVE to perform the SMP/E RECEIVE for RSE API. Consult the instructions in the sample job for more information.

    Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

    Allocate SMP/E Target and Distribution Libraries

    Edit and submit sample job HUH3ALOC to allocate the SMP/E target and distribution libraries for RSE API. Consult the instructions in the sample job for more information.

    Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

    Allocate, create and mount ZFS Files (Optional)

    This job allocates, creates a mountpoint, and mounts zFS data sets.

    If you plan to install RSE API into a new z/OS UNIX file system, you can edit and submit the optional HUH4ZFS job to perform the following tasks:

    Consult the instructions in the sample job for more information.

    The recommended z/OS UNIX file system type is zFS. The recommended mountpoint is /usr/lpp/IBM/rseapi.

    Before running the sample job to create the z/OS UNIX file system, you must ensure that OMVS is active on the driving system. zFS must be active on the driving system if you are installing RSE API into a file system that is zFS.

    If you create a new file system for this product, consider updating the BPXPRMxx PARMLIB member to mount the new file system at IPL time. This action can be helpful if an IPL occurs before the installation is completed.

    MOUNT FILESYSTEM('#dsn')
     MOUNTPOINT('/usr/lpp/IBM/rseapi')
     MODE(RDWR)        /* can be MODE(READ) */
     TYPE(ZFS) PARM('AGGRGROW') /* zFS, with extents */
    

    See the following information to update the statements in the previous sample:

    #dsn is the name of the data set holding the z/OS UNIX file system.
    /usr/lpp/IBM/rseapi is the name of the mountpoint where the z/OS UNIX file system will be mounted.

    Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

    Allocate File System Paths

    The target system HFS or zFS data set must be mounted on the driving system when running the sample HUH5MKD job since the job will create paths in the HFS or zFS.

    Before running the sample job to create the paths in the file system, you must ensure that OMVS is active on the driving system and that the target system's HFS or zFS file system is mounted to the driving system. zFS must be active on the driving system if you are installing RSE API into a file system that is zFS.

    If you plan to install RSE API into a new HFS or zFS file system, you must create the mountpoint and mount the new file system to the driving system for RSE API.

    The recommended mountpoint is /usr/lpp/IBM/rseapi.

    Edit and submit sample job HUH5MKD to allocate the HFS or zFS paths for RSE API. Consult the instructions in the sample job for more information.

    If you create a new file system for this product, consider updating the BPXPRMxx PARMLIB member to mount the new file system at IPL time. This action can be helpful if an IPL occurs before the installation is completed.

    Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

    Create DDDEF Entries

    Edit and submit sample job HUH6DDEF to create DDDEF entries for the SMP/E target and distribution libraries for RSE API. Consult the instructions in the sample job for more information.

    Expected Return Codes and Messages: You will receive a return code of 0 if this job runs correctly.

    Perform SMP/E APPLY

    1. Ensure that you have the latest HOLDDATA; then edit and submit sample job HUH7APLY to perform an SMP/E APPLY CHECK for RSE API. Consult the instructions in the sample job for more information.

      The latest HOLDDATA is available through several different portals, including http://service.software.ibm.com/holdata/390holddata.html. The latest HOLDDATA may identify HIPER and FIXCAT APARs for the FMIDs you will be installing. An APPLY CHECK will help you determine if any HIPER or FIXCAT APARs are applicable to the FMIDs you are installing. If there are any applicable HIPER or FIXCAT APARs, the APPLY CHECK will also identify fixing PTFs that will resolve the APARs, if a fixing PTF is available.

      You should install the FMIDs regardless of the status of unresolved HIPER or FIXCAT APARs. However, do not deploy the software until the unresolved HIPER and FIXCAT APARs have been analyzed to determine their applicability. That is, before deploying the software either ensure fixing PTFs are applied to resolve all HIPER or FIXCAT APARs, or ensure the problems reported by all HIPER or FIXCAT APARs are not applicable to your environment.

      To receive the full benefit of the SMP/E Causer SYSMOD Summary Report, do not bypass the PRE, ID, REQ, and IFREQ on the APPLY CHECK. The SMP/E root cause analysis identifies the cause only of errors and not of warnings (SMP/E treats bypassed PRE, ID, REQ, and IFREQ conditions as warnings, instead of errors).

      Here are sample APPLY commands:

      1. To ensure that all recommended and critical service is installed with the FMIDs, receive the latest HOLDDATA and use the APPLY CHECK command as follows
        APPLY S(fmid,fmid,...) CHECK
        FORFMID(fmid,fmid,...)
        SOURCEID(RSU*)
        FIXCAT(IBM.PRODUCTINSTALL-REQUIREDSERVICE)
        GROUPEXTEND .
        

        Some HIPER APARs might not have fixing PTFs available yet. You should analyze the symptom flags for the unresolved HIPER APARs to determine if the reported problem is applicable to your environment and if you should bypass the specific ERROR HOLDs in order to continue the installation of the FMIDs.

        This method requires more initial research, but can provide resolution for all HIPERs that have fixing PTFs available and are not in a PE chain. Unresolved PEs or HIPERs might still exist and require the use of BYPASS.

      2. To install the FMIDs without regard for unresolved HIPER APARs, you can add the BYPASS(HOLDCLASS(HIPER)) operand to the APPLY CHECK command. This will allow you to install FMIDs even though one or more unresolved HIPER APARs exist. After the FMIDs are installed, use the SMP/E REPORT ERRSYSMODS command to identify unresolved HIPER APARs and any fixing PTFs.
        APPLY S(fmid,fmid,...) CHECK
        FORFMID(fmid,fmid,...)
        SOURCEID(RSU*)
        FIXCAT(IBM.PRODUCTINSTALL-REQUIREDSERVICE)
        GROUPEXTEND
        BYPASS(HOLDCLASS(HIPER)) .
         ..any other parameters documented in the program directory
        

        This method is quicker, but requires subsequent review of the Exception SYSMOD report produced by the REPORT ERRSYSMODS command to investigate any unresolved HIPERs. If you have received the latest HOLDDATA, you can also choose to use the REPORT MISSINGFIX command and specify Fix Category IBM.PRODUCTINSTALL-REQUIREDSERVICE to investigate missing recommended service.

        If you bypass HOLDs during the installation of the FMIDs because fixing PTFs are not yet available, you can be notified when the fixing PTFs are available by using the APAR Status Tracking (AST) function of ServiceLink or the APAR Tracking function of ResourceLink.

    2. After you take actions that are indicated by the APPLY CHECK, remove the CHECK operand and run the job again to perform the APPLY.

      Note: The GROUPEXTEND operand indicates that SMP/E applies all requisite SYSMODs. The requisite SYSMODS might be applicable to other functions.

      Expected Return Codes and Messages from APPLY CHECK: You will receive a return code of 0 if this job runs correctly.

      Expected Return Codes and Messages from APPLY: You will receive a return code of 0 if this job runs correctly.

    Perform SMP/E ACCEPT

    Edit and submit sample job HUH8ACPT to perform an SMP/E ACCEPT CHECK for RSE API. Consult the instructions in the sample job for more information.

    To receive the full benefit of the SMP/E Causer SYSMOD Summary Report, do not bypass the PRE, ID, REQ, and IFREQ on the ACCEPT CHECK. The SMP/E root cause analysis identifies the cause of errors but not warnings (SMP/E treats bypassed PRE, ID, REQ, and IFREQ conditions as warnings rather than errors).

    Before you use SMP/E to load new distribution libraries, it is recommended that you set the ACCJCLIN indicator in the distribution zone. In this way, you can save the entries that are produced from JCLIN in the distribution zone whenever a SYSMOD that contains inline JCLIN is accepted. For more information about the ACCJCLIN indicator, see the description of inline JCLIN in the SMP/E Commands book for details.

    After you take actions that are indicated by the ACCEPT CHECK, remove the CHECK operand and run the job again to perform the ACCEPT.

    Note: The GROUPEXTEND operand indicates that SMP/E accepts all requisite SYSMODs. The requisite SYSMODS might be applicable to other functions.

    Expected Return Codes and Messages from ACCEPT CHECK: You will receive a return code of 0 if this job runs correctly.

    If PTFs that contain replacement modules are accepted, SMP/E ACCEPT processing will link-edit or bind the modules into the distribution libraries. During this processing, the Linkage Editor or Binder might issue messages that indicate unresolved external references, which will result in a return code of 4 during the ACCEPT phase. You can ignore these messages, because the distribution libraries are not executable and the unresolved external references do not affect the executable system libraries.

    Expected Return Codes and Messages from ACCEPT: You will receive a return code of 0 if this job runs correctly.

    Run REPORT CROSSZONE

    The SMP/E REPORT CROSSZONE command identifies requisites for products that are installed in separate zones. This command also creates APPLY and ACCEPT commands in the SMPPUNCH data set. You can use the APPLY and ACCEPT commands to install those cross-zone requisites that the SMP/E REPORT CROSSZONE command identifies.

    After you install RSE API, it is recommended that you run REPORT CROSSZONE against the new or updated target and distribution zones. REPORT CROSSZONE requires a global zone with ZONEINDEX entries that describe all the target and distribution libraries to be reported on.

    For more information about REPORT CROSSZONE, see the SMP/E manuals.

    Cleaning Up Obsolete Data Sets, Paths, and DDDEFs

    The web download data sets listed in Table 12 (section "DASD Storage Requirements") are temporary data sets. You can delete these data sets after you complete the SMP/E install.


    Activating RSE API

    File System Execution

    If you mount the file system in which you have installed RSE API in read-only mode during execution, then you do not have to take further actions to activate RSE API.


    Product Customization

    The publication IBM Remote System Explorer API (RSE API) Host Configuration Guide (SC27-9905-00) contains the necessary information to customize and use RSE API.


    Notices

    This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

    APAR numbers are provided in this document to assist in locating PTFs that may be required. Ongoing problem reporting may result in additional APARs being created. Therefore, the APAR lists in this document may not be complete. To obtain current service recommendations and to identify current product service requirements, always contact the IBM Customer Support Center or use S/390 SoftwareXcel to obtain the current "PSP Bucket".

    IBM may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to the

    IBM Director of Licensing
    IBM Corporation
    North Castle Drive
    Armonk, New York 10504-1785
    USA

    For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

    Intellectual Property Licensing
    Legal and Intellectual Property Law
    IBM Japan, Ltd.
    19-21, Nihonbashi-Hakozakicho, Chuo-ku
    Tokyo 103-8510, Japan

    Trademarks

    IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml.


    Reader's Comments

    Program Directory for IBM Remote System Explorer API (RSE API), June 2020

    We appreciate your input on this publication. Feel free to comment on the clarity, accuracy, and completeness of the information or give us any other feedback that you might have.

    Send your comments by emailing us at ibmkc@us.ibm.com, and include the following information:

    1. Your name and address

    2. Your email address

    3. Your telephone or fax number

    4. The publication title and order number

    5. The topic and page number related to your comment

    6. The text of your comment

    When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it believes appropriate without incurring any obligation to you.

    IBM or any other organizations will only use the personal information that you supply to contact you about the issues that you submit.

    Thank you for your participation.