Zowe Remote SSH
Zowe Remote SSH
Use Zowe Remote SSH to perform actions with data sets, USS files, jobs, and more.
Zowe Remote SSH offers a compelling set of advantages for developers and system administrators seeking efficient and modern ways to interact with the mainframe:
-
Simplified set-up and deployment: ZRS provides intuitive set-up wizards within both the Zowe Explorer extension and the Zowe CLI plug-in. ZRS involves little to no server-side configuration and does not require sysadmin assistance. Simplified onboarding accelerates productivity and reduces the barrier to entry for both seasoned mainframers and those new to the platform.
-
Secure and standard communication: Leveraging the robust and widely-adopted Secure Shell (SSH) protocol for data transmission ensures a secure channel for interacting with your mainframe systems. This commitment to industry-standard security practices provides peace of mind when accessing and managing critical mainframe data.
-
Enhanced user experience within existing Zowe tools: Zowe Explorer leverages ZRS to provide an alternative communication pathway to mainframe resources with a direct SSH-based stack. By integrating with existing Zowe tools, ZRS provides flexibility for engaging with mainframe capabilities within your preferred workflow. ZRS also maintains a persistent connection with the server so that the user remains authenticated while working in Zowe Explorer.
Status of Zowe Remote SSH functionality
For the functionality that is currently available, see the following tables.
Legend
- ✅ Supported
- 🚧 Partially supported
- ❌ Not supported
- ➖ Not applicable
- italic Planned for initial release
Data Sets
| Operation | z/OSMF | FTP | Backend | Middleware | SDK | CLI | VSCE |
|---|---|---|---|---|---|---|---|
| List data sets | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| List data set members | ✅ | ✅ | 🚧 1 | ✅ | ✅ | ✅ | ✅ |
| Read data set | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Read data set member | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Write data set | ✅ | ✅ | 🚧 2 | ✅ | ✅ | ✅ | ✅ |
| Write data set member | ✅ | ✅ | 🚧 2 | ✅ | ✅ | ✅ | ✅ |
| Create data set | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Create data set member | ✅ | ✅ | 🚧 3 | ✅ | ✅ | ✅ | ✅ |
| Delete data set | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Delete data set member | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Recall data set | 🚧 4 | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Migrate data set | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Delete migrated data set | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Rename data set | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Rename data set member | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Copy data set | ✅ | ❌ | ✅ | ✅ | ❌ | ❌ | ❌ |
| Compress data set | ➖ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |
| Search data sets | 🚧 5 | ❌ | 🚧 5 | ❌ | ✅ | ❌ | ❌ |
| Invoke AMS (VSAM) | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
- Not all attributes are retrieved.
- RECFM=U (undefined record format) data sets are read-only; write attempts return an error.
- If the member already exists, this operation causes member contents to be overwritten.
- Does not support some migration utilities like CA Disk.
- Limited options compared to ISPF
srchfor.
USS Files
| Operation | z/OSMF | FTP | Backend | Middleware | SDK | CLI | VSCE |
|---|---|---|---|---|---|---|---|
| List files/directories | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Read USS file | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Write USS file | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Create file/directory | ✅ | ✅ | 🚧 1 | ✅ | ✅ | ✅ | ✅ |
| Delete file/directory | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Copy file/directory | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Move file/directory | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
chmod file/directory | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
chown file/directory | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
chtag USS file | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Issue UNIX command | ✅ | ✅ | ✅ | ❌ | ✅ | ❌ | ❌ |
Invoke extattr | ✅ | ❌ | ❌ | ❌ | ❌ | ➖ | ➖ |
| Get ACL entries | ✅ | ❌ | ❌ | ❌ | ❌ | ➖ | ➖ |
| Set ACL entries | ✅ | ❌ | ❌ | ❌ | ❌ | ➖ | ➖ |
| Link file/directory | ✅ | ❌ | ❌ | ❌ | ❌ | ➖ | ➖ |
| Unlink file/directory | ✅ | ❌ | ❌ | ❌ | ❌ | ➖ | ➖ |
| List z/OS file systems | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
| Create z/OS file system | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
| Delete z/OS file system | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
| Mount file system | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
| Unmount file system | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
- Recursive option is not supported.
Jobs
| Operation | z/OSMF | FTP | Backend | Middleware | SDK | CLI | VSCE |
|---|---|---|---|---|---|---|---|
| Get job status | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| List jobs | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| List spool files | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Read spool file | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Get job JCL | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Submit job | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Delete job | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Cancel job | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ 1 |
| Hold job | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ➖ 2 |
| Release job | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ➖ 2 |
| Change job class | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
- Does not support force, restart, dump, or purge.
- Zowe Explorer does not support the Job Hold/Release operation.
Console
| Operation | z/OSMF | FTP | Backend | Middleware | SDK | CLI | VSCE |
|---|---|---|---|---|---|---|---|
| Issue MVS command | ✅ | ❌ | ✅ 1 | ❌ | ✅ | ❌ | ❌ |
| Get MVS command response | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Get MVS detect result | ✅ | ❌ | ❌ | ❌ | ❌ | ➖ | ➖ |
- Requires APF authorization.
TSO
| Operation | z/OSMF | FTP | Backend | Middleware | SDK | CLI | VSCE |
|---|---|---|---|---|---|---|---|
| Start TSO address space | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Start TSO app | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
| Issue TSO command | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Get TSO command response | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Send TSO message | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Send TSO app message | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
| Ping TSO address space | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Receive TSO message | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Receive TSO app message | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
| Stop TSO address space | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
Other
| Operation | z/OSMF | FTP | Backend | Middleware | SDK | CLI | VSCE |
|---|---|---|---|---|---|---|---|
| Read system log | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ➖ |
| Get server status | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
| Change user password | ✅ | ❌ | ❌ | ❌ | ❌ | ➖ | ➖ |
| Issue SSH command | ❌ | ❌ | ❌ | ❌ | ✅ | ❌ | ❌ |