IBM RSE API Plug-in for Zowe CLI commands
Refer to the following tables for the commands 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 with a search path. | 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. The --mode option specifies the file permissions. If no permissions are specified, the default is 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. The --mode option specifies the directory permissions. If no permissions are specified, the default is 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 save the file to a specific location on local, specify the -f option followed by a path and file name. Specify -b for binary download. The --ec option specifies the encoding, while the --lc option specifies the local encoding. | v1.0.0 |
zowe rse download uss-directory "/u/user/ussDir | zowe zos-files download uss-directory /a/ibmuser | -f, -b, --ec,--lc | Download content from a z/OS UNIX System Services directory to a local directory on your PC | v1.1.6 |
zowe rse ul ftu "localFile.txt" "/u/user/fileName" | zowe files ul ftu "localFile.txt" "/u/user/fileName" | -b, --ec, --lc, --append-only | Upload a local file to z/OS UNIX System Services. Specify -b for binary upload. Use --ec to specify the host encoding and --lc to specify the local encoding. Use --append-only to append content to the target file instead of replacing it. | v1.0.0, --append-only is available in v1.2.5 |
zowe rse ul dtu "/path/to/localDir" "/path/to/dirName" | zowe files ul dtu "/path/to/localDir" "/path/to/dirName" | -r, -b, --ec, --lc, --append-only | Upload a directory to z/OS UNIX System Services. Specify -r to upload the directory recursively. Specify -b for binary upload. Use --ec to specify the host encoding and --lc to specify the local encoding. Use --append-only to append to the target files instead of replacing them. | v1.0.0, --append-only is available in v1.2.5 |
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, --disable-symlink-resolution | Search UNIX System Services files using a specified path, file name, and text pattern. | v1.1.4, --disable-symlink-resolution is available with v1.2.3 |
zowe rse change clear-tag "/u/user/fileName.txt" | N/A | Clear the tag of the specified UNIX System Services file. | v1.1.4 | |
zowe rse convert unix-file-encoding "/u/user/fileName.txt" 'hostEncoding' 'targetEncoding' | N/A | Converts the encoding of the specified Unix System Services 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 or directory to another file or directory on the same or a different LPAR. Specify --target-host, --target-port, --target-user, --target-password for the target LPAR. Specify --target-rse-p for the target RSE profile. Use --replace to overwrite 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 or directory. | v1.1.0 | |
zowe rse submit uss-file "/u/user/fileName.jcl" | zowe jobs submit uss-file "/u/user/fileName.jcl"" | --wfo , --wfa , --vasc , -d , -e, --js , --je | Submit a job using the JCL in the specified UNIX System Services file. | v1.1.6 |
zowe rse edit uss-file "/u/user/fileName" | zowe zos-files edit uss-file "/u/user/fileName" | --extension, --editor, --binary, --encoding | Edit the content of a UNIX System Services file | v1.0.0 |
zowe rse compare uss-files "/u/user/test1.txt" "/u/user/test2.txt" | zowe files compare uss-files "/u/user/test1.txt" "/u/user/test2.txt" | --encoding, --context-lines, --browser-view, --seqnum | Compare the contents of two z/OS Unix System Services files in the terminal (stdout). | v1.0.0 |
zowe rse compare local-file-uss-file "./example.txt" "/u/user/test.txt" | zowe files compare local-file-uss-file "./example.txt" "/u/user/test.txt" | --encoding, --context-lines, --browser-view, --seqnum | Compare the contents of a local file and a z/OS Unix file in the terminal (stdout). | v1.0.0 |
zowe rse archive list-files "/u/user/archive.zip" "/u/user/test/" | N/A | List files or directories inside a z/OS UNIX System Services archive | v1.0.5 | |
zowe rse archive get-content "/u/user/archive.zip" "/u/user/test/test.txt" | N/A | --encoding, --binary, --local-encoding, --file | Retrieve the content of an archive file within another archive. Use -b to download the file in binary mode. The --encoding (--ec) option specifies the encoding on the host, while the --local-encoding (--lc) option specifies the local encoding. Use --file (-f) to specify the local path to save the content. | v1.0.5 |
zowe rse archive update-content "/u/user/archive.zip" "/u/user/test/test.txt" --file "local/file" | N/A | --encoding, --binary, --local-encoding, --file | Update the contents of a UNIX file within an archive. Specify the local file to upload using --file (-f). Use -b to upload the file in binary mode. The --encoding (--ec) option specifies the encoding on the host, while the --lc option specifies the local encoding. | v1.0.5 |
zowe rse archive delete "/u/user/archive.zip" "/u/user/test/test.txt" | N/A | Delete a UNIX System Services file or folder within an archive. | v1.0.5 | |
zowe rse archive create-dir "/u/user/archive.zip" "/u/user/test/" | N/A | Create a UNIX directory within an archive. | v1.0.5 | |
zowe rse archive create-file "/u/user/archive.zip" "/u/user/test/test.txt" | N/A | Create a UNIX file within an archive. | v1.0.5 | |
zowe rse archive export-file "/u/user/archive.zip" "/u/user/test/test.txt" --export-path '/u/user/ep/test.txt' | N/A | --export-path | Export a UNIX file or folder from an archive to a destination path on system. | v1.0.5 |
zowe rse archive import-file "/u/user/archive.zip" "/u/user/test/" --import-path '/u/user/ip/test.txt' | N/A | --import-path | Import a UNIX file or folder from a specified import path on system to a relative path within an archive. | v1.0.5 |
zowe rse copy mtu "hlq.dsname" "/u/user/test/" | N/A | --extension | Copy a PDS (Partitioned Data Set), a PDS member, or a sequential dataset (SEQ) to a specified UNIX location. If you want to copy just one member from a PDS, you can provide the member name. Additionally, you can use the --extension option to save the copied file with a specific extension. This option works for both datasets and individual members. For datasets, the extension will be applied to all members within that dataset. | v1.2.3 |
zowe rse copy utm "/u/user/directoryName" "hlq.dsname" | N/A | Copy all the files from a UNIX directory into a PDS (Partitioned Data Set), where each file becomes a member of that PDS. If you only want to copy a single file instead of the entire directory, you can provide the specific file path from the UNIX System Services (USS) instead of the directory path. | v1.2.3 | |
zowe rse list uss-hierarchy "/u/user/test" | N/A | --max-depth, --type, --format, --show-hidden | Retrieve the hierarchy of files or folders under a specified directory. This operation traverses the directory tree and returns all files or folders. By default (--format paths), the command returns a flat list of paths. With --format details, the command returns detailed information. Warning: This operation can be resource-intensive for large directory trees. Use the --max-depth parameter to limit traversal depth. | v1.2.5 |
zowe rse convert unix-folder-encodings "/u/example/myfolder" --local-attributes '/home/user/project/.gitattributes' | N/A | --local-attributes, --remote-attributes, --encoding-map | Converts the encoding of files in a z/OS UNIX System Services directory based on file name pattern rules. Specify exactly one source of encoding rules: a local .gitattributes or .zosattributes file, a remote attributes file in z/OS UNIX System Services, or an inline encoding map. | v1.2.5 |
zowe rse create uss-link "/u/IBM/test" "/u/IBM/link" | N/A | --type | Create a symbolic (soft) or hard link in z/OS UNIX System Services. The --type option specifies the link type: soft (symbolic link, default) or hard (hard link). | v1.2.4 |
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 using a filter to search, such as name, name.*. To display the attributes of each data set, specify the -a option. | 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 using the data set name to search. Use the --pattern option to filter members in the data set. The --rangeNameOffset option specifies the start member name of the comparison range to list. It is mutually exclusive with --rangeOffset; specify only one of them. The --rangeOffset option specifies the start member index of the comparison range to list. It is mutually exclusive with --rangeNameOffset; specify only one of them. The --numToShow option specifies the maximum number of members to return. | --pattern is available in v1.0.1. --rangeNameOffset,--rangeOffset, --numToShow are available in 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, --dp, --ds, --dsu, --ers, --ip, --is --isu, --kl, --ko --rec, --re, --spn, --vt. | Allocate a data set based on the attributes of 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), volume serial (vs), data allocation primary (dp), data allocation secondary (ds), data allocation space unit (dsu), erase (ers), index allocation primary (ip), index allocation secondary (is), index allocation space unit (isu), key length (kl), key offset (ko), recovery (rec), reuse (re), spanned (spn), and VSAM type (vt). Allocate-like for a VSAM data set is available only in v1.2.3 and above. If no options are specified to override, all attributes from the like data set are 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). You can specify attributes such as 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 provided, default options are 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 options are 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 their 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, --non-roundtripable-characters | Download a PS data set or a single member from a PO data set to a local file. Use -f to specify the local path for the downloaded file. Use -e to specify the file extension for the downloaded file. If -e is not specified, the file is saved as a text file. Use -b for binary download. Use --ec to specify the host encoding and --lc to specify the local encoding. The --mappings-file to specify the location of a non-default mappings file. Use --non-roundtripable-characters to return information in the response headers about invalid hexadecimal characters for text-mode downloads, including byte positions (offsets) and hexadecimal values for characters that were not translated during encoding conversion. | -b is available in v1.0.3, --non-roundtripable-characters is available in v1.2.5 |
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 the local. Use -d to specify the local directory where the files should be downloaded. Use -e to define the file extension for the downloaded files; if not specified, the files are saved as text files. Use -b for binary download. The --ec option specifies the encoding, while the --mappings-file option specifies the location of a non-default mappings file. The --lc option specifies the local encoding. | -b is available in v1.0.3 |
zowe rse ul ftds "localFile.txt" "hlq.dsname" | zowe files ul ftds "localFile.txt" "hlq.dsname" | --ec, -b, --mappings-file, --lc, --ft, --append-only | Upload a local file to the host as a data set. Use --ec to specify the host encoding. Use -b for binary upload. Use --mappings-file to specify the location of a non-default mappings file. Use --lc to specify the local encoding. The --ft to enable force truncation during upload. By default, force truncation is disabled. A confirmation prompt is displayed before truncation occurs. Use --append-only to append content to the target data set instead of replacing it. | v1.0.0, --append-only is available in v1.2.5 |
zowe rse ul dtp "localDirectory" "hlq.dsname" | zowe files ul dtp "localDirectory" "hlq.dsname" | --ec, -b, --mappings-file, --lc, --ft, --append-only | Upload a directory to a PDS. Use --ec to specify the host encoding. Use -b for binary upload. Use --mappings-file to specify the location of a non-default mappings file. Use --lc to specify the local encoding. Use --ft to enable force truncation during upload. By default, force truncation is disabled. A confirmation prompt is displayed before truncation occurs. Use --append-only to append content to the target data set members instead of replacing them. | v1.0.0, --append-only is available in v1.2.5 |
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. Use the options --target-host, --target-port, --target-user, --target-password to specify the target LPAR. Use --target-rse-p to define the target RSE profile. Specify --replace to overwrite the existing target data set if it already exists. | v1.0.3 |
zowe rse lock get-owner "hlq.dsname(member)" | N/A | Retrieve the owner ID of a locked sequential data set or a partitioned data set member. Specify either the sequential data set or the partition data set member to obtain the owner ID. | v1.1.1 | |
zowe rse lock set "hlq.dsname(member)" | N/A | Set an exclusive lock on a sequential data set or a partitioned data set member. | v1.1.1 | |
zowe rse lock remove "hlq.dsname(member)" | N/A | Release the exclusive lock acquired on a sequential data set or a partitioned data set member. | v1.1.1 | |
zowe rse lock member-info "hlq.dsname" | N/A | Retrieve the lock information on all PDS members. SUPPORTED WITH EXTENDED VSAM ENABLED ON SERVER | v1.1.1 | |
zowe rse edit data-set "hlq.dsname" | zowe files edit data-set "hlq.dsname" | --extension, --editor, --binary, --encoding | Edit the content of a z/OS data set | v1.0.0 |
zowe rse compare data-set "hlq.dsname(mem1)" "hlq.dsname(mem2)" | zowe files compare data-set "hlq.dsname(mem1)" "hlq.dsname(mem2)" | --encoding, --context-lines, --browser-view, --seqnum | Compare the contents of two z/OS data sets in the terminal (stdout). | v1.0.0 |
zowe rse compare local-file-data-set "./example.txt" "hlq.dsname(mem1)" | zowe files compare local-file-data-set "./example.txt" "hlq.dsname(mem1)" | --encoding, --context-lines, --browser-view, --seqnum | Compare the contents of a local file and a z/OS data set in the terminal (stdout). | v1.0.0 |
zowe rse create vsam "hlq.vsam.dsname" | zowe files create vsam "hlq.vsam.dsname" | --dp, --ds, --dsu, --ers, --ip, --is, --isu, --keylen, --keyoff, --rec, --re --spn, --vt | Creates a VSAM data set. Options include data allocation primary(dp), data allocation secondary(ds), data allocation space unit(dsu), erase(ers), index allocation primary(ip), index allocation secondary(is), index allocation space unit(isu), keylength(keylen), keyoffset(keyoff), recovery(rec), reuse(re), spanned(spn), vsamtype(vt). | v1.2.3 |
zowe rse locate member <dataSetName> <memberPrefix> | --attributes, --numToShow | Locate a data set member. Use --attributes to display additional information about each member. Use --numToShow to specify the maximum number of members to return. | v1.1.6 |
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. Use -o to specify the job owner. Use -p to specify the job name prefix. Use -s to specify the status of the listed jobs (ALL, ACTIVE, OUTPUT, or INPUT). Use -a to display additional job attributes. | v1.0.0 |
zowe rse ls sfbj "jobId" | zowe jobs ls sfbj "jobId" | List the spool files (DDs) for the specified z/OS job ID on the JES or spool queues. | 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, --rr | 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 for the downloaded job output. Use the option --ojd to save the output directly to the specified directory without creating a subdirectory named after the job ID. Use the option --ec to specify the EBCDIC code page used to encode host data. Use the --rr option to specify the zero-based record range (for example, 0–10) of the job output to download | v1.0.0, --ec is available in versions 1.1.6 and 1.2, while --rr is available with version 1.2.3 |
zowe rse submit data-set "hlq.datasetName(jclMember) | zowe jobs submit data-set "hlq.datasetName(jclMember) | --wfo , --wfa , --vasc , -d , -e, --js, --notify | Submit a JCL job contained in a data set. The data set can be a physical sequential data set or a PDS member. Use the --notify option to enable event notification. The command returns an event notification ID that you can use with zowe rse check notification --type job to wait for job completion through server-side long-polling. | --js available with v1.0.9, --notify available with v1.2.5 |
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, --notify | Submit a JCL job contained in a local file. Use the --je to specify the EBCDIC code page used to encode host data. Use the --notify option to enable event notification. The command returns an event notification ID that you can use with zowe rse check notification --type job to wait for job completion through server-side long-polling. | --js available with v1.0.9, --je available with v1.1.6 and v1.2, --notify available with v1.2.5 |
zowe rse submit stdin | zowe jobs submit stdin | --wfo , --wfa , --vasc , -d , -e, --js , --je, --notify | Submit a JCL job passed to the command through the standard input (stdin). Use the option --je to specify the EBCDIC code page used to encode host data. Use the --notify option to enable event notification. The command returns an event notification ID that you can use with zowe rse check notification --type job to wait for job completion through server-side long-polling. | --js available with v1.0.9, --je available with v1.1.6 and v1.2, --notify available with v1.2.5 |
zowe rse submit unix-file "/u/user/fileName.jcl" | zowe jobs submit uss-file "/u/user/fileName.jcl"" | --wfo , --wfa , --vasc , -d , -e, --js , --je, --notify | Submit a job using the JCL in the specified UNIX System Services file. Use the --notify option to enable event notification. The command returns an event notification ID that you can use with zowe rse check notification --type job to wait for job completion through server-side long-polling. | v1.1.6, --notify available with v1.2.5 |
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. Use the option -a to display additional job attributes. | 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 used to encode data 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 | |
zowe rse compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2" | zowe files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2" | --context-lines, --browser-view | Compare the contents of two spool DDs in the terminal (stdout). | v1.0.0 |
zowe rse compare local-file-spool-dd "./exmple.txt" "jobName:jobId:spoolId" | zowe files compare local-file-spool-dd "./exmple.txt" "jobName:jobId:spoolId" | --context-lines, --browser-view, --seqnum | Compare the contents of a local file and a spool DD in the terminal (stdout). | 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 | Retrieve 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 | Retrieve JSON Web Token information while the token remains valid. | 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 option enables interactive TSO commands through 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 by using streaming APIs. The --shell-id option enables interactive TSO commands through an Interactive ISPF Gateway. | v1.1.0 | v3.1.1.26 |
zowe rse issue unix "<COMMAND>" --cwd "/uss/path/toIssue" | --notify | Issue a UNIX System Services command. Use the --notify option to enable event notification. The command returns an event notification ID immediately. You can then use zowe rse check notification --type unix-command to wait for command completion and retrieve command output through server-side long-polling. | v1.0.0, --notify available with v1.2.5 | v3.1.1.26 | |
zowe rse issue unix-shell "<COMMAND>" --cwd "/uss/path/toIssue" | --env, --notify | Issue a UNIX System Services command with streaming output. Use the --env option to specify a comma-separated list of environment variables for the shell. Use the --notify option to enable event notification. The command returns an event notification ID immediately. You can then use zowe rse check notification --type unix-command to wait for command completion and retrieve command output through server-side long-polling. | v1.0.5, --notify available with v1.2.5 | v3.2.0.16 | |
zowe rse check conversion-mappings | Download a mappings file from the RSE API server. | v1.0.3 | v3.1.1.26 | ||
zowe rse change password currentPassword newPassword verifyNewPassword | Change the z/OS user password on the host and update the profile YAML file if it is 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, --jobClass, --jobId, --jobProc, --jobStep, --name, --page, --position, --sr, --srDescription, --stepio, --subtype, --swapin, --sysName, --task, --task%, --type, --userId | Display all about all active job address spaces. Use option flags to filter the returned data. | v1.0.5, filter options: v1.0.9 | v3.2.0.16 | |
zowe rse check password-expiry | Display the expiration date of the user ID password. | v1.1.2 | v3.1.1.26 | ||
zowe rse check notification <notification-id> | --type, --timeout | Wait for event completion through server-side long-polling by using a notification ID obtained from a command with --notify enabled. The --type parameter specifies the notification type: job for job completion (for example, notification ID JOB13167 from job submission commands) or unix-command for UNIX System Services command completion (for example, notification ID event-1779231835420 from zowe rse issue unix --notify or zowe rse issue unix-shell --notify). The --timeout option specifies the maximum time, in seconds, to wait for event completion (default: 600). The server holds the connection open until the event completes or the timeout is reached. The notification response provides complete event details, including duration, status, and job information, in a generic format that applies to any type of event notification. This method is more efficient than client-side polling. | v1.2.5 | 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 | Stop all the user long-running activities in the specified service. Use the --service option to specify the service to cancel. Valid values are all (default), unix-commands, jes-jobs, mvs-and-tso, unix-files, scan-service, common-properties | v1.2.0 | |
| zowe rse check version | --show-capabilites | Check the RSE API version and retrieve upgrade recommendations. The --show-capabilities option displays a detailed list of capabilities available in the current and recommended versions. |