Object containing all options to be used by the Download data set API
The files timeout header value
Constants to be used by the z/OSMF API
indicator for get info request
Specifies the z/OS data set and file REST interface
indicator for get defined systems in zosmf
indicator for get topology services
Known error codes return by the API
Error code when unable to connect to host
Error code when unable to connect to port
Error code when self signed certificate in chain
Error code when unable to verify the first certificate
Messages to be used as detail display error message when gathering z/OSMF information
Message indicate that the rejectUnauthorized flag was not set properly
Message indicate that unable to connect to specified host name
Message indicate that unable to establish connection with specified port number
Message indicate that input session object is invalid
Profile configuration for ZOSMF profiles
Generated using TypeDoc
z/OS Management Facility Package
Contains APIs to interact with the z/OS Management Facility (using z/OSMF REST endpoints).
API Examples
Check z/OSMF status
import { ProfileInfo } from "@zowe/imperative"; import { CheckStatus } from "@zowe/zosmf-for-zowe-sdk"; (async () => { // Load connection info from default z/OSMF profile const profInfo = new ProfileInfo("zowe"); await profInfo.readProfilesFromDisk(); const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf"); const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true }); const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs); const response = await CheckStatus.getZosmfInfo(session); console.log(response); })().catch((err) => { console.error(err); process.exit(1); });
List systems defined to z/OSMF
import { ProfileInfo } from "@zowe/imperative"; import { ListDefinedSystems } from "@zowe/zosmf-for-zowe-sdk"; (async () => { // Load connection info from default z/OSMF profile const profInfo = new ProfileInfo("zowe"); await profInfo.readProfilesFromDisk(); const zosmfProfAttrs = profInfo.getDefaultProfile("zosmf"); const zosmfMergedArgs = profInfo.mergeArgsForProfile(zosmfProfAttrs, { getSecureVals: true }); const session = ProfileInfo.createSession(zosmfMergedArgs.knownArgs); const response = await ListDefinedSystems.listDefinedSystems(session); console.log(response); })().catch((err) => { console.error(err); process.exit(1); });