Installation Instructions for z/VM Electronically or DVD Delivered Licensed Products

Last Updated July 28, 2022

Printable version   Printable version

After you have downloaded the electronically delivered VM product materials provided with your order to your workstation, or using the files provided on the DVD you need to upload those files to your z/VM host, de-compact them and then install them. The VM product materials will be referred to as product envelope(s) throughout the rest of this document.

The remainder of this document consists of the information and sample instructions for:
- Uploading product envelope(s) to your z/VM host from your workstation
- De-compacting the product envelope(s)
- Installing the product envelope(s) on your z/VM host

(1) Upload Product Envelope(s)

(a) Prepare for Upload

  1. The minidisk or SFS directory that you choose to place the product envelope(s) on will have to be able to be accessed from the product's installation user ID (refer to the product's Program Directory for information on the installation user ID).

  2. The order can be found on your workstation as follows:
    • If Electronic:
      • If using Download Director, it can be found in a directory called Download Director and in a folder named the IBM order number.
      • If using HTTPS, it will be in the directory you selected.

      You should rename the product envelope files on the workstation so that the file extension is bin. You may also want to rename the file name to identify the product. For example:

              V6317142.TERS0028   to   COBOL.BIN
    • If DVD:
      • The DVD files will have a file extension of trs

      You should rename the product envelope files to the workstation so that the file extension is bin.

    To identify that the contents of your order match the names of the downloaded files to the names listed under the heading 'Ref.No' on the Order Packing List, provided with your ShopzSeries order.

  3. You will need to have adequate space available on the z/VM host to hold the product envelope(s), both before and after de-compaction. To get an APPROXIMATE number of 3390 cyls needed to hold the compacted and de-compacted product envelope(s):
    • multiply the number of megabytes by 1024 to get number of kilobytes
    • divide the number of kilobytes by 4 to get the number of 4K blocks (Good rule of thumb is to always round up on all divides.)
    • divide the number of 4K blocks by 180 to get the number of 3390 cyls needed
    • There is no formula available to determine the space required to hold the de-compacted envelope file, but multiplying the number of cyls by 5 should get an approximate cyl value.
    For example: To hold a product envelope that is approximately 27MB on the workstation, in the tersed and de-compacted state, would require approximately 195 cyls on 3390 DASD.

(b) Upload Product Envelope(s)

Note: The GetShopz utility can be used to upload z/VM files directly to the host system. GetShopz currently supports z/VM product files and service files only, it can NOT be used to transfer z/VM Licensed Products.

To upload the compacted product envelope(s) directly to z/VM, the files should be uploaded as BINARY FIXED 1024 (this means that the uploaded file will end up being FIXED RECFM and have LRECL of 1024). You MUST make sure you use the appropriate transfer options, with whatever file transfer program you use, to ensure these file attributes are maintained.

For example, if you chose to use the Personal Communications Workstation Program to transfer then you need to set up a transfer type that ensures Fixed Recfm of 1024. To do this you would select Edit-> Preferences-> Transfer, from a PCOMM session, and then click on the VM tab. Then create a transfer type of binary-1024 with a Record Format of Fixed and Logical Record Length of 1024.

Sample Upload using TCP/IP FTP

The following sample instructions use FTP from a MS-DOS Window command prompt to transfer a product envelope from a workstation to a z/VM host minidisk (MDISK) or SFS directory. In order to use FTP, TCP/IP must be available on both the z/VM host and the workstation host.

It is NOT possible to FTP to a temporary MDISK on the VM host in this example. Also the MDISK you FTP to can not be linked in write mode on the host. If it is, then you need to detach it before the FTP server will be able to write to it.

Note: If an ESM (external security manager - e.g. IBM's RACF/VM) is enabled for the VM TCPIP FTP server then the ESM must be configured to allow the logon ID to access the required minidisk's, including the minidisk's owned by the logon ID. For information on how to correctly configure the FTP server and the ESM, refer to Chapter 9, "Configuring the FTP Server" and Appendix A "Using TCP/IP with an External Security Manager" in the z/VM TCP/IP Planning and Customization.

From an MS-DOS Window command prompt, type the
following commands (substitute values appropriate for your system,
when they differ from what is shown here):
  ftp {fully_qualifed_hostname | host ip_addr}
                                  Where "hostname" or "host ip_addr"
                                  is the VM node you want to FTP the
                                  product envelope(s) to.
  {type in VM userid that will receive the product envelope}
  {type in VM password}
        --- for sfs   ----
  cd {SFS_directory_name}         Where SFS_directory_name should be
                                  changed to your SFS directory name
                                  you intend to transfer to.
                                  For example: cd vmsys:userid.prodenv
        --- OR, for mdisk ----
  cd userid.mdisk_addr            Where userid.mdisk_addr should be
                                  the userid and minidisk address
                                  you intend to transfer to.  It can
                                  not be linked in write mode on the
                                  id you FTP to.  If it is then you
                                  need to detach it.
                                  If this mdisk requires a password,
                                  depending on the security manager
                                  in place on your system, you may
                                  be prompted to supply a password.
 lcd {drive}:\{folder}            Where "drive" is the letter, and,
                                  "folder" is name of folder, if
                                  using one, on the workstation where
                                  the product envelope exists.
                                  For example:
                                  lcd C:\DownloadDirector\2000281050_000070_PROD
 binary                           Set the transfer mode to BINARY
 quote site fixrec 1024           This command indicates to the VM host
                                  that files should be created with a
                                  Fixed record format, and with a
                                  record length (LRECL) of 1024.
 put {fn}.bin {fn}.bin            Where "fn".bin is the name of the
                                  product envelope file on the
                                  workstation, and "fn".bin is
                                  the file to be created on the VM
                                  For example:
                                    put cobol.bin cobol.bin
      NOTE:  Depending on the size of the file and connectivity, the
             put step can take several minutes.  Make sure that the FTP
             transfer completes without errors.
 quit                             End the FTP session, after successful
                                  completion of all file transfers.

(2) De-Compaction of Product Envelope(s)

Once the product envelope(s) exist on a z/VM minidisk or SFS directory they need to be de-compacted using the DETERSE MODULE. You need to log on to the user ID that has access to the minidisk or SFS directory that has the product envelope file on it.

(a) Locating the DETERSE MODULE

The DETERSE MODULE is shipped as part of the VMSES/E component of z/VM. By default, it resides on the 5E5 minidisk of the user ID MAINT. You have this disk linked and accessed, if it is not already. For example:


(b) Using the DETERSE MODULE

The command syntax for DETERSE is:

DETERSE ifn ift ifm ofn SERVLINK ofm (option

where option can be REPLACE. You need to use the REPLACE option if you are going to keep the original file name of the service envelope, otherwise no option is needed. In order for you to install the product envelope the file type must be SERVLINK. An example of using deterse against a product envelope is:


(c) Check the Product Envelope

If all steps have completed successfully, the product envelope should have a logical record length of 4005. Error messages from the VMFINS commands (that will be used in the step below) could indicate an incomplete transfer or transfer that did not retain the attributes of binary fixed 1024 during transfer.

(3) Installation of Product Envelope(s) on z/VM Host

The Program Directory for z/VM System Delivery Option (SDO) is required for the installation. The SDO PD is delivered with the Product Publications in your order or can be found at the url below (for the z/VM release you have ordered):

For installing the product envelope(s) you received you should begin with section 2.6 'Plan for Licensed Products Interdependences' in the SDO Program Directory. To see a quick flow of the sections you will be following, refer to section 2.1 'Checklist of z/VM SDO Installation Steps'.

Once into the section for your specific product you might be pointed to the product's program directory. If the product provides an online version of the program directory you should be able to find that under the 'Product publications' link on your ShopzSeries VM order download page. If not, then refer to your hardcopy version of the program directory that you should have received with your order.


  1. The minidisk or SFS directory that the product envelope resides on needs to be accessed as the 'C' disk.
  2. When you install the product envelope(s) you will need to use the ENV option on the VMFINS commands. After the ENV you supply the file name of the product envelope file. Remember that the file type of this file needs to be SERVLINK. For example: