zowe

Welcome to Zowe CLI!

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

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

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

Options

Global Options


zoweauth

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

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

zoweauthlogin

Log in to an authentication service.

zoweauthloginapiml

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

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

Usage

zowe auth login apiml [options]

Options

Base Connection Options

Profile Options

Examples

zoweauthlogout

Log out of an authentication service.

zoweauthlogoutapiml

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

Usage

zowe auth logout apiml [options]

Base Connection Options

Profile Options

Examples


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

zoweconfigreport-env

Reports key items from your environment and identifies problem conditions

Usage

zowe config report-env [options]

Examples

zoweconfigschema

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

Usage

zowe config schema [options]

Examples

zoweconfigsecure

prompt for secure configuration properties

Usage

zowe config secure [options]

Options

Examples

zoweconfigset

create or update a configuration property

Usage

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

Positional Arguments

Options

Examples

zoweconfigupdate-schemas

Update schema files by looking up the directory structure.

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

Usage

zowe config update-schemas [options]

Options

Examples


zowedaemon

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

zowedaemondisable

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


zowedbm-db2

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

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

zowedbm-db2check

Perform DDL syntax checking.

zowedbm-db2checkddl

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

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

Usage

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

Positional Arguments

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2compare

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

zowedbm-db2compareddl

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

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

Usage

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

Positional Arguments

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2deploy

Deploy DDL statements to a Db2 subsystem.

zowedbm-db2deployddl

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

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

Usage

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

Positional Arguments

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2execute

Execute a script to implement Db2 object changes.

zowedbm-db2executecompare-script

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

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

Usage

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

Positional Arguments

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2executemigration-script

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

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

Usage

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

Positional Arguments

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2executescript

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

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

Usage

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

Positional Arguments

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2generate

Generate DDL statements for Db2 objects.

zowedbm-db2generateddl

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

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

Usage

zowe dbm-db2 generate ddl [options]

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples

zowedbm-db2prepare

Prepare DDL statements and a script to migrate Db2 objects.

zowedbm-db2preparemigration

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

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

Usage

zowe dbm-db2 prepare migration [options]

Required Options

Options

Profile Options

DBM-Db2 Connection Options

Base Connection Options

Examples


zoweejes

Welcome to the EJES RESTapi Manager

This plug-in allows you to interact with EJES on the host to emulate EJES Batch under TSO and to query the EJES monitoredspool and host libraries to retreive tabular and report information

zoweejesapi

Make requests with the (E)JES REST API to the (E)JES API using options that correspond to object models in the (E)JES REST API swagger documentation. You should refer to that document, refer to chapter 10 of the (E)JES Reference, and issue "zowe ejes api init --helpApp" further details.

All responses are returned in JSON format by using the --rfj (--response-format-json) option.

The tools necessary manage the spool with (E)JES are provided. You will be able to download sysout, email it as PDF, and submit jobs from MVS and the local workstation. All downloads are saved to a file in the current working directory, or to the path specified on the EJES_DOWNLOAD_PATH environment variable.

The CLI generates exit codes. 0 indicates the transaction completed, but you should check the output for (E)JES errors. A non-zero exit code below 100 indicates a problem coding an options or a download file filesystem issue. An exit code above 100 is a response code from the host through the API. If use the host host "return" command in the --command option, you will receive a 500 exit code. Use a stateless init request or issue a term request to avoid this result.

This CLI was developed to provide an easy scripting option to avoid coding directly to the REST API. However, it can be used to experiment with the REST API. The --debug option will return the host requests and responses as objects and properties in JSON.

zoweejesapicancel-download

Cancels a streaming download of PDF or Text data. A download is initiated via the -d option on an Exec request. Refer to the (E)JES REST API swagger documentation for details on mapped options.

For a command group overview, issue: zowe ejes api -h

Usage

zowe ejes api cancel-download [options]

Query Item Options

EJES Connection Options

Profile Options

Examples

zoweejesapiexec

Executes an API command in an existing (stateful) or new transient (stateless) session.

Returns items as requested by the query parameters. An existing session is used when a valid cookie is used as an argument on the --cookie option. This is the preferred scenario when multiple transactions are expected since it provides significant performance benefits. It requires server affinity for sessions in a clustered server environment.

A new transient session will be created if a --authorization or --user option is provided and a --cookie option is not. A transient session exists only for the current transaction and meets the goal of statelessness as defined by ROA and REST. However, it is much less efficient than using an existing session across multiple transactions, and does not preserve the state of the underlying (E)JES API. Nevertheless, it is the prefered scenario where a single transaction and statelessness suffice.

See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell. Options flagged with "initParms model" are valid only for stateless transactions on the exec command.

For a command group overview, issue: zowe ejes api -h

Usage

zowe ejes api exec [options]

Query Item Options

Init Request Options

Exec Request Options

PDF and TEXT Common Options

PDF Download Options

PDF Security Property Options

Mail Options

Platform-encoding Options

Debug Visualization Options

EJES Connection Options

Profile Options

Examples

Example:

  * `$  zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddata "//IEFBR14  JOB IEFBR14,'IEFBR14',CLASS=A,MSGCLASS=H\n//EXEC     EXEC PGM=IEFBR14\n//"`

Example:

  * `$  zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddatafile "iefbr14.jcl"`

Example:

  * `$  zowe ejes api exec -d text --cc interpret --cookie "EJESWEB_54761=B6910D...;path=/EjesWeb;Secure;HttpOnly"`

zoweejesapiinit

Creates an API session and optionally issues an API command. Returns items as requested by the -q and -c options. A Set-Cookie header is included in the response. The value of the returned cookie identifies the session and should be supplied as an argument on the --cookie option on subsequent API data, exec, and term requests. Cookies can be managed for you. See the --cookie option for details. Close the session with an API term request when it is no longer needed to free up system resources. Sessions that are idle for more than two minutes will be automatically closed. See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell.

For a command group overview, issue: zowe ejes api -h

Usage

zowe ejes api init [options]

Query Item Options

Init Request Options

Exec Request Options

Platform-encoding Options

Debug Visualization Options

EJES Connection Options

Profile Options

Examples

zoweejesapiterm

Terminates the API session.

For a command group overview, issue: zowe ejes api -h

Usage

zowe ejes api term [options]

EJES Connection Options

Profile Options

Examples

Example:

  * `$  zowe ejes api term --cookie "EJESWEB_54761=0F6E5A...;path=/EjesWeb;Secure;HttpOnly"`

zoweejesbatch

The (E)JES batch interface provides much of the power of the on-line environment to automated programs or scripts.

Using the batch interface, procedures may be created that issue commands or alter other resources based upon the condition of jobs in the JESplex and the contents of spool information (e.g., reports, condition codes, JES messages) produced by those jobs. System housekeeping functions containing (E)JES batch procedures may be submitted at scheduled times, on demand, or when certain system conditions are met. Practically any function that requires access to spool or other (E)JES-provided information can be automated.

zoweejesbatchactivity

Display jobs in all active address spaces for the JESplex or sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch activity [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchapfds

Display APF-authorized libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch apfds [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchclass

Display job classes defined for the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch class [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchcmdstack

Issues a starting command stack. It connects to the host and allows you to use an enhanced set of EJES BATCH commands.

Usage

zowe ejes batch cmdstack <parameter-list> [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchcommand

Display the long command processor, then enter the EJES Batch Shell.

Usage

zowe ejes batch command [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchdjc

Display a table of Dependent Job Control networks in the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch djc [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchdynexit

Display a table of MVS dynamic exits defined within the current sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch dynexit [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchenclave

Display a table of WLM enclaves defined within the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch enclave [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchenq

Display a table of information about ENQs and RESERVEs in the sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch enq [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchenqc

Display a table of information about ENQ contention in the sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch enqc [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchenqd

Display a table of information about ENQ SYSDSN resources in the sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch enqd [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchentry

Display the (E)JES entry panel, then enter the EJES Batch Shell.

Usage

zowe ejes batch entry [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchfss

Display a table of Functional Subsystems defined for the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch fss [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchgroup

Display a table of Generalized Main Scheduler parameters for job class groups in the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch group [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchhcheck

Display a table of the about checks registered with IBM Health Checker for z/OS, then enter the EJES Batch Shell.

Usage

zowe ejes batch hcheck [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchhold

Display a table of the sysout in the Hold queue, then enter the EJES Batch Shell.

Usage

zowe ejes batch hold [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchinit

Display a table of JES2-managed batch initiators defined for the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch init [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchinput

Display a table of all jobs in the JESplex that are in pre-execution and execution status, then enter the EJES Batch Shell.

Usage

zowe ejes batch input [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchjesplex

Display a table of JES images in your z/OS JESplex, then enter the EJES Batch Shell. A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex.

Usage

zowe ejes batch jesplex [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchjgroup

Display a table of the active job groups in the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch jgroup [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchline

Display a table of the lines that connect NJE nodes to your JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch line [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchlnklst

Display a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch lnklst [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchlog

Display the log, then enter the EJES Batch Shell. You may optionally specify operlog or syslog, or command stack 'logattr on' to see the operlog display in MCS Console colors.

Usage

zowe ejes batch log [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchlpalst

Display a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch lpalst [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchmds

Display a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues, then enter the EJES Batch Shell.

Usage

zowe ejes batch mds [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchmemusage

Display a table of real and virtual memory requirements of jobs and other tasks running within your sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch memusage [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchmenu

Display or control the (E)JES menu, then enter the EJES Batch Shell.

Usage

zowe ejes batch menu [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchmounts

Display a table of mounted file systems within the sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch mounts [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchnetconn

Display a table of NJE (Network Job Entry) connection, then enter the EJES Batch Shell.

Usage

zowe ejes batch netconn [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchnetserv

Display a table of NJE network servers, then enter the EJES Batch Shell.

Usage

zowe ejes batch netserv [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchnje

Display a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues, then enter the EJES Batch Shell.

Usage

zowe ejes batch nje [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchnode

Display a table of the NJE nodes defined to the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch node [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchnop

Start or resume a session with no operation. Most useful in conjunction with --resume.

Usage

zowe ejes batch nop [options]

Options

EJES Connection Options

Profile Options

zoweejesbatchoffload

Display a table of the JES2 spool offload devices in your JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch offload [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchOutput

Display a table of sysout in the JES2 Output queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

Usage

zowe ejes batch Output [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchpageds

Display a table of paging resources defined to the systems in your sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch pageds [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchparmlib

Display a table of information about system parameter libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch parmlib [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchprinter

Display a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch printer [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchproclib

Display a table of information about your JES proclib concatenations, then enter the EJES Batch Shell.

Usage

zowe ejes batch proclib [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchpstatus

Display a table of z/OS UNIX processes running in the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch pstatus [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchquery

Display displays or primary commands your credentials authorize, then enter the EJES Batch Shell. The positional operand is required and may be 'auth' or 'auth display'.

Usage

zowe ejes batch query <parameter-list> [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchresmon

Display a table of JES resources for the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch resmon [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchresource

Display a table of the WLM Resources defined for the current sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch resource [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchschenv

Display a table of the WLM Scheduling Environments defined for the current sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch schenv [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchsession

Display a table of all active (E)JES sessions, then enter the EJES Batch Shell.

Usage

zowe ejes batch session [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchshell

Starts the EJES Batch Shell without logging on. It allows you to connect to the host and use an enhanced set of EJES BATCH commands.

Usage

zowe ejes batch shell [options]

Options

EJES Connection Options

Profile Options

zoweejesbatchspart

Display a table of the SPOOL partition configuration of your JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch spart [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchspvol

Display a table of the SPOOL volume extent configuration of your JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch spvol [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchstatus

Display jobs in the JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch status [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchsubsys

Display a table of all the MVS subsystems defined to the systems in your sysplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch subsys [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchsymbol

Display a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space, then enter the EJES Batch Shell.

Usage

zowe ejes batch symbol [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchsyscls

Display a table of the sysout class configuration for your JESplex, then enter the EJES Batch Shell.

Usage

zowe ejes batch syscls [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchsysplex

Display a table of the connected system images in your z/OS sysplex, then enter the EJES Batch Shell. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).

Usage

zowe ejes batch sysplex [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchsysreq

Display a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF), then enter the EJES Batch Shell. Outstanding replies and action messages for the entire sysplex are shown.

Usage

zowe ejes batch sysreq [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchulog

Display the user log console browser, then enter the EJES Batch Shell. The optional parameter allows you to specify a console name other than that which would normally be chosen automatically. Please refer to the CONSOLE command documentation for considerations when specifying a console name.

Usage

zowe ejes batch ulog [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchwriter

Display a table of sysout in the JES3 Writer queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

Usage

zowe ejes batch writer [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesbatchzero

Display a table of sysout data sets created by JES3 internal facilities, then enter the EJES Batch Shell.

Usage

zowe ejes batch zero [parameter-list] [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

zoweejesissue

Issue a system command by sending the positional parameters to the host. (E)JES will respond with output sent to your user log.

zoweejesissuesubmit

Submit a job from the local host with the local: prefix, or a MVS data set or z/OS UNIX path. Responds with submission messages and a table providing a description of a successful submission.

Usage

zowe ejes issue submit <command> [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

Examples

zoweejesissuesyscmd

Issue a system command and receive console output as a report in text format.

Usage

zowe ejes issue syscmd <command> [options]

Positional Arguments

Options

EJES Connection Options

Profile Options

Examples

zoweejeslog

Output the tail end of the host log to stdout, optionally streaming new records. Positioning, searching, and limiting options are supported, including specifying which log type and what system.

zoweejeslogstream

Outputs the operations log or system log to stdout. Behaves like a Linux tail function with support for standard tail options --follow (-f), --lines (-n), -q, -v, and --version.

  Set the position in the log to begin output using \-\-find, \-\-line, \-\-time, and \-\-offset\.  

  Use OPERLOG Message Filtering Options to create a windowed log by filtering for and outputting only lines that fit criteria, e\.g\., fetch only lines associated with an IAT6xxxx message by specifying: \-\-msgId "IAT6\*"\.  After filtering the log, output is positioned at the bottom\.  Use position options to change that\.

  Turn on highlighting for \-\-find using \-\-hilite\.  Perform regex text matching with highlighting using \-\-match\.  Enable MCS console color emulation with \-\-mcs\.  To prevent ANSI escape characters from being output and to instead use accessibility\-friendly text\-only indicators, specify: \-\-nocolor "on"\.

  The order of host commands issued during initialization are fixed in this program in this order:

1. All OPERLOG message filtering options, e.g., --msgId and --msgTxt

2. --line

3. --time

4. --find

5. --offset

  Conceptually and depending on specified options, the program can create a window into the log data using message filtering options, then can point to a line in the data such as the first line, then can position at a time, then find arbitrary text, then offset the view up and down by seconds to days or a number of lines\.

  The program outputs trailer diagnostic lines at the end of the run to stderr\.  Use this information to make your queries more efficient\.  The trailer and header lines can be muted using the \-\-quiet (\-q) option or setting the EJES\_LOG\_CLI\_QUIET environment variable\.  The program outputs a bottom\-of\-data line to stdout that is considered an output line by \-\-lines with a line\-count argument\.  To disable it, set the EJES\_LOG\_CLI\_NO\_BOTTOM environment variable\.

Usage

zowe ejes log stream [log-type] [options]

Positional Arguments

Options

ANSI Color Options

Find String and Position Options

Positioning Options

Positioning Offset Options

OPERLOG Message Filtering Options

Log Options

JES-type Options

EJES Connection Options

EJES CLI Runtime Options

Profile Options

Examples

zoweejesquery

Query the host using (E)JES. Return host spool, dataset, and library tables. Return browsable data as reports. Query commands specify which primary table to query. Each primary table may also have child tables or child reports you can query using the --table and/or --report options. You can access only those primary tables you are authorized to use. Issue these commands as an introduction: (1) "zowe ejes query list" to show available tables.(2) "zowe ejes query status --owner help" to demonstrate how to find how it all works. (3) "zowe ejes query status --owner list" to demonstrate how to find appropriate arguments. (4) "zowe ejes query status --owner myuserid --sort time d" to view a sorted table of your jobs.(5) "zowe ejes query status --owner myuserid --sort time d --report " to view the first job in report form (truncated to your screen).

zoweejesqueryactivity

Select a table of all the jobs in all active address spaces for the JESplex or sysplex.

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query activity [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query activity --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query activity --metafilter help`

zoweejesqueryapfds

Select a table of APF-authorized libraries defined to the systems in your sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query apfds [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query apfds --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query apfds --metafilter help`

zoweejesqueryclass

Select table of job classes defined for the JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query class [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query class --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query class --metafilter help`

zoweejesquerydjc

Select a table of Dependent Job Control networks in the JESplex.

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query djc [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query djc --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query djc --metafilter help`

zoweejesquerydynexit

Select a table of MVS dynamic exits defined within the current sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query dynexit [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query dynexit --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query dynexit --metafilter help`

zoweejesqueryenclave

Select a table of WLM enclaves defined within the JESplex.

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query enclave [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query enclave --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query enclave --metafilter help`

zoweejesqueryenq

Select a table of information about ENQs and RESERVEs in the sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query enq [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query enq --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query enq --metafilter help`

zoweejesqueryenqc

Select a table of information about ENQ contention in the sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query enqc [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query enqc --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query enqc --metafilter help`

zoweejesqueryenqd

Select a table of information about ENQ SYSDSN resources in the sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query enqd [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query enqd --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query enqd --metafilter help`

zoweejesqueryfss

Select a table of Functional Subsystems defined for the JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query fss [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query fss --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query fss --metafilter help`

zoweejesquerygroup

Select a table of Generalized Main Scheduler parameters for job class groups in the JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query group [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query group --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query group --metafilter help`

zoweejesqueryhcheck

Select a table of the about checks registered with IBM Health Checker for z/OS.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query hcheck [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

zoweejesqueryhold

Select a table of the sysout in the Hold queue.

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query hold [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query hold --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query hold --metafilter help`

zoweejesqueryinit

Select a table of JES2-managed batch initiators defined for the JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query init [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query init --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query init --metafilter help`

zoweejesqueryinput

Select a table of all jobs in the JESplex that are in pre-execution and execution status.

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query input [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query input --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query input --metafilter help`

zoweejesqueryjesplex

Select a table of JES images in your z/OS JESplex.

A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex. Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query jesplex [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query jesplex --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query jesplex --metafilter help`

zoweejesqueryjgroup

Select a table of the active job groups in the JESplex.

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query jgroup [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query jgroup --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query jgroup --metafilter help`

zoweejesqueryline

Select a table of the lines that connect NJE nodes to your JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query line [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query line --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query line --metafilter help`

zoweejesquerylist

Display a list of all the primary display tables you are authorized to query on the host.

Usage

zowe ejes query list [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

zoweejesquerylnklst

Select a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query lnklst [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query lnklst --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query lnklst --metafilter help`

zoweejesquerylpalst

Select a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query lpalst [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query lpalst --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query lpalst --metafilter help`

zoweejesquerymds

Select a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues.

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query mds [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query mds --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query mds --metafilter help`

zoweejesquerymemusage

Select a table of real and virtual memory requirements of jobs and other tasks running within your sysplex.

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query memusage [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query memusage --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query memusage --metafilter help`

zoweejesquerymounts

Select a table of mounted file systems within the sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query mounts [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query mounts --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query mounts --metafilter help`

zoweejesquerynetconn

Select a table of NJE (Network Job Entry) connections.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query netconn [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query netconn --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query netconn --metafilter help`

zoweejesquerynetserv

Select a table of NJE network servers.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query netserv [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query netserv --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query netserv --metafilter help`

zoweejesquerynje

Select a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues.

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query nje [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query nje --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query nje --metafilter help`

zoweejesquerynode

Select a table of the NJE nodes defined to the JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query node [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query node --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query node --metafilter help`

zoweejesqueryoffload

Select a table of the JES2 spool offload devices in your JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query offload [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query offload --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query offload --metafilter help`

zoweejesquerypageds

Select a table of paging resources defined to the systems in your sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query pageds [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query pageds --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query pageds --metafilter help`

zoweejesqueryparmlib

Select a table of information about system parameter libraries defined to the systems in your sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query parmlib [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query parmlib --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query parmlib --metafilter help`

zoweejesqueryprinter

Select a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query printer [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query printer --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query printer --metafilter help`

zoweejesqueryproclib

Select a table of information about your JES proclib concatenations.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query proclib [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query proclib --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query proclib --metafilter help`

zoweejesquerypstatus

Select a table of z/OS UNIX processes running in the JESplex.

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query pstatus [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query pstatus --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query pstatus --metafilter help`

zoweejesqueryresmon

Select a table of JES resources for the JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query resmon [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query resmon --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query resmon --metafilter help`

zoweejesqueryresource

Select a table of the WLM Resources defined for the current sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query resource [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query resource --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query resource --metafilter help`

zoweejesqueryschenv

Select a table of the WLM Scheduling Environments defined for the current sysplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query schenv [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query schenv --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query schenv --metafilter help`

zoweejesquerysession

Select a table of all active (E)JES sessions.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query session [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query session --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query session --metafilter help`

zoweejesqueryspart

Select a table of the SPOOL partition configuration of your JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query spart [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query spart --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query spart --metafilter help`

zoweejesqueryspvol

Select a table of the SPOOL volume extent configuration of your JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query spvol [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query spvol --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query spvol --metafilter help`

zoweejesquerystatus

Select a table of all jobs in the JESplex.

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query status [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query status --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query status --metafilter help`

zoweejesquerysubsys

Select a table of all the MVS subsystems defined to the systems in your sysplex.

Use Primary Selection options to modify which rows are included in a table (for example, --sysnames sys* includes only systems starting with "sys"). Use General Use options to narrow your selected rows further. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query subsys [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A descriptive table for that option will be displayed and any other work will stop. The table may display available columns or positional input fields depending on the option.

Example:

  * `$  zowe ejes query subsys --select list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query subsys --metafilter help`

zoweejesquerysymbol

Select a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query symbol [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query symbol --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query symbol --metafilter help`

zoweejesquerysyscls

Select a table of the sysout class configuration for your JESplex.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query syscls [options]

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query syscls --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query syscls --metafilter help`

zoweejesquerysysplex

Select a table of the connected system images in your z/OS sysplex. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query sysplex [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query sysplex --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query sysplex --metafilter help`

zoweejesquerysysreq

Select a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF). Outstanding replies and action messages for the entire sysplex are shown.

Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query sysreq [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other wor`k will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query sysreq --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query sysreq --metafilter help`

zoweejesquerywriter

Select a table of sysout in the Output queue (JES2) or Writer queue (JES3). The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.

Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query writer [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query writer --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query writer --metafilter help`

zoweejesqueryzero

Select a table of sysout data sets created by JES3 internal facilities.

Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.

Usage

zowe ejes query zero [parameter-list] [options]

Positional Arguments

EJES Connection Options

General Use Options

General Primary Selection Options

Query options

Command Processing Options

Job Submission Options

Debug and Test Options

Advanced Use Primary Selection Options

Advanced Use Options

Options

Profile Options

Examples

The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.

Example:

  * `$  zowe ejes query zero --table list`

The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.

Example:

  * `$  zowe ejes query zero --metafilter help`

zoweendevor

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

zoweendevoradd

Add an Element into Endevor.

zoweendevoraddelement

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

Usage

zowe endevor add element <element> [options]

Positional Arguments

endevor-location definition options

input sources options

options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorapprove

Approve a Package in Endevor.

zoweendevorapprovepackage

The approve package command approves Package in Endevor for execution.

Usage

zowe endevor approve package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorbackin

Backin a Package in Endevor.

zoweendevorbackinpackage

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

Usage

zowe endevor backin package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorbackout

Backout a Package in Endevor.

zoweendevorbackoutpackage

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

Usage

zowe endevor backout package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorcast

Cast a Package in Endevor.

zoweendevorcastpackage

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

Usage

zowe endevor cast package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorcheck

Endevor Web Services Health Check.

zoweendevorcheckinstance

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

Usage

zowe endevor check instance [instance] [options]

Positional Arguments

endevor session definition options

endevor-location definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorcommit

Commit a Package in Endevor.

zoweendevorcommitpackage

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

Usage

zowe endevor commit package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorconfirm

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

zoweendevorconfirmresolution

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

Usage

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

Positional Arguments

Profile Options

Base Connection Options

Examples

zoweendevorcreate

Create a Package in Endevor.

zoweendevorcreatepackage

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

Usage

zowe endevor create package [package] [options]

Positional Arguments

input sources options

options

endevor-location definition options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevordelete

Delete an Element or a Package in Endevor.

zoweendevordeleteelement

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

Usage

zowe endevor delete element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevordeletepackage

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

Usage

zowe endevor delete package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevordeny

Deny a Package in Endevor.

zoweendevordenypackage

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

Usage

zowe endevor deny package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorexecute

Execute a Package in Endevor.

zoweendevorexecutepackage

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

Usage

zowe endevor execute package [package] [options]

Positional Arguments

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorgenerate

Generate an Element in Endevor.

zoweendevorgenerateelement

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

Usage

zowe endevor generate element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorinitialize

Initialize a directory as an Endevor workspace.

zoweendevorinitializeworkspace

Initialize current directory as an Endevor workspace.

Usage

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

Positional Arguments

Profile Options

Base Connection Options

Examples

zoweendevorlist

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

zoweendevorlistcode-page-config

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

Usage

zowe endevor list code-page-config [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistdefaults

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

Usage

zowe endevor list defaults [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistdialog

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

Usage

zowe endevor list dialog [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistelements

The list elements command lists element information in Endevor

Usage

zowe endevor list elements [element] [options]

Positional Arguments

endevor-location definition options

options

endevor search text options

scl generation options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistenvironments

The list environments command lists environments in Endevor

Usage

zowe endevor list environments [environment] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistfeatures

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

Usage

zowe endevor list features [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistinstances

The list instances command lists instances used by Endevor Web Services

Usage

zowe endevor list instances [options]

endevor session definition options

output customization options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistpackages

The list packages command lists package information in Endevor

Usage

zowe endevor list packages [package] [options]

Positional Arguments

options

endevor-location definition options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistprocessor-groups

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

Usage

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

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistprocessor-symbols

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

Usage

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

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorliststages

The list stages command lists stages in Endevor

Usage

zowe endevor list stages [stage] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistsubsystems

The list subsystems command lists subsystem information in Endevor

Usage

zowe endevor list subsystems [subsystem] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistsymbols

List the Endevor site symbols

Usage

zowe endevor list symbols [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlistsystems

The list systems command lists system information in Endevor

Usage

zowe endevor list systems [system] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlisttasks

List asynchronous tasks submitted by this user

Usage

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

Positional Arguments

asynchronous task options

endevor session definition options

endevor-location definition options

output customization options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlisttype-sequence

List the contents of the Endevor type sequence

Usage

zowe endevor list type-sequence [options]

endevor session definition options

endevor-location definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorlisttypes

The list types command lists type information in Endevor

Usage

zowe endevor list types [type] [options]

Positional Arguments

endevor-location definition options

options

endevor session definition options

output customization options

asynchronous task options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevormerge

Merge Endevor elements from one Endevor location into another

zoweendevormergeelement

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

Usage

zowe endevor merge element [element] [options]

Positional Arguments

endevor-location definition options

merge-location definition options

workspace options

options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevormove

Move an Element in Endevor.

zoweendevormoveelement

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

Usage

zowe endevor move element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorprint

Print an Element or a Component in Endevor.

zoweendevorprintcomponents

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

Usage

zowe endevor print components <element> [options]

Positional Arguments

endevor-location definition options

options

output customization options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorprintelement

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

Usage

zowe endevor print element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

output customization options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorprintmember

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

Usage

zowe endevor print member <member> [options]

Positional Arguments

input sources options

options

asynchronous task options

output customization options

endevor session definition options

endevor-location definition options

Profile Options

Base Connection Options

Examples

zoweendevorqueryacm

Query Elements and information about their components in Endevor.

zoweendevorqueryacmcomponents

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

Usage

zowe endevor queryacm components <element> [options]

Positional Arguments

endevor-location definition options

options

output customization options

asynchronous task options

endevor session definition options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorreset

Reset a Package in Endevor.

zoweendevorresetpackage

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

Usage

zowe endevor reset package [package] [options]

Positional Arguments

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorretrieve

Retrieve an Element in Endevor.

zoweendevorretrieveelement

The retrieve element command retrieves an existing element in Endevor.

Usage

zowe endevor retrieve element <element> [options]

Positional Arguments

endevor-location definition options

options

output location options

output customization options

bulk action options

endevor session definition options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorretrieveresult

Retrieve the result of an asynchronous task

Usage

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

Positional Arguments

endevor session definition options

endevor-location definition options

output customization options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweendevorsignin

Signin an Element in Endevor.

zoweendevorsigninelement

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

Usage

zowe endevor signin element <element> [options]

Positional Arguments

endevor-location definition options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorsubmit

Submit a Package or a SCL file in Endevor.

zoweendevorsubmitpackage

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

Usage

zowe endevor submit package [package] [options]

Positional Arguments

input sources options

output location options

options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorsubmitscl

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

Usage

zowe endevor submit scl [options]

options

input sources options

endevor-location definition options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorsynchronize

Synchronize remote Endevor inventory with the local Endevor workspace.

zoweendevorsynchronizeworkspace

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

Usage

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

Positional Arguments

endevor-location definition options

options

workspace options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevortransfer

Transfer an Element in Endevor.

zoweendevortransferelement

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

Usage

zowe endevor transfer element <element> [options]

Positional Arguments

endevor-location definition options

output location options

options

asynchronous task options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorunsynchronize

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

zoweendevorunsynchronizeworkspace

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

Usage

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

Positional Arguments

endevor-location definition options

workspace options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorupdate

Update an Element or a Package in Endevor.

zoweendevorupdateelement

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

Usage

zowe endevor update element <element> [options]

Positional Arguments

input sources options

endevor-location definition options

options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorupdatepackage

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

Usage

zowe endevor update package [package] [options]

Positional Arguments

input sources options

options

endevor-location definition options

endevor session definition options

output customization options

Profile Options

Base Connection Options

Examples

zoweendevorview

View an Element or a Package SCL in Endevor.

zoweendevorviewelement

The view element command views an existing element in Endevor.

Usage

zowe endevor view element <element> [options]

Positional Arguments

endevor-location definition options

options

output customization options

asynchronous task options

endevor session definition options

Profile Options

Base Connection Options

Examples

zoweendevorviewpkgscl

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

Usage

zowe endevor view pkgscl [package] [options]

Positional Arguments

endevor-location definition options

output customization options

endevor session definition options

Profile Options

Base Connection Options

Examples


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-gitlocal-hook-token

Manage the token you use for secure communication with BridgeForGit when using the local hook validation.

zoweendevor-bridge-for-gitlocal-hook-tokengenerate

Generate a new local hook token for Endevor Bridge for Git.

Usage

zowe endevor-bridge-for-git local-hook-token generate [options]

Options

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitlocal-hook-tokenlist

List your local hook token.

Usage

zowe endevor-bridge-for-git local-hook-token list [options]

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

Profile Options

Base Connection Options

Examples

zoweendevor-bridge-for-gitlocal-hook-tokenrevoke

Revoke your local hook token.

Usage

zowe endevor-bridge-for-git local-hook-token revoke [options]

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


zoweidms

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

zoweidmsissue

Issues IDMS DCMT and DCUF commands

zoweidmsissuedcmt-display

Execute a DCMT DISPLAY command

Usage

zowe idms issue dcmt-display [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-help

Execute a DCMT HELP command

Usage

zowe idms issue dcmt-help [options]

IDMS Connection Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-quiesce

Execute a DCMT QUIESCE command

Usage

zowe idms issue dcmt-quiesce [options]

IDMS Connection Options

Required Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-shutdown

Execute a DCMT SHUTDOWN command

Usage

zowe idms issue dcmt-shutdown [options]

IDMS Connection Options

Required Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-statistics

Execute a DCMT STATISTICS command

Usage

zowe idms issue dcmt-statistics [options]

IDMS Connection Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-test

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

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

Usage

zowe idms issue dcmt-test [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcmt-vary

Execute a DCMT VARY command

Usage

zowe idms issue dcmt-vary [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcuf-help

Execute a DCUF HELP command

Usage

zowe idms issue dcuf-help [options]

IDMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmsissuedcuf-show

Execute a DCUF SHOW command

Usage

zowe idms issue dcuf-show [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslist

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

zoweidmslistdatasources

Lists data sources defined to the IDMS REST API

Usage

zowe idms list datasources [options]

IDMS Connection Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslistlog

Lists log messages based on the search options provided

Usage

zowe idms list log [options]

IDMS Connection Options

Required Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslistsystems

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

Usage

zowe idms list systems [options]

IDMS Connection Options

Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslisttransactions

Lists transaction details on a specific IDMS system

Usage

zowe idms list transactions [options]

IDMS Connection Options

Required Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweidmslistuser-tasks

Lists all active user tasks on a specific IDMS system

Usage

zowe idms list user-tasks [options]

IDMS Connection Options

Required Options

Profile Options

Base Connection Options

Response Format Options

Examples


zoweims

Interact with IBM IMS programs and transactions.

zoweimsquery

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

zoweimsqueryprogram

Query an IMS application program.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsqueryregion

Query an IMS region.

Usage

zowe ims query region [options]

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsquerytransaction

Query an IMS transaction.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstart

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

zoweimsstartprogram

Start an IMS application program.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstartregion

Start an IMS region.

Usage

zowe ims start region [memberName] [options]

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstarttransaction

Start an IMS transaction.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstop

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

zoweimsstopprogram

Stop an IMS application program.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstopregion

Stop an IMS region.

Usage

zowe ims stop region [options]

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsstoptransaction

Stop an IMS transaction.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsupdate

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

zoweimsupdateprogram

Update an IMS application program.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zoweimsupdatetransaction

Update an IMS transaction.

Usage

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

Positional Arguments

Options

IMS Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples


zowejclcheck

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

zowejclcheckcheck

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

zowejclcheckcheckdata-set

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

Usage

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

Positional Arguments

Options

JCLCheck Connection Options

Profile Options

Base Connection Options

Examples

zowejclcheckchecklocal-file

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

Usage

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

Positional Arguments

Options

JCLCheck Connection Options

Profile Options

Base Connection Options

Examples


zowemat

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

zowematmonitor

Get monitor history and measurement analysis data from MAT.

zowematmonitorcodeview

Get the CodeView measurement details.

zowematmonitorcodeviewcallerid

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

Usage

zowe mat monitor codeview callerid [options]

Options

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

zowepluginsshow-first-steps

Show first steps required to set up plugin for use.

Usage

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

Positional Arguments

Examples

zowepluginsuninstall

Uninstall plug-ins.

Usage

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

Positional Arguments

Examples

zowepluginsupdate

Update plug-ins.

Usage

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

Positional Arguments

Options

Examples

zowepluginsvalidate

Validate a plug-in that has been installed.

Usage

zowe plugins validate [plugin] [options]

Positional Arguments

Options

Examples


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

zoweprofilescreatedbm-db2-options-profile

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

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

Usage

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

Positional Arguments

Options

zoweprofilescreatedbm-db2-profile

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

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

Usage

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

Positional Arguments

DBM-Db2 Options

Options

Examples

zoweprofilescreateebg-profile

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the 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

zoweprofilescreateendevor-location-profile

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

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

Usage

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

Positional Arguments

Options

Examples

zoweprofilescreateendevor-profile

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

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

Usage

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

Positional Arguments

Options

Examples

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

zoweprofilescreateidms-profile

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

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

Usage

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

Positional Arguments

IDMS Connection Options

Options

Examples

zoweprofilescreateims-profile

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

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

zoweprofilescreatejclcheck-profile

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

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

Usage

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

Positional Arguments

JCLCheck Connection Options

Options

Examples

zoweprofilescreatejclx-profile

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

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

Usage

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

Positional Arguments

Options

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

zoweprofilescreatesysview-format-profile

The SYSVIEW format profile schema, where you specify display settings

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

Usage

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

Positional Arguments

display options

Options

Examples

zoweprofilescreatesysview-profile

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

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

Usage

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

Positional Arguments

sysview 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

zoweprofilesdeletedbm-db2-options-profile

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

Positional Arguments

Options

Examples

zoweprofilesdeletedbm-db2-profile

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

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

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeleteebg-profile

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

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

zoweprofilesdeleteendevor-location-profile

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

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

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeleteendevor-profile

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

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

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletefmp-profile

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

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

zoweprofilesdeleteidms-profile

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

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

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeleteims-profile

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

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

zoweprofilesdeletejclcheck-profile

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

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

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletejclx-profile

Delete a jclx 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 jclx-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

zoweprofilesdeletesysview-format-profile

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

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

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletesysview-profile

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

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

Usage

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

Positional Arguments

Options

Examples

zoweprofilesdeletetso-profile

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

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

zoweprofileslistdbm-db2-options-profiles

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

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

Usage

zowe profiles list dbm-db2-options-profiles [options]

Options

Examples

zoweprofileslistdbm-db2-profiles

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

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

Usage

zowe profiles list dbm-db2-profiles [options]

Options

Examples

zoweprofileslistebg-profiles

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the 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

zoweprofileslistendevor-location-profiles

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

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

Usage

zowe profiles list endevor-location-profiles [options]

Options

Examples

zoweprofileslistendevor-profiles

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

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

Usage

zowe profiles list endevor-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

zoweprofileslistidms-profiles

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

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

Usage

zowe profiles list idms-profiles [options]

Options

Examples

zoweprofileslistims-profiles

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

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

Usage

zowe profiles list ims-profiles [options]

Options

Examples

zoweprofileslistjclcheck-profiles

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

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

Usage

zowe profiles list jclcheck-profiles [options]

Options

Examples

zoweprofileslistjclx-profiles

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

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

Usage

zowe profiles list jclx-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

zoweprofileslistsysview-format-profiles

The SYSVIEW format profile schema, where you specify display settings

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

Usage

zowe profiles list sysview-format-profiles [options]

Options

Examples

zoweprofileslistsysview-profiles

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

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

Usage

zowe profiles list sysview-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-defaultdbm-db2-options-profile

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

Positional Arguments

Examples

zoweprofilesset-defaultdbm-db2-profile

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

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

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultebg-profile

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

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-defaultendevor-location-profile

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

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

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultendevor-profile

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

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

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultfmp-profile

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

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-defaultidms-profile

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

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

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultims-profile

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

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-defaultjclcheck-profile

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

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

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultjclx-profile

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

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

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

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaultsysview-profile

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

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

Usage

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

Positional Arguments

Examples

zoweprofilesset-defaulttso-profile

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

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

zoweprofilesupdatedbm-db2-options-profile

The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.

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

Usage

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

Positional Arguments

Options

zoweprofilesupdatedbm-db2-profile

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

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

Usage

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

Positional Arguments

DBM-Db2 Options

Examples

zoweprofilesupdateebg-profile

An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the 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)

zoweprofilesupdateendevor-location-profile

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

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

Usage

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

Positional Arguments

Options

zoweprofilesupdateendevor-profile

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

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

Usage

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

Positional Arguments

Options

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

zoweprofilesupdateidms-profile

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

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

Usage

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

Positional Arguments

IDMS Connection Options

Examples

zoweprofilesupdateims-profile

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

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

zoweprofilesupdatejclcheck-profile

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

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

Usage

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

Positional Arguments

JCLCheck Connection Options

zoweprofilesupdatejclx-profile

Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.

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

Usage

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

Positional Arguments

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

zoweprofilesupdatesysview-format-profile

The SYSVIEW format profile schema, where you specify display settings

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

Usage

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

Positional Arguments

display options

Examples

zoweprofilesupdatesysview-profile

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

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

Usage

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

Positional Arguments

sysview connection options

Examples

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


zowesysview

Zowe CLI plugin for SYSVIEW

zowesysviewcapture

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

Usage

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

Positional Arguments

data options

display options

response format options

sysview connection options

Profile Options

Base Connection Options

Examples

zowesysviewcapture-immediate

Submit a capture request2

Usage

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

Positional Arguments

display options

data options

sysview connection options

Profile Options

Base Connection Options

Examples

zowesysviewcheck

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

zowesysviewcheckstatus

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

Usage

zowe sysview check status [options]

sysview connection options

Profile Options

Base Connection Options

Examples

zowesysviewdisplay

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

Usage

zowe sysview display <command-string> [options]

Positional Arguments

data options

display options

response format options

sysview connection options

Profile Options

Base Connection Options

Examples

zowesysviewexecute

Issue a SYSVIEW function command and display any messages

Usage

zowe sysview execute <command-string> [options]

Positional Arguments

display options

data options

sysview connection options

Profile Options

Base Connection Options

Examples


zowezjcl-expert

IBM Z JCL Expert Plug-in for Zowe CLI

zowezjcl-expertlocal

Wraps an SSH call to JCLX on the remote system to validate the specified local file containing JCL.

Usage

zowe zjcl-expert local <filePath> [options]

Positional Arguments

Options

Zosmf Connection Options

z/OS Ssh Connection Options

Profile Options

Base Connection Options

zowezjcl-expertremote-ds

Wraps an SSH call to JCLX on the remote system to validate the specified remote data set.

Usage

zowe zjcl-expert remote-ds <dsn> [options]

Positional Arguments

Options

Zosmf Connection Options

z/OS Ssh Connection Options

Profile Options

Base Connection Options

zowezjcl-expertremote-fs

Wraps an SSH call to JCLX on the remote system to validate the specified remote zFS file.

Usage

zowe zjcl-expert remote-fs <filePath> [options]

Positional Arguments

Options

Zosmf Connection Options

z/OS Ssh Connection Options

Profile Options

Base Connection Options


zowezos-console

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

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

zowezos-consolecollect

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

zowezos-consolecollectsync-responses

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

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

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 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-filescopydata-set-cross-lpar

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreate

Create data sets.

zowezos-filescreatedata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-binary

Create executable data sets

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-c

Create data sets for C code programming

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-classic

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-partitioned

Create partitioned data sets (PDS)

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-sequential

Create physical sequential data sets (PS)

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatedata-set-vsam

Create a VSAM cluster

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreateuss-directory

Create a UNIX directory.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreateuss-file

Create a UNIX file.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filescreatezos-file-system

Create a z/OS file system.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdelete

Delete a data set or Unix System Services file.

zowezos-filesdeletedata-set

Delete a data set or data set member permanently

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdeletedata-set-vsam

Delete a VSAM cluster permanently

Usage

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

Positional Arguments

Options

Required Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdeletemigrated-data-set

Delete migrated data sets.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdeleteuss-file

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

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdeletezos-file-system

Delete a z/OS file system permanently.

Usage

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

Positional Arguments

Required Options

Zosmf Connection Options

Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownload

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

zowezos-filesdownloadall-members

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownloaddata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownloaddata-sets-matching

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownloaduss-directory

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesdownloaduss-file

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesedit

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

zowezos-fileseditdata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesedituss-file

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesinvoke

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

zowezos-filesinvokeams-file

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

Usage

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

Positional Arguments

Zosmf Connection Options

Options

Profile Options

Base Connection Options

Examples

zowezos-filesinvokeams-statements

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

Usage

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

Positional Arguments

Zosmf Connection Options

Options

Profile Options

Base Connection Options

Examples

zowezos-fileslist

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

zowezos-fileslistall-members

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-fileslistdata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-fileslistfile-system

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

Usage

zowe zos-files list file-system [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-fileslistuss-files

List USS files and directories in a UNIX file path

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-filesmigrate

Migrate data sets.

zowezos-filesmigratedata-set

Migrate a data set.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesmount

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

zowezos-filesmountfile-system

Mount a UNIX file system on a specified directory.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesrecall

Recall migrated data sets.

zowezos-filesrecalldata-set

Recall a migrated data set.

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesrename

Rename a data set or member.

zowezos-filesrenamedata-set

Rename a data set.

Usage

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

Positional Arguments

Zosmf Connection Options

Options

Profile Options

Base Connection Options

Examples

zowezos-filesrenamedata-set-member

Rename a data set member.

Usage

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

Positional Arguments

Zosmf Connection Options

Options

Profile Options

Base Connection Options

Examples

zowezos-filesunmount

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

zowezos-filesunmountfile-system

Unmount a UNIX file system.

Usage

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

Positional Arguments

Zosmf Connection Options

Options

Profile Options

Base Connection Options

Examples

zowezos-filesupload

Upload the contents of a file to data sets.

zowezos-filesuploaddir-to-pds

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesuploaddir-to-uss

Upload a local directory to a USS directory.

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

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

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

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesuploadfile-to-data-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesuploadfile-to-uss

Upload content to a USS file from local file

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesuploadstdin-to-data-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesview

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

zowezos-filesviewdata-set

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-filesviewuss-file

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezos-ftp

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

zowezos-ftpallocate

Allocate a sequential or partitioned dataset

zowezos-ftpallocatedata-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdelete

Delete data sets, jobs, and USS files

zowezos-ftpdeletedata-set

Delete a data set

Usage

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

Positional Arguments

Required Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdeletejob

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdeleteuss-file

Delete a USS file

Usage

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

Positional Arguments

Required Options

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdownload

Download data set, job spool, and USS file content

zowezos-ftpdownloadall-spool-by-jobid

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdownloaddata-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpdownloaduss-file

Download the contents of a USS file to a local file

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftplist

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

zowezos-ftplistdata-set

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistdata-set-members

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistjobs

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

Usage

zowe zos-ftp list jobs [options]

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistspool-files-by-jobid

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftplistuss-files

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

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpmake

Make a USS directory

zowezos-ftpmakeuss-directory

Make a Unix System Services Directory

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftprename

Rename data sets and USS files or directories

zowezos-ftprenamedata-set

Rename a cataloged data set

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftprenameuss-file

Rename a USS file or directory

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpsubmit

Submit jobs from local files and data sets

zowezos-ftpsubmitdata-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpsubmitlocal-file

Submit a job from a local file containing JCL

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpsubmitstdin

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

Usage

zowe zos-ftp submit stdin [options]

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpupload

Upload data set and USS content

zowezos-ftpuploadfile-to-data-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpuploadfile-to-uss-file

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpuploadstdin-to-data-set

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

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpuploadstdin-to-uss-file

Upload from stdin to a Unix System Services File

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpview

View data sets, job output, and USS content

zowezos-ftpviewall-spool-by-jobid

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpviewdata-set

View the contents of a z/OS data set

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpviewjob-status-by-jobid

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-ftpviewspool-file-by-id

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

Usage

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

Positional Arguments

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples

zowezos-ftpviewuss-file

View the contents of a Unix System Services File

Usage

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

Positional Arguments

Options

FTP Connection options

TLS / Secure Connection options

Profile Options

Base Connection Options

Examples


zowezos-jobs

Manage z/OS jobs.

zowezos-jobscancel

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

zowezos-jobscanceljob

Cancel a single job by job ID

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsdelete

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

zowezos-jobsdeletejob

Delete a single job by job ID

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsdeleteold-jobs

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

Usage

zowe zos-jobs delete old-jobs [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobsdownload

Download the output of a job as separate files.

zowezos-jobsdownloadoutput

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-jobslist

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

zowezos-jobslistjobs

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

Usage

zowe zos-jobs list jobs [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobslistspool-files-by-jobid

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

Usage

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

Positional Arguments

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-jobsmodify

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

zowezos-jobsmodifyjob

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

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

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezos-ssh

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

zowezos-sshissue

Issue a z/OS USS command.

zowezos-sshissuecommand

Issue a z/OS USS command

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

Usage

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

Positional Arguments

Options

z/OS Ssh Connection Options

Profile Options

Base Connection Options

Examples


zowezos-tso

Issue TSO commands and interact with TSO address spaces.

zowezos-tsoissue

Issue TSO commands.

zowezos-tsoissuecommand

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

Usage

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

Positional Arguments

Options

TSO ADDRESS SPACE OPTIONS

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-tsoping

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

zowezos-tsopingaddress-space

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

Usage

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

Positional Arguments

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-tsosend

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

zowezos-tsosendaddress-space

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

Usage

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

Positional Arguments

Required Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-tsostart

Start TSO/E address space.

zowezos-tsostartaddress-space

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

Usage

zowe zos-tso start address-space [options]

TSO ADDRESS SPACE OPTIONS

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-tsostop

Stop TSO/E address space.

zowezos-tsostopaddress-space

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

Usage

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

Positional Arguments

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezos-workflows

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

zowezos-workflowsarchive

Archive workflow instance in z/OSMF.

zowezos-workflowsarchiveactive-workflow

Archive an active workflow instance in z/OSMF.

Usage

zowe zos-workflows archive active-workflow [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowscreate

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

zowezos-workflowscreateworkflow-from-data-set

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

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowscreateworkflow-from-local-file

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

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowscreateworkflow-from-uss-file

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

Usage

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

Positional Arguments

Required Options

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowsdelete

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

zowezos-workflowsdeleteactive-workflow

Delete an active workflow instance in z/OSMF

Usage

zowe zos-workflows delete active-workflow [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowsdeletearchived-workflow

Delete an archived workflow from z/OSMF

Usage

zowe zos-workflows delete archived-workflow [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowslist

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

zowezos-workflowslistactive-workflow-details

Get the details of an active z/OSMF workflow

Usage

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

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowslistactive-workflows

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

Usage

zowe zos-workflows list active-workflows [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

Examples

zowezos-workflowslistarchived-workflows

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

Usage

zowe zos-workflows list archived-workflows [options]

Zosmf Connection Options

Profile Options

Base Connection Options

Response Format Options

zowezos-workflowslistdefinition-file-details

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowsstart

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

zowezos-workflowsstartworkflow-full

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

Usage

zowe zos-workflows start workflow-full [options]

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezos-workflowsstartworkflow-step

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

Usage

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

Positional Arguments

Options

Zosmf Connection Options

Profile Options

Base Connection Options

Examples


zowezosmf

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

zowezosmfcheck

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

zowezosmfcheckstatus

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

Usage

zowe zosmf check status [options]

Zosmf Connection Options

Profile Options

Base Connection Options

Examples

zowezosmflist

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

zowezosmflistsystems

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

Usage

zowe zosmf list systems [options]

Zosmf Connection Options

Profile Options

Base Connection Options

Examples