Step-by-Step Configuration of the VS Code Debugger for Mainframe with IBM z/OS Debugger
Executive Summary: Step-by-Step Configuration of the VS Code Debugger for Mainframe with IBM z/OS Debugger
Bring modern visual debugging to VS Code. Learn how to configure launch.json, connect to the IBM z/OS Debugger headless service, and execute interactive source-level breakpoint debugging inside Visual Studio Code.
1 Problem Statement & Architecture Context: Step-by-Step Configuration of the VS Code Debugger for Mainframe with IBM z/OS Debugger
Developers who have migrated to VS Code for code editing are still forced to switch to terminal sessions or 3270 green-screens whenever they need to debug a COBOL program step-by-step.
2 Technical Root Cause & Architecture Mechanics
The IBM Z Open Debug extension enables the VS Code Debug Adapter Protocol (DAP) to communicate with the IBM z/OS Debugger on the mainframe over TCP/IP.
3 Implementation Guide & Modernization Strategy
# 1. Install IBM Z Open Debug Extension
In VS Code, install IBM.zopeneditor and IBM.z-open-debug.
# 2. Configure .vscode/launch.json
Add the debug launch configuration:
{
"version": "0.2.0",
"configurations": [
{
"type": "zopenedebug",
"request": "launch",
"name": "Debug Mainframe Batch COBOL",
"port": 8001,
"secure": false,
"trace": true
}
]
}
# 3. Launch Debug Session and Run Job
1. Press F5 in VS Code to start listening on port 8001.
2. Submit your batch JCL with //CEEOPTS DD pointing to your IP:
TEST(ALL,*,PROMPT,TCPIP&
3. When the job runs on z/OS, VS Code pauses execution, highlights the first line in yellow, and allows you to set visual breakpoints in the gutter!
Technical Specifications Matrix
| Attribute | Specification |
|---|---|
| Target Environment | IBM z/OS • DevOps & Automation |
| Key Technologies | VS Code, Debugging, IBM z/OS Debugger |
| Delivery SLA | Accelerated Sprint Delivery via StackMF Pods |
| Technical Reviewer | Anshu, Chief Technology Architect • StackMF Architecture Pod |
Production Readiness & Verification Checklist
- Ensure workstation IP is reachable from the z/OS network (VPN/corporate LAN).
- Store compiler side-files (`SYSDEBUG`) in accessible libraries.
- Clean up completed debug sessions to release mainframe TCB threads.
? Frequently Asked Questions
What is the root cause of Step-by-Step Configuration of the VS Code Debugger for Mainframe with IBM z/OS Debugger? ↓
How do you resolve Step-by-Step Configuration of the VS Code Debugger for Mainframe with IBM z/OS Debugger in production? ↓
How can teams prevent Step-by-Step Configuration of the VS Code Debugger for Mainframe with IBM z/OS Debugger in enterprise pipelines? ↓
Recommended Technical Runbooks
Migrating from Broadcom Endevor to Git & Modern CI/CD using Zowe CLI and IBM DBB
Broadcom CA-7 / CA-11 Decoupling: Migrating 20,000+ JCL Batch Schedules to Stonebranch or Control-M
Building Enterprise REXX Automation: Scripting TSO/E, ISPF Panels, and SDSF Job Parsing
Authoritative Reference Documentation
Official IBM manuals, Redbooks, and vendor technical advisories:
This diagnostic runbook is published by StackMF Technologies LLP for educational and architectural reference only. All code snippets, JCL, and procedures are provided "AS IS" without warranty of any kind. Always test changes thoroughly in non-production sysplex environments prior to production rollout.
IBM, z/OS, CICS, Db2, IMS, RACF, and IDz are registered trademarks of International Business Machines Corporation. Broadcom, CA-7, and Endevor are trademarks of Broadcom Inc. All other trademarks belong to their respective owners and are referenced under the Nominative Fair Use Doctrine (US Lanham Act 15 U.S.C. ยง 1125 / Section 30 of the Indian Trade Marks Act, 1999) solely for technology compatibility and diagnostic identification. StackMF Technologies LLP is an independent consulting entity not affiliated with or endorsed by these vendors. View Full Legal & IP Policy →
Struggling with Critical Mainframe Incidents or Vendor Renewal Pressure?
StackMF deploys certified Senior Mainframe Engineers fluent in both z/OS legacy internals (COBOL, DB2, CICS, VSAM, CA-7, Endevor) and modern cloud stacks (React, Kafka, AWS, Git). Onboard dedicated pods in 48 hours or cut Broadcom licensing by 60%.