ZOA Utilities functionality overview

The functionality provided by IBM® Z Open Automation Utilities is categorized as follows.

You can find some simple coding examples of the shell commands and APIs for Java and Python by following the links in the tables. For detailed command and API reference, see ZOA Utilities command and API reference.

MVS program execution utilities

Function Shell Java Python Description
Execute an unauthorized MVS program mvscmd MVSCmd.execute() MVSCmd.execute() Runs an unauthorized MVS command (program) that resides in a PDS or PDSE from the Unix System Services (USS) command line
Execute an authorized MVS program mvscmdauth MVSCmd.executeAuthorized() MVSCmd.execute_authorized() Runs an authorized MVS command (program) that resides in a PDS or PDSE from the Unix System Services (USS) command line

For a sample of how to use ZOA Utilities to work with MVS resources, see Using commands and APIs provided by ZOA Utilities.

Data set manipulation utilities

Function Shell Java Python Description
Check whether a data set exists dls Datasets.exists() Datasets.exists() Lists non-VSAM data sets such as partitioned data sets and sequential data sets
Copy data sets dcp Datasets.copy() Datasets.copy() Copies a fully qualified file (or files) to another file
Note: The file can be a partitioned data set, sequential data set, partitioned data set member, or HFS file.
Compare two data sets ddiff Datasets.compare() Datasets.compare() Compares two files, each of which can be a partitioned data member or sequential data set
Write to a data set decho Datasets.write() Datasets.write() Writes a non-VSAM data set to stdout
Search for text in data sets dgrep Datasets.search() Datasets.search() Searches partitioned data sets, partitioned data set members, and sequential data sets for a string
List data sets dls Datasets.list() Datasets.list() Lists non-VSAM data sets such as partitioned data sets and sequential data sets
Delete data sets drm Datasets.delete() Datasets.delete() Deletes one or more non-VSAM or VSAM data sets
Archive data sets dzip Datasets.zip() Datasets.zip() Archives a set of datasets to a binary file
Restore data sets dunzip Datasets.unzip() Datasets.unzip() Unzips a dzip binary file to the specified HLQ
Replace text in data sets dsed Datasets.findReplace() Datasets.find_replace() Provides basic support for finding and replacing of a string in a partitioned data set, a partitioned data set member, or a sequential data set
Read text in a dataset(all of the file) dtail Datasets.read() Datasets.read() Prints the tail of a partitioned data set member or sequential data set
Read text in a data set (last n lines) dtail Datasets.readLast() Datasets.read_last() Same as above
Read text in a data set (from the nth line) dtail Datasets.readFrom() Datasets.read_from() Same as above
Create a data set dtouch Datasets.create() Datasets.create() Provides a way to allocate a partitioned data set, sequential data set, or VSAM data set
Rename a data set dmv Datasets.rename() Datasets.move() Moves a data set to a new name
List data set members mls Datasets.listMembers() Datasets.list_members() Lists partitioned data set members
Delete data set members mrm Datasets.deleteMembers() Datasets.delete_members() Deletes one or more data set members
Rename a data set member mmv Datasets.renameMember() Datasets.move_member() Moves a partitioned data set member to a new name

JES utilities

Function Shell Java Python Description
Submit a job jsub Jobs.submit() Jobs.submit() Submits a data set that contains JCL
Cancel a job jcan Jobs.cancel() Jobs.cancel() Cancels and purges a job using SDSF REXX
List jobs jls Jobs.list() Jobs.list() Lists jobs that match a pattern
List job DDs ddls Jobs.listDDNames() Jobs.list_dds() Lists ddnames for a given job
List job output for step name pjdd Jobs.readOutput() Jobs.read_output() Lists the output for a given job id and ddname

System concatenation utilities

Function Shell Java Python Description
Get a temporary data set name mvstmp Datasets.genTempName() Datasets.temp_name() Generates a valid MVS data set name that is suitable for use as a temporary data set
Find a member in a concatenation dwhence Datasets.findMember() Datasets.find_member() Searches for a member within a data set concatenation
Display the active link list pll ZSystem.listLinklist() ZSystem.list_linklist() Displays the active link list concatenation
Search link list for a member llwhence ZSystem.findInLinklist() ZSystem.find_linklist() Searches for the data set in the link list that a module comes from
Display the active parmlib pparm ZSystem.listParmlib() ZSystem.list_parmlib() Displays the active parmlib
Search parmlib for a string parmgrep ZSystem.findInParmlib() ZSystem.search_parmlib() Searches for a string across the parmlib concatenation
Search parmlib for a member parmwhence ZSystem.searchParmlib() ZSystem.find_parmlib() Searches for the data set in the parmlib concatenation that a member comes from
Display the active proclib pproc ZSystem.listProclib() ZSystem.list_proclib() Shows the dynamic proclib
Note: This is useful to determine where started tasks are searched for.
Search proclib for a string procgrep ZSystem.findInProclib() ZSystem.search_proclib() Searches for a string across the proclib concatenation
Search proclib for a member procwhence ZSystem.searchProclib() ZSystem.find_proclib() Searches for what data set of the proclib concatenation that a member comes from

Console utility

Function Shell Java Python Description
Display the console log pcon ZSystem.readConsoleLog() ZSystem.read_console() Displays the last minute, hour or day or all of the operator console log

Operator utility

Function Shell Java Python Description
Submit a operator command opercmd OperatorCmd.execute() OperatorCmd.execute() Runs the specified operator command and writes the output to the console

Miscellaneous

Function Shell Java Python Description
Print the current HLQ hlq Datasets.hlq() Datasets.hlq() Returns the active TSO high-level qualifier