@zowe/cli

# Zowe CLI Help Welcome to Zowe CLI! Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS. For additional Zowe CLI documentation, visit https://zowe.github.io/docs-site For Zowe CLI support, visit https://zowe.org ### Table of Contents * [config](#config) * [set](#config-set) * [reset](#config-reset) * [list](#config-list) * [get](#config-get) * [plugins](#plugins) * [install](#plugins-install) * [list](#plugins-list) * [uninstall](#plugins-uninstall) * [update](#plugins-update) * [validate](#plugins-validate) * [profiles](#profiles) * [create | cre](#profiles-create) * [zosmf-profile](#profiles-create-zosmf-profile) * [tso-profile](#profiles-create-tso-profile) * [ssh-profile](#profiles-create-ssh-profile) * [update | upd](#profiles-update) * [zosmf-profile](#profiles-update-zosmf-profile) * [tso-profile](#profiles-update-tso-profile) * [ssh-profile](#profiles-update-ssh-profile) * [delete | rm](#profiles-delete) * [zosmf-profile](#profiles-delete-zosmf-profile) * [tso-profile](#profiles-delete-tso-profile) * [ssh-profile](#profiles-delete-ssh-profile) * [list | ls](#profiles-list) * [zosmf-profiles](#profiles-list-zosmf-profiles) * [tso-profiles](#profiles-list-tso-profiles) * [ssh-profiles](#profiles-list-ssh-profiles) * [set-default | set](#profiles-set-default) * [zosmf-profile](#profiles-set-default-zosmf-profile) * [tso-profile](#profiles-set-default-tso-profile) * [ssh-profile](#profiles-set-default-ssh-profile) * [provisioning | pv](#provisioning) * [list | ls](#provisioning-list) * [template-info](#provisioning-list-template-info) * [catalog-templates](#provisioning-list-catalog-templates) * [instance-info](#provisioning-list-instance-info) * [instance-variables](#provisioning-list-instance-variables) * [registry-instances](#provisioning-list-registry-instances) * [provision | prov](#provisioning-provision) * [template](#provisioning-provision-template) * [perform | perf](#provisioning-perform) * [action](#provisioning-perform-action) * [delete | del](#provisioning-delete) * [instance](#provisioning-delete-instance) * [zos-console | console](#zos-console) * [collect](#zos-console-collect) * [sync-responses](#zos-console-collect-sync-responses) * [issue](#zos-console-issue) * [command](#zos-console-issue-command) * [zos-files | files](#zos-files) * [create | cre](#zos-files-create) * [data-set-sequential](#zos-files-create-data-set-sequential) * [data-set-partitioned](#zos-files-create-data-set-partitioned) * [data-set-binary](#zos-files-create-data-set-binary) * [data-set-c](#zos-files-create-data-set-c) * [data-set-classic](#zos-files-create-data-set-classic) * [data-set-vsam](#zos-files-create-data-set-vsam) * [zos-file-system](#zos-files-create-zos-file-system) * [uss-file](#zos-files-create-uss-file) * [uss-directory](#zos-files-create-uss-directory) * [delete | del](#zos-files-delete) * [data-set](#zos-files-delete-data-set) * [data-set-vsam](#zos-files-delete-data-set-vsam) * [uss-file](#zos-files-delete-uss-file) * [zos-file-system](#zos-files-delete-zos-file-system) * [invoke | call](#zos-files-invoke) * [ams-statements](#zos-files-invoke-ams-statements) * [ams-file](#zos-files-invoke-ams-file) * [download | dl](#zos-files-download) * [data-set](#zos-files-download-data-set) * [all-members](#zos-files-download-all-members) * [uss-file](#zos-files-download-uss-file) * [list | ls](#zos-files-list) * [all-members](#zos-files-list-all-members) * [data-set](#zos-files-list-data-set) * [uss-files](#zos-files-list-uss-files) * [file-system](#zos-files-list-file-system) * [upload | ul](#zos-files-upload) * [file-to-data-set](#zos-files-upload-file-to-data-set) * [stdin-to-data-set](#zos-files-upload-stdin-to-data-set) * [dir-to-pds](#zos-files-upload-dir-to-pds) * [file-to-uss](#zos-files-upload-file-to-uss) * [dir-to-uss](#zos-files-upload-dir-to-uss) * [mount](#zos-files-mount) * [file-system](#zos-files-mount-file-system) * [unmount | umount](#zos-files-unmount) * [file-system](#zos-files-unmount-file-system) * [zos-jobs | jobs](#zos-jobs) * [submit | sub](#zos-jobs-submit) * [data-set](#zos-jobs-submit-data-set) * [local-file](#zos-jobs-submit-local-file) * [stdin](#zos-jobs-submit-stdin) * [download | dl](#zos-jobs-download) * [output](#zos-jobs-download-output) * [view | vw](#zos-jobs-view) * [job-status-by-jobid](#zos-jobs-view-job-status-by-jobid) * [spool-file-by-id](#zos-jobs-view-spool-file-by-id) * [list | ls](#zos-jobs-list) * [spool-files-by-jobid](#zos-jobs-list-spool-files-by-jobid) * [jobs](#zos-jobs-list-jobs) * [delete | del](#zos-jobs-delete) * [job](#zos-jobs-delete-job) * [cancel | can](#zos-jobs-cancel) * [job](#zos-jobs-cancel-job) * [zos-tso | tso](#zos-tso) * [send](#zos-tso-send) * [address-space](#zos-tso-send-address-space) * [start | st](#zos-tso-start) * [address-space](#zos-tso-start-address-space) * [ping](#zos-tso-ping) * [address-space](#zos-tso-ping-address-space) * [stop | sp](#zos-tso-stop) * [address-space](#zos-tso-stop-address-space) * [issue](#zos-tso-issue) * [command](#zos-tso-issue-command) * [zos-uss | uss](#zos-uss) * [issue | iss](#zos-uss-issue) * [ssh](#zos-uss-issue-ssh) * [zos-workflows | wf](#zos-workflows) * [create | cre](#zos-workflows-create) * [workflow-from-data-set](#zos-workflows-create-workflow-from-data-set) * [workflow-from-uss-file](#zos-workflows-create-workflow-from-uss-file) * [workflow-from-local-file](#zos-workflows-create-workflow-from-local-file) * [start | sta](#zos-workflows-start) * [workflow-full](#zos-workflows-start-workflow-full) * [workflow-step](#zos-workflows-start-workflow-step) * [list | ls](#zos-workflows-list) * [active-workflows](#zos-workflows-list-active-workflows) * [active-workflow-details](#zos-workflows-list-active-workflow-details) * [definition-file-details](#zos-workflows-list-definition-file-details) * [archived-workflows](#zos-workflows-list-archived-workflows) * [archive](#zos-workflows-archive) * [active-workflow](#zos-workflows-archive-active-workflow) * [delete | del](#zos-workflows-delete) * [active-workflow](#zos-workflows-delete-active-workflow) * [archived-workflow](#zos-workflows-delete-archived-workflow) * [zosmf](#zosmf) * [check](#zosmf-check) * [status](#zosmf-check-status) * [list](#zosmf-list) * [systems](#zosmf-list-systems) # config<a name="config"></a> Manage configuration and overrides. To see all set-able options use "list" command. ## set<a name="config-set"></a> Set a configuration setting\. #### Usage zowe config set <configName> <configValue> [options] #### Positional Arguments * `configName` *(string)* * Setting name\. Possible values: CredentialManager \- The package name of a plugin that will override the default credential manager to allow for different credential storage methods\. * `configValue` *(string)* * Value to set #### Examples * Set the default credential manager to my-credential-manager: * `$ zowe config set CredentialManager my-credential-manager` ## reset<a name="config-reset"></a> Reset a configuration setting to default value\. #### Usage zowe config reset <configName> [options] #### Positional Arguments * `configName` *(string)* * Setting name to reset #### Examples * Reset the credential manager to default value: * `$ zowe config reset CredentialManager` ## list<a name="config-list"></a> List all configuration setting options\. #### Usage zowe config list [options] #### Options * `--values` *(boolean)* * Show values for every option #### Examples * List all configuration setting options: * `$ zowe config list` * List all configuration setting options with values: * `$ zowe config list --values` ## get<a name="config-get"></a> Get a value of single setting option\. #### Usage zowe config get <configName> [options] #### Positional Arguments * `configName` *(string)* * Setting name #### Examples * Get a value of CredentialManager setting: * `$ zowe config get CredentialManager` # plugins<a name="plugins"></a> Install and manage plug-ins ## install<a name="plugins-install"></a> Install plug\-ins to an application\. #### Usage zowe plugins install [plugin...] [options] #### Positional Arguments * `plugin...` *(string)* * A space\-separated list of plug\-ins to install\. A plug\-in can be any format that is accepted by the \`npm install\` command (local directory, TAR file, git URL, public package, private package, etc\.\.\.)\. To use a relative local directory, at least one '/' or '\' must exist in the plug\-in path\. For example, you have a local plug\-in in a folder called 'test\-plugin' that you want to install\. Specify the relative local directory by issuing the following command: zowe plugins install \./test\-plugin If you omit the '\./', then the install command looks for 'test\-plugin' in an npm registry\. If the plugin argument is omitted, the plugins\.json file will determine which plug\-ins are installed\. For more information on the plugins\.json file, see the \-\-file option\. #### Options * `--file` *(local file path)* * Specifies the location of a plugins\.json file that contains the plug\-ins you want to install\. All plug\-ins specified in plugins\.json will be installed to the base CLI and the contents will be placed into C:\Users\\\<user>\\.zowe\plugins\plugins\.json\. If you do not specify a plugins\.json file and do not specify a plug\-in, the default plugin\.json file (C:\Users\\\<user>\\.zowe\plugins\plugins\.json\) will be used\. This provides a way to install plug\-ins that were lost or corrupted after reinstalling or updating Zowe CLI\. * `--registry` *(string)* * The npm registry that is used when installing remote packages\. When this value is omitted, the value returned by \`npm config get registry\` is used\. For more information about npm registries, see: https://docs\.npmjs\.com/misc/registry * `--login` *(boolean)* * The flag to add a registry user account to install from secure registry\. It saves credentials to the \.npmrc file using \`npm adduser\`\. When this value is omitted, credentials from \.npmrc file is used\. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from \.npmrc file\. For more information about npm registries, see: https://docs\.npmjs\.com/cli/adduser #### Examples * Install plug-ins saved in C:\Users\\\<user>\\.zowe\plugins\plugins.json: * `$ zowe plugins install` * Install plug-ins saved in a properly formatted config file: * `$ zowe plugins install --file /some/file/path/file_name.json` * Install a remote plug-in: * `$ zowe plugins install my-plugin` * Install a remote plug-in using semver: * `$ zowe plugins install my-plugin@"^1.2.3"` * Install a remote plug-in from the specified registry: * `$ zowe plugins install my-plugin --registry https://registry.npmjs.org/` * Install a local folder, local TAR file, and a git URL: * `$ zowe plugins install ./local-file /root/tar/some-tar.tgz git://github.com/project/repository.git#v1.0.0` * Install a remote plug-in from the registry which requires authorization(don't need to use this flag if you have already logged in before): * `$ zowe plugins install my-plugin --registry https://registry.npmjs.org/ --login` ## list<a name="plugins-list"></a> List all plug\-ins installed\. #### Usage zowe plugins list [options] ## uninstall<a name="plugins-uninstall"></a> Uninstall plug\-ins\. #### Usage zowe plugins uninstall [plugin...] [options] #### Positional Arguments * `plugin...` *(string)* * The name of the plug\-in to uninstall\. If the plug\-in argument is omitted, no action is taken\. #### Examples * Uninstall a plug-in: * `$ zowe plugins uninstall my-plugin` ## update<a name="plugins-update"></a> Update plug\-ins\. #### Usage zowe plugins update [plugin...] [options] #### Positional Arguments * `plugin...` *(string)* * The name of the plug\-in to update\. If the plug\-in argument is omitted, no action is taken\. #### Options * `--registry` *(string)* * The npm registry that is used when installing remote packages\. When this value is omitted, the value returned by \`npm config get registry\` is used\. For more information about npm registries, see: https://docs\.npmjs\.com/misc/registry * `--login` *(boolean)* * The flag to add a registry user account to install from secure registry\. It saves credentials to the \.npmrc file using \`npm adduser\`\. When this value is omitted, credentials from \.npmrc file is used\. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from \.npmrc file\. For more information about npm registries, see: https://docs\.npmjs\.com/cli/adduser #### Examples * Update a plug-in: * `$ zowe plugins update my-plugin` * Update a remote plug-in from the registry which requires authorization(don't need to use this flag if you have already logged in before): * `$ zowe plugins update my-plugin --registry https://registry.npmjs.org/ --login` ## validate<a name="plugins-validate"></a> Validate a plug\-in that has been installed\. #### Usage zowe plugins validate [plugin] [options] #### Positional Arguments * `plugin` *(string)* * The name of the plug\-in to validate\. Validation issues identified for this plug\-in are displayed\. If the plug\-in argument is omitted, all installed plug\-ins are validated\. #### Examples * Validate a plug-in named my-plugin: * `$ zowe plugins validate my-plugin` * Validate all installed plug-ins: * `$ zowe plugins validate` # profiles<a name="profiles"></a> Create and manage configuration profiles ## create | cre<a name="profiles-create"></a> Create new configuration profiles. ### zosmf-profile<a name="profiles-create-zosmf-profile"></a> z/OSMF Profile #### Usage zowe profiles create zosmf-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the new zosmf profile\. You can load this profile by using the name on commands that support the "\-\-zosmf\-profile" option\. #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Options * `--overwrite` | `--ow` *(boolean)* * Overwrite the zosmf profile when a profile of the same name exists\. #### Examples * Create a zosmf profile called 'zos123' to connect to z/OSMF at host zos123 and port 1443: * `$ zowe profiles create zosmf-profile zos123 --host zos123 --port 1443 --user ibmuser --password myp4ss` * Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) and allow self-signed certificates: * `$ zowe profiles create zosmf-profile zos124 --host zos124 --user ibmuser --password myp4ss --reject-unauthorized false` * Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) and allow self-signed certificates: * `$ zowe profiles create zosmf-profile zosAPIML --host zosAPIML --port 2020 --user ibmuser --password myp4ss --reject-unauthorized false --base-path basePath` ### tso-profile<a name="profiles-create-tso-profile"></a> z/OS TSO/E User Profile #### Usage zowe profiles create tso-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the new tso profile\. You can load this profile by using the name on commands that support the "\-\-tso\-profile" option\. #### TSO ADDRESS SPACE OPTIONS * `--account` | `-a` *(string)* * Your z/OS TSO/E accounting information\. * `--character-set` | `--cs` *(string)* * Character set for address space to convert messages and responses from UTF\-8 to EBCDIC\. Default value: 697 * `--code-page` | `--cp` *(string)* * Codepage value for TSO/E address space to convert messages and responses from UTF\-8 to EBCDIC\. Default value: 1047 * `--columns` | `--cols` *(number)* * The number of columns on a screen\. Default value: 80 * `--logon-procedure` | `-l` *(string)* * The logon procedure to use when creating TSO procedures on your behalf\. Default value: IZUFPROC * `--region-size` | `--rs` *(number)* * Region size for the TSO/E address space\. Default value: 4096 * `--rows` *(number)* * The number of rows on a screen\. Default value: 24 #### Options * `--overwrite` | `--ow` *(boolean)* * Overwrite the tso profile when a profile of the same name exists\. #### Examples * Create a tso profile called 'myprof' with default settings and JES accounting information of 'IZUACCT': * `$ zowe profiles create tso-profile myprof -a IZUACCT` * Create a tso profile called 'largeregion' with a region size of 8192, a logon procedure of MYPROC, and JES accounting information of '1234': * `$ zowe profiles create tso-profile largeregion -a 1234 --rs 8192` ### ssh-profile<a name="profiles-create-ssh-profile"></a> z/OS SSH Profile #### Usage zowe profiles create ssh-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the new ssh profile\. You can load this profile by using the name on commands that support the "\-\-ssh\-profile" option\. #### z/OS Ssh Connection Options * `--host` | `-H` *(string)* * The z/OS SSH server host name\. * `--port` | `-P` *(number)* * The z/OS SSH server port\. Default value: 22 * `--user` | `-u` *(string)* * Mainframe user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe password, which can be the same as your TSO password\. * `--privateKey` | `--key` | `--pk` *(string)* * Path to a file containing your private key, that must match a public key stored in the server for authentication * `--keyPassphrase` | `--passphrase` | `--kp` *(string)* * Private key passphrase, which unlocks the private key\. * `--handshakeTimeout` | `--timeout` | `--to` *(number)* * How long in milliseconds to wait for the SSH handshake to complete\. #### Options * `--overwrite` | `--ow` *(boolean)* * Overwrite the ssh profile when a profile of the same name exists\. #### Examples * Create a ssh profile called 'ssh111' to connect to z/OS SSH server at host 'zos123' and default port 22: * `$ zowe profiles create ssh-profile ssh111 --host sshhost --user ibmuser --password myp4ss` * Create a ssh profile called 'ssh222' to connect to z/OS SSH server at host 'zos123' and port 13022: * `$ zowe profiles create ssh-profile ssh222 --host sshhost --port 13022 --user ibmuser --password myp4ss` * Create a ssh profile called 'ssh333' to connect to z/OS SSH server at host 'zos123' using a privatekey '/path/to/privatekey' and its decryption passphrase 'privateKeyPassphrase' for privatekey authentication: * `$ zowe profiles create ssh-profile ssh333 --host sshhost --user ibmuser --privateKey /path/to/privatekey --keyPassphrase privateKeyPassphrase` ## update | upd<a name="profiles-update"></a> Update a profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates. ### zosmf-profile<a name="profiles-update-zosmf-profile"></a> z/OSMF Profile #### Usage zowe profiles update zosmf-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the new zosmf profile\. You can load this profile by using the name on commands that support the "\-\-zosmf\-profile" option\. #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Examples * Update a zosmf profile named 'zos123' with a new username and password: * `$ zowe profiles update zosmf-profile zos123 --user newuser --password newp4ss` ### tso-profile<a name="profiles-update-tso-profile"></a> z/OS TSO/E User Profile #### Usage zowe profiles update tso-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the new tso profile\. You can load this profile by using the name on commands that support the "\-\-tso\-profile" option\. #### TSO ADDRESS SPACE OPTIONS * `--account` | `-a` *(string)* * Your z/OS TSO/E accounting information\. * `--character-set` | `--cs` *(string)* * Character set for address space to convert messages and responses from UTF\-8 to EBCDIC\. * `--code-page` | `--cp` *(string)* * Codepage value for TSO/E address space to convert messages and responses from UTF\-8 to EBCDIC\. * `--columns` | `--cols` *(number)* * The number of columns on a screen\. * `--logon-procedure` | `-l` *(string)* * The logon procedure to use when creating TSO procedures on your behalf\. * `--region-size` | `--rs` *(number)* * Region size for the TSO/E address space\. * `--rows` *(number)* * The number of rows on a screen\. #### Examples * Update a tso profile called myprof with new JES accounting information: * `$ zowe profiles update tso-profile myprof -a NEWACCT` ### ssh-profile<a name="profiles-update-ssh-profile"></a> z/OS SSH Profile #### Usage zowe profiles update ssh-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the new ssh profile\. You can load this profile by using the name on commands that support the "\-\-ssh\-profile" option\. #### z/OS Ssh Connection Options * `--host` | `-H` *(string)* * The z/OS SSH server host name\. * `--port` | `-P` *(number)* * The z/OS SSH server port\. * `--user` | `-u` *(string)* * Mainframe user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe password, which can be the same as your TSO password\. * `--privateKey` | `--key` | `--pk` *(string)* * Path to a file containing your private key, that must match a public key stored in the server for authentication * `--keyPassphrase` | `--passphrase` | `--kp` *(string)* * Private key passphrase, which unlocks the private key\. * `--handshakeTimeout` | `--timeout` | `--to` *(number)* * How long in milliseconds to wait for the SSH handshake to complete\. ## delete | rm<a name="profiles-delete"></a> Delete existing profiles. ### zosmf-profile<a name="profiles-delete-zosmf-profile"></a> Delete a zosmf profile\. You must specify a profile name to be deleted\. To find a list of available profiles for deletion, issue the profiles list command\. By default, you will be prompted to confirm the profile removal\. #### Usage zowe profiles delete zosmf-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the zosmf profile to be deleted\. You can also load this profile by using the name on commands that support the "\-\-zosmf\-profile" option\. #### Options * `--force` *(boolean)* * Force deletion of profile, and dependent profiles if specified\. No prompt will be displayed before deletion occurs\. #### Examples * Delete a zosmf profile named profilename: * `$ zowe profiles delete zosmf-profile profilename` ### tso-profile<a name="profiles-delete-tso-profile"></a> Delete a tso profile\. You must specify a profile name to be deleted\. To find a list of available profiles for deletion, issue the profiles list command\. By default, you will be prompted to confirm the profile removal\. #### Usage zowe profiles delete tso-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the tso profile to be deleted\. You can also load this profile by using the name on commands that support the "\-\-tso\-profile" option\. #### Options * `--force` *(boolean)* * Force deletion of profile, and dependent profiles if specified\. No prompt will be displayed before deletion occurs\. #### Examples * Delete a tso profile named profilename: * `$ zowe profiles delete tso-profile profilename` ### ssh-profile<a name="profiles-delete-ssh-profile"></a> Delete a ssh profile\. You must specify a profile name to be deleted\. To find a list of available profiles for deletion, issue the profiles list command\. By default, you will be prompted to confirm the profile removal\. #### Usage zowe profiles delete ssh-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specifies the name of the ssh profile to be deleted\. You can also load this profile by using the name on commands that support the "\-\-ssh\-profile" option\. #### Options * `--force` *(boolean)* * Force deletion of profile, and dependent profiles if specified\. No prompt will be displayed before deletion occurs\. #### Examples * Delete a ssh profile named profilename: * `$ zowe profiles delete ssh-profile profilename` ## list | ls<a name="profiles-list"></a> List profiles of the type ### zosmf-profiles<a name="profiles-list-zosmf-profiles"></a> z/OSMF Profile #### Usage zowe profiles list zosmf-profiles [options] #### Options * `--show-contents` | `--sc` *(boolean)* * List zosmf profiles and their contents\. All profile details will be printed as part of command output\. #### Examples * List profiles of type zosmf: * `$ zowe profiles list zosmf-profiles` * List profiles of type zosmf and display their contents: * `$ zowe profiles list zosmf-profiles --sc` ### tso-profiles<a name="profiles-list-tso-profiles"></a> z/OS TSO/E User Profile #### Usage zowe profiles list tso-profiles [options] #### Options * `--show-contents` | `--sc` *(boolean)* * List tso profiles and their contents\. All profile details will be printed as part of command output\. #### Examples * List profiles of type tso: * `$ zowe profiles list tso-profiles` * List profiles of type tso and display their contents: * `$ zowe profiles list tso-profiles --sc` ### ssh-profiles<a name="profiles-list-ssh-profiles"></a> z/OS SSH Profile #### Usage zowe profiles list ssh-profiles [options] #### Options * `--show-contents` | `--sc` *(boolean)* * List ssh profiles and their contents\. All profile details will be printed as part of command output\. #### Examples * List profiles of type ssh: * `$ zowe profiles list ssh-profiles` * List profiles of type ssh and display their contents: * `$ zowe profiles list ssh-profiles --sc` ## set-default | set<a name="profiles-set-default"></a> Set which profiles are loaded by default. ### zosmf-profile<a name="profiles-set-default-zosmf-profile"></a> The zosmf set default\-profiles command allows you to set the default profiles for this command group\. When a zosmf command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements\. #### Usage zowe profiles set-default zosmf-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specify a profile for default usage within the zosmf group\. When you issue commands within the zosmf group without a profile specified as part of the command, the default will be loaded instead\. #### Examples * Set the default profile for type zosmf to the profile named 'profilename': * `$ zowe profiles set-default zosmf-profile profilename` ### tso-profile<a name="profiles-set-default-tso-profile"></a> The tso set default\-profiles command allows you to set the default profiles for this command group\. When a tso command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements\. #### Usage zowe profiles set-default tso-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specify a profile for default usage within the tso group\. When you issue commands within the tso group without a profile specified as part of the command, the default will be loaded instead\. #### Examples * Set the default profile for type tso to the profile named 'profilename': * `$ zowe profiles set-default tso-profile profilename` ### ssh-profile<a name="profiles-set-default-ssh-profile"></a> The ssh set default\-profiles command allows you to set the default profiles for this command group\. When a ssh command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements\. #### Usage zowe profiles set-default ssh-profile <profileName> [options] #### Positional Arguments * `profileName` *(string)* * Specify a profile for default usage within the ssh group\. When you issue commands within the ssh group without a profile specified as part of the command, the default will be loaded instead\. #### Examples * Set the default profile for type ssh to the profile named 'profilename': * `$ zowe profiles set-default ssh-profile profilename` # provisioning | pv<a name="provisioning"></a> Perform z/OSMF provisioning tasks on Published Templates in the Service Catalog and Provisioned Instances in the Service Registry. ## list | ls<a name="provisioning-list"></a> Lists z/OSMF provisioning information such as the provisioned instances from the registry, the provisioned instance details, the available provisioning templates and provisioning template details. ### template-info<a name="provisioning-list-template-info"></a> List details about a template published with z/OSMF Cloud Provisioning\. #### Usage zowe provisioning list template-info <name> [options] #### Positional Arguments * `name` *(string)* * The name of a z/OSMF cloud provisioning template\. #### Options * `--all-info` | `--ai` *(boolean)* * Display detailed information about published z/OSMF service catalog template (summary information is printed by default)\. #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Profile Options * `--zosmf-profile` | `--zosmf-p` *(string)* * The name of a (zosmf) profile to load for this command execution\. #### Examples * List summary information for template "template1": * `$ zowe provisioning list template-info template1` ### catalog-templates<a name="provisioning-list-catalog-templates"></a> Lists the z/OSMF service catalog published templates\. #### Usage zowe provisioning list catalog-templates [options] #### Options * `--all-info` | `--ai` *(boolean)* * Display information about published z/OSMF service catalog templates (summary information is printed by default)\. #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Profile Options * `--zosmf-profile` | `--zosmf-p` *(string)* * The name of a (zosmf) profile to load for this command execution\. #### Examples * List all published templates in the z/OSMF service catalog (with full detail): * `$ zowe provisioning list catalog-templates --all-info` ### instance-info<a name="provisioning-list-instance-info"></a> List details about an instance provisioned with z/OSMF\. #### Usage zowe provisioning list instance-info <name> [options] #### Positional Arguments * `name` *(string)* * Provisioned Instance Name #### Options * `--display` *(string)* * Level of information to display for the provisioned instance\. Possible values: summary \- summary information, no actions or variables actions \- (default) summary with actions, no variables vars \- summary information with variables, no actions extended \- extended information with actions full \- all available information Allowed values: extended, summary, vars, actions, full #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Profile Options * `--zosmf-profile` | `--zosmf-p` *(string)* * The name of a (zosmf) profile to load for this command execution\. #### Examples * List summary information with a list of actions for an instance with the name "instance1": * `$ zowe provisioning list instance-info instance1` * Show extended general information with actions for a provisioned instance with the name "instance1": * `$ zowe provisioning list instance-info instance1 --display extended` ### instance-variables<a name="provisioning-list-instance-variables"></a> List a set of variables and their values for a given name\. #### Usage zowe provisioning list instance-variables <name> [options] #### Positional Arguments * `name` *(string)* * Provisioned Instance Name #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Profile Options * `--zosmf-profile` | `--zosmf-p` *(string)* * The name of a (zosmf) profile to load for this command execution\. #### Response Format Options * `--response-format-filter` | `--rff` *(array)* * Filter (include) fields in the response\. Accepts an array of field/property names to include in the output response\. You can filter JSON objects properties OR table columns/fields\. In addition, you can use this option in conjunction with '\-\-response\-format\-type' to reduce the output of a command to a single field/property or a list of a single field/property\. * `--response-format-type` | `--rft` *(string)* * The command response output format type\. Must be one of the following: table: Formats output data as a table\. Use this option when the output data is an array of homogeneous JSON objects\. Each property of the object will become a column in the table\. list: Formats output data as a list of strings\. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array\. object: Formats output data as a list of prettified objects (or single object)\. Can be used in place of "table" to change from tabular output to a list of prettified objects\. string: Formats output data as a string\. JSON objects/arrays are stringified\. Allowed values: table, list, object, string * `--response-format-header` | `--rfh` *(boolean)* * If "\-\-response\-format\-type table" is specified, include the column headers in the output\. #### Examples * List instance variables of "instance1": * `$ zowe provisioning list instance-variables instance1` ### registry-instances<a name="provisioning-list-registry-instances"></a> List the provisioned instances from the z/OSMF software registry\. #### Usage zowe provisioning list registry-instances [options] #### Options * `--all-info` | `--ai` *(boolean)* * Display all available information about provisioned instances (summary by default)\. * `--filter-by-type` | `--fbt` *(string)* * Filter the list of provisioned instances by type (e\.g\. DB2 or CICS)\. * `--filter-by-external-name` | `--fben` *(string)* * Filter the list of provisioned instances by External Name\. * `--types` | `-t` *(boolean)* * Display a list of all types for provisioned instances (e\.g\. DB2 or CICS)\. #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Profile Options * `--zosmf-profile` | `--zosmf-p` *(string)* * The name of a (zosmf) profile to load for this command execution\. #### Examples * List all provisioned instances (with full detail): * `$ zowe provisioning list registry-instances --all-info` ## provision | prov<a name="provisioning-provision"></a> Using z/OSMF cloud provisioning services provision available templates. ### template<a name="provisioning-provision-template"></a> Using z/OSMF cloud provisioning services, provision available templates\. You can view available templates using the zowe provisioning list catalog\-templates command\. #### Usage zowe provisioning provision template <name> [options] #### Positional Arguments * `name` *(string)* * The name of a z/OSMF cloud provisioning template\. #### Options * `--properties` | `-p` *(string)* * A sequence of string enclosed "name=value" pairs of prompt variables\. e\.g: "CSQ\_MQ\_SSID=ZCT1,CSQ\_CMD\_PFX=\!ZCT1"\. * `--properties-file` | `--pf` *(string)* * Path to \.yml file containing properties\. * `--domain-name` | `--dn` *(string)* * Required if the user has consumer authorization to more than one domain with this template name\. * `--tenant-name` | `--tn` *(string)* * Required if the user has consumer authorization to more than one tenant in the same domain that contains this template name\. * `--user-data-id` | `--udi` *(string)* * ID for the user data specified with user\-data\. Passed into the software services registry\. * `--user-data` | `--ud` *(string)* * User data that is passed into the software services registry\. Can be specified only if user\-data\-id is provided\. * `--account-info` | `--ai` *(string)* * Account information to use in the JCL JOB statement\. The default is the account information that is associated with the resource pool for the tenant\. * `--system-nick-names` | `--snn` *(string)* * Each string is the nickname of the system upon which to provision the software service defined by the template\. The field is required if the resource pool associated with the tenant used for this operation is not set up to automatically select a system\. Only one nickname is allowed\.If the field is provided it is validated\. e\.g: "SYSNAME1,SYSNAME2"\. #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Profile Options * `--zosmf-profile` | `--zosmf-p` *(string)* * The name of a (zosmf) profile to load for this command execution\. #### Examples * Provision a published software service template.: * `$ zowe provisioning provision template template1` ## perform | perf<a name="provisioning-perform"></a> Perform actions against instances provisioned with z/OSMF. ### action<a name="provisioning-perform-action"></a> Perform actions on instances previously provisioned with z/OSMF cloud provisioning services\. To view the list of provisioned instances, use the "zowe provisioning list registry\-instances" command\. Once you have obtained an instance name you can use the "zowe provisioning list instance\-info <name>" command to view the available instance actions\. #### Usage zowe provisioning perform action <name> <actionname> [options] #### Positional Arguments * `name` *(string)* * Provisioned Instance name\. * `actionname` *(string)* * The action name\. Use the "zowe provisioning list instance\-info <name>" command to view available instance actions\. #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Profile Options * `--zosmf-profile` | `--zosmf-p` *(string)* * The name of a (zosmf) profile to load for this command execution\. #### Examples * Perform the "start" action on the provisioned instance "instance1": * `$ zowe provisioning perform action instance1 start` ## delete | del<a name="provisioning-delete"></a> Deletes instance previously provisioned with z/OSMF cloud provisioning services. ### instance<a name="provisioning-delete-instance"></a> Deletes selected deprovisioned instance\. #### Usage zowe provisioning delete instance <name> [options] #### Positional Arguments * `name` *(string)* * Deprovisioned Instance name\. #### Zosmf Connection Options * `--host` | `-H` *(string)* * The z/OSMF server host name\. * `--port` | `-P` *(number)* * The z/OSMF server port\. Default value: 443 * `--user` | `-u` *(string)* * Mainframe (z/OSMF) user name, which can be the same as your TSO login\. * `--password` | `--pass` | `--pw` *(string)* * Mainframe (z/OSMF) password, which can be the same as your TSO password\. * `--reject-unauthorized` | `--ru` *(boolean)* * Reject self\-signed certificates\. Default value: true * `--base-path` | `--bp` *(string)* * The base path for your API mediation layer instance\. Specify this option to prepend the base path to all z/OSMF resources when making REST requests\. Do not specify this option if you are not using an API mediation layer\. #### Profile Options * `--zosmf-profile` | `--zosmf-p` *(string)* * The name of a (zosmf) profile to load for this command execution\. #### Examples * Delete deprovisioned instance "instance1": * `$ zowe provisioning delete instance instance1` # zos-console | console<a name="zos-console"></a> Interact with z/OSMF console services. Issue z/OS console commands and collect responses. z/OS console services establishes extended MCS (EMCS) consoles on behalf of the user, which are used to issue the commands and collect responses. Important! Before you use commands in the zos-console command group, ensure that you understand the implications of issuing z/OS console commands in your environment. ## collect<a name="zos-console-collect"></a> z/OSMF console services provides a command response key upon successful issue of a console command. You can use this key to collect additional console message responses. ### sync-responses<a name="zos-console-collect-sync-responses"></a> The z/OSMF console REST APIs return a "solicited response key" after successfully issuing a synchronous console command that produces solicited responses\. You can use the "solicited response key"on the "sync\-responses" command to collect any additional outstanding solicited responses from the console the command was issued\. In general, when issuing a z/OS console command, z/OS applications route responses to the originating console\. The command response messages are referred to as "solicited command responses" (i\.e\. direct responses to the command issued)\. When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default\. However, there is no z/OS mechanism that indicates the total number of response messages that may be produc