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!

zoweca7commands

All the available commands are listed in the COMMANDS section.

zoweca7commandsaddrq

Manually adds temporary, one-time, preexecution user or predecessor job requirements

Usage

zowe ca7 commands addrq [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandscancel

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.

Usage

zowe ca7 commands cancel [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsdemand

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 commands demand [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsdemandh

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

Usage

zowe ca7 commands demandh [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandshold

This function is available on the QM.1 panel with a FILL value of H.
Depending on the timing and whether you have any other
predecessor situations, the QM.3 panel can sometimes accomplish this process.
For more information on HOLD command, see the techdocs folder in this project.

Usage

zowe ca7 commands hold [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsjclovrd

The JCLOVRD command establishes or satisfies JCL override requirements.

Usage

zowe ca7 commands jclovrd [options]

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandspost

The POST command indicates to the CA Workload Automation CA 7 Editionsystem that a preexecution requirement for a job in the request queue is satisfied

Usage

zowe ca7 commands post [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsprscf

The PRSCF command frees a shared, exclusive, or RCT resource that is connected to a job

Usage

zowe ca7 commands prscf [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsprsqa

The PRSQA command activates a corequisite resource

Usage

zowe ca7 commands prsqa [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsrelease

Release a single job to CA 7.

Usage

zowe ca7 commands release [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsrequeue

Re-queues jobs from the ready or active queues back to the request queue.

Usage

zowe ca7 commands requeue [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsresolv

Work that is scheduled by a trigger or on-request work that is DEMANDed or RUN has no direct relationship to a base calendar and therefore does not require the use of this function.

Usage

zowe ca7 commands resolv [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsrestart

Restart a single job to CA 7.

Usage

zowe ca7 commands restart [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsrmtsub

The RMTSUB command is used by a scheduling product that has a remote job dependency on a CA 7 job.

Usage

zowe ca7 commands rmtsub [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsrmttrk

The RMTTRK defines a dependency on a job in a remote CA 7 workload.

Usage

zowe ca7 commands rmttrk [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsrun

Run a single job to CA 7.

Usage

zowe ca7 commands run [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsrunh

Run and hold a single job to CA 7.

Usage

zowe ca7 commands runh [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandssubmit

The SUBMIT top line command modifies and expedites the process of job submission for jobs already residing in the queues

Usage

zowe ca7 commands submit [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandssubtm

SUBTM modifies the required submit time-of-day for a job in the request queue

Usage

zowe ca7 commands subtm [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7commandsverify

The VERIFY command establishes or satisfies a manual verification requirement for a currently scheduled run of the job in the request queue before its execution.

Usage

zowe ca7 commands verify [options]

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7create-job-definition

All the available commands are listed in the COMMANDS section.

zoweca7create-job-definitionreq-predecessor

Creates predecessor requirement for a job.

Usage

zowe ca7 create-job-definition req-predecessor [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7create-job-definitionschedule

Create schedule parameters

Usage

zowe ca7 create-job-definition schedule [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7create-resource-definition

All the available commands are listed in the COMMANDS section.

zoweca7create-resource-definitionresource-count-resource

Create Resource Count Resource parameters

Usage

zowe ca7 create-resource-definition resource-count-resource [options]

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7dataset

All the available commands listed in the Dataset section.

zoweca7datasetcreate-dataset

Create Dataset

Usage

zowe ca7 dataset create-dataset [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7datasetcreate-dataset-trigger

Create Dataset Trigger

Usage

zowe ca7 dataset create-dataset-trigger [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7datasetdelete-dataset

Delete Dataset

Usage

zowe ca7 dataset delete-dataset [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7datasetdelete-dataset-trigger

Delete Dataset Trigger

Usage

zowe ca7 dataset delete-dataset-trigger [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7datasetrename-dataset

Rename a existing Dataset

Usage

zowe ca7 dataset rename-dataset [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7datasetupdate-dataset

Modify Dataset

Usage

zowe ca7 dataset update-dataset [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7datasetupdate-dataset-trigger

Modify Dataset Trigger

Usage

zowe ca7 dataset update-dataset-trigger [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7delete-job-definition

All the available commands are listed in the COMMANDS section.

zoweca7delete-job-definitionreq-predecessor

Delete predecessor requirement for a job.

Usage

zowe ca7 delete-job-definition req-predecessor [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7delete-job-definitionschedule

Delete an existing date/time schedule

Usage

zowe ca7 delete-job-definition schedule [options]

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7delete-resource-definition

All the available commands are listed in the COMMANDS section.

zoweca7delete-resource-definitionresource-count-resource

Delete a Resource Count resource

Usage

zowe ca7 delete-resource-definition resource-count-resource [options]

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7event-manager-requests

All the available commands are listed in the COMMANDS section.

zoweca7event-manager-requestsjob-status

Available request is listed below.

Usage

zowe ca7 event-manager-requests job-status [options]

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definition

All the available commands listed in the Job Definition section.

zoweca7job-definitioncreate-address-space-resource

Add Address Space Resource

Usage

zowe ca7 job-definition create-address-space-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitioncreate-corequisite-resource

Add Corequisite Resource

Usage

zowe ca7 job-definition create-corequisite-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitioncreate-exclusive-resource

Add Exclusive Resource

Usage

zowe ca7 job-definition create-exclusive-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitioncreate-job

Create Job Definition

Usage

zowe ca7 job-definition create-job [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitioncreate-job-trigger-successor

Add Job Trigger

Usage

zowe ca7 job-definition create-job-trigger-successor [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitioncreate-resource-count-resource

Add Resource Count Resource

Usage

zowe ca7 job-definition create-resource-count-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitioncreate-shared-resource

Post Shared Resource

Usage

zowe ca7 job-definition create-shared-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitioncreate-variable-resource

Add Variable Resource

Usage

zowe ca7 job-definition create-variable-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitiondelete-address-space-resource

Delete Address Space Resource

Usage

zowe ca7 job-definition delete-address-space-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitiondelete-corequisite-resource

Delete Corequisite Resource

Usage

zowe ca7 job-definition delete-corequisite-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitiondelete-exclusive-resource

Delete Exclusive Resource

Usage

zowe ca7 job-definition delete-exclusive-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitiondelete-job

Delete Job Definition

Usage

zowe ca7 job-definition delete-job [options]

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitiondelete-job-trigger-successor

Delete Job Trigger

Usage

zowe ca7 job-definition delete-job-trigger-successor [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitiondelete-resource-count-resource

Delete Resource Count Resource

Usage

zowe ca7 job-definition delete-resource-count-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitiondelete-shared-resource

Delete Shared Resource

Usage

zowe ca7 job-definition delete-shared-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitiondelete-variable-resource

Delete Variable Resource

Usage

zowe ca7 job-definition delete-variable-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionlist-job

List Job Definiton

Usage

zowe ca7 job-definition list-job [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionlist-job-trigger-successor

Get Job Trigger Successor

Usage

zowe ca7 job-definition list-job-trigger-successor [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionupdate-address-space-resource

Modify Address Space Resource

Usage

zowe ca7 job-definition update-address-space-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionupdate-corequisite-resource

Modify Corequisite Resource

Usage

zowe ca7 job-definition update-corequisite-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionupdate-exclusive-resource

ExclusiveResource

Usage

zowe ca7 job-definition update-exclusive-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionupdate-job

JobDefinition

Usage

zowe ca7 job-definition update-job [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionupdate-job-trigger-successor

Modify Job Trigger Successor

Usage

zowe ca7 job-definition update-job-trigger-successor [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionupdate-resource-count-resource

Modify Resource Count Resource

Usage

zowe ca7 job-definition update-resource-count-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-definitionupdate-shared-resource

Modify Shared Resource

Usage

zowe ca7 job-definition update-shared-resource [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7job-instance

All the available commands listed in the Job Instance section.

zoweca7job-instancelist-waiting-resource

List waiting Resource

Usage

zowe ca7 job-instance list-waiting-resource [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definition

All the available commands are listed in the COMMANDS section.

zoweca7list-job-definitionjob

Get a list of the job definitions for one or more jobs.

Usage

zowe ca7 list-job-definition job [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definitionprose

Get a list of the prose information for one or more jobs.

Usage

zowe ca7 list-job-definition prose [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definitionrequirement-predecessor

Get a list of the predecessors for one or more jobs.

Usage

zowe ca7 list-job-definition requirement-predecessor [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definitionrequirement-successor

Get a list of the successor jobs for one or more jobs.

Usage

zowe ca7 list-job-definition requirement-successor [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definitionresource

Get a list of the job resources for one or more jobs.

Usage

zowe ca7 list-job-definition resource [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definitionschedule

Get a list of the job schedules for one or more jobs.

Usage

zowe ca7 list-job-definition schedule [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definitionstep-dd

Get a list of the job STEP and DD information for one or more jobs.

Usage

zowe ca7 list-job-definition step-dd [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definitiontrigger-predecessor

Get a list of the trigger objects for one or more jobs.

Usage

zowe ca7 list-job-definition trigger-predecessor [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-definitiontrigger-successor

Get a list of the triggered jobs for one or more jobs.

Usage

zowe ca7 list-job-definition trigger-successor [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-history

All the available commands are listed in the COMMANDS section.

zoweca7list-job-historyprior-run

Get a list one or more jobs from the prior-run queue.

Usage

zowe ca7 list-job-history prior-run [options]

Options

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-instance

All the available commands are listed in the COMMANDS section.

zoweca7list-job-instanceactive-resource

Display active resources by job.

Usage

zowe ca7 list-job-instance active-resource [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-instancejcl

Displays JCL for a job in the active workload.

Usage

zowe ca7 list-job-instance jcl [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-instancelist

Displays information about jobs in the active workload.

Usage

zowe ca7 list-job-instance list [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-instancelistCustom

Displays information about jobs in the active workload.

Usage

zowe ca7 list-job-instance listCustom [options]

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-job-instancerequirements

Displays information about requirements for jobs in the active workload.

Usage

zowe ca7 list-job-instance requirements [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7list-resource-definition

All the available commands are listed in the COMMANDS section.

zoweca7list-resource-definitionresource-count-resource

Retrieves a Resource Count Resource Information

Usage

zowe ca7 list-resource-definition resource-count-resource [options]

Required Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7update-job-definition

All the available commands are listed in the COMMANDS section.

zoweca7update-job-definitionjob

Update requirement definition for a job

Usage

zowe ca7 update-job-definition job [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7update-job-definitionrequirement-predecessor

Update requirement definition for a job

Usage

zowe ca7 update-job-definition requirement-predecessor [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7update-job-definitionschedule

Modify schedule parameters

Usage

zowe ca7 update-job-definition schedule [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7update-job-instance

All the available commands are listed in the COMMANDS section.

zoweca7update-job-instancejcl

Update JCL for a job

Usage

zowe ca7 update-job-instance jcl [options]

Required Options

Options

CA7 Connection Options

Profile Options

Base Connection Options

Examples

zoweca7update-resource-definition

All the available commands are listed in the COMMANDS section.

zoweca7update-resource-definitionresource-count-resource

Modify Resource Count Resource parameters

Usage

zowe ca7 update-resource-definition resource-count-resource [options]

Required Options

CA7 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


zoweconfig

Manage JSON project and global configuration

zoweconfigauto-init

Automatically generate a config from APIML

Usage

zowe config auto-init [options]

Automatic Config Initialization Options

APIML Connection Options

Profile Options

zoweconfigconvert-profiles

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

Usage

zowe config convert-profiles [options]

Options

Examples

zoweconfigedit

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

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

Usage

zowe config edit [options]

Options

Examples

zoweconfigimport

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

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

Usage

zowe config import <location> [options]

Positional Arguments

Options

Connection Options

Examples

zoweconfiginit

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

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

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

Usage

zowe config init [options]

Options

Examples

zoweconfiglist

List config properties

Usage

zowe config list [property] [options]

Positional Arguments

Options

Examples

zoweconfigprofiles

Displays profile paths.

Usage

zowe config profiles [options]

Examples

zoweconfigschema

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

Usage

zowe config schema [options]

Examples

zoweconfigsecure

prompt for secure configuration properties

Usage

zowe config secure [options]

Options

Examples

zoweconfigset

create or update a configuration property

Usage

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

Positional Arguments

Options

Examples

zoweconfigupdate-schemas

Update schema files by looking up the directory structure.

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

Usage

zowe config update-schemas [options]

Options

Examples


zowedaemon

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

zowedaemondisable

Disables daemon-mode operation of the Zowe CLI.

Usage

zowe daemon disable [options]

Examples

zowedaemonenable

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

Usage

zowe daemon enable [options]

Examples

zowedaemonrestart

Restart the Zowe CLI daemon.

Usage

zowe daemon restart [options]

Examples


zowedb2

Interact with IBM Db2 for z/OS

zowedb2call

Call a Db2 stored procedure

zowedb2callprocedure

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

Usage

zowe db2 call procedure <routine> [options]

Positional Arguments

Options

DB2 Connection Options

Profile Options

Base Connection Options

Examples

zowedb2execute

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

zowedb2executesql

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

Usage

zowe db2 execute sql [options]

Options

DB2 Connection Options

Profile Options

Base Connection Options

Examples

zowedb2export

Export data from a Db2 table

zowedb2exporttable

Export a Db2 table to the stdout or a file.

Usage

zowe db2 export table <table> [options]

Positional Arguments

Options

DB2 Connection Options

Profile Options

Base Connection Options

Examples


zoweendevor-bridge-for-git

Use the 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-gitbranch

Manage the branches of your Git-Endevor mapping.

zoweendevor-bridge-for-gitbranchadd

Add a branch to an existing mapping

Usage

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

Positional Arguments

Options

Endevor options (alternatively use an 'endevor' profile)

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitbranchdelete

Remove a branch from an existing mapping

Usage

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

Positional Arguments

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitbranchlist

List the branches of an existing mapping

Usage

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

Positional Arguments

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitbuild

Build changes from git local repository in Endevor

zoweendevor-bridge-for-gitbuildexecute

Build changes against remote git repository's 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-connection

Manage connections to Endevor Web Services used by Endevor Bridge for Git.

zoweendevor-bridge-for-gitendevor-connectioncreate

Create new Endevor connection for Endevor Bridge for Git.

Usage

zowe endevor-bridge-for-git endevor-connection create <connection> [options]

Positional Arguments

Options

Endevor options (alternatively use an 'endevor' profile)

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitendevor-connectiondelete

Delete existing Endevor connection defined to Endevor Bridge for Git.

Usage

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

Positional Arguments

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitendevor-connectionlist

List Endevor connections used by Endevor Bridge for Git.

Usage

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

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

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevor-bridge-for-gitendevor-connectionrename

Rename existing Endevor connection defined to Endevor Bridge for Git.

Usage

zowe endevor-bridge-for-git endevor-connection rename <connection> <new-connection> [options]

Positional Arguments

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitendevor-connectionupdate-credentials

Update your Endevor credentials for the Endevor connection.

Usage

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

Positional Arguments

Endevor options (alternatively use an 'endevor' profile)

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitendevor-credentials

Manage your Endevor credentials stored in Endevor Bridge for Git. [Deprecated]

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)

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

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)

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

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

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

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevor-bridge-for-gitprocessor-group

Manage the processor groups of your mapping

zoweendevor-bridge-for-gitprocessor-grouplist

List processor groups used by a type in your mapping

Usage

zowe endevor-bridge-for-git processor-group list [options]

Options

Response Format Options

Examples

zoweendevor-bridge-for-gitprocessor-groupupdate

Update the processor group of a specific element in your local repository

Usage

zowe endevor-bridge-for-git processor-group update <element> <processor-group> [options]

Positional Arguments

Options

Response Format Options

zoweendevor-bridge-for-gitprocessor-groupupdate-all

Update the processor group of all changed elements of a specific type

Usage

zowe endevor-bridge-for-git processor-group update-all <processor-group> [options]

Positional Arguments

Options

Response Format Options

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


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


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

MAT Profile Options

Profile Options

Base Connection Options

Examples

zowematmonitorcodeviewcsect

Get the CodeView measurement details in Csect mode.

Usage

zowe mat monitor codeview csect [options]

Options

MAT Profile Options

Profile Options

Base Connection Options

Examples

zowematmonitorcodeviewhistogram

Get the Histogram details for the measurement.

Usage

zowe mat monitor codeview histogram [options]

Options

MAT Profile Options

Profile Options

Base Connection Options

Examples

zowematmonitorcodeviewmodule

Get the CodeView measurement details in Module mode.

Usage

zowe mat monitor codeview module [options]

Options

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

MAT Profile Options

Profile Options

Base Connection Options

Examples

zowematmonitordb2sqlstmt

Get SQL details for the DB2 statement.

Usage

zowe mat monitor db2 sqlstmt [options]

Options

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

MAT Profile Options

Profile Options

Base Connection Options

Examples

zowematmonitordelayviewdelay

Get the delay details for the measurement.

Usage

zowe mat monitor delayview delay [options]

Options

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

MAT Profile Options

Profile Options

Base Connection Options

Examples

zowematmonitoroverview

Get the overview details of the measurement.

Usage

zowe mat monitor overview [options]

Options

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

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

MAT Profile Options

Profile Options

Base Connection Options

Examples

zowematprofilelist

Get the list of available monitor profiles.

Usage

zowe mat profile list [options]

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


zoweomspool

Interact with Spool™

zoweomspoolissue

Issue Spool commands.

zoweomspoolissuecommand

Issue commands to work with Spool.

Usage

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

Positional Arguments

SPOOL OPTIONS

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

Warning: This group has been deprecated.
Recommended replacement: The 'config init' command

zoweprofilescreate

Create new configuration profiles.

Warning: This group has been deprecated.
Recommended replacement: The 'config init' command

zoweprofilescreatebase-profile

Base profile that stores values shared by multiple service profiles

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

CA7 Connection Options

Options

zoweprofilescreatecaview-profile

Configuration profile for View

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

Options

Cics Connection Options

Examples

zoweprofilescreatedb2-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

Options

zoweprofilescreateebg-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

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

Options

zoweprofilescreatefmp-profile

File Master Plus profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

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

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

IMS Connection Options

Options

Examples

zoweprofilescreatemat-profile

MAT Analyze CLI profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

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

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

MQ Connection Options

Options

Examples

zoweprofilescreateomspool-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

SPOOL OPTIONS

Options

Examples

zoweprofilescreateops-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

OPS WEB SERVICES CONNECTION OPTIONS

Options

Examples

zoweprofilescreatepma-profile

MAT Detect CLI profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

PMA Connection Options

Options

Examples

zoweprofilescreatessh-profile

z/OS SSH Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

z/OS Ssh Connection Options

Options

Examples

zoweprofilescreatetso-profile

z/OS TSO/E User Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

TSO ADDRESS SPACE OPTIONS

Options

Examples

zoweprofilescreatezftp-profile

Configuration profile for z/OS FTP

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Options

Examples

zoweprofilescreatezosmf-profile

z/OSMF Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config init' command

Usage

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

Positional Arguments

Zosmf Connection Options

Options

Examples

zoweprofilesdelete

Delete existing profiles.

Warning: This group has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

zowe profiles delete ca7-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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

zowe profiles delete caview-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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

zowe profiles delete 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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

zowe profiles delete ebg-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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

zowe profiles delete fmp-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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

zowe profiles delete ims-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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeleteomspool-profile

Delete a omspool 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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

zowe profiles delete omspool-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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

zowe profiles delete pma-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.

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletetso-profile

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

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletezftp-profile

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

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletezosmf-profile

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

Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json

Usage

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

Positional Arguments

Options

Examples

zoweprofileslist

List profiles of the type {{type}}.

Warning: This group has been deprecated.
Recommended replacement: The 'config list' command

zoweprofileslistbase-profiles

Base profile that stores values shared by multiple service profiles

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list ca7-profiles [options]

Options

Examples

zoweprofileslistcaview-profiles

Configuration profile for View

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list caview-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list cics-profiles [options]

Options

Examples

zoweprofileslistdb2-profiles

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

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list 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 Endevor Bridge for Git server of your choice.

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list ebg-profiles [options]

Options

Examples

zoweprofileslistfmp-profiles

File Master Plus profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list fmp-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list ims-profiles [options]

Options

Examples

zoweprofileslistmat-profiles

MAT Analyze CLI profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

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

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list mq-profiles [options]

Options

Examples

zoweprofileslistomspool-profiles

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

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list omspool-profiles [options]

Options

Examples

zoweprofileslistops-profiles

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

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list ops-profiles [options]

Options

Examples

zoweprofileslistpma-profiles

MAT Detect CLI profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list pma-profiles [options]

Options

Examples

zoweprofileslistssh-profiles

z/OS SSH Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list ssh-profiles [options]

Options

Examples

zoweprofileslisttso-profiles

z/OS TSO/E User Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list tso-profiles [options]

Options

Examples

zoweprofileslistzftp-profiles

Configuration profile for z/OS FTP

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list zftp-profiles [options]

Options

Examples

zoweprofileslistzosmf-profiles

z/OSMF Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config list' command

Usage

zowe profiles list zosmf-profiles [options]

Options

Examples

zoweprofilesset-default

Set which profiles are loaded by default.

Warning: This group has been deprecated.
Recommended replacement: The 'config set' command

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles set-default ca7-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles set-default caview-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles set-default 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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles set-default ebg-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles set-default fmp-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles set-default ims-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultomspool-profile

The omspool set default-profiles command allows you to set the default profiles for this command group. When a omspool 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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles set-default omspool-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles set-default pma-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaulttso-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultzftp-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultzosmf-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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.

Warning: This group has been deprecated.
Recommended replacement: The 'config set' command

zoweprofilesupdatebase-profile

Base profile that stores values shared by multiple service profiles

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

CA7 Connection Options

zoweprofilesupdatecaview-profile

Configuration profile for View

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

zowe profiles update caview-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.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

Options

zoweprofilesupdateebg-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

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

zoweprofilesupdatefmp-profile

File Master Plus profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

FMP Connection Options

zoweprofilesupdateims-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

IMS Connection Options

zoweprofilesupdatemat-profile

MAT Analyze CLI profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

MQ Connection Options

zoweprofilesupdateomspool-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

SPOOL OPTIONS

Examples

zoweprofilesupdateops-profile

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

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

OPS WEB SERVICES CONNECTION OPTIONS

Examples

zoweprofilesupdatepma-profile

MAT Detect CLI profile schema.

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

PMA Connection Options

zoweprofilesupdatessh-profile

z/OS SSH Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

z/OS Ssh Connection Options

zoweprofilesupdatetso-profile

z/OS TSO/E User Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

TSO ADDRESS SPACE OPTIONS

Examples

zoweprofilesupdatezftp-profile

Configuration profile for z/OS FTP

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

zoweprofilesupdatezosmf-profile

z/OSMF Profile

Warning: This command has been deprecated.
Recommended replacement: The 'config set' command

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


zowezos-console

Interact with z/OSMF console services. Issue z/OS console commands and collect responses. z/OS console services establishes extended MCS (EMCS) consoles on behalf of the user, which are used to issue the commands and collect responses.

Important! Before you use commands in the zos-console command group, ensure that you understand the implications of issuing z/OS console commands in your environment.

zowezos-consolecollect

z/OSMF console services provides a command response key upon successful issue of a console command. You can use this key to collect additional console message responses.

zowezos-consolecollectsync-responses

The z/OSMF console REST APIs return a "solicited response key" after successfully issuing a synchronous console command that produces solicited responses. You can use the "solicited response key"on the "sync-responses" command to collect any additional outstanding solicited responses from the console the command was issued.

In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. The command response messages are referred to as "solicited command responses" (i.e. direct responses to the command issued). When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default. However, there is no z/OS mechanism that indicates the total number of response messages that may be produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-consoleissue

Issue z/OS console commands and optionally collect responses.

zowezos-consoleissuecommand

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

In general, when issuing a z/OS console command, z/OS applications route responses to the originating console. The command response messages are referred to as "solicited command responses" (i.e. direct responses to the command issued). When issuing a z/OS console command using Zowe CLI, collection of all solicited command responses is attempted by default. However, there is no z/OS mechanism that indicates the total number of response messages that may be produced from a given command. Therefore, the Zowe CLI console APIs return a "solicited response key" that can be used to "follow-up" and collect any additional solicited command responses.

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezos-files

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

zowezos-filescompare

Compare the contents of a two data set members on your terminal (stdout).

zowezos-filescomparedata-set

Compare content of two z/OS data sets on your terminal (stdout).

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescomparelocal-file-data-set

Compare content of a local file and a z/os dataset on your terminal (stdout).

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescomparelocal-file-spool-dd

Compare content of a local-file and a spool-dd on your terminal (stdout).

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescomparelocal-file-uss-file

Compare content of a local file and a z/os uss file on your terminal (stdout).

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescomparespool-dd

Compare content of two spool dds on your terminal (stdout).

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescompareuss-files

Compare the contents of a two uss files on your terminal (stdout). browser.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescopy

Copy a data set.

zowezos-filescopydata-set

Copy a data set to another data set

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreate

Create data sets.

zowezos-filescreatedata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-binary

Create executable data sets

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-c

Create data sets for C code programming

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-classic

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-partitioned

Create partitioned data sets (PDS)

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-sequential

Create physical sequential data sets (PS)

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-vsam

Create a VSAM cluster

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreateuss-directory

Create a UNIX directory.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreateuss-file

Create a UNIX file.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatezos-file-system

Create a z/OS file system.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdelete

Delete a data set or Unix System Services file.

zowezos-filesdeletedata-set

Delete a data set or data set member permanently

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdeletedata-set-vsam

Delete a VSAM cluster permanently

Usage

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

Positional Arguments

Options

Required Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdeletemigrated-data-set

Delete migrated data sets.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdeleteuss-file

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

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdeletezos-file-system

Delete a z/OS file system permanently.

Usage

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

Positional Arguments

Required Options

Zosmf Connection Options

Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownload

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

zowezos-filesdownloadall-members

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownloaddata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownloaddata-sets-matching

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownloaduss-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
.* -
*.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-filesview

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

zowezos-filesviewdata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesviewuss-file

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezos-ftp

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

zowezos-ftpallocate

Allocate a sequential or partitioned dataset

zowezos-ftpallocatedata-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdelete

Delete data sets, jobs, and USS files

zowezos-ftpdeletedata-set

Delete a data set

Usage

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

Positional Arguments

Required Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdeletejob

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdeleteuss-file

Delete a USS file

Usage

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

Positional Arguments

Required Options

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdownload

Download data set, job spool, and USS file content

zowezos-ftpdownloadall-spool-by-jobid

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdownloaddata-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdownloaduss-file

Download the contents of a USS file to a local file

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftplist

List data sets, data set members, uss files, jobs, spool files

zowezos-ftplistdata-set

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistdata-set-members

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistjobs

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

Usage

zowe zos-ftp list jobs [options]

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistspool-files-by-jobid

Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID.

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistuss-files

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

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpmake

Make a USS directory

zowezos-ftpmakeuss-directory

Make a Unix System Services Directory

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftprename

Rename data sets and USS files or directories

zowezos-ftprenamedata-set

Rename a cataloged data set

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftprenameuss-file

Rename a USS file or directory

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpsubmit

Submit jobs from local files and data sets

zowezos-ftpsubmitdata-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpsubmitlocal-file

Submit a job from a local file containing JCL

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpsubmitstdin

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

Usage

zowe zos-ftp submit stdin [options]

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpupload

Upload data set and USS content

zowezos-ftpuploadfile-to-data-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpuploadfile-to-uss-file

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpuploadstdin-to-data-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpuploadstdin-to-uss-file

Upload from stdin to a Unix System Services File

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpview

View data sets, job output, and USS content

zowezos-ftpviewall-spool-by-jobid

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpviewdata-set

View the contents of a z/OS data set

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpviewjob-status-by-jobid

View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID.

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpviewspool-file-by-id

View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID.

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpviewuss-file

View the contents of a Unix System Services File

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples


zowezos-jobs

Manage z/OS jobs.

zowezos-jobscancel

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

zowezos-jobscanceljob

Cancel a single job by job ID

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsdelete

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

zowezos-jobsdeletejob

Delete a single job by job ID

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsdeleteold-jobs

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

Usage

zowe zos-jobs delete old-jobs [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsdownload

Download the output of a job as separate files.

zowezos-jobsdownloadoutput

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobslist

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

zowezos-jobslistjobs

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

Usage

zowe zos-jobs list jobs [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobslistspool-files-by-jobid

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

Usage

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

Positional Arguments

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobssubmit

Submit a job (JCL).

zowezos-jobssubmitdata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobssubmitlocal-file

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobssubmitstdin

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

Usage

zowe zos-jobs submit stdin [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobssubmituss-file

Submit a job (JCL) contained in a USS file. The command does not pre-validate the USS file path. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.

Usage

zowe zos-jobs submit uss-file <file> [options]

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobsview

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

zowezos-jobsviewall-spool-content

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

Usage

zowe zos-jobs view all-spool-content <jobid> [options]

Positional Arguments

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsviewjob-status-by-jobid

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

Usage

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

Positional Arguments

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobsviewspool-file-by-id

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

Usage

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

Positional Arguments

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

Usage

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

Positional Arguments

Options

z/OS Ssh Connection Options

Profile Options

Base Connection Options

Examples


zowezos-tso

Issue TSO commands and interact with TSO address spaces.

zowezos-tsoissue

Issue TSO commands.

zowezos-tsoissuecommand

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

Usage

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

Positional Arguments

Options

TSO ADDRESS SPACE OPTIONS

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-tsoping

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

zowezos-tsopingaddress-space

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

Usage

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

Positional Arguments

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-tsosend

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

zowezos-tsosendaddress-space

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

Usage

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

Positional Arguments

Required Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-tsostart

Start TSO/E address space.

zowezos-tsostartaddress-space

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

Usage

zowe zos-tso start address-space [options]

TSO ADDRESS SPACE OPTIONS

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-tsostop

Stop TSO/E address space.

zowezos-tsostopaddress-space

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

Usage

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

Positional Arguments

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezos-workflows

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

zowezos-workflowsarchive

Archive workflow instance in z/OSMF.

zowezos-workflowsarchiveactive-workflow

Archive an active workflow instance in z/OSMF.

Usage

zowe zos-workflows archive active-workflow [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowscreate

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

zowezos-workflowscreateworkflow-from-data-set

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

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowscreateworkflow-from-local-file

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

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowscreateworkflow-from-uss-file

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

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowsdelete

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

zowezos-workflowsdeleteactive-workflow

Delete an active workflow instance in z/OSMF

Usage

zowe zos-workflows delete active-workflow [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowsdeletearchived-workflow

Delete an archived workflow from z/OSMF

Usage

zowe zos-workflows delete archived-workflow [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowslist

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

zowezos-workflowslistactive-workflow-details

Get the details of an active z/OSMF workflow

Usage

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

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowslistactive-workflows

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

Usage

zowe zos-workflows list active-workflows [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowslistarchived-workflows

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

Usage

zowe zos-workflows list archived-workflows [options]

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

zowezos-workflowslistdefinition-file-details

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowsstart

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

zowezos-workflowsstartworkflow-full

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

Usage

zowe zos-workflows start workflow-full [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowsstartworkflow-step

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezosmf

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

zowezosmfcheck

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

zowezosmfcheckstatus

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

Usage

zowe zosmf check status [options]

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezosmflist

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

zowezosmflistsystems

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

Usage

zowe zosmf list systems [options]

Zosmf Connection Options

Profile Options

Base Connection Options

Examples