zowe

Welcome to Zowe CLI!

Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.

For additional Zowe CLI documentation, visit https://docs.zowe.org

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

Global Options


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


zoweca7

Welcome to the CA 7 Zowe CLI!

zoweca7cancel

For CPU jobs, the CANCEL command only removes the job from the queues.
For XPJOB jobs, the CANCEL command removes the job from the queues.
For agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.

zoweca7canceljobnumber

Indicates the individual job to cancel, and the value must be a CA 7 job number.

Usage

zowe ca7 cancel jobnumber <jobnumber> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7demand

Demand a single job to CA 7.

zoweca7demandjob

The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
JOB and JOBL are mutually exclusive.

Usage

zowe ca7 demand job <job> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7demandjobl

The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

Usage

zowe ca7 demand jobl <jobl> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7demandh

Demand a single job to CA 7 and hold.

zoweca7demandhjob

The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

Usage

zowe ca7 demandh job <job> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7demandhjobl

The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.

Usage

zowe ca7 demandh jobl <jobl> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7jobstatus

Retrieve job status information from CA 7.

zoweca7jobstatusjobnumber

Indicates the individual job to retrieve, and the value must be a CA 7 job number.

Usage

zowe ca7 jobstatus jobnumber <jobnumber> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7release

Release a single job to CA 7.

zoweca7releasejobnumber

Indicates the individual job to release, and the value must be a CA 7 job number.

Usage

zowe ca7 release jobnumber [jobnumber] [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7restart

Restart a single job to CA 7.

zoweca7restartjobnumber

Indicates the individual job to Restart, and the value must be a CA 7 job number.

Usage

zowe ca7 restart jobnumber <jobnumber> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7run

Run a single job to CA 7.

zoweca7runjob

The value must be a job name.
If the job has not been defined in the database, this name must also match the member name for the JCL unless the job is defined in the database.
this name must also match the member name for the JCL unless the job is defined in the database.
See also JCLID. JOB and JOBL are mutually exclusive.

Usage

zowe ca7 run job <job> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7runjobl

The ran jobs are placed in the request queue and assigned a unique CA 7 job number.

Usage

zowe ca7 run jobl <jobl> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7runh

Run and hold a single job to CA 7.

zoweca7runhjob

The ran jobs are placed in the request queue and assigned a unique CA 7 job number.

Usage

zowe ca7 runh job <job> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7runhjobl

The ran jobs are placed in the request queue and assigned a unique CA 7 job number.

Usage

zowe ca7 runh jobl <jobl> [options]

Positional Arguments

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples


zowecaspool

Interact with Spool™

zowecaspoolissue

Issue Spool commands.

zowecaspoolissuecommand

Issue commands to work with Spool.

Usage

zowe caspool issue command <commandText> [options]

Positional Arguments

SPOOL OPTIONS

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowecaview

Access View data and perform related tasks.

zowecaviewdownload

Download View report data to local folder.

zowecaviewdownloadreport

Download report data.
Optionally convert text report to PDF.

Usage

zowe caview download report <repositoryId> <reportHandle> [fileTarget] [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewexport

Export View text report file to local folder.

zowecaviewexportreport

Export text report to spreadsheet using a predefined export rule.

Usage

zowe caview export report <repositoryId> <reportHandle> <ruleId> [fileTarget] [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewget

Get information from View repository.

zowecaviewgetuser

Get user information from repository.

zowecaviewgetusersettings

Get current user settings from repository.

Usage

zowe caview get user settings <repositoryId> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewlist

List View repository, report, and user information.

zowecaviewlistexport-rules

List export rules defined for a report.
Use the returned 'Identifier' in the 'export report' command to reference that rule.

Usage

zowe caview list export-rules <reportId> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewlistreport

List information about a specific report.

zowecaviewlistreportindex-names

List indexes for a a specific report.
Use the returned 'IndexNameHandle' to reference a report index.
Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values for that index.

Usage

zowe caview list report index-names <repositoryId> <reportHandle> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewlistreportindex-values

List index values for a report index.
Use the returned 'ReportHandle' to reference an index value in other commands.
For example, use 'ReportHandle' in the 'download report' command to download that corresponding view of the report.

Usage

zowe caview list report index-values <repositoryId> <reportHandle> <indexNameHandle> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewlistreportlogical-views

List logical views available for a specific report.
Use the returned 'ReportHandle' to reference a logical view in other commands.
For example, use 'ReportHandle' in the 'download report' command to download the logical view of that report.
Use the returned 'IndexNameHandle' in the 'list report index-values' command to retrieve the list of associated index values (if defined) for that index.

Usage

zowe caview list report logical-views <repositoryId> <reportHandle> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewlistreports

List reports in a repository.
Use the returned 'ReportHandle' to reference a report in other commands.
For example, use the 'ReportHandle' in the 'download report' command to download that report.

Usage

zowe caview list reports <repositoryId> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewlistrepositories

List repositories.
Use the returned 'Identifier' to reference a repository in other commands.
For example, use the 'Identifier' in the list reports' command to list reports in that repository.

Usage

zowe caview list repositories [options]

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewsearch

Search data in a View repository.

zowecaviewsearchindex

Search cross-report index data in a repository.

zowecaviewsearchindexnames

Search cross-report index names in a repository.
Use the returned 'IndexNameHandle' to reference a cross-report index name.
For example, use the 'IndexNameHandle' in the 'search index values' command to retrieve the list of index values for that cross-report index.

Usage

zowe caview search index names <repositoryId> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewsearchindexreports

Search reports containing a cross-report index value in a repository.
Use the returned 'ReportHandle' to reference a view of the report.
For example, use the 'ReportHandle' in the 'download report' command to download that view of the report.

Usage

zowe caview search index reports <repositoryId> <indexNameHandle> <valueHandle> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewsearchindexvalues

Search cross-report index values in a repository.
Use the returned 'IndexValueHandle' in the 'search index reports' command to retrieve the list of reports containing that index value.

Usage

zowe caview search index values <repositoryId> <indexNameHandle> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewset

Set information in View repository.

zowecaviewsetuser

Set configuration for current user in repository.

zowecaviewsetuserdistribution

Set distribution id for current user in repository.

Usage

zowe caview set user distribution <repositoryId> <distributionId> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options

zowecaviewsetusermode

Set mode for current user in repository.

Usage

zowe caview set user mode <repositoryId> <mode> [options]

Positional Arguments

Options

View Connection Options

Profile Options

Base Connection Options


zowecics

Interact with IBM CICS programs and transactions.

zowecicsadd-to-list

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

zowecicsadd-to-listcsdGroup

Add a CSD Group to a CICS CSD List.

Usage

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

Positional Arguments

Options

Cics Connection Options

Profile Options

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


zowecics-deploy

CICS bundle deployment plugin.

zowecics-deploydeploy

Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. A BUNDLE resource is installed, ENABLED and made AVAILABLE in the target scope of the CICSplex.

zowecics-deploydeploybundle

Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. The DFHDPLOY utility is used to install and make available a BUNDLE resource in the target group of CICS regions.

Usage

zowe cics-deploy deploy bundle [options]

cics-deploy Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowecics-deploygenerate

Generate a CICS bundle and associated metadata files in the current working directory. This allows the application in the current working directory to be deployed to CICS.

zowecics-deploygeneratebundle

Generate a CICS bundle in the working directory. The associated data is constructed from a combination of the command-line options and the contents of package.json. If package.json exists, no options are required. If package.json does not exist, both --start-script and --nodejsapp are required.

Usage

zowe cics-deploy generate bundle [options]

cics-deploy Options

Examples

zowecics-deploypush

Push combines several actions for deploying a bundle to CICS into a single command. It uploads the bundle to z/OS, optionally runs an 'npm install' command on the remote system, then uses DFHDPLOY to install and enable the bundle in a target CICS environment.

zowecics-deploypushbundle

Push a CICS bundle from the working directory to a target CICSplex.

Usage

zowe cics-deploy push bundle [options]

cics-deploy Options

Zosmf Connection Options

z/OS Ssh Connection Options

CICS Connection Options

Profile Options

Base Connection Options

Examples

zowecics-deployundeploy

Undeploy a CICS bundle from one or more CICS regions within a CICSplex. A BUNDLE resource is made UNAVAILABLE, it is then DISABLED and DISCARDED from the target scope with the CICSplex.

zowecics-deployundeploybundle

Undeploy a CICS bundle from one or more CICS regions within a CICSplex. The DFHDPLOY utility is used to undeploy and remove a BUNDLE resource from the target group of CICS regions.

Usage

zowe cics-deploy undeploy bundle [options]

cics-deploy Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zoweconfig

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

zoweconfigget

Get a value of single setting option.

Usage

zowe config get <configName> [options]

Positional Arguments

Examples

zoweconfiglist

List all configuration setting options.

Usage

zowe config list [options]

Options

Examples

zoweconfigreset

Reset a configuration setting to default value.

Usage

zowe config reset <configName> [options]

Positional Arguments

Examples

zoweconfigset

Set a configuration setting.

Usage

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

Positional Arguments

Examples


zowedb2

Interact with IBM Db2 for z/OS

zowedb2call

Call a Db2 stored procedure

zowedb2callprocedure

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

Usage

zowe db2 call procedure <routine> [options]

Positional Arguments

Options

DB2 Connection Options

Profile Options

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.

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-db2 generate ddl' command.

Usage

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

Positional Arguments

Required Options

Options

Profile 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 summary report that provides a high-level overview of the changes. You can execute the script that is generated from this command using the 'zowe dbm-db2 execute compare-script' command.

Usage

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

Positional Arguments

Required Options

Options

Profile 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.

Usage

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

Positional Arguments

Required Options

Options

Profile 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-db2 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.

Usage

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

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowedbm-db2executemigration-script

Execute the migration script that was generated with the 'zowe dbm-db2 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.

Usage

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

Positional Arguments

Options

Profile 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-db2 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.

Usage

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

Positional Arguments

Options

Profile 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-db2 compare ddl' command.

Usage

zowe dbm-db2 generate ddl [options]

Options

Required Options

Profile 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-db2 execute migration-script' command.

Usage

zowe dbm-db2 prepare migration [options]

Options

Required Options

Profile 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

output customization options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition options

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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorlist

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

zoweendevorlistelements

The list elements command lists element information in Endevor

Usage

zowe endevor list elements [element] [options]

Positional Arguments

endevor-location definition options

options

scl generation options

output customization options

endevor session definition 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

output customization options

endevor session definition 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

endevor-location definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor session definition 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

output customization options

endevor session definition 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

output customization options

endevor session definition 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

output customization options

endevor session definition options

Profile Options

Base Connection Options

Response Format 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

output customization options

endevor session definition 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 location 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

output location options

output customization options

endevor session 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

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

output customization options

endevor-location definition options

endevor session definition 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

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

output customization options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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

output customization options

endevor-location definition 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

output customization 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

output customization options

endevor session definition 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

output customization options

endevor-location definition options

endevor session definition 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 location options

output customization 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 location options

output customization options

endevor session definition options

Profile Options

Base Connection Options

Examples


zoweendevor-bridge-for-git

Use the CA Endevor Bridge for Git plug-in to manage your Git-Endevor mappings and build your local Git changes before synchronizing them to Endevor.

zoweendevor-bridge-for-gitbuild

Build changes from git local repository in Endevor

zoweendevor-bridge-for-gitbuildexecute

Build changes against remote git repository's CA Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.

Usage

zowe endevor-bridge-for-git build execute [options]

Required Options

Endevor work area options

Options

Endevor options (alternatively use an 'endevor' profile)

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevor-bridge-for-gitbuildjob-report

Get the report after executing 'build job-submit' command. This this command must be issued to finalize processing.

Usage

zowe endevor-bridge-for-git build job-report [options]

Required Options

Options

Endevor options (alternatively use an 'endevor' profile)

z/OSMF connection options (alternatively use a 'zosmf' profile)

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevor-bridge-for-gitbuildjob-submit

Build changes from git local repository in Endevor by submitting a job. It supports autogen for building dependencies using with the option of selecting autogen span. After submitting, the command 'build job-report' must be issued to finalize processing.

Usage

zowe endevor-bridge-for-git build job-submit [options]

Required Options

Endevor work area options

Options

Endevor options (alternatively use an 'endevor' profile)

z/OSMF connection options (alternatively use a 'zosmf' profile)

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevor-bridge-for-gitendevor-credentials

Manage your Endevor credentials stored in CA Endevor Bridge for Git.

zoweendevor-bridge-for-gitendevor-credentialsupdate

Update your Endevor credentials for a Git-Endevor mapping.

Usage

zowe endevor-bridge-for-git endevor-credentials update <context> <mapping> [options]

Positional Arguments

Endevor options (alternatively use an 'endevor' profile)

CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitmapping

Manage the Git-Endevor mappings.

zoweendevor-bridge-for-gitmappingadd-element

Add an element from up the map in your CA Endevor to your Git repository.

Usage

zowe endevor-bridge-for-git mapping add-element <context> <mapping> [options]

Positional Arguments

Options

Endevor options (alternatively use an 'endevor' profile)

CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitmappingcreate

Create a Git-Endevor mapping

Usage

zowe endevor-bridge-for-git mapping create [options]

Options

Endevor options (alternatively use an 'endevor' profile)

CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitmappingdelete

Delete a Git-Endevor mapping

Usage

zowe endevor-bridge-for-git mapping delete <context> <mapping> [options]

Positional Arguments

CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitmappinglist

List Git-Endevor mappings. If the mapping contains multiple systems and/or subsystems, the field 'system' and 'subsystem' will contain the value 'multi'.

Usage

zowe endevor-bridge-for-git mapping list [options]

Options

CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevor-bridge-for-gitwork-area

Use an Endevor work area from the list defined by your administrator.

zoweendevor-bridge-for-gitwork-arealist

List Endevor work areas.

Usage

zowe endevor-bridge-for-git work-area list [work-area-id] [options]

Positional Arguments

Options

Response Format Options

Examples

zoweendevor-bridge-for-gitwork-areareserve

Reserve the first found available Endevor work area. When success, returns the reserved work area id

Usage

zowe endevor-bridge-for-git work-area reserve [work-area-id] [options]

Positional Arguments

Required Options

Options

Endevor options (alternatively use an 'endevor' profile)

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitwork-areaunreserve

Unreserve an Endevor work area.

Usage

zowe endevor-bridge-for-git work-area unreserve <work-area-id> [options]

Positional Arguments

Required Options

Options

Endevor options (alternatively use an 'endevor' profile)

Profile Options

Base Connection Options

Examples


zowefile-master-plus

File Master Plus command line interface is a file management and data manipulation tool.
It speeds up file creation and manipulates virtual storage access method (VSAM), sequential and partitioned data sets.
It also supports symbolic access to data via layouts and data manipulation like selection of records in data sets.

zowefile-master-pluscopy

Copy data from a data set and optionally filter or modify the copied data by using selection criteria.

zowefile-master-pluscopydata-set

Copy from a data set to another data set.
If the <to> data set does not exist, File Master Plus automatically creates a new data set using the attributes of <from> data set.
It supports all data set types that are supported by File Master Plus.

Usage

zowe file-master-plus copy data-set <from> <to> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreate

Create a data set.

zowefile-master-pluscreatelarge-format-sequential

Create a large format sequential data set.

Usage

zowe file-master-plus create large-format-sequential <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatelike-model

Create a data set by allocating parameters from a model data set.

Usage

zowe file-master-plus create like-model <name> <model> [options]

Positional Arguments

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatepartitioned-data-set

Create a partitioned data set.

Usage

zowe file-master-plus create partitioned-data-set <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatepartitioned-data-set-extended

Create an extended partitioned data set.

Usage

zowe file-master-plus create partitioned-data-set-extended <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatephysical-sequential

Create a physical sequential data set.

Usage

zowe file-master-plus create physical-sequential <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatevsam-esds

Create an entry-sequenced Virtual Storage Access Method (VSAM) data set (ESDS).

Usage

zowe file-master-plus create vsam-esds <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatevsam-ksds

Create a key-sequenced data set (KSDS) Virtual Storage Access Method (VSAM) data set.

Usage

zowe file-master-plus create vsam-ksds <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatevsam-lds

Create linear data set (LDS) Virtual Storage Access Method (VSAM) data set.

Usage

zowe file-master-plus create vsam-lds <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatevsam-rrds

Create a relative-record data set (RRDS) Virtual Storage Access Method (VSAM) data set.

Usage

zowe file-master-plus create vsam-rrds <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluscreatevsam-vrrds

Create a variable-length relative-record data set (VRRDS) Virtual Storage Access Method (VSAM) data set.

Usage

zowe file-master-plus create vsam-vrrds <name> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-plusdelete

Permanently deletes a data set.

zowefile-master-plusdeletedata-set

Permanently deletes a data set.
It supports all data set types that are supported by File Master Plus.

Usage

zowe file-master-plus delete data-set <name> [options]

Positional Arguments

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-pluspopulate

Populate the specified data set with records.
It supports all data set types that are supported by File Master Plus.

zowefile-master-pluspopulatedata-set

Populate a specific data set with records.
The layout of the records to add are described by a Cobol or PL/I copybook.

Usage

zowe file-master-plus populate data-set <name> [options]

Positional Arguments

Options

Required Options

FMP Connection Options

Profile Options

Base Connection Options

Examples

zowefile-master-plusrename

Rename the specified data set.

zowefile-master-plusrenamedata-set

Rename a data set.
It supports all data set types that are supported by File Master Plus.

Usage

zowe file-master-plus rename data-set <old> <new> [options]

Positional Arguments

Options

FMP Connection Options

Profile Options

Base Connection Options

Examples


zoweidms

IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands

zoweidmsissue

Issues IDMS DCMT and DCUF commands

zoweidmsissuedcmt-display

Execute a DCMT DISPLAY command

Usage

zowe idms issue dcmt-display [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-help

Execute a DCMT HELP command

Usage

zowe idms issue dcmt-help [options]

IDMS Connection Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-quiesce

Execute a DCMT QUIESCE command

Usage

zowe idms issue dcmt-quiesce [options]

IDMS Connection Options

Required Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-shutdown

Execute a DCMT SHUTDOWN command

Usage

zowe idms issue dcmt-shutdown [options]

IDMS Connection Options

Required Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-statistics

Execute a DCMT STATISTICS command

Usage

zowe idms issue dcmt-statistics [options]

IDMS Connection Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-test

Execute a DCMT TEST command. Obtains diagnostic information for Broadcom technical support personnel.

The DCMT TEST command is used for debugging and diagnostic purposes only. Use it only when told to do so by IDMS technical support personnel. It is enabled only if certain CSA test flags are turned on

Usage

zowe idms issue dcmt-test [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-vary

Execute a DCMT VARY command

Usage

zowe idms issue dcmt-vary [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcuf-help

Execute a DCUF HELP command

Usage

zowe idms issue dcuf-help [options]

IDMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcuf-show

Execute a DCUF SHOW command

Usage

zowe idms issue dcuf-show [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslist

Lists available datasources, real-time monitor statistics information, log messages, active user tasks, and transaction details

zoweidmslistdatasources

Lists data sources defined to the IDMS REST API

Usage

zowe idms list datasources [options]

IDMS Connection Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslistlog

Lists log messages based on the search options provided

Usage

zowe idms list log [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslistsystems

Lists either all active IDMS systems on an LPAR or lists information about a specific system if a jobname is provided

Usage

zowe idms list systems [options]

IDMS Connection Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslisttransactions

Lists transaction details on a specific IDMS system

Usage

zowe idms list transactions [options]

IDMS Connection Options

Required Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslistuser-tasks

Lists all active user tasks on a specific IDMS system

Usage

zowe idms list user-tasks [options]

IDMS Connection Options

Required Options

Profile Options

Base Connection Options

Response Format Options

Examples


zoweims

Interact with IBM IMS programs and transactions.

zoweimsquery

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

zoweimsqueryprogram

Query an IMS application program.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsqueryregion

Query an IMS region.

Usage

zowe ims query region [options]

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsquerytransaction

Query an IMS transaction.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstart

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

zoweimsstartprogram

Start an IMS application program.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstartregion

Start an IMS region.

Usage

zowe ims start region [memberName] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstarttransaction

Start an IMS transaction.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstop

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

zoweimsstopprogram

Stop an IMS application program.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstopregion

Stop an IMS region.

Usage

zowe ims stop region [options]

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstoptransaction

Stop an IMS transaction.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsupdate

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

zoweimsupdateprogram

Update an IMS application program.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsupdatetransaction

Update an IMS transaction.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples


zowejclcheck

Validates the accuracy of job control language (JCL) and also helps identify execution-time errors, such as security violations and missing data sets that could cause jobs to fail.

zowejclcheckcheck

Perform a check on JCL that is contained in an MVS data set or a local file.

zowejclcheckcheckdata-set

Reads the specified input data set and invokes the JCLCheck service with the data set contents.

Usage

zowe jclcheck check data-set <dataSet> [options]

Positional Arguments

Options

JCLCheck Connection Options

Profile Options

Base Connection Options

Examples

zowejclcheckchecklocal-file

Reads the contents of the local file specified and invokes the JCLCheck service with the JCL contents.

Usage

zowe jclcheck check local-file <localFile> [options]

Positional Arguments

Options

JCLCheck Connection Options

Profile Options

Base Connection Options

Examples


zowemat

The MAT Analyze plug-in for ZOWE CLI enables you to manage monitor profiles and get the measurement analysis data using Mainframe Application Tuner (MAT)

zowematmonitor

Get monitor history and measurement analysis data from MAT.

zowematmonitorcodeview

Get the CodeView measurement details.

zowematmonitorcodeviewcallerid

Get the CodeView CallerID details for the specific CSECT and module.

Usage

zowe mat monitor codeview callerid [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitorcodeviewcsect

Get the CodeView measurement details in Csect mode.

Usage

zowe mat monitor codeview csect [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitorcodeviewhistogram

Get the Histogram details for the measurement.

Usage

zowe mat monitor codeview histogram [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitorcodeviewmodule

Get the CodeView measurement details in Module mode.

Usage

zowe mat monitor codeview module [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitordb2

Get the DB2 measurement details.

zowematmonitordb2db2view

Get the DB2View details for the measurement.

Usage

zowe mat monitor db2 db2view [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitordb2sqlstmt

Get SQL details for the DB2 statement.

Usage

zowe mat monitor db2 sqlstmt [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitordelayview

Get the DelayView measurement details.

zowematmonitordelayviewaddress

Get the delay address details for the measurement.

Usage

zowe mat monitor delayview address [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitordelayviewdelay

Get the delay details for the measurement.

Usage

zowe mat monitor delayview delay [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitorhistory

Get list of all available measurements that are stored in the history of the specific monitor profile.

Usage

zowe mat monitor history [options]

Options

Profile Options

Base Connection Options

Examples

zowematmonitoroverview

Get the overview details of the measurement.

Usage

zowe mat monitor overview [options]

Options

Profile Options

Base Connection Options

Examples

zowematprofile

Create, invoke, and list MAT monitor profiles.

zowematprofilecreate

Create a MAT monitor profile.

Usage

zowe mat profile create [options]

Required Options

Options

Profile Options

Base Connection Options

Examples

zowematprofileinvoke

Invoke a MAT monitor profile to start measurement.

Usage

zowe mat profile invoke [options]

Required Options

Options

Profile Options

Base Connection Options

Examples

zowematprofilelist

Get the list of available monitor profiles.

Usage

zowe mat profile list [options]

Profile Options

Base Connection Options


zowemat-pma-util

The MAT Detect plug-in for Zowe CLI enables you to detect performance issues and access performance data supplied by the Performance Management Assistant component (PMA) of Mainframe Application Tuner.

zowemat-pma-utilget

Get performance information using PMA utilities. You can get the current performance data of your jobs and check for the daily performance alerts.

zowemat-pma-utilgetalert

Check for alerts created in PMA and detect whether any of your jobs exceeds the average daily performance. If the threshold is exceeded, a PMA alert is triggered. We recommend that you include this command in your end-of-day build to trace all jobs that might cause performance degradation by code changes during the day.

Usage

zowe mat-pma-util get alert [options]

PMA Connection Options

Profile Options

Base Connection Options

Examples

zowemat-pma-utilgetalert-by-job

Check whether the specified job exceeds the average daily performance. No record returned indicates that no performance degradation was detected for this job.

Usage

zowe mat-pma-util get alert-by-job <jobname> [options]

Positional Arguments

PMA Connection Options

Profile Options

Base Connection Options

Examples

zowemat-pma-utilgetperf

Get the current performance data of a specific job using PMA. If the current measurement results for any of the measured parameters are higher than average values, an alert message is displayed.

Usage

zowe mat-pma-util get perf <jobname> [options]

Positional Arguments

PMA Connection Options

Profile Options

Base Connection Options

Examples

zowemat-pma-utilscope

Get and define the PMA scope information. You can create and update the list of jobs that you want to include, or the list of programs to be excluded from the PMA scope of work.

zowemat-pma-utilscopedel-job

Delete a job from the list of inclusions in the PMA scope.

Usage

zowe mat-pma-util scope del-job <jobname> [options]

Positional Arguments

Options

PMA Connection Options

Profile Options

Base Connection Options

Examples

zowemat-pma-utilscopedel-pgm

Delete a program from the list of exclusions from the PMA scope.

Usage

zowe mat-pma-util scope del-pgm <pgmname> [options]

Positional Arguments

PMA Connection Options

Profile Options

Base Connection Options

Examples

zowemat-pma-utilscopeexl-pgm

Exclude a program from the PMA scope of work.

Usage

zowe mat-pma-util scope exl-pgm <pgmname> [options]

Positional Arguments

Options

PMA Connection Options

Profile Options

Base Connection Options

Examples

zowemat-pma-utilscopeget-listj

Get the list of jobs included in the PMA scope.

Usage

zowe mat-pma-util scope get-listj [options]

PMA Connection Options

Profile Options

Base Connection Options

Examples

zowemat-pma-utilscopeget-listp

Get the list of programs excluded from the PMA scope.

Usage

zowe mat-pma-util scope get-listp [options]

PMA Connection Options

Profile Options

Base Connection Options

Examples

zowemat-pma-utilscopeinc-job

Include a job in the PMA scope of work.

Usage

zowe mat-pma-util scope inc-job <jobname> [options]

Positional Arguments

Options

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


zoweops

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

zoweopsdisable

Disable OPS/MVS rules.

zoweopsdisablerule

Disable the specified rule.

Usage

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

Positional Arguments

OPS WEB SERVICES CONNECTION OPTIONS

Profile Options

Base Connection Options

Examples

zoweopsenable

Enables OPS/MVS rules.This will cause SSM to take the necessary action to enable that rule.

zoweopsenablerule

Enable the specified rule.

Usage

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

Positional Arguments

OPS WEB SERVICES CONNECTION OPTIONS

Profile Options

Base Connection Options

Examples

zoweopsshow

Display data associated with OPS/MVS automation elements (for example, rules or SSM resources).

zoweopsshowresource

Display data associated with the specified SSM resource. Currently, only resource state is displayed.

Usage

zowe ops show resource <resourcename> [options]

Positional Arguments

Options

OPS WEB SERVICES CONNECTION OPTIONS

Profile Options

Base Connection Options

Examples

zoweopsshowrule

Display data associated with the specified rule. Currently, only rule status is displayed.

Usage

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

Positional Arguments

OPS WEB SERVICES CONNECTION OPTIONS

Profile Options

Base Connection Options

Examples

zoweopsstart

Start OPS/MVS resources.

zoweopsstartresource

Start the specified resource. The desired state of the resource willbe set to the appropriate UP state and SSM will take actions to start the resource.

Usage

zowe ops start resource <resourcename> [options]

Positional Arguments

Options

OPS WEB SERVICES CONNECTION OPTIONS

Profile Options

Base Connection Options

Examples

zoweopsstop

Stop OPS/MVS resources.

zoweopsstopresource

Stop the specified resource. The desired state of the resource willbe set to the appropriate DOWN state and SSM will take actions to start the resource.

Usage

zowe ops stop resource <resourcename> [options]

Positional Arguments

Options

OPS WEB SERVICES 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

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


zoweprofiles

Create and manage configuration profiles.

zoweprofilescreate

Create new configuration profiles.

zoweprofilescreatebase-profile

Base profile that stores values shared by multiple service profiles

Usage

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

Positional Arguments

Base Connection Options

Options

Examples

zoweprofilescreateca7-profile

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

Usage

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

Positional Arguments

CA7 Connection Options

Options

zoweprofilescreatecaspool-profile

Configuration profile for Spool, where you specify information about your Spool instance

Usage

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

Positional Arguments

SPOOL OPTIONS

Options

Examples

zoweprofilescreatecaview-profile

Configuration profile for View

Usage

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

Positional Arguments

Options

Examples

zoweprofilescreatecics-deploy-profile

Specifies the target environment for the cics-deploy deploy and undeploy actions.

Usage

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

Positional Arguments

Required Options

Options

Examples

zoweprofilescreatecics-profile

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

Usage

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

Positional Arguments

Required Options

Options

Cics Connection Options

Examples

zoweprofilescreatedb2-profile

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

Usage

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

Positional Arguments

Options

zoweprofilescreatedbm-db2-profile

The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

Usage

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

Positional Arguments

dbm-db2 Common Options

dbm-db2 Connection Options

Options

Examples

zoweprofilescreateebg-profile

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.

Usage

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

Positional Arguments

CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

Options

zoweprofilescreateendevor-location-profile

The Endevor element location, where you specify your working environment, system and subsystem

Usage

zowe profiles create endevor-location-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilescreateendevor-profile

The Endevor endevor profile schema, where you specify your endevor session information and credentials

Usage

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

Positional Arguments

Options

Examples

zoweprofilescreatefmp-profile

File Master Plus profile schema.

Usage

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

Positional Arguments

FMP Connection Options

Options

Examples

zoweprofilescreateidms-profile

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

Usage

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

Positional Arguments

IDMS Connection Options

Options

Examples

zoweprofilescreateims-profile

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

Usage

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

Positional Arguments

IMS Connection Options

Options

Examples

zoweprofilescreatejclcheck-profile

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

Usage

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

Positional Arguments

JCLCheck Connection Options

Options

Examples

zoweprofilescreatemat-profile

MAT Analyze CLI profile schema.

Usage

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

Positional Arguments

MAT Profile Options

Options

Examples

zoweprofilescreatemq-profile

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

Usage

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

Positional Arguments

Required Options

MQ Connection Options

Options

Examples

zoweprofilescreateops-profile

The OPS Web Services session profile schema, where you specify your session information and credentials

Usage

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

Positional Arguments

OPS WEB SERVICES CONNECTION OPTIONS

Options

Examples

zoweprofilescreatepma-profile

MAT Detect CLI profile schema.

Usage

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

Positional Arguments

PMA Connection Options

Options

Examples

zoweprofilescreaterse-profile

A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.

Usage

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

Positional Arguments

Zowe REST Connection Options

Options

Examples

zoweprofilescreatesa-profile

Profile for System Automation Plug-in

Usage

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

Positional Arguments

SA CONNECTTION OPTIONS

Options

zoweprofilescreatessh-profile

z/OS SSH Profile

Usage

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

Positional Arguments

z/OS Ssh Connection Options

Options

Examples

zoweprofilescreatesysview-format-profile

The SYSVIEW format profile schema, where you specify display settings

Usage

zowe profiles create sysview-format-profile <profileName> [options]

Positional Arguments

display options

Options

Examples

zoweprofilescreatesysview-profile

The SYSVIEW session profile schema, where you specify your session information and credentials

Usage

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

Positional Arguments

sysview connection options

Options

Examples

zoweprofilescreatetso-profile

z/OS TSO/E User Profile

Usage

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

Positional Arguments

TSO ADDRESS SPACE OPTIONS

Options

Examples

zoweprofilescreatewa-profile

A profile for interaction with WA REST Services

Usage

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

Positional Arguments

workload-automation Connection Options

Options

Examples

zoweprofilescreatezftp-profile

Configuration profile for z/OS FTP

Usage

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

Positional Arguments

Options

TLS / Secure Connection options

Examples

zoweprofilescreateznetview-profile

The NetView profile is the profile that you created to communicate with the NetView REST Server. It is required to use Z NetView Plug-ins, including Z NetView Base Plug-in, Z NetView Automation Plug-in and Z NetView Network Plug-in.

Usage

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

Positional Arguments

Options

NetView Connection Options

Examples

zoweprofilescreatezosconnect-profile

z/OS Connect EE connection profile

Usage

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

Positional Arguments

Required Options

Options

zoweprofilescreatezosmf-profile

z/OSMF Profile

Usage

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

Positional Arguments

Zosmf Connection Options

Options

Examples

zoweprofilesdelete

Delete existing profiles.

zoweprofilesdeletebase-profile

Delete a base profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete base-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeleteca7-profile

Delete a ca7 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete ca7-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletecaspool-profile

Delete a caspool profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete caspool-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletecaview-profile

Delete a caview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete caview-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletecics-deploy-profile

Delete a cics-deploy profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete cics-deploy-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletecics-profile

Delete a cics profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletedb2-profile

Delete a db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletedbm-db2-profile

Delete a dbm-db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete dbm-db2-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeleteebg-profile

Delete a ebg profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete ebg-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeleteendevor-location-profile

Delete a endevor-location profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete endevor-location-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeleteendevor-profile

Delete a endevor profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete endevor-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletefmp-profile

Delete a fmp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete fmp-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeleteidms-profile

Delete a idms profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete idms-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeleteims-profile

Delete a ims profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletejclcheck-profile

Delete a jclcheck profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete jclcheck-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletemat-profile

Delete a mat profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete mat-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletemq-profile

Delete a mq profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeleteops-profile

Delete a ops profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete ops-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletepma-profile

Delete a pma profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete pma-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeleterse-profile

Delete a rse profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete rse-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletesa-profile

Delete a sa profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete sa-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletessh-profile

Delete a ssh profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletesysview-format-profile

Delete a sysview-format profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete sysview-format-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletesysview-profile

Delete a sysview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete sysview-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletetso-profile

Delete a tso profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletewa-profile

Delete a wa profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete wa-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletezftp-profile

Delete a zftp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeleteznetview-profile

Delete a znetview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete znetview-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletezosconnect-profile

Delete a zosconnect profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

zowe profiles delete zosconnect-profile <profileName> [options]

Positional Arguments

Options

Examples

zoweprofilesdeletezosmf-profile

Delete a zosmf profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.

Usage

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

Positional Arguments

Options

Examples

zoweprofileslist

List profiles of the type {{type}}.

zoweprofileslistbase-profiles

Base profile that stores values shared by multiple service profiles

Usage

zowe profiles list base-profiles [options]

Options

Examples

zoweprofileslistca7-profiles

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

Usage

zowe profiles list ca7-profiles [options]

Options

Examples

zoweprofileslistcaspool-profiles

Configuration profile for Spool, where you specify information about your Spool instance

Usage

zowe profiles list caspool-profiles [options]

Options

Examples

zoweprofileslistcaview-profiles

Configuration profile for View

Usage

zowe profiles list caview-profiles [options]

Options

Examples

zoweprofileslistcics-deploy-profiles

Specifies the target environment for the cics-deploy deploy and undeploy actions.

Usage

zowe profiles list cics-deploy-profiles [options]

Options

Examples

zoweprofileslistcics-profiles

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

Usage

zowe profiles list cics-profiles [options]

Options

Examples

zoweprofileslistdb2-profiles

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

Usage

zowe profiles list db2-profiles [options]

Options

Examples

zoweprofileslistdbm-db2-profiles

The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

Usage

zowe profiles list dbm-db2-profiles [options]

Options

Examples

zoweprofileslistebg-profiles

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.

Usage

zowe profiles list ebg-profiles [options]

Options

Examples

zoweprofileslistendevor-location-profiles

The Endevor element location, where you specify your working environment, system and subsystem

Usage

zowe profiles list endevor-location-profiles [options]

Options

Examples

zoweprofileslistendevor-profiles

The Endevor endevor profile schema, where you specify your endevor session information and credentials

Usage

zowe profiles list endevor-profiles [options]

Options

Examples

zoweprofileslistfmp-profiles

File Master Plus profile schema.

Usage

zowe profiles list fmp-profiles [options]

Options

Examples

zoweprofileslistidms-profiles

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

Usage

zowe profiles list idms-profiles [options]

Options

Examples

zoweprofileslistims-profiles

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

Usage

zowe profiles list ims-profiles [options]

Options

Examples

zoweprofileslistjclcheck-profiles

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

Usage

zowe profiles list jclcheck-profiles [options]

Options

Examples

zoweprofileslistmat-profiles

MAT Analyze CLI profile schema.

Usage

zowe profiles list mat-profiles [options]

Options

Examples

zoweprofileslistmq-profiles

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

Usage

zowe profiles list mq-profiles [options]

Options

Examples

zoweprofileslistops-profiles

The OPS Web Services session profile schema, where you specify your session information and credentials

Usage

zowe profiles list ops-profiles [options]

Options

Examples

zoweprofileslistpma-profiles

MAT Detect CLI profile schema.

Usage

zowe profiles list pma-profiles [options]

Options

Examples

zoweprofileslistrse-profiles

A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.

Usage

zowe profiles list rse-profiles [options]

Options

Examples

zoweprofileslistsa-profiles

Profile for System Automation Plug-in

Usage

zowe profiles list sa-profiles [options]

Options

Examples

zoweprofileslistssh-profiles

z/OS SSH Profile

Usage

zowe profiles list ssh-profiles [options]

Options

Examples

zoweprofileslistsysview-format-profiles

The SYSVIEW format profile schema, where you specify display settings

Usage

zowe profiles list sysview-format-profiles [options]

Options

Examples

zoweprofileslistsysview-profiles

The SYSVIEW session profile schema, where you specify your session information and credentials

Usage

zowe profiles list sysview-profiles [options]

Options

Examples

zoweprofileslisttso-profiles

z/OS TSO/E User Profile

Usage

zowe profiles list tso-profiles [options]

Options

Examples

zoweprofileslistwa-profiles

A profile for interaction with WA REST Services

Usage

zowe profiles list wa-profiles [options]

Options

Examples

zoweprofileslistzftp-profiles

Configuration profile for z/OS FTP

Usage

zowe profiles list zftp-profiles [options]

Options

Examples

zoweprofileslistznetview-profiles

The NetView profile is the profile that you created to communicate with the NetView REST Server. It is required to use Z NetView Plug-ins, including Z NetView Base Plug-in, Z NetView Automation Plug-in and Z NetView Network Plug-in.

Usage

zowe profiles list znetview-profiles [options]

Options

Examples

zoweprofileslistzosconnect-profiles

z/OS Connect EE connection profile

Usage

zowe profiles list zosconnect-profiles [options]

Options

Examples

zoweprofileslistzosmf-profiles

z/OSMF Profile

Usage

zowe profiles list zosmf-profiles [options]

Options

Examples

zoweprofilesset-default

Set which profiles are loaded by default.

zoweprofilesset-defaultbase-profile

The base set default-profiles command allows you to set the default profiles for this command group. When a base command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default base-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultca7-profile

The ca7 set default-profiles command allows you to set the default profiles for this command group. When a ca7 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default ca7-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultcaspool-profile

The caspool set default-profiles command allows you to set the default profiles for this command group. When a caspool command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default caspool-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultcaview-profile

The caview set default-profiles command allows you to set the default profiles for this command group. When a caview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default caview-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultcics-deploy-profile

The cics-deploy set default-profiles command allows you to set the default profiles for this command group. When a cics-deploy command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default cics-deploy-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultcics-profile

The cics set default-profiles command allows you to set the default profiles for this command group. When a cics command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default cics-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultdb2-profile

The db2 set default-profiles command allows you to set the default profiles for this command group. When a db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default db2-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultdbm-db2-profile

The dbm-db2 set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default dbm-db2-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultebg-profile

The ebg set default-profiles command allows you to set the default profiles for this command group. When a ebg command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default ebg-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultendevor-location-profile

The endevor-location set default-profiles command allows you to set the default profiles for this command group. When a endevor-location command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default endevor-location-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultendevor-profile

The endevor set default-profiles command allows you to set the default profiles for this command group. When a endevor command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default endevor-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultfmp-profile

The fmp set default-profiles command allows you to set the default profiles for this command group. When a fmp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default fmp-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultidms-profile

The idms set default-profiles command allows you to set the default profiles for this command group. When a idms command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default idms-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultims-profile

The ims set default-profiles command allows you to set the default profiles for this command group. When a ims command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default ims-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultjclcheck-profile

The jclcheck set default-profiles command allows you to set the default profiles for this command group. When a jclcheck command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default jclcheck-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultmat-profile

The mat set default-profiles command allows you to set the default profiles for this command group. When a mat command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default mat-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultmq-profile

The mq set default-profiles command allows you to set the default profiles for this command group. When a mq command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default mq-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultops-profile

The ops set default-profiles command allows you to set the default profiles for this command group. When a ops command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default ops-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultpma-profile

The pma set default-profiles command allows you to set the default profiles for this command group. When a pma command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default pma-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultrse-profile

The rse set default-profiles command allows you to set the default profiles for this command group. When a rse command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default rse-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultsa-profile

The sa set default-profiles command allows you to set the default profiles for this command group. When a sa command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default sa-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultssh-profile

The ssh set default-profiles command allows you to set the default profiles for this command group. When a ssh command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default ssh-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultsysview-format-profile

The sysview-format set default-profiles command allows you to set the default profiles for this command group. When a sysview-format command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default sysview-format-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultsysview-profile

The sysview set default-profiles command allows you to set the default profiles for this command group. When a sysview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default sysview-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaulttso-profile

The tso set default-profiles command allows you to set the default profiles for this command group. When a tso command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default tso-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultwa-profile

The wa set default-profiles command allows you to set the default profiles for this command group. When a wa command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default wa-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultzftp-profile

The zftp set default-profiles command allows you to set the default profiles for this command group. When a zftp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default zftp-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultznetview-profile

The znetview set default-profiles command allows you to set the default profiles for this command group. When a znetview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default znetview-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultzosconnect-profile

The zosconnect set default-profiles command allows you to set the default profiles for this command group. When a zosconnect command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default zosconnect-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesset-defaultzosmf-profile

The zosmf set default-profiles command allows you to set the default profiles for this command group. When a zosmf command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.

Usage

zowe profiles set-default zosmf-profile <profileName> [options]

Positional Arguments

Examples

zoweprofilesupdate

Update a {{type}} profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.

zoweprofilesupdatebase-profile

Base profile that stores values shared by multiple service profiles

Usage

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

Positional Arguments

Base Connection Options

Examples

zoweprofilesupdateca7-profile

A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.

Usage

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

Positional Arguments

CA7 Connection Options

zoweprofilesupdatecaspool-profile

Configuration profile for Spool, where you specify information about your Spool instance

Usage

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

Positional Arguments

SPOOL OPTIONS

Examples

zoweprofilesupdatecaview-profile

Configuration profile for View

Usage

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

Positional Arguments

Options

zoweprofilesupdatecics-deploy-profile

Specifies the target environment for the cics-deploy deploy and undeploy actions.

Usage

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

Positional Arguments

Options

zoweprofilesupdatecics-profile

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

Usage

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

Positional Arguments

Options

Cics Connection Options

zoweprofilesupdatedb2-profile

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

Usage

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

Positional Arguments

Options

zoweprofilesupdatedbm-db2-profile

The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.

Usage

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

Positional Arguments

dbm-db2 Common Options

dbm-db2 Connection Options

Examples

zoweprofilesupdateebg-profile

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.

Usage

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

Positional Arguments

CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)

zoweprofilesupdateendevor-location-profile

The Endevor element location, where you specify your working environment, system and subsystem

Usage

zowe profiles update endevor-location-profile <profileName> [options]

Positional Arguments

Options

zoweprofilesupdateendevor-profile

The Endevor endevor profile schema, where you specify your endevor session information and credentials

Usage

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

Positional Arguments

Options

zoweprofilesupdatefmp-profile

File Master Plus profile schema.

Usage

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

Positional Arguments

FMP Connection Options

zoweprofilesupdateidms-profile

An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information

Usage

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

Positional Arguments

IDMS Connection Options

Examples

zoweprofilesupdateims-profile

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

Usage

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

Positional Arguments

IMS Connection Options

zoweprofilesupdatejclcheck-profile

A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.

Usage

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

Positional Arguments

JCLCheck Connection Options

zoweprofilesupdatemat-profile

MAT Analyze CLI profile schema.

Usage

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

Positional Arguments

MAT Profile Options

zoweprofilesupdatemq-profile

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

Usage

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

Positional Arguments

Options

MQ Connection Options

zoweprofilesupdateops-profile

The OPS Web Services session profile schema, where you specify your session information and credentials

Usage

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

Positional Arguments

OPS WEB SERVICES CONNECTION OPTIONS

Examples

zoweprofilesupdatepma-profile

MAT Detect CLI profile schema.

Usage

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

Positional Arguments

PMA Connection Options

zoweprofilesupdaterse-profile

A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.

Usage

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

Positional Arguments

Zowe REST Connection Options

zoweprofilesupdatesa-profile

Profile for System Automation Plug-in

Usage

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

Positional Arguments

SA CONNECTTION OPTIONS

zoweprofilesupdatessh-profile

z/OS SSH Profile

Usage

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

Positional Arguments

z/OS Ssh Connection Options

zoweprofilesupdatesysview-format-profile

The SYSVIEW format profile schema, where you specify display settings

Usage

zowe profiles update sysview-format-profile <profileName> [options]

Positional Arguments

display options

Examples

zoweprofilesupdatesysview-profile

The SYSVIEW session profile schema, where you specify your session information and credentials

Usage

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

Positional Arguments

sysview connection options

Examples

zoweprofilesupdatetso-profile

z/OS TSO/E User Profile

Usage

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

Positional Arguments

TSO ADDRESS SPACE OPTIONS

Examples

zoweprofilesupdatewa-profile

A profile for interaction with WA REST Services

Usage

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

Positional Arguments

workload-automation Connection Options

zoweprofilesupdatezftp-profile

Configuration profile for z/OS FTP

Usage

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

Positional Arguments

Options

TLS / Secure Connection options

zoweprofilesupdateznetview-profile

The NetView profile is the profile that you created to communicate with the NetView REST Server. It is required to use Z NetView Plug-ins, including Z NetView Base Plug-in, Z NetView Automation Plug-in and Z NetView Network Plug-in.

Usage

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

Positional Arguments

Options

NetView Connection Options

zoweprofilesupdatezosconnect-profile

z/OS Connect EE connection profile

Usage

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

Positional Arguments

Options

zoweprofilesupdatezosmf-profile

z/OSMF Profile

Usage

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

Positional Arguments

Zosmf Connection Options

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


zowerse-api-for-zowe-cli

Welcome to the IBM RSE API Plug-in for Zowe CLI!

zowerse-api-for-zowe-cliauth

Connect to the RSE API Server authentication service and obtain a token. The token provides authentication to services that are supported by the RSE API. When you log in, the token is stored in your profile until it expires. Profiles store connection information, and are used if you do not supply connection information in a command. To take advantage of the token authentication service, you should omit username and password in profiles so that the token in the profile is used.

zowerse-api-for-zowe-cliauthlogin

Log in to an authentication service to obtain a JWT Token.

Usage

zowe rse-api-for-zowe-cli auth login [options]

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-cliauthlogout

Log out of the authentication service and retire the JWT Token

Usage

zowe rse-api-for-zowe-cli auth logout [options]

Profile Options

Base Connection Options

zowerse-api-for-zowe-cliauthquery

Get back JWT Token information if it is not yet expired.

Usage

zowe rse-api-for-zowe-cli auth query [options]

Profile Options

Base Connection Options

zowerse-api-for-zowe-clicancel

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

zowerse-api-for-zowe-clicanceljob

Cancel a single job by job ID

Usage

zowe rse-api-for-zowe-cli cancel job <jobid> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clichange

Change User Data on the Host

zowerse-api-for-zowe-clichangepassword

Change z/OS User Password on the Host

Usage

zowe rse-api-for-zowe-cli change password <currentPassword> <newPassword> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clicheck

Confirm that RSE API is running on a specified system and gather information about the RSE API server and Address Space for diagnostic purposes. Obtain and update MVS mappings file

zowerse-api-for-zowe-clicheckconversion-mappings

Download MVS mapping file.

Usage

zowe rse-api-for-zowe-cli check conversion-mappings [options]

Options

Profile Options

Base Connection Options

zowerse-api-for-zowe-clicheckjob-address-space

Display all active job address space information.

Usage

zowe rse-api-for-zowe-cli check job-address-space [options]

Profile Options

Base Connection Options

zowerse-api-for-zowe-clicheckstatus

Confirm that RSE API is running on a system specified in your profile and gather information about the RSE API server for diagnostic purposes. The command outputs properties of the RSE API server such as version, hostname, and the port the server is running.

Usage

zowe rse-api-for-zowe-cli check status [options]

Profile Options

Base Connection Options

zowerse-api-for-zowe-clichecksystem-address-space

Display active system address space information.

Usage

zowe rse-api-for-zowe-cli check system-address-space [options]

Profile Options

Base Connection Options

zowerse-api-for-zowe-clicopy

Copy a data set

zowerse-api-for-zowe-clicopydata-set

Copy a data set to another data set

Usage

zowe rse-api-for-zowe-cli copy data-set <fromDataSetName> <toDataSetName> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clicreate

Create data sets, data set members or uss files and directories

zowerse-api-for-zowe-clicreatedata-set

Create a data set based on the properties of an existing data set

Usage

zowe rse-api-for-zowe-cli create data-set <dataSetName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clicreatedata-set-member

Create a member for a Partitioned data set.

Usage

zowe rse-api-for-zowe-cli create data-set-member <datasetMember> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clicreatedata-set-partitioned

Create partitioned data sets (PDS)

Usage

zowe rse-api-for-zowe-cli create data-set-partitioned <dataSetName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clicreatedata-set-sequential

Create physical sequential data sets (PS)

Usage

zowe rse-api-for-zowe-cli create data-set-sequential <dataSetName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clicreateuss-directory

Create a uss directory.

Usage

zowe rse-api-for-zowe-cli create uss-directory <ussPath> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clicreateuss-file

Create a uss file.

Usage

zowe rse-api-for-zowe-cli create uss-file <ussPath> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clidelete

Delete a data set or Unix System Services file

zowerse-api-for-zowe-clideletedata-set

Delete a data set permanently

Usage

zowe rse-api-for-zowe-cli delete data-set <dataSetName> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clideletejob

Delete a single job by job ID

Usage

zowe rse-api-for-zowe-cli delete job <jobid> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clideleteuss-file

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

Usage

zowe rse-api-for-zowe-cli delete uss-file <fileName> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clidownload

Download content from z/OS data sets, USS files, and JOB Output to your PC.

zowerse-api-for-zowe-clidownloadall-members

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

Usage

zowe rse-api-for-zowe-cli download all-members <dataSetName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clidownloaddata-set

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

Usage

zowe rse-api-for-zowe-cli download data-set <dataSetName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clidownloadoutput

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

Usage

zowe rse-api-for-zowe-cli download output <jobid> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clidownloaduss-file

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

Usage

zowe rse-api-for-zowe-cli download uss-file <ussFileName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-cliissue

Issue TSO and UNIX commands

zowerse-api-for-zowe-cliissuecommand

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

Usage

zowe rse-api-for-zowe-cli issue command <commandText> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-cliissueunix

issues a UNIX command

Usage

zowe rse-api-for-zowe-cli issue unix <commandText> [options]

Positional Arguments

Required Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clilist

List uss file and folders, data sets and data set members, or jobs and spool files. Optionally, you can list their details and attributes.

zowerse-api-for-zowe-clilistall-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 rse-api-for-zowe-cli list all-members <dataSetName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clilistdata-set

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

Usage

zowe rse-api-for-zowe-cli list data-set <filter> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clilistjobs

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

Usage

zowe rse-api-for-zowe-cli list jobs [options]

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowerse-api-for-zowe-clilistspool-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 RSE API Jobs REST endpoints.

Usage

zowe rse-api-for-zowe-cli list spool-files-by-jobid <jobid> [options]

Positional Arguments

Profile Options

Base Connection Options

Response Format Options

Examples

zowerse-api-for-zowe-clilistuss-files

List USS files and directories in a UNIX file path

Usage

zowe rse-api-for-zowe-cli list uss-files <path> [options]

Positional Arguments

Profile Options

Base Connection Options

Response Format Options

Examples

zowerse-api-for-zowe-climigrate

Migrate data sets.

zowerse-api-for-zowe-climigratedata-set

Migrate a data set.

Usage

zowe rse-api-for-zowe-cli migrate data-set <dataSetName> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clirecall

Recall migrated data sets.

zowerse-api-for-zowe-clirecalldata-set

Recall a migrated data set.

Usage

zowe rse-api-for-zowe-cli recall data-set <dataSetName> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clirename

Rename a Data set, Data set member,File or Directory

zowerse-api-for-zowe-clirenamedata-set

Rename a Data Set.

Usage

zowe rse-api-for-zowe-cli rename data-set <dataSetName> <name> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clirenamedata-set-member

Rename a Data Set Member.

Usage

zowe rse-api-for-zowe-cli rename data-set-member <dataSetMemberName> <name> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clirenameuss-file

Rename a Unix File or Directory.

Usage

zowe rse-api-for-zowe-cli rename uss-file <path> <name> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-clisubmit

Submit jobs (JCL) contained in data sets.

zowerse-api-for-zowe-clisubmitdata-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 Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.

Usage

zowe rse-api-for-zowe-cli submit data-set <dataset> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowerse-api-for-zowe-clisubmitlocal-file

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

Usage

zowe rse-api-for-zowe-cli submit local-file <localFile> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowerse-api-for-zowe-clisubmitstdin

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

Usage

zowe rse-api-for-zowe-cli submit stdin [options]

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowerse-api-for-zowe-cliupload

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

zowerse-api-for-zowe-cliuploaddir-to-pds

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

Usage

zowe rse-api-for-zowe-cli upload dir-to-pds <inputdir> <dataSetName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-cliuploaddir-to-uss

Upload a local directory to a USS directory.

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

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

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

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

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

Usage

zowe rse-api-for-zowe-cli upload dir-to-uss <inputDir> <USSDir> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-cliuploadfile-to-data-set

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

Usage

zowe rse-api-for-zowe-cli upload file-to-data-set <inputfile> <dataSetName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-cliuploadfile-to-uss

Upload content to a USS file from local file

Usage

zowe rse-api-for-zowe-cli upload file-to-uss <inputfile> <USSFileName> [options]

Positional Arguments

Options

Profile Options

Base Connection Options

Examples

zowerse-api-for-zowe-cliview

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

zowerse-api-for-zowe-cliviewjob-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 Jobs REST endpoints (expect for "no jobs found").

Usage

zowe rse-api-for-zowe-cli view job-status-by-jobid <jobid> [options]

Positional Arguments

Profile Options

Base Connection Options

Response Format Options

Examples

zowerse-api-for-zowe-cliviewspool-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 Jobs REST endpoints.

Usage

zowe rse-api-for-zowe-cli view spool-file-by-id <jobid> <spoolfileid> [options]

Positional Arguments

Profile Options

Base Connection Options

Examples


zowesecure-credential-store

Store credentials securely in profiles by encrypting them

zowesecure-credential-storerevert

Reverts all secure profiles to be stored in plain text

Usage

zowe secure-credential-store revert [options]

Required Options

zowesecure-credential-storeupdate

Updates all plain text profiles to be securely stored

Usage

zowe secure-credential-store update [options]


zowesystem-automation

Interact with SA Operations REST API of IBM Z System Automation.

You need to configure and start the "SA Operations REST Server".

First steps:

- Create a Zowe Profile with connection information to your Z SA Operations REST Server.
Use the command "zowe profiles create sa" and specify the required options.

- For more help of creating a profile issue "zowe profiles create sa --help".

- Make sure one sa profile is set as default profile.
Use command "zowe profiles set-default sa --help" for more information.

- For a list of possible command issue: "zowe sa --help"

zowesystem-automationactivate

Activate a setting or configuration from stored configuration data

zowesystem-automationactivatepolicy

Updates all SAPlex members (Automation Manager and -Agents) with the definition that is stored in the specified policy dataset.
Using '*' as policyName causes a refresh of current policy.

Requires (min.): SA Operations API 1.1.0

Following Success Messages can be returned by this command:
SACLI001100 - Policy activation with {PolicyDatasetName} has been requested
SACLI001110 - Re-Activation of current active policy has been requested

Usage

zowe system-automation activate policy [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationcreate

Create an object from template

zowesystem-automationcreateresource

Create a dynamic resource from template

Requires (min.): SA Operations API 1.0.0

Following Success Message can be returned by this command:
SACLI002100 - Dynamic resource {ResourceName} has been created from template {TemplateName}

Usage

zowe system-automation create resource [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationdelete

Delete requests or dynamic resource instance that exist in the SAplex

zowesystem-automationdeleterequest

Delete (cancel) a request.

Requires (min.): SA Operations API 1.1.0

Following Success Message can be returned by this command:
SACLI003200 - {Action} request on {ResourceName} from source {Source} has been deleted

Usage

zowe system-automation delete request [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationdeleteresource

Delete a resource instance created from template (dynamic resource)

Requires (min.): SA Operations API 1.0.0

Following Success Message can be returned by this command:
SACLI003100 - Resource {ResourceName} has been deleted

Usage

zowe system-automation delete resource [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationdisable

Disable recording or takeoverfile processing

zowesystem-automationdisablerecording

Disable the recording processing.

Requires (min.): SA Operations API 1.1.0

Following Success Message can be returned by this command:
SACLI004100 - Recording has been disabled

Usage

zowe system-automation disable recording [options]

Profile Options

Base Connection Options

Examples

zowesystem-automationdisabletakeoverfile

Disable the takeover handling via Takeoverfile.

Following Success Message can be returned by this command:
SACLI004200 - Takeoverfile processing has been disabled

Usage

zowe system-automation disable takeoverfile [options]

Profile Options

Base Connection Options

Examples

zowesystem-automationenable

Enable recording or takeoverfile processing

zowesystem-automationenablerecording

Enable the recording processing to a specified dataset.

Requires (min.): SA Operations API 1.1.0

Following Success Message can be returned by this command:
SACLI005100 - Recording to {DatasetName} has been enabled

Usage

zowe system-automation enable recording [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationenabletakeoverfile

Enable the takeover handling via takeoverfile.

Requires (min.): SA Operations API 1.1.0

Following Success Message can be returned by this command:
SACLI005200 - Takeoverfile processing has been enabled

Usage

zowe system-automation enable takeoverfile [options]

Profile Options

Base Connection Options

Examples

zowesystem-automationlist

Query resources, templates, requests and configuration members defined in an SAplex

zowesystem-automationlistmembers

List all configuration members currently defined

Requires (min.): SA Operations API 1.1.0

Following Success Message can be returned by this command:
SACLI006100 - Listing Members success

Usage

zowe system-automation list members [options]

Options

View Options

Profile Options

Base Connection Options

Examples

zowesystem-automationlistpolicies

List the active configuration (policy) of all SAPlex members (agent and manager).

Requires (min.): SA Operations API 1.0.0

Following Success Message can be returned by this command:
SACLI006500 - Listing policies success

Usage

zowe system-automation list policies [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationlistrequests

List all requests currently added to resources matching the specified filter options.

Requires (min.): SA Operations API 1.1.0

Following Success Message can be returned by this command:
SACLI006200 - Listing requests success

Usage

zowe system-automation list requests [options]

Options

List Options

Profile Options

Base Connection Options

Examples

zowesystem-automationlistresources

List all resources currently being automated and matching the specified filter options in a table.

Requires (min.): SA Operations API 1.0.0

Following Success Message can be returned by this command:
SACLI006300 - Listing resources success

Usage

zowe system-automation list resources [options]

Options

View group

Profile Options

Base Connection Options

Examples

zowesystem-automationlisttemplates

List all templates currently defined matching the spcecified filter options in a table.

Requires (min.): SA Operations API 1.0.0

Following Success Message can be returned by this command:
SACLI006400 - Listing templates success

Usage

zowe system-automation list templates [options]

Options

View group

Profile Options

Base Connection Options

Examples

zowesystem-automationresume

Resume a component known by System Automation such as a resource.

zowesystem-automationresumemember

Resumen an SAPlex member (SA Agent).

Requires (min.): SA Operations API 1.1.0

Following Success Message can be returned by this command:
SACLI007100 - Requesting resume of SAPlex member (SA Agent) success

Usage

zowe system-automation resume member [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationresumeresource

Resume a resource.

Requires (min.): SA Operations API 1.0.0

Following Success Message can be returned by this command:
SACLI007200 - Requesting resume of resource {ResourceName} success

Usage

zowe system-automation resume resource [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationset

Set an option of an SAPlex Member

zowesystem-automationsetPrimaryManager

Set an Automation Manager to Primary Automation Manager (PAM)

Requires (min.): SA Operations API 1.1.0

Following Success Message can be returned by this command:
SACLI008100 - Setting Primary Automation Manger on {SYSTEM} success

Usage

zowe system-automation set PrimaryManager [options]

Options

Profile Options

Base Connection Options

zowesystem-automationstart

Starts an object known by System Automation such as a resource

zowesystem-automationstartresource

Issues a start request, that will cause the resource to start in case the request is winning.

Requires (min.): SA Operations API 1.0.0

Following Success Message can be returned by this command:
SACLI009100 - Requesting start of resource {ResourceName} success

Usage

zowe system-automation start resource [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationstop

Stops a component known by System Automation such as a resource

zowesystem-automationstopresource

Issues a stop request, that will cause the resource to stop in case the request is winning.

Requires (min.): SA Operations API 1.0.0

Following Success Message can be created by this command:
SACLI010100 - Requesting stop of resource {ResourceName} success

Usage

zowe system-automation stop resource [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationsuspend

Suspend an object known by System Automation such as a resource

zowesystem-automationsuspendmember

Suspend an agent (SAPlex member).

Requires (min.): SA Operations API 1.1.0

Following Success Message can be created by this command:
SACLI02300 - Request suspend of agent {AgentName} success

Usage

zowe system-automation suspend member [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationsuspendresource

Suspend a resource.

Requires (min.): SA Operations API 1.0.0

Following Success Message can be created by this command:
SACLI011200 - Requesting suspend of resource {ResourceName} success

Usage

zowe system-automation suspend resource [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationview

View details about an SA object

zowesystem-automationviewconnection

View connection information of SA Operations REST Server that would be used by any other CLI command.

In case you have connection problems with any other CLI command - you can use this command instead

to check the connection options as resulting combination from base profile, sa profile and command line

parameters that are being used to connect the SA Operations Server.

Following Success Message can be created by this command:
SACLI012500 - Connected SA Operations API REST Server: {Server} on Port: {Port}

Usage

zowe system-automation view connection [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationviewmember

View details of an SAPlex member (agent or automation manager)

Requires (min.): SA Operations API 1.1.0

Following Success Message can be created by this command:
SACLI012100 - Viewing member success

Usage

zowe system-automation view member [options]

Options

View Options

Profile Options

Base Connection Options

Examples

zowesystem-automationviewrequest

View details of a request.

Requires (min.): SA Operations API 1.1.0

Following Success Message can be created by this command:
SACLI012200 - Viewing request success

Usage

zowe system-automation view request [options]

Options

Profile Options

Base Connection Options

Examples

zowesystem-automationviewresource

View details of one resource.

Requires (min.): SA Operations API 1.0.0

Following Success Message can be created by this command:
SACLI02300 - Request suspend of agent {AgentName} success

Usage

zowe system-automation view resource [options]

Options

View Option

Profile Options

Base Connection Options

Examples

zowesystem-automationviewversion

View API version of connected SA Operations REST Server.

Requires (min.): SA Operations API 1.1.0

Following Success Message can be created by this command:
SACLI012400 - Connected SA Operations API {Version} is {Status}.

Usage

zowe system-automation view version [options]

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

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


zoweworkload-automation

Interact with IBM Z Workload Scheduler

zoweworkload-automationexecute

Execute WAPL commands. Enclose the commands in double quotes and escape any symbols that have a special meaning to the shell.

zoweworkload-automationexecutewapl

Execute one or multiple WAPL statements from a command line.

Usage

zowe workload-automation execute wapl [options]

Options

workload-automation Connection Options

Profile Options

Base Connection Options

Examples

zoweworkload-automationget

Get resources or jobs in plan.

zoweworkload-automationgetjobinplan

Get the job in plan.

Usage

zowe workload-automation get jobinplan [options]

Required Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweworkload-automationgetresourceinplan

Get the resource in plan.

Usage

zowe workload-automation get resourceinplan [options]

Required Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweworkload-automationlist

List jobs, jobstreams, and resources in plan, list jobstreams in model(database).

zoweworkload-automationlistjobinplan

List the jobs in plan.

Usage

zowe workload-automation list jobinplan [options]

Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweworkload-automationlistjobstreaminmodel

List the jobstreams in model.

Usage

zowe workload-automation list jobstreaminmodel [options]

Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweworkload-automationlistjobstreaminplan

List the jobstreams in plan.

Usage

zowe workload-automation list jobstreaminplan [options]

Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweworkload-automationlistresourceinplan

List the resources in plan.

Usage

zowe workload-automation list resourceinplan [options]

Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweworkload-automationset-status

Set the status of a job in plan.

zoweworkload-automationset-statusjobinplan

Set the status of a job in plan.

Usage

zowe workload-automation set-status jobinplan [options]

Required Options

Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweworkload-automationsubmit

Submit a jobstream into the plan.

zoweworkload-automationsubmitjobstreaminplan

Submit a jobstream to the plan.

Usage

zowe workload-automation submit jobstreaminplan [options]

Required Options

Options

workload-automation Connection Options

Profile Options

Base Connection Options

Examples

zoweworkload-automationupdate

Update resources or jobs in plan.

zoweworkload-automationupdatejobinplan

Update the job in plan.

Usage

zowe workload-automation update jobinplan [options]

Required Options

Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweworkload-automationupdateresourceinplan

Update the resource in plan.

Usage

zowe workload-automation update resourceinplan [options]

Required Options

workload-automation Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples


zoweznetview-automation

Manage NetView automation tables.

zoweznetview-automationactivate

Activate an automation table.

zoweznetview-automationactivateautomation-table

This command activates an automation table by inserting it into the current list of active automation tables.

NOTE: If the specified automation table already exists within the list of active automation tables, this automation table will be replaced at its existing position, and the position option is ignored.

Usage

zowe znetview-automation activate automation-table <memberName> [options]

Positional Arguments

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-automationdownload

Download automation table statement(s).

zoweznetview-automationdownloadautomation-table

Download automation table statements from a data set member to a file on your local system so the contents can be modified and saved again.

Note that unpredictable results can occur in the following situations:

An automation table has syntax errors.

Data REXX is used in the automation table, etc.

Usage

zowe znetview-automation download automation-table <memberName> [options]

Positional Arguments

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-automationlist

List the automation table statistics.

zoweznetview-automationlistautomation-table-statistics

Retrieve automation table statistics for the specified member and report type.

Usage

zowe znetview-automation list automation-table-statistics <tableName> [options]

Positional Arguments

Required Options

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-automationtest

Run a simulated automation table test for a Canzlog message.

zoweznetview-automationtestautomation-table

Replay a recorded Canzlog message and its attributes. You can either provide an automation table name or specify the path of the local file which stores the automation table statements for testing, but you can’t provide both parameters at the same time.

Note: Both the recorded member name AND a file or member that contains 1 automation table statement are valid parameters.

Usage

zowe znetview-automation test automation-table [options]

Required Options

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-automationupload

Upload automation table statement(s).

zoweznetview-automationuploadautomation-table

Upload automation table statement(s) into the specified data set and member.

Usage

zowe znetview-automation upload automation-table <memberName> [options]

Positional Arguments

Required Options

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-automationvalidate

Validate an automation table.

zoweznetview-automationvalidateautomation-table

Validate an automation table.

Usage

zowe znetview-automation validate automation-table [options]

Required Options

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples


zoweznetview-base

Perform basic NetView operations.

zoweznetview-baseauth

Connect to the NetView REST Server authentication service and obtain a token, or disconnect from the NetView REST Server and revoke the token.

zoweznetview-baseauthlogin

Log in to the NetView REST Server authentication service and obtain a token. When you log in to the NetView REST Server authentication service without any option, the token will be stored in your default NetView profile until it expires.

Usage

zowe znetview-base auth login [options]

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-baseauthlogout

Log out of the NetView REST Server. The authentication token is revoked and removed from the default NetView profile, if the token was stored there.

Usage

zowe znetview-base auth logout [options]

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-baseissue

Issue NetView commands

zoweznetview-baseissuecommand

Issue NetView commands and display responses. This REST API will not work for every NetView command. Any command that provides outputs in a panel will not be retrieved.

Note: No specific formatting has been done for command output.

Usage

zowe znetview-base issue command <commandText> [options]

Positional Arguments

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-baselist

List Canzlog messages, task utilization information, and active NetView domains.

zoweznetview-baselistcanzlog

List a message or a set of messages from Canzlog.

Usage

zowe znetview-base list canzlog <requestType> [options]

Positional Arguments

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-baselistdomains

List data about active NetView domains in a sysplex or active domains configured to the enterprise master NetView program. The command that NetView program is running is LIST STATUS=XCFGRPS, which returns a list of z/OS® XCF groups in which the NetView program participates. Note: The DISCOVERY Tower must be enabled to retrieve data from other NetView domains configured to the enterprise master NetView program.

Usage

zowe znetview-base list domains [options]

Options

NetView Connection Options

Profile Options

Base Connection Options

zoweznetview-baselisttask-info

Lists the CPU utilization, storage utilization, number of queued messages, and the running command (if available) for active NetView tasks.

Usage

zowe znetview-base list task-info [options]

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-baserecord

Record a Canzlog message and its message attributes.

zoweznetview-baserecordcanzlog

Record the Canzlog message and its message attributes in the topmost concatenated DSIASRC DD data set.

The recording contains all the relevant information about the message that can be retrieved from Canzlog, and much of the information is in a non-readable format.

This step should be done as soon as the Canzlog message are successfully retrieved, because the message could become unavailable in a short time.

Usage

zowe znetview-base record canzlog <czid> [options]

Positional Arguments

Required Options

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples


zoweznetview-network

Monitor your network with the NetView program.

zoweznetview-networklist

List distributed Dynamic Virtual IP Address (DDVIPA) data.

zoweznetview-networklistddvipa-health

List health information for distributed Dynamic Virtual IP Addresses (DDVIPAs).

Usage

zowe znetview-network list ddvipa-health [options]

Options

NetView Connection Options

Profile Options

Base Connection Options

Examples

zoweznetview-networklistddvipa-stats

List information on the percentage of connections distributed to a specific IP address and port in comparison to the Workload Manager (WLM) recommended distribution percentage. The Workload Manager related information is also displayed. Several parameters are provided for filtering the data.

Usage

zowe znetview-network list ddvipa-stats [options]

Options

NetView 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-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-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-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-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-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:

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

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

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-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 or partitioned dataset

Usage

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

Positional Arguments

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 in OUTPUT status. This cancels the job if it is running and purges its output from the system.

zowezos-jobsdeletejob

Delete a single job by job ID

Usage

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

Positional Arguments

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-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-jobsview

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

zowezos-jobsviewjob-status-by-jobid

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

Usage

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

Positional Arguments

Zosmf Connection Options

Profile Options

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

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

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


zowezosconnect

z/OS Connect EE plugin for Zowe CLI

zowezosconnectapi

Manage z/OS Connect EE APIs

zowezosconnectapidelete

Delete an API

Usage

zowe zosconnect api delete <apiName> [options]

Positional Arguments

Options

z/OS Connect EE Connection Options

Profile Options

Base Connection Options

zowezosconnectapiinfo

Get detailed information about an API

Usage

zowe zosconnect api info <apiName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapiinstall

Install a new API

Usage

zowe zosconnect api install <file> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapilist

List the APIs installed in the server

Usage

zowe zosconnect api list [options]

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapistart

Set an APIs status to started

Usage

zowe zosconnect api start <apiName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapistop

Set an APIs status to stopped

Usage

zowe zosconnect api stop <apiName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapiupdate

Update an existing API

Usage

zowe zosconnect api update <apiName> <file> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapirequester

Manage z/OS Connect EE API Requesters

zowezosconnectapirequesterdelete

Delete an API Requester

Usage

zowe zosconnect apirequester delete <apiRequesterName> [options]

Positional Arguments

Options

z/OS Connect EE Connection Options

Profile Options

Base Connection Options

zowezosconnectapirequesterinfo

Get detailed information about an API Requester

Usage

zowe zosconnect apirequester info <apiRequesterName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapirequesterinstall

Install a new API Requester

Usage

zowe zosconnect apirequester install <file> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapirequesterlist

List the API Requesters installed in the server

Usage

zowe zosconnect apirequester list [options]

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapirequesterstart

Set an API Requester status to started

Usage

zowe zosconnect apirequester start <apiRequesterName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapirequesterstop

Set an API Requesters status to stopped

Usage

zowe zosconnect apirequester stop <apiRequesterName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectapirequesterupdate

Update an existing API Requester

Usage

zowe zosconnect apirequester update <apiRequesterName> <file> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectservice

Manage z/OS Connect EE Services

zowezosconnectservicedelete

Delete a Service

Usage

zowe zosconnect service delete <serviceName> [options]

Positional Arguments

Options

z/OS Connect EE Connection Options

Profile Options

Base Connection Options

zowezosconnectserviceinfo

Get detailed information about a Service

Usage

zowe zosconnect service info <serviceName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectserviceinstall

Install a new Service

Usage

zowe zosconnect service install <file> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectservicelist

List the Services installed in the server

Usage

zowe zosconnect service list [options]

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectservicestart

Set a Services status to started

Usage

zowe zosconnect service start <serviceName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectservicestop

Set a Services status to stopped

Usage

zowe zosconnect service stop <serviceName> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options

zowezosconnectserviceupdate

Update an exisiting Service

Usage

zowe zosconnect service update <serviceName> <file> [options]

Positional Arguments

z/OS Connect EE Connection Options

Options

Profile Options

Base Connection Options


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