zowe

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://docs.zowe.org

For Zowe CLI support, visit https://www.zowe.org

Global Options


zowecics

Interact with IBM CICS programs and transactions.

zowecicsadd-to-list

Add new resources (for example, CSD Groups to CSD Lists) to CICS through IBM CMCI.

zowecicsadd-to-listcsdGroup

Add a CSD Group to a CICS CSD List.

Usage

zowe cics add-to-list csdGroup <name> <csdList> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdefine

Define new resources (for example, programs) to CICS through IBM CMCI.

zowecicsdefineprogram

Define a new program to CICS.

Usage

zowe cics define program <programName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdefinetransaction

Define a new transaction to CICS.

Usage

zowe cics define transaction <transactionName> <programName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdefineurimap-client

Define a new URIMAP of type client to CICS. This acts as an HTTP(S) client

Usage

zowe cics define urimap-client <urimapName> <csdGroup> [options]

Positional Arguments

Required Options

Options

Cics Connection Options

Profile Options

Examples

zowecicsdefineurimap-pipeline

Define a new URIMAP of type pipeline to CICS. This processes incoming HTTP(S) requests

Usage

zowe cics define urimap-pipeline <urimapName> <csdGroup> [options]

Positional Arguments

Required Options

Options

Cics Connection Options

Profile Options

Examples

zowecicsdefineurimap-server

Define a new URIMAP of type server to CICS. This acts as an HTTP(S) server

Usage

zowe cics define urimap-server <urimapName> <csdGroup> [options]

Positional Arguments

Required Options

Options

Cics Connection Options

Profile Options

Examples

zowecicsdefinewebservice

Define a new web service to CICS.

Usage

zowe cics define webservice <webserviceName> <csdGroup> [options]

Positional Arguments

Required Options

Options

Cics Connection Options

Profile Options

Examples

zowecicsdelete

Delete resources (for example, programs) from CICS through IBM CMCI.

zowecicsdeleteprogram

Delete a program from CICS.

Usage

zowe cics delete program <programName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdeletetransaction

Delete a transaction from CICS.

Usage

zowe cics delete transaction <transactionName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdeleteurimap

Delete a urimap from CICS.

Usage

zowe cics delete urimap <urimapName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdeletewebservice

Delete a web service from CICS.

Usage

zowe cics delete webservice <webserviceName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdisable

Disable resources (for example, urimaps) from CICS through IBM CMCI.

zowecicsdisableurimap

Disable a urimap from CICS.

Usage

zowe cics disable urimap <urimapName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdiscard

Discard resources (for example, programs) from CICS through IBM CMCI.

zowecicsdiscardprogram

Discard a program from CICS.

Usage

zowe cics discard program <programName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdiscardtransaction

Discard a transaction from CICS.

Usage

zowe cics discard transaction <transactionName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsdiscardurimap

Discard a urimap from CICS.

Usage

zowe cics discard urimap <urimapName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsenable

Enable resources (for example, urimaps) from CICS through IBM CMCI.

zowecicsenableurimap

Enable a urimap from CICS.

Usage

zowe cics enable urimap <urimapName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsget

Get resources (for example, programs or transactions) from CICS through IBM CMCI.

zowecicsgetresource

Get resources (for example, programs or transactions) from CICS.

Usage

zowe cics get resource <resourceName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Response Format Options

Examples

zowecicsinstall

Install resources (for example, programs) to CICS through IBM CMCI.

zowecicsinstallprogram

Install a program to CICS.

Usage

zowe cics install program <programName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsinstalltransaction

Install a transaction to CICS.

Usage

zowe cics install transaction <transactionName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsinstallurimap

Install a urimap to CICS.

Usage

zowe cics install urimap <urimapName> <csdGroup> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsrefresh

Refresh a program on CICS through IBM CMCI.

zowecicsrefreshprogram

Refresh a program on CICS.

Usage

zowe cics refresh program <programName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples

zowecicsremove-from-list

Remove resources (for example, CSD Groups in CSD Lists) from CICS through IBM CMCI.

zowecicsremove-from-listcsdGroup

Remove a CSD Group from a CICS CSD List.

Usage

zowe cics remove-from-list csdGroup <name> <csdList> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Examples


zoweconfig

Manage configuration and overrides. To see all set-able options use "list" command.

zoweconfigget

Get a value of single setting option.

Usage

zowe config get <configName> [options]

Positional Arguments

Examples

zoweconfiglist

List all configuration setting options.

Usage

zowe config list [options]

Options

Examples

zoweconfigreset

Reset a configuration setting to default value.

Usage

zowe config reset <configName> [options]

Positional Arguments

Examples

zoweconfigset

Set a configuration setting.

Usage

zowe config set <configName> <configValue> [options]

Positional Arguments

Examples


zowedb2

Interact with IBM Db2 for z/OS

zowedb2call

Call a Db2 stored procedure

zowedb2callprocedure

Call a Db2 stored procedure. Specify the stored procedure name and optionally provide values.

Usage

zowe db2 call procedure <routine> [options]

Positional Arguments

Options

DB2 Connection Options

Profile Options

Examples

zowedb2execute

Execute SQL queries against a Db2 region and retrieve the response. Enclose the query in quotes and escape any symbols that have a special meaning to the shell.

zowedb2executesql

Execute one or multiple SQL statements separated by a semicolon from a command line or from a file.

Usage

zowe db2 execute sql [options]

Options

DB2 Connection Options

Profile Options

Examples

zowedb2export

Export data from a Db2 table

zowedb2exporttable

Export a Db2 table to the stdout or a file.

Usage

zowe db2 export table <table> [options]

Positional Arguments

Options

DB2 Connection Options

Profile Options

Examples


zoweims

Interact with IBM IMS programs and transactions.

zoweimsquery

Query application programs, regions or transactions across an IMSplex.The query returns information about application programs, regions and transactions. This command submits a 'QUERY PGM', 'DIS ACT' or 'QUERY TRAN' IMS command and returns the output.

zoweimsqueryprogram

Query an IMS application program.

Usage

zowe ims query program [name...] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsqueryregion

Query an IMS region.

Usage

zowe ims query region [options]

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsquerytransaction

Query an IMS transaction.

Usage

zowe ims query transaction [name...] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsstart

Starts a region, application program, or transaction and makes IMS resources available for reference and use. This command submits a '/START REGION', 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.

zoweimsstartprogram

Start an IMS application program.

Usage

zowe ims start program [name...] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsstartregion

Start an IMS region.

Usage

zowe ims start region [memberName] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsstarttransaction

Start an IMS transaction.

Usage

zowe ims start transaction [name...] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsstop

Stops a running region, application program or transaction. This command submits a '/STOP REGION', 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.",

zoweimsstopprogram

Stop an IMS application program.

Usage

zowe ims stop program [name...] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsstopregion

Stop an IMS region.

Usage

zowe ims stop region [options]

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsstoptransaction

Stop an IMS transaction.

Usage

zowe ims stop transaction <name...> [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsupdate

Updates the setting(s) for application program or transaction. This command submits a 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.

zoweimsupdateprogram

Update an IMS application program.

Usage

zowe ims update program [name...] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples

zoweimsupdatetransaction

Update an IMS transaction.

Usage

zowe ims update transaction [name...] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Response Format Options

Examples


zowemq

Interact with IBM MQ for z/OS.

zowemqrun

MQ Utilities

zowemqrunmqsc

MQ Utilities

Usage

zowe mq run mqsc <qmgr> <cmd> [options]

Positional Arguments

MQ Connection Options

Profile Options

Examples


zoweplugins

Install and manage plug-ins

zowepluginsinstall

Install plug-ins to an application.

Usage

zowe plugins install [plugin...] [options]

Positional Arguments

Options

Examples

zowepluginslist

List all plug-ins installed.

Usage

zowe plugins list [options]

zowepluginsuninstall

Uninstall plug-ins.

Usage

zowe plugins uninstall [plugin...] [options]

Positional Arguments

Examples

zowepluginsupdate

Update plug-ins.

Usage

zowe plugins update [plugin...] [options]

Positional Arguments

Options

Examples

zowepluginsvalidate

Validate a plug-in that has been installed.

Usage

zowe plugins validate [plugin] [options]

Positional Arguments

Examples


zoweprofiles

Create and manage configuration profiles

zoweprofilescreate

Create new configuration profiles.

zoweprofilescreatecics-profile

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

Usage

zowe profiles create cics-profile <profileName> [options]

Positional Arguments

Required Options

Options

Cics Connection Options

Examples

zoweprofilescreatedb2-profile

A profile for interaction with Db2 for the z/OS region

Usage

zowe profiles create db2-profile <profileName> [options]

Positional Arguments

Options

zoweprofilescreateims-profile

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

Usage

zowe profiles create ims-profile <profileName> [options]

Positional Arguments

IMS Connection Options

Options

Examples

zoweprofilescreatemq-profile

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

Usage

zowe profiles create mq-profile <profileName> [options]

Positional Arguments

Required Options

MQ Connection Options

Options

Examples

zoweprofilescreatessh-profile

z/OS SSH Profile

Usage

zowe profiles create ssh-profile <profileName> [options]

Positional Arguments

z/OS Ssh Connection Options

Options

Examples

zoweprofilescreatetso-profile

z/OS TSO/E User Profile

Usage

zowe profiles create tso-profile <profileName> [options]

Positional Arguments

TSO ADDRESS SPACE OPTIONS

Options

Examples

zoweprofilescreatezftp-profile

Configuration profile for z/OS FTP

Usage

zowe profiles create zftp-profile <profileName> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Examples

zoweprofilescreatezosmf-profile

z/OSMF Profile

Usage

zowe profiles create zosmf-profile <profileName> [options]

Positional Arguments

Zosmf Connection Options

Options

Examples

zoweprofilesdelete

Delete existing profiles.

zoweprofilesdeletecics-profile

Delete a cics 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 cics-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletedb2-profile

Delete a db2 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 db2-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeleteims-profile

Delete a ims 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 ims-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletemq-profile

Delete a mq 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 mq-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletessh-profile

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

Options

Examples

zoweprofilesdeletetso-profile

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

Options

Examples

zoweprofilesdeletezftp-profile

Delete a zftp 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 zftp-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletezosmf-profile

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

Options

Examples

zoweprofileslist

List profiles of the type {{type}}

zoweprofileslistcics-profiles

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

Usage

zowe profiles list cics-profiles [options]

Options

Examples

zoweprofileslistdb2-profiles

A profile for interaction with Db2 for the z/OS region

Usage

zowe profiles list db2-profiles [options]

Options

Examples

zoweprofileslistims-profiles

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

Usage

zowe profiles list ims-profiles [options]

Options

Examples

zoweprofileslistmq-profiles

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

Usage

zowe profiles list mq-profiles [options]

Options

Examples

zoweprofileslistssh-profiles

z/OS SSH Profile

Usage

zowe profiles list ssh-profiles [options]

Options

Examples

zoweprofileslisttso-profiles

z/OS TSO/E User Profile

Usage

zowe profiles list tso-profiles [options]

Options

Examples

zoweprofileslistzftp-profiles

Configuration profile for z/OS FTP

Usage

zowe profiles list zftp-profiles [options]

Options

Examples

zoweprofileslistzosmf-profiles

z/OSMF Profile

Usage

zowe profiles list zosmf-profiles [options]

Options

Examples

zoweprofilesset-default

Set which profiles are loaded by default.

zoweprofilesset-defaultcics-profile

The cics set default-profiles command allows you to set the default profiles for this command group. When a cics 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 cics-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultdb2-profile

The db2 set default-profiles command allows you to set the default profiles for this command group. When a db2 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 db2-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultims-profile

The ims set default-profiles command allows you to set the default profiles for this command group. When a ims 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 ims-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultmq-profile

The mq set default-profiles command allows you to set the default profiles for this command group. When a mq 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 mq-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultssh-profile

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

Examples

zoweprofilesset-defaulttso-profile

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

Examples

zoweprofilesset-defaultzftp-profile

The zftp set default-profiles command allows you to set the default profiles for this command group. When a zftp 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 zftp-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultzosmf-profile

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

Examples

zoweprofilesupdate

Update a {{type}} 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.

zoweprofilesupdatecics-profile

A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.

Usage

zowe profiles update cics-profile <profileName> [options]

Positional Arguments

Options

Cics Connection Options

zoweprofilesupdatedb2-profile

A profile for interaction with Db2 for the z/OS region

Usage

zowe profiles update db2-profile <profileName> [options]

Positional Arguments

Options

zoweprofilesupdateims-profile

An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.

Usage

zowe profiles update ims-profile <profileName> [options]

Positional Arguments

IMS Connection Options

zoweprofilesupdatemq-profile

An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface

Usage

zowe profiles update mq-profile <profileName> [options]

Positional Arguments

Options

MQ Connection Options

zoweprofilesupdatessh-profile

z/OS SSH Profile

Usage

zowe profiles update ssh-profile <profileName> [options]

Positional Arguments

z/OS Ssh Connection Options

zoweprofilesupdatetso-profile

z/OS TSO/E User Profile

Usage

zowe profiles update tso-profile <profileName> [options]

Positional Arguments

TSO ADDRESS SPACE OPTIONS

Examples

zoweprofilesupdatezftp-profile

Configuration profile for z/OS FTP

Usage

zowe profiles update zftp-profile <profileName> [options]

Positional Arguments

Options

TLS / Secure Connection options

zoweprofilesupdatezosmf-profile

z/OSMF Profile

Usage

zowe profiles update zosmf-profile <profileName> [options]

Positional Arguments

Zosmf Connection Options

Examples


zoweprovisioning

Perform z/OSMF provisioning tasks on Published Templates in the Service Catalog and Provisioned Instances in the Service Registry.

zoweprovisioningdelete

Deletes instance previously provisioned with z/OSMF cloud provisioning services.

zoweprovisioningdeleteinstance

Deletes selected deprovisioned instance.

Usage

zowe provisioning delete instance <name> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zoweprovisioninglist

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.

zoweprovisioninglistcatalog-templates

Lists the z/OSMF service catalog published templates.

Usage

zowe provisioning list catalog-templates [options]

Options

Zosmf Connection Options

Profile Options

Examples

zoweprovisioninglistinstance-info

List details about an instance provisioned with z/OSMF.

Usage

zowe provisioning list instance-info <name> [options]

Positional Arguments

Options

  Allowed values: extended, summary, vars, actions, full

Zosmf Connection Options

Profile Options

Examples

zoweprovisioninglistinstance-variables

List a set of variables and their values for a given name.

Usage

zowe provisioning list instance-variables <name> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zoweprovisioninglistregistry-instances

List the provisioned instances from the z/OSMF software registry.

Usage

zowe provisioning list registry-instances [options]

Options

Zosmf Connection Options

Profile Options

Examples

zoweprovisioninglisttemplate-info

List details about a template published with z/OSMF Cloud Provisioning.

Usage

zowe provisioning list template-info <name> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zoweprovisioningperform

Perform actions against instances provisioned with z/OSMF.

zoweprovisioningperformaction

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

Zosmf Connection Options

Profile Options

Examples

zoweprovisioningprovision

Using z/OSMF cloud provisioning services provision available templates.

zoweprovisioningprovisiontemplate

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

Options

Zosmf Connection Options

Profile Options

Examples


zowesecure-credential-store

Store credentials securely in profiles by encrypting them

zowesecure-credential-storeupdate

Updates all plain text profiles to be securely stored

Usage

zowe secure-credential-store update [options]


zowezos-console

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.

zowezos-consolecollect

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.

zowezos-consolecollectsync-responses

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 produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.

Usage

zowe zos-console collect sync-responses <responsekey> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-consoleissue

Issue z/OS console commands and optionally collect responses.

zowezos-consoleissuecommand

Issue a z/OS console command and print command responses (known as "solicited command responses").

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 produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.

Zowe CLI will issue "follow-up" API requests by default to collect any additional outstanding solicited command responses until a request returns no additional responses. At that time, Zowe CLI will attempt a final collection attempt. If no messages are present, the command is complete. If additional messages are present, the process is repeated. However, this does not guarantee that all messages produced in direct response (i.e. solicited) have been collected. The z/OS application may produce additional messages in direct response to your command at some point in the future. You can manually collect additional responses using the "command response key" OR specify additional processing options to, for example, delay collection attempts by a specified interval.

Usage

zowe zos-console issue command <commandtext> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples


zowezos-files

Manage z/OS data sets, create data sets, and more

zowezos-filescopy

Copy a data set

zowezos-filescopydata-set

Copy a data set to another data set

Usage

zowe zos-files copy data-set <fromDataSetName> <toDataSetName> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreate

Create data sets

zowezos-filescreatedata-set-binary

Create executable data sets

Usage

zowe zos-files create data-set-binary <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreatedata-set-c

Create data sets for C code programming

Usage

zowe zos-files create data-set-c <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreatedata-set-classic

Create classic data sets (JCL, HLASM, CBL, etc...)

Usage

zowe zos-files create data-set-classic <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreatedata-set-partitioned

Create partitioned data sets (PDS)

Usage

zowe zos-files create data-set-partitioned <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreatedata-set-sequential

Create physical sequential data sets (PS)

Usage

zowe zos-files create data-set-sequential <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreatedata-set-vsam

Create a VSAM cluster

Usage

zowe zos-files create data-set-vsam <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreateuss-directory

Create a UNIX directory.

Usage

zowe zos-files create uss-directory <ussPath> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreateuss-file

Create a UNIX file.

Usage

zowe zos-files create uss-file <ussPath> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filescreatezos-file-system

Create a z/OS file system.

Usage

zowe zos-files create zos-file-system <fileSystemName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesdelete

Delete a data set or Unix System Services file

zowezos-filesdeletedata-set

Delete a data set or data set member permanently

Usage

zowe zos-files delete data-set <dataSetName> [options]

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesdeletedata-set-vsam

Delete a VSAM cluster permanently

Usage

zowe zos-files delete data-set-vsam <dataSetName> [options]

Positional Arguments

Options

Required Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesdeleteuss-file

Delete a Unix Systems Services (USS) File or directory permanently

Usage

zowe zos-files delete uss-file <fileName> [options]

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesdeletezos-file-system

Delete a z/OS file system permanently.

Usage

zowe zos-files delete zos-file-system <fileSystemName> [options]

Positional Arguments

Required Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesdownload

Download content from z/OS data sets and USS files to your PC

zowezos-filesdownloadall-members

Download all members from a partitioned data set to a local folder

Usage

zowe zos-files download all-members <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesdownloaddata-set

Download content from a z/OS data set to a local file

Usage

zowe zos-files download data-set <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesdownloaduss-file

Download content from a USS file to a local file on your PC

Usage

zowe zos-files download uss-file <ussFileName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-fileshMigrate

Migrate data sets.

zowezos-fileshMigratedata-set

Migrate a data set.

Usage

zowe zos-files hMigrate data-set <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesinvoke

Invoke z/OS utilities such as Access Method Services (AMS)

zowezos-filesinvokeams-file

Submit control statements for execution by Access Method Services (IDCAMS). You can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets, and more. You must format the control statements exactly as the IDCAMS utility expects. For more information about control statements, see the IBM publication 'z/OS DFSMS Access Method Services Commands'.

Usage

zowe zos-files invoke ams-file <controlStatementsFile> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-filesinvokeams-statements

Submit control statements for execution by Access Method Services (IDCAMS). You can use IDCAMS to create VSAM data sets (CSI, ZFS, etc...), delete data sets, and more. You must format the control statements exactly as the IDCAMS utility expects. For more information about control statements, see the IBM publication 'z/OS DFSMS Access Method Services Commands'.

Usage

zowe zos-files invoke ams-statements <controlStatements> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-fileslist

List data sets and data set members. Optionally, you can list their details and attributes.

zowezos-fileslistall-members

List all members of a partitioned data set. To view additional information about each member, use the --attributes option under the Options section of this help text.

Usage

zowe zos-files list all-members <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-fileslistdata-set

List data sets that match a pattern in the data set name

Usage

zowe zos-files list data-set <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-fileslistfile-system

List all mounted filesystems, or the specific filesystem mounted at a given path, or the filesystem with a given filesystem name.

Usage

zowe zos-files list file-system [options]

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-fileslistuss-files

List USS files and directories in a UNIX file path

Usage

zowe zos-files list uss-files <path> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-filesmount

Mount z/OS UNIX file systems, such as HFS, ZFS, and more. This connects you to USS file systems.

zowezos-filesmountfile-system

Mount a UNIX file system on a specified directory.

Usage

zowe zos-files mount file-system <fileSystemName> <mountPoint> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesrename

Rename a data set or member.

zowezos-filesrenamedata-set

Rename a data set.

Usage

zowe zos-files rename data-set <beforeDataSetName> <afterDataSetName> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-filesrenamedata-set-member

Rename a data set member.

Usage

zowe zos-files rename data-set-member <dataSetName> <beforeMemberName> <afterMemberName> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-filesunmount

Unmount file systems, such as HFS, ZFS, and more. This disconnects you from USS file systems.

zowezos-filesunmountfile-system

Unmount a UNIX file system.

Usage

zowe zos-files unmount file-system <fileSystemName> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-filesupload

Upload the contents of a file to z/OS data sets

zowezos-filesuploaddir-to-pds

Upload files from a local directory to a partitioned data set (PDS)

Usage

zowe zos-files upload dir-to-pds <inputdir> <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesuploaddir-to-uss

Upload a local directory to a USS directory.

An optional .zosattributes file in the source directory can be used to control file conversion and tagging.

An example .zosattributes file:
# pattern local-encoding remote-encoding
# Don't upload the node_modules directory
.* -
*.jpg binary binary
# Convert CICS Node.js profiles to EBCDIC
*.profile ISO8859-1 EBCDIC

Lines starting with the ‘#’ character are comments. Each line can specify up to three positional attributes:

Due to a z/OSMF limitation, files that are transferred in text mode are converted to the default EBCDIC code page on the z/OS system. Therefore the only EBCDIC code page to specify as the remote encoding is the default code page for your system.

A .zosattributes file can either be placed in the top-level directory you want to upload, or its location can be specified by using the --attributes parameter. .zosattributes files that are placed in nested directories are ignored.

Usage

zowe zos-files upload dir-to-uss <inputDir> <USSDir> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesuploadfile-to-data-set

Upload the contents of a file to a z/OS data set

Usage

zowe zos-files upload file-to-data-set <inputfile> <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesuploadfile-to-uss

Upload content to a USS file from local file

Usage

zowe zos-files upload file-to-uss <inputfile> <USSFileName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-filesuploadstdin-to-data-set

Upload the content of a stdin to a z/OS data set

Usage

zowe zos-files upload stdin-to-data-set <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples


zowezos-ftp

Data set and job functionality via FTP. This functionality uses the open source zos-node-accessor package from IBM. Commands under this group require you to create a zftp profile before using them. If you find this functionality useful, please consider setting up z/OSMF on your system to get improved stability and speed and more features (for example, issuing TSO and console commands) by using core Zowe CLI.

zowezos-ftpdelete

Delete data sets, jobs, and USS files

zowezos-ftpdeletedata-set

Delete a data set

Usage

zowe zos-ftp delete data-set <dataSet> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpdeletejob

Cancel a job and purge its output. Note: this command will not work to delete TSU or STC type jobs.

Usage

zowe zos-ftp delete job <jobid> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpdeleteuss-file

Delete a USS file

Usage

zowe zos-ftp delete uss-file <ussFile> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpdownload

Download data set, job spool, and USS file content

zowezos-ftpdownloadall-spool-by-jobid

Download all spool content for a job to files in a local directory by providing the job id

Usage

zowe zos-ftp download all-spool-by-jobid <jobid> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpdownloaddata-set

Download the contents of a z/OS data set to a local file

Usage

zowe zos-ftp download data-set <dataSet> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpdownloaduss-file

Download the contents of a USS file to a local file

Usage

zowe zos-ftp download uss-file <ussFile> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftplist

List data sets, uss files, jobs, spool files

zowezos-ftplistdata-set

List all data sets that match a DSLEVEL pattern (see help below). The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets:volume, unit, referred, ext, used, recfm, lrecl, blksz, dsorg, and dsname.

Usage

zowe zos-ftp list data-set <pattern> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Response Format Options

Examples

zowezos-ftplistjobs

List all data sets that match a DSLEVEL pattern (see help below).

Usage

zowe zos-ftp list jobs [options]

Required Options

Options

TLS / Secure Connection options

Profile Options

Response Format Options

Examples

zowezos-ftplistspool-files-by-jobid

Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

Usage

zowe zos-ftp list spool-files-by-jobid <jobid> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Response Format Options

Examples

zowezos-ftplistuss-files

List USS files and subdirectories in a directory. The following values can be used with the --response-format-filter (--rff) argument todisplay more data from the data sets:name, size, owner, group, and permissions

Usage

zowe zos-ftp list uss-files <directory> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Response Format Options

Examples

zowezos-ftprename

Rename data sets and USS files or directories

zowezos-ftprenamedata-set

Rename a cataloged data set

Usage

zowe zos-ftp rename data-set <oldDataSet> <newDataSet> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftprenameuss-file

Rename a USS file or directory

Usage

zowe zos-ftp rename uss-file <olduss> <newuss> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpsubmit

Submit jobs from local files and data sets

zowezos-ftpsubmitdata-set

Submit a job from a cataloged data set containing JCL. The JCL will be downloaded via FTP and then submitted.

Usage

zowe zos-ftp submit data-set <dataSet> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Response Format Options

Examples

zowezos-ftpsubmitlocal-file

Submit a job from a local file containing JCL

Usage

zowe zos-ftp submit local-file <file> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Response Format Options

Examples

zowezos-ftpsubmitstdin

Submit a job from JCL written to the standard input (stdin) of this process.

Usage

zowe zos-ftp submit stdin [options]

Required Options

Options

TLS / Secure Connection options

Profile Options

Response Format Options

Examples

zowezos-ftpupload

Upload data set and USS content

zowezos-ftpuploadfile-to-data-set

Upload contents of a local file to a z/OS data set

Usage

zowe zos-ftp upload file-to-data-set <file> <dataSet> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpuploadfile-to-uss-file

Upload contents of a local to a Unix System Services file.

Usage

zowe zos-ftp upload file-to-uss-file <file> <ussFile> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpuploadstdin-to-data-set

Upload contents piped to stdin to a z/OS data set

Usage

zowe zos-ftp upload stdin-to-data-set <dataSet> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpuploadstdin-to-uss-file

Upload from stdin to a Unix System Services File

Usage

zowe zos-ftp upload stdin-to-uss-file <ussFile> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpview

View data sets, job output, and USS content

zowezos-ftpviewall-spool-by-jobid

View all spool content for a job by providing the job id

Usage

zowe zos-ftp view all-spool-by-jobid <jobid> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpviewdata-set

View the contents of a z/OS data set

Usage

zowe zos-ftp view data-set <dataSet> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpviewjob-status-by-jobid

View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints (expect for "no jobs found").

Usage

zowe zos-ftp view job-status-by-jobid <jobid> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Response Format Options

Examples

zowezos-ftpviewspool-file-by-id

View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

Usage

zowe zos-ftp view spool-file-by-id <jobid> <spoolfileid> [options]

Positional Arguments

Required Options

Options

TLS / Secure Connection options

Profile Options

Examples

zowezos-ftpviewuss-file

View the contents of a Unix System Services File

Usage

zowe zos-ftp view uss-file <ussFile> [options]

Positional Arguments

Options

Required Options

TLS / Secure Connection options

Profile Options

Examples


zowezos-jobs

Manage z/OS jobs.

zowezos-jobscancel

Cancel a single job by job ID. This cancels the job if it is running or on input.

zowezos-jobscanceljob

Cancel a single job by job ID

Usage

zowe zos-jobs cancel job <jobid> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-jobsdelete

Delete a single job by job ID in OUTPUT status. This cancels the job if it is running and purges its output from the system

zowezos-jobsdeletejob

Delete a single job by job ID

Usage

zowe zos-jobs delete job <jobid> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-jobsdownload

Download the output of a job as separate files.

zowezos-jobsdownloadoutput

Download all job output to a local directory. Each spool DD will be downloaded to its own file in the directory.

Usage

zowe zos-jobs download output <jobid> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-jobslist

List z/OS jobs and list the spool files (DDs) for a z/OS job on the JES/spool queues.

zowezos-jobslistjobs

List jobs on JES spool/queues. By default, the command lists jobs owned (owner) by the user specified in your z/OSMF profile. The default for prefix is "*". The command does not prevalidate your user ID. The command surfaces errors verbatim from the z/OSMF Jobs REST endpoints.

Usage

zowe zos-jobs list jobs [options]

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-jobslistspool-files-by-jobid

Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

Usage

zowe zos-jobs list spool-files-by-jobid <jobid> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-jobssubmit

Submit jobs (JCL) contained in data sets.

zowezos-jobssubmitdata-set

Submit a job (JCL) contained in a data set. The data set may be of type physical sequential or a PDS member. The command does not pre-validate the data set name. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

Usage

zowe zos-jobs submit data-set <dataset> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-jobssubmitlocal-file

Submit a job (JCL) contained in a local file. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

Usage

zowe zos-jobs submit local-file <localFile> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-jobssubmitstdin

Submit a job (JCL) passed to the command via the stdin stream. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

Usage

zowe zos-jobs submit stdin [options]

Options

Zosmf Connection Options

Profile Options

Response Format Options

zowezos-jobsview

View details of z/OS jobs on spool/JES queues.

zowezos-jobsviewjob-status-by-jobid

View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints (expect for "no jobs found").

Usage

zowe zos-jobs view job-status-by-jobid <jobid> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-jobsviewspool-file-by-id

View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.

Usage

zowe zos-jobs view spool-file-by-id <jobid> <spoolfileid> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples


zowezos-tso

Issue TSO commands and interact with TSO address spaces

zowezos-tsoissue

Issue TSO commands

zowezos-tsoissuecommand

Creates a TSO address space, issues a TSO command through the newly created address space, waits for the READY prompt to print the response, and terminates the TSO address space. All response data are returned to the user up to (but not including) the TSO 'READY' prompt.

Usage

zowe zos-tso issue command <commandText> [options]

Positional Arguments

Options

TSO ADDRESS SPACE OPTIONS

Zosmf Connection Options

Profile Options

Examples

zowezos-tsoping

Ping a TSO address space, from which you previously started and received a token (a.k.a 'servelet-key').

zowezos-tsopingaddress-space

Ping a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

Usage

zowe zos-tso ping address-space <servletKey> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples

zowezos-tsosend

Send data to TSO and collect responses until the prompt is reached

zowezos-tsosendaddress-space

Send data to the TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

Usage

zowe zos-tso send address-space <servletKey> [options]

Positional Arguments

Required Options

Zosmf Connection Options

Profile Options

Examples

zowezos-tsostart

Start TSO/E address space

zowezos-tsostartaddress-space

Start a TSO address space, from which you will receive a token (a.k.a 'servlet-key') for further address space interaction (e.g. termination).

Usage

zowe zos-tso start address-space [options]

TSO ADDRESS SPACE OPTIONS

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-tsostop

Stop TSO/E address space

zowezos-tsostopaddress-space

Stop a TSO address space, from which you previously started and received a token (a.k.a 'servlet-key').

Usage

zowe zos-tso stop address-space <servletkey> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Examples


zowezos-uss

Issue z/OS USS commands remotely using an SSH session. Output from the commands is displayed on the local terminal.

zowezos-ussissue

Issue a z/OS USS command

zowezos-ussissuessh

Issue a z/OS USS command

Usage

zowe zos-uss issue ssh <command> [options]

Positional Arguments

Options

z/OS Ssh Connection Options

Profile Options

Examples


zowezos-workflows

Create and manage z/OSMF workflows on a z/OS system

zowezos-workflowsarchive

Archive workflow instance in z/OSMF

zowezos-workflowsarchiveactive-workflow

Archive an active workflow instance in z/OSMF.

Usage

zowe zos-workflows archive active-workflow [options]

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-workflowscreate

Create a z/OSMF workflow on a z/OS system.

zowezos-workflowscreateworkflow-from-data-set

Create a z/OSMF workflow on a z/OS system using a Data set

Usage

zowe zos-workflows create workflow-from-data-set <workflowName> [options]

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-workflowscreateworkflow-from-local-file

Create a z/OSMF workflow on a z/OS system using a Local file

Usage

zowe zos-workflows create workflow-from-local-file <workflowName> [options]

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-workflowscreateworkflow-from-uss-file

Create a workflow instance in z/OSMF using a USS file

Usage

zowe zos-workflows create workflow-from-uss-file <workflowName> [options]

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-workflowsdelete

Delete an active workflow or an archived workflow from z/OSMF.

zowezos-workflowsdeleteactive-workflow

Delete an active workflow instance in z/OSMF

Usage

zowe zos-workflows delete active-workflow [options]

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-workflowsdeletearchived-workflow

Delete an archived workflow from z/OSMF

Usage

zowe zos-workflows delete archived-workflow [options]

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-workflowslist

List the z/OSMF workflows for a system or a sysplex with filter options.

zowezos-workflowslistactive-workflow-details

Get the details of an active z/OSMF workflow

Usage

zowe zos-workflows list active-workflow-details [options]

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-workflowslistactive-workflows

List active workflow instance(s) in z/OSMF. Multiple filters can be used together. Omitting all options will list all workflows on the sysplex

Usage

zowe zos-workflows list active-workflows [options]

Options

Zosmf Connection Options

Profile Options

Response Format Options

Examples

zowezos-workflowslistarchived-workflows

List the archived z/OSMF workflows for a system or sysplex.

Usage

zowe zos-workflows list archived-workflows [options]

Zosmf Connection Options

Profile Options

Response Format Options

zowezos-workflowslistdefinition-file-details

Retrieve the contents of a z/OSMF workflow definition from a z/OS system.

Usage

zowe zos-workflows list definition-file-details <definitionFilePath> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-workflowsstart

Start a z/OSMF workflow on a z/OS system.

zowezos-workflowsstartworkflow-full

Will run workflow from the beginning to the end or to the first manual step.

Usage

zowe zos-workflows start workflow-full [options]

Options

Zosmf Connection Options

Profile Options

Examples

zowezos-workflowsstartworkflow-step

Will run given step of workflow instance plus following steps if specified by --perform-following-steps option.

Usage

zowe zos-workflows start workflow-step <stepName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Examples


zowezosmf

Retrieve and show the properties of a z/OSMF web server

zowezosmfcheck

Confirm that z/OSMF is running on a specified system and gather information about the z/OSMF server for diagnostic purposes.

zowezosmfcheckstatus

Confirm that z/OSMF is running on a system specified in your profile and gather information about the z/OSMF server for diagnostic purposes. The command outputs properties of the z/OSMF server such as version, hostname, and installed plug-ins.

Usage

zowe zosmf check status [options]

Zosmf Connection Options

Profile Options

Examples

zowezosmflist

Obtain a list of systems that are defined to a z/OSMF instance.

zowezosmflistsystems

Obtain a list of systems that are defined to a z/OSMF instance.

Usage

zowe zosmf list systems [options]

Zosmf Connection Options

Profile Options

Examples