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:
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.
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 { IProfile, Logger, LoggingConfigurer, ImperativeError, CredentialManagerFactory } from "@zowe/imperative"; import { getDefaultProfile } from "@zowe/core-for-zowe-sdk"; import { Shell, SshSession } from "@zowe/zos-uss-for-zowe-sdk"; (async () => { //Initialize the Imperative Credential Manager Factory and Logger Logger.initLogger(LoggingConfigurer.configureLogger('lib', {name: 'test'})); // Uncommment the below line if the Secure Credential Store is in use // await CredentialManagerFactory.initialize({service: "Zowe-Plugin"}); // Get the default z/OSMF profile and create a z/OSMF session with it let defaultSshProfile: IProfile; try { defaultSshProfile = await getDefaultProfile("ssh", true); } catch (err) { throw new ImperativeError({msg: "Failed to get a profile."}); } const session: SshSession = SshSession.createBasicSshSession(defaultSshProfile); 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 { IProfile, Logger, LoggingConfigurer, ImperativeError, CredentialManagerFactory } from "@zowe/imperative"; import { getDefaultProfile } from "@zowe/core-for-zowe-sdk"; import { Shell, SshSession } from "@zowe/zos-uss-for-zowe-sdk"; (async () => { //Initialize the Imperative Credential Manager Factory and Logger Logger.initLogger(LoggingConfigurer.configureLogger('lib', {name: 'test'})); // Uncommment the below line if the Secure Credential Store is in use // await CredentialManagerFactory.initialize({service: "Zowe-Plugin"}); // Get the default z/OSMF profile and create a z/OSMF session with it let defaultSshProfile: IProfile; try { defaultSshProfile = await getDefaultProfile("ssh", true); } catch (err) { throw new ImperativeError({msg: "Failed to get a profile."}); } const session: SshSession = SshSession.createBasicSshSession(defaultSshProfile); 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); });