@zowe/cli-test-utils (master) doxdox documentation

Test utilities package for Zowe CLI plug-ins

# Constants()

Class to contain constants

# Constants.DISPLAY_NAME()

Description of product

# docs.zowe.org()

Documentation link for the CLI

# ProfileConstants.APIML_LOGIN_DESCRIPTION()

# ProfileConstants.APIML_LOGIN_EXAMPLE1()

# ProfileConstants.APIML_LOGIN_EXAMPLE2()

# ProfileConstants.APIML_LOGIN_SUMMARY()

# ProfileConstants.APIML_LOGOUT_DESCRIPTION()

# ProfileConstants.APIML_LOGOUT_EXAMPLE1()

# ProfileConstants.APIML_LOGOUT_EXAMPLE2()

# ProfileConstants.APIML_LOGOUT_OPTION_TOKEN_TYPE()

# ProfileConstants.APIML_LOGOUT_SUMMARY()

# ProfileConstants.AUTH_GROUP_DESCRIPTION()

# ProfileConstants.AUTH_GROUP_SUMMARY()

# ProfileConstants.AUTO_INIT_OPTION_CERT_FILE()

# ProfileConstants.AUTO_INIT_OPTION_CERT_KEY_FILE()

# ProfileConstants.AUTO_INIT_OPTION_GROUP()

# ProfileConstants.AUTO_INIT_OPTION_HOST()

# ProfileConstants.AUTO_INIT_OPTION_PASSWORD()

# ProfileConstants.AUTO_INIT_OPTION_PORT()

# ProfileConstants.AUTO_INIT_OPTION_REJECT_UNAUTHORIZED()

# ProfileConstants.AUTO_INIT_OPTION_TOKEN_TYPE()

# ProfileConstants.AUTO_INIT_OPTION_TOKEN_VALUE()

# ProfileConstants.AUTO_INIT_OPTION_USER()

# ProfileConstants.BASE_CONNECTION_OPTION_GROUP()

# ProfileConstants.BASE_OPTION_CERT_FILE()

# ProfileConstants.BASE_OPTION_CERT_FILE_PASSPHRASE()

# ProfileConstants.BASE_OPTION_CERT_KEY_FILE()

# ProfileConstants.BASE_OPTION_HOST()

# ProfileConstants.BASE_OPTION_PASSWORD()

# ProfileConstants.BASE_OPTION_PORT()

# ProfileConstants.BASE_OPTION_REJECT_UNAUTHORIZED()

# ProfileConstants.BASE_OPTION_TOKEN_TYPE()

# ProfileConstants.BASE_OPTION_TOKEN_VALUE()

# ProfileConstants.BASE_OPTION_USER()

# www.zowe.org()

Support link for zowe

# zowe.log()

Custom log location to prevent logging to default folder based on the package name

# getImperativeConfig()

Get the Imperative config object which defines properties of the CLI. This allows it to be accessed without calling Imperative.init.

# ApimlAuthHandler()

This class is used by the auth command handlers as the base class for their implementation.

# e()

The profile type where token type and value should be stored

# mServiceDescription()

The description of your service to be used in CLI prompt messages

# SessConstants.TOKEN_TYPE_CHOICES()

The default token type to use if not specified as a command line option

# ync(session)

This is called by the "auth login" command after it creates a session, to obtain a token that can be stored in a profile.

Parameters

Name Types Description
session AbstractSession The session object to use to connect to the auth service

# ync(session)

This is called by the "auth logout" command after it creates a session, to revoke a token before removing it from a profile.

Parameters

Name Types Description
session AbstractSession The session object to use to connect to the auth service

# ZosmfSession.createSessCfgFromArgs(args)

This is called by the {@link BaseAuthHandler#process} when it needs a session. Should be used to create a session to connect to the auth service.

Parameters

Name Types Description
args ICommandArguments The command line arguments to use for building the session

# ApimlAutoInitHandler()

This class is used by the auth command handlers as the base class for their implementation.

# colorizeKeyword(changeKeyWd)

Colorize a change keyword for a message to be displayed.

Parameters

Name Types Description
changeKeyWd string The keyword that we want to colorize.

# displayAutoInitChanges()

This is called by our processAutoInit() base class function to display the set of actions taken by the auto-init command.

# e()

The profile type where token type and value should be stored

# e()

Record info about profile properties that override properties defined in the base profile. These properties may prevent connecting to the APIML.

# mAutoInitReport()

private method

This structure is populated during convertApimlProfileInfoToProfileConfig and retrieved by the auto-init command handler to provide the data for the output of the auto-init command.

# mServiceDescription()

The description of your service to be used in CLI prompt messages

# recordOneProfChange(profNmToRecord, profObj, msgToRecord)

Record the change message for one profile with the this.mAutoInitReport.profileRpts array.

Parameters

Name Types Description
profNmToRecord string The name of the profile for which we want to record a change.
profObj IConfigProfile An IConfigProfile object which is used when a new entry must be created in the profileRpts array.
msgToRecord string The message to record for the type of change to this profile.

# recordProfilesFound(apimlProfInfos)

Record the set of profiles found by our interrogation of plugins and APIML. The information is re-arranged to enable easy reporting of the desired information. This function assumes that the 'services' module continues to use its algorithm in which the first profile of a given type is the profile that we select.. If that changes, this function must also change.

Parameters

Name Types Description
apimlProfInfos IApimlProfileInfo The profileInfo array returned by services.getServicesByConfig().

# recordProfileUpdates()

Record how the profiles have been updated by auto-init.

# ync(session)

This is called by the "auto-init" command after it creates a session, to generate a configuration

Parameters

Name Types Description
session AbstractSession The session object to use to connect to the configuration service

# ZosmfSession.createSessCfgFromArgs(args)

This is called by the {@link BaseAuthHandler#process} when it needs a session. Should be used to create a session to connect to the auto-init service.

Parameters

Name Types Description
args ICommandArguments The command line arguments to use for building the session

# close()

private method

Close event handler triggered when client closes connection

# createStdinStream(data, expectedLength)

private method

Create readable stream for stdin data received from the daemon client.

Parameters

Name Types Description
data First chunk of stdin data
expectedLength Expected byte length of stdin data

# DaemonClient()

Class for handling client connections to our persistent service (e.g. daemon mode)

# end()

private method

End event handler triggered when client disconnects

# net.Socket(mClient, mServer, mOwner)

Creates an instance of DaemonClient.

Parameters

Name Types Description
mClient net.Socket
mServer net.Server
mOwner string

# run()

Run an instance of this client and wait for proper events

# shutdown()

private method

Shutdown the daemon server cleanly. This is triggered when our EXE sends Control-C in the stdin property of its request object.

# ync(data)

private method

Data event handler triggered for whenever data comes in on a connection

Parameters

Name Types Description
data Buffer

# close()

private method

Server close handler

# constructor(mParms)

Creates an instance of DaemonDecider.

Parameters

Name Types Description
mParms string[]

# DaemonDecider()

Initial paramter parse to handle conditionally starting as a persistent process (e.g. daemon mode)

# error(err)

private method

Server error handler

Parameters

Name Types Description
err Error

# init()

Initialize our DaemonDecider parse and optionally start the server

# initialParse()

private method

Perform initial parsing of undocumented parameters

# mSocket()

private method

Hold current socket path for the server

# mStartServer()

private method

Indicator for whether or not to start the server

# mUser()

private method

Hold current owner for the server

# net.Server()

private method

Hold instance of a running server

# parm()

NOTE(Kelosky): For now, we use an undocumented parameter --daemon. If found first, we bypass yargs and begin running this as a persistent Processor.

# recordDaemonPid()

private method

Record the process ID of the daemon that is being started for the current user. On a multi-user system, each user gets his/her own daemon.

# runOrUseDaemon()

Method to immediately parse or otherwise start the server for later processing from incoming socket connections.

# startServer()

private method

Get whether or not to start the server

# startServer()

private method

Set whether or not to start the server

# DaemonUtil()

Class containing daemon utility functions.

# getDaemonDir()

Get the directory that holds daemon-related runtime files. Ensures that the directory exists, or we create it.

# DisableDaemonHandler()

Handler to disable daemon mode.

# readMyDaemonPid(daemonPidFileNm)

Read the process ID for a daemon running for the current user from the pid file of the current user. The format of the PID file is: { user: string pid: number }

Parameters

Name Types Description
daemonPidFileNm The file name containing the PID for the daemon.

# ync(cmdParams)

Process the disable daemon command and populates the response object as needed.

Parameters

Name Types Description
cmdParams IHandlerParameters Parameters supplied by yargs

# ync()

Disable daemon mode.

# addZoweBinOnPosix(pathToZoweBin)

Add our .zowe/bin directory to the front of the user's PATH on Linux and MAC. Do that by adding a line at the end of the user's .profile file.

Parameters

Name Types Description
pathToZoweBin The absolute path to our .zowe/bin drectory.

# EnableDaemonHandler()

Handler to enable daemon mode.

# ync(cmdParams)

Process the enable daemon command and populates the response object as needed.

Parameters

Name Types Description
cmdParams IHandlerParameters Parameters supplied by yargs

# ync(canAskQuestions)

Enable daemon mode. We extract our native executable and place it in ZOWE_CLI_HOME/bin.

Parameters

Name Types Description
canAskQuestions boolean Can we interactively ask the user questions?

# ync(tgzFile, toDir, fileToExtract)

Unzip, from a gzipped tar file, any file that contains fileToExtract as a substring of the file name. The file will be placed into toDir. We expect toDir to already exist.

Parameters

Name Types Description
tgzFile The gzipped tar file that we will extract
toDir The directory into which we extract files
fileToExtract The file name (or substring of the file name) to extract.

# ync(pathToZoweBin, userQuestions)

Add our .zowe/bin directory to the user's PATH.

Parameters

Name Types Description
pathToZoweBin The absolute path to our .zowe/bin drectory.
userQuestions IDaemonEnableQuestions Questions for user (if permitted)

# ync(pathToZoweBin)

Add our .zowe/bin directory to the front of the user's PATH on Windows.

Parameters

Name Types Description
pathToZoweBin The absolute path to our .zowe/bin drectory.

# RestartDaemonHandler()

Handler to disable daemon mode.

# ync(cmdParams)

Process the disable daemon command and populates the response object as needed.

Parameters

Name Types Description
cmdParams IHandlerParameters Parameters supplied by yargs

# ync()

Restart daemon mode.

# CatalogTemplatesHandler()

Handler to list template catalog

# formatProvisionedInstanceSummaryOutput(instance:, option:)

Format the output of instance summary data, options may be used to further refine the output

Parameters

Name Types Description
instance: IProvisionedInstance one or more provisioned instance
option: command options

# InstanceInfoHandler()

Handler to list instance info

# InstanceVariablesHandler()

Handler to list instance variables

# formatProvisionedInstancesSummaryOutput(instances:, showAllInfo)

Format the output of instance summary data, options may be used to further refine the output

Parameters

Name Types Description
instances: IProvisionedInstance one or more provisioned instance
showAllInfo : display summary (default) or all information fields

# RegistryInstancesHandler()

Handler to list registry instances

# TemplateInfoHandler()

Handler to list template info

# ActionHandler()

Handler to perform action against instance

# definition()

private method

This object defines the top level command group for zosworkflows. This is not something that is intended to be used outside of this npm package.

# ArchiveDefinition()

private method

This object defines the command for the archive group within zosworkflows. This is not something that is intended to be used outside of this npm package.

# ArchiveHandler()

Common Handler for archiving workflow instance in z/OSMF in zosworkflows package. This is not something that is intended to be used outside of this npm package.

# arguments()

private method

Command line arguments passed

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-workflows archive"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# ArchiveOptions()

Object containing all extra options to be used by the archive workflow commands.

# workflowKey()

The workflow key of the workflow to be archived.

# workflowName()

The name of the workflow to be archived.

# zosmfVersion()

Identifies the version of the zOSMF workflow service.

# Workflow()

private method

This object defines the command for archiving workflow instance on zOSMF. This is not something that is intended to be used outside of this npm package.

# arguments()

private method

Command line arguments passed

# CreateCommonHandler()

Common Handler for creating workflow instance in z/OSMF in zosworkflows package. This is not something that is intended to be used outside of this npm package.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-workflows create"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# accessType()

Specifies the access type for the workflow. Public, Restricted or Private.

# assignToOwner()

Indicates whether the workflow steps are assigned to the workflow owner.

# CreateCommonOptions()

Object containing all extra options to be used by the create workflow commands.

# deleteCompleted()

Whether the successfully completed jobs to be deleted from the JES spool.

# et()

Data set containing workflow definiton option.

# inputFile()

Property file containing key-value pairs as workflow variables.

# keepFiles()

Avoid deletion the uploaded files after successful execution.

# localFile()

Local file containing workflow definiton option.

# overwrite()

Specifies whether delete workflow with the same name if it already exists.

# owner()

User id of the owner of the workflow.

# remoteDirectory()

The remote uss directory where the files are to be uploaded.

# systemName()

System where the workflow will run.

# ussFile()

Uss file containing workflow definiton option.

# variables()

Variables list for workflow.

# zosmfVersion()

Identifies the version of the zOSMF workflow service.

# CreateDefinition()

private method

This object defines the command for the create group within zosworkflows. This is not something that is intended to be used outside of this npm package.

# DataSet()

private method

This object defines the command for creating workflow instance from dataset within zosworkflows. This is not something that is intended to be used outside of this npm package.

# LocalFile()

private method

This object defines the command for creating workflow instance from local file within zosworkflows. This is not something that is intended to be used outside of this npm package.

# UssFile()

private method

This object defines the command for creating workflow instance from uss file within zosworkflows. This is not something that is intended to be used outside of this npm package.

# arguments()

private method

Command line arguments passed

# DeleteArchivedCommonHandler()

Common handler to delete a workflow instance in z/OSMF. This is not something that is intended to be used outside of this npm package.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-workflows delete"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# arguments()

private method

Command line arguments passed

# DeleteCommonHandler()

Common handler to delete a workflow instance in z/OSMF. This is not something that is intended to be used outside of this npm package.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-workflows delete"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# DeleteDefinition()

private method

This object defines the command for the delete group within zosworkflows. This is not something that is intended to be used outside of this npm package.

# DeleteActiveWorkflow()

private method

This object defines the command for delete workflow using workflow key within zosworkflows. This is not something that is intended to be used outside of this npm package.

# DeleteWorkflowOptions()

Object containing all extra options to be used by the delete active workflow commands.

# workflowKey()

Parameter to delete workflow by workflow key.

# workflowName()

Parameter to delete workflow by workflow name

# DeleteArchivedWorkflow()

private method

This object defines the command for delete workflow using workflow key within zosworkflows. This is not something that is intended to be used outside of this npm package.

# DeleteArchivedWorkflowOptions()

Object containing all extra options to be used by the delete archived workflow commands.

# workflowKey()

Parameter to delete workflow by workflow key.

# workflowName()

Parameter to delete workflow by workflow name

# ListDefinition()

private method

This object defines the command for the List group within zosworkflows. This is not something that is intended to be used outside of this npm package.

# ActiveWorkflowDetailsCommonOptions()

Object containing all extra options to be used by the list active workflow details commands.

# listSteps()

Optional parameter for listing steps properties.

# listVariables()

Optional parameter for listing variables properties.

# skipWorkflowSummary()

Optional parameter for listing steps summary only

# stepsSummaryOnly()

Optional parameter for listing steps summary only

# workflowKey()

Parameter to list workflow details by workflow key.

# workflowName()

Parameter to list workflow details by workflow name

# ActiveWorkflowDetails()

private method

This object defines the command for listing active workflow details within zosworkflows. This is not something that is intended to be used outside of this npm package.

# ActiveWorkflowDetails()

A Handler for listing details of a workflow instance in z/OSMF in zosworkflows package. This is not something that is intended to be used outside of this npm package.

# arguments()

private method

Command line arguments passed

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-workflows list active-workflow-details"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# ActiveWorkflows()

private method

This object defines the command for listing workflow instance(s) in zOSMF. This is not something that is intended to be used outside of this npm package.

# arguments()

private method

Command line arguments passed

# ListActiveWorkflowsHandler()

Common Handler for listing active workflow(s) instance(s) in z/OSMF.

# ync(params)

Handler process - invoked by the command processor to handle the "zos-workflows list"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# category()

Category of the workflow, which is either general or configuration

# ListActiveWorkflowsOptions()

Object containing all extra options to be used by the list active-workflow commands.

# owner()

Workflow owner (a valid z/OS user ID).

# statusName()

Workflow status.

# system()

Nickname of the system on which the workflow is to be performed.

# vendor()

Name of the vendor that provided the workflow definition file.

# workflowName()

The name of the workflow.

# zosmfVersion()

Identifies the version of the zOSMF workflow service.

# ArchivedWorkflows()

private method

This object defines the command for listing archived z/OSMF workflows for a system or sysplex. This is not something that is intended to be used outside of this npm package.

# arguments()

Command line arguments passed

# ListArchivedWorkflowsHandler()

Common Handler for listing archived workflows for a system.

# ync(params)

Handler process - invoked by the command processor to handle the "zos-workflows archived list"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# RetrieveWorkflowDefinition()

private method

This object defines the command for retrieving workflow contents of zosworkflow definition. This is not something that is intended to be used outside of this npm package.

# arguments()

private method

Command line arguments passed

# ListActiveWorkflowsHandler()

Common Handler for retrieving the contents of a z/OSMF workflow definition from a z/OS system.

# ync(params)

Handler process - invoked by the command processor to handle the "zos-workflows list"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# definitionFilePath()

Parameter to list workflow details by workflow name

# listSteps()

Optional parameter for listing steps properties.

# listVariables()

Optional parameter for listing variables properties.

# RetrieveWorkflowDefinitionCommonOptions()

Object containing all extra options to be used by the retrieve workflow definition commands.

# performFollowingSteps()

If the workflow contains any subsequent automated steps, this property indicates whether z/OSMF is to perform the steps.

# resolveConflict()

Indicates how variable conflicts are to be handled when the Workflows task reads in the output file from a step.

# StartCommonOptions()

Object containing all extra options to be used by the start workflow commands.

# wait()

Identifies whether to wait for workflow instance to finish.

# workflowKey()

Workflow key of workflow to be run.

# workflowName()

Workflow name of workflow to be run.

# zosmfVersion()

Identifies the version of the zOSMF workflow service.

# StartDefinition()

private method

This object defines the command for the start group within zos-workflows. This is not something that is intended to be used outside of this npm package.

# WorkflowFull()

private method

This object defines the command for delete workflow using workflow key within zos-workflows. This is not something that is intended to be used outside of this npm package.

# arguments()

private method

Command line arguments passed

# WorkflowFullHandler()

Common handler to start a workflow instance in z/OSMF. This is not something that is intended to be used outside of this npm package.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-workflows start full-workflow

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# WorkflowStep()

private method

This object defines the command for delete workflow using workflow key within zos-workflows. This is not something that is intended to be used outside of this npm package.

# arguments()

private method

Command line arguments passed

# WorkflowStepHandler()

Common handler to start a workflow instance in z/OSMF. This is not something that is intended to be used outside of this npm package.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-workflows start workflow-step"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# Handler()

Handle to collect a MVS console command response

# Handler()

Handle to issue a MVS console command

# definition()

private method

This object defines the top level command group for zosfiles. This is not something that is intended to be used outside of this npm package.

# getDataSet(name)

Converts the name of a data set to an IDataSet

Parameters

Name Types Description
name string - the name in the form USER.DATA.SET

# processWithSession(commandParameters, session, zosmfProfile)

This is called by the {@link ZosFilesBaseHandler#process} after it creates a session. Should be used so that every class under files does not have to instantiate the session object.

Parameters

Name Types Description
commandParameters IHandlerParameters Command parameters sent to the handler.
session AbstractSession The session object generated from the zosmf profile.
zosmfProfile IProfile The zosmf profile that was loaded for the command. Never use this deprecated zosmfProfile parameter. It should have been removed for the V2 version of Zowe, but we missed it. There is no good reason to use it. Better techniques exist, and are implemented in all of the implementations of this abstract class.

# ync(commandParameters)

This will grab the zosmf profile and create a session before calling the subclass {@link ZosFilesBaseHandler#processWithSession} method.

Parameters

Name Types Description
commandParameters IHandlerParameters Command parameters sent by imperative.

# ZosFilesBaseHandler()

private method

This class is used by the various zosfiles handlers as the base class for their implementation. All handlers within zosfiles should extend this class. This class should not be used outside of the zosfiles package.

# CompareDefinition()

Compare group definition containing its description and children

# binary()

The binary option

# binary2()

The binary option for file 2

# browserView()

Open in browser option

# CompareOptions()

Object containing all options to be used by the Compare API

# contextLines()

The contextlines option

# encoding()

The encoding option

# encoding2()

The encoding option for file 2

# record()

The record option

# record2()

The record option for file 2

# seqnum()

The seqnum option

# volume()

The volume serial

# volume2()

The volume serial for file 2

# CompareBaseHandler()

private method

This class is used by the various zosfiles-compare handlers as the base class for their implementation. All handlers within zosfiles-compare should extend this class. This class should not be used outside of the zosfiles-compare package.

# getFile1(session, args, helper)

Abstract method required for compare handlers to determine how they gather the contents of the file/dataset to compare

Parameters

Name Types Description
session Gives access to the session object in case the handler needs to submit a request to get the first file
args Command arguments required for getting the dataset, filepath, or spool descriptor
helper CompareBaseHelper instance to access prepare- functions

# getFile2(session, args, helper)

Abstract method required for compare handlers to determine how they gather the contents of the file/dataset to compare

Parameters

Name Types Description
session Gives access to the session object in case the handler needs to submit a request to get the contents
args Command arguments required for getting the dataset, filepath, or spool descriptor
helper CompareBaseHelper instance to access prepare- functions

# ync(commandParameters)

This will grab the zosmf profile and create a session before calling the subclass {@link ZosFilesBaseHandler#processWithSession} method.

Parameters

Name Types Description
commandParameters IHandlerParameters Command parameters sent by imperative.

# browserView()

private method

browserView option

# CompareBaseHelper()

Base helper for compare command to handle common operations through the comparison

# constructor(commandParameters)

Creates an instance of CompareBaseHelper

Parameters

Name Types Description
commandParameters IHandlerParameters Command parameters sent to the handler

# contextLines()

private method

contextLines option

# file1Options()

file compare option for file1

# file2Options()

file compare option for file2

# k()

private method

task

# prepareContent(content, content2)

This method will prepare the strings for comparison ready

Parameters

Name Types Description
content string Buffer
content2 string Buffer

# prepareLocalFile(filePath)

Helper function that compare-related handlers will use to get the contents of a local file

Parameters

Name Types Description
filePath Path to the file to compate against

# prepareSpoolDescriptor(spoolDescription)

Parse the spool description and split them into individual properties

Parameters

Name Types Description
spoolDescription Colon-separated (:) spool descriptor

# responseTimeout()

responseTimeout option

# seqnum()

seqnum option

# ync(string1, string2)

To get the difference string in ternninal or in browser

Parameters

Name Types Description
string1 string - string of file 1 comtent
string2 string - string of file 2 comtent

# DatasetDefinition()

Compare data sets command definition containing its description, examples and/or options

# DatasetHandler()

Handler to view a data set's content

# LocalfileDatasetDefinition()

Compare local files and data sets command definition containing its description, examples and/or options

# LocalfileDatasetHandler()

Handler to compare a localfile and a dataset content

# LocalfileSpoolddDefinition()

Compare local-file-spool-dd command definition containing its description, examples and/or options

# LocalfileSpoolddHandler()

Handler to compare spooldd's content

# LocalfileUssFileDefinition()

Compare local files and data sets command definition containing its description, examples and/or options

# LocalfileUssHandler()

Handler to compare the local file and uss file's content

# SpoolddDefinition()

Compare spool-dds command definition containing its description, examples and/or options

# SpoolddHandler()

Handler to compare spooldd's content

# UssFileDefinition()

Compare uss-files command definition containing its description, examples and/or options

# UssFileHandler()

Handler to view a data set's content

# CopyDefinition()

private method

This object defines the command for the copy group within zosfiles. This is not something that is intended to be used outside of the zosfiles package.

# DsDefinition()

This object defines the command for copy data-set within zosfiles. This is not something that is intended to be used outside of the zosfiles package.

# DsHandler()

Handler to copy a data set.

# CreateDefinition()

Create group definition containing its description and children

# alcunit()

The unit of space allocation

# attributes()

The indicator that we should print all allocation attributes

# avgblk()

The average block

# blksize()

The block size

# dirblk()

The number of directory blocks

# dsntype()

The data set type

# dsorg()

The data set organization

# flatFile()

The indicator of a flat file creation (Sequential data set)

# like()

The like value of data set

# lrecl()

The record length

# primary()

The primary space allocation

# recfm()

The record format

# s()

The storage class

# s()

The management class

# s()

The data class

# secondary()

The secondary space allocation

# showAttributes()

The indicator that we should print all allocation attributes

# size()

The size of the data set

# unit()

The device type

# volser()

The volume serial

# ZosFilesCreateExtraOptions()

Object containing all extra options to be used by the Create API

# ZosFilesCreateOptions()

Object containing all options to be used by the Create API

# generateZosmfOptions(commandArguments)

Generate the appropriate options object to create a dataset before sending it to the z/OS MF APIs

Parameters

Name Types Description
commandArguments yargs.Arguments - The provided command arguments

Returns

ICreateDataSetOptions

Object to be sent

# BinaryPDSDefinition()

Create Binary PDS command definition containing its description, examples and/or options

# BinaryPDSHandler()

Handler to create a Binary-PDS data set

# CPDSDefinition()

Create C-code PDS command definition containing its description, examples and/or options

# CPDSHandler()

Handler to create a C-PDS data set

# ClassicPDSDefinition()

Create Classic PDS command definition containing its description, examples and/or options

# ClassicPDSHandler()

Handler to create a Classic-PDS data set

# DsDefinition()

Create dataSet command definition containing its description, examples and/or options

# DataSetHandler()

Handler to like a data set

# PdsDefinition()

Create PDS command definition containing its description, examples and/or options

# PdsHandler()

Handler to create a PDS data set

# PsDefinition()

Create PS command definition containing its description, examples and/or options

# PsHandler()

Handler to create a PDS data set

# mode()

The permission bits for owner, group, and world users of the directory

# UssCreateOptions()

Specifies the file or directory permission bits to be used in creating the file or directory.

# UssDirHandler()

Handler to create a USS Directory

# mode()

The permission bits for the owner, group, and world users of the file

# UssCreateOptions()

Specifies the file or directory permission bits to be used in creating the file or directory.

# UssFileHandler()

Handler to create a USS file

# VsamHandler()

Handler to create a VSAM data set

# retainFor()

The number of days for which the VSAM cluster will be retained.

# retainTo()

The number of days for which the VSAM cluster will be retained.

# volumes()

The volumes on which to allocate a VSAM cluster

# VsamCreateOptions()

Object containing all extra options to be used by the Create API

# ZfsHandler()

Handler to create a z/OS file system

# cylsPri()

The number of primary cylinders to allocate for the ZFS

# cylsSec()

The number of secondary cylinders to allocate for the ZFS

# group()

The group ID for the ZFS root directory

# owner()

The user ID for owner of the ZFS root directory

# perms()

The permissions code for the ZFS root directory

# timeout()

The number of seconds to wait for the create command to complete

# volumes()

The volumes on which to create the ZFS

# ZfsCreateOptions()

Object containing all extra options to be used by the Create API

# DeleteDefinition()

private method

This object defines the command for the delete group within zosfiles. This is not something that is intended to be used outside of the zosfiles package.

# DsDefinition()

private method

This object defines the command for delete data-set within zosfiles. This is not something that is intended to be used outside of the zosfiles package.

# DsHandler()

Handler to delete a data set.

# MDSHandler()

Handler to rename a Data Set

# UssDefinition()

private method

This object defines the command for delete data-set within zosfiles. This is not something that is intended to be used outside of the zosfiles package.

# UssHandler()

Handler to delete a USS file.

# VsamDefinition()

private method

This object defines the command for delete vsam-cluster within zosfiles. This is not something that is intended to be used outside of the zosfiles package.

# VsamHandler()

Handler to delete a VSAM data set.

# ZfsDefinition()

private method

This object defines the command for delete zos-file-system within zosfiles. This is not something that is intended to be used outside of the zosfiles package.

# ZfsHandler()

Handler to delete a z/OS file system.

# DownloadDefinition()

Download group definition containing its description and children

# attributes()

The attributes option to specify the path to a zos-files-attributes file

# binary()

The binary option

# directory()

The directory to download all members to

# DownloadOptions()

Object containing all options to be used by the Download data set API

# encoding()

The encoding option

# excludePattern()

The pattern to be excluded

# extension()

The file extension to use for the downloaded file

# extensionMap()

The extension-map to use for the downloaded file

# file()

The local file to download the data set to

# includeHidden()

The include hidden option for download

# maxConcurrentRequests()

The maximum concurrent requests for "download all-members"

# overwrite()

The include hidden option for download

# record()

The record option

# volume()

The volume serial

# AllMembersDefinition()

Download all members command definition containing its description, examples and/or options

# AllMembersHandler()

Handler to download all members from a pds

# DatasetDefinition()

Download data set command definition containing its description, examples and/or options

# DatasetHandler()

Handler to download a data set or member

# DataSetMatchingDefinition()

Download all members command definition containing its description, examples and/or options

# DataSetMatchingHandler()

Handler to download all members from a pds

# UssFileDefinition()

Download data set command definition containing its description, examples and/or options

# UssFileHandler()

Handler to download an uss file

# UssDirDefinition()

Download all members command definition containing its description, examples and/or options

# UssDirHandler()

Handler to download all members from a pds

# HMigrateDefinition()

hMigrate group definition containing its description and children

# DSHandler()

Handler to migrate a Data Set

# HRecallDefinition()

hRecall group definition containing its description and children

# DSHandler()

Handler to rename a Data Set

# InvokeDefinition()

Invoke group definition containing its description and children

# AmsFileDefinition()

AMS command definition containing its description, examples and/or options

# AmsFileHandler()

Handler to create a PDS data set

# AmsStatementsDefinition()

AMS command definition containing its description, examples and/or options

# AmsStatementsHandler()

Handler to create a PDS data set

# ListDefinition()

Download group definition containing its description and children

# attributes()

The indicator that we want to show more attributes

# depth()

An optional USS search parameter to limit the depth of the file and directory search

# filesys()

An optional USS search parameter to determine whether or not to search all filesystems

# fsname()

The indicator that where the name of mounted.

# group()

An optional USS search parameter to filter by group name or number

# ListOptions()

Object containing all options to be used by the List data-set/member API

# maxLength()

The indicator of how many lines will the list have, the default is 0 which means all the data sets.

# mtime()

An optional USS search parameter to filter by modified time in number of days

# name()

An optional USS search parameter for a file or directory name

# owner()

An optional USS search parameter to filter by owner name or number

# path()

The indicator that where ti file syste is mounted.

# pattern()

The pattern to match against a list of members in a data set.

# perm()

An optional USS search parameter to filter by permission octal string

# size()

An optional USS search parameter to filter by file size

# start()

An optional search parameter that specifies the first data set name to return in the response document.

# symlinks()

An optional USS search parameter to determine whether or not to follow symlinks

# type()

An optional USS search parameter to filter by the type of file, directory, device, or special file

# volume()

The volume serial

# AllMembersDefinition()

List all members command definition containing its description, examples and/or options

# AllMembersHandler()

Handler to list a data set members

# DataSetDefinition()

List data sets command definition containing its description, examples and/or options

# DataSetHandler()

Handler to list a data sets

# FsDefinition()

List data sets command definition containing its description, examples and/or options

# FsHandler()

Handler to list a data sets

# USSFileDefinition()

List all members command definition containing its description, examples and/or options

# USSFileHandler(params)

Handler to list a unix directory

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# MountDefinition()

Download group definition containing its description and children

# FsHandler()

Handler to mount a Unix file system

# FsMountOptions()

Object containing all extra options to be used by the Mount API

# fsType()

The file system type to mount

# mode()

The read/write mode for the file system

# RenameDefinition()

Rename group definition containing its description and children

# DsHandler()

Handler to rename a data set

# DsmHandler()

Handler to rename a data set member

# UnmountDefinition()

Download group definition containing its description and children

# FsHandler()

Handler to unmount a Unix file system

# UploadDefinition()

Upload group definition containing its description and children

# asciiFiles()

The ascii-files option

# attributes()

The attributes option

# binary()

The binary option

# binaryFiles()

The binary-files option

# encoding()

The encoding option

# includeHidden()

The include hidden option for upload

# maxConcurrentRequests()

The maximum concurrent requests for upload

# recall()

The migrated recall option

# record()

The record option

# recursive()

The recursive option

# UploadOptions()

Object containing all options to be used by the Upload API

# volume()

The volume serial

# DirToPdsDefinition()

Upload dir-to-pds command definition containing its description, examples and/or options

# DirToPdsHandler()

Handler to upload content of a directory to a PDS

# DirToUSSDirDefinition()

Upload dir-to-uss command definition containing its description, examples and/or options

# DirToUSSDirHandler()

Handler to upload content from a local directory to a USS directory

# FileToDataSetDefinition()

Upload file-to-data-set command definition containing its description, examples and/or options

# FileToDataSetHandler()

Handler to upload content from a file to a data set

# FileToUSSDefinition()

Upload file-to-uss command definition containing its description, examples and/or options

# FileToUSSHandler()

Handler to upload content from a local file to a USS file

# StdinToDataSetDefinition()

Upload stdin-to-data-set command definition containing its description, examples and/or options

# StdinToDataSetHandler()

Handler to stream data from stdin to a data set

# ViewDefinition()

View group definition containing its description and children

# binary()

The binary option

# encoding()

The encoding option

# range()

The range of records to return

# record()

The record option

# ViewOptions()

Object containing all options to be used by the View API

# volume()

The volume serial

# DatasetDefinition()

View data set command definition containing its description, examples and/or options

# DatasetHandler()

Handler to view a data set's content

# USSFileDefinition()

View USS file content command definition containing its description, examples and/or options

# USSFileHandler()

Handler to view USS file content

# modifyVersion()

The files timeout header value

# arguments()

private method

Command line arguments passed

# JobHandler()

"zos-jobs cancel job" command handler. Cancel a job by ID.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs cancel job"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# arguments()

private method

Command line arguments passed

# JobHandler()

"zos-jobs delete job" command handler. Delete (purge) a job by ID.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs delete job"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# arguments()

private method

Command line arguments passed

# OldJobsHandler()

"zos-jobs delete old-jobs" command handler. Delete (purge) multiple jobs in OUTPUT status.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs delete job"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# OutputHandler()

"zos-jobs download output" command handler. Download each spool DD to a separate file.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs download output"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# JobsHandler()

Handler for the "zos-jobs list jobs" command.

# ync(params)

Handler for the "zos-jobs list jobs" command. Produces a tabular list of jobs on spool based on the input parameters.

Parameters

Name Types Description
params IHandlerParameters - see interface for details

# arguments()

private method

Command line arguments passed

# profile()

private method

The z/OSMF profile for this command

# SpoolFilesHandler()

"zos-jobs list spool-files" command handler. Outputs a table of spool files.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs list spool-files"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# arguments()

private method

Command line arguments passed

# JobHandler()

"zos-jobs modify job" command handler. Modify a job by name and ID.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs modify job"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# SharedSubmitHandler()

"zos-jobs submit data-set" command handler. Submits a job (JCL) contained within a z/OS data set (PS or PDS member).

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs submit data-set"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# AllSpoolContentHandler()

"zos-jobs view all-spool-content" command handler. Outputs details regarding a z/OS job.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs view all-spool-content"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# JobStatusByJobidHandler()

"zos-jobs view job-status-by-jobid" command handler. Outputs details regarding a z/OS job.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs view job-status-by-jobid"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# SpoolFileByIdHandler()

"zos-jobs view spool-by-id" command handler. Outputs a single spool DD contents.

# ync(params)

Command handler process - invoked by the command processor to handle the "zos-jobs view job"

Parameters

Name Types Description
params IHandlerParameters - Command handler parameters

# LogsHandler()

Handle to get logs from z/OSMF restful api

# Handler()

Handler to show zosmf information

# CheckStatusMessages()

Messages displayed by the zosmf check status command

# cmdSucceeded()

Displayed when checkStatus succeeds and returns status information.

# Handler()

Handler to show zosmf information

# TSO_OPTION_ACCOUNT()

# TSO_OPTION_ACCOUNT_PROFILE()

# TSO_OPTION_CHAR_SET()

# TSO_OPTION_CODE_PAGE()

# TSO_OPTION_COLUMNS()

# TSO_OPTION_GROUP()

# TSO_OPTION_LOGON_PROCEDURE()

# TSO_OPTION_REGION_SIZE()

# TSO_OPTION_ROWS()

# TSO_PROFILE_OPTIONS()

# Handler()

Handler to issue command to TSO address space

# Handler()

Handler to Send data to TSO address space

# Handler()

Handler to Send data to TSO address space

# Handler()

Handler to start an address space

# IssueCommand()

Definition for the "issue" group of commands under the Shell plugin

# Handler()

Handle to issue an USS ssh command

# ApimlConstants()

Class for various APIML constants.

# SERVICES_ENDPOINT()

URI for listing APIML services

# convertApimlProfileInfoToProfileConfig(profileInfoList)

Converts apiml profile information to team config profile objects to be stored in a zowe.config.json file

Parameters

Name Types Description
profileInfoList List of apiml profiles

# getPluginApimlConfigs()

Forms a list of APIML service attributes needed to query APIML for every REST service for every loaded command group. This information can later be used to create every connection profile required for every loaded command group.

# Services()

Class to handle listing services on APIML gateway.

# ync(session, configs)

Calls the services endpoint of the APIML gateway to obtain a list of services that support Single Sign-On. This list is compared against a list of APIML service attributes defined in CLI plug-in configs. When a service's API ID is present in both lists, a profile info object is generated to store CLI profile info for connecting to that service.

Parameters

Name Types Description
session Session with APIML connection info
configs APIML service attributes defined by CLI plug-ins

# connProfType()

Once getPluginApimlConfigs() has processed the loaded ImperativeConfig, the connProfType will be a required property in the resulting object.

# pluginName()

The plugin name from which these attributes were retrieved. If retrieved from the core CLI, then the CLI name is used.

# eProfileOverride()

As part of the auto-init output report, this structure represents profile properties that override properties defined in the base profile.

# Login()

Class to handle logging onto APIML.

# ync(session)

Perform APIML login to obtain LTPA2 or other token types.

Parameters

Name Types Description
session AbstractSession

# APIML_V1_RESOURCE()

URI base jobs API

# LoginConstants()

Class for various login constants.

# Logout()

Class to handle logging out of APIML.

# ync(session)

Perform APIML logout to invalidate LTPA2 or other token types.

Parameters

Name Types Description
session AbstractSession

# APIML_V1_RESOURCE()

URI base jobs API

# APIML_V1_TOKEN_EXP_ERR()

Zowe Token Expired Error Code

# LogoutConstants()

Class for various logout constants.

# APIML_LOGIN_EXAMPLE1()

Example definition for APIML login command

# APIML_LOGIN_EXAMPLE2()

Example definition for APIML login command with show-token

# APIML_LOGOUT_EXAMPLE1()

Example definition for APIML logout command

# APIML_LOGOUT_EXAMPLE2()

Example definition for APIML logout command with token-value

# APIML_LOGOUT_OPTION_TOKEN_TYPE()

Option used in APIML logout command for token-type

# AUTO_INIT_OPTION_CERT_FILE()

Option used in profile creation and commands for certificate file to be used to interact with login APIs

# AUTO_INIT_OPTION_CERT_KEY_FILE()

Option used in profile creation and commands for certificate key file to be used to interact with login APIs

# AUTO_INIT_OPTION_HOST()

Option used in profile creation and commands for hostname

# AUTO_INIT_OPTION_PORT()

Option used in profile creation and commands for port

# AUTO_INIT_OPTION_REJECT_UNAUTHORIZED()

Option used in profile creation and commands for rejectUnauthorized setting for connecting to z/OSMF

# AUTO_INIT_OPTION_TOKEN_TYPE()

Option used in profile creation and commands for tokenType

# AUTO_INIT_OPTION_TOKEN_VALUE()

Option used in profile creation and commands for tokenValue to be used to interact with APIs

# AUTO_INIT_OPTION_USER()

Option used in profile creation and commands for username / ID

# E()

Option used to specify the path to the certificate file for authentication

# E_OPTION_CERT_FILE()

Option used to specify the path to the certificate file for authentication

# E_OPTION_CERT_KEY_FILE()

Option used to specify the path to the certificate file for authentication

# E_OPTION_HOST()

Option used in profile creation and commands for hostname

# E_OPTION_PORT()

Option used in profile creation and commands for port

# E_OPTION_REJECT_UNAUTHORIZED()

Option used in profile creation and commands for rejectUnauthorized setting for connecting to z/OSMF

# E_OPTION_TOKEN_TYPE()

Option used in profile creation and commands for tokenType

# E_OPTION_TOKEN_VALUE()

Option used in profile creation and commands for tokenValue to be used to interact with APIs

# E_OPTION_USER()

Option used in profile creation and commands for username / ID

# eProfile()

Profile configuration for SSH profiles

# ProfileConstants()

Class containing the various profile related constants

# SWORD()

Option used in profile creation and commands for password/passphrase

# SWORD()

Option used in profile creation and commands for password/passphrase

# 1.0()

If you use this header, delete job API will be asynchronous. This is the default setting, so using this header is not really necessary unless you want to be explicit.

# 2.0()

If you use this header, delete job API will be synchronous. But using it may cause problems for some users depending on their maintenance level and configuration.

# ACCEPT_ENCODING()

Header that specifies GZIP compression is supported Recent versions of z/OSMF issue a warning if this header is omitted

# E()

base header

# OCTET_STREAM()

octet stream header

# RANGE()

Header to set byte range

# S_A()

job class header

# TEXT_PLAIN()

plain text header

# X_CSRF_ZOSMF_HEADER()

security header

# X_IBM_BINARY()

binary transfer header

# X_IBM_BINARY_BY_RECORD()

binary by record header

# X_IBM_INTRDR_LRECL_256()

256 lrecl header

# X_IBM_INTRDR_LRECL_80()

80 lrecl header

# X_IBM_INTRDR_MODE_TEXT()

text type header

# X_IBM_INTRDR_RECFM_F()

fixed recfm header

# X_IBM_MAX_ITEMS()

This header value specifies the maximum number of items to return. To request that all items be returned, set this header to 0. If you omit this header, or specify an incorrect value, up to 1000 items are returned by default.

# X_IBM_MIGRATED_RECALL_WAIT()

data set migrated recall headers

# X_IBM_NOTIFICATION_URL()

n/a header

# X_IBM_RECORD()

record transfer header

# X_IBM_RECORD_RANGE()

Header to set record range

# X_IBM_RESPONSE_TIMEOUT()

Header to set response timeout Timeout defaults to 30 seconds if not modified

# X_IBM_RETURN_ETAG()

Header to force return of ETag in response regardless of file size By default Etag is returned only for files smaller than a system determined value (which is at least 8mb)

# X_IBM_TEXT()

text transfer header

# X_IBM_TEXT_ENCODING()

encoding value for text headers

# ZosmfHeaders()

Class to contain default z/OSMF headers

# appendHeaders(headers)

Append z/OSMF specific headers to the callers headers for cases where a header is common to every request.

Parameters

Name Types Description
headers any[] undefined

# log()

Use the Brightside logger instead of the imperative logger

# processError(original)

Process an error encountered in the rest client

Parameters

Name Types Description
original IImperativeError - the original error automatically built by the abstract rest client

# ZosmfRestClient()

Wrapper for invoke z/OSMF API through the RestClient to perform common error handling and checking and resolve promises according to generic types

# noSession()

Error message that no session was supplied.

# nozOSMFVersion()

Error message that no z/OSMF version parameter string was supplied.

# asyncPool(poolLimit, array, iteratorFn)

Execute multiple promises in a pool with a maximum number of promises executing at once

Parameters

Name Types Description
poolLimit - limit of how many promises should execute at once
array - array of objects to convert to promises with iteratorFn
iteratorFn - the function that turns an entry in the array into a promise

# getErrorContext(content, lineIndex)

Produces formatted context of a given error in the specified location of the contents NOTE: The lineIndex is zero-based indexed

Parameters

Name Types Description
content string string[]
lineIndex number - Zero-basd indexed location of the error to be printed

Returns

string

Few lines (separated by \n) containing error context

# padLeft(str, len, padChar)

Adds padding in case you want a longer string.

Parameters

Name Types Description
str string - string to add the padding to
len number - final length of the padded string
padChar string - Padding character

Returns

string

Padded string

# readStdin()

Utility function to read complete standard in contents from a handler Can be awaited from async methods

# sleep(ms)

This is a simple sleep function to help when waiting for a certain period of time before continuing.

Parameters

Name Types Description
ms number The number of milliseconds to sleep.

# trimLineToTerminalWidth(str)

Trims a given line based on the terminal's width. It also replaces tabs with spaces.

Parameters

Name Types Description
str string - string to be trimmed

Returns

string

Trimmed string

# getDefaultProfile(profileType, mergeWithBase)

Loads default z/OSMF profile. The profile must have already been created using Zowe CLI, and not rely on base profiles

Parameters

Name Types Description
profileType string - The name of the profile type
mergeWithBase boolean - Whether or not to merge with the base profile

# getZoweDir()

Retrieves the Zowe CLI home directory. In the situation Imperative has not initialized it we mock a default value.

# deleteDeprovisionedInstance(session, zOSMFVersion, instanceId)

Performs the delete action against a provisioned software service instance.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
instanceId string - the object-id of provisioned instance in the registry.

# DeleteInstance()

Delete deprovisioned instances.

# ListCatalogTemplates()

Get info about all published templates.

# ync(session, zOSMFVersion)

This operation returns the catalog of published software service templates.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.

# ListInstanceInfo()

Get info about a provisioned instance.

# ync(session, zOSMFVersion, instanceId)

This operation retrieves a published software service instance from the registry instances.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
instanceId string - the id of the provisioned software service instance.

# getResourcesQuery(zOSMFVersion, instanceId)

Builds a resources query from passed parameters which is needed for z/OSMF api URI.

Parameters

Name Types Description
zOSMFVersion string - the URI path that identifies the version of the provisioning service.
instanceId string - unique id of the provisioned instance .

# ListInstanceVariables()

Get variables of the provisioned instance.

# ync(session, zOSMFVersion, instanceId)

This operation returns variables of the provisioned instance.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path that identifies the version of the provisioning service.
instanceId string - unique id of the provisioned instance .

# getResourcesQuery(zOSMFVersion, type, externalName)

Builds URI path from provided parameters.

Parameters

Name Types Description
zOSMFVersion string - the URI path that identifies the version of the provisioning service.
type string - system type of the instance.
externalName string - regular expression, specifies the external name of the instance.

# ListRegistryInstances()

Get info about all provisioned instances.

# ync(session, zOSMFVersion, filteredQuery)

This operation returns registry of provisioned instances.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path that identifies the version of the provisioning service.
filteredQuery string - URI path with filters for listing filtered registry instances.

# ync(session, zOSMFVersion, type, externalName)

This operation returns registry of provisioned instances filtered by type and external name.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path that identifies the version of the provisioning service.
type string - system type of the instance.
externalName string - regular expression, specifies the external name of the instance.

# getResourcesQuery(zOSMFVersion, templateName)

Builds a resources query from passed parameters which is needed for z/OSMF api URI.

Parameters

Name Types Description
zOSMFVersion string is the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
templateName string is the name of published software service template in the catalog.

# ListTemplateInfo()

Get info about a template.

# ync(session, zOSMFVersion, templateName)

This operation retrieves a published software service template from the catalog.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
templateName string - the name of published software service template in the catalog.

# getResourcesQuery(zOSMFVersion, instanceId, actionName)

Builds a resources query from passed parameters which is needed for z/OSMF api URI.

Parameters

Name Types Description
zOSMFVersion string - the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
instanceId string - the object-id of provisioned instance in the registry.
actionName string - name of the action to perform.

# PerformAction()

Perform an action on published software service template.

# ync(session, zOSMFVersion, instanceId, actionName)

Performs an action against a provisioned software service instance.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
instanceId string - the object-id of provisioned instance in the registry.
actionName string - name of the action to perform.

# ProvisionPublishedTemplate()

Provision a published software service template.

# ync(session, zOSMFVersion, templateName, account)

Provision a published software service template only with account number parameter.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
templateName string - the name of published software service template.
account string - account information to use in the JCL JOB statement.

# ync(session, zOSMFVersion, templateName, optionalParms)

Provision a published software service template, with optional parameters if passed.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
zOSMFVersion string - the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
templateName string - the name of published software service template.
optionalParms IProvisionOptionals - optional parameters for z/OSMF rest call, @see {IProvisionOptionals}.

# 1.0()

Version of the z/OSMF software services template service

# ACTIONS_RESOURCES()

URI base for performed actions on a provisioned instance.

# INSTANCES_RESOURCE()

URI base for provisioned instances API.

# noAccountInfo()

No account number was provided error message.

# noActionName()

Error message that no template name parameter string was supplied.

# noInstanceId()

Error message that no instance-id parameter string was supplied.

# noSessionProvisioning()

Error message that no session provided.

# noTemplateName()

Error message that no template name parameter string was supplied.

# ProvisioningConstants()

Constants for provisioning related info.

# RESOURCE()

URI base for provisioning API.

# RESOURCE_EXTERNAL_NAME()

Parameter for filtering by external name.

# RESOURCE_PROVISION_RUN()

URI base for provisioning a published template.

# RESOURCE_TYPE()

Parameter for filtering by type.

# TEMPLATES_RESOURCES()

URI base for published templates API.

# VARIABLES_RESOURCE()

URI base for provisioned instance variables.

# parseProperties(propertiesText)

Parsers text with properties in key1=val1,key2=val2 format and returns IInputProperty[]

Parameters

Name Types Description
propertiesText string - required runtime property objects passed as a string.

# ProvisioningService()

Service class which helps to filter or edit input parameters.

# readPropertiesFromYamlFile(path)

Reads a YAML file with properties, parses it in key1=val1,key2=val2 format and returns IInputProperty[].

Parameters

Name Types Description
path string - path of the file.

# sedOptionalParms(properties, propertiesFile, domainName, tenantName, userDataId, userData, accountInfo, systemNickNames)

Helper method which checks if optional parameters were passed or not.

Parameters

Name Types Description
properties string - required runtime property objects.
propertiesFile string - path of the properties yaml file.
domainName string - name of the domain.
tenantName string - name of the tenant.
userDataId string - ID for the user data specified with user-data.
userData string - user data that is passed into the software services registry.
accountInfo string - account information to use in the JCL JOB statement.
systemNickNames string[] - nicknames of the systems upon which to provision a template.

# ProvisioningValidator()

Class validates parameters for provisioning commands.

# validateNotEmptyString(text, errorMsg)

Validate supplied parameters

Parameters

Name Types Description
text string - string to check if empty
errorMsg string - message to show in case validation fails

# validateSession(session)

Validate session

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info

# validateString(text, errorMsg)

Validate supplied parameters

Parameters

Name Types Description
text string - string to check if not null or undefined
errorMsg string - message to show in case validation fails

# name()

Name of the property.

# value()

Value of the property.

# abstract()

Brief description of the variable for the UI widget.

# choices()

Contains allowable choices for the value of the variable.

# description()

Explanation of what the variable is used for and perhaps what the syntactic requirements are.

# explainPromptVariableFull()

Main explanation map object for full output.

# explainPromptVariableSummary()

Main explanation map object for summary output.

# label()

Short label for the UI widget.

# max()

For a string type, indicates the maximum string length of the value. For all other types, indicates the maximum value required.

# min()

For a string type, indicates the minimum string length of the value. For all other types, indicates the minimum value required.

# name()

Name of the property.

# places()

Maximum number of decimal places that can be specified for a variable of the decimal type.

# prettyFull()

Explained keys for all-info.

# prettySummary()

Explained keys for summary.

# regex()

Standard regular expression that constrains the variable value.

# required()

Indicates whether the variable value is required during the workflow create process.

# type()

Type of variable element: boolean, string, integer, decimal, time, date.

# value()

Current value for the property.

# explainProvisionTemplateResponse()

Main explanation map object for summary output.

# description()

Description for the software.

# explainProvisionedInstanceExtended()

Main explanation map object for extended provisioned instance output.

# explainProvisionedInstanceFull()

Main explanation map object for full provisioned instance output.

# explainProvisionedInstanceSummary()

Main explanation map object for provisioned instance summary output without variables and actions.

# explainProvisionedInstanceSummaryWithActions()

Main explanation map object for provisioned instance summary output with actions.

# explainProvisionedInstanceSummaryWithVars()

Main explanation map object for provisioned instance summary output with variables.

# owner()

The user ID that identifies the owner of the software.

# provider()

The user ID that identifies the provider of the software.

# state()

The current state of the software.

# sysplex()

Sysplex on which the software is provisioned.

# system()

System on which the software is provisioned.

# t()

The time the object was updated. The time is in the ISO8601 format.

# t()

The user ID that last updated the object.

# t()

The name of the last action that was performed.

# t()

The action ID of the last action that was performed.

# t()

The state of the last action that was performed.

# type()

Type of the software.

# User()

Indicates if auditing is performed on workflows and command actions that are associated with the instance.

# vendor()

Vendor of the software.

# version()

Version of the software.

# command()

For command type actions, the command.

# explainProvisionedInstanceActionsFull()

Main explanation map object for full output.

# explainProvisionedInstanceActionsSummary()

Main explanation map object for summary output.

# instructions()

For instruction type actions, the instructions.

# name()

The name of the action. If the name of the action is deprovision, the action is for deprovisioning the software.

# prettyFull()

Explained keys for full.

# prettySummary()

Explained keys for summary.

# type()

The type of the action.

# variables()

For workflow type actions, if provided, the workflow variables.

# explainAtCreateVariable()

Main explanation map object for create provisioned instance variables.

# explainPromptVariable()

Main explanation map object for provisioned instance prompt variables output.

# explainProvisionedInstanceVariable()

Main explanation map object for the output of provisioned instance variables.

# name()

Name of the variable.

# pretty()

Explained keys for summary.

# value()

Value of the variable.

# visibility()

Visibility of the variable.

# variables()

Variables for the software services instance.

# explainProvisionedInstancesFull()

Main explanation map object for full output.

# explainProvisionedInstancesSummary()

Main explanation map object for summary output.

# description()

Description of a template.

# explainPublishedTemplateFull()

Main explanation map object for full output

# explainPublishedTemplateSummary()

Main explanation map object for summary output

# name()

Name of a template.

# owner()

Template owner ID.

# prettyFull()

Local explanation map for full

# prettySummary()

Local explanation map for summary

# state()

Status of a template.

# version()

Version of a template.

# description()

Description of the template.

# explainPublishedTemplateInfoFull()

Main explanation map object for full output

# explainPublishedTemplateInfoSummary()

Main explanation map object for summary output

# name()

Name of the template.

# owner()

Template owner ID.

# prettyFull()

Explained keys for all-info

# prettySummary()

Explained keys for summary

# state()

Status of the template.

# version()

Version of the template.

# explainPublishedTemplatesFull()

Main explanation map object for full output.

# explainPublishedTemplatesSummary()

Main explanation map object for summary output.

# explainTemplateRegistryInfoResponse()

Main explanation map object for summary output.

# explainTemplateWorkflowInfoResponse()

Main explanation map object for workflow-info response output.

# vendor()

Vendor name.

# workflowDescription()

Description of the workflow.

# workflowID()

ID of the workflow.

# workflowKey()

Unique workflow key.

# workflowVersion()

Version of the workflow.

# ArchiveWorkflow()

Class to handle archiving the workflow instance in z/OSMF

# archiveWorkflowByKey(session, workflowKey, zOSMFVersion)

Archives the workflow based on the workflow key

Parameters

Name Types Description
session AbstractSession z/OSMF session
workflowKey string Workflow key of the workflow to be archived
zOSMFVersion string z/OSMF REST API version

# ArchivedDeleteWorkflow()

Class to handle deletion of an archived z/OSMF workflow from a z/OS system

# ync(session, workflowKey, zOSMFVersion)

Delete archived workflow

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
workflowKey string - Unique identifier of the workflow instance.
zOSMFVersion string - Identifies the version of the zOSMF workflow service.

# CancelWorkflow()

Class to handle canceling of zOSMF workflow instance

# WorkflowConstants.ZOSMF_VERSION(session, workflowKey, zOSMFVersion)

Cancel a workflow instance

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
workflowKey string - Unique identifier of the workflow instance.
zOSMFVersion string - Identifies the version of the zOSMF workflow service.

# CreateWorkflow()

Class to handle creation of zOSMF workflow instance

# createWorkflow(session, WorkflowName, WorkflowDefinitionFile, systemName, Owner, VariableInputFile, Variables, AssignToOwner, AccessType, DeleteCompletedJobs, zOSMFVersion)

Create a zOSMF workflow instance

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
WorkflowName string - Name of the workflow that will be created
WorkflowDefinitionFile string - Full path to USS file or DATASET/MEMBER with xml
systemName string - System where the workflow will run
Owner string - User ID of the workflow owner.
VariableInputFile string - Properties file with pre-specify values for workflow variables
Variables string - A list of one or more variables for the workflow.
AssignToOwner boolean - Indicates whether the workflow steps are assigned to the workflow owner
AccessType accessT - Specifies the access type for the workflow. Public, Restricted or Private.
DeleteCompletedJobs boolean - Specifies whether the job is deleted from the JES spool after it completes successfully.
zOSMFVersion string - Identifies the version of the zOSMF workflow service.

# getTempFile(userId, localFile, customDir)

Get a full path with file name for a temporary USS file

Parameters

Name Types Description
userId string - User ID to add to the file name.
localFile string - Local file name.
customDir string - Custom directory.

# parseProperties(propertiesText)

copied from ProvisioningService.ts Parsers text with properties in key1=val1,key2=val2 format and returns IInputProperty[]

Parameters

Name Types Description
propertiesText string - required runtime property objects passed as a string.

# ync(session, WorkflowName, WorkflowDefinitionFile, systemName, Owner, VariableInputFile, Variables, AssignToOwner, AccessType, DeleteCompletedJobs, zOSMFVersion, keepFiles, customDir)

Create a zOSMF workflow instance using local files

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
WorkflowName string - Name of the workflow that will be created
WorkflowDefinitionFile string - Local workflow definition file
systemName string - System where the workflow will run
Owner string - User ID of the workflow owner.
VariableInputFile string - Local properties file with pre-specify values for workflow variables
Variables string - A list of one or more variables for the workflow.
AssignToOwner boolean - Indicates whether the workflow steps are assigned to the workflow owner
AccessType accessT - Specifies the access type for the workflow. Public, Restricted or Private.
DeleteCompletedJobs boolean - Specifies whether the job is deleted from the JES spool after it completes successfully.
zOSMFVersion string - Identifies the version of the zOSMF workflow service.
keepFiles boolean - Identifies if the uploaded uss files should be kept.
customDir string - Path to specific USS directory in which to upload the temp files.

# ync(session, localFile, remoteFile)

Upload USS files to default dir, or a user specified one

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info.
localFile string - Local file to upload.
remoteFile string - Remote location to upload to.

# ync(session, ussFileName)

Delete USS file

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info.
ussFileName string - USS file to delete.

# DeleteWorkflow()

Class to handle deletion of zOSMF workflow instance

# ync(session, workflowKey, zOSMFVersion)

Delete a workflow instance

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
workflowKey string - Unique identifier of the workflow instance.
zOSMFVersion string - Identifies the version of the zOSMF workflow service.

# getResourceQuery(params)

This operation Builds URI path from provided parameters.

Parameters

Name Types Description
params IGetWorkflowsOptions - The array with URI path with filters for listing filtered workflows.

# ListWorkflows()

Get list of workflows from registry.

# ync(session, options)

This operation returns list of workflows. Parameters are optional,request can include one or more parameters to filter the results.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
options IGetWorkflowsOptions - Options to filter the request

# ync(session, workflowName, zOSMFVersion)

This operation is used to return a worflow-key by given workflow name.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
workflowName string - workflow name by which to list workflows
zOSMFVersion string - identifies the version of the provisioning service.

# ync(steps)

Processes the z/OSMF workflow step info in a recursive manner.

Parameters

Name Types Description
steps IStepInfo[] z/OSMF steps to be processed

# StartWorkflow()

Class to handle starting of zOSMF workflow instance

# ync(session, workflowKey, resolveConflict, step, subsequent, zOSMFVersion)

Create a zOSMF workflow instance

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
workflowKey string - Unique key that workflow instant got assigned by zOSMF
resolveConflict string - Indicates how variable conflicts are to be handled when the Workflows task reads in the output file from a step. Allowed values are: outputFileValue, existingValue, leaveConflict(have to resolve conflict manually)
step string - Specifies the step name that will run.
subsequent string - If the workflow contains any subsequent automated steps, this property indicates whether z/OSMF is to perform the steps.
zOSMFVersion string - Identifies the version of the zOSMF workflow service.

# 1.0()

Version of the z/OSMF

# ARCH_WORKFLOW_RESOURCE()

URI base for workflows API.

# ARCHIVE_WORKFLOW()

URI base for archiving workflow API

# CANCEL_WORKFLOW()

URI base for canceling workflow API.

# category()

URI base for filter workflows from registry API.

# filePath()

URI base for filePath for workflow definition.

# LIST_WORKFLOWS()

URI base for list workflows from registry API.

# noOwner()

Error message that no owner parameter string was supplied.

# noSteps()

Error message that no steps parameter was supplied.

# noSystemName()

Error message that no system name parameter string was supplied.

# noVariables()

Error message that no variables parameter was supplied.

# noWorkflowDefinitionFile()

Error message that no workflow definition file parameter string was supplied.

# noWorkflowKey()

Error message that no workflow key string was supplied.

# noWorkflowName()

Error message that no workflow name parameter string was supplied.

# owner()

URI base for filter workflows from registry API.

# RESOURCE()

URI base for workflow API.

# returnData()

URI base for returnData for workflow properties from registry API.

# START_WORKFLOW()

URI base for starting workflow API.

# statusName()

URI base for filter workflows from registry API.

# steps()

URI base for steps for workflow properties from registry API.

# system()

URI base for filter workflows from registry API.

# tempPath()

Default path for uploading temporary files

# variables()

URI base for variables for workflow properties from registry API.

# vendor()

URI base for filter workflows from registry API.

# WF_NAME()

URI base for filtering workflow by name API.

# WORKFLOW_DEFINITION()

URI base for workflows API.

# WORKFLOW_RESOURCE()

URI base for workflows API.

# WorkflowConstants()

Constants for workflow related APIs.

# workflowKey()

URI base for filter workflows from registry API.

# workflowName()

URI base for filter workflows from registry API.

# wrongString()

Error message that no system name parameter string was supplied.

# WrongWorkflowKey()

Error message that workflow key that was supplied does not exist. IZUWF5001W: The workflow key "workflowkey" was not found.

# validateNotEmptyString(text, errorMsg)

Validate supplied parameters

Parameters

Name Types Description
text string - string to check if empty
errorMsg string - message to show in case validation fails

# validateOwner(userID, errorMsg)

Validate supplied parameter

Parameters

Name Types Description
userID string - string to check if it is valid user ID regarding IBM
errorMsg string - message to show in case validation fails

# validateParameter(parameterValue, errorMsg)

Validate supplied string for parameters if there is not value "?" or "&"

Parameters

Name Types Description
parameterValue string - check if the provided parameters does not contain value "?" or "&"
errorMsg string - message to show in case validation fails

# validateSession(session)

Validate session

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info

# validateString(text, errorMsg)

Validate supplied parameters

Parameters

Name Types Description
text string - string to check if not null or undefined
errorMsg string - message to show in case validation fails

# WorkflowValidator()

Class validates parameters for workflows commands.

# currentStepName()

Step that is being processed automatically or that caused stop.

# currentStepNumber()

The step number.

# currentStepTitle()

Step title.

# messageID()

Message identifier for the accompanying message.

# messageText()

Message text that describes the reason that automation is stopped.

# startedTime()

Time that automation processing started.

# startUser()

User ID of the user who initiated the automation processing.

# stoppedTime()

Time that automation processing stopped.

# owner()

Unique workflow name.

# system()

Unique workflow name.

# workflowDefinitionFile()

Path to workflow definition file. Xml in USS or Dataset

# workflowName()

Unique workflow name.

# vendor()

Workflow vendor.

# workflowDescription()

Description of the workflow.

# workflowID()

Workflow ID.

# workflowKey()

Unique workflow key.

# workflowVersion()

Version of the workflow.

# vendor()

Workflow vendor.

# workflowDescription()

Description of the workflow.

# workflowID()

Workflow ID.

# workflowKey()

Unique workflow key.

# workflowVersion()

Version of the workflow.

# ddname()

DDNAME for the data set creation.

# id()

Data set number (key).

# s()

Class that is assigned to the spool file.

# jobfiles()

Contains an array of one or more objects with details about files created by the job.

# jobid()

Job identifier.

# jobname()

Job name.

# owner()

User ID associated with the job.

# s()

Job execution class.

# type()

Job type.

# mapFrom()

Property from REST req.

# mapTo()

Assigned workflow variable.

# object()

Interface for variable objects.

# approver()

Id or ids separated by spaces

# approverSub()

Whether in id is substitution.

# object()

Interface for Step approver object.

# description()

Step description.

# et()

Data set name that contains the saved JCL.

# etSub()

Indicates whether the data set name contains variable substitution.

# name()

Name of the step.

# optional()

Indicates whether the step is optional.

# title()

Step title.

# UnixFile()

UNIX file name (absolute name) that contains the saved JCL.

# UnixFileSub()

Indicates whether the UNIX file name contains variable substitution.

# autoEnable()

Indicates whether the step can be performed automatically.

# CalledWorkflow()

Indicates whether this step calls another workflow.

# description()

Step description.

# et()

Data set name that contains the saved JCL.

# etSub()

Indicates whether the data set name contains variable substitution.

# isRestStep()

Indicates whether this step is a REST API step.

# name()

Name of the step.

# optional()

Indicates whether the step is optional.

# state()

State of the step.

# stepNumber()

The step number.

# title()

Step title.

# UnixFile()

UNIX file name (absolute name) that contains the saved JCL.

# UnixFileSub()

Indicates whether the UNIX file name contains variable substitution.

# User()

The user ID under which the step is to be performed.

# userDefined()

Indicates whether the step was added manually to the workflow.

# UserDynamic()

Indicates whether the runAsUser ID value can change.

# name()

Step name

# state()

State of the step

# stepNumber()

ID of the step

# name()

Name of the variable.

# object()

Interface for variable objects.

# value()

Value of the variable.

# abstract()

Brief description of variable.

# category()

Name of logical variable group.

# choice()

Choice value.

# decimalPlaces()

Maximum number of decimal places.

# default()

Default value of variable.

# description()

Description of variable.

# exposeToUser()

Whether variable displayed.

# maxLength()

Maximum length of variable value.

# maxValue()

Maximum value of variable.

# minLength()

Minimum length of variable value.

# minValue()

Minimum value of variable.

# name()

Name of the variable.

# object()

Interface for variable definition object.

# promptAtCreate()

Whether variable is prompted at create.

# regularExpression()

Standard regular expression.

# requiredAtCreate()

Whether variable must be specified.

# scope()

Variable scope.

# type()

Type of variable.

# validationType()

Validation type of variable.

# visibility()

Indicates if display variable to Workflows users (public or private).

# name()

Name of variable.

# scope()

Variable scope.

# type()

Variable type.

# value()

Variable value.

# visibility()

Variable visibility (public|private).

# name()

Name of the variable.

# object()

Interface for variable-specification object.

# required()

Indicates if is variable required.

# scope()

Variable scope.

# category()

Category of workflow.

# isCallable()

Indicates if workflow can be called by other workflow.

# productID()

Identifier of product configured via workflow.

# productName()

Name of the product configured via workflow.

# productVersion()

Version of the product configured via workflow.

# scope()

Restrict a workflow to one instance only.

# vendor()

Name of the vendor.

# workflowDefaultName()

Identifies workflow default name.

# workflowDefinitionFileMD5Value()

128bit hash associated with definition file.

# workflowDescription()

Description of workflow.

# workflowID()

Short ID that identifies the workflow.

# workflowVersion()

Version of the workflow definition file.

# CollectCommand()

Get the response to a command that was issued asynchronously with the Issue Command service

# collectCommon(session, consoleName, commandResponseKey)

Collect any messages related to the synchronous command response key provided

Parameters

Name Types Description
session AbstractSession representing connection to this api
consoleName string name of the EMCS console that is used to issue the command
commandResponseKey string command response key from the Issue Command request

# collectDefConsoleCommon(session, commandResponseKey)

Collect any messages (from default console) related to the synchronous command response key provided

Parameters

Name Types Description
session AbstractSession representing connection to this api
commandResponseKey string command response key from the Issue Command request

Returns

Promise<IZosmfCollectResponse>

command response on resolve, @see {IZosmfCollectResponse}

# getFollowUpAttempts(parms)

Parameters

Name Types Description
parms ICollectParms parameters for collect command

Returns

number

# getResource(consoleName, commandResponseKey)

Get resource path for collect command

Parameters

Name Types Description
consoleName string name of the EMCS console that is used to issue the command
commandResponseKey string command response key from the Issue Command request

Returns

string

resource path

# getTimeout(parms)

Parameters

Name Types Description
parms ICollectParms console collect parameters, @see {ICollectParms}s

Returns

number

timeout in milliseconds or default value

# ync(session, parms, response)

Collect any messages related to the synchronous command response key provided and collect them into IConsoleResponse To control additional collection and other behaviors, populate the ICollectParms object according to your needs (see ICollectParms for details).

Parameters

Name Types Description
session AbstractSession representing connection to this api
parms ICollectParms console collect parameters, @see {ICollectParms}
response IConsoleResponse response from previous command (if present), @see {IConsoleResponse}

Returns

Promise<IConsoleResponse>

command response on resolve, @see {IConsoleResponse}

# ConsoleResponseService()

Class contains helper methods for console response commands response processing

# getEmptyConsoleResponse()

Provides empty console response

Returns

IConsoleResponse

# populate(zosmfResponse, response, processResponses)

Populate the console response with the details returned from the z/OSMF console API. Method takes two parameters: response from z/OSMF command and response to be populated. Method adds response to a collection of z/OSMF responses, mark response as "succeeded" (response.success = true) and populate other fields of response with values from z/OSMF sresponse.

Parameters

Name Types Description
zosmfResponse IZosmfIssueResponse zosmf console response, @see {IZosmfIssueResponse}
response IConsoleResponse console response to be populated, @see {IConsoleResponse}
processResponses boolean is set to true, append command response string to the console API response

Returns

IConsoleResponse

populated console response, @see {IConsoleResponse}

# populateError(error, response)

Populate the console response with the Imperative error message. Method takes two parameters: Imperative error and response to be populated. Method save error message info failureResponse field and mark console response as "failed" (response.success = false)

Parameters

Name Types Description
error ImperativeError Imperative error, @see {ImperativeError}
response IConsoleResponse console response to be populated, @see {IConsoleResponse}

Returns

IConsoleResponse

populated console response, @see {IConsoleResponse}

# tZosmfResponseEmpty(response)

Determines whether last z/OSMF response has empty content or not

Parameters

Name Types Description
response IConsoleResponse command response

Returns

boolean

true if last z/OSMF response has empty "cmd-response", false otherwise

# ConsoleValidator()

Class validates parameters for console commands

# validateCollectCommonParms(session, consoleName, commandResponseKey)

Validate supplied parameters

Parameters

Name Types Description
session AbstractSession representing connection to this api
consoleName string name of the EMCS console that is used to issue the command
commandResponseKey string command response key from the Issue Command request

# validateCollectParm(parms)

Validate supplied parameters

Parameters

Name Types Description
parms ICollectParms console collect parameters, @see {ICollectParms}

# validateCollectParms(session, parms)

Validate supplied parameters

Parameters

Name Types Description
session AbstractSession representing connection to this api
parms ICollectParms console collect parameters, @see {ICollectParms}

# validateCommonParms(session, consoleName, commandParms)

Validate supplied parameters

Parameters

Name Types Description
session AbstractSession representing connection to this api
consoleName string name of the EMCS console that is used to issue the command
commandParms IZosmfIssueParms synchronous console issue parameters, @see {IZosmfIssueParms}

# validateConsoleName(consoleName)

Validate console name

Parameters

Name Types Description
consoleName string

# validateIssueParm(parms)

Validate supplied parameters

Parameters

Name Types Description
parms IIssueParms console issue parameters, @see {IIssueParms}

# validateIssueParms(session, parms)

Validate supplied parameters

Parameters

Name Types Description
session AbstractSession representing connection to this api
parms IIssueParms console issue parameters, @see {IIssueParms}

# validateIssueSimpleParms(session, theCommand)

Validate supplied parameters

Parameters

Name Types Description
session AbstractSession representing connection to this api
theCommand string command to issue

# validateSession(session)

Validate session

Parameters

Name Types Description
session AbstractSession representing connection to this api

# buildZosmfConsoleApiParameters(parms)

Build IZosmfIssueParms object from provided parameters

Parameters

Name Types Description
parms IIssueParms parameters for issue command

Returns

IZosmfIssueParms

request body, @see {ZosmfConsoleApiParameters}

# getResource(consoleName)

Get resource path for issue command

Parameters

Name Types Description
consoleName string name of the EMCS console that is used to issue the command

Returns

string

resource path

# IssueCommand()

Issue MVS Console commands by using a system console

# issueCommon(session, consoleName, commandParms)

Issue an MVS console command, returns "raw" z/OSMF response

Parameters

Name Types Description
session AbstractSession representing connection to this api
consoleName string name of the EMCS console that is used to issue the command
commandParms IZosmfIssueParms synchronous console issue parameters, @see {IZosmfIssueParms}

Returns

Promise<IZosmfIssueResponse>

command response on resolve, @see {IZosmfIssueResponse}

# issueDefConsoleCommon(session, commandParms)

Issue an MVS console command in default console, returns "raw" z/OSMF response

Parameters

Name Types Description
session AbstractSession representing connection to this api
commandParms IZosmfIssueParms synchronous console issue parameters, @see {IZosmfIssueParms}

Returns

Promise<IZosmfIssueResponse>

command response on resolve, @see {IZosmfIssueResponse}

# ync(session, parms)

Issue an MVS console command command synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued. However, after (according to the z/OSMF REST API documentation) approximately 3 seconds the response will be returned.

Parameters

Name Types Description
session AbstractSession representing connection to this api
parms IIssueParms console issue parameters, @see {IIssueParms}

Returns

Promise<IConsoleResponse>

command response on resolve, @see {IConsoleResponse}

# ync(session, theCommand)

Simple issue console command method. Does not accept parameters, so all defaults on the z/OSMF API are taken.

Parameters

Name Types Description
session AbstractSession representing connection to this api
theCommand string command to issue

Returns

Promise<IConsoleResponse>

command response on resolve, @see {IConsoleResponse}

# ync(session, issueParms, collectParms)

Issue an MVS console command command synchronously - meaning solicited (direct command responses) are gathered immediately after the command is issued. However, after (according to the z/OSMF REST API documentation) approximately 3 seconds the response will be returned. To control additional collection and other behaviors, populate the ICollectParms object according to your needs (see ICollectParms for details).

Parameters

Name Types Description
session AbstractSession representing connection to this api
issueParms IIssueParms console issue parameters, @see {IIssueParms}
collectParms ICollectParms console collect parameters, @see {ICollectParms}

Returns

Promise<IConsoleResponse>

command response on resolve, @see {IConsoleResponse}

# commandResponseKey()

The command response key for follow up messages API call.

# commandResponse()

The command response text.

# success()

True if the command was issued and the responses were collected.

# tResponseKey()

The final command response key - used to "follow-up" and check for additional response messages for the command.

# zosmfResponse()

The list of zOSMF console API responses. May issue multiple requests (because of user request) or to ensure that all messages are collected. Each individual response is placed here.

# command()

The Command to issue.

# cmd()

The z/OS console command to issue.

# MAX_ALLOC_QUANTITY()

Maximum value for primary and secondary allocation

# MAX_AMS_BUFFER()

Maximum numbers of characters to allow for the continuation character on AMS statements

# MAX_AMS_LINE()

Maximum length of an AMS statement

# MAX_RETAIN_DAYS()

Maximum numbers of days for which to retain a dataset.

# MIN_RETAIN_DAYS()

Minimum numbers of days for which to retain a dataset.

# RES_AMS()

Indicator of an AMS request

# RES_DEPTH()

Indicator of the depth parameter for files operations

# RES_DS_FILES()

Indicator of a data set request

# RES_DS_LEVEL()

Indicator the query parameters used to qualify the request

# RES_DS_MEMBERS()

Indicator of a members request

# RES_FILESYS()

Indicator of the filesystem behavior parameter for files operations

# RES_FSNAME()

Indicator of a ds file name

# RES_GROUP()

Indicator of the group parameter for files operations

# RES_MFS()

Indicator of a z/OS mfs

# RES_MTIME()

Indicator of the modification time parameter for files operations

# RES_NAME()

Indicator of the name parameter for files operations

# RES_PATH()

Indicator of a USS File request

# RES_PERM()

Indicator of the permission octal mask parameter for files operations

# RES_SIZE()

Indicator of the size parameter for files operations

# RES_SYMLINKS()

Indicator of the symlink behavior parameter for files operations

# RES_TYPE()

Indicator of the file type parameter for files operations

# RES_USER()

Indicator of the user parameter for files operations

# RES_USS_FILES()

Indicator of a USS File request

# RES_ZFS_FILES()

Indicator of a z/OS file system request

# RESOURCE()

Specifies the z/OS data set and file REST interface

# VSAM_ALCUNIT_CHOICES()

The set of allocation unit choices for VSAM files

# VSAM_DSORG_CHOICES()

The set of dataset organization choices for VSAM files

# ZosFilesConstants()

Constants to be used by the API

# amsCommandExecutedSuccessfully()

Message indicating that the AMS commands was executed successfully

# attributesFileNotFound()

Messaging indicating an attributes file was not found

# attributeTitle()

Message indicating the attributes are used during dataset creation

# commonFor()

Message to be used when throwing an imperative error during dataset creation

# commonWithValue()

Message to be used when throwing an imperative error during dataset creation

# errorParsingAttributesFile()

Message indicating an error parsing an attributes file

# errorReadingAttributesFile()

Message indicating an error reading an attributes file

# et()

Message indicating that attempt to upload a directory with multiple files to a physical sequential data set

# etCopiedSuccessfully()

Message indicating that the data set was copied successfully

# etCreatedSuccessfully()

Message indicating that the data set was created successfully

# etDeletedSuccessfully()

Message indicating that the data set was deleted successfully

# etDeletionRequested()

Message indicating that the data set was deleted successfully.

# etDownloadedSuccessfully()

Message indicating that the data set was downloaded successfully

# etDownloadFailed()

Message indicating that the following data sets failed to properly download

# etLikeName()

Message indicating that the data set "like" name is required

# etMember()

Message indicating that attempt to upload a directory to a data set member

# etMigrationRequested()

Message indicating that the data set was migrated successfully.

# etName()

Message indicating that the data set name is required

# etRecalledSuccessfully()

Message indicating that the data set was recalled successfully.

# etRecallRequested()

Message indicating that the data set was recalled successfully.

# etRenamedSuccessfully()

Message indicating that the data set has been renamed successfully.

# ets()

Message indicating that data set objects were not passed.

# ets()

Message indicating that only empty partitioned data sets match the provided patterns

# ets()

Message indicating that some or all data sets failed to download

# etsArchived()

Message indicating that all data sets matching the provided patterns are archived.

# etsDownloadedSuccessfully()

Message indicating that the data sets matching pattern was downloaded successfully

# etsInList()

Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.

# etsMatchedPattern()

Message indicating that the data sets matching pattern were listed successfully

# etsMatchingPattern()

Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.

# etsMatchingPatternRemain()

Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.

# etType()

Message indicating that the data set type is unsupported

# etType()

Message indicating that the data set type is required

# etUploadedSuccessfully()

Message indicating that file is uploaded to data set successfully

# fsMountedSuccessfully()

Message indicating that the file system was mounted successfully.

# fsUnmountedSuccessfully()

Message indicating that the file system was unmounted successfully.

# invalidAlcunitOption()

Message indicating invalid 'create' command 'alcunit' option

# invalidAttributesSyntax()

Messaging indicating invalid syntax in .zosattributes file

# invalidDsntypeOption()

Message indicating invalid 'create' command 'dsntype' option

# invalidDsorgOption()

Message indicating invalid 'create' command 'dsorg' option

# invalidFilesCreateOption()

Message indicating an invalid 'create' command option

# invalidFilesMountOption()

Message indicating an invalid 'mount' command option

# invalidMountModeOption()

Message indicating invalid 'mount' command 'mode' option

# invalidPermsOption()

Message indicating invalid 'create' command 'perms' option

# invalidPODsorgDirblkCombination()

Message indicating that directory blocks cannot be zero if the data set organization is 'PO'

# invalidPSDsorgDirblkCombination()

Message indicating that directory blocks must be zero if the data set organization is 'PS'

# invalidRecfmOption()

Message indicating invalid 'create' command 'recfm' option

# longAmsStatement()

Message indicating that the AMS commands was too long to be passed to z/OS MF

# maximumAllocationQuantityExceeded()

Message indicating the maximum allocation quantity has been exceeded

# memberDownloadFailed()

Message indicating that the following members failed to properly download

# missingFilesCreateOptions()

Message indicating the 'create' command options is null or undefined

# missingFilesMountOptions()

Message indicating the 'mount' command options is null or undefined

# missingFileSystemName()

Message indicating that the file system name is required

# missingFsOption()

Message indicating that an expected file system option was not supplied.

# missingInputDir()

Message indicating that the input directory is required

# missingInputDirectory()

Message indicating that the input directory path is required

# missingInputFile()

Message indicating that the input file is required

# missingMountPoint()

Message indicating that the mount point is required

# missingPatterns()

Message indicating that patterns were not passed.

# missingPayload()

Message indicating that the payload is required

# missingPrimary()

Message indicating 'create' command 'primary' option is required

# missingRecordLength()

Message indicating 'create' command 'lrecl' option is required

# missingRequestType()

Message indicating that the request type is required

# missingRequiredTableParameters()

Message indicating that required table parameters are missing for file list

# missingStatements()

Message indicating that the AMS statements is required

# missingUSSDirectoryName()

Message indicating that the USS directory name is required

# missingUSSDirName()

Message indicating that the USS Dir name is required

# missingUSSFileName()

Message indicating that the USS File name is required

# missingVsamOption()

Message indicating that the an expected VSAM option was not supplied.

# missingZfsOption()

Message indicating that an expected ZFS option was not supplied.

# nodeJsFsError()

Message indicating that a failure has happened in the NodeJS File System API

# noMembersFound()

Message indicating that the no members were found

# pathIsNotDirectory()

Message indicating that input path is not a directory

# someDownloadsFailed()

Message indicating that some data set downloads failed

# unsupportedDataType()

Message indicating that the data type is unsupported for USS files

# ussCreatedSuccessfully()

Message indicating that the uss file or directory crated successfully.

# ussDirUploadedSuccessfully()

Message indicating that the uss directory was uploaded successfully

# ussFileDeletedSuccessfully()

Message indicating that the USS file or directory was deleted successfully

# ussFileDownloadedSuccessfully()

Message indicating that the uss file was downloaded successfully

# ussFileUploadedSuccessfully()

Message indicating that the uss file was uploaded successfully

# valueOutOfBounds()

Message indicating that the an expected VSAM option was not supplied.

# zfsCreatedSuccessfully()

Message indicating that the ZFS was created successfully

# zfsDeletedSuccessfully()

Message indicating that the ZFS was deleted successfully

# ZosFilesMessages()

Messages to be used as command responses for different scenarios

# dsn()

The name of the data set

# et()

Interface for data sets

# k()

Task status object used by CLI handlers to create progress bars Optional

# k()

Task that will automatically be updated to report progress of upload or download to user

# resource()

URI for this request

# tring()

Http(s) response body as a string

# name()

The name of the dataset

# commandResponse()

The command response text.

# success()

indicates if the command ran successfully.

# tring()

String type definition for properties of abstractRestClient that have a getter set. This can be safely used in a getter call as a variable for the abstractRestClient object.

# Copy()

This class holds helper functions that are used to copy the contents of datasets through the z/OSMF APIs.

# ync(session, toDataSet, options)

Copy the contents of a dataset

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
toDataSet IDataSet - The data set to copy to
options IDataSetOptions - Options

# et()

The dataset to copy from.

# etOptions()

This interface defines the options that can be sent into the copy data set function.

# BINARY()

Specifies the defaults used by the Zos Files API to create a data set used for binaries

# BLANK()

Specifies the defaults used by the Zos Files API to create a blank data set

# C()

Specifies the defaults used by the Zos Files API to create a data set used for C code

# CreateDefaults()

Defaults to be used as options for the different types of data sets that can be created

# DATA_SET()

Specifies all the defaults to create non-vsam data sets

# PARTITIONED()

Specifies the defaults used by the Zos Files API to create a partitioned data set

# SEQUENTIAL()

Specifies the defaults used by the Zos Files API to create a sequential data set

# SIC()

Specifies the defaults used by the Zos Files API to create a classic data set

# VSAM()

Specifies the defaults used by the Zos Files API to create a VSAM cluster

# Create()

Class to handle creation of data sets

# etValidateOptions(options)

Validate supplied parameters

Parameters

Name Types Description
options - additional options for the creation of the data set

# vsamConvertToIdcamsOptions(cliOptions)

Convert the options received from the CLI into options that we supply to IDCAMS.

Parameters

Name Types Description
cliOptions ICreateVsamOptions - The set of options from our CLI

# vsamFormIdcamsCreateCmd(dataSetName, options)

Form the IDCAMS command to create a VSAM cluster

Parameters

Name Types Description
dataSetName string - the name of the dataset for the created cluster
options - options for the creation of the cluster

# vsamValidateOptions(options)

Validate the options for the command to create a VSAM cluster

Parameters

Name Types Description
options - options for the creation of the cluster

# ync(session, dataSetType, dataSetName, options)

Create a data set

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
dataSetType CreateDataSetTypeEnum - the type of data set we are going to create
dataSetName string - the name of the data set to create
options Partial<ICreateDataSetOptions> - overrides the default options provided by dataSetType

# ync(session, dataSetName, options)

Create a VSAM cluster

Parameters

Name Types Description
session AbstractSession - An established z/OSMF session
dataSetName string - the name of the dataset for the created cluster
options Partial<ICreateVsamOptions> - options for the creation of the cluster

# ync(session, ussPath, type, mode)

Create a uss file or folder

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
ussPath string - USS path to create file or directory
type string - the request type "file" or "directory"
mode string - the characters to describe permissions

# zfsValidateOptions(options)

Validate the options for the command to create a z/OS file system

Parameters

Name Types Description
options - options for the creation of the file system

# enum()

Enumerated type that describes the different kinds of data sets that can be created

# lrecl()

The record length

# primary()

The primary space allocation

# s()

The storage class

# s()

The management class

# s()

The data class

# type()

The request type

# s()

The storage class

# s()

The management class

# s()

The data class

# cylsPri()

The primary space allocation

# s()

The storage class

# s()

The management class

# s()

The data class

# Delete()

This class holds helper functions that are used to delete files through the z/OSMF APIs.

# ync(session, dataSetName, options)

Deletes a non-VSAM data set

Parameters

Name Types Description
session AbstractSession z/OSMF connection info
dataSetName string The name of the data set to delete
options IDeleteDatasetOptions Additional options for deletion of the data set

# ync(session, dataSetName, options)

Deletes a VSAM data set

Parameters

Name Types Description
session AbstractSession z/OSMF connection info
dataSetName string The name of the VSAM data set to delete
options IDeleteVsamOptions Additional options for deletion of the data set

# ync(session, fileName, recursive)

Deletes a USS file or directory

Parameters

Name Types Description
session AbstractSession z/OSMF connection info
fileName string The name of the file or directory to delete
recursive boolean The indicator to delete directory recursively

# ync(session, fileSystemName)

Deletes a z/OS file system

Parameters

Name Types Description
session AbstractSession z/OSMF connection info
fileSystemName string The name of the ZFS to delete

# etOptions()

This interface defines the options that can be sent into the delete data set function.

# e()

Specifies the data component of a cluster is to be overwritten with binary zeros when the cluster is deleted.

# apiResponse()

Delete VSAM calls the invoke api, which returns an {@link IZosFilesResponse} object. So the api response will be set to that return object.

# buildDownloadDsmResponse(result, options)

Build a response string from a download data sets matching result.

Parameters

Name Types Description
result Result object from the download API
options Options passed to the download API

# buildDownloadUssDirResponse(result, options)

Build a response string from a download ussDir result.

Parameters

Name Types Description
result Result object from the download API
options Options passed to the download API

# createDownloadPromise(mem)

Function that takes a member and turns it into a promise to download said member

Parameters

Name Types Description
mem - an object with a "member" field containing the name of the data set member

# Download()

This class holds helper functions that are used to download data sets, members and more through the z/OS MF APIs

# emptyDownloadDsmResult()

Create an empty download data sets matching result.

# emptyDownloadUssDirResult()

Create an empty download data sets matching result.

# ync(session, dataSetName, options)

Retrieve data sets and/or members contents and save them in your local workspace

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
dataSetName string - contains the data set name
options IDownloadOptions - contains the options to be sent

# ync(session, dataSetName, options)

Retrieve all members from a PDS and save them in your local workspace

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
dataSetName string - contains the data set name
options IDownloadOptions - contains the options to be sent

# ync(session, dataSetObjs, options)

Download a list of data sets to local files

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
dataSetObjs IZosmfListResponse[] - contains data set objects returned by z/OSMF List API
options IDownloadOptions - contains the options to be sent

# ync(session, ussFileName, options)

Retrieve USS file content and save it in your local workspace.

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
ussFileName string - contains the USS file name
options IDownloadOptions - contains the options to be sent

# ync(session, ussDirName, fileOptions, listOptions)

Retrieve USS file content and save it in your local workspace.

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
ussDirName string - contains the USS file name
fileOptions IDownloadOptions - contains the file options to be sent
listOptions IUSSListOptions - contains the uss list options to be sent

# downloaded()

List of data set names that have downloaded successfully.

# failedArchived()

List of data set names that failed to download because they are archived.

# failedUnsupported()

List of data set names that failed to download because they are an unsupported type.

# failedWithErrors()

Object containing key-value pairs of data set names and errors for data sets that failed to download.

# e()

Indicates if the created directories and files use the original letter case, which is for data sets always uppercase. The default value is false for backward compability. If the option "directory" or "file" is provided, this option doesn't have any effect. This option has only effect on automatically generated directories and files.

# key()

Map data set names that match your pattern to the desired extension

# t()

Indicates if a download operation for multiple files/data sets should fail as soon as the first failure happens. If set to true, the first failure will throw an error and abort the download operation. If set to false, individual download failures will be reported after all other downloads have completed. The default value is true for backward compatibility.

# downloaded()

List of file names that have downloaded successfully.

# failedWithErrors()

Object containing key-value pairs of files and errors for uss files that failed to download.

# skippedExisting()

List of file names that were not downloaded because they already existed on the system.

# Get()

This class holds helper functions that are used to get the content of data sets or USS files through the z/OSMF APIs

# ync(session, dataSetName, options)

Retrieve data sets content

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
dataSetName string - contains the data set name
options IViewOptions - contains the options to be sent

# ync(session, USSFileName, options)

Retrieve USS file content

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
USSFileName string - contains the data set name
options IViewOptions - contains the options to be sent

# HDelete()

This class holds helper functions that are used to delete data sets through the z/OSMF APIs.

# ync(session, dataSetName, wait)

Parameters

Name Types Description
session AbstractSession z/OSMF connection info
dataSetName string The name of the data set to recall
wait boolean If true then the function waits for completion of the request. If false (default) the request is queued.

# HMigrate()

This class holds helper functions that are used to migrate data sets through the z/OSMF APIs.

# ync(session, dataSetName, wait)

Parameters

Name Types Description
session AbstractSession z/OSMF connection info
dataSetName string The name of the data set to recall
wait boolean If true then the function waits for completion of the request. If false (default) the request is queued.

# HRecall()

This class holds helper functions that are used to recall data sets through the z/OSMF APIs.

# ync(session, dataSetName, wait)

Parameters

Name Types Description
session AbstractSession z/OSMF connection info
dataSetName string The name of the data set to recall
wait boolean If true then the function waits for completion of the request. If false (default) the request is queued.

# Invoke()

This class holds helper functions that are used to execute AMS control statements through the z/OS MF APIs

# ync(session, controlStatements)

Send the AMS request to z/OS MF

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
controlStatements string string[]

# List()

This class holds helper functions that are used to list data sets and its members through the z/OS MF APIs

# ync(session, dataSetName, options)

Retrieve all members from a PDS

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
dataSetName string - contains the data set name
options IListOptions - contains the options to be sent

# ync(session, dataSetName, options)

Retrieve all members from a data set name

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
dataSetName string - contains the data set name
options IListOptions - contains the options to be sent

# ync(session, path, options)

Retrieve a list of all files from a path name

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
path string - contains the uss path name
options IUSSListOptions - contains the options to be sent

# ync(session, options)

Retrieve zfs files

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
options IZfsOptions - contains the options to be sent

# ync(session, options)

Retrieve zfs files if indicated path

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
options IZfsOptions - contains the options to be sent

# ync(session, patterns, options)

List data sets that match a DSLEVEL pattern

Parameters

Name Types Description
session AbstractSession z/OSMF connection info
patterns string[] Data set patterns to include
options IDsmListOptions Contains options for the z/OSMF request

# k()

Task status object used by CLI handlers to create progress bars Optional

# dsname()

The name of the dataset

# vol()

The volume name on which the dataset is stored

# fsValidateOptions(options)

Validate the options for the command to mount a z/OS file system

Parameters

Name Types Description
options - options for the mounting of the file system

# Mount()

This class holds helper functions that are used to mount file systems through the z/OS MF APIs

# ync(session, fileSystemName, mountPoint, options)

Mount a Unix file system

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
fileSystemName string - contains the file system name
mountPoint string - contains the mount point
options IListOptions - contains the options to be sent

# Rename()

Class to handle renaming data sets

# ync(session, beforeDataSetName, fterDataSetName)

Rename a data set

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
beforeDataSetName string - the name of the data set to rename
fterDataSetName string - the new name of the data set

# ync(session, dataSetName, beforeMemberName, afterMemberName)

Rename a data set member

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
dataSetName string - the name of the data set the member belongs to
beforeMemberName string - the current name of the member
afterMemberName string - the new name of the member

# ync(session, afterDataSetName, beforeDataSet)

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
afterDataSetName string - The new name of the data set in the form 'dataset(member)'
beforeDataSet IDataSet - The data set you are renaming

# Unmount()

This class holds helper functions that are used to unmount file systems through the z/OS MF APIs

# ync(session, fileSystemName, options)

Unmount a Unix file system

Parameters

Name Types Description
session AbstractSession - z/OS MF connection info
fileSystemName string - contains the file system name
options IZosFilesOptions - contains the options to use

# Dirs(dirPath)

Checks if a given directory has sub-directories or not

Parameters

Name Types Description
dirPath string full-path for the directory to check

# edOnOptions(options, context)

helper function to generate the headers based on the options used

Parameters

Name Types Description
options IUploadOptions - upload options
context string - context method from where you call this function (can be "buffer", "stream" or undefined)

# formatStringForDisplay(stringInput)

helper function to prepare file names for display on progress bar

Parameters

Name Types Description
stringInput string input to be formated

# getDirs(dirPath)

Returns an array of sub-directories objects, containing directory name, and full path specification

Parameters

Name Types Description
dirPath full-path for the directory to check

# log()

Get Log

# ync(session, inputFile, dataSetName, options)

Upload content from file to data set

Parameters

Name Types Description
session AbstractSession - z/OS connection info
inputFile string - path to a file
dataSetName string - Name of the data set to write to
options IUploadOptions - Uploading options

Returns

Promise<IZosFilesResponse>

A response indicating the out come

# ync(session, inputDir, dataSetName, options)

Upload content from a directory to a PDS

Parameters

Name Types Description
session AbstractSession - z/OS connection info
inputDir string - path to a file
dataSetName string - Name of the data set to write to
options IUploadOptions - Uploading options

Returns

Promise<IZosFilesResponse>

A response indicating the out come

# ync(session, fileBuffer, dataSetName, options)

Writing data buffer to a data set.

Parameters

Name Types Description
session AbstractSession - z/OS connection info
fileBuffer Buffer - Data buffer to be written
dataSetName string - Name of the data set to write to
options IUploadOptions - Uploading options

Returns

Promise<IZosFilesResponse>

A response indicating the outcome

# ync(session, fileBuffer, dataSetName, options)

Writing data buffer to a data set.

Parameters

Name Types Description
session AbstractSession - z/OS connection info
fileBuffer Buffer - Data buffer to be written
dataSetName string - Name of the data set to write to
options IUploadOptions - Uploading options

Returns

Promise<IZosFilesResponse>

A response indicating the out come

# ync(session, inputPath, dataSetName, options, task)

Upload content from input path to dataSet or PDS members

Parameters

Name Types Description
session AbstractSession - z/OS connection info
inputPath string - User input path to file or directory
dataSetName string - Name of the data set to write to
options IUploadOptions - Uploading options
task - use this to be updated on the current status of the upload operation

Returns

Promise<IZosFilesResponse>

A response indicating the out come

# ync(session, ussname, buffer, options)

Upload content to USS file

Parameters

Name Types Description
session AbstractSession - z/OS connection info
ussname string - Name of the USS file to write to
buffer Buffer - Data to be written
options IUploadOptions - Uploading options

# ync(session, ussname, uploadStream, options)

Upload content to USS file

Parameters

Name Types Description
session AbstractSession - z/OS connection info
ussname string - Name of the USS file to write to
uploadStream Buffer - Data to be written
options IUploadOptions - Uploading options

# ync(session, inputFile, ussname, options)

Upload content from a local file to remote USS file

Parameters

Name Types Description
session - z/OS connection info
inputFile - Path to local file
ussname - Name of USS file to write to
options - Uploading options

# ync(session, inputDirectory, ussname, options)

Upload local directory to USS directory

Parameters

Name Types Description
session AbstractSession - z/OS connection info
inputDirectory string - the path of local directory
ussname string - the name of uss folder
options IUploadOptions - Uploading options

# ync(session, ussname)

Check if USS directory exists

Parameters

Name Types Description
session AbstractSession - z/OS connection info
ussname string - the name of uss folder

Returns

Promise<boolean>

# ync(session, inputDirectory, ussname, options)

Upload directory to USS recursively

Parameters

Name Types Description
session AbstractSession - z/OS connection info
inputDirectory string - the path of local directory
ussname string - the name of uss folder
options IUploadOptions - Uploading options

Returns

null

# dirName()

directory name

# fullPath()

full path specification (on local host)

# binary()

The indicator to upload the data set in binary mode

# fileName()

File name to be uploaded in binary or ascii

# fileNames()

List of file names to be uploaded in binary or asci

# from()

Name of input file

# success()

Upload status

# to()

Name of data set

# ync(session, USSFileName, payload)

Retrieve various details from USS file functions This function uses a JSON payload to retrieve information via zosmf utilities function

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
USSFileName string - contains the file name
payload JSON - contains the options to be sent

# ync(session, type, codeset)

Changes the tag attributes associate with a file using function chtag This function uses a JSON payload to set the information via zosmf utilities function

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
type Tag - enum of chtag type of Test, Binary or Mixed
codeset string - optional string describing codeset e.g. IBM-1047

# ync(session, USSFileName)

Based upon the files chtag value. Identify how the tagging should be interpretted when transferring the contents For example an EBCDIC file would always be converted from it's EBCDIC value to the ASCII An ASCII file value or binary should not be converted. The default value if the tag is not set or in an invalid state correctly is to convert.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
USSFileName string - contains the file name

# ync(session, USSFileName, options)

Check the tags on an existing USS file and update binary and encoding properties on the options object.

Parameters

Name Types Description
session z/OSMF connection info
USSFileName Path to USS file
options Options for downloading a USS file

# ync(session, USSFilePath, newFilePath)

Re-name USS file or directory

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
USSFilePath string - contains the current filepath
newFilePath string - contains the new filepath

# ZosFilesAttributes()

Attributes for a set of files relating to how they will be uploaded to USS

# DEFAULT_FILE_EXTENSION()

Default file extension

# DSN_SEP()

Data set name qualifier separator

# edOnOptions(options)

private method

Common method to build headers given input options object

Parameters

Name Types Description
options IOptions - various options

# et(dataSet)

Break up a dataset name of either: USER.WORK.JCL(TEMPLATE) to user/work/jcl/template Or: USER.WORK.PS to user/work/ps

Parameters

Name Types Description
dataSet string - data set to break up into folders

# formatUnixFilepath(usspath)

Format USS filepaths in the way that the APIs expect (no leading /)

Parameters

Name Types Description
usspath string - the path to format

# generateMemberName(fileName)

Generate member name from input string base on IBM specification

Parameters

Name Types Description
fileName string input name used to generate member name with

Returns

string

generated member name

# getFileListFromPath(inputPath, inFullPathFormat, isIgnoreHidden)

Return an array contain the list of all files in the input path. It does not trevor to directory in the input path.

Parameters

Name Types Description
inputPath string input path to gather file list
inFullPathFormat boolean is the return file path in full path mode flag
isIgnoreHidden boolean is listing hidden files flag

Returns

string[]

Array of all files finds in path

# getFullPath(inputPath)

Get fullpath name from input path.

Parameters

Name Types Description
inputPath string - input path

Returns

string

full path version of the input path

# king(dataSetName)

Check if the input data set name contain masking characters

Parameters

Name Types Description
dataSetName string input data set name to be checked

Returns

boolean

status if data set name contain masking characters

# normalizeNewline(buffer)

Normalize all Windows newline to Unix newline

Parameters

Name Types Description
buffer Buffer data to convert

Returns

Buffer

converted data

# sanitizeUssPathForRestCall(ussPath)

Normanize and URL-encode a USS path to be passed to z/OSMF

Parameters

Name Types Description
ussPath path to sanitize

# ync(session, dataSetName, returnMessage, hsmCommand, options)

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
dataSetName string -The name of the data set to recall
returnMessage string - Message to return based upon command request
hsmCommand any - HsmCommand requested
options IRecallOptions IMigrateOptions

# ZosFilesUtils()

Common IO utilities

# 1.0(session, job, version)

Cancel and purge a job Alternative version of the cancel API accepting an IJob object returned from other APIs such as GetJobs and SubmitJobs

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
job IJob - the job that you want to cancel
version string - version of cancel request

# CancelJobs()

Class to handle deletion of job information

# log()

Getter for brightside logger

# ync(session, jobname, jobid)

Cancel and purge a job

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobname string - job name to be translated into parms object
jobid string - job id to be translated into parms object

# ync(session, parms)

Cancel and purge a job Full version of the API with a parameter object

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ICancelJobParms - parm object (see ICancelJobParms interface for details)

# 1.0(session, job, modifyVersion)

Cancel and purge a job Alternative version of the delete API accepting an IJob object returned from other APIs such as GetJobs and SubmitJobs

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
job IJob - the job that you want to delete
modifyVersion "1.0" "2.0"

# DeleteJobs()

Class to handle deletion of job information

# log()

Getter for brightside logger

# ync(session, jobname, jobid)

Cancel and purge a job

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobname string - job name to be translated into parms object
jobid string - job id to be translated into parms object

# ync(session, parms)

Cancel and purge a job Full version of the API with a parameter object

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms IDeleteJobParms - parm object (see IDeleteJobParms interface for details)

# DEFAULT_JOBS_OUTPUT_DIR()

Default directory where output will be placed

# DEFAULT_JOBS_OUTPUT_FILE_EXT()

Default extension of downloaded folders

# DownloadJobs()

Class to handle downloading of job information

# DownloadJobs.DEFAULT_JOBS_OUTPUT_DIR(jobFile, omitJobidDirectory, outDir)

Get the file where a specified spool file (IJobFile) would be downloaded to

Parameters

Name Types Description
jobFile IJobFile - the spool file that would be downloaded
omitJobidDirectory boolean - if true, the job ID of the jobFile will not be included in the file path
outDir string - parent output directory you would like to download to

# getSpoolDownloadFilePath(parms)

Get the file where a specified spool file (IJobFile) would be downloaded to

Parameters

Name Types Description
parms IDownloadSpoolContentParms - parm object (see IDownloadSpoolContentParms interface for details)

# log()

Getter for brightside logger

# ync(session, jobFile)

Download spool content to a the default download directory

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobFile - spool file to download

# ync(session, parms)

Download all job output (spool content) for a job to a the local directory

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms IDownloadAllSpoolContentParms - parameter object (see IDownloadAllSpoolContentParms for details)

# ync(session, parms)

Download spool content to specified directory

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms IDownloadSpoolContentParms - parm object (see IDownloadSpoolContentParms interface for details)

# GetJobs()

Class to handle obtaining of z/OS batch job information

# getJobs(session)

Get jobs (defaults to the user ID of the session as owner)

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info

# getSpoolContent(session, jobFile)

Get spool content from a job (keeping naming convention patter with this duplication function).

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobFile - the spool file for which you want to retrieve the content

# getSpoolFiles(session, jobname, jobid)

Get a list of all spool files for a job.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobname string - the job name for the job for which you want to get a list of spool files
jobid string - the job ID for the job for which you want to get a list of spool files

# getSpoolFilesForJob(session, job)

Get a list of all job spool files for a job Alternate version of the API that accepts an IJob object returned by other APIs such as SubmitJobs.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
job IJob - the job for which you would like to get a list of job spool files

# ync(session, prefix)

Get jobs that match a job name preixl Defaults to jobs owned by the user ID in the session.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
prefix string - job name prefix for which to list jobs. Supports wildcard e.g. JOBNM* returns jobs with names starting with "JOBNM"

# ync(session, owner)

Get jobs that are owned by a certain user or pattern of users

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
owner string - owner for which to get jobs. Supports wildcard e.g. IBMU* returns jobs owned by all users whose ID beings with "IBMU"

# ync(session, owner, prefix)

Get a list of jobs that match an owner and prefix

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
owner string - owner for which to get jobs. Supports wildcard e.g. IBMU* returns jobs owned by all users whose ID beings with "IBMU"
prefix string - prefix for which to get jobs. Supports wildcard e.g. JOBNM* returns jobs with names starting with "JOBNM"

# ync(session, )

Get a list of jobs that match various parameters

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
string

# ync(session, jobid)

Get a single job object from an input job id

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobid string - the job ID for the job for which you want to get status

# ync(session, params)

Get jobs filtered by owner and prefix.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
params IGetJobsParms - parm object (see IGetJobsParms interface for details)

# ync(session, jobname, jobid)

Get the status and other details (e.g. owner, return code) for a job

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobname string - the job name for the job for which you want to get status
jobid string - the job ID for the job for which you want to get status

# ync(session, job)

Get the status and other details (e.g. owner, return code) for a job Alternate version of the API that accepts an IJob object returned by other APIs such as SubmitJobs. Even though the parameter and return value are of the same type, the IJob object returned will have the current status of the job.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
job IJob - job object

# ync(session, parms)

Get the status and other details (e.g. owner, return code) for a job

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ICommonJobParms - parm object (see ICommonJobParms interface for details)

# ync(session, parms)

Get a list of all job spool files for a job.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ICommonJobParms - parm object (see for details)

# ync(session, jobname, jobid)

Get JCL from a job.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobname string - the job name for the job for which you want to retrieve JCL
jobid string - the job ID for the job for which you want to retrieve JCL

# ync(session, job)

Get JCL from a job. Alternate version of the API that accepts an IJob object returned by other APIs such as SubmitJobs.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
job IJob - the job for which you would like to retrieve JCL

# ync(session, parms)

Get the JCL that was used to submit a job.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ICommonJobParms - parm object (see ICommonJobParms interface for details)

# ync(session, jobname, jobid, spoolId)

Get spool content from a job using the job name, job ID, and spool ID number from z/OSMF

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobname - the job name for the job containing the spool content
jobid - the job id for the job containing the spool content
spoolId - id number assigned by zosmf that identifies the particular job spool file (DD)

# ync(session, jobFile)

Get spool content from a job.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobFile - the spool file for which you want to retrieve the content

# 2.0()

Default version of cancel

# COMBO_ID()

Query parm delimiter

# DEFAULT_MAX_JOBS()

Maximum number of jobs to obtain

# DEFAULT_PREFIX()

Wildcard prefix

# DEFAULT_STATUS()

Maximum number of jobs to obtain

# E()

Release a job

# EXEC_DATA()

Execution data query string

# JobsConstants()

Constants for various job related info

# QUERY_ID()

Query identifier

# QUERY_JOBID()

Query id for getting a specific job id

# QUERY_MAX_JOBS()

Query id for getting max jobs

# QUERY_OWNER()

Query id for getting job by an owner

# QUERY_PREFIX()

Query id for getting a job by prefix

# QUERY_STATUS()

Query id for getting a specific job id

# RESOURCE()

URI base jobs API

# RESOURCE_JCL_CONTENT()

URI endpoint for getting JCL

# RESOURCE_SPOOL_CONTENT()

URI endpoint for getting spool files

# RESOURCE_SPOOL_FILES()

URI endpoint for getting spool file content

# STEP_DATA()

Step data query string

# missingDirectoryOption()

Message indicating that the "directory" option needs to be used if "extension" was used

# missingJcl()

Message indicating that no JCL source was given

# missingUssFilePath()

Message indicating that the USS file path is required

# ZosJobsMessages()

Messages to be used as command responses for different scenarios

# log()

# ModifyJobs()

Class to handle modify of jobclass and holdStatus information

# ync(session, parms, options)

Modify a job

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms IModifyJobParms - parms object (see IModifyJobParms interface for details)
options IModifyJobOptions - options object (see IModifyJobOptions interface for details)

# ync(session, parms, options)

Modify a job Full version of the API with a parameter object

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms IModifyJobParms - parm object (see IModifyJobParms interface for details)
options IModifyJobOptions - options object (see IModifyJobOptions interface for details)

# constructErrorMsg(parms, details)

private method

Constructs the default error message (to be thrown via ImperativeError) for the monitor jobs APIs

Parameters

Name Types Description
parms IMonitorJobWaitForParms - The parameters passed to the API
details string - Additional error details string

# JOB_STATUS.OUTPUT()

Default expected job status ("OUTPUT")

# Logger.getAppLogger()

private method

Obtain an instance of the app logger (Brightside).

# MonitorJobs()

APIs for monitoring the status of a job. Use these APIs to wait for a job to enter the specified status. All APIs in monitor jobs invoke z/OSMF jobs REST endpoints to obtain job status information.

# waitForJobOutputStatus(session, job)

Given an IJob (has jobname/jobid), waits for the status of the job to be "OUTPUT". This API will poll for the OUTPUT status once every 3 seconds indefinitely. If the polling interval/duration is NOT sufficient, use "waitForStatusCommon" to adjust. See JSDoc for "waitForStatusCommon" for full details on polling and other logic.

Parameters

Name Types Description
session AbstractSession - a Rest client session for z/OSMF
job IJob - the z/OS job to wait for (see z/OSMF Jobs APIs for details)

# waitForOutputStatus(session, jobname, jobid)

Given the jobname/jobid, waits for the status of the job to be "OUTPUT". This API will poll for the OUTPUT status once every 3 seconds indefinitely. If the polling interval/duration is NOT sufficient, use "waitForStatusCommon" to adjust. See JSDoc for "waitForStatusCommon" for full details on polling and other logic.

Parameters

Name Types Description
session AbstractSession - a Rest client session for z/OSMF
jobname string - the z/OS jobname of the job to wait for output status (see z/OSMF Jobs APIs for details)
jobid string - the z/OS jobid of the job to wait for output status (see z/OSMF Jobs APIS for details)

# ync(session, parms)

Given jobname/jobid, checks for the desired "status" (default is "OUTPUT") continuously (based on the interval and attempts specified). The "order" of natural job status is INPUT > ACTIVE > OUTPUT. If the requested status is earlier in the sequence than the current status of the job, then the method returns immediately (since the job will never enter the requested status) with the current status of the job.

Parameters

Name Types Description
session AbstractSession - a Rest client session for z/OSMF
parms IMonitorJobWaitForParms - monitor jobs parameters (see interface for details)

# ync(session, parms)

private method

"Polls" (sets timeouts and continuously checks) for the status of the job to match the desired status.

Parameters

Name Types Description
session AbstractSession - a Rest client session for z/OSMF
parms IMonitorJobWaitForParms - The monitor jobs parms (see interface for details)

# ync(session, parms)

private method

Checks the status of the job for the expected status (OR that the job has progressed passed the expected status).

Parameters

Name Types Description
session AbstractSession - the session to initiate the z/OSMF getJobStatus request
parms IMonitorJobWaitForParms - the monitor jobs parameters containing the jobname, jobid, status, etc.

# et(session, jobDataSet)

Submit a job that resides in a z/OS data set.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobDataSet string - job data set to be translated into parms object

# formSubstitutionHeader(symName, symDefs, valStartInx, valEndInx)

Form a header used for JCL symbol substitution

Parameters

Name Types Description
symName string The name of the JCL substitution symbol
symDefs string The CLI argument that contains all of the JCL substitution symbol definitions
valStartInx string Index into symDefs to the start of the value for symName.
valEndInx string Index into symDefs that is one past the end of the value for symName.

# getSubstitutionHeaders(symbols)

Parse input string for JCL substitution

Parameters

Name Types Description
symbols string - JCL substitution symbols

# log()

Getter for brightside logger

# submitJcl(session, jcl, internalReaderRecfm, internalReaderLrecl)

Submit a string of JCL to run

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jcl string - string of JCL that you want to be submit
internalReaderRecfm string - record format of the jcl you want to submit. "F" (fixed) or "V" (variable)
internalReaderLrecl string - logical record length of the jcl you want to submit

# SubmitJobs()

Class to handle submitting of z/OS batch jobs via z/OSMF

# submitUSSJob(session, jobUSSFile)

Submit a job that resides in a USS File.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobUSSFile string - job USS File to be translated into parms object

# ync(session, parms)

Submit a job that resides in a z/OS data set or USS file.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ISubmitJobParms - parm object (see for details)

# ync(session, parms)

Submit a JCL string to run

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ISubmitJclParms - parm object (see for details)

# ync(session, jcl, internalReaderRecfm, internalReaderLrecl)

Submit a JCL string to run

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jcl string - string of JCL that you want to be submit
internalReaderRecfm string - record format of the jcl you want to submit. "F" (fixed) or "V" (variable).
internalReaderLrecl string - logical record length of the jcl you want to submit

# ync(session, parms)

Submit a job from a string of JCL and be notified whenever it reaches the default status on a default polling interval.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ISubmitJclNotifyParm - parm object (see for details)

# ync(session, jobDataSet)

Submit a job and be notified whenever it reaches the default status on a default polling interval.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobDataSet string - job data set to be translated into parms object with assumed defaults

# ync(session, jobUSSFile)

Submit a job and be notified whenever it reaches the default status on a default polling interval.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
jobUSSFile string - job USS file to be translated into parms object with assumed defaults

# ync(session, parms)

Submit a job from a data set and be notified whenever it reaches a certain status. If not status is specified, MonitorJobs.DEFAULT_STATUS is assumed. The polling interval can also be optionally controlled via parms.watchDelay. If not specified, the default polling is MonitorJobs.DEFAULT_WATCH_DELAY.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ISubmitJobNotifyParm - parm object (see for details)

# ync(session, parms, responseJobInfo)

Common method to handle job submit options

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
parms ISubmitParms - Submit options
responseJobInfo IJob - job document for a previously submitted job

# ync(session, job, status, watchDelay)

private method

Common method to watch for a job to reach a certain status whether the job was submitted through raw JCL statement or through a data set containing JCL.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
job IJob - job document for a previously submitted job
status JOB_STATUS - status that we want this job to reach before notifying
watchDelay number - delay / interval to poll

# request()

"cancel" is currently the only valid value

# version()

Version, at the time of writing, 1.0 or 2.0 are accepted.

# jobid()

job id for the job you want to cancel

# jobname()

job name for the job you want to cancel

# jobid()

job id for a job

# jobname()

job name for a job

# 1.0()

Optional Version of the X-IBM-Job-Modify-Version header to use (see ZosmfHeaders) If omitted, functionality is the same as if specifying "1.0" - the deletion of the job is asynchronous If "2.0" is specified, the cancel and purge is synchronous

# jobid()

job id for the job you want to delete

# jobname()

job name for the job you want to delete

# jobid()

JOB ID of the job for which you want to download all output e.g. JOB00001

# jobname()

Name of the job for which you want to download all output e.g. MYJOBNM

# s()

updated class for job

# e()

specify this option as true when wanting to release your job

# s()

new job class to change job to

# jobid()

job id for the job you want to change

# jobname()

job name for the job you want to change

# jobid()

The z/OS JOBID for the job to monitor. No pre-validation of the JOBID (other than its presence) is performed. Any errors that you receive regarding invalid JOBID/JOBNAME will be surfaced by z/OSMF. Ensure that your JOBID specification adheres to the z/OS standards.

# jobname()

The z/OS JOBNAME for the job to monitor. No pre-validation of the JOBNAME (other than its presence) is performed. Any errors that you receive regarding invalid JOBID/JOBNAME will be surfaced by z/OSMF. Ensure that your JOBNAME specification adheres to the z/OS standards.

# jcl()

JCL to submit, for example: "//IEFBR14 JOB ()\n" + "//RUN EXEC PGM=IEFBR14"

# jcl()

JCL to submit, for example: "//IEFBR14 JOB ()\n" + "//RUN EXEC PGM=IEFBR14"

# et()

z/OS data set which should contain syntactically correct JCL Example value: IBMUSER.PUBLIC.CNTL(IEFBR14) where IEFBR14 contains statements like: //IEFBR14 JOB () //RUN EXEC PGM=IEFBR14

# et()

z/OS data set which should contain syntactically correct JCL Example value: IBMUSER.PUBLIC.CNTL(IEFBR14) where IEFBR14 contains statements like: //IEFBR14 JOB () //RUN EXEC PGM=IEFBR14

# jobUSSFile()

USS File which should contain syntactically correct JCL Example value: /u/users/ibmuser/iefbr14.jcl where the file contains statements like: //IEFBR14 JOB () //RUN EXEC PGM=IEFBR14

# jclSource()

USS file which should contain syntactically correct JCL Example value: IBMUSER.PUBLIC.CNTL(IEFBR14) where IEFBR14 contains statements like: //IEFBR14 JOB () //RUN EXEC PGM=IEFBR14

# k()

Task status object used by CLI handlers to create progress bars for certain job submit requests Optional

# e()

job phase

# e()

job phase name

# jobid()

job id for a job Uniquely identifies a job on a z/OS system

# jobname()

job name for a job

# on()

explaination of error

# owner()

owner of the job

# retcode()

return code of the job

# s()

job class

# status()

status of the job

# subsystem()

The primary or secondary JES subsystem. If this value is null, the job was processed by the primary subsystem.

# type()

type of job

# url()

url for direct reference of job info

# jobid()

job id for a job

# jobname()

job name for a job

# retcode()

return code of the job

# s()

Job class

# category()

Category error number

# message()

z/OSMF error message

# on()

Reason code number

# rc()

Return code number

# stack()

Stack info

# jobid()

job id for a job

# jobname()

job name for a job

# member()

Member

# message()

Message

# owner()

Job owner

# status()

status of the job

# sysname()

System name

# ddname()

DD name of job spool file

# id()

Identifier for this spool file. each IJobFile for a single batch job will have a unique ID

# jobid()

job id for a job Uniquely identifies a job on a z/OS system

# jobname()

job name for a job

# lrecl()

Job DD lrecl (logical record length - how many bytes each record is)

# procstep()

If this spool file was produced during a job procedure step, the name of the step will be here.

# recfm()

Record format of the spool file (DD)

# s()

Job class for which job ran

# stepname()

The name of the job step during which this spool file was produced

# subsystem()

The primary or secondary JES subsystem. If this value is null, the job was processed by the primary subsystem.

# ddname()

DD name of job spool file

# id()

ID of job that was submitted

# stepname()

Step for which job dd exists

# active()

ACtive

# smfid()

smfid

# jobid()

job id for a job

# jobname()

job name for a job

# retcode()

return code of the job

# status()

status of the job

# data()

Content of the spool file

# ddName()

DD name of job spool file

# id()

Identifier for this spool file.

# procName()

If this spool file was produced during a job procedure step, the name of the step will be here

# stepName()

The name of the job step during which this spool file was produced

# getResourcePath(commandParms)

Get resource path for z/OSMF log restful api

Parameters

Name Types Description
commandParms IZosLogParms params to compose the resource path

Returns

string

resource path

# GetZosLog()

Get zos log via z/OSMF restful api

# ync(session, commandParms)

Issue an z/OSMF log command, returns "raw" z/OSMF response

Parameters

Name Types Description
session AbstractSession representing connection to this api
commandParms IZosLogParms log api parameters, @see {IZosLogParms}

Returns

Promise<IZosLogType>

command response , @see {IZosLogType}

# GetZosLogValidator()

Class validates parameters for GetZosLog

# validateSession(session)

Validate session

Parameters

Name Types Description
session AbstractSession representing connection to this api

# noSessionMessage()

Error message that no session provided.

# cart()

Eight character command and response token (CART).

# color()

The color of the message.

# jobName()

The name of the job that generates the message.

# message()

The content of the message.

# messageId()

The message ID.

# replyId()

Reply ID, in decimal.

# subType()

Indicate whether the message is a DOM, WTOR, or HOLD message.

# system()

Original eight character system name.

# time()

For example, “Thu Feb 03 03:00 GMT 2021”.

# timestamp()

UNIX timestamp. For example, 1621920830109.

# type()

“HARDCOPY”.

# items()

JSON array of messages

# nextTimestamp()

The UNIX timestamp. This value could be used in a subsequent request tospecify a starting timestamp. Logs in the “nextTimestamp” are not returned in the current response.

# source()

Indicates the source of the log. Value "OPERLOG" indicates the operations log.

# timezone()

Specify the timezone of the z/OS system. Valid values for the timezone rangefrom -12 to 12. For example, "-3" means UTC-3 timezone.

# totalitems()

Total number of messages returned in the response.

# CheckStatus()

This class holds the helper functions that are used to gather zosmf information throgh the z/OSMF APIs.

# log()

Get Log

# ync(session)

Get z/OSMF information

Parameters

Name Types Description
session AbstractSession z/OSMF connection info.

# ListDefinedSystems()

This class is used to list the systems defined to z/OSMF throgh the z/OSMF APIs.

# ync(session)

List systems defined to z/OSMF

Parameters

Name Types Description
session AbstractSession z/OSMF connection info.

# console()

Returns the console interface for the command handler

# data()

Returns the format interface for the command handler

# fail(err)

Fail the command with an imperative error

Parameters

Name Types Description
err IImperativeError - the imperative error parameters

# format()

Returns the format interface for the command handler

# mArguments()

Command line arguments passed

# mHandlerParams()

Full set of command handler parameters from imperative

# mSession()

The session creating from the command line arguments / profile

# mZosmfLoadedProfile()

Loaded z/OSMF profile with meta information

# mZosmfProfile()

Loaded z/OSMF profile if needed

# processCmd(commandParameters)

This is called by the {@link ZosmfBaseHandler#process} after it creates a session.

Parameters

Name Types Description
commandParameters IHandlerParameters Command parameters sent to the handler.

# progress()

Returns the format interface for the command handler

# ync(commandParameters)

This will grab the arguments and create a session before calling the subclass {@link ZosmfBaseHandler#processWithSession} method.

Parameters

Name Types Description
commandParameters IHandlerParameters Command parameters sent by imperative.

# ZosmfBaseHandler()

This class is used by the various handlers in the project as the base class for their implementation.

# createSessCfgFromArgs(args)

Given command line arguments, create an session configuration object.

Parameters

Name Types Description
args ICommandArguments - The arguments specified by the user

# E()

Option used to specify the path to the certificate file for authentication

# E_PATH()

Option used in profile creation and commands for base path setting for connecting to z/OSMF

# SWORD()

Option used in profile creation and commands for password/passphrase for z/OSMF

# ZOSMF_CONNECTION_OPTIONS()

Options related to connecting to z/OSMF These options can be filled in if the user creates a profile

# ZOSMF_OPTION_CERT_FILE()

Option used to specify the path to the certificate file for authentication

# ZOSMF_OPTION_CERT_KEY_FILE()

Option used to specify the path to the cert's key file for authentication

# ZOSMF_OPTION_HOST()

Option used in profile creation and commands for hostname for z/OSMF

# ZOSMF_OPTION_PORT()

Option used in profile creation and commands for port for z/OSMF

# ZOSMF_OPTION_PROTOCOL()

Option used to specify HTTP or HTTPS Protocol

# ZOSMF_OPTION_REJECT_UNAUTHORIZED()

Option used in profile creation and commands for rejectUnauthorized setting for connecting to z/OSMF

# ZOSMF_OPTION_USER()

Option used in profile creation and commands for username / ID for z/OSMF

# ZosmfSession()

Utility Methods for Brightside

# ZosmfSession.ZOSMF_OPTION_HOST()

Option used in profile creation and commands for hostname for z/OSMF

# ZosmfSession.ZOSMF_OPTION_PASSWORD()

Option used in profile creation and commands for password/passphrase for z/OSMF

# ZosmfSession.ZOSMF_OPTION_USER()

Option used in profile creation and commands for username / ID for z/OSMF

# BAD_HOST_NAME()

Error code when unable to connect to host

# BAD_PORT()

Error code when unable to connect to port

# ERROR_CODES()

Known error codes return by the API

# INFO()

indicator for get info request

# RESOURCE()

Specifies the z/OS data set and file REST interface

# responseTimeout()

The files timeout header value

# SELF_SIGNED_CERT_IN_CHAIN()

Error code when self signed certificate in chain

# SYSTEMS()

indicator for get defined systems in zosmf

# TOPOLOGY()

indicator for get topology services

# UNABLE_TO_VERIFY_LEAF_SIGNATURE()

Error code when unable to verify the first certificate

# ZosFilesOptions()

Object containing all options to be used by the Download data set API

# ZosmfConstants()

Constants to be used by the z/OSMF API

# improperRejectUnauthorized()

Message indicate that the rejectUnauthorized flag was not set properly

# invalidHostName()

Message indicate that unable to connect to specified host name

# invalidPort()

Message indicate that unable to establish connection with specified port number

# missingSession()

Message indicate that input session object is invalid

# ZosmfMessages()

Messages to be used as detail display error message when gathering z/OSMF information

# ZosmfProfile()

Profile configuration for ZOSMF profiles

# items()

Properties of each defined system.

# numRows()

Total items returned.

# IssueTso()

Class to handle issue command to TSO

# ync(session, accountNumber, command, startParams)

API method to start a TSO address space, issue a command, collect responses until prompt is reached, and terminate the address space.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
accountNumber string - accounting info for Jobs
command string - command text to issue to the TSO address space.
startParams IStartTsoParms - optional object with required parameters for starting TSO address space, @see {IStartTsoParms}

# ync(session, commandParms)

API method to start a TSO address space with provided parameters, issue a command, collect responses until prompt is reached, and terminate the address space.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
commandParms IIssueTsoParms - object with required parameters, @see {IIssueTsoParms}

# getResource(servletKey)

Get resource path for ping command

Parameters

Name Types Description
servletKey string servelet key from start API method

Returns

string

resource path

# ync(session, servletKey, res)

Issue a TSO Ping command, returns @param {IPingResponse} result, @see {IPingResponse}

Parameters

Name Types Description
session AbstractSession representing connection to this api
servletKey string servletkey for address space to ping, generated by start command
res IZosmfPingResponse raw ZOS/MF response

Returns

IPingResponse

# createResponse(allResponses, messages)

Creates ISendResponse object and fills with data

Parameters

Name Types Description
allResponses IZosmfTsoResponse[] - array of all collected responses
messages string - concatenated messages from responses

# SendTso()

Class to handle sending data to TSO

# ync(session, servletKey, data)

API method to send data to already started TSO address space, but will read TSO data until a PROMPT is reached.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
servletKey string - servlet key returned from a successful start
data string - data to send to the TSO address space.

# ync(session, commandParams)

API method to send data to already started TSO address space

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
commandParams IStartTsoParms - object with required parameters, @see {ISendTsoParms}

# ync(session, servletKey)

API method is used to get response data from a TSO address space.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
servletKey String - servlet key of address space

# ync(session, tso)

Collects responses from address space until it reaches prompt

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
tso IZosmfTsoResponse - object from first API call from witch responses are needed

# getResourcesQuery(parms)

Builds a resources query from passed parameters which is needed for z/OSMF api URI.

Parameters

Name Types Description
parms IStartTsoParms - object with required parameters, @see {IStartTsoParms}

# setDefaultAddressSpaceParams(parms, accountNumber)

Sets required parameters by default if not provided. If some parameters provided it uses received and the rest required parameters will be default

Parameters

Name Types Description
parms IStartTsoParms - object with required parameters, @see {IStartTsoParms}
accountNumber string - this key of IStartTsoParms required, because it cannot be default.

# startCommon(session, commandParms)

Start TSO address space with provided parameters

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
commandParms IStartTsoParms - object with required parameters, @see {IStartTsoParms}

# StartTso()

Start TSO address space and receive servlet key

# ync(session, accountNumber, parms)

Start TSO address space with provided parameters.

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
accountNumber string - this key of IStartTsoParms required, because it cannot be default.
parms IStartTsoParms - optional object with required parameters, @see {IStartTsoParms}

# getResources(servletKey)

Generates query parameter needed for z/OSMF REST call

Parameters

Name Types Description
servletKey string - unique servlet entry identifier

# StopTso()

Stop active TSO address space using servlet key

# ync(session, commandParms)

Sends REST call to z/OSMF for stoping active TSO address space

Parameters

Name Types Description
session AbstractSession - z/OSMF connection info
commandParms IStopTsoParms - object with required parameters, @see {IStopTsoParms}

# ync(session, servKey)

Stop TSO address space and populates response with IStartStopResponse, @see {IStartStopResponse}

Parameters

Name Types Description
session AbstractSession
servKey string - unique servlet entry identifier

# DEFAULT_CHSET()

Default character-set value

# DEFAULT_COLS()

Default number of columns value

# DEFAULT_CPAGE()

Default code page value

# DEFAULT_PROC()

Default logonProcedure value

# DEFAULT_ROWS()

Default number of rows value

# DEFAULT_RSIZE()

Default region-size value

# noAccountNumber()

No account number was provided error message

# noCommandInput()

No command text was provided error message

# noDataInput()

No data parameter string was supplied error message

# noPingInput()

No servlet key was provided for Ping command error message

# noServletKeyInput()

No servlet key was provided error message

# noSessionTso()

No Session provided error message

# noTsoIssueInput()

No input parameters were provided error message

# noTsoStartInput()

No input parameters were provided error message

# noTsoStopInput()

No input parameters for stop were provided error message

# noZosmfResponse()

No ZOSMF response was received error message

# PARM_ACCT()

Quert id of account number passed to z/OSMF URI

# PARM_CHSET()

Quert id of character-set passed to z/OSMF URI

# PARM_COLS()

Quert id of columns passed to z/OSMF URI

# PARM_CPAGE()

Quert id of code page passed to z/OSMF URI

# PARM_PROC()

Quert id of logonProcedure passed to z/OSMF URI

# PARM_ROWS()

Quert id of rows passed to z/OSMF URI

# PARM_RSIZE()

Quert id of region size passed to z/OSMF URI

# RES_DONT_READ_REPLY()

Param for not reading reply

# RES_START_TSO()

URI for starting TSO

# RESOURCE()

URI base for TSO API

# TsoConstants()

Constants for TSO related info

# TsoConstants.RESOURCE()

URI for TSO Ping API

# populatePing(zosmfResponse)

Populates ping command response with z/OSMF response details

Parameters

Name Types Description
zosmfResponse IZosmfPingResponse - z/OSMF response object, @see {IZosmfPingResponse}

# populateStartAndStop(zosmfResponse)

Populates start and stop commands response with z/OSMF response details

Parameters

Name Types Description
zosmfResponse IZosmfTsoResponse - z/OSMF response object, @see {IZosmfTsoResponse}

# populateStartAndStopCollectAll(zosmfResponse, collectedResponses)

Populates start and stop commands response with z/OSMF response details

Parameters

Name Types Description
zosmfResponse IZosmfTsoResponse - z/OSMF response object, @see {IZosmfTsoResponse}
collectedResponses ICollectedResponses - collected z/OSMF responses object, @see {ICollectedResponses}

# TsoResponseService()

Filter responses from z/OSMF

# TsoValidator()

Class validates parameters for TSO commands

# validateErrorMessageFromZosmf(zosmfResponse)

Validate z/OSMF response for errors

Parameters

Name Types Description
zosmfResponse IZosmfTsoResponse - object response from z/OSMF, @see {IZosmfTsoResponse}

# validateIssueParams(parms)

Validate TSO issue command parameters

Parameters

Name Types Description
parms IStartTsoParms - object with required parameters, @see {IIssueTsoParms}

# validateNotEmptyString(text, errorMsg)

Validate supplied parameters

Parameters

Name Types Description
text string - string to check if empty
errorMsg string - message to show in text case validation fails

# validatePingParms(session, text, errorMsg)

Validate supplied parameters

Parameters

Name Types Description
session AbstractSession - representing connection to this api
text string - string to check if not empty or undefined
errorMsg string - message to show in text case validation fails