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.
z/OS UNIX System Services
| RSE CLI plug-in command | Zowe CLI z/OSMF command | Options | Description | RSE API version available |
|---|---|---|---|---|
zowe rse ls uss "/u/user" | zowe files ls uss "/u/user" | List z/OS UNIX System Services files using a path to search. | v1.0.0 | |
zowe rse create file "/u/user/newFile" | zowe files create file "/u/user/newFile" | --mode | Create a z/OS UNIX System Services 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" | --mode | Create a z/OS UNIX System Services 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 z/OS UNIX System Services files. | v1.0.0 | |
zowe rse del uss "/u/user/directoryName" | zowe files del uss "/u/user/directoryName" | Delete z/OS UNIX System Services directories or folders. | v1.0.0 | |
zowe rse dl uf "/path/to/fileName" | zowe files dl uf "/path/to/fileName" | -f, -b, --ec,--lc | Download 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. The --lc command is to specify local encoding. | v1.0.0 |
zowe rse ul ftu "localFile.txt" "/u/user/fileName" | zowe files ul ftu "localFile.txt" "/u/user/fileName" | -b, --ec,--lc | Upload a local file to z/OS UNIX System Services. Specify -b for binary download. The --ec command is to specify an encoding on the host. The --lc command is to specify local encoding. | 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, --ec, --lc | Upload a directory to z/OS UNIX System Services. 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. The --lc command is to specify local encoding. | v1.0.0 |
zowe rse rename uss "/u/user/fileName" "newFileName" | Rename a z/OS UNIX System Services file or directory. | v1.0.0 | ||
zowe rse change properties "/u/user/fileName" | --owner, --group, --permission | Change properties of a z/OS UNIX System Services file or directory. | v1.1.3 | |
zowe rse search uss "/u/user/fileName" "fileName" | N/A | --text, --regex-file-name, --regex-content, --case-sensitive-file-name, --case-sensitive-content, --path-results-only | Search for UNIX files by specifying the path, file name, and text pattern. | v1.1.4 |
zowe rse change clear-tag "/u/user/fileName.txt" | N/A | Clear the tag of the UNIX file specified. | v1.1.4 | |
zowe rse convert unix-file-encoding "/u/user/fileName.txt" 'hostEncoding' 'targetEncoding' | N/A | Converts the encoding of the specified Unix file to target encoding. | v1.0.1 | |
zowe rse copy unix-cross-lpar "/u/user/fileName1.txt" "/u/user/fileName2.txt" | N/A | --target-host, --target-port, --target-user, --target-password, --target-rse-p, --replace | Copy a z/OS UNIX System Services file to another file/directory on the same or different LPAR. Specify --target-host, --target-port, --target-user, --target-password for the target LPAR. Specify --target-rse-p for the target rse profile. Specify --replace in order to force an overwrite of the existing file. | v1.1.6 |
zowe rse move uss "/u/ibmuser/fileName" "/u/ibmuser/newfolder/" | N/A | Move a z/OS UNIX System Services file/directory. | v1.1.0 |
MVS
| RSE CLI plug-in command | Zowe CLI z/OSMF command | Options | Description | RSE API version available |
|---|---|---|---|---|
zowe rse ls ds filter | zowe files ls ds filter | -a | List 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" | --pattern, --rangeNameOffset, --rangeOffset, --numToShow | List 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. The --rangeNameOffset option specifies the start member name of the comparison range to list. It is mutually exclusive with --rangeOffset; please specify only one of them. The --rangeOffset option specifies the start of the member ordering index of the comparison range to list. It is mutually exclusive with --rangeNameOffset; please specify only one of them. The --numToShow option specifies the maximum number of members to be returned. | --pattern available with v1.0.1. --rangeNameOffset,--rangeOffset, --numToShow available with version 1.1.6 |
zowe rse create ds "hlq.dsname" --like "hlq.originalds | zowe files create ds "hlq.dsname" --like "hlq.originalds | --bs, --db, --dt, --rf, --rl, --ss, --vs, --au, --ab, --ps | Allocate 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, --ps | Create 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, --ps | Create 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-file,--lc | Download 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 --lc command is to specify local 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-file, --lc | Download 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. The --lc command is to specify local encoding. | -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-file,--lc | Upload 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. The --lc command is to specify local encoding. | v1.0.0 |
zowe rse ul dtp "localDirectory" "hlq.dsname" | zowe files ul dtp "localDirectory" "hlq.dsname" | --ec, -b, --mappings-file, --lc | Upload 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. The --lc command is to specify local encoding. | 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 toDataSetName | zowe files copy data-set fromDataSetName toDataSetName | Copy a data set or data set member to another data set. | v1.0.3 | |
zowe rse copy data-set-cross-lpar fromDataSetName toDataSetName | zowe files copy data-set-cross-lpar fromDataSetName toDataSetName | --target-host, --target-port, --target-user, --target-password, --target-rse-p, --replace | Copy a data set or data set member to another data set on the same or different LPAR. Specify --target-host, --target-port, --target-user, --target-password for the target LPAR. Specify --target-rse-p for the target rse profile. Specify --replace in order to replace the existing targetDataset. | v1.0.3 |
JES
| RSE CLI plug-in command | Zowe CLI z/OSMF command | Options | Description | RSE API version available |
|---|---|---|---|---|
zowe rse ls js | zowe jobs ls js | -o, -p, -s, -a | List 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). The option -a shows the additional job attributes of the listed jobs. | 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, --ojd, --ec | Download 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. Use the option --ec to specify the EBCDIC code page to be used for encoding the data at the host. | v1.0.0, --ec available with v1.1.6 and v1.2 |
zowe rse submit data-set "hlq.datasetName(jclMember) | zowe jobs submit data-set "hlq.datasetName(jclMember) | --wfo , --wfa , --vasc , -d , -e, --js | Submit a JCL job contained in a data set. The data set can be physical sequential or a PDS member. | --js available with v1.0.9 |
zowe rse submit local-file "path/to/local/file" | zowe jobs submit local-file "path/to/local/file" | --wfo , --wfa , --vasc , -d , -e, --js , --je | Submit a JCL job contained in a local file. Use the option --je to specify the EBCDIC code page to be used for encoding the data at the host. | --js available with v1.0.9, --je available with v1.1.6 and v1.2 |
zowe rse submit stdin | zowe jobs submit stdin | --wfo , --wfa , --vasc , -d , -e, --js , --je | Submit a JCL job passed to the command via the stdin stream. Use the option --je to specify the EBCDIC code page to be used for encoding the data at the host. | --js available with v1.0.9, --je available with v1.1.6 and v1.2 |
zowe rse view job-status-by-jobid JOB00123 | zowe jobs view job-status-by-jobid JOB00123 | -a | View status details of a single z/OS job on spool or JES queues. The option -a shows the additional job attributes of the job. | v1.0.0 |
zowe rse view spool-file-by-id JOB00123 4 | zowe jobs view spool-file-by-id JOB00123 4 | --ec | View the contents of a spool file from a z/OS job on spool or JES queues. Use the option --ec to specify the EBCDIC code page to be used for encoding the data at the host. | v1.0.0, --ec available with v1.1.6 and v1.2 |
zowe rse cancel job JOB03456 | zowe jobs cancel job JOB03456 | Cancel a single job by job ID. | v1.0.0 |
System
| RSE CLI plug-in command | Zowe CLI z/OSMF command | Options | Description | RSE API version available | z/OS Explorer version available |
|---|---|---|---|---|---|
zowe rse check status | zowe zosmf check status | Get system and API information. | v1.0.1 | v3.1.1.26 | |
zowe rse auth login | zowe auth login | Log in to an authentication service to obtain a JSON Web Token. | v1.0.0 | v3.1.1.26 | |
zowe rse auth query | Get back JSON Web Token information if it is not yet expired. | v1.0.0 | v3.1.1.26 | ||
zowe rse auth logout | zowe auth logout | Log out of the authentication service and retire the JSON Web Token. | v1.0.3 | v3.1.1.26 | |
zowe rse issue command "<COMMAND>" | zowe tso issue command "<COMMAND>" | --shell-id | Issue a TSO command. The --shell-id tag allows interactive TSO commands using an Interactive ISPF Gateway. | v1.0.1, --shell-id available v1.0.8 | v3.1.1.26 |
zowe rse issue tso-shell "<COMMAND>" | zowe tso issue command "<COMMAND>" | --shell-id | Issue a TSO command using streaming APIs. The --shell-id tag allows interactive TSO commands using an Interactive ISPF Gateway. | v1.1.0 | v3.1.1.26 |
zowe rse issue unix "<COMMAND>" --cwd "/uss/path/toIssue" | Issue a UNIX command. | v1.0.0 | v3.1.1.26 | ||
zowe rse issue unix-shell "<COMMAND>" --cwd "/uss/path/toIssue" | --env | Issue a UNIX command with streaming output. Use the option --env to specify a comma-separated list of environment variables for the executing shell. | v1.0.5 | v3.2.0.16 | |
zowe rse check conversion-mappings | Download Mappings file from RSE API server. | v1.0.3 | v3.1.1.26 | ||
zowe rse change password currentPassword newPassword | Change z/OS User Password on the Host and update profile's yaml if saved locally. | v1.0.2 | v3.1.1.26 | ||
zowe rse check system-address-space | Display active system address space information. | v1.0.5 | v3.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, --userId | Display all active job address space information. Option tags are used to filter the returned list of data. | v1.0.5, filter options: v1.0.9 | v3.2.0.16 | |
zowe rse check password-expiry | Displays expiration date of user id's password. | v1.1.2 | v3.1.1.26 |
RSE Common Properties
| RSE CLI plug-in command | Zowe CLI z/OSMF command | Options | Description | RSE API version available |
|---|---|---|---|---|
| zowe rse cm copy "global-ns" "backup-ns" | --private | Copy a Common Properties namespace. Use the option --private to specify for private namespace. | v1.1.3 | |
| zowe rse cm create "global-ns" | --private | Create a Common Properties namespace. Use the option --private to specify for private namespace. | v1.1.3 | |
| zowe rse cm delete "global-ns" --path "/path/to/property" | --path, --private | Delete a Common Properties namespace, or delete a property in the namespace indicated by the --path option. Use the option --private to specify for private namespace. | v1.1.3 | |
| zowe rse cm list | --private | List all Common Properties namespaces. Use the option --private to specify for private namespace. | v1.1.3 | |
| zowe rse cm rename "global-ns" "backup-ns" | --private | Rename a Common Properties namespace. Use the option --private to specify for private namespace. | v1.1.3 | |
| zowe rse cm set "global-ns" "/path/to/property" "some-value" | --private, --value-type | Set a property in the namespace. If the value is not a simple string but a number, boolean or JSON string, use --value-type to specify the type. Use the option --private to specify for private namespace. | v1.1.3 | |
| zowe rse cm view "global-ns" --path "/path/to/property" | --path, --private | View all properties in a Common Properties namespace, or a property in the namespace specified by the --path option. Use the option --private to specify for private namespace. | v1.1.3 |
RSE Administrator Commands
| RSE CLI plug-in command | Zowe CLI z/OSMF command | Options | Description | RSE API version available |
|---|---|---|---|---|
| zowe rse admin-commands cancelactivity | --service | Stops all the user's longrunning activities in the specified service. The --service option is used to specify the service to cancel. Accepted services include all(by default),unix-commands, jes-jobs, mvs-and-tso, unix-files, scan-service, common-properties | v1.2.0 |