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

Options

Global Options


zoweauth

Connect to Zowe API Mediation Layer authentication service and obtain a token, or disconnect from the authentication service and revoke the token.

The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, you should omit username and password in service profiles so that the token in the base profile is used.

zoweauthlogin

Log in to an authentication service.

zoweauthloginapiml

Log in to Zowe API Mediation Layer authentication service and obtain or update a token.

The token provides authentication to services that support the API ML SSO (Single Sign-On) capability. When you log in, the token is stored in your default base profile until it expires. Base profiles store connection information shared by multiple services (e.g., z/OSMF), and are used if you do not supply connection information in a service profile. To take advantage of the API ML SSO capability, you should omit username and password in service profiles so that the token in the base profile is used.

Usage

zowe auth login apiml [options]

Options

Base Connection Options

Profile Options

Examples

zoweauthlogout

Log out of an authentication service.

zoweauthlogoutapiml

Log out of the Zowe API Mediation Layer authentication service and revoke the token so it can no longer authenticate. Also remove the token from the default base profile, if it is stored on disk.

Usage

zowe auth logout apiml [options]

Base Connection Options

Profile Options

Examples


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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Examples

zowecicsdeletetransaction

Delete a transaction from CICS.

Usage

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

Positional Arguments

Options

Cics Connection Options

Profile Options

Base Connection Options

Examples

zowecicsdeleteurimap

Delete a urimap from CICS.

Usage

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

Positional Arguments

Options

Cics Connection Options

Profile Options

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Examples

zowecicsdiscardtransaction

Discard a transaction from CICS.

Usage

zowe cics discard transaction <transactionName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Base Connection Options

Examples

zowecicsdiscardurimap

Discard a urimap from CICS.

Usage

zowe cics discard urimap <urimapName> [options]

Positional Arguments

Options

Cics Connection Options

Profile Options

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Examples

zowecicsinstalltransaction

Install a transaction to CICS.

Usage

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

Positional Arguments

Options

Cics Connection Options

Profile Options

Base Connection Options

Examples

zowecicsinstallurimap

Install a urimap to CICS.

Usage

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

Positional Arguments

Options

Cics Connection Options

Profile Options

Base Connection 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

Base Connection 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

Base Connection Options

Examples


zoweconfig

Manage JSON project and global configuration.

zoweconfigauto-init

Automatically generate a config from APIML.

Usage

zowe config auto-init [options]

Automatic Config Initialization Options

Options

APIML Connection Options

Profile Options

zoweconfigconvert-profiles

Convert v1 profiles to a global zowe.config.json file.

Usage

zowe config convert-profiles [options]

Options

Examples

zoweconfigedit

Edit an existing config file in your system's default text editor.

In a graphical environment, the application associated with JSON files will be launched. In a command-line environment, vi will be launched. To override the command-line editor used, specify it with the --editor option.

Usage

zowe config edit [options]

Options

Examples

zoweconfigimport

Import config files from another location on disk or from an Internet URL.

If the config `$schema` property points to a relative path, the schema will also be imported.

Usage

zowe config import <location> [options]

Positional Arguments

Options

Connection Options

Examples

zoweconfiginit

Initialize config files. Defaults to initializing "zowe.config.json" in the current working directory unless otherwise specified.

Use "--user-config" to init "zowe.config.user.json". Use "--global-config" to initialize the configuration files in your home "~/.zowe" directory.

Use "--no-prompt" to skip prompting for values in a CI environment.

Usage

zowe config init [options]

Options

Examples

zoweconfiglist

List config properties.

Usage

zowe config list [property] [options]

Positional Arguments

Options

Examples

zoweconfigprofiles

Displays profile paths.

Usage

zowe config profiles [options]

Examples

zoweconfigreport-env

Reports key items from your environment and identifies problem conditions.

Usage

zowe config report-env [options]

Examples

zoweconfigschema

Dumps the JSON schema for the config. The schema is dynamically created based on your available plugins. Direct the output of this command to a file and include in your config with '$schema' property to get editor completion.

Usage

zowe config schema [options]

Examples

zoweconfigsecure

Prompt for secure configuration properties.

Usage

zowe config secure [options]

Options

Examples

zoweconfigset

Create or update a configuration property.

Usage

zowe config set <property> [value] [options]

Positional Arguments

Options

Examples

zoweconfigupdate-schemas

Update schema files by looking up the directory structure.

Schema files up in higher level directories will always be updated. To also update schema files down in lower level directories, specify the `--depth` flag.

Usage

zowe config update-schemas [options]

Options

Examples


zowedaemon

Perform operations that control the daemon-mode functionality of the Zowe CLI. Daemon-mode runs the CLI command processor as a daemon to improve performance.

zowedaemondisable

Disable daemon-mode operation of the Zowe CLI.

Usage

zowe daemon disable [options]

Examples

zowedaemonenable

Enable daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.

Usage

zowe daemon enable [options]

Examples

zowedaemonrestart

Restart the Zowe CLI daemon.

Usage

zowe daemon restart [options]

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

Base Connection 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

Base Connection 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

Base Connection Options

Examples


zowedbm-db2

DBM-Db2 plug-in to interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

zowedbm-db2check

Perform DDL syntax checking.

zowedbm-db2checkddl

Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm generate ddl' command.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 check ddl <local-input-ddl-filename> [options]

Positional Arguments

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2compare

Compare DDL with a Db2 subsystem and produce an update script to implement changes.

zowedbm-db2compareddl

Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a high-level change summary report and a parseable impact analysis report. You can execute the script that is generated from this command using the 'zowe dbm execute compare-script' command.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]

Positional Arguments

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2deploy

Deploy DDL statements to a Db2 subsystem.

zowedbm-db2deployddl

Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 deploy ddl <local-input-ddl-filename> [options]

Positional Arguments

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2execute

Execute a script to implement Db2 object changes.

zowedbm-db2executecompare-script

Execute the compare script that was generated with the 'zowe dbm compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]

Positional Arguments

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2executemigration-script

Execute the migration script that was generated with the 'zowe dbm prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 execute migration-script <local-input-migrate-script-filename> [options]

Positional Arguments

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2executescript

Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 execute script <local-input-bp-script-filename> [options]

Positional Arguments

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2generate

Generate DDL statements for Db2 objects.

zowedbm-db2generateddl

Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm compare ddl' command.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 generate ddl [options]

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2prepare

Prepare DDL statements and a script to migrate Db2 objects.

zowedbm-db2preparemigration

Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm execute migration-script' command.

For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli

Usage

zowe dbm-db2 prepare migration [options]

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples


zoweendevor

Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.

zoweendevoradd

Add an Element into Endevor.

zoweendevoraddelement

The add element command lets you add an Element to an Environment entry Stage in Endevor.

Usage

zowe endevor add element <element> [options]

Positional Arguments

endevor-location definition options

input sources options

options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorapprove

Approve a Package in Endevor.

zoweendevorapprovepackage

The approve package command approves Package in Endevor for execution.

Usage

zowe endevor approve package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorbackin

Backin a Package in Endevor.

zoweendevorbackinpackage

The backin package command reverses the backout action and returns the Package to a status of Executed.

Usage

zowe endevor backin package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorbackout

Backout a Package in Endevor.

zoweendevorbackoutpackage

The backout package command restores the executable and output modules of the Package to the status they were in before execution.

Usage

zowe endevor backout package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorcast

Cast a Package in Endevor.

zoweendevorcastpackage

The cast package command prepares the Package for review and subsequent execution. Casting a Package freezes the contents of the Package and prevents further changes to the Package.

Usage

zowe endevor cast package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorcheck

Endevor Web Services Health Check.

zoweendevorcheckinstance

The check instance command triggers the web services health check for a given instance.

Usage

zowe endevor check instance [instance] [options]

Positional Arguments

endevor session definition options

endevor-location definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorcommit

Commit a Package in Endevor.

zoweendevorcommitpackage

The commit package command commits a Package, which removes all backout/backin data while retaining Package event information.

Usage

zowe endevor commit package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorconfirm

Confirm a manual conflict resolution inside an Endevor workspace file is complete.

zoweendevorconfirmresolution

Confirm a manual conflict resolution inside an Endevor workspace file is complete.

Usage

zowe endevor confirm resolution [workspace-file] [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zoweendevorcreate

Create a Package in Endevor.

zoweendevorcreatepackage

The create package command lets you create a package in Endevor.

Usage

zowe endevor create package [package] [options]

Positional Arguments

input sources options

options

endevor-location definition options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevordelete

Delete an Element or a Package in Endevor.

zoweendevordeleteelement

The delete element command deletes an Element from the specified inventory location in Endevor.

Usage

zowe endevor delete element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevordeletepackage

The delete package command lets you delete Packages of any status type in Endevor.

Usage

zowe endevor delete package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevordeny

Deny a Package in Endevor.

zoweendevordenypackage

The deny package command changes the status of a Package to Denied.

Usage

zowe endevor deny package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorexecute

Execute a Package in Endevor.

zoweendevorexecutepackage

The execute package command executes a Package that have a status of Approved or Execfailed.

Usage

zowe endevor execute package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorgenerate

Generate an Element in Endevor.

zoweendevorgenerateelement

The generate element command executes the generate Processor for the current level of the Element.

Usage

zowe endevor generate element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorinitialize

Initialize a directory as an Endevor workspace.

zoweendevorinitializeworkspace

Initialize current directory as an Endevor workspace.

Usage

zowe endevor initialize workspace [workspace-dir] [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zoweendevorlist

List instances, elements, types, packages and inventory locations in Endevor.

zoweendevorlistcode-page-config

The list code-page-config command lists the EBCDIC code page mapping rules used by Endevor Web Services

Usage

zowe endevor list code-page-config [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistdefaults

List the contents of the main Endevor configuration table (C1DEFLTS)

Usage

zowe endevor list defaults [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistdialog

List the contents of the Endevor ISPF dialog defaults table (ENDIECFG)

Usage

zowe endevor list dialog [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistelements

The list elements command lists element information in Endevor

Usage

zowe endevor list elements [element] [options]

Positional Arguments

endevor-location definition options

options

endevor search text options

scl generation options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistenvironments

The list environments command lists environments in Endevor

Usage

zowe endevor list environments [environment] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistfeatures

List the contents of the Endevor optional features table (ENCOPTBL)

Usage

zowe endevor list features [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistinstances

The list instances command lists instances used by Endevor Web Services

Usage

zowe endevor list instances [options]

endevor session definition options

output customization options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistpackages

The list packages command lists package information in Endevor

Usage

zowe endevor list packages [package] [options]

Positional Arguments

options

endevor-location definition options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistprocessor-groups

The list processor-groups command lists processor group information in Endevor

Usage

zowe endevor list processor-groups [proc-group] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistprocessor-symbols

The list processor-symbols command lists processor group symbol overrides information in Endevor

Usage

zowe endevor list processor-symbols [proc-group] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorliststages

The list stages command lists stages in Endevor

Usage

zowe endevor list stages [stage] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistsubsystems

The list subsystems command lists subsystem information in Endevor

Usage

zowe endevor list subsystems [subsystem] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistsymbols

List the Endevor site symbols

Usage

zowe endevor list symbols [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistsystems

The list systems command lists system information in Endevor

Usage

zowe endevor list systems [system] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlisttasks

List asynchronous tasks submitted by this user

Usage

zowe endevor list tasks [task-id] [options]

Positional Arguments

asynchronous task options

endevor session definition options

endevor-location definition options

output customization options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlisttype-sequence

List the contents of the Endevor type sequence

Usage

zowe endevor list type-sequence [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlisttypes

The list types command lists type information in Endevor

Usage

zowe endevor list types [type] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevormerge

Merge Endevor elements from one Endevor location into another

zoweendevormergeelement

Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use "synchronize workspace" command afterwards to push the result back into Endevor.

Usage

zowe endevor merge element [element] [options]

Positional Arguments

endevor-location definition options

merge-location definition options

workspace options

options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevormove

Move an Element in Endevor.

zoweendevormoveelement

The move element command moves Elements between inventory locations along a map.

Usage

zowe endevor move element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorprint

Print an Element or a Component in Endevor.

zoweendevorprintcomponents

The print component command prints selected component information about Element in Endevor.

Usage

zowe endevor print components <element> [options]

Positional Arguments

endevor-location definition options

options

output customization options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorprintelement

The print element command prints selected information about Element in Endevor.

Usage

zowe endevor print element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

output customization options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorprintmember

The print member command prints a member from a specified dataset.

Usage

zowe endevor print member <member> [options]

Positional Arguments

input sources options

options

asynchronous task options

output customization options

endevor session definition options

endevor-location definition options

Profile Options

Base Connection Options

Examples

zoweendevorqueryacm

Query Elements and information about their components in Endevor.

zoweendevorqueryacmcomponents

Query components used by a specified Element with the Endevor ACM Query facility.

Usage

zowe endevor queryacm components <element> [options]

Positional Arguments

endevor-location definition options

options

output customization options

asynchronous task options

endevor session definition options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorreset

Reset a Package in Endevor.

zoweendevorresetpackage

The reset package command lets you set the status of a Package back to In-edit so you can modify it.

Usage

zowe endevor reset package [package] [options]

Positional Arguments

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorretrieve

Retrieve an Element in Endevor.

zoweendevorretrieveelement

The retrieve element command retrieves an existing element in Endevor.

Usage

zowe endevor retrieve element <element> [options]

Positional Arguments

endevor-location definition options

options

output location options

output customization options

bulk action options

endevor session definition options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorretrieveresult

Retrieve the result of an asynchronous task

Usage

zowe endevor retrieve result [task-id] [options]

Positional Arguments

endevor session definition options

endevor-location definition options

output customization options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorsignin

Signin an Element in Endevor.

zoweendevorsigninelement

The signin element command signs in an existing element in Endevor.

Usage

zowe endevor signin element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorsubmit

Submit a Package or a SCL file in Endevor.

zoweendevorsubmitpackage

The submit package command submits a JCL job stream to execute one or more Packages.

Usage

zowe endevor submit package [package] [options]

Positional Arguments

input sources options

output location options

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorsubmitscl

The submit scl commands submits a SCL file to be executed.

Usage

zowe endevor submit scl [options]

options

input sources options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorsynchronize

Synchronize remote Endevor inventory with the local Endevor workspace.

zoweendevorsynchronizeworkspace

Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace

Usage

zowe endevor synchronize workspace [workspace-dir] [options]

Positional Arguments

endevor-location definition options

options

workspace options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevortransfer

Transfer an Element in Endevor.

zoweendevortransferelement

The Transfer element command transfers Elements from one Endevor location to another.

Usage

zowe endevor transfer element <element> [options]

Positional Arguments

endevor-location definition options

output location options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorunsynchronize

Remove a synchronized Endevor inventory from a local Endevor workspace and delete any related metadata.

zoweendevorunsynchronizeworkspace

Remove a selected subset of remote Endevor inventory from a local Endevor workspace

Usage

zowe endevor unsynchronize workspace [workspace-dir] [options]

Positional Arguments

endevor-location definition options

workspace options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorupdate

Update an Element or a Package in Endevor.

zoweendevorupdateelement

The update element command updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage.

Usage

zowe endevor update element <element> [options]

Positional Arguments

input sources options

endevor-location definition options

options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorupdatepackage

The update package command lets you update a package in Endevor.

Usage

zowe endevor update package [package] [options]

Positional Arguments

input sources options

options

endevor-location definition options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorview

View an Element or a Package SCL in Endevor.

zoweendevorviewelement

The view element command views an existing element in Endevor.

Usage

zowe endevor view element <element> [options]

Positional Arguments

endevor-location definition options

options

output customization options

asynchronous task options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorviewpkgscl

The view pkgscl command views the SCL of an existing package in Endevor.

Usage

zowe endevor view pkgscl [package] [options]

Positional Arguments

endevor-location definition options

output customization options

endevor session definition options

Profile Options

Base Connection 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

Base Connection Options

Examples


zoweomspool

Interact with Output Management Spool™ for z/OS (OM Spool)

zoweomspoolissue

Issue OM Spool commands.

zoweomspoolissuecommand

Issue commands to work with OM Spool.

Usage

zowe omspool issue command <command-text> [options]

Positional Arguments

OM SPOOL OPTIONS

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zoweops

Interact with OPS/MVS® for automation administration and resource management.

zoweopscreate

Create a generic AOF event for API rules processing.

zoweopscreateevent

Create a generic AOF event for API rules processing

Usage

zowe ops create event <eventCode> <eventText> [options]

Positional Arguments

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsdisable

Disable an Automated Operations Facility rule.

zoweopsdisablerule

Disable the specified rule.

Usage

zowe ops disable rule <ruleset> <rule> [options]

Positional Arguments

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsenable

Enable an Automated Operations Facility rule.

zoweopsenablerule

Enable the specified rule.

Usage

zowe ops enable rule <ruleset> <rule> [options]

Positional Arguments

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsexecute

Execute an OPS/MVS REXX program or an operator command.

zoweopsexecutecommand

Execute the specified operator command.

Usage

zowe ops execute command <command> [options]

Positional Arguments

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsexecuterexx

Execute the specified OPS/MVS REXX program.

Usage

zowe ops execute rexx <program> [options]

Positional Arguments

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsshow

Display data associated with OPS/MVS automation elements, such as AOF rules and rulesets, and SSM resources, OPS log names, subsystems and RDF tables, or REST API server status.

zoweopsshowlogname

Display a list of the OPSLOG lognames that are defined to the specified subsystem. The list also identifies the live OPSLOG. This command is only available when connected to the OPS/MVS REST API server.

Usage

zowe ops show logname [options]

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsshowresource

Display data associated with the specified SSM resource. Currently, only the current and desired states of the resource are displayed.

Usage

zowe ops show resource <resourcename> [options]

Positional Arguments

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsshowrule

Display data associated with the specified rule.

Usage

zowe ops show rule <ruleset> <rule> [options]

Positional Arguments

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsshowruleset

Display data associated with one or all rulesets for a specified subsystem. This command is only available when connected to the OPS/MVS REST API server.

Usage

zowe ops show ruleset [options]

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsshowstatus

Display data associated with an OPS/MVS REST API server. This command is only available when connected to the OPS/MVS REST API server.

Usage

zowe ops show status [options]

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsshowsubsystem

Display a list of the OPS/MVS subsystems that are running on the host z/OS LPAR. This command is only available when connected to the OPS/MVS REST API server.

Usage

zowe ops show subsystem [options]

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsshowtable

Display a list of the RDF tables that are defined to the specified subsystem. This command is only available when connected to the OPS/MVS REST API server.

Usage

zowe ops show table [options]

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsstart

Start a System State Manager resource.

zoweopsstartresource

Start the specified resource. The desired state of the resource is set to the appropriate UP state and SSM takes action to start the resource.

Usage

zowe ops start resource <resourcename> <tablename> [options]

Positional Arguments

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection Options

Examples

zoweopsstop

Stop a System State Manager resource.

zoweopsstopresource

Stop the specified resource. The desired state of the resource is set to the appropriate DOWN state and SSM takes action to stop the resource.

Usage

zowe ops stop resource <resourcename> <tablename> [options]

Positional Arguments

Options

OPS/MVS Web Services / REST API connection options

Profile Options

Base Connection 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]

Options

zowepluginsshow-first-steps

Show first steps required to set up plug-in for use.

Usage

zowe plugins show-first-steps [plugin] [options]

Positional Arguments

Examples

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

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

Base Connection 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

Base Connection Options

Examples

zoweprovisioninglistinstance-info

List details about an instance provisioned with z/OSMF.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Examples


zowesysview

Zowe CLI plugin for SYSVIEW

zowesysviewcapture

Display output from a primary command stored in a SYSVIEW capture data set

Usage

zowe sysview capture <capture-dsn> <capture-command> [options]

Positional Arguments

data options

display options

response format options

sysview connection options

Profile Options

Base Connection Options

Examples

zowesysviewcapture-immediate

Submit a capture request2

Usage

zowe sysview capture-immediate <capture-file> [options]

Positional Arguments

display options

data options

sysview connection options

Profile Options

Base Connection Options

Examples

zowesysviewcheck

Confirm that the SYSVIEW REST server is running on a specified system.

zowesysviewcheckstatus

Confirm that the SYSVIEW REST server is running on a system specified. The command outputs properties of the z/OS system and the SYSVIEW REST server.

Usage

zowe sysview check status [options]

sysview connection options

Profile Options

Base Connection Options

Examples

zowesysviewdisplay

Issue a SYSVIEW primary command and display output, including any messages

Usage

zowe sysview display <command-string> [options]

Positional Arguments

data options

display options

response format options

sysview connection options

Profile Options

Base Connection Options

Examples

zowesysviewexecute

Issue a SYSVIEW function command and display any messages

Usage

zowe sysview execute <command-string> [options]

Positional Arguments

display options

data options

sysview connection options

Profile Options

Base Connection Options

Examples


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

Base Connection 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

Base Connection Options

Examples


zowezos-files

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

zowezos-filescompare

Compare the contents of z/OS data sets or USS files in your terminal (stdout).

zowezos-filescomparedata-set

Compare the contents of two z/OS data sets in your terminal (stdout).

Usage

zowe zos-files compare data-set <dataSetName1> <dataSetName2> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescomparelocal-file-data-set

Compare the contents of a local file and a z/OS data set in your terminal (stdout).

Usage

zowe zos-files compare local-file-data-set <localFilePath> <dataSetName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescomparelocal-file-spool-dd

Compare the contents of a local file and a spool dd in your terminal (stdout).

Usage

zowe zos-files compare local-file-spool-dd <localFilePath> <spoolDescription> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescomparelocal-file-uss-file

Compare the contents of a local file and a z/OS USS file in your terminal (stdout).

Usage

zowe zos-files compare local-file-uss-file <localFilePath> <ussFilePath> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescomparespool-dd

Compare the contents of two spool dds in your terminal (stdout).

Usage

zowe zos-files compare spool-dd <spoolDescription1> <spoolDescription2> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescompareuss-files

Compare the contents of two z/OS USS files in your terminal (stdout).

Usage

zowe zos-files compare uss-files <ussFilePath1> <ussFilePath2> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

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

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescopydata-set-cross-lpar

Copy a data set to another data set on a specified LPAR.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreate

Create data sets.

zowezos-filescreatedata-set

Create data sets based on the properties of an existing data set.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Examples

zowezos-filesdeletemigrated-data-set

Delete migrated data sets.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection 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

Base Connection 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

Options

Profile Options

Base Connection 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

Base Connection 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

Base Connection Options

Examples

zowezos-filesdownloaddata-sets-matching

Download all data sets that match a DSLEVEL pattern (see help below). You can use several options to qualify which data sets will be skipped and how the downloaded files will be structured. Data sets that are neither physical sequential nor partitioned data sets (with members) will be excluded.

Usage

zowe zos-files download data-sets-matching <pattern> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownloaduss-directory

Download content from a USS directory to a local directory on your PC.

Usage

zowe zos-files download uss-directory <ussDirName> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection 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

Base Connection Options

Examples

zowezos-filesedit

Edit the contents of a data set or USS file with your terminal and default editor.

zowezos-fileseditdata-set

Edit content from a z/OS data set with your terminal and default editor.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesedituss-file

Edit content from a Unix System Services (USS) file with your terminal and default editor.

Usage

zowe zos-files edit uss-file <ussFilePath> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection 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

Options

Profile Options

Base Connection 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

Options

Profile Options

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Response Format Options

Examples

zowezos-filesmigrate

Migrate data sets.

zowezos-filesmigratedata-set

Migrate a data set.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection 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

Base Connection Options

Examples

zowezos-filesrecall

Recall migrated data sets.

zowezos-filesrecalldata-set

Recall a migrated data set.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection 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

Options

Profile Options

Base Connection 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

Options

Profile Options

Base Connection Options

Examples

zowezos-filessearch

Search files for a search term.

zowezos-filessearchdata-sets

Search all data sets and PDS members that match the data set name for a search term.

Usage

zowe zos-files search data-sets <pattern> <searchString> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection 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

Options

Profile Options

Base Connection Options

Examples

zowezos-filesupload

Upload the contents of a file to 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

Base Connection 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
node_modules -
# Don't upload files that start with periods
.* -
# Upload jpg images in binary
*.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:

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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Examples

zowezos-filesview

View the contents of a data set or USS file on your terminal (stdout).

zowezos-filesviewdata-set

View content from a z/OS data set on your terminal (stdout).

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesviewuss-file

View content from a Unix System Services (USS) file on your terminal (stdout).

Usage

zowe zos-files view uss-file <file> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection 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-ftpallocate

Allocate a sequential or partitioned dataset

zowezos-ftpallocatedata-set

Allocate a sequential dataset or partitioned dataset with '--dcb "PDSTYPE=PDS"'

Usage

zowe zos-ftp allocate data-set <datasetName> [options]

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdeleteuss-file

Delete a USS file

Usage

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

Positional Arguments

Required Options

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftplist

List data sets, data set members, 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistdata-set-members

List all members of the specified PDS or PDSE data set.

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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]

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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.

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistuss-files

List USS files and subdirectories in a directory. Optional file name pattern like "prefix*", "*suffix", or "prefix*suffix" can be specified at the end of directory. See EXAMPLES section.

The following values can be used with the --response-format-filter (--rff) argument to display more data from the data sets: name, size, owner, group, and permissions.

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpmake

Make a USS directory

zowezos-ftpmakeuss-directory

Make a Unix System Services Directory

Usage

zowe zos-ftp make uss-directory <ussDirectory> [options]

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftprenameuss-file

Rename a USS file or directory

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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]

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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.

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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.

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection 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

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsdelete

Delete a single job by job ID or delete multiple jobs in OUTPUT status.

zowezos-jobsdeletejob

Delete a single job by job ID.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsdeleteold-jobs

Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by your user ID that are in output status.

Usage

zowe zos-jobs delete old-jobs [options]

Options

Zosmf Connection Options

Profile Options

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Response Format Options

Examples

zowezos-jobsmodify

Modify the job class or the hold status of a job.

zowezos-jobsmodifyjob

Modify the job class or the hold status of a job.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobssearch

Search the spool output of a job.

zowezos-jobssearchjob

Search the spool output of a job.

Usage

zowe zos-jobs search job <jobname> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobssubmit

Submit a job (JCL).

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

Base Connection 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

Base Connection 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

Base Connection Options

Response Format Options

Examples

zowezos-jobssubmituss-file

Submit a job (JCL) contained in a USS file. The command does not pre-validate the USS file path. 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 uss-file <file> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobsview

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

zowezos-jobsviewall-spool-content

View the contents of each spool file from a z/OS job on spool/JES 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 view all-spool-content <jobid> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

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

Base Connection 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

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezos-logs

Interact with z/OS logs.

zowezos-logslist

List z/OS logs by invoking z/OSMF REST API.

zowezos-logslistlogs

List z/OS operlog within a time range.

Use this operation to get the z/OS operations logs. It invokes z/OSMF REST API to retrieve logs.

Executing 'zowe zos-logs list logs' will by default return logs from current time and backwards to 10 minutes before.

Note: OPERLOG needs to be configured on z/OS server.

Usage

zowe zos-logs list logs [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezos-ssh

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

zowezos-sshissue

Issue a z/OS USS command.

zowezos-sshissuecommand

Issue a z/OS USS command

Note: The common CLI 'Base Connection Options' of token-type and token-value are not applicable to the ssh command, since the ssh service is not accessible through APIML.

Usage

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

Positional Arguments

Options

z/OS Ssh Connection Options

Profile Options

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection 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

Base Connection Options

Examples