IBM Z® Open Editor
Docs
News and Blogs
IBM Downloads
VS Code Marketplace
GitHub
Docs
News and Blogs
IBM Downloads
VS Code Marketplace
GitHub
  • Overview

    • Introduction
    • Updates and user feedback
  • Getting Started

    • Getting started with IBM Z Open Editor
    • Setting up integrations to interact with z/OS
    • Getting started with Zowe 3.0
  • Configuration

    • Setting preferences
    • Configuring your applications with ZAPP files
    • Setting property groups
    • Setting compiler options
    • Setting file associations
    • Setting language-specific tab stops and rulers
    • Enabling and disabling problems in IBM Z Open Editor
    • Enabling and disabling unreachable COBOL code warnings
    • Customizing the Outline view
    • Setting language-specific maximum line length
    • EBCDIC code pages and mappings files
    • Experimental: Formatting COBOL source code
  • Tutorials

    • Tutorial overview
    • Exploring the user interface
    • Exploring the sample files
    • COBOL editing tutorial
    • COBOL, PL/I Preprocessor tutorial
    • HLASM editing tutorial
    • REXX editing tutorial
    • Managing z/OS resources with IBM RSE API Plug-in for Zowe CLI tutorial
    • Submitting JCL to compile, link, and run jobs tutorial
  • Editing program files

    • Language References
    • Making COBOL and PL/I code changes
    • Making High Level Assembler code changes
    • Making REXX code changes
    • Making JCL code changes
    • Using and managing code snippets
    • Using the integrated Git
    • Searching for COBOL, PL/I, HLASM, and REXX components
  • Interacting with z/OS using Zowe

    • Interacting with z/OS
    • Creating a configuration profile in Zowe Explorer v3.0.0
    • Migrating your old Zowe yaml profiles for Zowe v3.0
    • Supported methods of authentication for z/OS using Zowe
    • Sharing team configuration files
    • Connecting to z/OS with Zowe Explorer walk through
    • Using the Zowe Explorer views
    • Using Zowe profiles in Z Open Editor
    • Connecting to z/OS using Zowe CLI walk through
    • Using command line to interact with z/OS
    • Interact with RSE Common Properties
  • Advanced Capabilities

    • Overview
    • Activating advanced capabilities
    • Launching a 3270 emulator from Zowe Explorer
    • z/OS Resources Table
    • Data Elements View
    • Program Control Flow Browser
    • Data Flow Browser
    • Preprocessor support
    • Custom Macros for HLASM
    • Language Detection
    • Linting with IBM ZCodeScan
    • User build with IBM Dependency Based Build (DBB)
    • Agent Mode
    • Line Hex Editor
  • Cloud-based Editing

    • Overview to using Cloud and Browser-based platforms
    • Try Z Open Editor in the Red Hat Developer Sandbox
    • Configuring Red Hat OpenShift Dev Spaces
    • Managing Developer Workspaces
    • Managing secrets
    • Create and use custom images
    • Migrating from IBM Wazi for Dev Spaces
    • Using Z Open Editor on GitHub Codespaces
    • Using Z® Open Editor with Dev Containers
  • Troubleshooting

    • Known issues and limitations
    • Troubleshooting using log files
    • Troubleshooting for User Build
    • Uninstalling CLI plugins and VS Code extensions
  • Reference

    • IBM RSE API Plug-in for Zowe CLI commands
    • IBM RSE API Plug-in for Zowe CLI as nodejs SDK package
    • IBM RSE API Plug-in for Zowe CLI as nodejs SDK reference
    • Example Zowe configuation setups
    • IBM Z Open Editor MCP Tools
    • Accessibility and Keyboard Shortcuts
    • settings.json properties
    • Message ID Reference
    • Other Visual Studio Code extensions
  • Legal information

    • Notices
    • Trademarks
    • Privacy policy considerations

Example Zowe configuation setups

  • Flat Zowe team configuration
  • Nested Zowe team configuration
  • RSE profiles connection type setup
  • z/OSMF profiles connection type setup

Flat Zowe team configuration

{
  "$schema": "./zowe.schema.json",
  "profiles": {
    "zosmf": {
      "type": "zosmf",
      "properties": {
        "port": 443
      },
      "secure": []
    },
    "tso": {
      "type": "tso",
      "properties": {
        "account": "",
        "codePage": "1047",
        "logonProcedure": "IZUFPROC"
      },
      "secure": []
    },
    "ssh": {
      "type": "ssh",
      "properties": {
        "port": 22
      },
      "secure": []
    },
    "rse": {
      "type": "rse",
      "properties": {
        "port": 6800,
        "basePath": "rseapi",
        "protocol": "https"
      },
      "secure": []
    },
    # common properties can be defined in the base profile insread of defining them in every profile
    "base": {
      "type": "base",
      "properties": {
        "host": "myzos.ibm.com",
        # reject connection if self-signed certificate is used
        "rejectUnauthorized": true
      },
      # these secure fields will determine the values written to and stored in the OS credential manager.
      "secure": ["user", "password"]
    }
  },
  "defaults": {
    "zosmf": "zosmf",
    "tso": "tso",
    "ssh": "ssh",
    "rse": "rse",
    "base": "base"
  },
  # setting determines if information is written to the file or credential manager
  "autoStore": true
}

Nested Zowe team configuration

Nested team configurations are great option for users that have multiple LPAR connections.

{
  "$schema": "./zowe.schema.json",
  "profiles": {
    "lpar1": {
      "properties": {
        "host": "lpar1.com",
        "rejectUnauthorized": false
      },
      "secure": ["user", "password"],       # Example of shared credentials across LPAR profiles
      "profiles": {
        "zosmf": {
          "type": "zosmf",
          "properties": {
            "port": 443
          }
        },
        "rse": {
          "type": "rse",
          "properties": {
            "port": 6800,
            "basePath": "rseapi",
            "protocol": "https"
          }
        },
        "ssh": {
          "type": "ssh",
          "properties": {
            "port": 22
          }
        }
      }
    },
    "lpar2": {
      "properties": {
        "host": "lpar2.com",
        "rejectUnauthorized": false
      },
      "profiles": {
        "zosmf": {
          "type": "zosmf",
          "properties": {
            "port": 443
          },
          "secure": ["user", "password"]    # Example of credentials that are profile specific
        },
        "ssh": {
          "type": "ssh",
          "properties": {
            "port": 22
          },
          "secure": ["user", "password"]
        }
      }
    },
    "lpar3": {
      "properties": {
        "host": "lpar3.com",
        "rejectUnauthorized": false
      },
      "secure": ["user", "password"],
      "profiles": {
        "zosmf": {
          "type": "zosmf",
          "properties": {
            "port": 3128,
            "protocol": "http"
          }
        }
      }
    }
  },
  "defaults": {
    "zosmf": "lpar1.zosmf",
    "ssh": "lpar1.ssh",
    "rse": "lpar1.rse"
  },
  "autoStore": true
}

RSE profiles connection type setup

RSE profile with Base profile using direct connection basic authentication

{
  "$schema": "./zowe.schema.json",
  "profiles": {
    "rse": {
      "type": "rse",
      "properties": {
        "port": 6803,
        "basePath": "rseapi",               #RSE Rest API Port
        "protocol": "https"                 #RSE Rest API base path
      },
      "secure": []
    },
    "base": {
      "type": "base",
      "properties": {
        "host": "examplehost.com",
        "rejectUnauthorized": true
      },
      "secure": ["user", "password"]
    }
  },
  "defaults": {
    "rse": "rse",
    "base": "base"
  },
  "autoStore": true
}

RSE profile using direct connection token authentication

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "rse": {
          "type": "rse",
          "properties": {
            "host": "examplehost.com",
            "port": 6800,                   #RSE Rest API Port
            "basePath": "rseapi",           #RSE Rest API base path
            "rejectUnauthorized": true
          },
          "secure": ["tokenValue"]
      },
    },
    "defaults": {
        "rse": "rse"
    },
    "autoStore": true
}

RSE profiles using API Mediation Layer for authentication

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "rse": {
            "type": "rse",
            "properties": {
                "port": 7554,                 #API ML Port
                "basePath": "ibmrse"          #API ML base path to registered RSE API
            }
        },
        "base": {
            "type": "base",
            "properties": {
                "host": "host.com",
                "rejectUnauthorized": true
            },
            "secure": [
              "tokenValue"
            ]
        }
    },
    "defaults": {
        "rse": "rse",
        "base": "base"
    },
    "autoStore": true
}

z/OSMF profiles connection type setup

z/OSMF profiles using direct connect certificate authentication

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "zosmf": {
          "type": "zosmf",
          "properties": {
          "port": 443,
          "rejectUnauthorized": false,
          "protocol": "https",
          "certFile": "/Users/username/certificates/cert-file.crt",     # Certificate file path
          "certKeyFile": "/Users/username/certificates/key-file.key"    # Certificate key path
        },
        "secure": []
      },
    },
    "defaults": {
        "zosmf": "zosmf"
    },
    "autoStore": true
}

z/OSMF profiles using API Mediation Layer for authentication

{
    "$schema": "./zowe.schema.json",
    "profiles": {
        "zosmf": {
            "type": "zosmf",
            "properties": {
                "port": 7554,                          #API ML Port
                "basePath": "ibmzosmf/api/v1"          #API ML base path to registered RSE API
            }
        },
        "base": {
            "type": "base",
            "properties": {
                "host": "host.com",
                "rejectUnauthorized": true
            },
            "secure": [
              "tokenValue"
            ]
        }
    },
    "defaults": {
        "zosmf": "zosmf",
        "base": "base"
    },
    "autoStore": true
}
Last Updated: 6/19/25, 9:16 AM
Contributors: Billie Simmons, phaumer, Esther M
Prev
IBM RSE API Plug-in for Zowe CLI as nodejs SDK reference
Next
IBM Z Open Editor MCP Tools