Type for the mode option of the mount file-system API.
The possible job status strings (as specified by the z/OSMF documentation). Used in the Jobs APIs for monitoring jobstatus, etc.
z/OSMF options for recall of migrated data sets. See the z/OSMF REST API publication for complete details.
Execute multiple promises in a pool with a maximum number of promises executing at once
limit of how many promises should execute at once
array of objects to convert to promises with iteratorFn
the function that turns an entry in the array into a promise
Loads default z/OSMF profile. The profile must have already been created using Zowe CLI, and not rely on base profiles
The name of the profile type
Whether or not to merge with the base profile
Produces formatted context of a given error in the specified location of the contents
NOTE: The lineIndex is zero-based indexed
Indicates the contents or the file path to the file containing the contents to get the error from
Zero-basd indexed location of the error to be printed
Few lines (separated by \n) containing error context
Retrieves the Zowe CLI home directory. In the situation Imperative has not initialized it we mock a default value.
Adds padding in case you want a longer string.
string to add the padding to
final length of the padded string
Padded string
Utility function to read complete standard in contents from a handler Can be awaited from async methods
This is a simple sleep function to help when waiting for a certain period of time before continuing.
Resolves after the specified time is up.
Trims a given line based on the terminal's width. It also replaces tabs with spaces.
string to be trimmed
Trimmed string
Defaults to be used as options for the different types of data sets that can be created
Specifies all the defaults to create non-vsam data sets
Specifies the defaults used by the Zos Files API to create a data set used for binaries
Specifies the defaults used by the Zos Files API to create a data set used for C code
Specifies the defaults used by the Zos Files API to create a classic data set
Specifies the defaults used by the Zos Files API to create a partitioned data set
Specifies the defaults used by the Zos Files API to create a sequential data set
Specifies the defaults used by the Zos Files API to create a VSAM cluster
Error message that workflow key that was supplied does not exist. IZUWF5001W: The workflow key "workflowkey" was not found.
Constants to be used by the API
Maximum value for primary and secondary allocation
Maximum numbers of characters to allow for the continuation character on AMS statements
Maximum length of an AMS statement
Maximum numbers of days for which to retain a dataset.
Minimum numbers of days for which to retain a dataset.
Specifies the z/OS data set and file REST interface
Indicator of an AMS request
Indicator of a data set request
Indicator the query parameters used to qualify the request
Indicator of a members request
Indicator of a ds file name
Indicator of a z/OS mfs
Indicator of a USS File request
Indicator of a USS File request
Indicator of a z/OS file system request
The set of allocation unit choices for VSAM files
The set of dataset organization choices for VSAM files
Messages to be used as command responses for different scenarios
Message indicating that all data sets matching the provided patterns are archived.
Message indicating that the AMS commands was executed successfully
Message indicating the attributes are used during dataset creation
Messaging indicating an attributes file was not found
Message to be used when throwing an imperative error during dataset creation
Message to be used when throwing an imperative error during dataset creation
Message indicating that the data set was created successfully
Message indicating that the data set has been renamed successfully.
Message indicating that file is uploaded to data set successfully
Message indicating that the data set was copied successfully
Message indicating that the data set was deleted successfully
Message indicating that the data set was deleted successfully.
Message indicating that the data set was downloaded successfully
Message indicating that the data set was migrated successfully.
Message indicating that the data set was recalled successfully.
Message indicating that the data sets matching pattern was downloaded successfully
Message indicating an error parsing an attributes file
Message indicating an error reading an attributes file
Message indicating that the file system was mounted successfully.
Message indicating that the file system was unmounted successfully.
Message indicating invalid 'create' command 'alcunit' option
Messaging indicating invalid syntax in .zosattributes file
Message indicating invalid 'create' command 'dsntype' option
Message indicating invalid 'create' command 'dsorg' option
Message indicating an invalid 'create' command option
Message indicating an invalid 'mount' command option
Message indicating invalid 'mount' command 'mode' option
Message indicating that directory blocks cannot be zero if the data set organization is 'PO'
Message indicating that directory blocks must be zero if the data set organization is 'PS'
Message indicating invalid 'create' command 'perms' option
Message indicating invalid 'create' command 'recfm' option
Message indicating that the AMS commands was too long to be passed to z/OS MF
Message indicating the maximum allocation quantity has been exceeded
Message indicating that the following members failed to properly download
Message indicating that the data set "like" name is required
Message indicating that the data set name is required
Message indicating that the data set type is required
Message indicating that the file system name is required
Message indicating the 'create' command options is null or undefined
Message indicating the 'mount' command options is null or undefined
Message indicating that an expected file system option was not supplied.
Message indicating that the input directory is required
Message indicating that the input directory path is required
Message indicating that the input file is required
Message indicating that the mount point is required
Message indicating that patterns were not passed.
Message indicating that the payload is required
Message indicating 'create' command 'primary' option is required
Message indicating 'create' command 'lrecl' option is required
Message indicating that the request type is required
Message indicating that the AMS statements is required
Message indicating that the USS directory name is required
Message indicating that the USS File name is required
Message indicating that the an expected VSAM option was not supplied.
Message indicating that an expected ZFS option was not supplied.
Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.
Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.
Message indicating that no data sets remain to be downloaded after the excluded ones were filtered out.
Message indicating that the no members were found
Message indicating that a failure has happened in the NodeJS File System API
Message indicating that only empty partitioned data sets match the provided patterns
Message indicating that input path is not a directory
Message indicating that the data set type is unsupported
Message indicating that attempt to upload a directory to a data set member
Message indicating that attempt to upload a directory with multiple files to a physical sequential data set
Message indicating that the uss file or directory crated successfully.
Message indicating that the uss directory was uploaded successfully
Message indicating that the USS file or directory was deleted successfully
Message indicating that the uss file was downloaded successfully
Message indicating that the uss file was uploaded successfully
Message indicating that the an expected VSAM option was not supplied.
Message indicating that the ZFS was created successfully
Message indicating that the ZFS was deleted successfully
Messages to be used as command responses for different scenarios
Message indicating that the "directory" option needs to be used if "extension" was used
Message indicating that no JCL source was given
Message indicating that the USS file path is required
Messages to be used as command responses for different scenarios
Message indicating that the data set type is unsupported
Constants to be used by the z/OSMF API
indicator for get info request
Specifies the z/OS data set and file REST interface
indicator for get defined systems in zosmf
indicator for get topology services
Known error codes return by the API
Error code when unable to connect to host
Error code when unable to connect to port
Error code when self signed certificate in chain
Error code when unable to verify the first certificate
Messages to be used as detail display error message when gathering z/OSMF information
Message indicate that the rejectUnauthorized flag was not set properly
Message indicate that unable to connect to specified host name
Message indicate that unable to establish connection with specified port number
Message indicate that input session object is invalid
Main explanation map object for create provisioned instance variables.
Main explanation map object for provisioned instance prompt variables output.
Main explanation map object for full output.
Main explanation map object for summary output.
Main explanation map object for summary output.
Main explanation map object for full output.
Main explanation map object for summary output.
Main explanation map object for extended provisioned instance output.
Main explanation map object for full provisioned instance output.
Main explanation map object for provisioned instance summary output without variables and actions.
Main explanation map object for provisioned instance summary output with actions.
Main explanation map object for provisioned instance summary output with variables.
Main explanation map object for the output of provisioned instance variables.
Main explanation map object for full output.
Main explanation map object for summary output.
Main explanation map object for full output
Main explanation map object for full output
Main explanation map object for summary output
Main explanation map object for summary output
Main explanation map object for full output.
Main explanation map object for summary output.
Main explanation map object for summary output.
Main explanation map object for workflow-info response output.
No account number was provided error message.
No account number was provided error message
Error message that no template name parameter string was supplied.
No command text was provided error message
No data parameter string was supplied error message
Error message that no instance-id parameter string was supplied.
Error message that no owner parameter string was supplied.
No servlet key was provided for Ping command error message
No servlet key was provided error message
Error message that no session was supplied.
Error message that no session provided.
No Session provided error message
Error message that no steps parameter was supplied.
Error message that no system name parameter string was supplied.
Error message that no template name parameter string was supplied.
No input parameters were provided error message
No input parameters were provided error message
No input parameters for stop were provided error message
Error message that no variables parameter was supplied.
Error message that no workflow definition file parameter string was supplied.
Error message that no workflow key string was supplied.
Error message that no workflow name parameter string was supplied.
No ZOSMF response was received error message
Error message that no z/OSMF version parameter string was supplied.
Explained keys for summary.
Explained keys for all-info. Explained keys for full. Local explanation map for full Explained keys for all-info
Explained keys for summary. Explained keys for summary. Local explanation map for summary Explained keys for summary
Error message that no system name parameter string was supplied.
Generated using TypeDoc
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.