@zowe/cli-test-utils (master)

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# close()

private method

Server close handler

# constructor(mParms)

Creates an instance of DaemonDecider.

Parameters

# DaemonDecider()

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

# error(err)

private method

Server error handler

Parameters

# 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

# ync(cmdParams)

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

Parameters

# 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

# EnableDaemonHandler()

Handler to enable daemon mode.

# ync(cmdParams)

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

Parameters

# ync(canAskQuestions)

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

Parameters

# 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

# ync(pathToZoweBin, userQuestions)

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

Parameters

# ync(pathToZoweBin)

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

Parameters

# RestartDaemonHandler()

Handler to disable daemon mode.

# ync(cmdParams)

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

Parameters

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# ync(commandParameters)

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

Parameters

# 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

# getFile2(session, args, helper)

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

Parameters

# ync(commandParameters)

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

Parameters

# 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

# 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

# prepareLocalFile(filePath)

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

Parameters

# prepareSpoolDescriptor(spoolDescription)

Parse the spool description and split them into individual properties

Parameters

# responseTimeout()

responseTimeout option

# seqnum()

seqnum option

# ync(string1, string2)

To get the difference string in ternninal or in browser

Parameters

# 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

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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# log()

Use the Brightside logger instead of the imperative logger

# processError(original)

Process an error encountered in the rest client

Parameters

# 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

# 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

Returns

string

Few lines (separated by \n) containing error context

# padLeft(str, len, padChar)

Adds padding in case you want a longer string.

Parameters

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

# trimLineToTerminalWidth(str)

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

Parameters

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

# 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

# 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

# ListInstanceInfo()

Get info about a provisioned instance.

# ync(session, zOSMFVersion, instanceId)

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

Parameters

# getResourcesQuery(zOSMFVersion, instanceId)

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

Parameters

# ListInstanceVariables()

Get variables of the provisioned instance.

# ync(session, zOSMFVersion, instanceId)

This operation returns variables of the provisioned instance.

Parameters

# getResourcesQuery(zOSMFVersion, type, externalName)

Builds URI path from provided parameters.

Parameters

# ListRegistryInstances()

Get info about all provisioned instances.

# ync(session, zOSMFVersion, filteredQuery)

This operation returns registry of provisioned instances.

Parameters

# ync(session, zOSMFVersion, type, externalName)

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

Parameters

# getResourcesQuery(zOSMFVersion, templateName)

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

Parameters

# ListTemplateInfo()

Get info about a template.

# ync(session, zOSMFVersion, templateName)

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

Parameters

# getResourcesQuery(zOSMFVersion, instanceId, actionName)

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

Parameters

# PerformAction()

Perform an action on published software service template.

# ync(session, zOSMFVersion, instanceId, actionName)

Performs an action against a provisioned software service instance.

Parameters

# ProvisionPublishedTemplate()

Provision a published software service template.

# ync(session, zOSMFVersion, templateName, account)

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

Parameters

# ync(session, zOSMFVersion, templateName, optionalParms)

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

Parameters

# 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

# 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

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

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

Parameters

# ProvisioningValidator()

Class validates parameters for provisioning commands.

# validateNotEmptyString(text, errorMsg)

Validate supplied parameters

Parameters

# validateSession(session)

Validate session

Parameters

# validateString(text, errorMsg)

Validate supplied parameters

Parameters

# 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

# ArchivedDeleteWorkflow()

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

# ync(session, workflowKey, zOSMFVersion)

Delete archived workflow

Parameters

# CancelWorkflow()

Class to handle canceling of zOSMF workflow instance

# WorkflowConstants.ZOSMF_VERSION(session, workflowKey, zOSMFVersion)

Cancel a workflow instance

Parameters

# 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

# getTempFile(userId, localFile, customDir)

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

Parameters

# parseProperties(propertiesText)

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

Parameters

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

Create a zOSMF workflow instance using local files

Parameters

# ync(session, localFile, remoteFile)

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

Parameters

# ync(session, ussFileName)

Delete USS file

Parameters

# DeleteWorkflow()

Class to handle deletion of zOSMF workflow instance

# ync(session, workflowKey, zOSMFVersion)

Delete a workflow instance

Parameters

# getResourceQuery(params)

This operation Builds URI path from provided parameters.

Parameters

# 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

# ync(session, workflowName, zOSMFVersion)

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

Parameters

# ync(steps)

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

Parameters

# StartWorkflow()

Class to handle starting of zOSMF workflow instance

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

Create a zOSMF workflow instance

Parameters

# 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

# validateOwner(userID, errorMsg)

Validate supplied parameter

Parameters

# validateParameter(parameterValue, errorMsg)

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

Parameters

# validateSession(session)

Validate session

Parameters

# validateString(text, errorMsg)

Validate supplied parameters

Parameters

# 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

# collectDefConsoleCommon(session, commandResponseKey)

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

Parameters

Returns

Promise<IZosmfCollectResponse>

command response on resolve, @see {IZosmfCollectResponse}

# getFollowUpAttempts(parms)

Parameters

Returns

number

# getResource(consoleName, commandResponseKey)

Get resource path for collect command

Parameters

Returns

string

resource path

# getTimeout(parms)

Parameters

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

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