System requirements

Last Updated: 2/6/2019, 9:49:17 PM

System requirements

Before installing Zowe, ensure that your environment meets the prerequisites.


z/OS host requirements (for all components):

  • IBM z/OS Management Facility (z/OSMF) Version 2.2 or Version 2.3.

    z/OSMF is a prerequisite for the Zowe microservice. z/OSMF must be installed and running before you use Zowe. For details, see z/OSMF configuration.

  • z/OS® Version 2.2 or later.

  • Node.js Version or later on the z/OS host where you install the Zowe Application Server.

    1. To install Node.js on z/OS, follow the procedures at


    • To install Node.js on z/OS, ensure that you meet the following requirements in the procedure. Other requirements, including installing Python, Make 4.1, or Perl, are not needed.

      z/OS V2R2 with PTF UI46658 or z/OS V2R3, z/OS UNIX System Services enabled, and Integrated Cryptographic Service Facility (ICSF) configured and started.

    • The following requirements for installing Node.js are NOT needed, so you can skip those configurations.
      • Python, Make 4.1, or Perl
      • C/C++ compiler

    After you install Node.js, set the NODE_HOME environment variable to the directory where Node.js is installed. For example, NODE_HOME=/proj/mvd/node/installs/node-v6.14.4-os390-s390x.

  • npm 5.4 or later

    To update npm, issue the following command:

    npm install -g npm
  • IBM SDK for Java Technology Edition V8 or later

Disk and browser requirements (for Zowe desktop):

  • 833 MB of HFS file space.

  • Supported browsers:

    • Google Chrome V54 or later
    • Mozilla Firefox V44 or later
    • Safari V11 or later
    • Microsoft Edge (Windows 10)

Client requirements (for Zowe CLI):

Any platform where Node.js 8.0 or 10 is available, including Windows, Linux, and Mac operating systems. For details, see System requirements for Zowe CLI.

z/OSMF configuration

The following information contains procedures and tips for meeting z/OSMF requirements. For complete information, go to IBM Knowledge Center and read the following documents.

z/OS requirements

Ensure that the z/OS system meets the following requirements:

Requirements Description Resources in IBM Knowledge Center
Integrated Cryptographic Service Facility (ICSF) On z/OS, Node requires ICSF to be installed, configured and started. N/A
AXR (System REXX) z/OS uses AXR (System REXX) component to perform Incident Log tasks. The component enables REXX executable files to run outside of conventional TSO and batch environments. System REXX
Common Event Adapter (CEA) server The CEA server, which is a co-requisite of the Common Information Model (CIM) server, enables the ability for z/OSMF to deliver z/OS events to C-language clients. Customizing for CEA
Common Information Model (CIM) server z/OSMF uses the CIM server to perform capacity-provisioning and workload-management tasks. Start the CIM server before you start z/OSMF (the IZU* started tasks). Reviewing your CIM server setup
CONSOLE and CONSPROF commands The CONSOLE and CONSPROF commands must exist in the authorized command table. Customizing the CONSOLE and CONSPROF commands
IBM z/OS Provisioning Toolkit The IBM® z/OS® Provisioning Toolkit is a command line utility that provides the ability to provision z/OS development environments. If you want to provision CICS or Db2 environments with the Zowe CLI, this toolkit is required. What is IBM Cloud Provisioning and Management for z/OS?
Java level IBM® 64-bit SDK for z/OS®, Java Technology Edition V8 or later is required. Software prerequisites for z/OSMF
TSO region size To prevent exceeds maximum region size errors, verify that the TSO maximum region size is a minimum of 65536 KB for the z/OS system. N/A
User IDs User IDs require a TSO segment (access) and an OMVS segment. During workflow processing and REST API requests, z/OSMF might start one or more TSO address spaces under the following job names: userid; substr(userid, 1, 6) CN (Console). N/A

Configuring z/OSMF

Follow these steps:

  1. From the console, issue the following command to verify the version of z/OS:


    Part of the output contains the release, for example,

    RELEASE z/OS 02.02.00.
  2. Configure z/OSMF.

    z/OSMF is a base element of z/OS V2.2 and V2.3, so it is already installed. But it might not be configured and running on every z/OS V2.2 and V2.3 system.

    In short, to configure an instance of z/OSMF, run the IBM-supplied jobs IZUSEC and IZUMKFS, and then start the z/OSMF server. The z/OSMF configuration process occurs in three stages, and in the following order:

    • Stage 1 - Security setup
    • Stage 2 - Configuration
    • Stage 3 - Server initialization

    This stage sequence is critical to a successful configuration. For complete information about how to configure z/OSMF, see Configuring z/OSMF for the first time if you use z/OS V2.2 or Setting up z/OSMF for the first time if V2.3.

Note: In z/OS V2.3, the base element z/OSMF is started by default at system initial program load (IPL). Therefore, z/OSMF is available for use as soon as you set up the system. If you prefer not to start z/OSMF automatically, disable the autostart function by checking for START commands for the z/OSMF started procedures in the COMMNDxx parmlib member.

The z/OS Operator Consoles task is new in Version 2.3. Applications that depend on access to the operator console such as Zowe CLI's RestConsoles API require Version 2.3.

  1. Verify that the z/OSMF server and angel processes are running. From the command line, issue the following command:

    /D A,IZU*

    If jobs IZUANG1 and IZUSVR1 are not active, issue the following command to start the angel process:

    /S IZUANG1

    After you see the message ""CWWKB0056I INITIALIZATION COMPLETE FOR ANGEL"", issue the following command to start the server:

    /S IZUSVR1

    The server might take a few minutes to initialize. The z/OSMF server is available when the message ""CWWKF0011I: The server zosmfServer is ready to run a smarter planet."" is displayed.

  2. Issue the following command to find the startup messages in the SDSF log of the z/OSMF server:

    f IZUG349I

    You could see a message similar to the following message, which indicates the port number:

    IZUG349I: The z/OSMF STANDALONE Server home page can be accessed at after the z/OSMF server is started on your system.

    In this example, the port number is 443. You will need this port number later.

    Point your browser at the nominated z/OSMF STANDALONE Server home page and you should see its Welcome Page where you can log in.

Note: If your implementation uses an external security manager other than RACF (for example, CA Technologies, a Broadcom Company, Top Secret or CA Technologies ACF2), you provide equivalent commands for your environment. For more information, see the following product documentation:

z/OSMF REST services for the Zowe CLI

The Zowe CLI uses z/OSMF Representational State Transfer (REST) APIs to work with system resources and extract system data. Ensure that the following REST services are configured and available.

z/OSMF REST services Requirements Resources in IBM knowledge Center
Cloud provisioning services Cloud provisioning services are required for the Zowe CLI CICS and Db2 command groups. Endpoints begin with /zosmf/provisioning/ Cloud provisioning services
TSO/E address space services TSO/E address space services are required to issue TSO commands in the Zowe CLI. Endpoints begin with /zosmf/tsoApp TSO/E address space services
z/OS console services z/OS console services are required to issue console commands in the Zowe CLI. Endpoints begin with /zosmf/restconsoles/ z/OS console services
z/OS data set and file REST interface z/OS data set and file REST interface is required to work with mainframe data sets and UNIX System Services files in the Zowe CLI. Endpoints begin with /zosmf/restfiles/ z/OS data set and file REST interface
z/OS jobs REST interface z/OS jobs REST interface is required to use the zos-jobs command group in the Zowe CLI. Endpoints begin with /zosmf/restjobs/ z/OS jobs REST interface
z/OSMF workflow services z/OSMF workflow services is required to create and manage z/OSMF workflows on a z/OS system. Endpoints begin with /zosmf/workflow/ z/OSMF workflow services

Zowe uses symbolic links to the z/OSMF,, and ltpa.keys files. Zowe reuses SAF, SSL, and LTPA configurations; therefore, they must be valid and complete.

For more information, see Using the z/OSMF REST services in IBM z/OSMF documentation.

To verify that z/OSMF REST services are configured correctly in your environment, enter the REST endpoint into your browser. For example:


  • Browsing z/OSMF endpoints requests your user ID and password for defaultRealm; these are your TSO user credentials.
  • The browser returns the status code 200 and a list of all jobs on the z/OS system. The list is in raw JSON format.

Planning for installation of API Mediation Layer, Zowe Application Framework, and Zowe APF Angel

The following information is required during the installation process of API Mediation Layer and Zowe Application Framework. Make the decisions before the installtion.

  • The HFS directory where you install Zowe, for example, /var/zowe.

  • The HFS directory that contains a 64-bit Java™ 8 JRE.

  • The z/OSMF installation directory, for example, /usr/lpp/zosmf/lib.

  • The API Mediation Layer HTTP and HTTPS port numbers. You will be asked for 3 unique port numbers.

  • The user ID that runs the Zowe started task.

    Tip: Use the same user ID that runs the z/OSMF IZUSVR1 task, or a user ID with equivalent authorizations.

  • The mainframe account under which the ZSS server runs must have UPDATE permission on the BPX.DAEMON and BPX.SERVER facility class profiles.

System requirements for Zowe CLI

Before you install Zowe CLI, make sure your system meets the following requirements:

Prerequisite software

The following prerequisites for Windows, Mac, and Linux are required if you are installing Zowe CLI from a local package. If you are installing Zowe CLI from Bintray registry, you only require Node.js and npm.

Note: As a best practice, we recommend that you update Node.js regularly to the latest Long Term Support (LTS) version.

Ensure that the following prerequisite software is installed on your computer:

  • Node.js V8.0 or later

    Tip: You might need to restart the command prompt after installing Node.js. Issue the command node --version to verify that Node.js is installed.

  • Node Package Manager V5.0 or later

    npm is included with the Node.js installation. Issue the command npm --version to verify that npm is installed.

Supported platforms

Zowe CLI is supported on any platform where Node.js 8.0 or 10 is available, including Windows, Linux, and Mac operating systems. For information about known issues and workarounds, see Troubleshooting installing Zowe CLI.

Zowe CLI is designed and tested to integrate with z/OSMF running on IBM z/OS Version 2.2 or later. Before you can use Zowe CLI to interact with the mainframe, system programmers must install and configure IBM z/OSMF in your environment.


  • Oracle Linux 6 is not supported.

Free disk space

Zowe CLI requires approximately 100 MB of free disk space. The actual quantity of free disk space consumed might vary depending on the operating system where you install Zowe CLI.