createProfileExamples
createProfileExamples: { description: string; options: string }[] = [{options: "ssh111 --host sshhost --user ibmuser --password myp4ss",description: "Create a ssh profile called 'ssh111' to connect to z/OS SSH server at host 'zos123' and default port 22"},{options: "ssh222 --host sshhost --port 13022 --user ibmuser --password myp4ss",description: "Create a ssh profile called 'ssh222' to connect to z/OS SSH server at host 'zos123' and port 13022"},{options: "ssh333 --host sshhost --user ibmuser --privateKey /path/to/privatekey --keyPassphrase privateKeyPassphrase",description: "Create a ssh profile called 'ssh333' to connect to z/OS SSH server at host 'zos123' " +"using a privatekey '/path/to/privatekey' and its decryption passphrase 'privateKeyPassphrase' " +"for privatekey authentication"},{options: "ssh444 --privateKey /path/to/privatekey",description: "Create a ssh profile called 'ssh444' to connect to z/OS SSH server on default port 22, without specifying " +"username, host, or password, preventing those values from being stored on disk"}]
z/OS USS Package
Contains APIs to interact with USS on z/OS (using the z/OS SSH service).
Installation Instructions
The z/OS USS SDK has a dependency on the ssh2 package. This package allows for more secure cryptographic ciphers to be used first on supporting hardware. In order to do this, the dependency attempts to build some native modules at install time.
If these modules cannot be built, the dependency will continue to function, without the optimal cipher list order. However, some error messaging may be visible. These errors can be safely ignored, if desired.
To consume the optimal cipher list and build the native modules, the following software is pre-requisite:
Windows
We recommend NodeJS be installed with Chocolatey, which includes most of the required tooling. An additional tool, CMake, will need to be installed in addition to Chocolatey.
Alternatively, install the following:
Unix
make
gcc-c++
,g++
)MacOS
XCode Command Line Tools
API Examples
Check disk space on file system containing home directory
import { ProfileInfo } from "@zowe/imperative"; import { Shell, SshSession } from "@zowe/zos-uss-for-zowe-sdk"; (async () => { // Load connection info from default SSH profile const profInfo = new ProfileInfo("zowe"); await profInfo.readProfilesFromDisk(); const sshProfAttrs = profInfo.getDefaultProfile("ssh"); const sshMergedArgs = profInfo.mergeArgsForProfile(sshProfAttrs, { getSecureVals: true }); const session = new SshSession(ProfileInfo.initSessCfg(sshMergedArgs.knownArgs)); await Shell.executeSsh(session, "df .", (data: string) => { if (data.trim()) console.log(data); }); })().catch((err) => { console.error(err); process.exit(1); });
Make a script executable
import { ProfileInfo } from "@zowe/imperative"; import { Shell, SshSession } from "@zowe/zos-uss-for-zowe-sdk"; (async () => { // Load connection info from default SSH profile const profInfo = new ProfileInfo("zowe"); await profInfo.readProfilesFromDisk(); const sshProfAttrs = profInfo.getDefaultProfile("ssh"); const sshMergedArgs = profInfo.mergeArgsForProfile(sshProfAttrs, { getSecureVals: true }); const session = new SshSession(ProfileInfo.initSessCfg(sshMergedArgs.knownArgs)); await Shell.executeSshCwd(session, "chmod +x test.sh", "/tmp", (data: string) => { if (data.trim()) throw new Error(data); }); })().catch((err) => { console.error(err); process.exit(1); });