IBM RSE API Plug-in for Zowe CLI commands

Refer to the following tables for commands that are available in the IBM® RSE API Plug-in for Zowe™ CLI (RSE CLI plug-in) and their equivalent Zowe CLI z/OSMF commands.

USS

RSE CLI plug-in commandZowe CLI z/OSMF commandOptionsDescriptionRSE API version available
zowe rse ls uss "/u/user"zowe files ls uss "/u/user"List USS files using a path to search.v1.0.0
zowe rse create file "/u/user/newFile"zowe files create file "/u/user/newFile"--modeCreate a USS file. --mode states the permissions of the file. If permissions are not entered, the default will be rwxrw-r--.v1.0.0
zowe rse create dir "/u/user/newDirectory"zowe files create dir "/u/user/newDirectory"--modeCreate a USS directory. --mode states the permissions of the directory. If permissions are not entered, the default will be rwxrw-r--.v1.0.0
zowe rse del uss "/u/user/fileName"zowe files del uss "/u/user/fileName"Delete UNIX files.v1.0.0
zowe rse del uss "/u/user/directoryName"zowe files del uss "/u/user/directoryName"Delete UNIX directories or folders.v1.0.0
zowe rse dl uf "/path/to/fileName"zowe files dl uf "/path/to/fileName"-f, -b, --ecDownload a file from the host to local. To download files to a specific location on local, specify the option -f followed by a path and file name of location on local. Specify -b for binary download. The --ec command is to specify an encoding.v1.0.0
zowe rse ul ftu "localFile.txt" "/u/user/fileName"zowe files ul ftu "localFile.txt" "/u/user/fileName"-b, --ecUpload a local file to USS. Specify -b for binary download. The --ec command is to specify an encoding on the host.v1.0.0
zowe rse ul dtu "/path/to/localDir" "/path/to/dirName"zowe files ul dtu "/path/to/localDir" "/path/to/dirName"-r, -b, --ecUpload a directory to USS. To upload the directory recursively, specify the option -r. Specify -b for binary download. The --ec command is to specify an encoding on the host.v1.0.0
zowe rse rename uss "/u/user/fileName" "newFileName"Rename a UNIX file or directory.v1.0.0

MVS

RSE CLI plug-in commandZowe CLI z/OSMF commandOptionsDescriptionRSE API version available
zowe rse ls ds filterzowe files ls ds filter-aList data sets by using a filter to search, for example, name, name.*. To list the data set's attributes, specify the option -a.v1.0.0
zowe rse ls am "hlq.dsname"zowe files ls am "hlq.dsname"--patternList all members of a PDS by using the data set name to search. The --pattern tag can be used for a member filter search on the data set.--pattern available with v1.0.1
zowe rse create ds "hlq.dsname" --like "hlq.originaldszowe files create ds "hlq.dsname" --like "hlq.originalds--bs, --db, --dt, --rf, --rl, --ss, --vs, --au, --ab, --psAllocate a data set like another data set. Options include: block size (bs), device type (dt), directory blocks (db), record format (rf), record length (rl), secondary space (ss), allocation unit (au), average block (ab), primary (ps), and volume serial (vs). If no options are specified to overwritten, all attributes from the like data set will be used.v1.0.7
zowe rse create ps "hlq.dsname"zowe files create ps "hlq.dsname"--bs, --db, --dt, --rf, --rl, --ss, --vs, --au, --ab, --psCreate a sequential data set (PS). Options include: block size (bs), device type (dt), directory blocks (db), record format (rf), record length (rl), secondary space (ss), allocation unit (au), average block (ab), primary (ps), and volume serial (vs). If no options are specified, a default option will be used.v1.0.0
zowe rse create pds "hlq.dsname"zowe files create pds "hlq.dsname"--bs, --db, --dt, --rf, --rl, --ss, --vs, --au, --ab, --psCreate a partitioned data set (PO). Options include: block size (bs), device type (dt), directory blocks (db), record format (rf), record length (rl), secondary space (ss), allocation unit (au), average block (ab), primary (ps), and volume serial (vs). If no options are specified, a default option will be used.v1.0.0
zowe rse create member "hlq.dsname(newmember)"Create a member for a partitioned data set.v1.0.0
zowe rse del ds "hlq.dsname"zowe files del ds "hlq.dsname"Delete sequential (PS) and partitioned (PO) data sets or members.v1.0.0
zowe rse dl ds "hlq.dsname(member)"zowe files dl ds "hlq.dsname(member)"-f, -b, --ec, -e, --mappings-fileDownload a PS data set or a single member of a PO data set from the host to local. Specify -f to indicate the path on local to download to. Specify -e to indicate the extension of the file downloaded on local; if the extension is not indicated, the file will be saved as a text file. Specify -b for binary download. The --ec command is to specify an encoding. The --mappings-file tag will specify location of a non-default mappings file.-b available with v1.0.3
zowe rse dl am "hlq.dsname"zowe files dl am "hlq.dsname"-d, -b, --ec, -e, --mappings-fileDownload all members of a PO data set from the host to local. Specify -d to indicate the directory on local to download to. Specify -e to indicate the extension of the file downloaded on local; if the extension is not indicated, the file will be saved as a text file. Specify -b for binary download. The --ec command is to specify an encoding. The --mappings-file tag will specify location of a non-default mappings file.-b available with v1.0.3
zowe rse ul ftds "localFile.txt" "hlq.dsname"zowe files ul ftds "localFile.txt" "hlq.dsname"--ec, -b, --mappings-fileUpload a local file to the host as a data set. The --ec command is to specify an encoding on the host. Specify -b for binary upload. The --mappings-file tag will specify location of a non-default mappings file.v1.0.0
zowe rse ul dtp "localDirectory" "hlq.dsname"zowe files ul dtp "localDirectory" "hlq.dsname"--ec, -b, --mappings-fileUpload a directory to a PDS. The --ec command is to specify an encoding on the host. Specify -b for binary upload. The --mappings-file tag will specify location of a non-default mappings file.v1.0.0
zowe rse rename data-set "hlq.dsname" "hlq.newdsname"Rename a data set.v1.0.0
zowe rse rename data-set-member "hlq.dsname(memberName)" "newMemberName"Rename a data set member.v1.0.0
zowe rse migrate data-set "hlq.dsname"zowe files migrate data-set "hlq.dsname"Migrate data sets.v1.0.0
zowe rse recall data-set "hlq.dsname"zowe files recall data-set "hlq.dsname"Recall migrated data sets.v1.0.0
zowe rse copy data-set fromDataSetName toDataSetNamezowe files copy data-set fromDataSetName toDataSetNameCopy a data set or data set member to another data set.v1.0.3

JES

RSE CLI plug-in commandZowe CLI z/OSMF commandOptionsDescriptionRSE API version available
zowe rse ls jszowe jobs ls js-o, -p, -sList jobs on JES spool or queues. The option -o indicates the owner of the jobs. The option -p indicates the job's name prefix. The option -s indicates the status of the listed jobs (ALL, ACTIVE, OUTPUT, or INPUT).v1.0.0
zowe rse ls sfbj "jobId"zowe jobs ls sfbj "jobId"List the spool files (DDs) for a z/OS® job on the JES or spool queues for a z/OS job ID.v1.0.0
zowe rse delete job "jobId"zowe jobs delete job "jobId"Delete a single job by job ID.v1.0.0
zowe rse dl o "jobId"zowe jobs dl o "jobId"-d, -e, --ojdDownload job output by job ID. Use the option -d to specify a local directory for the download. Use the option -e to specify a files extension to save the job output with. Use the option --ojd to save the output directly to the specified directory without creating a subdirectory named after the ID of the job.v1.0.0
zowe rse submit data-set "hlq.datasetName(jclMember)zowe jobs submit data-set "hlq.datasetName(jclMember)--wfo , --wfa , --vasc , -d , -eSubmit a JCL job contained in a data set. The data set can be physical sequential or a PDS member.v1.0.0
zowe rse submit local-file "path/to/local/file"zowe jobs submit local-file "path/to/local/file"--wfo , --wfa , --vasc , -d , -eSubmit a JCL job contained in a local file.v1.0.0
zowe rse submit stdinzowe jobs submit stdin--wfo , --wfa , --vasc , -d , -eSubmit a JCL job passed to the command via the stdin stream.v1.0.0
zowe rse view job-status-by-jobid JOB00123zowe jobs view job-status-by-jobid JOB00123View status details of a single z/OS job on spool or JES queues.v1.0.0
zowe rse view spool-file-by-id JOB00123 4zowe jobs view spool-file-by-id JOB00123 4View the contents of a spool file from a z/OS job on spool or JES queues.v1.0.0
zowe rse cancel job JOB03456zowe jobs cancel job JOB03456Cancel a single job by job ID.v1.0.0

System

RSE CLI plug-in commandZowe CLI z/OSMF commandOptionsDescriptionRSE API version availablez/OS Explorer version available
zowe rse check statuszowe zosmf check statusGet system and API information.v1.0.1v3.1.1.26
zowe rse auth loginzowe auth loginLog in to an authentication service to obtain a JSON Web Token.v1.0.0v3.1.1.26
zowe rse auth queryGet back JSON Web Token information if it is not yet expired.v1.0.0v3.1.1.26
zowe rse auth logoutzowe auth logoutLog out of the authentication service and retire the JSON Web Token.v1.0.3v3.1.1.26
zowe rse issue command "<COMMAND>"zowe tso issue command "<COMMAND>"--shell-idIssue a TSO command. The --shell-id tag allows interactive TSO commands using an Interactive ISPF Gatewayopen in new window.v1.0.1, --shell-id available v1.0.8v3.1.1.26
zowe rse issue unix "<COMMAND>" --cwd "/uss/path/toIssue"Issue a UNIX command.v1.0.0v3.1.1.26
zowe rse check conversion-mappingsDownload Mappings file from RSE API server.v1.0.3v3.1.1.26
zowe rse change password currentPassword newPasswordChange z/OS User Password on the Host and update profile's yaml if saved locally.v1.0.2v3.1.1.26
zowe rse check system-address-spaceDisplay active system address space information.v1.0.5v3.2.0.16
zowe rse check job-address-space--asid, --asidx, --bytes, --cpu, --cpu%, --description, --dp, --elapsed, --frames, --hvcomhwm, --hvcomused, --io, --name, --page, --position, --stepio, --subtype, --swapin, --sysName, --task, --task%, --type, --userIdDisplay all active job address space information. Option tags are used to filter the returned list of data.v1.0.5, filter options: v1.0.9v3.2.0.16
Last Updated:
Contributors: Billie Simmons, Billie Jean Simmons, Min Huang, Lauren Li, Billie, shikunli, Billie Simmons, Rudy Leonel Pichola Flores, Shi Kun Li