Welcome to Zowe CLI!
Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.
For additional Zowe CLI documentation, visit https://docs.zowe.org
For Zowe CLI support, visit https://www.zowe.org
Global Options
-
--response-format-json
| --rfj
(boolean)
- Produce JSON formatted data from a command
-
--help
| -h
(boolean)
-
--help-examples
(boolean)
- Not available for top tier Zowe group
-
--help-web
| --hw
(boolean)
- Display HTML help in browser
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.
Log in to an authentication service.
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
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Examples
Log out of an authentication service.
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
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--token-type
| --tt
(string)
-
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
Allowed values: apimlAuthenticationToken, jwtToken, LtpaToken2
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Examples
Welcome to the CA 7 Zowe CLI!
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.
Indicates the individual job to cancel, and the value must be a CA 7 job number.
Usage
zowe ca7 cancel jobnumber <jobnumber> [options]
Positional Arguments
Options
-
--force
(string)
- Specifies to force the cancellation of the job.
Use of this option can potentially cause CA WA CA 7 Edition to abend; therefore, only use it as a last resort.
-
--reason
(string)
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Cancel job number 0016:
zowe ca7 cancel jobnumber 0016
Demand a single job to CA 7.
The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
JOB and JOBL are mutually exclusive.
Usage
zowe ca7 demand job <job> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
Usage
zowe ca7 demand jobl <jobl> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Demand a single job to CA 7 and hold.
The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
Usage
zowe ca7 demandh job <job> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
Usage
zowe ca7 demandh jobl <jobl> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Retrieve job status information from CA 7.
Indicates the individual job to retrieve, and the value must be a CA 7 job number.
Usage
zowe ca7 jobstatus jobnumber <jobnumber> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Release a single job to CA 7.
Indicates the individual job to release, and the value must be a CA 7 job number.
Usage
zowe ca7 release jobnumber [jobnumber] [options]
Positional Arguments
Options
-
-q
(string)
-
Q={REQ|RDY}
Indicates to release the contents of an entire queue. Omit Q when JOB or JOBL is specified.
REQ
Release the contents of the request queue.
RDY
Release the contents of the ready queue.
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Restart a single job to CA 7.
Indicates the individual job to Restart, and the value must be a CA 7 job number.
Usage
zowe ca7 restart jobnumber <jobnumber> [options]
Positional Arguments
Options
-
--bypgdg
| --bp
(string)
-
bypgdg={NO|YES|VER|CAT}
Indicates whether CA Workload Automation Restart Option for z/OS Schedulers bypasses GDG logic on a restart/rerun.
Value can be NO, YES, VER, or CAT.
Default: CA Workload Automation Restart Option for z/OS Schedulers default value
-
--condcd
| --cc
(string)
-
condcd=nnnn
Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers condition code
that the CA Workload Automation Restart Option for z/OS Schedulers step sets when the rerun is executed.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
and CA Workload Automation CA 7® Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel.
Limits: 1 to 4 numeric characters from 0 to 4095
-
--forcecomp
| --fc
(string)
-
forcecomp={NO|YES}
Indicates whether to flag the job as a normal completion.
If FORCECOMP=YES, the previous abnormal status of the job is ignored.
Normal job completion processing is performed instead of a restart.
Value can be NO or YES. NO is the default.
-
--lcc
(string)
-
lc=nnnn
Indicates an optional condition code value that replaces the last
condition code value for the step that the LSTP references and, optionally, LPSTP keywords.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Default: 0
Limits: 1 to 4 numeric characters from 0 to 4095
-
--lstp
(string)
-
lstp=stepname
Indicates an optional step name that has its last condition code value reset in the
CA Workload Automation Restart Option for z/OS Schedulers CMT.
Code LSTP and LCC when LPSTP is specified.
LSTP requires that an STPSTRT value is specified and that the LSTP step name occurs in the JCL of the job before the STPSTRT step name.
This option is honored only when CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters
-
--procstrt
| --ps
(string)
-
procstrt=procname
Indicates an optional step name referencing a procedure where processing is to start.
If PROCESS=R and PROCSTRT are used, also code STPSTRT.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters
-
--procend
| --pn
(string)
-
procend=procname
Indicates an optional step name referencing a procedure where processing is to end.
If PROCESS=R and PROCEND are used, code STPEND.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters
-
--process
| -p
(string)
-
process=code
Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers processing function code character to use in the restart/rerun.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use
and CA WA CA 7 Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel. Value can be F, P, S, N, O, or R.
Default: P
Limits: 1 alphabetic character
-
--reason
| -r
(string)
-
reason=text
Specifies a reason for the restart.
If the CA Workload Automation Restart Option for z/OS Schedulers Reason-for-Rerun module is available,
a code of up to four characters can be input and it is expanded.
Any reason input or expanded is copied to the run log.
This field is optional unless CA Workload Automation Restart Option for z/OS Schedulers requires a reason or
REASON=YES was specified in the RESTART statement in the initialization file.
Limits: 1 to 40 alphanumeric characters
-
--stpend
| --sn
(string)
-
stpend=stepname
Indicates an optional step name or number at which processing is to end.
If not specified, the last step of the job is assumed to be the ending step.
Code STPEND when PROCEND is specified.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
Limits: 1 to 8 alphanumeric characters
-
--stpstrt
| --st
(string)
-
stpstrt={stepname|*CMT*|*RERUN*|*RESUBP*}
Indicates an optional step name or number at which processing is to start.
If STPSTRT is not coded, the first step of the job is assigned to be the starting step.
Code STPSTRT when PROCSTRT is specified. This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use.
It can be one of
stepname
Specifies the step name or number at which processing is to start.
*CMT*
Indicates that the job is to restart with the step values currently on the CMT record.
*RERUN*
Indicates to rerun t the total job. If there are no restartable steps, specify RERUN.
*RESUBP*
Indicates that the CMT record of the job is set to production, and then the job is submitted.
-
--sup11stp
(string)
-
sup11stp={NO|YES}
Indicates whether to suppress the insertion of the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
If the job is resubmitted with SUP11STP=YES, the CA Workload Automation Restart Option for z/OS Schedulers step is not inserted.
Only valid if CA WA CA 7 Edition is inserting the CA Workload Automation Restart Option for z/OS Schedulers step.
See the INSERT-RMS field on the DB.1 panel.
Value can be NO or YES. NO is the default.
-
--usage
(string)
-
usage=code
Indicates an optional CA Workload Automation Restart Option for z/OS Schedulers
usage code of the character to use in the restart/rerun.
For the values, see the CA Workload Automation Restart Option for z/OS Schedulers documentation.
This option is honored only if CA Workload Automation Restart Option for z/OS Schedulers is in use and
CA WA CA 7 Edition is inserting the RMS step.
See the INSERT-RMS field on the DB.1 panel.
Limits: 1 alphanumeric character
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Run a single job to CA 7.
The value must be a job name.
If the job has not been defined in the database, this name must also match the member name for the JCL unless the job is defined in the database.
this name must also match the member name for the JCL unless the job is defined in the database.
See also JCLID. JOB and JOBL are mutually exclusive.
Usage
zowe ca7 run job <job> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The ran jobs are placed in the request queue and assigned a unique CA 7 job number.
Usage
zowe ca7 run jobl <jobl> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Run and hold a single job to CA 7.
The ran jobs are placed in the request queue and assigned a unique CA 7 job number.
Usage
zowe ca7 runh job <job> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The ran jobs are placed in the request queue and assigned a unique CA 7 job number.
Usage
zowe ca7 runh jobl <jobl> [options]
Positional Arguments
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Interact with Spool™
Issue Spool commands.
Issue commands to work with Spool.
Usage
zowe caspool issue command <commandText> [options]
Positional Arguments
-
commandText
(string)
- The Spool command to issue.
SPOOL OPTIONS
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--caspool-profile
| --caspool-p
(string)
- The name of a (caspool) profile to load for this command execution.
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Examples
Access View data and perform related tasks.
Download View report data to local folder.
Download report data.
Optionally convert text report to PDF.
Usage
zowe caview download report <repositoryId> <reportHandle> [fileTarget] [options]
Positional Arguments
-
repositoryId
(number)
-
reportHandle
(string)
-
fileTarget
(string)
- Local file path.
If the path represents a directory location, the report will be downloaded into that directory using a default file name.
If the path does not represent a directory location, the report will be downloaded into the specified path.
If the path is not specified, the file will be saved to the current working directory using the default file name.
Any missing directories will be created. If the target file already exists, the file will be overwritten.
Options
-
--convert-to-pdf
| --to-pdf
(boolean)
-
--page-orientation
| --orientation
(string)
-
--font-size
| --font
(number)
-
--green-bar
(boolean)
-
--pages
(string)
-
Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are downloaded.
Allowed values: ^(\d+(-\d+)?)(,(\d+(-\d+)?))*$
-
--content-filter
| --filter
(string)
- Filter text report content using a permanent filter definition.
If the product instance does not support this feature, this option is ignored.
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Export View text report file to local folder.
Export text report to spreadsheet using a predefined export rule.
Usage
zowe caview export report <repositoryId> <reportHandle> <ruleId> [fileTarget] [options]
Positional Arguments
-
repositoryId
(number)
-
reportHandle
(string)
-
ruleId
(number)
-
fileTarget
(string)
- Local file path.
If the path represents a directory location, the report will be exported into that directory using a default file name.
If the path does not represent a directory location, the report will be exported into the specified path.
If the path is not specified, the file will be saved to the current working directory using the default file name.
Any missing directories will be created. If the target file already exists, the file will be overwritten.
Options
-
--pages
(string)
-
Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are exported.
Allowed values: ^(\d+(-\d+)?)(,(\d+(-\d+)?))*$
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Get information from View repository.
Get user information from repository.
Get current user settings from repository.
Usage
zowe caview get user settings <repositoryId> [options]
Positional Arguments
Options
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId
Default value: Mode,DistId,ModeAccess,DistMask
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
List View repository, report, and user information.
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
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Identifier,Name,Description,Owner,Public
Default value: Identifier,Name,Description
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
List information about a specific report.
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
-
repositoryId
(number)
-
reportHandle
(string)
Options
-
--filter-names
| --names
(string)
-
Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
Default value: *,*,*,*,*,*,*,*
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Index,SubIndexNames,IndexNameHandle
Default value: Index,SubIndexNames,IndexNameHandle
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
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
-
repositoryId
(number)
-
reportHandle
(string)
-
indexNameHandle
(string)
Options
-
--filter-values
| --values
(string)
-
Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
Default value: *,*,*,*,*,*,*,*
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Value,SubValues,ReportHandle
Default value: Value,SubValues,ReportHandle
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
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
-
repositoryId
(number)
-
reportHandle
(string)
Options
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Description,Index,SubIndexNames,ReportHandle,IndexNameHandle,Number,ViewId,Default
Default value: Description,Index,SubIndexNames,ReportHandle,IndexNameHandle
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
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
-
--filter-name
| -n
(string)
-
--limit
| -l
(number)
-
--latest-versions
| --latest-version
| --lv
(number)
-
--archival-since
| --since
| --archival-from
| --from
(string)
- Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--archival-until
| --until
| --archival-to
| --to
(string)
- Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--output-header
| --header
(boolean)
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days
Default value: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
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
-
--filter-name
| -n
(string)
- Filter (include) based on repository name. Use the percent sign (%) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.
-
--filter-path
| -p
(string)
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Identifier,Name,Description,Path,CharacterSet,ReportAccess,CreatedBy,DateCreated,ModifiedBy,ModifiedDate
Default value: Identifier,Name,Description,Path,CharacterSet
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Search data in a View repository.
Search cross-report index data in a repository.
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
-
--filter-reports
| --reports
(string)
-
--filter-names
| --names
(string)
-
Filter (include) based on index name. Separate multiple index names with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
Default value: *,*,*,*,*,*,*,*
-
--latest-versions
| --latest-version
| --lv
(number)
-
--archival-since
| --since
| --archival-from
| --from
(string)
- Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--archival-until
| --until
| --archival-to
| --to
(string)
- Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--online-only
| --online
(boolean)
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Index,SubIndexNames,IndexNameHandle
Default value: Index,SubIndexNames,IndexNameHandle
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
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
-
repositoryId
(number)
-
indexNameHandle
(string)
-
valueHandle
(string)
Options
-
--filter-reports
| --reports
(string)
-
--latest-versions
| --latest-version
| --lv
(number)
-
--archival-since
| --since
| --archival-from
| --from
(string)
- Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--archival-until
| --until
| --archival-to
| --to
(string)
- Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--online-only
| --online
(boolean)
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days
Default value: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
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
-
repositoryId
(number)
-
indexNameHandle
(string)
Options
-
--filter-reports
| --reports
(string)
-
--filter-values
| --values
(string)
-
Filter (include) based on index values. Separate index values with commas. Use the asterisk (*) as a wildcard to represent any number of characters.
Default value: *,*,*,*,*,*,*,*
-
--latest-versions
| --latest-version
| --lv
(number)
-
--archival-since
| --since
| --archival-from
| --from
(string)
- Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--archival-until
| --until
| --archival-to
| --to
(string)
- Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
-
--online-only
| --online
(boolean)
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Value,SubValues,IndexValueHandle
Default value: Value,SubValues,IndexValueHandle
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Set information in View repository.
Set configuration for current user in repository.
Set distribution id for current user in repository.
Usage
zowe caview set user distribution <repositoryId> <distributionId> [options]
Positional Arguments
-
repositoryId
(number)
-
distributionId
(string)
Options
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId
Default value: Mode,DistId,ModeAccess,DistMask
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Set mode for current user in repository.
Usage
zowe caview set user mode <repositoryId> <mode> [options]
Positional Arguments
-
repositoryId
(number)
-
mode
(string)
- User mode.
Must match regular expression: ^(ALL|SAR|SARO|EXP|EXPO)$
Options
-
--output-format
| --output
(string)
-
Output format. This option is ignored if '--response-format-json' is specified.
Default value: tabular
Allowed values: ^tabular$, ^csv$, ^json$, ^xml$
-
--output-header
| --header
(boolean)
-
--output-field
| -f
(array)
-
Field to include in the output. Multiple fields can be specified.
Fields appear in the order you specify.
Allowed values: Mode,DistId,ModeAccess,DistMask,Banner,Language,MasterAuthority,Printer,UserId
Default value: Mode,DistId,ModeAccess,DistMask
View Connection Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Interact with IBM CICS programs and transactions.
Add new resources (for example, CSD Groups to CSD Lists) to CICS through IBM CMCI.
Add a CSD Group to a CICS CSD List.
Usage
zowe cics add-to-list csdGroup <name> <csdList> [options]
Positional Arguments
-
name
(string)
- The name of the CSD Group to add. The maximum length of the CSD Group name is eight characters
-
csdList
(string)
- The name of the CSD List to add the group to. The maximum length of the CSD List name is eight characters
Options
-
--region-name
(string)
- The CICS region name to which to add the CSD Group to the CSD List
-
--cics-plex
(string)
- The name of the CICSPlex to which to add the CSD Group to the CSD List
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Define new resources (for example, programs) to CICS through IBM CMCI.
Define a new program to CICS.
Usage
zowe cics define program <programName> <csdGroup> [options]
Positional Arguments
-
programName
(string)
- The name of the new program to define. The maximum length of the program name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new program that you want to define. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to define the new program
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Define a new transaction to CICS.
Usage
zowe cics define transaction <transactionName> <programName> <csdGroup> [options]
Positional Arguments
-
transactionName
(string)
- The name of the new transaction to define. The maximum length of the transaction name is four characters.
-
programName
(string)
- The name of the program that the transaction uses. The maximum length of the program name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new transaction that you want to define. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to define the new transaction
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new transaction
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
urimapName
(string)
- The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
Required Options
Options
-
--urimap-scheme
| --us
(string)
-
The scheme component to be used with the request (http or https).
Default value: https
Allowed values: http, https
-
--authenticate
| --auth
(string)
-
The authentication and identification scheme to be used for client URIMAPs.
Allowed values: NO, BASIC
-
--certificate
| --cert
(string)
- The label of a certificate in the keyring that is to be used as the client certificate in SSL handshakes
-
--description
| --desc
(string)
- Description of the URIMAP resource being defined.
-
--region-name
(string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable
(boolean)
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
urimapName
(string)
- The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
Required Options
-
--urimap-path
| --up
(string)
- The path component of the URI.
-
--urimap-host
| --uh
(string)
- The host component of the URI.
-
--pipeline-name
| --pn
(string)
- The name of the PIPELINE resource definition for the URIMAP. The maximum length of the pipeline name is eight characters.
Options
-
--urimap-scheme
| --us
(string)
-
The scheme component to be used with the request (http or https).
Default value: https
Allowed values: http, https
-
--description
| --desc
(string)
- Description of the URIMAP resource being defined.
-
--transaction-name
| --tn
(string)
- The name of the TRANSACTION resource definition for the URIMAP. The maximum length of the transaction name is four characters.
-
--webservice-name
| --wn
(string)
- The name of the WEBSERVICE resource definition for the URIMAP. The maximum length of the transaction name is 32 characters.
-
--tcpipservice
| --tcpip
(string)
- The TCPIPSERVICE to which the URIMAP definition applies.
-
--region-name
(string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable
(boolean)
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
urimapName
(string)
- The name of the URIMAP to create. The maximum length of the urimap name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new urimap that you want to define. The maximum length of the group name is eight characters.
Required Options
-
--urimap-path
| --up
(string)
- The path component of the URI.
-
--urimap-host
| --uh
(string)
- The host component of the URI.
-
--program-name
| --pn
(string)
- The application program that makes or handles the requests.
Options
-
--urimap-scheme
| --us
(string)
-
The scheme component to be used with the request (http or https).
Default value: https
Allowed values: http, https
-
--description
| --desc
(string)
- Description of the URIMAP resource being defined.
-
--tcpipservice
| --tcpip
(string)
- The TCPIPSERVICE to which the URIMAP definition applies.
-
--region-name
(string)
- The CICS region name to which to define the new URIMAP.
-
--cics-plex
(string)
- The name of the CICSPlex to which to define the new URIMAP.
-
--enable
(boolean)
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Define a new web service to CICS.
Usage
zowe cics define webservice <webserviceName> <csdGroup> [options]
Positional Arguments
-
webserviceName
(string)
- The name of the WEBSERVICE to create. The maximum length of the web service name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the new web service that you want to define. The maximum length of the group name is eight characters.
Required Options
Options
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete resources (for example, programs) from CICS through IBM CMCI.
Delete a program from CICS.
Usage
zowe cics delete program <programName> <csdGroup> [options]
Positional Arguments
-
programName
(string)
- The name of the program to delete. The maximum length of the program name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the program that you want to delete. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to delete the program
-
--cics-plex
(string)
- The name of the CICSPlex from which to delete the program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a transaction from CICS.
Usage
zowe cics delete transaction <transactionName> <csdGroup> [options]
Positional Arguments
-
transactionName
(string)
- The name of the transaction to delete. The maximum length of the transaction name is four characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the transaction that you want to delete. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to delete the transaction
-
--cics-plex
(string)
- The name of the CICSPlex from which to delete the transaction
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a urimap from CICS.
Usage
zowe cics delete urimap <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to delete. The maximum length of the urimap name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the urimap that you want to delete. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to delete the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a web service from CICS.
Usage
zowe cics delete webservice <webserviceName> <csdGroup> [options]
Positional Arguments
-
webserviceName
(string)
- The name of the web service to delete. The maximum length of the web service name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the web service that you want to delete. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to delete the web service
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Disable resources (for example, urimaps) from CICS through IBM CMCI.
Disable a urimap from CICS.
Usage
zowe cics disable urimap <urimapName> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to disable. The maximum length of the urimap name is eight characters.
Options
-
--region-name
(string)
- The CICS region name in which to disable the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Discard resources (for example, programs) from CICS through IBM CMCI.
Discard a program from CICS.
Usage
zowe cics discard program <programName> [options]
Positional Arguments
-
programName
(string)
- The name of the program to discard. The maximum length of the program name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to discard the program
-
--cics-plex
(string)
- The name of the CICSPlex from which to discard the program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Discard a transaction from CICS.
Usage
zowe cics discard transaction <transactionName> [options]
Positional Arguments
-
transactionName
(string)
- The name of the transaction to discard. The maximum length of the transaction name is four characters.
Options
-
--region-name
(string)
- The CICS region name from which to discard the transaction
-
--cics-plex
(string)
- The name of the CICSPlex from which to discard the transaction
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Discard a urimap from CICS.
Usage
zowe cics discard urimap <urimapName> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to discard. The maximum length of the urimap name is eight characters.
Options
-
--region-name
(string)
- The CICS region name from which to discard the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Enable resources (for example, urimaps) from CICS through IBM CMCI.
Enable a urimap from CICS.
Usage
zowe cics enable urimap <urimapName> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to enable. The maximum length of the urimap name is eight characters.
Options
-
--region-name
(string)
- The CICS region name in which to enable the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Get resources (for example, programs or transactions) from CICS through IBM CMCI.
Get resources (for example, programs or transactions) from CICS.
Usage
zowe cics get resource <resourceName> [options]
Positional Arguments
-
resourceName
(string)
- The name of the resource to get.
Options
-
--region-name
| --rn
(string)
- The CICS region name from which to get the resources
-
--cics-plex
| --cp
(string)
- The name of the CICSPlex from which to get the resources
-
--criteria
| -c
(string)
- The criteria by which to filter the resource
-
--parameter
| -p
(string)
- The parameter by which to refine the resource
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Get program resources from the region named MYREGION:
zowe cics get resource CICSProgram --region-name MYREGION
-
Get local transaction resources from the region named MYREGION:
zowe cics get resource CICSLocalTransaction --region-name MYREGION
-
Get local file resources from the region named MYREGION:
zowe cics get resource CICSLocalFile --region-name MYREGION
-
Get program definition resources from the CSD group named GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionProgram --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get transaction definition resources from the CSD group named GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionTransaction --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get URIMap definition resources from the CSD group named GRP1 and the region named MYREGION:
zowe cics get resource CICSDefinitionURIMap --region-name MYREGION --parameter "CSDGROUP(GRP1)"
-
Get program resources that start with the name PRG from the region named MYREGION:
zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=PRG*"
-
Get a local transaction resource named TRAN from the region named MYREGION:
zowe cics get resource CICSLocalTransaction --region-name MYREGION --criteria "TRANID=TRAN"
-
Get program resources that start with the name MYPRG from the region named MYREGION and display various fields as a table:
zowe cics get resource CICSProgram --region-name MYREGION --criteria "PROGRAM=MYPRG*" --rft table --rfh --rff program length status
Install resources (for example, programs) to CICS through IBM CMCI.
Install a program to CICS.
Usage
zowe cics install program <programName> <csdGroup> [options]
Positional Arguments
-
programName
(string)
- The name of the program to install. The maximum length of the program name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the program that you want to install. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to install the program
-
--cics-plex
(string)
- The name of the CICSPlex to which to install the program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Install a transaction to CICS.
Usage
zowe cics install transaction <transactionName> <csdGroup> [options]
Positional Arguments
-
transactionName
(string)
- The name of the transaction to install. The maximum length of the transaction name is four characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the transaction that you want to install. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to install the transaction
-
--cics-plex
(string)
- The name of the CICSPlex to which to install the transaction
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Install a urimap to CICS.
Usage
zowe cics install urimap <urimapName> <csdGroup> [options]
Positional Arguments
-
urimapName
(string)
- The name of the urimap to install. The maximum length of the urimap name is eight characters.
-
csdGroup
(string)
- The CICS system definition (CSD) Group for the urimap that you want to install. The maximum length of the group name is eight characters.
Options
-
--region-name
(string)
- The CICS region name to which to install the urimap
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Refresh a program on CICS through IBM CMCI.
Refresh a program on CICS.
Usage
zowe cics refresh program <programName> [options]
Positional Arguments
-
programName
(string)
- The name of the program to refresh. The maximum length of the program name is eight characters.
Options
-
--region-name
(string)
- The CICS region name on which you want to refresh the program
-
--cics-plex
(string)
- The name of the CICSPlex on which to refresh the program
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Remove resources (for example, CSD Groups in CSD Lists) from CICS through IBM CMCI.
Remove a CSD Group from a CICS CSD List.
Usage
zowe cics remove-from-list csdGroup <name> <csdList> [options]
Positional Arguments
-
name
(string)
- The name of the CSD Group to remove. The maximum length of the CSD Group name is eight characters
-
csdList
(string)
- The name of the CSD List to remove the group from. The maximum length of the CSD List name is eight characters
Options
-
--region-name
(string)
- The CICS region name to which to remove the CSD Group from the CSD List
-
--cics-plex
(string)
- The name of the CICSPlex to which to remove the CSD Group from the CSD List
Cics Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
CICS bundle deployment plugin.
Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. A BUNDLE resource is installed, ENABLED and made AVAILABLE in the target scope of the CICSplex.
Deploy a CICS bundle from zFS to one or more CICS regions within a CICSplex. The DFHDPLOY utility is used to install and make available a BUNDLE resource in the target group of CICS regions.
Usage
zowe cics-deploy deploy bundle [options]
cics-deploy Options
-
--name
| -n
(string)
- Required. Specifies the name of the CICS BUNDLE resource (up to 8 characters) to deploy or undeploy.
-
--bundle-directory
| --bd
| --bundledir
| --bundle-dir
(string)
- Required. Specifies the location of the CICS bundle (up to 255 characters) on zFS.
-
--cicsplex
| --cp
(string)
- Specifies the CICSplex (up to 8 characters) to target. This parameter defaults to the value specified in the cics-deploy profile.
-
--scope
| --sc
(string)
- Specifies the name of the CICS System, or CICS System Group (up to 8 characters) to target. This parameter defaults to the value specified in the cics-deploy profile.
-
--csd-group
| --cg
| --csdgroup
(string)
- Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is deployed, a definition is added to this group. If a bundle is undeployed, then the definition is removed from this group. The definition is added or removed from the CSD of each system that is specified by the --scope option. The --csd-group and --res-group options are mutually exclusive.
-
--res-group
| --rg
| --resgroup
(string)
- Specifies the BAS resource group (up to 8 characters) for the bundle resource. If a bundle is deployed, a resource is defined in the BAS data repository. If a bundle is undeployed, the definition is removed. The --csd-group and --res-group options are mutually exclusive.
-
--cics-hlq
| --cq
| --cicshlq
(string)
- Specifies the high-level qualifier (up to 35 characters) at which the CICS datasets can be found in the target environment. This parameter defaults to the value specified in the cics-deploy profile.
-
--cpsm-hlq
| --cph
| --cpsmhlq
(string)
- Specifies the high-level qualifier (up to 35 characters) at which the CPSM datasets can be found in the target environment. This parameter defaults to the value specified in the cics-deploy profile.
-
--description
| --desc
(string)
- An optional value that specifies a description of the bundle definition (up to 58 characters).
-
--job-card
| --jc
| --jobcard
(string)
-
Specifies the job card to use with any generated DFHDPLOY JCL. Use this parameter if you need to tailor the job card and you have not set the --cics-deploy-profile option. You can separate multiple lines of the jobcard with \n.
Default value: //DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT
-
--timeout
| --to
(number)
- An optional numerical value that specifies the maximum amount of time in seconds (1 - 1800 inclusive) for the DFHDPLOY command to complete. If not specified DFHDPLOY will use its default of 300 seconds.
-
--target-state
| --ts
| --targetstate
(string)
-
Specifies the target state for the deployed bundle.
Default value: ENABLED
Allowed values: DISABLED, ENABLED, AVAILABLE
-
--verbose
| -v
(boolean)
Zosmf Connection Options
-
--zosmf-host
| --zh
(string)
- The z/OSMF server host name.
-
--zosmf-port
| --zp
(number)
-
--zosmf-user
| --zu
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--zosmf-password
| --zpw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--zosmf-reject-unauthorized
| --zru
(boolean)
- Reject self-signed certificates.
-
--zosmf-base-path
| --zbp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
-
--cics-deploy-profile
| --cics-deploy-p
(string)
- The name of a (cics-deploy) profile to load for this command execution.
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Deploy a CICS bundle with a specific name and location to a default set of target regions:
zowe cics-deploy deploy bundle --name EXAMPLE --bundle-directory /u/example/bundleDir
-
Deploy a CICS bundle, but declare a timeout if the processing takes too long:
zowe cics-deploy deploy bundle --name EXAMPLE --bundle-directory /u/example/bundleDir --timeout 60
-
Deploy a CICS bundle to a specific target environment by using specific zosmf & cics-deploy profiles:
zowe cics-deploy deploy bundle --name EXAMPLE --bundle-directory /u/example/bundleDir --cicsplex TESTPLEX --scope SCOPE --res-group BUNDGRP --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics
Generate a CICS bundle and associated metadata files in the current working directory. This allows the application in the current working directory to be deployed to CICS.
Generate a CICS bundle in the working directory. The associated data is constructed from a combination of the command-line options and the contents of package.json. If package.json exists, no options are required. If package.json does not exist, both --start-script and --nodejsapp are required.
Usage
zowe cics-deploy generate bundle [options]
cics-deploy Options
-
--bundle-id
| -b
| --id
| --bundleid
(string)
- The ID for the generated CICS bundle, up to 64 characters. If no value is specified, a default value is created from the 'name' property in the package.json file in the current working directory. If the value is too long, it is truncated. If it contains characters that are not supported by CICS, each character is replaced by an X.
-
--bundle-version
| --bv
| --bundleversion
(string)
- The major.minor.micro version number for the generated CICS bundle. If no value is specified, a default value of 1.0.0 is used.
-
--nodejsapp
| -n
| --nj
| --nja
(string)
- The ID of the generated CICS NODEJSAPP resource, up to 32 characters. If no value is specified, a default value is created from the 'name' property in package.json, or the bundleid option if specified. If the value is too long it is truncated. If it contains characters that are not supported by CICS, each character is replaced by an X.
-
--start-script
| -s
| --ss
| --startscript
(string)
- Up to 255 character path to the Node.js start script that runs when the associated bundle is enabled in CICS. If a value is not specified, a default value is created from either the 'scripts.start' property of the package.json file in the current working directory, or from the 'main' property.
-
--port
| -p
(string)
- The TCP/IP port number the Node.js application should use for clients to connect to. If a value is specified, it is set within the generated NODEJSAPP's profile. The Node.js application can reference this value by accessing the PORT environment variable, for example using process.env.PORT. Additional environment variables can be set by manually editing the profile.
-
--overwrite
| --ow
(boolean)
-
--merge
| --me
(boolean)
Examples
-
Generate a CICS bundle in the working directory, taking information from package.json:
zowe cics-deploy generate bundle
-
Generate a CICS bundle in the working directory, based on package.json but using a bundle ID of "mybundle":
zowe cics-deploy generate bundle --bundle-id mybundle
-
Generate a CICS bundle in the working directory in which a package.json does not exist:
zowe cics-deploy generate bundle --bundle-id mybundle --nodejsapp myapp --start-script server.js
Push combines several actions for deploying a bundle to CICS into a single command. It uploads the bundle to z/OS, optionally runs an 'npm install' command on the remote system, then uses DFHDPLOY to install and enable the bundle in a target CICS environment.
Push a CICS bundle from the working directory to a target CICSplex.
Usage
zowe cics-deploy push bundle [options]
cics-deploy Options
-
--name
| -n
(string)
- Required. Specifies the name of the CICS BUNDLE resource (up to 8 characters) to deploy or undeploy.
-
--target-directory
| --td
| --targetdir
| --target-dir
(string)
- Specifies the target zFS location in which the CICS bundle is to be created (up to 255 characters). This parameter defaults to the value specified in the cics-deploy profile.
-
--cicsplex
| --cp
(string)
- Specifies the CICSplex (up to 8 characters) to target. This parameter defaults to the value specified in the cics-deploy profile.
-
--scope
| --sc
(string)
- Specifies the name of the CICS System, or CICS System Group (up to 8 characters) to target. This parameter defaults to the value specified in the cics-deploy profile.
-
--csd-group
| --cg
| --csdgroup
(string)
- Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is deployed, a definition is added to this group. If a bundle is undeployed, then the definition is removed from this group. The definition is added or removed from the CSD of each system that is specified by the --scope option. The --csd-group and --res-group options are mutually exclusive.
-
--res-group
| --rg
| --resgroup
(string)
- Specifies the BAS resource group (up to 8 characters) for the bundle resource. If a bundle is deployed, a resource is defined in the BAS data repository. If a bundle is undeployed, the definition is removed. The --csd-group and --res-group options are mutually exclusive.
-
--cics-hlq
| --cq
| --cicshlq
(string)
- Specifies the high-level qualifier (up to 35 characters) at which the CICS datasets can be found in the target environment. This parameter defaults to the value specified in the cics-deploy profile.
-
--cpsm-hlq
| --cph
| --cpsmhlq
(string)
- Specifies the high-level qualifier (up to 35 characters) at which the CPSM datasets can be found in the target environment. This parameter defaults to the value specified in the cics-deploy profile.
-
--description
| --desc
(string)
- An optional value that specifies a description of the bundle definition (up to 58 characters).
-
--job-card
| --jc
| --jobcard
(string)
-
Specifies the job card to use with any generated DFHDPLOY JCL. Use this parameter if you need to tailor the job card and you have not set the --cics-deploy-profile option. You can separate multiple lines of the jobcard with \n.
Default value: //DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT
-
--timeout
| --to
(number)
- An optional numerical value that specifies the maximum amount of time in seconds (1 - 1800 inclusive) for the DFHDPLOY command to complete. If not specified DFHDPLOY will use its default of 300 seconds.
-
--target-state
| --ts
| --targetstate
(string)
-
Specifies the target state for the deployed bundle.
Default value: ENABLED
Allowed values: DISABLED, ENABLED, AVAILABLE
-
--verbose
| -v
(boolean)
-
--overwrite
| --ow
(boolean)
Zosmf Connection Options
-
--zosmf-host
| --zh
(string)
- The z/OSMF server host name.
-
--zosmf-port
| --zp
(number)
-
--zosmf-user
| --zu
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--zosmf-password
| --zpw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--zosmf-reject-unauthorized
| --zru
(boolean)
- Reject self-signed certificates.
-
--zosmf-base-path
| --zbp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
z/OS Ssh Connection Options
-
--ssh-host
| --sh
(string)
- The z/OS SSH server host name.
-
--ssh-port
| --sp
(number)
- The z/OS SSH server port.
-
--ssh-user
| --su
(string)
- Mainframe user name, which can be the same as your TSO login.
-
--ssh-password
| --spw
(string)
- Mainframe password, which can be the same as your TSO password.
-
--ssh-private-key
| --spk
(string)
- Path to a file containing your private key, that must match a public key stored in the server for authentication
-
--ssh-key-passphrase
| --skp
(string)
- Private key passphrase, which unlocks the private key.
-
--ssh-handshake-timeout
| --sht
(number)
- How long in milliseconds to wait for the SSH handshake to complete.
CICS Connection Options
-
--cics-host
| --ch
(string)
- The CMCI server host name.
-
--cics-port
| --cpo
(number)
-
--cics-user
| --cu
(string)
- Mainframe (CICS) user name, which can be the same as your TSO login.
-
--cics-password
| --cpw
(string)
- Mainframe (CICS) password, which can be the same as your TSO password.
-
--cics-reject-unauthorized
| --cru
(boolean)
- Reject self-signed certificates.
-
--cics-protocol
| --cpr
(string)
Profile Options
-
--cics-deploy-profile
| --cics-deploy-p
(string)
- The name of a (cics-deploy) profile to load for this command execution.
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--ssh-profile
| --ssh-p
(string)
- The name of a (ssh) profile to load for this command execution.
-
--cics-profile
| --cics-p
(string)
- The name of a (cics) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Push a CICS bundle from the working directory by using default cics-deploy, cics, ssh and zosmf profiles:
zowe cics-deploy push bundle --name EXAMPLE --target-directory /u/example/bundles
-
Push a CICS bundle from the working directory by using specific zosmf, ssh & cics-deploy profiles:
zowe cics-deploy push bundle --name EXAMPLE --target-directory /u/example/bundles --zosmf-profile testplex --cics-deploy-profile devcics --ssh-profile ssh
-
Push a CICS bundle from the working directory replacing any bundle of the same name that is already deployed:
zowe cics-deploy push bundle --name EXAMPLE --target-directory /u/example/bundles --overwrite
Undeploy a CICS bundle from one or more CICS regions within a CICSplex. A BUNDLE resource is made UNAVAILABLE, it is then DISABLED and DISCARDED from the target scope with the CICSplex.
Undeploy a CICS bundle from one or more CICS regions within a CICSplex. The DFHDPLOY utility is used to undeploy and remove a BUNDLE resource from the target group of CICS regions.
Usage
zowe cics-deploy undeploy bundle [options]
cics-deploy Options
-
--name
| -n
(string)
- Required. Specifies the name of the CICS BUNDLE resource (up to 8 characters) to deploy or undeploy.
-
--cicsplex
| --cp
(string)
- Specifies the CICSplex (up to 8 characters) to target. This parameter defaults to the value specified in the cics-deploy profile.
-
--scope
| --sc
(string)
- Specifies the name of the CICS System, or CICS System Group (up to 8 characters) to target. This parameter defaults to the value specified in the cics-deploy profile.
-
--csd-group
| --cg
| --csdgroup
(string)
- Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is deployed, a definition is added to this group. If a bundle is undeployed, then the definition is removed from this group. The definition is added or removed from the CSD of each system that is specified by the --scope option. The --csd-group and --res-group options are mutually exclusive.
-
--res-group
| --rg
| --resgroup
(string)
- Specifies the BAS resource group (up to 8 characters) for the bundle resource. If a bundle is deployed, a resource is defined in the BAS data repository. If a bundle is undeployed, the definition is removed. The --csd-group and --res-group options are mutually exclusive.
-
--cics-hlq
| --cq
| --cicshlq
(string)
- Specifies the high-level qualifier (up to 35 characters) at which the CICS datasets can be found in the target environment. This parameter defaults to the value specified in the cics-deploy profile.
-
--cpsm-hlq
| --cph
| --cpsmhlq
(string)
- Specifies the high-level qualifier (up to 35 characters) at which the CPSM datasets can be found in the target environment. This parameter defaults to the value specified in the cics-deploy profile.
-
--job-card
| --jc
| --jobcard
(string)
-
Specifies the job card to use with any generated DFHDPLOY JCL. Use this parameter if you need to tailor the job card and you have not set the --cics-deploy-profile option. You can separate multiple lines of the jobcard with \n.
Default value: //DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT
-
--timeout
| --to
(number)
- An optional numerical value that specifies the maximum amount of time in seconds (1 - 1800 inclusive) for the DFHDPLOY command to complete. If not specified DFHDPLOY will use its default of 300 seconds.
-
--target-state
| --ts
| --targetstate
(string)
-
Specifies the target state for the undeployed bundle.
Default value: DISCARDED
Allowed values: UNAVAILABLE, DISABLED, DISCARDED
-
--verbose
| -v
(boolean)
Zosmf Connection Options
-
--zosmf-host
| --zh
(string)
- The z/OSMF server host name.
-
--zosmf-port
| --zp
(number)
-
--zosmf-user
| --zu
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--zosmf-password
| --zpw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--zosmf-reject-unauthorized
| --zru
(boolean)
- Reject self-signed certificates.
-
--zosmf-base-path
| --zbp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
-
--cics-deploy-profile
| --cics-deploy-p
(string)
- The name of a (cics-deploy) profile to load for this command execution.
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Undeploy a CICS bundle by using the default cics-deploy and zosmf profiles:
zowe cics-deploy undeploy bundle --name EXAMPLE
-
Undeploy a CICS bundle, and declare a timeout if the processing takes too long:
zowe cics-deploy undeploy bundle --name EXAMPLE --timeout 60
-
Undeploy a CICS bundle from a specific target environment by using specific zosmf and cics-deploy profiles:
zowe cics-deploy undeploy bundle --name EXAMPLE --cics-plex TESTPLEX --scope SCOPE --res-group BUNDGRP --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --zosmf-profile testplex --cics-deploy-profile devcics
Manage configuration and overrides. To see all set-able options use "list" command.
Get a value of single setting option.
Usage
zowe config get <configName> [options]
Positional Arguments
Examples
List all configuration setting options.
Usage
zowe config list [options]
Options
-
--values
(boolean)
- Show values for every option
Examples
Reset a configuration setting to default value.
Usage
zowe config reset <configName> [options]
Positional Arguments
Examples
Set a configuration setting.
Usage
zowe config set <configName> <configValue> [options]
Positional Arguments
-
configName
(string)
- Setting name. Possible values:
CredentialManager - The package name of a plugin that will override the default credential manager to allow for different credential storage methods.
-
configValue
(string)
Examples
Interact with IBM Db2 for z/OS
Call a Db2 stored procedure
Call a Db2 stored procedure. Specify the stored procedure name and optionally provide values.
Usage
zowe db2 call procedure <routine> [options]
Positional Arguments
-
routine
(string)
- The name of a Db2 stored procedure
Options
DB2 Connection Options
-
--host
| -H
(string)
-
--port
| -P
(number)
- The Db2 server port number
-
--user
| -u
(string)
- The Db2 user ID (may be the same as the TSO login)
-
--password
| --pass
| --pw
(string)
- The Db2 password (may be the same as the TSO password)
-
--database
| --db
(string)
-
--sslFile
| --ssl
(string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Call stored procedure DEMO.SP1:
zowe db2 call procedure "DEMO.SP1"
-
Call a stored procedure and pass values for parameter indicators:
zowe db2 call procedure "DEMO.SP2(?, ?)" --parameters "Hello" "world!"
-
Call a stored procedure and pass values for two output parameters. The first output requires a 2-character buffer. The second output is a message that will be truncated to the length of the placeholder.:
zowe db2 call procedure "DEMO.SP3(NULL, ?, ?)" --parameters "00" "message_placeholder_message_placeholder"
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.
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
-
--query
| -q
(string)
- The SQL statement verbatim to execute
-
--file
| -f
(string)
- A local file containing the SQL statements to execute
DB2 Connection Options
-
--host
| -H
(string)
-
--port
| -P
(number)
- The Db2 server port number
-
--user
| -u
(string)
- The Db2 user ID (may be the same as the TSO login)
-
--password
| --pass
| --pw
(string)
- The Db2 password (may be the same as the TSO password)
-
--database
| --db
(string)
-
--sslFile
| --ssl
(string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Execute a dummy SQL query:
zowe db2 execute sql --query "SELECT 'Hello World' FROM SYSIBM.SYSDUMMY1"
-
Retrieve the employees table and total number of rows:
zowe db2 execute sql -q "SELECT * FROM SAMPLE.EMP; SELECT COUNT(*) AS TOTAL FROM SAMPLE.EMP"
-
Execute a file with SQL statements:
zowe db2 execute sql --file backup_sample_database.sql
Export data from a Db2 table
Export a Db2 table to the stdout or a file.
Usage
zowe db2 export table <table> [options]
Positional Arguments
-
table
(string)
- The name of the table to export
Options
DB2 Connection Options
-
--host
| -H
(string)
-
--port
| -P
(number)
- The Db2 server port number
-
--user
| -u
(string)
- The Db2 user ID (may be the same as the TSO login)
-
--password
| --pass
| --pw
(string)
- The Db2 password (may be the same as the TSO password)
-
--database
| --db
(string)
-
--sslFile
| --ssl
(string)
- Path to an SSL Certificate file
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
dbm-db2 plug-in to interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.
Perform DDL syntax checking.
Validate the syntax of input DDL and optionally verify Db2 object dependencies. Use this command to ensure that the syntax of the input DDL is valid. You can also optionally verify that the objects to be created do not exist on the Db2 subsystem and that the related objects that are required for successful creation of the objects exist on the Db2 subsystem or in the input DDL. You can generate input DDL using the 'zowe dbm-db2 generate ddl' command.
Usage
zowe dbm-db2 check ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Compare DDL with a Db2 subsystem and produce an update script to implement changes.
Compare objects that are defined in a DDL file to objects that are defined on a Db2 subsystem and generate an update script to implement the necessary object changes. This command also generates a summary report that provides a high-level overview of the changes. You can execute the script that is generated from this command using the 'zowe dbm-db2 execute compare-script' command.
Usage
zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
-
--match-set
| --ms
(string)
-
Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.
Format:
<match\-set\-creator\.match\-set\-name>
For more information about mask services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If \-\-match\-set and \-\-match\-set\-file are both specified, specifications in match\-set\-file take precedence\.
-
--match-set-file
| --msf
(string)
-
Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.
Format:
<object\-type> <source\-name\-mask> <target\-name\-mask>;
STOGROUP <name> <name>
DATABASE <name> <name>
TABLESPACE <database\.name> <database\.name>
TABLE <schema\.name> <schema\.name>
INDEX <schema\.name> <schema\.name>
VIEW <schema\.name> <schema\.name>
SYNONYM <schema\.name> <schema\.name>
ALIAS <schema\.name> <schema\.name>
TRIGGER <schema\.name> <schema\.name>
SEQUENCE <schema\.name> <schema\.name>
FUNCTION <schema\.name\[\.version\]> <schema\.name\[\.version\]>
PROCEDURE <schema\.name\[\.version\]> <schema\.name\[\.version\]>
Note: <schema> must be 8 characters or less\. <name> must be 18 characters or less\. The SEQUENCE <name> must be 8 characters or less\.
A mask specification can include the following wildcard characters:
% (percent sign) indicates that zero or more characters can occupy that position\. Other non\-wildcard characters must match\.
\- (hyphen) indicates that any character can occupy that position, but a character must exist at that position\.
\* (asterisk) indicates that like named objects on the source and target should be mapped\. No other characters can appear together with this character\.
Use a semicolon to separate mask specifications\. Multiple mask specifications for the same object type are supported\.
Example:
The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:
TABLE MY%.%TABLE YOUR%.%TABLE;
TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
TABLE *.MYTABLE *.YOURTABLE;
For a list of mask specifications, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If \-\-match\-set and \-\-match\-set\-file are both specified, specifications in match\-set\-file take precedence\.
-
--change-set
| --cs
(string)
-
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
Format:
<change\-set\-creator\.change\-set\-name>
For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
-
--change-set-file
| --csf
(string)
-
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
Format:
<object\-attribute> <from\-value> <to\-value>
The <object\-attribute> consists of four characters\. The first two characters identify the object type\. The last two characters identify the specific attribute\. Wildcard characters are supported in the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
Example:
The following example demonstrates changes to table’s schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
-
--rule-set
| --rs
(string)
-
Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (as determined by match-set processing).
Format:
<rule\-set\-creator\.rule\-set\-name>
For more information about rule database services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
-
--id
(string)
-
Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem by the execution of this command.
Format: The name must begin with a non-numeric character, and can consist of the characters A to Z (uppercase only), 0 to 9, $, #, and @.
-
--description
| -d
(string)
- Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
-
--output-compare-script
| --ocs
(string)
-
--output-summary-file
| --osf
(string)
-
Specifies the local output file name that provides a summary of the changes to be performed to the Db2 objects on the target Db2 subsystem. The file summarizes what the changes are, but not how the changes are made.
Default value: summary.txt
-
--modification
| -m
(string)
-
Identifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the set of values that are normally used.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
-
--error-file
| --ef
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Generate a script to update objects on the 'TEST' Db2 subsystem with DDL definitions in myddl.sql file:
zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST
-
Generate a script to update objects and apply a rule-set for the matched objects:
zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET
-
Generate a script to update objects and apply a ruleset for the objects matched as determined by the local mask specifications in the pair.txt file:
zowe dbm-db2 compare ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt
Deploy DDL statements to a Db2 subsystem.
Deploy Db2 object changes on the target Db2 subsystem using an input file that contains the DDL. For example, an application developer has made changes to DDL in a local file and is ready to test the DDL changes. Use this command to deploy the changes to the test environment.
Usage
zowe dbm-db2 deploy ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
-
--match-set
| --ms
(string)
-
Specifies the creator and name of an existing RC/Migrator automapping mask set. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. Matching determines whether the 'change-set' or 'rule-set' options are applied.
Format:
<match\-set\-creator\.match\-set\-name>
For more information about mask services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If \-\-match\-set and \-\-match\-set\-file are both specified, specifications in match\-set\-file take precedence\.
-
--match-set-file
| --msf
(string)
-
Specifies the name of the local input file that contains the mapping mask specifications. Matching is used to pair objects in a DDL file to objects that are defined on a Db2 subsystem. For example, a mask specification can account for different schema naming patterns across environments. Matching determines whether the 'change-set' or 'rule-set' options are applied.
Format:
<object\-type> <source\-name\-mask> <target\-name\-mask>;
STOGROUP <name> <name>
DATABASE <name> <name>
TABLESPACE <database\.name> <database\.name>
TABLE <schema\.name> <schema\.name>
INDEX <schema\.name> <schema\.name>
VIEW <schema\.name> <schema\.name>
SYNONYM <schema\.name> <schema\.name>
ALIAS <schema\.name> <schema\.name>
TRIGGER <schema\.name> <schema\.name>
SEQUENCE <schema\.name> <schema\.name>
FUNCTION <schema\.name\[\.version\]> <schema\.name\[\.version\]>
PROCEDURE <schema\.name\[\.version\]> <schema\.name\[\.version\]>
Note: <schema> must be 8 characters or less\. <name> must be 18 characters or less\. The SEQUENCE <name> must be 8 characters or less\.
A mask specification can include the following wildcard characters:
% (percent sign) indicates that zero or more characters can occupy that position\. Other non\-wildcard characters must match\.
\- (hyphen) indicates that any character can occupy that position, but a character must exist at that position\.
\* (asterisk) indicates that like named objects on the source and target should be mapped\. No other characters can appear together with this character\.
Use a semicolon to separate mask specifications\. Multiple mask specifications for the same object type are supported\.
Example:
The following example demonstrates different ways of matching the table MYNAME.MYTABLE to the table YOURNAME.YOURTABLE:
TABLE MY%.%TABLE YOUR%.%TABLE;
TABLE MYN-M-.MYT% YOURN-M-.YOURT%;
TABLE MYNAME.MYTABLE YOURNAME.YOURTABLE;
TABLE *.MYTABLE *.YOURTABLE;
For a list of mask specifications, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If \-\-match\-set and \-\-match\-set\-file are both specified, specifications in match\-set\-file take precedence\.
-
--change-set
| --cs
(string)
-
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
Format:
<change\-set\-creator\.change\-set\-name>
For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
-
--change-set-file
| --csf
(string)
-
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes. The changes apply to new objects only as determined by match-set processing.
Format:
<object\-attribute> <from\-value> <to\-value>
The <object\-attribute> consists of four characters\. The first two characters identify the object type\. The last two characters identify the specific attribute\. Wildcard characters are supported in the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
Example:
The following example demonstrates changes to table’s schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
-
--rule-set
| --rs
(string)
-
Specifies the creator and name of an existing RC/Migrator rule set to be used to override Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file.The changes apply to the existing objects only (as determined by match-set processing).
Format:
<rule\-set\-creator\.rule\-set\-name>
For more information about rule database services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
-
--modification
| -m
(string)
-
Identifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the set of values that are normally used.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
-
--error-file
| --ef
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Update Db2 objects on a target Db2 subsystem according to DDL definitions in myddl.sql file:
zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST
-
Update Db2 objects according to the input DDL definitions and applied rule set for the matched objects:
zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET
-
Update Db2 objects according to the input DDL definitions and applied rule set for the objects matched as determined by the local mask specifications in the pair.txt file:
zowe dbm-db2 deploy ddl myddl.sql --target-db2 TEST --rule-set USER1.RULESET --match-set-file pair.txt
Execute a script to implement Db2 object changes.
Execute the compare script that was generated with the 'zowe dbm-db2 compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.
Usage
zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]
Positional Arguments
Options
-
--output-recovery-file
| --orf
(string)
-
Specifies the local output recovery file that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm-db2 execute script' command undoes the changes that were made by execution of the compare-script.
Default value: recovery\.txt
-
--restart
| -r
(string)
-
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
The following restart options are valid:
new \- Restart execution of the script at the first statement\.
token \- Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure\.
-
--modification
| -m
(string)
-
Identifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the set of values that are normally used.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
-
--error-file
| --ef
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Execute a compare script:
zowe dbm-db2 execute compare-script compare.txt
-
Restart execution of a compare script at the first statement in the script:
zowe dbm-db2 execute compare-script compare.txt --restart new
-
Restart execution of a compare script at the location in the token:
zowe dbm-db2 execute compare-script compare.txt --restart 78A724GOBLEDYGOOK6FD140F6780D6FA
Execute the migration script that was generated with the 'zowe dbm-db2 prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.
Usage
zowe dbm-db2 execute migration-script <local-input-migrate-script-filename> [options]
Positional Arguments
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Execute a migration script:
zowe dbm-db2 execute migration-script migration.txt
-
Restart execution of a migration script at the first statement in the script:
zowe dbm-db2 execute migration-script migration.txt --restart new
-
Restart execution of a migration script at the location in the token. Execution begins at the last successful sync point that is recorded in the restart token up to the end of the restart token section:
zowe dbm-db2 execute migration-script migration.txt --restart target,78A724GOBLEDYGOOK6FD140F6780D6FA
Execute a Batch Processor script on a target subsystem. For example, use this command to execute a Batch Processor script or specifically to execute a recovery script to undo changes that were made by the 'zowe dbm-db2 execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.
Usage
zowe dbm-db2 execute script <local-input-bp-script-filename> [options]
Positional Arguments
Options
-
--target-db2
| --td
(string)
- Specifies the target Db2 subsystem ID where you want to execute the script. If the option is not specified, the target subsystem is identified by the first .CONNECT statement in the script. The target-db2 option value takes precedence.
-
--script-section
| --ss
(string)
-
Identifies the location in the script where you want to begin execution.
The following options are valid:
name \- Begin execution of the specific section and process all subsequent statements up to the next section\.
A section is a '\.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL\. 'source' is an alias for UNLOADS\. 'target' is an alias for SQLDDL\.
number \- Begin execution after the specific sync point (\.SYNC <number> statement) and process all statements up to the end of the script\.
name, number \- Begin execution of the specific script section beginning from the sync point (\.SYNC <number> statement) within the section and process all subsequent statements up to the next section\.
-
--restart
| -r
(string)
-
Specifies the location in the script where you want to restart execution. The effects of previous successful script statement executions remain.
The following restart options are valid:
new \- Restart execution of the script at the first statement\.
token \- Restart execution of the script at the location that is recorded in the specified token and that was returned from a previous execution failure\.
name, token \- Restart execution of the script at the location in the restart section that is recorded in the specified token and that was returned from a prior execution failure\.
A section is a Batch Processor '\.SYSTEM <name>' statement, where <name> identifies a logical grouping of statements such as UNLOADS or SQLDDL\. 'source' is an alias for UNLOADS\. 'target' is an alias for SQLDDL\.
-
--modification
| -m
(string)
-
Identifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the set of values that are normally used.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
-
--error-file
| --ef
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Execute a recovery script:
zowe dbm-db2 execute script recovery.txt
-
Execute a script on the 'TEST' Db2 subsystem:
zowe dbm-db2 execute script script001.txt --target-db2 TEST
-
Execute only the SQLDDL section of a script. The first .CONNECT statement in the script identifies the target subsystem where the script is executed. Execution begins at the .SYSTEM SQLDDL statement and ends at the next .SYSTEM statement in the script:
zowe dbm-db2 execute script script001.txt ––script-section SQLDDL
-
Execute a script beginning from the sync point 10 (.SYNC 10 statement) to the end of the script:
zowe dbm-db2 execute script script001.txt ––script-section 10
-
Execute only the target (SQLDDL) section of the script starting at sync point 20:
zowe dbm-db2 execute script script001.txt ––script-section target,20
-
Restart execution of a script from the beginning:
zowe dbm-db2 execute script script001.txt ––restart new
-
Restart execution of a script at the location specified in the token. The restart token is returned by a previous 'zowe dbm-db2 execute command' failure as part of the terminal output and in the error file:
zowe dbm-db2 execute script script001.txt ––restart 78A724A48DA5185D06FD140F6780D6FA
-
Restart execution at the last successful sync point recorded in the restart token up to the end of the target (SQLDDL) section:
zowe dbm-db2 execute script script001.txt ––restart target,78A724A48DA5185D06FD140F6780D6FA
Generate DDL statements for Db2 objects.
Generate CREATE or DROP DDL statements for specified Db2 objects into an output DDL file. For example, use this command to generate CREATE TABLE definitions that you can then edit and use to update the table definition on a Db2 subsystem with the 'zowe dbm-db2 compare ddl' command.
Usage
zowe dbm-db2 generate ddl [options]
Options
-
--object
| -o
(string)
-
Specifies the Db2 objects for which you want to generate DDL statements. Use the optional include syntax to include related Db2 objects.
Format: see object-file description.
Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
-
--object-file
| --of
(string)
-
Specifies the local input file that contains a list of Db2 objects, separated by a semicolon, for which you want to generate DDL statements. Use the optional include syntax to include related Db2 objects.
Format:
<object\-type> <object\-name> \[include(<related\-object\-type>,\.\.\.)\];
The required clause <object\-type> <object\-name> identifies the specific Db2 (base) object:
STOGROUP <name>
DATABASE <name>
TABLESPACE <dbname>\.<name>
TABLE <schema>\.<name>
INDEX <schema>\.<name>
VIEW <schema>\.<name>
ALIAS <schema>\.<name>
SYNONYM <schema>\.<name>
MQT <schema>\.<name>
SEQUENCE <schema>\.<name>
TRIGGER <schema>\.<name>
FUNCTION <schema>\.<name>\[\.<version>\]
PROCEDURE <schema>\.<name>\[\.<version>\]
The optional clause include(<related\-object\-type>,\.\.\.) identifies one or more, comma separated related object types that you want to include in the generated DDL statements\. You can specify STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT\-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL\.
Example:
table sysibm\.systables include (tablespace, database, index);
database db1 include(children);
Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
-
--change-set
| --cs
(string)
-
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes when generating the DDL.
Format:
<change\-set\-creator\.change\-set\-name>
For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
-
--change-set-file
| --csf
(string)
-
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes when generating DDL.
Format:
<object\-attribute> <from\-value> <to\-value>
The <object\-attribute> consists of four characters\. The first two characters identify the object type\. The last two characters identify the specific attribute\. Wildcard characters are supported in the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Example:
The following example demonstrates changes to table’s schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
-
--type
| -t
(string)
-
Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.
Default value: create
Allowed values: drop, create
-
--output-ddl-file
| --odf
(string)
-
--modification
| -m
(string)
-
Identifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the set of values that are normally used.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
-
--error-file
| --ef
(string)
Required Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Generate CREATE DDL statements for a tablespace and its child table:
zowe dbm-db2 generate ddl --object "tablespace my.tbsp include(table)" --source-db2 SRC --output-ddl-file objects.sql
-
Generate CREATE DDL statements for a database and its children and apply changes as defined in the change set:
zowe dbm-db2 generate ddl --object "database my.db include(children)" --source-db2 SRC --change-set USER1.CHANGSET --output-ddl-file objects.sql
-
Generate DROP DDL statements only for the input object list:
zowe dbm-db2 generate ddl --object-file objects.txt --source-db2 SRC --type drop --output-ddl-file output.sql
Prepare DDL statements and a script to migrate Db2 objects.
Generate a script to migrate Db2 object definitions (DDL) and data from a source subsystem to a target subsystem. You can specify which objects to include and apply changes to the objects as part of the migration. To execute the script, use the 'zowe dbm-db2 execute migration-script' command.
Usage
zowe dbm-db2 prepare migration [options]
Options
-
--object
| -o
(string)
-
Specifies the Db2 objects that you want to migrate. Use the optional include syntax to include related Db2 objects.
Format: see object-file description.
Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
-
--object-file
| --of
(string)
-
Specifies the local input file that contains a list of Db2 objects, separated by a semicolon, that you want to migrate. Use the optional include syntax to include related Db2 objects.
Format:
<object\-type> <object\-name> \[include(<related\-object\-type>,\.\.\.)\];
The required clause <object\-type> <object\-name> identifies the specific Db2 (base) object:
STOGROUP <name>
DATABASE <name>
TABLESPACE <dbname>\.<name>
TABLE <schema>\.<name>
INDEX <schema>\.<name>
VIEW <schema>\.<name>
ALIAS <schema>\.<name>
SYNONYM <schema>\.<name>
MQT <schema>\.<name>
SEQUENCE <schema>\.<name>
TRIGGER <schema>\.<name>
FUNCTION <schema>\.<name>\[\.<version>\]
PROCEDURE <schema>\.<name>\[\.<version>\]
The optional clause include(<related\-object\-type>,\.\.\.) identifies one or more, comma separated related object types that you want to include in the object list\. You can specify STOGROUP, DATABASE, TABLESPACE, TABLE, INDEX, VIEW, SYNONYM, MQT\-ALL, TRIGGER, ROUTINE, PARENTS, CHILDREN, and ALL\.
Example:
table sysibm\.systables include (tablespace, database, index);
database db1 include(children);
Note: The \-\-object and \-\-object\-file options are mutually exclusive\.
-
--change-set
| --cs
(string)
-
Specifies the creator and name of an existing RC/Migrator global change set to be used to modify Db2 object attributes when preparing objects for migration.
Format:
<change\-set\-creator\.change\-set\-name>
For more information about global change services, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
-
--change-set-file
| --csf
(string)
-
Specifies the name of the local input file that contains the global change specifications to modify Db2 object attributes when preparing for migration.
Format:
<object\-attribute> <from\-value> <to\-value>
The <object\-attribute> consists of four characters\. The first two characters identify the object type\. The last two characters identify the specific attribute\. Wildcard characters are supported in the <from\-value> and <to\-value>\. The first occurrence in multiple specifications for the same <object\-attribute> has the highest precedence\.
For a list of global change set attributes, see the RC/Migrator documentation at https://techdocs\.broadcom\.com/db2rcmig\.
Example:
The following example demonstrates changes to table’s schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
Note: If change\-set and change\-set\-file are both specified, specifications in change\-set\-file take precedence\.
-
--output-migrate-script
| --oms
(string)
-
--output-ddl-file
| --odf
(string)
-
--modification
| -m
(string)
-
Identifies a named set of server-managed default parameter values that control the execution behavior of the zowe dbm-db2 commands. For example, you can use a modification to identify a set of default values that differ from the set of values that are normally used.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt.
-
--error-file
| --ef
(string)
Required Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.
Add an Element into Endevor.
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
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
input sources options
-
--from-file
| --ff
(string)
- Use this input to provide source file.
-
--from-dataset
| --fd
(string)
- Use this input to provide source data set name.
-
--from-member
| --fm
(string)
- Use this input to provide source member name in the data set.
-
--from-path
| --fp
(string)
- Use this input to provide the path of source USS file. It must be used with from-uss-file.
-
--from-uss-file
| --fuf
(string)
- Use this input to provide source USS file name. It must be used with from-path
options
-
--override-signout
| --os
(boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--new-version
| --nv
(number)
- Assign a different version number to the Element.
-
--proc-group
| --pg
(string)
- The Endevor processor group you would like to use.
-
--generate
| -g
(boolean)
- Specifies if you want to Generate Element after Add/Update action.
-
--get-fingerprint
| --gfg
(boolean)
-
--fingerprint
| --fg
(string)
- Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Approve a Package in Endevor.
The approve package command approves Package in Endevor for execution.
Usage
zowe endevor approve package [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
options
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Backin a Package in Endevor.
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
-
package
(string)
- Name of the Endevor package.
options
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Backout a Package in Endevor.
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
-
package
(string)
- Name of the Endevor package.
options
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Cast a Package in Endevor.
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
-
package
(string)
- Name of the Endevor package.
options
-
--from-date-time
| --fdt
(string)
- Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--to-date-time
| --tdt
(string)
- Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--validate-components
| --vc
(string)
-
Specify "yes" to enable component validation within the package, "no" to disable, and "warn" to generate a warning if component validation fails.
Allowed values: yes, no, warn
-
--nobackout
| --nb
(boolean)
- Specify this option to NOT have backout facility available for this package.
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Commit a Package in Endevor.
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
-
package
(string)
- Name of the Endevor package.
options
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a Package in Endevor.
The create package command lets you create a package in Endevor.
Usage
zowe endevor create package [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
input sources options
-
--from-file
| --ff
(string)
- Use this input to provide source file.
-
--from-dataset
| --fd
(string)
- Use this input to provide source data set name.
-
--from-member
| --fm
(string)
- Use this input to provide source member name in the data set.
-
--from-package
| --fp
(string)
- Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.
-
--from-text
| --ft
(string)
- Provides a string to use as input SCL.
options
-
--description
| -d
(string)
- Allows you to associate a 50-character description when creating package.
-
--from-date-time
| --fdt
(string)
- Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--to-date-time
| --tdt
(string)
- Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--nobackout
| --nb
(boolean)
- Specify this option to NOT have backout facility available for this package.
-
--notes-from-file
| --nff
(string)
- Local file of notes for approve/deny package.
-
--type
| -t
(string)
-
--sharable
| --sh
(boolean)
- Specify this option if the package can be edited by more than one person when in In-edit status.
-
--append
| -a
(boolean)
- Specify this option to append the SCL you are adding to the existing package SCL. Otherwise it would be replaced.
-
--promotion
| --pr
(boolean)
- Specify this option to define the package as a promotion package.
-
--novalidate-scl
| --nvs
(boolean)
- Specify this option to NOT validate the package components while creating a package.
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete an Element or a Package in Endevor.
The delete element command deletes an Element from the specified inventory location in Endevor.
Usage
zowe endevor delete element <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--proc-group
| --pg
(string)
- The Endevor processor group you would like to use.
-
--override-signout
| --os
(boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--only-components
| --oc
(boolean)
- Applicable for Endevor ACM users only. Indicates whether you want to delete both the Element component list and the Element, or the Element component list only. "No" is the default option
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The delete package command lets you delete Packages of any status type in Endevor.
Usage
zowe endevor delete package [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
options
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Deny a Package in Endevor.
The deny package command changes the status of a Package to Denied.
Usage
zowe endevor deny package [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
options
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Execute a Package in Endevor.
The execute package command executes a Package that have a status of Approved or Execfailed.
Usage
zowe endevor execute package [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
options
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Generate an Element in Endevor.
The generate element command executes the generate Processor for the current level of the Element.
Usage
zowe endevor generate element <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--proc-group
| --pg
(string)
- The Endevor processor group you would like to use.
-
--search
| --sea
(boolean)
- Enables the search through the Endevor map.
-
--copy-back
| --cb
(boolean)
- Specify if you want to copy the current level of the Element back to the FROM Stage, then perform this action. Do not use with --nosource option.
-
--override-signout
| --os
(boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--nosource
| --ns
(boolean)
- Specify if you want to have source-less Element. Do not use with --copy-back option.
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
List instances, elements, types, packages and inventory locations in Endevor.
The list elements command lists element information in Endevor
Usage
zowe endevor list elements [element] [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--path
| --pa
(string)
-
--return
| --ret
(string)
-
--search
| --sea
(boolean)
- Enables the search through the Endevor map.
-
--data
| --dat
(string)
-
Allows to select the type of summary data returned in the element list (defaults to all).
Default value: all
Allowed values: all, bas, ele, comp
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-generate
| --wcg
(string)
- Instructs Endevor to search using the generate CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastact
| --wcla
(string)
- Instructs Endevor to search using the last action CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastlvl
| --wcll
(string)
- Instructs Endevor to search using the last level CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-change
| --wcchg
(string)
- This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-type
| --wpt
(string)
-
Lets you select Elements according to a specified Processor type.
Allowed values: GEN, GENERATE, MOV, MOVE, DEL, DELETE
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
scl generation options
output customization options
-
--full-output
| --fo
(boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages
| --sm
(boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--file-name
| --fn
(string)
- File name for saving output messages from Endevor locally.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list environments command lists environments in Endevor
Usage
zowe endevor list environments [environment] [options]
Positional Arguments
-
environment
(string)
- Name of the Endevor environment.
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
output customization options
-
--full-output
| --fo
(boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages
| --sm
(boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--file-name
| --fn
(string)
- File name for saving output messages from Endevor locally.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list instances command lists instances used by Endevor Web Services
Usage
zowe endevor list instances [options]
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list packages command lists package information in Endevor
Usage
zowe endevor list packages [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
options
-
--status
| --st
(string)
-
Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
It is possible to specify multiple status separated by "," during list and delete package.
Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED
-
--type
| -t
(string)
-
--enterprise
| --ent
(string)
-
--promotion-status
| --ps
(string)
-
--prom-target-env
| --pte
(string)
- Promotion target environment. Specifies the promotion package target environment. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.
-
--prom-target-stgID
| --pts
(string)
- Promotion target stage ID. Specifies the promotion package target stage ID. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.
-
--approver
| --apr
(string)
- Specifies a one to eight character approver ID. Only one approver ID can be specified and name masking is not supported.
output customization options
-
--full-output
| --fo
(boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages
| --sm
(boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--file-name
| --fn
(string)
- File name for saving output messages from Endevor locally.
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list stages command lists stages in Endevor
Usage
zowe endevor list stages [stage] [options]
Positional Arguments
-
stage
(string)
- Name of the Endevor stage
endevor-location definition options
options
output customization options
-
--full-output
| --fo
(boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages
| --sm
(boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--file-name
| --fn
(string)
- File name for saving output messages from Endevor locally.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list subsystems command lists subsystem information in Endevor
Usage
zowe endevor list subsystems [subsystem] [options]
Positional Arguments
-
subsystem
(string)
- Name of the Endevor subsystem
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--stage-number
| --sn
(string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
output customization options
-
--full-output
| --fo
(boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages
| --sm
(boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--file-name
| --fn
(string)
- File name for saving output messages from Endevor locally.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list systems command lists system information in Endevor
Usage
zowe endevor list systems [system] [options]
Positional Arguments
-
system
(string)
- Name of the Endevor system
endevor-location definition options
options
output customization options
-
--full-output
| --fo
(boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages
| --sm
(boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--file-name
| --fn
(string)
- File name for saving output messages from Endevor locally.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
The list types command lists type information in Endevor
Usage
zowe endevor list types [type] [options]
Positional Arguments
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--stage-number
| --sn
(string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
output customization options
-
--full-output
| --fo
(boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages
| --sm
(boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--file-name
| --fn
(string)
- File name for saving output messages from Endevor locally.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Move an Element in Endevor.
The move element command moves Elements between inventory locations along a map.
Usage
zowe endevor move element <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--proc-group
| --pg
(string)
- The Endevor processor group you would like to use.
-
--sync
| -s
(boolean)
- Specify if you want to synchronize source and current level of the Elements while performing this action.
-
--with-history
| --wh
(boolean)
- Specify if you want to preserve the change history of the Elements while performing this action.
-
--bypass-element-delete
| --bed
(boolean)
- Specify if you want to retain the Elements in the source Stage after successfully completing this action.
-
--retain-signout
| --rs
(boolean)
- Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.
-
--signout-to
| --st
(string)
- Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
-
--jump
| -j
(boolean)
- Specify if you want to move Elements across Environments even if those Elements exist at an intermediate Stage that is not on the map, while performing this action.
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Print an Element or a Component in Endevor.
The print component command prints selected component information about Element in Endevor.
Usage
zowe endevor print components <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--level
| --lev
(number)
- Indicates the level number of the element (use along with the version option).
-
--element-version
| --ev
(number)
- Indicates the version number of the element (use along with the level option).
-
--print-comp
| --pc
(string)
-
Specify the type of data to print out for print component command
Default value: browse
Allowed values: browse, changes, history, summary
-
--search
| --sea
(boolean)
- Enables the search through the Endevor map.
-
--noheadings
| --nh
(boolean)
- Specify to not print a header on each page.
-
--explode
| --exp
| --ex
(boolean)
- Specify to print component info from ACMQ.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
output location options
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The print element command prints selected information about Element in Endevor.
Usage
zowe endevor print element <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--level
| --lev
(number)
- Indicates the level number of the element (use along with the version option).
-
--element-version
| --ev
(number)
- Indicates the version number of the element (use along with the level option).
-
--print
(string)
-
Specify the type of data to print out for print element command
Default value: browse
Allowed values: browse, changes, history, summary, master, listing
-
--list-string
| --ls
(string)
- Specifies the one to eight character text-string used to identify the listing data set to print.
-
--search
| --sea
(boolean)
- Enables the search through the Endevor map.
-
--noheadings
| --nh
(boolean)
- Specify to not print a header on each page.
-
--explode
| --exp
| --ex
(boolean)
- Specify to print component info from ACMQ.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
output location options
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Query Elements and information about their components in Endevor.
Query components used by a specified Element with the Endevor ACM Query facility.
Usage
zowe endevor queryacm components <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--excCirculars
| --exc
(boolean)
- Filters the result to exclude components that have a circular relationship to the subject of your search.
-
--excIndirect
| --exi
(boolean)
- Filters the result to exclude indirectly related components.
-
--excRelated
| --exr
(boolean)
- Filters the result to exclude related components.
output customization options
-
--full-output
| --fo
(boolean)
- Specify this option if you want a full output of list action.
-
--suppress-messages
| --sm
(boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--file-name
| --fn
(string)
- File name for saving output messages from Endevor locally.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Reset a Package in Endevor.
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
-
package
(string)
- Name of the Endevor package.
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Retrieve an Element in Endevor.
The retrieve element command retrieves an existing element in Endevor.
Usage
zowe endevor retrieve element <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--element-version
| --ev
(number)
- Indicates the version number of the element (use along with the level option).
-
--level
| --lev
(number)
- Indicates the level number of the element (use along with the version option).
-
--override-signout
| --os
(boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--nosignout
| --nsign
(boolean)
- Specify if you want to perform the action without signing the element out.
-
--replace-member
| --replace
| --rm
(boolean)
- Specify if you want to replace the member currently in the library with the new element contents
-
--expand-includes
| --expand
| --ei
(boolean)
- Indicates that INCLUDE statements should be expanded in the course of the action.
-
--search
| --sea
(boolean)
- Enables the search through the Endevor map.
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
-
--get-fingerprint
| --gfg
(boolean)
output location options
-
--to-file
| --tf
(string)
- File name in which the command output will be stored.
-
--to-path
| --tp
(string)
- Provide a USS path to a destination location.
-
--to-uss-file
| --tuf
(string)
- Provide a USS file as a destination file.
-
--to-dataset
| --td
(string)
- Provide a destination data set name.
-
--to-member
| --tm
(string)
- Provide a destination member name inside the data set.
output customization options
bulk action options
-
--to-dir
| --tdir
(string)
- Directory name in which the command output will be stored.
-
--flat
(boolean)
- Store the output of the bulk action within one folder. When you use this option, ensure that the results do not contain duplicate names. (Duplicate names occur when two or more Elements have the same name and type.)
-
--with-dependencies
| --wd
(boolean)
- Retrieve Elements, including their Endevor-managed input components.
-
--where-ccid-generate
| --wcg
(string)
- Instructs Endevor to search using the generate CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastact
| --wcla
(string)
- Instructs Endevor to search using the last action CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastlvl
| --wcll
(string)
- Instructs Endevor to search using the last level CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-change
| --wcchg
(string)
- Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Retrieve element from specified inventory location to local file with endevor profile set up:
zowe endevor retrieve element elementName --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME --tf localfile.txt -i ENDEVOR
-
Bulk Retrieve elements with wildcarded element name and type, to local directory with endevor profile set up:
zowe endevor retrieve element "*" --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ "*" --to-dir /user/localdir -i ENDEVOR
Signin an Element in Endevor.
The signin element command signs in an existing element in Endevor.
Usage
zowe endevor signin element <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--proc-group
| --pg
(string)
- The Endevor processor group you would like to use.
-
--search
| --sea
(boolean)
- Enables the search through the Endevor map.
-
--override-signout
| --os
(boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--signout-to
| --st
(string)
- Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Submit a Package or a SCL file in Endevor.
The submit package command submits a JCL job stream to execute one or more Packages.
Usage
zowe endevor submit package [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
input sources options
-
--from-file
| --ff
(string)
- Use this input to provide source file.
-
--from-dataset
| --fd
(string)
- Use this input to provide source data set name.
-
--from-member
| --fm
(string)
- Use this input to provide source member name in the data set.
output location options
options
-
--status
| --st
(string)
-
Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
It is possible to specify multiple status separated by "," during list and delete package.
Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED
-
--multiple-streams
| --ms
(boolean)
- Specify to submit a separate, unique job for each package. If you do not specify this, a single job with a unique job step for each package is submitted.
-
--increment-jobname
| --ij
(boolean)
- Specify to increases the last character in the jobcard you provide.
-
--jcl-procedure
| --jp
(string)
- This option lets you to identify the name of the JCL procedure that you want to invoke. ENDEVOR is used by default if any processor is specified.
-
--CA7-dependent-job
| --7dj
(string)
- Specifies a single predecessor job which must complete while demanded job is waiting in the CA7 scheduler.
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The submit scl commands submits a SCL file to be executed.
Usage
zowe endevor submit scl [options]
options
input sources options
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Transfer an Element in Endevor.
The Transfer element command transfers Elements from one Endevor location to another.
Usage
zowe endevor transfer element <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
output location options
-
--to-environment
| --toenv
(string)
- The target Endevor environment.
-
--to-system
| --tosys
(string)
- The target Endevor system.
-
--to-subsystem
| --tosub
(string)
- The target Endevor subsystem.
-
--to-element
| --toele
(string)
- The target Endevor element name.
-
--to-type
| --totyp
(string)
- The target Endevor element type.
-
--to-stage-number
| --tosn
(string)
- The target Endevor stage Id/number.
options
-
--proc-group
| --pg
(string)
- The Endevor processor group you would like to use.
-
--element-version
| --ev
(number)
- Indicates the version number of the element (use along with the level option).
-
--level
| --lev
(number)
- Indicates the level number of the element (use along with the version option).
-
--new-version
| --nv
(number)
- Assign a different version number to the Element.
-
--sync
| -s
(boolean)
- Specify if you want to synchronize source and current level of the Elements while performing this action.
-
--with-history
| --wh
(boolean)
- Specify if you want to preserve the change history of the Elements while performing this action.
-
--ignore-generate-failed
| --igf
(boolean)
- Process the transfer request regardless of whether the FAILED flag is set for the element or if the element was generated or moved successfully.
-
--bypass-element-delete
| --bed
(boolean)
- Specify if you want to retain the Elements in the source Stage after successfully completing this action.
-
--bypass-delete-proc
| --bdp
(boolean)
- Specity to bypasses the execution of the delete processor.
-
--bypass-generate-proc
| --bgp
(boolean)
- Specify to bypasses the execution of the generate or move processor (whichever may be chosen) upon element transfer.
-
--retain-signout
| --rs
(boolean)
- Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.
-
--signout-to
| --st
(string)
- Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.
-
--jump
| -j
(boolean)
- Specify if you want to move Elements across Environments even if those Elements exist at an intermediate Stage that is not on the map, while performing this action.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Update an Element or a Package in Endevor.
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
-
element
(string)
- Name of the Endevor element.
input sources options
-
--from-file
| --ff
(string)
- Use this input to provide source file.
-
--from-dataset
| --fd
(string)
- Use this input to provide source data set name.
-
--from-member
| --fm
(string)
- Use this input to provide source member name in the data set.
-
--from-path
| --fp
(string)
- Use this input to provide the path of source USS file. It must be used with from-uss-file.
-
--from-uss-file
| --fuf
(string)
- Use this input to provide source USS file name. It must be used with from-path
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--override-signout
| --os
(boolean)
- Specify if you want to override the Signout of an Endevor element while performing this action.
-
--proc-group
| --pg
(string)
- The Endevor processor group you would like to use.
-
--generate
| -g
(boolean)
- Specifies if you want to Generate Element after Add/Update action.
-
--get-fingerprint
| --gfg
(boolean)
-
--fingerprint
| --fg
(string)
- Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The update package command lets you update a package in Endevor.
Usage
zowe endevor update package [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
input sources options
-
--from-file
| --ff
(string)
- Use this input to provide source file.
-
--from-dataset
| --fd
(string)
- Use this input to provide source data set name.
-
--from-member
| --fm
(string)
- Use this input to provide source member name in the data set.
-
--from-package
| --fp
(string)
- Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.
-
--from-text
| --ft
(string)
- Provides a string to use as input SCL.
options
-
--description
| -d
(string)
- Allows you to associate a 50-character description when creating package.
-
--from-date-time
| --fdt
(string)
- Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--to-date-time
| --tdt
(string)
- Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.
-
--nobackout
| --nb
(boolean)
- Specify this option to NOT have backout facility available for this package.
-
--notes-from-file
| --nff
(string)
- Local file of notes for approve/deny package.
-
--type
| -t
(string)
-
--sharable
| --sh
(boolean)
- Specify this option if the package can be edited by more than one person when in In-edit status.
-
--append
| -a
(boolean)
- Specify this option to append the SCL you are adding to the existing package SCL. Otherwise it would be replaced.
-
--promotion
| --pr
(boolean)
- Specify this option to define the package as a promotion package.
-
--novalidate-scl
| --nvs
(boolean)
- Specify this option to NOT validate the package components while creating a package.
output customization options
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
View an Element or a Package SCL in Endevor.
The view element command views an existing element in Endevor.
Usage
zowe endevor view element <element> [options]
Positional Arguments
-
element
(string)
- Name of the Endevor element.
endevor-location definition options
-
--environment
| --env
(string)
- The Endevor environment where your project resides.
-
--system
| --sys
(string)
- The Endevor system where your project resides.
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your project resides.
-
--type
| --typ
(string)
- Name of the Endevor element's type.
-
--stage-number
| --sn
(string)
-
--ccid
| --cci
(string)
- The CCID you want to use when performing an Element action.
-
--comment
| --com
(string)
- The comment you want to have when performing an Element action
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
options
-
--element-version
| --ev
(number)
- Indicates the version number of the element (use along with the level option).
-
--level
| --lev
(number)
- Indicates the level number of the element (use along with the version option).
-
--search
| --sea
(boolean)
- Enables the search through the Endevor map.
-
--where-ccid-all
| --wca
(string)
- Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-current
| --wcc
(string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve
| --wcr
(string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-group
| --wpg
(string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
output location options
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
The view pkgscl command views the SCL of an existing package in Endevor.
Usage
zowe endevor view pkgscl [package] [options]
Positional Arguments
-
package
(string)
- Name of the Endevor package.
endevor-location definition options
-
--maxrc
(number)
- The return code of a failed action
-
--instance
| -i
(string)
- Specifies Endevor Web Services dataSource name.
output location options
output customization options
endevor session definition options
-
--host
| --hostname
(string)
- Specifies the base host name.
-
--port
| -p
(string)
- Specifies the port number.
-
--protocol
| --prot
(string)
-
Specifies the protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--user
| --username
(string)
-
--password
| --pass
(string)
- Specifies the user's password.
-
--reject-unauthorized
| --ru
(boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
-
--base-path
| --bp
(string)
- Specifies the base path used for connecting to Endevor Rest API
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--endevor-location-profile
| --endevor-location-p
(string)
- The name of a (endevor-location) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Use the CA Endevor Bridge for Git plug-in to manage your Git-Endevor mappings and build your local Git changes before synchronizing them to Endevor.
Build changes from git local repository in Endevor
Build changes against remote git repository's CA Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.
Usage
zowe endevor-bridge-for-git build execute [options]
Required Options
Endevor work area options
-
--work-area-id
| --waid
(string)
- Endevor work area ID. Name-masking is not allowed.
-
--endevor-subsystem
| --endevorsub
(string)
- The CA Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.
-
--endevor-environment
| --endevorenv
(string)
- The CA Endevor SCM environment where your build subsystem resides.
-
--endevor-system
| --endevorsys
(string)
- The CA Endevor SCM system where your build subsystem resides.
Options
Endevor options (alternatively use an 'endevor' profile)
-
--endevor-protocol
| --endevorprot
(string)
-
--endevor-host
| --endevorh
(string)
- The Endevor Rest API hostname.
-
--endevor-port
| --endevorp
(number)
- The Endevor Rest API port.
-
--endevor-user
| --endevoru
(string)
- Mainframe (Endevor) username, which can be the same as your TSO login.
-
--endevor-password
| --endevorpass
| --endevorpw
(string)
- Mainframe (Endevor) password, which can be the same as your TSO password.
-
--endevor-reject-unauthorized
| --endevorru
(boolean)
-
--endevor-base-path
| --endevorbp
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Compile the changed elements in the current Git working directory using the work area "WORKAREA1" and an existing Endevor profile:
zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --work-area-id WORKAREA1
-
Compile the changed elements in the current Git working directory using the build subsystem "SUBNAME" and an existing Endevor profile:
zowe endevor-bridge-for-git build execute --endevor-instance INSTANCE --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME
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)
-
--endevor-protocol
| --endevorprot
(string)
-
--endevor-host
| --endevorh
(string)
- The Endevor Rest API hostname.
-
--endevor-port
| --endevorp
(number)
- The Endevor Rest API port.
-
--endevor-user
| --endevoru
(string)
- Mainframe (Endevor) username, which can be the same as your TSO login.
-
--endevor-password
| --endevorpass
| --endevorpw
(string)
- Mainframe (Endevor) password, which can be the same as your TSO password.
-
--endevor-reject-unauthorized
| --endevorru
(boolean)
-
--endevor-base-path
| --endevorbp
(string)
z/OSMF connection options (alternatively use a 'zosmf' profile)
-
--zosmf-host
| --zosmfh
(string)
- The z/OSMF server host name.
-
--zosmf-port
| --zosmfp
(number)
-
The z/OSMF server port.
Default value: 443
-
--zosmf-user
| --zosmfu
(string)
- Mainframe (z/OSMF) username, which can be the same as your TSO login.
-
--zosmf-password
| --zosmfpass
| --zosmfpw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--zosmf-reject-unauthorized
| --zosmfru
(boolean)
-
--zosmf-base-path
| --zosmfbp
(string)
- The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
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
-
--work-area-id
| --waid
(string)
- Endevor work area ID. Name-masking is not allowed.
-
--endevor-subsystem
| --endevorsub
(string)
- The CA Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.
-
--endevor-environment
| --endevorenv
(string)
- The CA Endevor SCM environment where your build subsystem resides.
-
--endevor-system
| --endevorsys
(string)
- The CA Endevor SCM system where your build subsystem resides.
Options
-
--work-dir
| --wd
(string)
-
--force-cleanup
| --fc
(boolean)
-
--autogen-span
| --ags
(string)
-
Specifies the autogen action option to automatically generate using elements.
The allowed values which have the following meaning:
NONE - Generates all elements that use the component being acted upon.
ALL - Generates using elements that are found in any System and Subsystem combinations within the Environment and Stage of the component's logical map.
SYSTEMS - Generates using elements that are found in any System, provided the element's Subsystem name matches the name of the Subsystem of the target component.
SUBSYSTEMS - Generates using elements from all Subsystems with the same-named System of the component specified.
Default value: NONE
Allowed values: NONE, ALL, SYSTEMS, SUBSYSTEMS
Endevor options (alternatively use an 'endevor' profile)
-
--endevor-protocol
| --endevorprot
(string)
-
--endevor-host
| --endevorh
(string)
- The Endevor Rest API hostname.
-
--endevor-port
| --endevorp
(number)
- The Endevor Rest API port.
-
--endevor-user
| --endevoru
(string)
- Mainframe (Endevor) username, which can be the same as your TSO login.
-
--endevor-password
| --endevorpass
| --endevorpw
(string)
- Mainframe (Endevor) password, which can be the same as your TSO password.
-
--endevor-reject-unauthorized
| --endevorru
(boolean)
-
--endevor-base-path
| --endevorbp
(string)
z/OSMF connection options (alternatively use a 'zosmf' profile)
-
--zosmf-host
| --zosmfh
(string)
- The z/OSMF server host name.
-
--zosmf-port
| --zosmfp
(number)
-
The z/OSMF server port.
Default value: 443
-
--zosmf-user
| --zosmfu
(string)
- Mainframe (z/OSMF) username, which can be the same as your TSO login.
-
--zosmf-password
| --zosmfpass
| --zosmfpw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--zosmf-reject-unauthorized
| --zosmfru
(boolean)
-
--zosmf-base-path
| --zosmfbp
(string)
- The base path for your API mediation layer instance. Specify this option toprepend the base path to all z/OSMF resources when making REST requests. Do notspecify this option if you are not using an API mediation layer.
Profile Options
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Compile the changed elements at "/endevor/ebg/repository" using work area with ID "WORKAREA1", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:
zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --work-area-id WORKAREA1 --work-dir /endevor/ebg/repository
-
Compile the changed elements at "/endevor/ebg/repository" using build subsystem "SUBNAME", jcl skeleton at "/endevor/jcl/jcl.txt" and existing Endevor and z/OSMF profiles:
zowe endevor-bridge-for-git build job-submit --skeleton-jcl /endevor/jcl/jcl.txt --endevor-subsystem SUBNAME --endevor-environment ENVNAME --endevor-system SYSNAME --work-dir /endevor/ebg/repository
Manage your Endevor credentials stored in CA Endevor Bridge for Git.
Update your Endevor credentials for a Git-Endevor mapping.
Usage
zowe endevor-bridge-for-git endevor-credentials update <context> <mapping> [options]
Positional Arguments
-
context
(string)
- Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
-
mapping
(string)
- Git-Endevor mapping name (ID of the Git repository).
Endevor options (alternatively use an 'endevor' profile)
CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
-
--ebg-profile
| --ebg-p
(string)
- The name of a (ebg) profile to load for this command execution.
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:
zowe endevor-bridge-for-git endevor-credentials update MY-CONTEXT MY-MAPPING
-
Update the Endevor credentials for the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG profile but not using an Endevor profile:
zowe endevor-bridge-for-git endevor-credentials update MY-CONTEXT MY-MAPPING --endevor-user my-user --endevor-password my-password
Manage the Git-Endevor mappings.
Add an element from up the map in your CA Endevor to your Git repository.
Usage
zowe endevor-bridge-for-git mapping add-element <context> <mapping> [options]
Positional Arguments
-
context
(string)
- Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
-
mapping
(string)
- Git-Endevor mapping name (ID of the Git repository).
Options
-
--elementName
| --name
(string)
- The name of the CA Endevor element you want to add.
-
--elementType
| --type
(string)
- The type of the CA Endevor element you want to add
-
--endevor-system
| --endevorsys
(string)
- The CA Endevor system where your element resides.
-
--endevor-subsystem
| --endevorsub
(string)
- The CA Endevor subsystem where your element resides.
-
--withDependencies
(boolean)
-
--force-get-dependencies
| --force
(boolean)
-
--validate
(boolean)
-
--branchId
(string)
- If specified, the requested elements will be added to the selected branch.
-
--all-branches
(boolean)
-
--file
| --fn
(local file path)
- If specified, the elements to add will be read from file. Make sure that the file is in the correct format as specified in the documentation.
Endevor options (alternatively use an 'endevor' profile)
-
--endevor-protocol
| --endevorprot
(string)
-
--endevor-host
| --endevorh
(string)
- The Endevor Rest API hostname.
-
--endevor-port
| --endevorp
(number)
- The Endevor Rest API port.
-
--endevor-user
| --endevoru
(string)
- Mainframe (Endevor) username, which can be the same as your TSO login.
-
--endevor-password
| --endevorpass
| --endevorpw
(string)
- Mainframe (Endevor) password, which can be the same as your TSO password.
-
--endevor-reject-unauthorized
| --endevorru
(boolean)
-
--endevor-base-path
| --endevorbp
(string)
CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
-
--ebg-profile
| --ebg-p
(string)
- The name of a (ebg) profile to load for this command execution.
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a Git-Endevor mapping
Usage
zowe endevor-bridge-for-git mapping create [options]
Options
-
--remote-url
| --url
(string)
- Git repository remote URL
-
--endevor-instance
| --endevori
(string)
- The CA Endevor Web Services dataSource name.
-
--endevor-system
| --endevorsys
(string)
- The CA Endevor system where your project resides.
-
--endevor-subsystem
| --endevorsub
(string)
- The CA Endevor subsystem where your project resides.
-
--endevor-environment
| --endevorenv
(string)
- The CA Endevor environment where your project resides.
-
--branch
| -b
(string)
-
--only-work-environment
(boolean)
-
--read-only
(boolean)
- If specified, it is necessary to use the option --endevor-stage-number. The synchronized elements will be read-only.
-
--endevor-stage-number
| --endevorsn
(string)
- The CA Endevor stage where your project resides (only for read only mappings).
-
--json-file
| --json
(local file path)
- Mapping JSON file to import
Endevor options (alternatively use an 'endevor' profile)
-
--endevor-protocol
| --endevorprot
(string)
-
--endevor-host
| --endevorh
(string)
- The Endevor Rest API hostname.
-
--endevor-port
| --endevorp
(number)
- The Endevor Rest API port.
-
--endevor-user
| --endevoru
(string)
- Mainframe (Endevor) username, which can be the same as your TSO login.
-
--endevor-password
| --endevorpass
| --endevorpw
(string)
- Mainframe (Endevor) password, which can be the same as your TSO password.
-
--endevor-reject-unauthorized
| --endevorru
(boolean)
-
--endevor-base-path
| --endevorbp
(string)
CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
-
--ebg-profile
| --ebg-p
(string)
- The name of a (ebg) profile to load for this command execution.
-
--endevor-profile
| --endevor-p
(string)
- The name of a (endevor) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Create the Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:
zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME
-
Create the read-only Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:
zowe endevor-bridge-for-git mapping create --remote-url https://git-server-enterprise.com/my-context/my-mapping.git --endevor-instance INSTANCE --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME --read-only --endevor-stage-number 2
-
Create the Git-Endevor mapping with importing a mapping file:
zowe endevor-bridge-for-git mapping create --json-file my-mapping.json
Delete a Git-Endevor mapping
Usage
zowe endevor-bridge-for-git mapping delete <context> <mapping> [options]
Positional Arguments
-
context
(string)
- Git-Endevor mapping context (ID of the organization, project, team or owner of the Git repository).
-
mapping
(string)
- Git-Endevor mapping name (ID of the Git repository).
CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
Base Connection Options
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
--view
| -v
(string)
-
Type of detail to be displayed.
Default value: default
Allowed values: default, endevor, all
-
--export
(boolean)
CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
Base Connection Options
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List all the Git-Endevor mappings using the default EBG profile:
zowe endevor-bridge-for-git mapping list
-
List all the Git-Endevor mappings and show their Endevor details using the default EBG profile:
zowe endevor-bridge-for-git mapping list --view endevor
-
List all the Git-Endevor mappings and show all their details using the default EBG profile:
zowe endevor-bridge-for-git mapping list --view all
-
List all the Git-Endevor mappings without an EBG profile:
zowe endevor-bridge-for-git mapping list --protocol http --host my-host --port 8080 --user my-git-username --token 1234567890
Use an Endevor work area from the list defined by your administrator.
List Endevor work areas.
Usage
zowe endevor-bridge-for-git work-area list [work-area-id] [options]
Positional Arguments
-
work-area-id
(string)
- Specify to list only one Endevor work area ID. Name-masking is not allowed.
Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
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
-
work-area-id
(string)
- Reserve the Endevor work area with the ID specified. Name-masking is not allowed.
Required Options
Options
Endevor options (alternatively use an 'endevor' profile)
-
--endevor-protocol
| --endevorprot
(string)
-
--endevor-host
| --endevorh
(string)
- The Endevor Rest API hostname.
-
--endevor-port
| --endevorp
(number)
- The Endevor Rest API port.
-
--endevor-user
| --endevoru
(string)
- Mainframe (Endevor) username, which can be the same as your TSO login.
-
--endevor-password
| --endevorpass
| --endevorpw
(string)
- Mainframe (Endevor) password, which can be the same as your TSO password.
-
--endevor-reject-unauthorized
| --endevorru
(boolean)
-
--endevor-base-path
| --endevorbp
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Reserve the first found available Endevor work area using an existing Endevor profile:
zowe endevor-bridge-for-git work-area reserve --endevor-instance ENDEVOR
-
Reserve the work area with ID "WORKAREA1", if available, using an existing Endevor profile:
zowe endevor-bridge-for-git work-area reserve WORKAREA1 --endevor-instance ENDEVOR
Unreserve an Endevor work area.
Usage
zowe endevor-bridge-for-git work-area unreserve <work-area-id> [options]
Positional Arguments
-
work-area-id
(string)
- Endevor work area ID. Name-masking is not allowed.
Required Options
Options
Endevor options (alternatively use an 'endevor' profile)
-
--endevor-protocol
| --endevorprot
(string)
-
--endevor-host
| --endevorh
(string)
- The Endevor Rest API hostname.
-
--endevor-port
| --endevorp
(number)
- The Endevor Rest API port.
-
--endevor-user
| --endevoru
(string)
- Mainframe (Endevor) username, which can be the same as your TSO login.
-
--endevor-password
| --endevorpass
| --endevorpw
(string)
- Mainframe (Endevor) password, which can be the same as your TSO password.
-
--endevor-reject-unauthorized
| --endevorru
(boolean)
-
--endevor-base-path
| --endevorbp
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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.
Copy data from a data set and optionally filter or modify the copied data by using selection criteria.
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
-
from
(string)
- Specifies the name of the data set to copy from.
-
to
(string)
- Specifies the name of the data set to copy to.
Options
-
--members
| -m
(array)
- Specifies the members that you want to copy from the data set. To rename the member, specify a new member name after the delimiter ','.If this parameter is not specified all the members are copied.
Note: This parameter only applies to a PDS or PDSE.
Example: --mem mem1,newmem1 mem2. Here 'mem2' is copied as it is, and 'mem1' is renamed as 'newmem1'.
-
--generation
| -g
(string)
- Specifies the PDSE V2 generation number that you want to copy from the data set from.
Note: This parameter should only be specified if data set from is PDSEV2. If not specified and data set from is a PDSE V2 then current generation, i.e. generation 0, is copied. If generation is negative specifies Relative generation, positive specifies Absolute generation, * specifies all generations and 0 specifies current generation.
Example1: --generation *. All generations of member(s) is copied.
Example2: --generation -1. Relative generation -1 of member(s) is copied.
Example3: --generation 4. Absolute generation 4 of member(s) is copied.
Allowed values: '*','range from -2000000000 to 2000000000'
-
--replace
| -r
(string)
-
Replace resource-specific items in the target data set. Note: Used only if the target data set is a PDS or a VSAM KSDS.
Example: -r n.
Default value: y
Allowed values: y, n
-
--static-selection-criteria
| --ssc
(string)
- Specifies the name of pre-defined File Master Plus selection criteria. The name refers to a member in the defaultselection criteria data set as defined in the FMM_CLIST parameter in File Master Plus server.
Example: --ssc testcri
-
--dynamic-selection-criteria
| --dsc
(string)
- Specifies path of the .txt file where the dynamic selection criteria exist. Ensure the format of the file is identical to the static selection criteria created by File Master Plus. If the selection criteria refer to field names in a Cobol or PL/I copybook, use the --layout-member and --layout-data-set parameters to name the copybook location.
Example: --dsc ../selcri/testcri.txt
-
--layout-member
| --lm
(string)
- Specifies name of the Cobol or PL/I copybook.
Example: -lm testlay.
-
--layout-data-set
| --lds
(string)
- Specifies name of the data set that contains the layout member.
Example: -lds fmmvs.layout.dataset.
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a data set.
Create a large format sequential data set.
Usage
zowe file-master-plus create large-format-sequential <name> [options]
Positional Arguments
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a model large format sequential data set name for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--logical-record-length
| --lrecl
| --lrl
(number)
- Specifies the length of the logical record.
Allowed values: 1-32760
Default value: 80
Example: --lrecl 80
-
--block-size
| --blksize
| --bs
(number)
- Specifies the size of the block of records.
Allowed values: 1-32760
Default value: 6160
Example: --blksize 6160
-
--record-format
| --recfm
| --rf
(string)
-
Specifies the record format.
The allowed values which have the following meaning:
F - Fixed-length records
V - Variable-length records
U - Undefined-length records
B - Records are blocked
A - Records contain ASCII printer control characters
M - Records contain machine code control characters
S - For variable-length records, records may span blocks
T - Records may be written into overflow tracks
Default value: FB
Example: --recfm FB
Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT
-
--space-units
| --su
(string)
-
Specifies the space allocation unit.
The allowed values which have the following meaning:
TRK - Tracks
CYL - Cylinders
BLK - Blocksize
Default value: CYL
Example: --su blk
Allowed values: TRK, CYL, BLK
-
--primary-space
| --ps
(number)
- Specifies primary space allocation unit.
Allowed values: 1-16777215
Default value: 1
Example: --ps 3
-
--secondary-space
| --ss
(number)
- Specifies secondary space allocation unit.
Allowed values: 1-16777215
Default value: 1
Example: --ss 5
-
--volume
| -v
(array)
- Specifies a disk volume or specific tapes.
Example: -v vol002
-
--unit-type
| --ut
(string)
- Specifies the DASD unit name.
Example: --ut sysda
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a large format sequential data set with default option values:
zowe file-master-plus create large-format-sequential fmmvs.test.dsname
-
Creating a large format sequential data set with options:
zowe file-master-plus create large-format-sequential fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
-
Creating a large format sequential data set like a model large format sequential data set:
zowe file-master-plus create large-format-sequential fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a large format sequential data set like a model large format sequential data set and overriding the parameters with options:
zowe file-master-plus create large-format-sequential fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm VB --ps 5 --ss 5 --ed p
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
-
name
(string)
- Specifies the name of the data set to create.
-
model
(string)
- Specifies the name of the model data set.
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a partitioned data set.
Usage
zowe file-master-plus create partitioned-data-set <name> [options]
Positional Arguments
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a model partitioned data set for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--logical-record-length
| --lrecl
| --lrl
(number)
- Specifies the length of the logical record.
Allowed values: 1-32760
Default value: 80
Example: --lrecl 80
-
--block-size
| --blksize
| --bs
(number)
- Specifies the size of the block of records.
Allowed values: 1-32760
Default value: 6160
Example: --blksize 6160
-
--record-format
| --recfm
| --rf
(string)
-
Specifies the record format.
The allowed values have the following meaning:
F - Fixed-length records
V - Variable-length records
U - Undefined-length records
B - Records are blocked
A - Records contain ASCII printer control characters
M - Records contain machine code control characters
S - For variable-length records, records may span blocks
T - Records may be written into overflow tracks
Default value: FB
Example: --recfm FB
Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT
-
--space-units
| --su
(string)
-
Specifies the space allocation unit.
The allowed values which have the following meaning:
TRK - Tracks
CYL - Cylinders
BLK - Blocksize
Default value: CYL
Example: --su blk
Allowed values: TRK, CYL, BLK
-
--primary-space
| --ps
(number)
- Specifies the primary space allocation unit.
Allowed values: 1-16777215
Default value: 1
Example: --ps 3
-
--secondary-space
| --ss
(number)
- Specifies the secondary space allocation unit.
Allowed values: 1-16777215
Default value: 1
Example: --ss 5
-
--directory-blocks
| --db
(number)
- Specifies number of directory blocks.
Allowed values: 1-16777215
Default value: 5
Example: --db 5
-
--volume
| -v
(string)
- Specifies a disk volume or specific tapes.
Example: -v vol002
-
--unit-type
| --ut
(string)
- Specifies the DASD unit name.
Example: --ut sysda
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a PDS with default option values:
zowe file-master-plus create partitioned-data-set fmmvs.test.dsname
-
Creating a PDS with options:
zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --su trk --ed p
-
Creating a PDS like a model PDS:
zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a PDS like a model PDS and overriding the parameters with options:
zowe file-master-plus create partitioned-data-set fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --ed 2025-09-27
Create an extended partitioned data set.
Usage
zowe file-master-plus create partitioned-data-set-extended <name> [options]
Positional Arguments
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a model extentded partitioned data set name for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--data-set-version
| --dsv
| --ver
(number)
-
--generations
| -g
(number)
- Specifies the number of generations.
Applicable when data set version is '2'.
Default value: 0
Example: -g 10
-
--logical-record-length
| --lrecl
| --lrl
(number)
- Specifies the length of the logical record.
Allowed values: 1-32760
Default value: 80
Example: --lrecl 80
-
--block-size
| --blksize
| --bs
(number)
- Specifies the size of the block of records.
Allowed values: 1-32760
Default value: 6160
Example: --blksize 6160
-
--record-format
| --recfm
| --rf
(string)
-
Specifies the record format.
The allowed values which have the following meaning:
F - Fixed-length records
V - Variable-length records
U - Undefined-length records
B - Records are blocked
A - Records contain ASCII printer control characters
M - Records contain machine code control characters
S - For variable-length records, records may span blocks
T - Records may be written into overflow tracks
Default value: FB
Example: --recfm FB
Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT
-
--space-units
| --su
(string)
-
Specifies the space allocation unit.
The allowed values have the following meaning:
TRK - Tracks
CYL - Cylinders
BLK - Blocksize
Default value: CYL
Example: --su blk
Allowed values: TRK, CYL, BLK
-
--primary-space
| --ps
(number)
- Specifies primary space allocation unit.
Allowed values: 1-16777215
Default value: 1
Example: --ps 3
-
--secondary-space
| --ss
(number)
- Specifies secondary space allocation unit.
Allowed values: 1-16777215
Default value: 1
Example: --ss 5
-
--volume
| -v
(string)
- Specifies a disk volume or specific tapes.
Example: -v vol002
-
--unit-type
| --ut
(string)
- Specifies the DASD unit name.
Example: --ut sysda
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a PDSE with default option values:
zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname
-
Creating a PDSE version 2 with options:
zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --ver 2 -g 10 --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
-
Creating a PDSE data set like a model PDSE:
zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a PDSE like a model PDSE and the parameters with options:
zowe file-master-plus create partitioned-data-set-extended fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm vb --ps 5 --ss 5 --db 5 -v vol005 --ed p
Create a physical sequential data set.
Usage
zowe file-master-plus create physical-sequential <name> [options]
Positional Arguments
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a model physical sequential data set name for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--logical-record-length
| --lrecl
| --lrl
(number)
- Specifies the length of the logical record.
Allowed values: 1-32760
Default value: 80
Example: --lrecl 80
-
--block-size
| --blksize
| --bs
(number)
- Specifies the size of the block of records.
Allowed values: 1-32760
Default value: 6160
Example: --blksize 6160
-
--record-format
| --recfm
| --rf
(string)
-
Specifies the record format.
The allowed values which have the following meaning:
F - Fixed-length records
V - Variable-length records
U - Undefined-length records
B - Records are blocked
A - Records contain ASCII printer control characters
M - Records contain machine code control characters
S - For variable-length records, records may span blocks
T - Records may be written into overflow tracks
Default value: FB
Example: --recfm FB
Allowed values: F, FA, FM, FB, FBA, FBM, FS, FSA, FSM, FT, FTA, FTM, FBS, FBT, U, UA, UM, UT, UTA, UTM, V, VA, VM, VB, VBA, VBM, VS, VSA, VSM, VT, VTA, VTM, VBS, VBT
-
--space-units
| --su
(string)
-
Specifies the space allocation unit.
The allowed values which have the following meaning:
TRK - Tracks
CYL - Cylinders
BLK - Blocksize
Default value: CYL
Example: --su blk
Allowed values: TRK, CYL, BLK
-
--primary-space
| --ps
(number)
- Specifies primary space allocation unit.
Allowed values: 1-16777215
Default value: 1
Example: --ps 3
-
--secondary-space
| --ss
(number)
- Specifies secondary space allocation unit.
Allowed values: 1-16777215
Default value: 1
Example: --ss 5
-
--volume
| -v
(array)
- Specifies a disk volume or specific tapes.
Example: -v vol002
-
--unit-type
| --ut
(string)
- Specifies the DASD unit name.
Example: --ut sysda
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a physical sequential data set with default option values:
zowe file-master-plus create physical-sequential fmmvs.test.dsname
-
Creating a physical sequential data set with options:
zowe file-master-plus create physical-sequential fmmvs.test.dsname --lrecl 180 --blksize 32720 --recfm vb --ps 5 --ss 5 -v vol005 --su trk --ed 2025-09-27
-
Creating a physical sequential data set like a model physical sequential data set:
zowe file-master-plus create physical-sequential fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a physical sequential data set like a model physical sequential data set and overriding the parameters with options:
zowe file-master-plus create physical-sequential fmmvs.test.dsname --model fmmvs.model.dsname --lrecl 180 --recfm VB --ps 5 --ss 5 --ed p
Create an entry-sequenced Virtual Storage Access Method (VSAM) data set (ESDS).
Usage
zowe file-master-plus create vsam-esds <name> [options]
Positional Arguments
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a ESDS (entry-sequenced VSAM data set) for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--maximum-record-size
| --mrs
(number)
- Specifies the maximum length of data records.
This parameter is mandatory unless a model data set is specified.
Example: --mrs 180
-
--average-record-size
| --ars
(number)
- Specifies the average length of data records.
If this parameter is not specified then it is set to the same as the maximum-record-size option.
Example: --ars 110
-
--data-dsname
| --ddsn
(string)
- Specifies the data set name of the data VSAM component.
If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
Example: --ddsn fmmvs.vsam.esds.data
-
--data-control-interval-size
| --dcis
(number)
- Specifies the size of the Control Interval for the data VSAM component.
Default value: 20480
Example: --dcis 3584
-
--data-space-units
| --dsu
(string)
-
Specifies the space allocation unit for data vsam component.
The allowed values have the following meaning:
TRK - Tracks
CYL - Cylinders
REC - Records
K - Kilobytes
M - Megabytes
Default value: TRK
Example: --dsu rec
Allowed values: TRK, CYL, REC, K, M
-
--data-primary-space
| --dps
(number)
- Specifies the primary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 18
Example: --dps 3
-
--data-secondary-space
| --dss
(number)
- Specifies the secondary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 3
Example: --dss 5
-
--data-volume
| --dv
(array)
- Specifies a disk volume or specific tapes for the data VSAM component.
Example: -dv vol002
-
--buffer-space
| --bs
(number)
- Specifies the minimum buffer space to allocate when this VSAM file is accessed.
Example: --bs 37376
-
--erase
| -e
(string)
-
Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
Default value: n
Example: -e y
Allowed values: y, n
-
--load-restartable
| --lr
(string)
-
Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
Default value: n
Example: -lr y
Allowed values: y, n
-
--reuse
| -r
(string)
-
--spanned
| -s
(string)
-
--write-check
| --wc
(string)
-
--control-interval-freespace-percentage
| --cifp
(number)
- Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
Example: --cifp 10
-
--control-area-freespace-percentage
| --cafp
(number)
- Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
Example: --cafp 10
-
--cross-region-share-option
| --crso
(number)
-
Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
The allowed values have the following meaning:
1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
3 - The data set can be fully shared by any number of users.
4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
Default value: 1
Example: --crso 2
Allowed values: 1, 2, 3, 4
-
--cross-system-share-option
| --csso
(number)
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
-
--log
| -l
(string)
-
When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
Example: --log ALL
Allowed values: NONE, UNDO, ALL
-
--frlog
| --fr
(string)
-
Specifies the type of VSAM batch logging to perform for this VSAM data set.
The allowed values have the following meaning:
NONE - Disables VSAM batch logging.
REDO - Enables VSAM batch logging.
UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
Example: --frlog ALL
Allowed values: NONE, UNDO, ALL, REDO
-
--log-replicate
| --lrp
(string)
-
--log-stream-id
| --lsi
(string)
- Specifies the 1- to 26-character name of the forward recovery log stream.
Example: --lsi LOGSTRA
-
--rls-enable
| --rls
| --re
(string)
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a ESDS with default option values and mandatory options:
zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160
-
Creating a ESDS with options:
zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed 2025-09-27
-
Creating a RLS enabled ESDS with logging options:
zowe file-master-plus create vsam-esds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --rls y -l all --lsi loga --lrp y --fr ALL
-
Creating a ESDS data set like a model ESDS data set:
zowe file-master-plus create vsam-esds fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a ESDS like a model ESDS data set and overriding the parameters with options:
zowe file-master-plus create vsam-esds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
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
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a model KSDS (key-sequenced VSAM data set) for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--keys-position
| --kp
(number)
- Specifies the position of the key within the base cluster.
This parameter is mandatory unless a model data set is specified.
Example: --kp 1
-
--keys-length
| --kl
(number)
- Specifies the length of the key within the base cluster.
This parameter is mandatory unless a model data set is specified.
Example: --kl 7
-
--maximum-record-size
| --mrs
(number)
- Specifies the maximum length of data records.
This parameter is mandatory unless a model data set is specified.
Example: --mrs 180
-
--average-record-size
| --ars
(number)
- Specifies the average length of data records.
If this parameter is not specified then it is set to the same as the maximum-record-size option.
Example: --ars 110
-
--data-dsname
| --ddsn
(string)
- Specifies the data set name of the data VSAM component.
If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
Example: --ddsn fmmvs.vsam.ksds.data
-
--data-control-interval-size
| --dcis
(number)
- Specifies the size of the Control Interval for the data VSAM component.
Default value: 20480
Example: --dcis 3584
-
--data-space-units
| --dsu
(string)
-
Specifies the space allocation unit for data vsam component.
The allowed values have the following meaning:
TRK - Tracks
CYL - Cylinders
REC - Records
K - Kilobytes
M - Megabytes
Default value: TRK
Example: --dsu rec
Allowed values: TRK, CYL, REC, K, M
-
--data-primary-space
| --dps
(number)
- Specifies the primary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 18
Example: --dps 3
-
--data-secondary-space
| --dss
(number)
- Specifies the secondary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 3
Example: --dss 5
-
--data-volume
| --dv
(array)
- Specifies a disk volume or specific tapes for the data VSAM component.
Example: -dv vol002
-
--index-dsname
| --idsn
(string)
- Specifies the data set name of the index VSAM component.
If this parameter is not specified then it is set to the cluster name with ‘.INDEX’ appended.
Example: --ddsn fmmvs.vsam.ksds.index
-
--index-control-interval-size
| --icis
(number)
- Specifies the size of Control Interval for index VSAM component.
Default value: 512
Example: --icis 3584
-
--index-space-units
| --isu
(string)
-
Specifies the space allocation unit for index VSAM component.
The allowed values have the following meaning:
TRK - Tracks
CYL - Cylinders
REC - Records
K - Kilobytes
M - Megabytes
Default value: TRK
Example: --isu cyl
Allowed values: TRK, CYL, REC, K, M
-
--index-primary-space
| --ips
(number)
- Specifies primary space allocation unit for index VSAM component.
Allowed values: 1-16777215
Default value: 1
Example: --ips 3
-
--index-secondary-space
| --iss
(number)
- Specifies secondary space allocation unit for index VSAM component.
Allowed values: 1-16777215
Default value: 1
Example: --iss 5
-
--index-volume
| --iv
(array)
- Specifies a disk volume or specific tapes for the index VSAM component.
Example: -iv vol002
-
--buffer-space
| --bs
(number)
- Specifies the minimum buffer space to allocate when this VSAM file is accessed.
Example: --bs 37376
-
--erase
| -e
(string)
-
Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
Default value: n
Example: -e y
Allowed values: y, n
-
--load-restartable
| --lr
(string)
-
Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
Default value: n
Example: -lr y
Allowed values: y, n
-
--reuse
| -r
(string)
-
--spanned
| -s
(string)
-
--write-check
| --wc
(string)
-
--control-interval-freespace-percentage
| --cifp
(number)
- Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
Example: --cifp 10
-
--control-area-freespace-percentage
| --cafp
(number)
- Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
Example: --cafp 10
-
--cross-region-share-option
| --crso
(number)
-
Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
The allowed values have the following meaning:
1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
3 - The data set can be fully shared by any number of users.
4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
Default value: 1
Example: --crso 2
Allowed values: 1, 2, 3, 4
-
--cross-system-share-option
| --csso
(number)
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
-
--log
| -l
(string)
-
When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
Example: --log ALL
Allowed values: NONE, UNDO, ALL
-
--frlog
| --fr
(string)
-
Specifies the type of VSAM batch logging to perform for this VSAM data set.
The allowed values have the following meaning:
NONE - Disables VSAM batch logging.
REDO - Enables VSAM batch logging.
UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
Example: --frlog ALL
Allowed values: NONE, UNDO, ALL, REDO
-
--log-replicate
| --lrp
(string)
-
--log-stream-id
| --lsi
(string)
- Specifies the 1- to 26-character name of the forward recovery log stream.
Example: --lsi LOGSTRA
-
--rls-enable
| --rls
| --re
(string)
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a KSDS with default option values and mandatory options:
zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160
-
Creating a KSDS with options:
zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y -s n --ed 2025-09-27
-
Creating a RLS enabled KSDS with logging options:
zowe file-master-plus create vsam-ksds fmmvs.test.dsname --kp 1 --kl 7 --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y -s n --rls y -l all --lsi loga --lrp y --fr ALL
-
Creating a KSDS data set like a model KSDS data set:
zowe file-master-plus create vsam-ksds fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a KSDS like a model KSDS data set and overriding the parameters with options:
zowe file-master-plus create vsam-ksds fmmvs.test.dsname --model fmmvs.model.dsname --kp 1 --kl 7 --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
Create linear data set (LDS) Virtual Storage Access Method (VSAM) data set.
Usage
zowe file-master-plus create vsam-lds <name> [options]
Positional Arguments
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a model LDS (Linear VSAM data set) for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--data-dsname
| --ddsn
(string)
- Specifies the data set name of the data VSAM component.
If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
Example: --ddsn fmmvs.vsam.esds.data
-
--data-control-interval-size
| --dcis
(number)
- Specifies the size of the Control Interval for the data VSAM component.
Default value: 4096
Example: --dcis 3584
-
--data-space-units
| --dsu
(string)
-
Specifies the space allocation unit for data vsam component.
The allowed values have the following meaning:
TRK - Tracks
CYL - Cylinders
REC - Records
K - Kilobytes
M - Megabytes
Default value: TRK
Example: --dsu rec
Allowed values: TRK, CYL, REC, K, M
-
--data-primary-space
| --dps
(number)
- Specifies the primary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 18
Example: --dps 3
-
--data-secondary-space
| --dss
(number)
- Specifies the secondary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 3
Example: --dss 5
-
--data-volume
| --dv
(array)
- Specifies a disk volume or specific tapes for the data VSAM component.
Example: -dv vol002
-
--buffer-space
| --bs
(number)
- Specifies the minimum buffer space to allocate when this VSAM file is accessed.
Example: --bs 37376
-
--erase
| -e
(string)
-
Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
Default value: n
Example: -e y
Allowed values: y, n
-
--load-restartable
| --lr
(string)
-
Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
Default value: n
Example: -lr y
Allowed values: y, n
-
--reuse
| -r
(string)
-
--write-check
| --wc
(string)
-
--control-interval-freespace-percentage
| --cifp
(number)
- Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
Example: --cifp 10
-
--control-area-freespace-percentage
| --cafp
(number)
- Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
Example: --cafp 10
-
--cross-region-share-option
| --crso
(number)
-
Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
The alloweThe allowed values have the following meaning:
1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
3 - The data set can be fully shared by any number of users.
4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
Default value: 1
Example: --crso 2
Allowed values: 1, 2, 3, 4
-
--cross-system-share-option
| --csso
(number)
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a LDS with default option values:
zowe file-master-plus create vsam-lds fmmvs.test.dsname
-
Creating a LDS with options:
zowe file-master-plus create vsam-lds fmmvs.test.dsname --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p
-
Creating a LDS data set like a model LDS data set:
zowe file-master-plus create vsam-lds fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a LDS like a model LDS data set and overriding the parameters with options:
zowe file-master-plus create vsam-lds fmmvs.test.dsname --model fmmvs.model.dsname --wc y --bs 37376 --crso 3 --csso 4 --ed 2025-09-27
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
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a model RRDS (relative-record VSAM data set) for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--maximum-record-size
| --mrs
(number)
- Specifies the maximum length of data records.
This parameter is mandatory unless a model data set is specified.
Example: --mrs 180
-
--data-dsname
| --ddsn
(string)
- Specifies the data set name of the data VSAM component.
If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
Example: --ddsn fmmvs.vsam.rrds.data
-
--data-control-interval-size
| --dcis
(number)
- Specifies the size of the Control Interval for the data VSAM component.
Default value: 20480
Example: --dcis 3584
-
--data-space-units
| --dsu
(string)
-
Specifies the space allocation unit for data vsam component.
The allowed values have the following meaning:
TRK - Tracks
CYL - Cylinders
REC - Records
K - Kilobytes
M - Megabytes
Default value: TRK
Example: --dsu rec
Allowed values: TRK, CYL, REC, K, M
-
--data-primary-space
| --dps
(number)
- Specifies the primary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 18
Example: --dps 3
-
--data-secondary-space
| --dss
(number)
- Specifies the secondary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 3
Example: --dss 5
-
--data-volume
| --dv
(array)
- Specifies a disk volume or specific tapes for the data VSAM component.
Example: -dv vol002
-
--buffer-space
| --bs
(number)
- Specifies the minimum buffer space to allocate when this VSAM file is accessed.
Example: --bs 37376
-
--erase
| -e
(string)
-
Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
Default value: n
Example: -e y
Allowed values: y, n
-
--load-restartable
| --lr
(string)
-
Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
Default value: n
Example: -lr y
Allowed values: y, n
-
--reuse
| -r
(string)
-
--write-check
| --wc
(string)
-
--control-interval-freespace-percentage
| --cifp
(number)
- Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
Example: --cifp 10
-
--control-area-freespace-percentage
| --cafp
(number)
- Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
Example: --cafp 10
-
--cross-region-share-option
| --crso
(number)
-
Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
The allowed values have the following meaning:
1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
3 - The data set can be fully shared by any number of users.
4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
Default value: 1
Example: --crso 2
Allowed values: 1, 2, 3, 4
-
--cross-system-share-option
| --csso
(number)
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
-
--log
| -l
(string)
-
When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
Example: --log ALL
Allowed values: NONE, UNDO, ALL
-
--frlog
| --fr
(string)
-
Specifies the type of VSAM batch logging to perform for this VSAM data set.
The allowed values have the following meaning:
NONE - Disables VSAM batch logging.
REDO - Enables VSAM batch logging.
UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
Example: --frlog ALL
Allowed values: NONE, UNDO, ALL, REDO
-
--log-replicate
| --lrp
(string)
-
--log-stream-id
| --lsi
(string)
- Specifies the 1- to 26-character name of the forward recovery log stream.
Example: --lsi LOGSTRA
-
--rls-enable
| --rls
| --re
(string)
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a RRDS with default option values and mandatory options:
zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160
-
Creating a RRDS with options:
zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p
-
Creating a RLS enabled RRDS with logging options:
zowe file-master-plus create vsam-rrds fmmvs.test.dsname --mrs 160 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --bs 37376 -e y -r y -s n --ed p --rls y -l all --lsi loga --lrp y --fr ALL
-
Creating a RRDS data set like a model RRDS data set:
zowe file-master-plus create vsam-rrds fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a RRDS like a model RRDS data set and overriding the parameters with options:
zowe file-master-plus create vsam-rrds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed 2025-09-27
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
-
name
(string)
- Specifies the name of the data set to create.
Options
-
--model
| -m
(string)
- Specifies the name of a model VRRDS (variable-length relative-record VSAM data set) for allocating parameters.
The parameters of the model data set override all defaults.
Example: -m fmmvs.model.dsname
-
--maximum-record-size
| --mrs
(number)
- Specifies the maximum length of data records.
This parameter is mandatory unless a model data set is specified and it should be greater than the average record size.
Example: --mrs 180
-
--average-record-size
| --ars
(number)
- Specifies the average length of data records.
This parameter is mandatory unless a model data set is specified and it should be less than the maximum record size.
Example: --ars 110
-
--data-dsname
| --ddsn
(string)
- Specifies the data set name of the data VSAM component.
If this parameter is not specified then by default it is set to the cluster name with ‘.DATA’.
Example: --ddsn fmmvs.vsam.ksds.data
-
--data-control-interval-size
| --dcis
(number)
- Specifies the size of the Control Interval for the data VSAM component.
Default value: 20480
Example: --dcis 3584
-
--data-space-units
| --dsu
(string)
-
Specifies the space allocation unit for data vsam component.
The allowed values have the following meaning:
TRK - Tracks
CYL - Cylinders
REC - Records
K - Kilobytes
M - Megabytes
Default value: TRK
Example: --dsu rec
Allowed values: TRK, CYL, REC, K, M
-
--data-primary-space
| --dps
(number)
- Specifies the primary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 18
Example: --dps 3
-
--data-secondary-space
| --dss
(number)
- Specifies the secondary space allocation unit for the data VSAM component.
Allowed values: 1-16777215
Default value: 3
Example: --dss 5
-
--data-volume
| --dv
(array)
- Specifies a disk volume or specific tapes for the data VSAM component.
Example: -dv vol002
-
--index-dsname
| --idsn
(string)
- Specifies the data set name of the index VSAM component.
If this parameter is not specified then it is set to the cluster name with ‘.INDEX’ appended.
Example: --ddsn fmmvs.vsam.ksds.index
-
--index-control-interval-size
| --icis
(number)
- Specifies the size of Control Interval for index VSAM component.
Default value: 512
Example: --icis 3584
-
--index-space-units
| --isu
(string)
-
Specifies the space allocation unit for index VSAM component.
The allowed values have the following meaning:
TRK - Tracks
CYL - Cylinders
REC - Records
K - Kilobytes
M - Megabytes
Default value: TRK
Example: --isu cyl
Allowed values: TRK, CYL, REC, K, M
-
--index-primary-space
| --ips
(number)
- Specifies primary space allocation unit for index VSAM component.
Allowed values: 1-16777215
Default value: 1
Example: --ips 3
-
--index-secondary-space
| --iss
(number)
- Specifies secondary space allocation unit for index VSAM component.
Allowed values: 1-16777215
Default value: 1
Example: --iss 5
-
--index-volume
| --iv
(array)
- Specifies a disk volume or specific tapes for the data VSAM component.
Example: -iv vol002
-
--buffer-space
| --bs
(number)
- Specifies the minimum buffer space to allocate when this VSAM file is accessed.
Example: --bs 37376
-
--erase
| -e
(string)
-
Indicates whether the VSAM file was allocated with the ERASE parameter, causing all components of the file to be overwritten with binary zeros, when the VSAM file is deleted from the catalog.
Default value: n
Example: -e y
Allowed values: y, n
-
--load-restartable
| --lr
(string)
-
Specify 'Y' to request that the VSAM component definition use the 'RECOVERY' parameter (which causes the data component to be preformatted previous to the initial load). Using this option causes the initial load to take longer, but loads which do not complete successfully can be restarted.
Specify 'N' to request that the VSAM component definition use the 'SPEED' parameter (which causes the data component to NOT be preformatted previous to the initial load).
Default value: n
Example: -lr y
Allowed values: y, n
-
--reuse
| -r
(string)
-
--write-check
| --wc
(string)
-
--control-interval-freespace-percentage
| --cifp
(number)
- Specifies the percentage of empty space in each control interval when the file is initially loaded.The free space lets records be inserted or expanded within a control interval before requiring a control interval split.
Example: --cifp 10
-
--control-area-freespace-percentage
| --cafp
(number)
- Specifies the percentage of control intervals to be left unused in each control area as the file is initially loaded. The use of control area free space lets some control interval splits occur before requiring a control area split.
Example: --cafp 10
-
--cross-region-share-option
| --crso
(number)
-
Specifies that the file can be shared among regions within the same system or within multiple systems using GRS (Global Resource Serialization).
The allowed values have the following meaning:
1 - The data set can be opened for read processing by an unlimited number of users, but the data set can be accessed by only one user when that user is doing read and write processing.
2 - The data set can be opened by only one user at a time for read and write processing, but any number of users can also be accessing the data set for read processing
3 - The data set can be fully shared by any number of users.
4 - The data set can be fully shared by any number of users. VSAM immediately updates the data set for PUTs and refreshes all input buffers for GETs.
Default value: 1
Example: --crso 2
Allowed values: 1, 2, 3, 4
-
--cross-system-share-option
| --csso
(number)
-
--expiration-date
| --ed
(string)
- Specifies the expiration date after which the data set can be deleted.
Specify 'P' or 'p' to make the data set permanent, or an expiration date in YYYY-MM-DD format.
Example: --ed 2032-07-31
-
--storage-class
| --sc
(string)
- Specifies the storage class.
Example: --sc scl002
-
--management-class
| --mc
(string)
- Specifies the management class.
Example: --mc mcl002
-
--data-class
| --dc
(string)
- Specifies the data class.
Example: --dc dcl002
-
--log
| -l
(string)
-
When specified, 'ALL' or 'UNDO' or 'NONE' indicates the VSAM RLS recovery option.
Example: --log ALL
Allowed values: NONE, UNDO, ALL
-
--frlog
| --fr
(string)
-
Specifies the type of VSAM batch logging to perform for this VSAM data set.
The allowed values have the following meaning:
NONE - Disables VSAM batch logging.
REDO - Enables VSAM batch logging.
UNDO - Changes made to your VSAM data set are backed out using VSAM batch logging.
ALL - Changes made to your VSAM data set are backed out and forward recovered using VSAM batch logging.
Example: --frlog ALL
Allowed values: NONE, UNDO, ALL, REDO
-
--log-replicate
| --lrp
(string)
-
--log-stream-id
| --lsi
(string)
- Specifies the 1- to 26-character name of the forward recovery log stream.
Example: --lsi LOGSTRA
-
--rls-enable
| --rls
| --re
(string)
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Creating a VRRDS with default option values and mandatory options:
zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160
-
Creating a VRRDS with options:
zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y --ed 2025-09-27
-
Creating a RLS enabled VRRDS with logging options:
zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --mrs 160 --ars 120 --dcis 3584 --dsu cyl --dps 1 --dss 3 --dv vol002 --icis 512 --isu cyl --ips 1 --iss 1 --iv vol002 --bs 37376 -e y -r y --rls y -l all --lsi loga --lrp y --fr ALL
-
Creating a VRRDS data set like a model VRRDS data set:
zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --model fmmvs.model.dsname
-
Creating a VRRDS like a model VRRDS data set and overriding the parameters with options:
zowe file-master-plus create vsam-vrrds fmmvs.test.dsname --model fmmvs.model.dsname --mrs 160 --wc y --bs 37376 --crso 3 --csso 4 --ed p
Permanently deletes a data 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
-
name
(string)
- Specifies the name of the data set that you want to delete.
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Deleting a data set:
zowe file-master-plus delete data-set fmmvs.dsname
Populate the specified data set with records.
It supports all data set types that are supported by File Master Plus.
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
-
name
(string)
- Specifies the name of the data set to populate.
Options
-
--member
| -m
(string)
- Specifies name of the member.
Note: Used only if the specified data set is a PDS or PDSE.
Example: -m member1.
Required Options
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Populating a data set:
zowe file-master-plus populate data-set fmmvs.dsname --lds fmmvs.layout.dataset --lm testlay --data ../instream/data1.txt
Rename the specified data 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
-
old
(string)
- Specifies the name of the data set that you want to rename.
-
new
(string)
- Specifies the new name of the data set.
Options
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
IDMS plug-in for listing real-time monitor statistics and information, viewing DC log messages, and issuing DCMT and DCUF commands
Issues IDMS DCMT and DCUF commands
Execute a DCMT DISPLAY command
Usage
zowe idms issue dcmt-display [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Required Options
-
--args
(string)
- DCMT DISPLAY command arguments
Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Issues a 'dcmt display task send' command to display information associated with the SEND task:
zowe idms issue dcmt-display --args "task send"
-
Issues a 'dcmt display active programs' command with an IDMS profile and data source to override the default:
zowe idms issue dcmt-display --args "active programs" --idms-profile myprofile2 --datasource sysdemo
Execute a DCMT HELP command
Usage
zowe idms issue dcmt-help [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Execute a DCMT QUIESCE command
Usage
zowe idms issue dcmt-quiesce [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Required Options
-
--args
(string)
- DCMT QUIESCE command arguments. Specifies the DCMT QUIESCE target area, segment, or DBNAME
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Issues the command 'dcmt quiesce dbname empdemo id 1' which quiesces all areas associated with segments included in the EMPDEMO database and assigns the operation to dcmt-id 1:
zowe idms issue dcmt-quiesce --args "dbname empdemo id 1"
-
Issues the command 'dcmt quiesce area emp* id 2' which quiesces all areas whose segment name begins with EMP and assigns the operation to dcmt-id 2:
zowe idms issue dcmt-quiesce --args "area emp* id 2"
Execute a DCMT SHUTDOWN command
Usage
zowe idms issue dcmt-shutdown [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Required Options
-
--args
(string)
- DCMT SHUTDOWN command arguments. NOPROMPT must be specified. IMMEDIATE is optional
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Issues a 'dcmt shutdown noprompt' command to shut down the DC/UCF system while allowing all active tasks and external run units to terminate normally first:
zowe idms issue dcmt-shutdown --args "noprompt"
-
Issues a 'dcmt shutdown noprompt immediate' command to immediately shut down the DC/UCF system, abending all active tasks and external run units with code SHUT:
zowe idms issue dcmt-shutdown --args "noprompt immediate"
Execute a DCMT STATISTICS command
Usage
zowe idms issue dcmt-statistics [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
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
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Required Options
-
--args
(string)
- DCMT TEST command arguments. Specifies which debugging options to use
Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Execute a DCMT VARY command
Usage
zowe idms issue dcmt-vary [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Required Options
-
--args
(string)
- DCMT VARY command arguments
Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Execute a DCUF HELP command
Usage
zowe idms issue dcuf-help [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Execute a DCUF SHOW command
Usage
zowe idms issue dcuf-show [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Required Options
-
--args
(string)
- DCUF SHOW command arguments
Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Lists available datasources, real-time monitor statistics information, log messages, active user tasks, and transaction details
Lists data sources defined to the IDMS REST API
Usage
zowe idms list datasources [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Lists log messages based on the search options provided
Usage
zowe idms list log [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
Required Options
Options
-
--record-type
| --rt
(string)
-
Type of log records:
1 - #WTL text line
2 - User trace text or physical I/O trace text
3 - User binary trace entries
4 - Snap or dump text
5 - Snap or dump binary entries
Examples: '1,2', '1,4,5', '2'
-
--record-identifier
| --ri
(string)
-
Identifier contained in log messages
Examples: 'LTE0001,LTVTM011', 'DCSYSTEM', 'SYSTE160'
-
--search-text
| --stext
(string)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Lists all the log messages where the time stamps satisfy the start and end time criteria:
zowe idms list log --start-time "2020-08-05 09:20:00" --end-time "2020-08-05 10:20:00"
-
Lists all the #WTL log messages where 'DB001108' is contained in the log message and where the time stamps satisfy the start and end time criteria:
zowe idms list log --start-time "2020-08-05 09:20:00" --end-time "2020-08-05 10:20:00" --record-type 1 --search-text DB001108
-
Lists all log messages with the DCSYSTEM record identifier where the time stamps satisfy the start and end time criteria:
zowe idms list log --start-time "2020-08-05 08:00:00.001234" --end-time "2020-08-05 13:43:33.26" --record-identifier DCSYSTEM
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
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
Options
-
--jobname
| -j
(string)
- The job name of the active IDMS system
-
--all
| -a
(boolean)
- Lists all active systems. This is the default behavior if no job name is provided
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Lists transaction details on a specific IDMS system
Usage
zowe idms list transactions [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
Required Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Lists all active user tasks on a specific IDMS system
Usage
zowe idms list user-tasks [options]
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
Required Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Interact with IBM IMS programs and transactions.
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.
Query an IMS application program.
Usage
zowe ims query program [name...] [options]
Positional Arguments
-
name...
(string)
- Specifies the name of the program(s) to query.
Options
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Query information for an application program named PGM123:
zowe ims query program "PGM123"
-
Query information for application programs named ABC and XYZ:
zowe ims query program "ABC XYZ"
-
Query information for application programs starting with PROG using the wild card character '*':
zowe ims query program "PROG*"
-
Query information for all application programs (default is all):
zowe ims query program
-
Query information for all application programs specifying optional parameters:
zowe ims query program --attributes "BMPTYPE TIMESTAMP" --status "NOTINIT" --route "IMS1 IMS2"
-
Query information for all application programs specifying optional connection parameters:
zowe ims query program --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
Query an IMS region.
Usage
zowe ims query region [options]
Options
-
--dc
(boolean)
-
--region
(boolean)
-
--route
| --rt
(array)
- Specifies the routes to return.
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Query information for regions on route IMS1:
zowe ims query region "IMS1"
-
Query information for regions on routes IMS1 and IMS2:
zowe ims query region "IMS1 IMS2"
-
Query DC and region information for regions on routes IMS1 and IMS2:
zowe ims query region "IMS1 IMS2" --dc true --region true
-
Query information for regions specifying optional connection parameters:
zowe ims query region --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
Query an IMS transaction.
Usage
zowe ims query transaction [name...] [options]
Positional Arguments
-
name...
(string)
- Specifies the name of transaction(s) to query. You can use an * character as a wildcard to select multiple transactions.
Options
-
--attributes
| --att
(array)
-
Specifies the transaction output fields to return.
Allowed values: ALL, BMPTYPE, DEFN, DEFNTYPE, DOPT, FP, GLOBAL, IMSID, GPSB, LANG, LOCAL, MODEL, RESIDENT, SCHDTYPE, STATUS, TIMESTAMP, TRANSTAT, EXPORTNEEDED, DB, RTC, TRAN, WORK
-
--status
| --st
(array)
-
Selects transactions that possess at least one of the specified transaction statuses.
Allowed values: AFFIN, BAL, CONV, CPIC, DYN, IOPREV, LCK, NOTINIT, QERR, QSTP, SUSPEND, STOQ, STOSCHD, TRACE, USTO
-
--route
| --rt
(array)
- Specifies the routes to return.
-
--class
| --cl
(array)
- Selects transactions by the classes you specify.
-
--queue-count-operator
| --qco
(array)
- The compare operator used to select transactions based on queue count. Valid values: LT, LE, GT, GE, EQ or NE.
-
--queue-count-value
| --qcv
(number)
- The numeric value used with 'queue_count_operator' to select transactions based on queue count.
-
--conversation-attributes
| --ca
(string)
- Selects transactions by the conversational attributes you specify.
-
--fast-path-options
| --fpo
(string)
- Selects transactions by the Fast Path options you specify.
-
--remote-option-specified
| --ros
(string)
- Selects transactions by the remote option you specify.
-
--response-mode-option-specified
| --rmos
(string)
- Selects transactions by the response mode option you specify.
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Query transaction information for transaction named TRN12:
zowe ims query transaction "TRN12"
-
Query transaction information for transactions named TRAN1 and TRAN2:
zowe ims query transaction "TRAN1 TRAN2"
-
Query transaction information for transactions starting with TRAN using the wild card character '*':
zowe ims query transaction "TRAN*"
-
Query transaction information for all transactions (default is all):
zowe ims query transaction
-
Query transaction information for all transactions specifying optional parameters:
zowe ims query transaction --attributes "AFFIN TIMESTAMP" --status "NOTINIT" --route "IMS1 IMS2"
-
Query transaction information for all transactions specifying optional connection parameters:
zowe ims query transaction --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
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.
Start an IMS application program.
Usage
zowe ims start program [name...] [options]
Positional Arguments
-
name...
(string)
- The name of the application program(s) to start. The maximum length of a program name is eight characters.
Options
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Start an application program named PGM123:
zowe ims start program "PGM123"
-
Start all application programs beginning with ACC*:
zowe ims start program "ACC*"
-
Start an application program named PGM234 and start tracing:
zowe ims start program "PGM234" --attributes "SCHD TRACE"
-
Start an application program named PGM890 routing to control regions IMS1 and IMS2:
zowe ims start program "PGM890" --route "IMS1 IMS2"
-
Start an application programs named XYZ1 specifying optional connection parameters:
zowe ims start program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
Start an IMS region.
Usage
zowe ims start region [memberName] [options]
Positional Arguments
-
memberName
(string)
- The name of the member that contains JCL for the region to start. The maximum length of the member name is eight characters. If no member name is specified, the default member name is used
Options
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Start a region stored in a member named MEM1:
zowe ims start region "MEM1"
-
Start a region stored in a member named MEM2 specifying the region to route the command:
zowe ims start region "MEM2" --route "IMS1"
-
Start a region stored in a member named MEM3 and override the job name:
zowe ims start region "MEM3" --job-name "JOB9"
-
Start a region stored in a member named MEM4 routing to control regions IMS1 and IMS2:
zowe ims start region "MEM4" --route "IMS1 IMS2"
-
Start a region stored in a member named MEM5 specifying optional connection parameters:
zowe ims start region "MEM5" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
Start an IMS transaction.
Usage
zowe ims start transaction [name...] [options]
Positional Arguments
-
name...
(string)
- The name of the transaction(s) to start. The maximum length of a transaction name is eight characters.
Options
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Start a transaction named TRN1:
zowe ims start transaction "TRN1"
-
Start all transactions beginning with TRN*:
zowe ims start transaction "TRN*"
-
Start a transaction named TRN2 and start tracing:
zowe ims start transaction "TRN2" --attributes "SCHD TRACE"
-
Start a transaction named TRN3 routing to control regions IMS1 and IMS2:
zowe ims start transaction "TRN3" --route "IMS1 IMS2"
-
Start a transaction named TRN4 specifying optional connection parameters:
zowe ims start transaction "TRN4" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
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.",
Stop an IMS application program.
Usage
zowe ims stop program [name...] [options]
Positional Arguments
-
name...
(string)
- The name( of the program(s) to stop. The maximum length of a program name is eight characters.
Options
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Stop an application program named PGM123:
zowe ims stop program "PGM123"
-
Stop all application programs beginning with ACC*:
zowe ims stop program "ACC*"
-
Stop tracing an application program named PGM234:
zowe ims stop program "PGM234" --attributes "TRACE"
-
Stop an application program named PGM890 routing to control regions IMS1 and IMS2:
zowe ims stop program "PGM890" --route "IMS1 IMS2"
-
Stop an application programs named XYZ1 specifying optional connection parameters:
zowe ims stop program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
Stop an IMS region.
Usage
zowe ims stop region [options]
Options
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Stop a region with job name JOBNM1:
zowe ims stop region --job-name "JOBNM1"
-
Stop multiple regions with region identifiers:
zowe ims stop region --region-ids 4 5
-
Stop a region with region identifier and cause the abnormal termination (ABEND) of the application program:
zowe ims stop region --region-ids 4 --abdump "TRAN1"
-
Stop a region with region identifier and specify 'cancel' because the 'abdump' option failed to stop the region:
zowe ims stop region --region-ids 4 --cancel true
-
Stop a region with job name JOBNM4 specifying optional connection parameters:
zowe ims stop region --job-name "JOBNM4" --user "username" --pass "pass1234" --host "localhost" --port 8080--ich "zos1" --icp 9999 --plex "PLEX1"
Stop an IMS transaction.
Usage
zowe ims stop transaction <name...> [options]
Positional Arguments
-
name...
(string)
- The name of the transaction(s) to stop. The maximum length of a transaction name is eight characters.
Options
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Stop a transaction named TRN1:
zowe ims stop transaction "TRN1"
-
Stop all transactions beginning with TRN*:
zowe ims stop transaction "TRN*"
-
Stop tracing a transaction named TRN2:
zowe ims stop transaction "TRN2" --attributes "TRACE"
-
Stop a transaction named TRN3 routing to control regions IMS1 and IMS2:
zowe ims stop transaction "TRN3" --route "IMS1 IMS2"
-
Stop a transaction named TRN4 specifying optional connection parameters:
zowe ims stop transaction "TRN4" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
Updates the setting(s) for application program or transaction. This command submits a 'UPDATE PGM' or 'UPDATE TRAN' IMS command and returns the output.
Update an IMS application program.
Usage
zowe ims update program [name...] [options]
Positional Arguments
-
name...
(string)
- The name of the application program(s) to update. The maximum length of a program name is eight characters.
Options
-
--bmp-type
| --bmptype
(string)
-
--dynamic
| --dopt
(string)
-
--fast-path
| --fp
(string)
-
--generated-psb
| --gpsb
(string)
-
--language
| --lang
(string)
-
Specifies the language interface of the program or a GPSB or defined a DOPT(Y) program as using the JAVA language (ASSEM, COBOL, JAVA, PASCAL, PLI).
Allowed values: ASSEM, COBOL, JAVA, PASCAL, PLI
-
--lock
| -l
(string)
-
--option
| -o
(string)
-
--resident
| -r
(string)
-
--route
| --rte
(array)
- Specifies the region(s) to route the command.
-
--schedule-type
| --schdtype
(string)
-
Specifies whether this application program can be scheduled into more than one message region or batch message region simultaneously (PARALLEL or SERIAL).
Allowed values: PARALLEL, SERIAL
-
--transaction-level-stat
| --transtat
(string)
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Update an application program named PGM123 to execute exclusively as Fast Path:
zowe ims update program "PGM123" --fp "E"
-
Update all application programs beginning with ACC* to not run in a BMP type region:
zowe ims update program "ACC*" --bmptype "N"
-
Unlock all programs beginning with PGM* to allow scheduling:
zowe ims update program "PGM*" --lock "OFF"
-
Update an application program named PGM890 to execute as Fast Path routing to control regions IMS1 and IMS2:
zowe ims update program "PGM890" --fp "E" --route "IMS1 IMS2"
-
Unlock an application programs named XYZ1 to allow scheduling specifying optional connection parameters:
zowe ims update program "XYZ1" --lock "OFF" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
Update an IMS transaction.
Usage
zowe ims update transaction [name...] [options]
Positional Arguments
-
name...
(string)
- The name of the transaction(s) to update. The maximum length of a transaction name is eight characters.
Options
-
--aoi-cmd
| --aocmd
(string)
-
Specifies the AOI option that you want to change (N, CMD, TRAN, Y).
Allowed values: N, CMD, TRAN, Y
-
--class
| -c
(array)
- Selects the transactions associated with the specified class or classes to be updated.
-
--commit-mode
| --cmtmode
(string)
-
Specifies when database updates and non-express output messages are committed (SNGL, MULT).
Allowed values: SINGLE, MODE
-
--conversation
| --conv
(string)
-
--current-priority
| --cpri
(number)
- Specifies a new value for the current priority of a transaction.
-
--directed-routing
| --dirroute
(string)
-
--edit-routine
| --editrtn
(string)
- Specifies the 1- to 8-character name of your transaction input edit routine that edits messages before the program receives the message.
-
--edit-uppercase
| --edituc
(string)
-
--emh-buffer-size
| --emhbsz
(number)
- Specifies the EMH buffer size required to run the Fast Path transaction.
-
--expiration-time
| --exprtime
(number)
- Specifies the elapsed time in seconds that IMS can use to cancel the input transaction.
-
--fast-path
| --fp
(string)
-
--inquiry
| --inq
(string)
-
--limit-count
| --lct
(number)
- Specifies the limit count.
-
--limit-priority
| --lpri
(number)
- Specifies the limit priority.
-
--lock
| -l
(string)
-
--log-write-ahead
| --dclwa
(string)
-
--maximum-regions
| --maxrgn
(number)
- Specifies a new value for the maximum number of regions that can be simultaneously scheduled for a given transaction.
-
--message-type
| --msgtype
(string)
-
Specifies the message type (single segment or multiple segment) (MULTSEG or SNGLSEG).
Allowed values: MULTSEG, SNGLSEG
-
--msname
| --mn
(string)
- Specifies the one- to eight-character name of the logical link path in a multiple IMS system configuration (MSC).
-
--normal-scheduling-priority
| --npri
(number)
- Specifies the normal scheduling priority.
-
--option
| -o
(string)
-
--parallel-processing-limit
| --parlim
(number)
- Specifies the parallel processing limit count.
-
--program
| --pgm
(string)
- Specifies the name of the application program associated with the transaction.
-
--processing-limit-count
| --plct
(number)
- Specifies the processing limit count.
-
--processing-limit-count-time
| --plcttime
(number)
- Specifies the processing limit count time.
-
--recover
| -r
(string)
-
--remote
| --re
(string)
-
--response-mode
| --resp
(string)
-
--route
| --rte
(array)
- Specifies the region(s) to route the command.
-
--segment-number
| --segno
(number)
- Specifies the segment number.
-
--segment-size
| --segsz
(number)
- Specifies the segment size.
-
--serial
| --sr
(string)
-
--set-class
| --sc
(number)
- Specifies the transaction class, which is an attribute used to select a transaction for scheduling.
-
--system-identification-local
| --sidl
(number)
- Specifies the system identification (SYSID) of the local system in a multiple-IMS system (MSC) configuration.
-
--system-identification-remote
| --sidr
(number)
- Specifies the system identification (SYSID) of the remote system in a multiple-IMS system (MSC) configuration.
-
--scratchpad-area-size
| --spasz
(number)
- Specifies the scratchpad area (SPA) size, in bytes, for a conversational transaction. The value can be a number from 16 and 32767.
-
--scratchpad-area-truncation
| --spatrunc
(string)
-
--transaction-level-stat
| --transtat
(string)
-
--wait-for-input
| --wfi
(string)
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Update a transaction named TRN1 to process exclusively as Fast Path:
zowe ims update transaction "TRN1" --fp "E"
-
Unlock to allow scheduling all transactions beginning with TRN* and associated with class CLASSA:
zowe ims update transaction "TRN*" --class "CLASSA" --lock "OFF"
-
Set response mode on for transaction named TRN2 and associated with classes CLASS1 and CLASS2:
zowe ims update transaction "TRN2" --class "CLASS1 CLASS2" --resp "Y"
-
Update a transaction named TRN3 to process exclusively as Fast Path routing to control regions IMS1 and IMS2:
zowe ims update transaction "TRN3" -fp "E" --route "IMS1 IMS2"
-
Associate PGM1 with transaction named TRN4 specifying optional connection parameters:
zowe ims update transaction "TRN4" --pgm "PGM1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1"
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.
Perform a check on JCL that is contained in an MVS data set or a local file.
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
-
dataSet
(string)
- The MVS data set containing the JCL contents. The data set can be a physical sequential (PS) or partitioned data set (PDS) member. The data set attributes must be recfm fixed-block (FB) and lrecl 80. The data set must be catalogued.
Options
JCLCheck Connection Options
-
--host
| -H
(string)
- Host name of the JCLCheck API service that is running on the mainframe system.
-
--port
| -P
(number)
- Port for the JCLCheck API service that is running on the mainframe system.
-
--user
| -u
(string)
- User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--password
| --pass
| --pw
(string)
- Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| -o
(string)
-
Specifies protocol to use for JCLCheck connection (http or https).
Default value: https
Allowed values: http, https
-
--jclcheck-options
| --jo
(string)
- The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
localFile
(string)
- The local file containing the JCL to check. The local JCL file can contain a single job or multiple jobs (specified one after another without blank lines or line breaks). The JCL lines in the file must not exceed 80 characters.
Options
JCLCheck Connection Options
-
--host
| -H
(string)
- Host name of the JCLCheck API service that is running on the mainframe system.
-
--port
| -P
(number)
- Port for the JCLCheck API service that is running on the mainframe system.
-
--user
| -u
(string)
- User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--password
| --pass
| --pw
(string)
- Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| -o
(string)
-
Specifies protocol to use for JCLCheck connection (http or https).
Default value: https
Allowed values: http, https
-
--jclcheck-options
| --jo
(string)
- The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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)
Get monitor history and measurement analysis data from MAT.
Get the CodeView measurement details.
Get the CodeView CallerID details for the specific CSECT and module.
Usage
zowe mat monitor codeview callerid [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
-
--module
(string)
- Specifies the module name that you request the CallerID details for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').
-
--csect
(string)
- Specifies the CSECT name that you request the CallerID details for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:
zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
-
Get the CallerID details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01 and empty module name:
zowe mat monitor codeview callerid --profile TESTPROF --csect "TUNCOB01" --module '""'
Get the CodeView measurement details in Csect mode.
Usage
zowe mat monitor codeview csect [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the Histogram details for the measurement.
Usage
zowe mat monitor codeview histogram [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
-
--module
(string)
- Specifies the module name that you request the Histogram data for. You get the module value from the 'codeview csect' command response. The module name can be empty (e.g., --module "IGZCPAC" or --module '""').
-
--csect
(string)
- Specifies the CSECT name that you request the Histogram data for. You get the csect value from the 'codeview csect' command response. The CSECT name can be empty (e.g., --csect "TUNCOB01" or --csect '""').
-
--group
(string)
- Specifies the histogram group size parameter that defines the resolution of the histogram (e.g., --group 32). If you do not specify the group parameter, the group size value defaults to 4 bytes. If the source program listing is registered with MAT, the group size parameter is ignored. The --group parameter is optional. Lower values of the --group parameter result in more granular representation of the histogram data. Values: numbers between 2 and 999999.
-
--top
(number)
- Specifies the maximum number of the top consuming CSECT activity locations that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all CSECT activity locations that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.
-
--listing
(boolean)
- Enables you to retrieve program listing details that pertain to the specific CSECT and statement. To use the listing retrieval option, you must install and configure the Endevor® Web Services and have the program listing for the specific measurement registered with MAT. The source code listing is retrieved through Endevor® footprints for Cobol, C/C++, and Assembler programs. The program listing file is downloaded to your local directory that you specified with the 'listingDir' parameter in your MAT configuration profile. When you request the histogram details with the '--listing' option, the 'histogram' command returns the additional 'listing' column that contains a reference to the program listing with the specific CSECT name, program type, line and column number that pertain to the requested CSECT and statement, for example, c:listingsSA420LE.asm:382:51. If you use Visual Studio Code (VS Code) IDE, you can click on the reference in the command responce in your VS Code terminal to navigate directly to the indicated source program location.The --listing parameter is optional.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB:
zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB"
-
Get the Histogram details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01, empty module name, limiting the group size to 32 bytes and the number of returned records to 5 top consumers:
zowe mat monitor codeview histogram --profile TESTPROF --csect "TUNCOB01" --module '""' --top 5 --group 32
-
Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, limit the number of returned records to 5 top consumers, and request the listing details:
zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --top 5 --listing
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor codeview module [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the DB2 measurement details.
Get the DB2View details for the measurement.
Usage
zowe mat monitor db2 db2view [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
-
--top
(number)
- Specifies the maximum number of the top consuming DB2 statements that you want to obtain in the response (e.g., --top 5). If you specify --top 0, you get the list of all DB2 statements that MAT has detected during the measurement.The --top parameter is optional. Values: numbers between 0 and 300.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the DB2View details for monitor number 5:
zowe mat monitor db2 db2view --mon_num 5
-
Get the DB2View details for the latest monitor in the TESTPROF profile, with the top consumer limitation set to 5 top consumers:
zowe mat monitor db2 db2view --profile TESTPROF --top 5
Get SQL details for the DB2 statement.
Usage
zowe mat monitor db2 sqlstmt [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
-
--dbrm
(string)
- Specifies the DBRM/Package name that the requested DB2 statement belongs to (e.g., --dbrm CUPBTSDY). You get the dbrm value from the 'db2 db2view ' command response.
-
--stmtnum
(number)
- Specifies the statement number that you request the SQL details for (e.g., --stmtnum 464). You get the stmtnum value from the 'db2 db2view ' command response.
-
--totalsamps
(number)
- Specifies the total number of samples taken for the requested statement (e.g., --totalsamps 1). You get the totalsamps value from the 'db2 db2view ' command response.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:
zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1
-
Get the DB2 SQL statement details for the latest monitor in the TESTPROF profile, for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1:
zowe mat monitor db2 sqlstmt --profile TESTPROF --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1
Get the DelayView measurement details.
Get the delay address details for the measurement.
Usage
zowe mat monitor delayview address [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
-
--majorcategory
(string)
- Specifies the major delay category name identified for the analysis item (e.g., --majorcategory "PC routine delay"). You get the majorcategory value from the 'delayview delay' command response.
-
--minorcategory
(string)
- Specifies the minor delay category name identified for the analysis item (e.g., --minorcategory "PC CALL"). You get the minorcategory value from the 'delayview delay' command response.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5:
zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL"
-
Get the delay address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for the latest monitor in the TESTPROF profile:
zowe mat monitor delayview address --profile TESTPROF –-majorcategory "PC routine delay" –-minorcategory "PC CALL"
Get the delay details for the measurement.
Usage
zowe mat monitor delayview delay [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Get list of all available measurements that are stored in the history of the specific monitor profile.
Usage
zowe mat monitor history [options]
Options
-
--profile
(string)
- Specifies the name of the profile.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the overview details of the measurement.
Usage
zowe mat monitor overview [options]
Options
-
--profile
(string)
- Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile.
-
--mon_num
(number)
- Specifies the unique monitor number of the measurement.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create, invoke, and list MAT monitor profiles.
Create a MAT monitor profile.
Usage
zowe mat profile create [options]
Required Options
-
--profile
(string)
- Specifies the name of the profile that you create in MAT (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.
-
--jobname
(string)
- Specifies the name of the job that you want to measure (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--targsys
(string)
- Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, 1-8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $), e.g. AA31,AA32).
Options
-
--batchreports
(string)
-
Specifies the setting for the Batch report option upon monitor completion.
Default value: no
Allowed values: yes, no
-
--description
(string)
- Provide the monitor description (maximum 24 characters).
-
--mondsn
(string)
- Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.
-
--stepname
(string)
- Specifies the name of the job step to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--mstep
(string)
-
Indicates whether the multi-step monitoring option is enabled.
Default value: no
Allowed values: yes, no
-
--procstep
(string)
- Specifies the name of the procedure step. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--program
(string)
- Specifies the name of the program to monitor. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--elapstime
(string)
-
--smon
(string)
-
--tasklib
(string)
- Specifies an additional DD name for load modules. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--samplecnt
(string)
-
--succnt
(string)
-
--reccnt
(string)
-
--sampdelay
(string)
-
--userexit1
(string)
- Specifies the name for the call user written Data Base. Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. DBEXIT1).
-
--userexit2
(string)
- Specifies the name 1 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT1).
-
--userexit3
(string)
- Specifies the name 2 for the call user written 4GL exit programs for this monitor . Values: maximum 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. UEXIT2).
-
--inctask
(string)
- Specifies the task name to define the tasks that you want to sample in a multitasking environment and restrict monitoring to the specific subtask within the address space. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. INC31,INC32).
-
--exctask
(string)
- Specifies the task name to omit from sampling in a multitasking environment Values: a comma separated list of up to 4 values is allowed, max. 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %) (e.g. EXC31,EXC32).
-
--tran
(string)
- Specifies the CICS transaction code name to monitor .Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TRAN1,TRAN2).
-
--term
(string)
- Specifies the CICS terminal IDs to monitor. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. TERM1,TERM2).
-
--userid
(string)
- Specifies the CICS user IDs to monitor. Values: Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or +) (e.g. USER1,USER2).
-
--db2expl
(string)
-
Indicates whether the Explain SQL option is enabled for DB2 SQL statements.
Default value: no
Allowed values: yes, no
-
--db2ctsql
(string)
-
Indicates whether the Collect SQL from Catalog option is enabled for DB2 SQL statements.If you specify db2expl=yes, then db2ctsql must be also set to yes.
Default value: no
Allowed values: yes, no
-
--db2hvloc
(string)
-
Indicates whether the Requestor Location option is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
-
--db2hvcor
(string)
-
Indicates whether the Correlation ID option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
-
--db2hviid
(string)
-
Indicates whether the Operator ID option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
-
--db2hvthd
(string)
-
Indicates whether the Thread Address option for SQL statements is enabled for DB2 measurements.
Default value: no
Allowed values: yes, no
-
--wasexprt
(string)
-
Indicates whether the Expert Mode is enabled for Java measurement.
Default value: no
Allowed values: yes, no
-
--urlfilt
(string)
- A filtering string to restrict monitoring to the specific application URL, transaction, or stored procedure for Java measurements. Values: a comma separated list of up to 4 values is allowed, max. 64 characters (e.g. mypage1.html,mypage2.html).
-
--sysfilt
(string)
- A filtering string to include the specified system class for Java measurements. If you specify a value for sysfilt, the measurement includes only the classes that match the filtering string pattern. Values: a comma separated list of up to 3 values is allowed, max. 64 characters (e.g. user1.class,user2.class).
-
--schedule
(string)
- Specifies the name of the schedule that you want to apply to the monitor profile (maximum 8 characters).
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Invoke a MAT monitor profile to start measurement.
Usage
zowe mat profile invoke [options]
Required Options
-
--profile
(string)
- Specifies the name of the profile in MAT that you invoke (e.g. PROFILE1). Values: 1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9, and @), the first character must be an alphabetic or @. The profile name must not contain characters # and $.
-
--jobname
(string)
- Specifies the name of the job to be measured (e.g. JOB1). Values: 1 to 8 characters, alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or %).
-
--targsys
(string)
- Specifies the target system in SYSPLEX. Values: a comma separated list of up to 4 values is allowed, maximum 8 characters each, a combination of alphanumeric (A-Z and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or a national (@, #, $) (e.g. AA31,AA32).
Options
-
--mondsn
(string)
- Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR). Values: data set name pattern, maximum 46 characters. If not specified, your default MAT monitor DSN pattern is applied.
-
--moiuuid
(string)
- Specifies the MOI UUID. Values: maximum 61 characters, alphanumeric (A-Z and 0-9). If you use this parameter for command execution, the value cannot be blank.
-
--moitimestamp
(string)
- Specifies the MOI timestamp. Values: maximum 12 characters, numbers only (0-9). If you use this parameter for command execution, the value cannot be blank.
-
--listing
(boolean)
- Activates automated registration of Cobol, C/C++, and Assembler program listings through Endevor® footprints. After completion of the measurement that you invoke with the --listing parameter, the MAT Analyze plug-in for Zowe CLI automatically retrieves the program listing that is associated with the monitored job and registers the listing with MAT. A registered program listing enhances the analysis possibilities of the 'codeview histogram' command the 'codeview histogram' command and enables you to inspect the source code statements that are associated with specific modules and CSECTs.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system :
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31
-
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and save the measurement result in the DEMO.MAT.MONITOR.PROFILE1 data set:
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --mondsn DEMO.MAT.MONITOR.PROFILE1
-
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and register the program listing:
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --listing
Get the list of available monitor profiles.
Usage
zowe mat profile list [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
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.
Get performance information using PMA utilities. You can get the current performance data of your jobs and check for the daily performance alerts.
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
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
jobname
(string)
- Specifies the name of the job that is being tested (e.g. TESTPMA8).
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Check whether your job TESTPMA8 exceeds the average daily performance using the default profile:
zowe mat-pma-util get alert-by-job TESTPMA8
-
Check whether your job TESTPMA8 exceeds the average daily performance using specific PMA profile details:
zowe mat-pma-util get alert-by-job TESTPMA8 --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
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
-
jobname
(string)
- Specifies the name of the job that is being tested (e.g. TESTPMA8).
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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.
Delete a job from the list of inclusions in the PMA scope.
Usage
zowe mat-pma-util scope del-job <jobname> [options]
Positional Arguments
-
jobname
(string)
- Specifies the name of the job that you want to delete from the list of inclusions in the PMA scope (e.g. TESTPMA8).
Options
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Delete the TESTPMA8 job from the list of inclusions in the PMA scope:
zowe mat-pma-util scope del-job TESTPMA8
-
Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope:
zowe mat-pma-util scope del-job TESTPMA8 --ps TESTCALL --st TESTDO
-
Delete the specific procname and step name of the TESTPMA8 job from the list of inclusions in the PMA scope using specific PMA profile details:
zowe mat-pma-util scope del-job TESTPMA8 --ps TESTCALL --st TESTDO --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
Delete a program from the list of exclusions from the PMA scope.
Usage
zowe mat-pma-util scope del-pgm <pgmname> [options]
Positional Arguments
-
pgmname
(string)
- Specifies the name of the program that you want to delete from the list of exclusions from the PMA scope (e.g. TESTPMA8).
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Exclude a program from the PMA scope of work.
Usage
zowe mat-pma-util scope exl-pgm <pgmname> [options]
Positional Arguments
-
pgmname
(string)
- Specifies the name of the program that you want to add to the list of exclusions from the PMA scope (e.g. TESTPMA8).
Options
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Exclude the TESTPMA8 program from the PMA scope:
zowe mat-pma-util scope exl-pgm TESTPMA8
-
Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program:
zowe mat-pma-util scope exl-pgm TESTPMA8 --dc "EXCLUDE FROM THE CURRENT SCOPE"
-
Exclude the TESTPMA8 program from the PMA scope and add a description to the excluded program using specific PMA profile details:
zowe mat-pma-util scope exl-pgm TESTPMA8 --dc "EXCLUDE FROM THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
Get the list of jobs included in the PMA scope.
Usage
zowe mat-pma-util scope get-listj [options]
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the list of programs excluded from the PMA scope.
Usage
zowe mat-pma-util scope get-listp [options]
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Include a job in the PMA scope of work.
Usage
zowe mat-pma-util scope inc-job <jobname> [options]
Positional Arguments
-
jobname
(string)
- Specifies the name of the job that you want to add to the list of inclusions in the PMA scope (e.g. TESTPMA8).
Options
-
--stepname
| --st
(string)
- Specifies the name of the job step that you want to include in the PMA scope.
-
--procstep
| --ps
(string)
- Specifies the procname of the job that you want to include in the PMA scope.
-
--description
| --dc
(string)
- Specifies the description of the job that you want to include in the PMA scope.
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--pma-profile
| --pma-p
(string)
- The name of a (pma) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Include the TESTPMA8 job in the PMA scope:
zowe mat-pma-util scope inc-job TESTPMA8
-
Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job:
zowe mat-pma-util scope inc-job TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE"
-
Include the specific procname and step name of the TESTPMA8 job in the PMA scope and add a description to the included job using specific PMA profile details:
zowe mat-pma-util scope inc-job TESTPMA8 --ps TESTCALL --st TESTDO --dc "INCLUDE IN THE CURRENT SCOPE" --ja 123456789 --jc A --jmc A --jl HLQ.CEETLOAD --jph PMAHLQ
Interact with IBM MQ for z/OS.
MQ Utilities
MQ Utilities
Usage
zowe mq run mqsc <qmgr> <cmd> [options]
Positional Arguments
-
qmgr
(string)
- The queue manager to apply the command to
-
cmd
(string)
MQ Connection Options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Interact with OPS/MVS® for automation administration and resource management.
Disable OPS/MVS rules.
Disable the specified rule.
Usage
zowe ops disable rule <ruleset> <rule> [options]
Positional Arguments
-
ruleset
(string)
- The rule set containing the rule.
-
rule
(string)
OPS WEB SERVICES CONNECTION OPTIONS
-
--user
(string)
- Your z/OS user name used to authenticate to OPS Web Services
-
--password
| --pass
(string)
- Your z/OS password used to authenticate to OPS Web Services
-
--host
(string)
- The hostname of the server where OPS Web Services is running.
-
--port
| -p
(number)
- The port number for OPS Web Services.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| --prot
(string)
-
The protocol used for connecting to OPS Web Services
Default value: https
Allowed values: http, https
-
--subsystem
| --subs
(string)
- Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Enables OPS/MVS rules.This will cause SSM to take the necessary action to enable that rule.
Enable the specified rule.
Usage
zowe ops enable rule <ruleset> <rule> [options]
Positional Arguments
-
ruleset
(string)
- The rule set containing the rule.
-
rule
(string)
OPS WEB SERVICES CONNECTION OPTIONS
-
--user
(string)
- Your z/OS user name used to authenticate to OPS Web Services
-
--password
| --pass
(string)
- Your z/OS password used to authenticate to OPS Web Services
-
--host
(string)
- The hostname of the server where OPS Web Services is running.
-
--port
| -p
(number)
- The port number for OPS Web Services.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| --prot
(string)
-
The protocol used for connecting to OPS Web Services
Default value: https
Allowed values: http, https
-
--subsystem
| --subs
(string)
- Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Display data associated with OPS/MVS automation elements (for example, rules or SSM resources).
Display data associated with the specified SSM resource. Currently, only resource state is displayed.
Usage
zowe ops show resource <resourcename> [options]
Positional Arguments
-
resourcename
(string)
- The name of the resource.
Options
OPS WEB SERVICES CONNECTION OPTIONS
-
--user
(string)
- Your z/OS user name used to authenticate to OPS Web Services
-
--password
| --pass
(string)
- Your z/OS password used to authenticate to OPS Web Services
-
--host
(string)
- The hostname of the server where OPS Web Services is running.
-
--port
| -p
(number)
- The port number for OPS Web Services.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| --prot
(string)
-
The protocol used for connecting to OPS Web Services
Default value: https
Allowed values: http, https
-
--subsystem
| --subs
(string)
- Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Display data associated with the specified rule. Currently, only rule status is displayed.
Usage
zowe ops show rule <ruleset> <rule> [options]
Positional Arguments
-
ruleset
(string)
- The rule set containing the rule.
-
rule
(string)
OPS WEB SERVICES CONNECTION OPTIONS
-
--user
(string)
- Your z/OS user name used to authenticate to OPS Web Services
-
--password
| --pass
(string)
- Your z/OS password used to authenticate to OPS Web Services
-
--host
(string)
- The hostname of the server where OPS Web Services is running.
-
--port
| -p
(number)
- The port number for OPS Web Services.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| --prot
(string)
-
The protocol used for connecting to OPS Web Services
Default value: https
Allowed values: http, https
-
--subsystem
| --subs
(string)
- Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Start OPS/MVS resources.
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
-
resourcename
(string)
- The name of the resource.
Options
OPS WEB SERVICES CONNECTION OPTIONS
-
--user
(string)
- Your z/OS user name used to authenticate to OPS Web Services
-
--password
| --pass
(string)
- Your z/OS password used to authenticate to OPS Web Services
-
--host
(string)
- The hostname of the server where OPS Web Services is running.
-
--port
| -p
(number)
- The port number for OPS Web Services.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| --prot
(string)
-
The protocol used for connecting to OPS Web Services
Default value: https
Allowed values: http, https
-
--subsystem
| --subs
(string)
- Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Stop OPS/MVS resources.
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
-
resourcename
(string)
- The name of the resource.
Options
OPS WEB SERVICES CONNECTION OPTIONS
-
--user
(string)
- Your z/OS user name used to authenticate to OPS Web Services
-
--password
| --pass
(string)
- Your z/OS password used to authenticate to OPS Web Services
-
--host
(string)
- The hostname of the server where OPS Web Services is running.
-
--port
| -p
(number)
- The port number for OPS Web Services.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| --prot
(string)
-
The protocol used for connecting to OPS Web Services
Default value: https
Allowed values: http, https
-
--subsystem
| --subs
(string)
- Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Install and manage plug-ins.
Install plug-ins to an application.
Usage
zowe plugins install [plugin...] [options]
Positional Arguments
-
plugin...
(string)
-
A space-separated list of plug-ins to install. A plug-in can be any format that is accepted by the `npm install` command (local directory, TAR file, git URL, public package, private package, etc...).
To use a relative local directory, at least one '/' or '\' must exist in the plug-in path. For example, you have a local plug-in in a folder called 'test-plugin' that you want to install. Specify the relative local directory by issuing the following command:
zowe plugins install ./test-plugin
If you omit the './', then the install command looks for 'test-plugin' in an npm registry.
If the plugin argument is omitted, the plugins.json file will determine which plug-ins are installed. For more information on the plugins.json file, see the --file option.
Options
-
--file
(local file path)
-
Specifies the location of a plugins.json file that contains the plug-ins you want to install.
All plug-ins specified in plugins.json will be installed to the base CLI and the contents will be placed into /home/<user>/.zowe/plugins/plugins.json.
If you do not specify a plugins.json file and do not specify a plug-in, the default plugin.json file (/home/<user>/.zowe/plugins/plugins.json) will be used. This provides a way to install plug-ins that were lost or corrupted after reinstalling or updating Zowe CLI.
-
--registry
(string)
-
The npm registry that is used when installing remote packages. When this value is omitted, the value returned by `npm config get registry` is used.
For more information about npm registries, see: https://docs.npmjs.com/misc/registry
-
--login
(boolean)
-
The flag to add a registry user account to install from secure registry. It saves credentials to the .npmrc file using `npm login`. When this value is omitted, credentials from .npmrc file is used. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from .npmrc file.
For more information about npm registries, see:
https://docs.npmjs.com/cli/login for NPM >= 9
https://docs.npmjs.com/cli/adduser for NPM < 9
Examples
-
Install plug-ins saved in /home/<user>/.zowe/plugins/plugins.json:
zowe plugins install
-
Install plug-ins saved in a properly formatted config file:
zowe plugins install --file /some/file/path/file_name.json
-
Install a remote plug-in:
zowe plugins install my-plugin
-
Install a remote plug-in using semver:
zowe plugins install my-plugin@"^1.2.3"
-
Install a remote plug-in from the specified registry:
zowe plugins install my-plugin --registry https://registry.npmjs.org/
-
Install a local folder, local TAR file, and a git URL:
zowe plugins install ./local-file /root/tar/some-tar.tgz git://github.com/project/repository.git#v1.0.0
-
Install a remote plug-in from the registry which requires authorization(don't need to use this flag if you have already logged in before):
zowe plugins install my-plugin --registry https://registry.npmjs.org/ --login
List all plug-ins installed.
Usage
zowe plugins list [options]
Options
-
--short
| -s
(boolean)
- Show output in abbreviated format
Uninstall plug-ins.
Usage
zowe plugins uninstall [plugin...] [options]
Positional Arguments
Examples
-
Uninstall a plug-in:
zowe plugins uninstall my-plugin
Update plug-ins.
Usage
zowe plugins update [plugin...] [options]
Positional Arguments
Options
-
--registry
(string)
-
The npm registry that is used when installing remote packages. When this value is omitted, the value returned by `npm config get registry` is used.
For more information about npm registries, see: https://docs.npmjs.com/misc/registry
-
--login
(boolean)
-
The flag to add a registry user account to install from secure registry. It saves credentials to the .npmrc file using `npm login`. When this value is omitted, credentials from .npmrc file is used. If you used this flag once for specific registry, you don't have to use it again, it uses credentials from .npmrc file.
For more information about npm registries, see:
https://docs.npmjs.com/cli/login for NPM >= 9
https://docs.npmjs.com/cli/adduser for NPM < 9
Examples
Validate a plug-in that has been installed.
Usage
zowe plugins validate [plugin] [options]
Positional Arguments
-
plugin
(string)
-
The name of the plug-in to validate.
Validation issues identified for this plug-in are displayed.
If the plug-in argument is omitted, all installed plug-ins are validated.
Options
Examples
-
Validate a plug-in named my-plugin:
zowe plugins validate my-plugin
-
Validate all installed plug-ins:
zowe plugins validate
-
Validate a plug-in named my-plugin, and treat warnings as errors:
zowe plugins validate my-plugin --fail-on-warning
Create and manage configuration profiles.
Create new configuration profiles.
Base profile that stores values shared by multiple service profiles
Usage
zowe profiles create base-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new base profile. You can load this profile by using the name on commands that support the "--base-profile" option.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Options
Examples
-
Create a profile called 'base1' to connect to host example.com and port 443:
zowe profiles create base-profile base1 --host example.com --port 443 --user admin --password 123456
-
Create a profile called 'base2' to connect to host example.com (default port - 443) and allow self-signed certificates:
zowe profiles create base-profile base2 --host example.com --user admin --password 123456 --reject-unauthorized false
-
Create a profile called 'base3' to connect to host example.com and port 1443, not specifying a username or password so they are not stored on disk; these will need to be specified on every command:
zowe profiles create base-profile base3 --host example.com --port 1443
-
Create a zosmf profile called 'base4' to connect to default port 443 and allow self-signed certificates, not specifying a username, password, or host so they are not stored on disk; these will need to be specified on every command:
zowe profiles create base-profile base4 --reject-unauthorized false
A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.
Usage
zowe profiles create ca7-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ca7 profile. You can load this profile by using the name on commands that support the "--ca7-profile" option.
CA7 Connection Options
Options
Configuration profile for Spool, where you specify information about your Spool instance
Usage
zowe profiles create caspool-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new caspool profile. You can load this profile by using the name on commands that support the "--caspool-profile" option.
SPOOL OPTIONS
Options
Examples
-
Create a profile for Spool named 'myProfile' with TSO account information '1234567890', Spool installation high level qualifier of 'CASPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec:
zowe profiles create caspool-profile myProfile --account 1234567890 --spoolhlq CASPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST
Configuration profile for View
Usage
zowe profiles create caview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new caview profile. You can load this profile by using the name on commands that support the "--caview-profile" option.
Options
-
--protocol
(string)
-
--hostname
(string)
- Hostname or ip address of the target View REST API instance.
-
--port
| -P
(number)
-
--base-path
(string)
-
--username
(string)
- User name used to authenticate against the target View REST API instance.
-
--password
| --pass
| --pw
(string)
- Password used to authenticate against the target View REST API instance.
-
--overwrite
| --ow
(boolean)
- Overwrite the caview profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
Examples
Specifies the target environment for the cics-deploy deploy and undeploy actions.
Usage
zowe profiles create cics-deploy-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new cics-deploy profile. You can load this profile by using the name on commands that support the "--cics-deploy-profile" option.
Required Options
-
--cicsplex
| --cp
(string)
- Specifies the CICSplex (up to 8 characters) to target.
-
--scope
| --sc
(string)
- Specifies the name of the CICS System, or CICS System Group (up to 8 characters) to target.
-
--cics-hlq
| --cq
| --cicshlq
(string)
- Specifies the High Level Qualifier (up to 35 characters) at which the CICS datasets can be found in the target environment.
-
--cpsm-hlq
| --cph
| --cpsmhlq
(string)
- Specifies the High Level Qualifier (up to 35 characters) at which the CPSM datasets can be found in the target environment.
-
--job-card
| --jc
| --jobcard
(string)
-
Specifies the job card to use with any generated DFHDPLOY JCL.
Default value: //DFHDPLOY JOB DFHDPLOY,CLASS=A,MSGCLASS=X,TIME=NOLIMIT
Options
-
--csd-group
| --cg
| --csdgroup
(string)
- Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is deployed then a definition is added to this group; if a bundle is undeployed then the definition is removed from this group. The CSD group is changed for each CICS system that is specified by the --scope option. The --csd-group and --res-group options are mutually exclusive.
-
--res-group
| --rg
| --resgroup
(string)
- Specifies the BAS resource group (up to 8 characters) for the bundle resource. If a bundle is deployed then a resource is defined in the BAS data repository; if a bundle is undeployed then the definition is removed. The --csd-group and --res-group options are mutually exclusive.
-
--target-directory
| --td
| --targetdir
| --target-dir
(string)
- Specifies the target zFS location to which CICS bundles should be uploaded (up to 255 characters).
-
--overwrite
| --ow
(boolean)
- Overwrite the cics-deploy profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
Examples
-
Create a cics-deploy profile called 'example1' to connect to a CPSM managed group of CICS regions within the TESTGRP1 scope of a cicsplex named PLEX1:
zowe profiles create cics-deploy-profile example1 --cicsplex PLEX1 --scope TESTGRP1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550
-
Create a cics-deploy profile called 'example2' to connect to the same CPSM managed group of regions, and identify a BAS resource group BUNDGRP1 in which to store resource definitions:
zowe profiles create cics-deploy-profile example2 --cicsplex PLEX1 --scope TESTGRP1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --res-group BUNDGRP1
-
Create a cics-deploy profile called 'example3' to connect to the same CPSM managed group of regions, and identify the default USS directory to which bundles should be uploaded:
zowe profiles create cics-deploy-profile example3 --cicsplex PLEX1 --scope TESTGRP1 --cics-hlq CICSTS55.CICS720 --cpsm-hlq CICSTS55.CPSM550 --target-directory /var/cicsts/bundles
A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.
Usage
zowe profiles create cics-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new cics profile. You can load this profile by using the name on commands that support the "--cics-profile" option.
Required Options
-
--host
| -H
(string)
- The CMCI server host name
-
--user
| -u
(string)
- Your username to connect to CICS
-
--password
| -p
(string)
- Your password to connect to CICS
Options
Cics Connection Options
Examples
A profile for interaction with Db2 for the z/OS region
Usage
zowe profiles create db2-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new db2 profile. You can load this profile by using the name on commands that support the "--db2-profile" option.
Options
-
--host
| -H
(string)
-
--port
| -P
(number)
- The Db2 server port number
-
--user
| -u
(string)
- The Db2 user ID (may be the same as the TSO login)
-
--password
| --pass
| --pw
(string)
- The Db2 password (may be the same as the TSO password)
-
--database
| -d
(string)
-
--ssl-file
| -s
(string)
- Path to an SSL Certificate file
-
--overwrite
| --ow
(boolean)
- Overwrite the db2 profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
Usage
zowe profiles create dbm-db2-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the "--dbm-db2-profile" option.
dbm-db2 Common Options
-
--job-cards
| --jc
(string)
-
Specifies a newline delimited string of z/OS JCL JOB statements.
Default value: //DB2DVOPS JOB (<nnn>),'DB2 PROVISIONING',NOTIFY=&SYSUID,\n// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),\n// REGION=0M,TIME=NOLIMIT
-
--work-dataset-prefix
| --wdp
(string)
-
--authid
| -a
(string)
-
--sqlid
| -s
(string)
-
--termination-character
| --tc
(string)
-
Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements.
You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.
-
--overwrite-output-files
| --oof
(boolean)
dbm-db2 Connection Options
-
--host
| -H
(string)
-
--port
| -P
(number)
-
--user
| -u
(string)
-
--password
| --pass
| --pw
(string)
-
Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.
Default value: <password>
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
(string)
-
Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.
Default value: https
Allowed values: http, https
-
--environment-list
| --el
(string)
-
Specifies a string of one or more paired values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through multiple DBM Data Service environments.
Format:
<ssid1>:<env1>, <ssid2>:<env2>, …
<ssid> is the subsystem ID. <env> is an entry that is configured in the DBM Data Service environments.yaml file. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt.
Example: ssid:prod@host1.net:7300,ssid2:test@host2.net:7300
Options
Examples
-
Create a dbm-db2 profile named profile_name1 and default values for all the dbm-db2-profile options:
zowe profiles create dbm-db2-profile profile_name1
-
Create a dbm-db2 profile named dbm123 that connects to the DBM Data Service at host dbm123 and port 1443 as user db2user and password myp4ss:
zowe profiles create dbm-db2-profile dbm123 --host dbm123 --port 1443 --user db2user --password myp4ss
-
Create a dbm-db2 profile named dbm124 that connects to the DBM Data Service at host dbm124 and the default port as user db2user and password myp4ss, and allow self-signed certificates:
zowe profiles create dbm-db2-profile dbm124 --host dbm124 --user db2user --password myp4ss --reject-unauthorized false
-
Create a dbm-db2 profile named dbm125 that connects to the DBM Data Service at host dbm125 and port 1443 and requires a user and password to be specified on every dbm-db2 command. DBM Data Service access to Db2 subsystems SUBA and SUBB uses prod@host1.com:322 and test@host2.com:522, respectively:
zowe profiles create dbm-db2-profile dbm125 --host dbm125 --port 1443 --el “SUBA:prod@host1.com:322,SUBB:test@host2.net:522”
An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.
Usage
zowe profiles create ebg-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ebg profile. You can load this profile by using the name on commands that support the "--ebg-profile" option.
CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Options
The Endevor element location, where you specify your working environment, system and subsystem
Usage
zowe profiles create endevor-location-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new endevor-location profile. You can load this profile by using the name on commands that support the "--endevor-location-profile" option.
Options
-
--instance
| -i
(string)
- The STC/datasource of the session
-
--environment
| --env
(string)
-
--system
| --sys
(string)
- The Endevor system where the element resides
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your element resides
-
--type
| --typ
(string)
- Name of the Endevor element's type
-
--stage-number
| --sn
(string)
-
--comment
| --com
(string)
- The Endevor comment you want to use when performing an action
-
--ccid
| --cci
(string)
- The Endevor CCID you want to use when performing an action
-
--maxrc
(number)
-
--overwrite
| --ow
(boolean)
- Overwrite the endevor-location profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
Examples
-
Create a location profile called 'ndvrLoc' to work at Endevor location ENV/1/SYS/SUBSYS, with elements of type COBOL, using Endevor web services configuration ENDEVOR:
zowe profiles create endevor-location-profile ndvrLoc --env ENV --sys SYS --sub SUBSYS --typ COBOL --sn 1 -i ENDEVOR
-
Create a location profile called 'ndvrLoc2' to work at Endevor location ENV/1/SYS/SUBSYS, using CCID 'CCID' and comment 'sample comment':
zowe profiles create endevor-location-profile ndvrLoc2 --env ENV --sys SYS --sub SUBSYS --sn 1 --com 'sample comment' --cci 'CCID'
The Endevor endevor profile schema, where you specify your endevor session information and credentials
Usage
zowe profiles create endevor-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new endevor profile. You can load this profile by using the name on commands that support the "--endevor-profile" option.
Options
-
--host
| --hostname
(string)
- The hostname of the endevor session
-
--port
| -p
(number)
- The port number of the endevor session
-
--user
| --username
(string)
- The username of the endevor session
-
--password
| --pass
(string)
-
--protocol
| --prot
(string)
-
--base-path
| --bp
(string)
-
--reject-unauthorized
| --ru
(boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--overwrite
| --ow
(boolean)
- Overwrite the endevor profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
Examples
-
Create an endevor profile called 'ndvrSample' to connect to Endevor web services at host ndvr123 and port 8080,using http protocol, with /EndevorService/rest base path, allowing self-signed certificates:
zowe profiles create endevor-profile ndvrSample --host ndvr123 --port 8080 --user ibmuser --password myp4ss --prot http --base-path EndevorService/rest --reject-unauthorized false
File Master Plus profile schema.
Usage
zowe profiles create fmp-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new fmp profile. You can load this profile by using the name on commands that support the "--fmp-profile" option.
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Options
Examples
-
Create a fmp profile with http protocol:
zowe profiles create fmp-profile fmp123 --host fmphost --port 19853 --user mfuser --password m4pass --protocol http
-
Create a fmp profile with https protocol and allow self-signed certificates:
zowe profiles create fmp-profile fmp234 --host fmphost --port 19854 --user mfuser --password m4pass --protocol https --reject-unauthorized false
-
Create a fmp profile with API Mediation layer:
zowe profiles create fmp-profile fmpAPIML --host fmpAPIML --port 2020 --user mfuser --pass mfp4ss --protocol https --reject-unauthorized false --base-path /api/v1/serviceID
An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information
Usage
zowe profiles create idms-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new idms profile. You can load this profile by using the name on commands that support the "--idms-profile" option.
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--reject-unauthorized
| --ru
(boolean)
Options
Examples
-
Create an IDMS profile called 'idms11' to connect to IDMS API services at host zos123 and port 1234, with base path api/v1/caidms and allow self-signed certificates:
zowe profiles create idms-profile idms11 --host zos123 --port 1234 --user myuid --password mypass --base-path api/v1/caidms --reject-unauthorized false
-
Create an IDMS profile called 'idms99' to connect to IDMS API services at host zos123 and port 1234, specify a default data source SYS195 to be used by JDBC to identify a target system and allow self-signed certificates:
zowe profiles create idms-profile idms99 --host zos123 --port 1234 --user myuid --password mypass --datasource SYS195 --reject-unauthorized false
An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.
Usage
zowe profiles create ims-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ims profile. You can load this profile by using the name on commands that support the "--ims-profile" option.
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Options
Examples
A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.
Usage
zowe profiles create jclcheck-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new jclcheck profile. You can load this profile by using the name on commands that support the "--jclcheck-profile" option.
JCLCheck Connection Options
-
--host
| -H
(string)
- Host name of the JCLCheck API service that is running on the mainframe system.
-
--port
| -P
(number)
- Port for the JCLCheck API service that is running on the mainframe system.
-
--user
| -u
(string)
- User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--password
| --pass
| --pw
(string)
- Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--reject-unauthorized
| --ru
(boolean)
-
--protocol
| -o
(string)
-
Specifies protocol to use for JCLCheck connection (http or https).
Default value: https
Allowed values: http, https
-
--jclcheck-options
| --jo
(string)
- The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
Options
Examples
MAT Analyze CLI profile schema.
Usage
zowe profiles create mat-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new mat profile. You can load this profile by using the name on commands that support the "--mat-profile" option.
MAT Profile Options
-
--protocol
| --prt
(string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Allowed values: http, https
-
--hostname
| --hn
(string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port
| --pt
(number)
- Specifies the server port (e.g. 8080).
-
--username
| --user
(string)
-
--password
| --pass
(string)
-
--zowediscoverable
| --zdis
(boolean)
-
Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your MAT REST API server settings.
Allowed values: false, true
-
--listingDir
| --ldir
(string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
Options
Examples
-
Create a MAT profile called 'matprofile' using your MAT configuration and REST API details, with the MAT REST API server integrated with the Zowe API Mediation Layer:
zowe profiles create mat-profile matprofile --prt http --hn localhost --pt 1234 --user user --pass pass --zowediscoverable true
-
Create a MAT profile called 'matprofile' using your MAT configuration and the details of the MAT REST API server without integration with the Zowe API Mediation Layer,and define the 'c:\listings' directory to store program listings for instant analysis from your VS Code IDE:
zowe profiles create mat-profile matprofile --prt http --hn localhost --pt 1234 --user user --pass pass --zowediscoverable false --listingDir 'c:\listings'
An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface
Usage
zowe profiles create mq-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new mq profile. You can load this profile by using the name on commands that support the "--mq-profile" option.
Required Options
-
--host
| -H
(string)
- The MQ Rest server host name
-
--port
| -P
(number)
- Port number of your MQ REST API server
-
--user
| -u
(string)
- User name to authenticate to your MQ REST API server
-
--password
| -p
(string)
- Password to authenticate to your MQ REST API server
MQ Connection Options
Options
Examples
The OPS Web Services session profile schema, where you specify your session information and credentials
Usage
zowe profiles create ops-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ops profile. You can load this profile by using the name on commands that support the "--ops-profile" option.
OPS WEB SERVICES CONNECTION OPTIONS
-
--host
(string)
- The hostname of the server where OPS Web Services is running.
-
--port
| -p
(number)
- The port number for OPS Web Services.
-
--user
(string)
- Your z/OS user name used to authenticate to OPS Web Services
-
--password
| --pass
(string)
- Your z/OS password used to authenticate to OPS Web Services
-
--protocol
| --prot
(string)
-
The protocol used for connecting to OPS Web Services
Default value: https
Allowed values: http, https
-
--reject-unauthorized
| --ru
(boolean)
-
--subsystem
| --subs
(string)
- Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
Options
Examples
MAT Detect CLI profile schema.
Usage
zowe profiles create pma-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new pma profile. You can load this profile by using the name on commands that support the "--pma-profile" option.
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
-
Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
Default value: A
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
Options
Examples
A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.
Usage
zowe profiles create rse-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new rse profile. You can load this profile by using the name on commands that support the "--rse-profile" option.
Zowe REST Connection Options
-
--host
| -H
(string)
- The z/OS host name running the Zowe REST API.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name for the Zowe REST API operations.
-
--password
| --pass
(string)
- The password of the user for the Zowe REST API operations.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
-
--protocol
| --protocol
(string)
-
--encoding
| --ec
(string)
- The encoding for download and upload of z/OS data set and USS files. The encoding should be specified in the form of "IBM-1047".
Options
Examples
-
Create an RSE API profile named 'myRseApiProfile' to connect to z/OS using the RSE API server at host zos123 that runs on port 6800 and has a base path of 'rseapi' and uses the 'http' protocol. An example base URL to RSE API would be: 'http://zos123:6800/rseapi/api/v1/':
zowe profiles create rse-profile myRseApiProfile --host zos123 --port 6800 --user ibmuser --pass myp4ss --bp rseapi --protocol http --ru false
-
Create a profile named 'myZoweRestProfile' to connect to z/OS using the Zowe REST APIs at host zos123 that runs the Zowe REST API server on port 8443, requires a TLS handshake using 'https' with SSL certificates, and has a default encoding of IBM-285. An example base URL to Zowe REST API would be: 'https://zos123:6800/api/v1/':
zowe profiles create rse-profile myZoweRestProfile --host zos123 --port 8443 --user ibmuser --pass myp4ss --ru false --protocol https --ec IBM-285
Profile for System Automation Plug-in
Usage
zowe profiles create sa-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new sa profile. You can load this profile by using the name on commands that support the "--sa-profile" option.
SA CONNECTTION OPTIONS
Options
z/OS SSH Profile
Usage
zowe profiles create ssh-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ssh profile. You can load this profile by using the name on commands that support the "--ssh-profile" option.
z/OS Ssh Connection Options
-
--host
| -H
(string)
- The z/OS SSH server host name.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password.
-
--privateKey
| --key
| --pk
(string)
- Path to a file containing your private key, that must match a public key stored in the server for authentication
-
--keyPassphrase
| --passphrase
| --kp
(string)
- Private key passphrase, which unlocks the private key.
-
--handshakeTimeout
| --timeout
| --to
(number)
- How long in milliseconds to wait for the SSH handshake to complete.
Options
Examples
-
Create a ssh profile called 'ssh111' to connect to z/OS SSH server at host 'zos123' and default port 22:
zowe profiles create ssh-profile ssh111 --host sshhost --user ibmuser --password myp4ss
-
Create a ssh profile called 'ssh222' to connect to z/OS SSH server at host 'zos123' and port 13022:
zowe profiles create ssh-profile ssh222 --host sshhost --port 13022 --user ibmuser --password myp4ss
-
Create a ssh profile called 'ssh333' to connect to z/OS SSH server at host 'zos123' using a privatekey '/path/to/privatekey' and its decryption passphrase 'privateKeyPassphrase' for privatekey authentication:
zowe profiles create ssh-profile ssh333 --host sshhost --user ibmuser --privateKey /path/to/privatekey --keyPassphrase privateKeyPassphrase
-
Create a ssh profile called 'ssh444' to connect to z/OS SSH server on default port 22, without specifying username, host, or password, preventing those values from being stored on disk:
zowe profiles create ssh-profile ssh444 --privateKey /path/to/privatekey
The SYSVIEW format profile schema, where you specify display settings
Usage
zowe profiles create sysview-format-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new sysview-format profile. You can load this profile by using the name on commands that support the "--sysview-format-profile" option.
display options
-
--context-fields
| --cf
(array)
- Context fields to display. Defaults to hiding all context
-
--overview
| -o
(boolean)
- Display the overview section
-
--info
| -i
(boolean)
- Display the information area, if any
-
--pretty
| -p
(boolean)
-
--blank-if-zero
| --biz
| -b
(boolean)
- Show a blank space instead of '0' values
-
--truncate
| --tr
(boolean)
Options
Examples
-
Create a SYSVIEW format profile to display the context fields 'commandName' and 'screenTitle', the information area, and not the overview area for all requests. Data will be formatted, and '0's will be blanked:
zowe profiles create sysview-format-profile myFormat --cf commandName screenTitle --overview false --info true --pretty true --biz true
The SYSVIEW session profile schema, where you specify your session information and credentials
Usage
zowe profiles create sysview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new sysview profile. You can load this profile by using the name on commands that support the "--sysview-profile" option.
sysview connection options
-
--host
| -H
(string)
- The hostname of the SYSVIEW REST API
-
--port
| -P
(number)
- The port number of the SYSVIEW REST API
-
--user
| -u
(string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password
| --pass
| --pw
(string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized
| --ru
(boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid
(string)
-
--base-path
| --bp
(string)
Options
Examples
-
Create a SYSVIEW profile called 'myLPAR' to connect to the SYSVIEW REST API at host lpar123, port 8080, and ssid ABCD:
zowe profiles create sysview-profile myLPAR --host lpar123 --port 8080 --user ibmuser --password !@#$^ --ssid ABCD
-
You already have a base profile with username and password. Create a SYSVIEW profile to specify host lpar123 and port 8080, using the default ssid of GSVX:
zowe profiles create sysview-profile myLPAR2 --host lpar123 --port 8080
-
You already have a base profile to connect to an API Mediation Layer and use SSO tokens. Create a SYSVIEW profile to point to the SYSVIEW REST API by specifying the base path /my-sysview-instance/api/v1:
zowe profiles create sysview-profile myLPAR3 --base-path /api/v1/my-sysview-instance
z/OS TSO/E User Profile
Usage
zowe profiles create tso-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new tso profile. You can load this profile by using the name on commands that support the "--tso-profile" option.
TSO ADDRESS SPACE OPTIONS
-
--account
| -a
(string)
- Your z/OS TSO/E accounting information.
-
--character-set
| --cs
(string)
-
--code-page
| --cp
(string)
-
--columns
| --cols
(number)
-
--logon-procedure
| -l
(string)
-
--region-size
| --rs
(number)
-
--rows
(number)
Options
Examples
-
Create a tso profile called 'myprof' with default settings and JES accounting information of 'IZUACCT':
zowe profiles create tso-profile myprof -a IZUACCT
-
Create a tso profile called 'largeregion' with a region size of 8192, a logon procedure of MYPROC, and JES accounting information of '1234':
zowe profiles create tso-profile largeregion -a 1234 --rs 8192
-
Create a tso profile called 'myprof2' with default settings and region size of 8192, without storing the user account on disk:
zowe profiles create tso-profile myprof2 --rs 8192
A profile for interaction with WA REST Services
Usage
zowe profiles create wa-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new wa profile. You can load this profile by using the name on commands that support the "--wa-profile" option.
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Options
Examples
Configuration profile for z/OS FTP
Usage
zowe profiles create zftp-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new zftp profile. You can load this profile by using the name on commands that support the "--zftp-profile" option.
Options
-
--host
| -H
(string)
- The hostname or IP address of the z/OS server to connect to.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Username for authentication on z/OS
-
--password
| -p
| --pass
| --pw
(string)
- Password to authenticate to FTP.
-
--secure-ftp
(boolean)
-
Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.
Default value: true
-
--connection-timeout
| --ct
(number)
-
--overwrite
| --ow
(boolean)
- Overwrite the zftp profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
TLS / Secure Connection options
Examples
The NetView profile is the profile that you created to communicate with the NetView REST Server. It is required to use Z NetView Plug-ins, including Z NetView Base Plug-in, Z NetView Automation Plug-in and Z NetView Network Plug-in.
Usage
zowe profiles create znetview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new znetview profile. You can load this profile by using the name on commands that support the "--znetview-profile" option.
Options
-
--automation-table-file-path
| --atfp
(string)
- The path of the automation table file on the workstation where the Zowe CLI is running on.
-
--overwrite
| --ow
(boolean)
- Overwrite the znetview profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
NetView Connection Options
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
Examples
z/OS Connect EE connection profile
Usage
zowe profiles create zosconnect-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new zosconnect profile. You can load this profile by using the name on commands that support the "--zosconnect-profile" option.
Required Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
Options
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
-
--rejectUnauthorized
| --ru
(boolean)
-
--overwrite
| --ow
(boolean)
- Overwrite the zosconnect profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
z/OSMF Profile
Usage
zowe profiles create zosmf-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new zosmf profile. You can load this profile by using the name on commands that support the "--zosmf-profile" option.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Options
-
--encoding
| --ec
(number)
- The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is 1047.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
-
--overwrite
| --ow
(boolean)
- Overwrite the zosmf profile when a profile of the same name exists.
-
--disable-defaults
| --dd
(boolean)
- Disable populating profile values of undefined properties with default values.
Examples
-
Create a zosmf profile called 'zos123' to connect to z/OSMF at host zos123 and port 1443:
zowe profiles create zosmf-profile zos123 --host zos123 --port 1443 --user ibmuser --password myp4ss
-
Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) and allow self-signed certificates:
zowe profiles create zosmf-profile zos124 --host zos124 --user ibmuser --password myp4ss --reject-unauthorized false
-
Create a zosmf profile called 'zos125' to connect to z/OSMF at the host zos125 and port 1443, not specifying a username or password so they are not stored on disk; these will need to be specified on every command:
zowe profiles create zosmf-profile zos125 --host zos125 --port 1443
-
Create a zosmf profile called 'zos126' to connect to z/OSMF on the default port 443 and allow self-signed certificates, not specifying a username, password, or host so they are not stored on disk; these will need to be specified on every command:
zowe profiles create zosmf-profile zos126 --reject-unauthorized false
-
Create a zosmf profile called 'zos124' to connect to z/OSMF at the host zos124 (default port - 443) and allow self-signed certificates:
zowe profiles create zosmf-profile zosAPIML --host zosAPIML --port 2020 --user ibmuser --password myp4ss --reject-unauthorized false --base-path basePath
Delete existing profiles.
Delete a base profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete base-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the base profile to be deleted. You can also load this profile by using the name on commands that support the "--base-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a ca7 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete ca7-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the ca7 profile to be deleted. You can also load this profile by using the name on commands that support the "--ca7-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a caspool profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete caspool-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the caspool profile to be deleted. You can also load this profile by using the name on commands that support the "--caspool-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a caview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete caview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the caview profile to be deleted. You can also load this profile by using the name on commands that support the "--caview-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a cics-deploy profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete cics-deploy-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the cics-deploy profile to be deleted. You can also load this profile by using the name on commands that support the "--cics-deploy-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a cics profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete cics-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the cics profile to be deleted. You can also load this profile by using the name on commands that support the "--cics-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete db2-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the db2 profile to be deleted. You can also load this profile by using the name on commands that support the "--db2-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a dbm-db2 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete dbm-db2-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the dbm-db2 profile to be deleted. You can also load this profile by using the name on commands that support the "--dbm-db2-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a ebg profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete ebg-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the ebg profile to be deleted. You can also load this profile by using the name on commands that support the "--ebg-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a endevor-location profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete endevor-location-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the endevor-location profile to be deleted. You can also load this profile by using the name on commands that support the "--endevor-location-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a endevor profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete endevor-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the endevor profile to be deleted. You can also load this profile by using the name on commands that support the "--endevor-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a fmp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete fmp-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the fmp profile to be deleted. You can also load this profile by using the name on commands that support the "--fmp-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a idms profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete idms-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the idms profile to be deleted. You can also load this profile by using the name on commands that support the "--idms-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a ims profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete ims-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the ims profile to be deleted. You can also load this profile by using the name on commands that support the "--ims-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a jclcheck profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete jclcheck-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the jclcheck profile to be deleted. You can also load this profile by using the name on commands that support the "--jclcheck-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a mat profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete mat-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the mat profile to be deleted. You can also load this profile by using the name on commands that support the "--mat-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a mq profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete mq-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the mq profile to be deleted. You can also load this profile by using the name on commands that support the "--mq-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a ops profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete ops-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the ops profile to be deleted. You can also load this profile by using the name on commands that support the "--ops-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a pma profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete pma-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the pma profile to be deleted. You can also load this profile by using the name on commands that support the "--pma-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a rse profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete rse-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the rse profile to be deleted. You can also load this profile by using the name on commands that support the "--rse-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a sa profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete sa-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the sa profile to be deleted. You can also load this profile by using the name on commands that support the "--sa-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a ssh profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete ssh-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the ssh profile to be deleted. You can also load this profile by using the name on commands that support the "--ssh-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a sysview-format profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete sysview-format-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the sysview-format profile to be deleted. You can also load this profile by using the name on commands that support the "--sysview-format-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a sysview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete sysview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the sysview profile to be deleted. You can also load this profile by using the name on commands that support the "--sysview-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a tso profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete tso-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the tso profile to be deleted. You can also load this profile by using the name on commands that support the "--tso-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a wa profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete wa-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the wa profile to be deleted. You can also load this profile by using the name on commands that support the "--wa-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a zftp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete zftp-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the zftp profile to be deleted. You can also load this profile by using the name on commands that support the "--zftp-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a znetview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete znetview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the znetview profile to be deleted. You can also load this profile by using the name on commands that support the "--znetview-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a zosconnect profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete zosconnect-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the zosconnect profile to be deleted. You can also load this profile by using the name on commands that support the "--zosconnect-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
Delete a zosmf profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Usage
zowe profiles delete zosmf-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the zosmf profile to be deleted. You can also load this profile by using the name on commands that support the "--zosmf-profile" option.
Options
-
--force
(boolean)
- Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.
Examples
List profiles of the type {{type}}.
Base profile that stores values shared by multiple service profiles
Usage
zowe profiles list base-profiles [options]
Options
Examples
A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.
Usage
zowe profiles list ca7-profiles [options]
Options
Examples
Configuration profile for Spool, where you specify information about your Spool instance
Usage
zowe profiles list caspool-profiles [options]
Options
Examples
Configuration profile for View
Usage
zowe profiles list caview-profiles [options]
Options
Examples
Specifies the target environment for the cics-deploy deploy and undeploy actions.
Usage
zowe profiles list cics-deploy-profiles [options]
Options
Examples
A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.
Usage
zowe profiles list cics-profiles [options]
Options
Examples
A profile for interaction with Db2 for the z/OS region
Usage
zowe profiles list db2-profiles [options]
Options
Examples
The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
Usage
zowe profiles list dbm-db2-profiles [options]
Options
Examples
An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.
Usage
zowe profiles list ebg-profiles [options]
Options
Examples
The Endevor element location, where you specify your working environment, system and subsystem
Usage
zowe profiles list endevor-location-profiles [options]
Options
Examples
The Endevor endevor profile schema, where you specify your endevor session information and credentials
Usage
zowe profiles list endevor-profiles [options]
Options
Examples
File Master Plus profile schema.
Usage
zowe profiles list fmp-profiles [options]
Options
Examples
An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information
Usage
zowe profiles list idms-profiles [options]
Options
Examples
An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.
Usage
zowe profiles list ims-profiles [options]
Options
Examples
A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.
Usage
zowe profiles list jclcheck-profiles [options]
Options
Examples
MAT Analyze CLI profile schema.
Usage
zowe profiles list mat-profiles [options]
Options
Examples
An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface
Usage
zowe profiles list mq-profiles [options]
Options
Examples
The OPS Web Services session profile schema, where you specify your session information and credentials
Usage
zowe profiles list ops-profiles [options]
Options
Examples
MAT Detect CLI profile schema.
Usage
zowe profiles list pma-profiles [options]
Options
Examples
A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.
Usage
zowe profiles list rse-profiles [options]
Options
Examples
Profile for System Automation Plug-in
Usage
zowe profiles list sa-profiles [options]
Options
Examples
z/OS SSH Profile
Usage
zowe profiles list ssh-profiles [options]
Options
Examples
The SYSVIEW format profile schema, where you specify display settings
Usage
zowe profiles list sysview-format-profiles [options]
Options
Examples
The SYSVIEW session profile schema, where you specify your session information and credentials
Usage
zowe profiles list sysview-profiles [options]
Options
Examples
z/OS TSO/E User Profile
Usage
zowe profiles list tso-profiles [options]
Options
Examples
A profile for interaction with WA REST Services
Usage
zowe profiles list wa-profiles [options]
Options
Examples
Configuration profile for z/OS FTP
Usage
zowe profiles list zftp-profiles [options]
Options
Examples
The NetView profile is the profile that you created to communicate with the NetView REST Server. It is required to use Z NetView Plug-ins, including Z NetView Base Plug-in, Z NetView Automation Plug-in and Z NetView Network Plug-in.
Usage
zowe profiles list znetview-profiles [options]
Options
Examples
z/OS Connect EE connection profile
Usage
zowe profiles list zosconnect-profiles [options]
Options
Examples
z/OSMF Profile
Usage
zowe profiles list zosmf-profiles [options]
Options
Examples
Set which profiles are loaded by default.
The base set default-profiles command allows you to set the default profiles for this command group. When a base command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default base-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the base group. When you issue commands within the base group without a profile specified as part of the command, the default will be loaded instead.
Examples
The ca7 set default-profiles command allows you to set the default profiles for this command group. When a ca7 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default ca7-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the ca7 group. When you issue commands within the ca7 group without a profile specified as part of the command, the default will be loaded instead.
Examples
The caspool set default-profiles command allows you to set the default profiles for this command group. When a caspool command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default caspool-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the caspool group. When you issue commands within the caspool group without a profile specified as part of the command, the default will be loaded instead.
Examples
The caview set default-profiles command allows you to set the default profiles for this command group. When a caview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default caview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the caview group. When you issue commands within the caview group without a profile specified as part of the command, the default will be loaded instead.
Examples
The cics-deploy set default-profiles command allows you to set the default profiles for this command group. When a cics-deploy command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default cics-deploy-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the cics-deploy group. When you issue commands within the cics-deploy group without a profile specified as part of the command, the default will be loaded instead.
Examples
The cics set default-profiles command allows you to set the default profiles for this command group. When a cics command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default cics-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the cics group. When you issue commands within the cics group without a profile specified as part of the command, the default will be loaded instead.
Examples
The db2 set default-profiles command allows you to set the default profiles for this command group. When a db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default db2-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the db2 group. When you issue commands within the db2 group without a profile specified as part of the command, the default will be loaded instead.
Examples
The dbm-db2 set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2 command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default dbm-db2-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the dbm-db2 group. When you issue commands within the dbm-db2 group without a profile specified as part of the command, the default will be loaded instead.
Examples
The ebg set default-profiles command allows you to set the default profiles for this command group. When a ebg command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default ebg-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the ebg group. When you issue commands within the ebg group without a profile specified as part of the command, the default will be loaded instead.
Examples
The endevor-location set default-profiles command allows you to set the default profiles for this command group. When a endevor-location command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default endevor-location-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the endevor-location group. When you issue commands within the endevor-location group without a profile specified as part of the command, the default will be loaded instead.
Examples
The endevor set default-profiles command allows you to set the default profiles for this command group. When a endevor command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default endevor-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the endevor group. When you issue commands within the endevor group without a profile specified as part of the command, the default will be loaded instead.
Examples
The fmp set default-profiles command allows you to set the default profiles for this command group. When a fmp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default fmp-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the fmp group. When you issue commands within the fmp group without a profile specified as part of the command, the default will be loaded instead.
Examples
The idms set default-profiles command allows you to set the default profiles for this command group. When a idms command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default idms-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the idms group. When you issue commands within the idms group without a profile specified as part of the command, the default will be loaded instead.
Examples
The ims set default-profiles command allows you to set the default profiles for this command group. When a ims command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default ims-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the ims group. When you issue commands within the ims group without a profile specified as part of the command, the default will be loaded instead.
Examples
The jclcheck set default-profiles command allows you to set the default profiles for this command group. When a jclcheck command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default jclcheck-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the jclcheck group. When you issue commands within the jclcheck group without a profile specified as part of the command, the default will be loaded instead.
Examples
The mat set default-profiles command allows you to set the default profiles for this command group. When a mat command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default mat-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the mat group. When you issue commands within the mat group without a profile specified as part of the command, the default will be loaded instead.
Examples
The mq set default-profiles command allows you to set the default profiles for this command group. When a mq command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default mq-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the mq group. When you issue commands within the mq group without a profile specified as part of the command, the default will be loaded instead.
Examples
The ops set default-profiles command allows you to set the default profiles for this command group. When a ops command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default ops-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the ops group. When you issue commands within the ops group without a profile specified as part of the command, the default will be loaded instead.
Examples
The pma set default-profiles command allows you to set the default profiles for this command group. When a pma command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default pma-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the pma group. When you issue commands within the pma group without a profile specified as part of the command, the default will be loaded instead.
Examples
The rse set default-profiles command allows you to set the default profiles for this command group. When a rse command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default rse-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the rse group. When you issue commands within the rse group without a profile specified as part of the command, the default will be loaded instead.
Examples
The sa set default-profiles command allows you to set the default profiles for this command group. When a sa command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default sa-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the sa group. When you issue commands within the sa group without a profile specified as part of the command, the default will be loaded instead.
Examples
The ssh set default-profiles command allows you to set the default profiles for this command group. When a ssh command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default ssh-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the ssh group. When you issue commands within the ssh group without a profile specified as part of the command, the default will be loaded instead.
Examples
The sysview-format set default-profiles command allows you to set the default profiles for this command group. When a sysview-format command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default sysview-format-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the sysview-format group. When you issue commands within the sysview-format group without a profile specified as part of the command, the default will be loaded instead.
Examples
The sysview set default-profiles command allows you to set the default profiles for this command group. When a sysview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default sysview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the sysview group. When you issue commands within the sysview group without a profile specified as part of the command, the default will be loaded instead.
Examples
The tso set default-profiles command allows you to set the default profiles for this command group. When a tso command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default tso-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the tso group. When you issue commands within the tso group without a profile specified as part of the command, the default will be loaded instead.
Examples
The wa set default-profiles command allows you to set the default profiles for this command group. When a wa command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default wa-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the wa group. When you issue commands within the wa group without a profile specified as part of the command, the default will be loaded instead.
Examples
The zftp set default-profiles command allows you to set the default profiles for this command group. When a zftp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default zftp-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the zftp group. When you issue commands within the zftp group without a profile specified as part of the command, the default will be loaded instead.
Examples
The znetview set default-profiles command allows you to set the default profiles for this command group. When a znetview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default znetview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the znetview group. When you issue commands within the znetview group without a profile specified as part of the command, the default will be loaded instead.
Examples
The zosconnect set default-profiles command allows you to set the default profiles for this command group. When a zosconnect command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default zosconnect-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the zosconnect group. When you issue commands within the zosconnect group without a profile specified as part of the command, the default will be loaded instead.
Examples
The zosmf set default-profiles command allows you to set the default profiles for this command group. When a zosmf command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Usage
zowe profiles set-default zosmf-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specify a
profile for default usage within the zosmf group. When you issue commands within the zosmf group without a profile specified as part of the command, the default will be loaded instead.
Examples
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.
Base profile that stores values shared by multiple service profiles
Usage
zowe profiles update base-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new base profile. You can load this profile by using the name on commands that support the "--base-profile" option.
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
- Reject self-signed certificates.
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.
Usage
zowe profiles update ca7-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ca7 profile. You can load this profile by using the name on commands that support the "--ca7-profile" option.
CA7 Connection Options
Configuration profile for Spool, where you specify information about your Spool instance
Usage
zowe profiles update caspool-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new caspool profile. You can load this profile by using the name on commands that support the "--caspool-profile" option.
SPOOL OPTIONS
Examples
-
Update the TSO account information to '3213213210' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --account 3213213210
-
Update high level qualifier of the Spool installation to 'CASPOOL.HLQ' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --spoolhlq CASPOOL.HLQ
-
Update the Spool subsystem name to 'ESF2' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --subsys ESF2
-
Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --outds OUTPUT.RESPONSE.DS.NEW
-
Update the data set containing ESFZOWE REXX exec to 'USER.CLIST' for Spool profile named 'myProfile':
zowe profiles update caspool-profile myProfile --clist USER.CLIST
Configuration profile for View
Usage
zowe profiles update caview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new caview profile. You can load this profile by using the name on commands that support the "--caview-profile" option.
Options
Specifies the target environment for the cics-deploy deploy and undeploy actions.
Usage
zowe profiles update cics-deploy-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new cics-deploy profile. You can load this profile by using the name on commands that support the "--cics-deploy-profile" option.
Options
-
--cicsplex
| --cp
(string)
- Specifies the CICSplex (up to 8 characters) to target.
-
--scope
| --sc
(string)
- Specifies the name of the CICS System, or CICS System Group (up to 8 characters) to target.
-
--csd-group
| --cg
| --csdgroup
(string)
- Specifies the CSD group (up to 8 characters) for the bundle resource. If a bundle is deployed then a definition is added to this group; if a bundle is undeployed then the definition is removed from this group. The CSD group is changed for each CICS system that is specified by the --scope option. The --csd-group and --res-group options are mutually exclusive.
-
--res-group
| --rg
| --resgroup
(string)
- Specifies the BAS resource group (up to 8 characters) for the bundle resource. If a bundle is deployed then a resource is defined in the BAS data repository; if a bundle is undeployed then the definition is removed. The --csd-group and --res-group options are mutually exclusive.
-
--cics-hlq
| --cq
| --cicshlq
(string)
- Specifies the High Level Qualifier (up to 35 characters) at which the CICS datasets can be found in the target environment.
-
--cpsm-hlq
| --cph
| --cpsmhlq
(string)
- Specifies the High Level Qualifier (up to 35 characters) at which the CPSM datasets can be found in the target environment.
-
--target-directory
| --td
| --targetdir
| --target-dir
(string)
- Specifies the target zFS location to which CICS bundles should be uploaded (up to 255 characters).
-
--job-card
| --jc
| --jobcard
(string)
- Specifies the job card to use with any generated DFHDPLOY JCL.
A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.
Usage
zowe profiles update cics-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new cics profile. You can load this profile by using the name on commands that support the "--cics-profile" option.
Options
-
--host
| -H
(string)
- The CMCI server host name
-
--port
| -P
(number)
-
--user
| -u
(string)
- Your username to connect to CICS
-
--password
| -p
(string)
- Your password to connect to CICS
-
--region-name
(string)
- The name of the CICS region name to interact with
-
--cics-plex
(string)
- The name of the CICSPlex to interact with
Cics Connection Options
A profile for interaction with Db2 for the z/OS region
Usage
zowe profiles update db2-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new db2 profile. You can load this profile by using the name on commands that support the "--db2-profile" option.
Options
The dbm-db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
Usage
zowe profiles update dbm-db2-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new dbm-db2 profile. You can load this profile by using the name on commands that support the "--dbm-db2-profile" option.
dbm-db2 Common Options
-
--job-cards
| --jc
(string)
- Specifies a newline delimited string of z/OS JCL JOB statements.
-
--work-dataset-prefix
| --wdp
(string)
- Specifies the prefix that is used as the high level qualifier in z/OS work data set names.
-
--authid
| -a
(string)
- Specifies the primary Db2 authorization ID (user ID) that is used to establish a connection between Db2 and a process.
-
--sqlid
| -s
(string)
- Specifies the authorization ID that is used as the value in generated SET CURRENT SQLID statements most of the time.
-
--termination-character
| --tc
(string)
-
Specifies the SQL termination character that you want to use to terminate object DDL for triggers, XML indexes, functions, and procedures that contain embedded semicolon-terminated SQL statements.
You cannot use a comma, an underscore, a single quote, double quotes, left parentheses, or right parentheses for this value.
-
--overwrite-output-files
| --oof
(boolean)
dbm-db2 Connection Options
-
--host
| -H
(string)
- Specifies the DBM Data Service REST API server host name or TCP/IP address to use.
-
--port
| -P
(number)
- Specifies the DBM Data Service REST API server TCP/IP port number.
-
--user
| -u
(string)
- Specifies the mainframe user name that you want to use to connect to the mainframe systems during execution of the Zowe CLI commands. This user name can be the same as your TSO login ID.
-
--password
| --pass
| --pw
(string)
- Specifies the mainframe password for the user name that is used to connect to the mainframe systems during execution of the CLI commands. This password can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
- Determines whether the dbm-db2 command is accepted or rejected when a self-signed certificate is returned by the DBM Data Service.
-
--protocol
(string)
-
Specifies the communication protocol to use between the zowe dbm-db2 client and the DBM Data Service.
Allowed values: http, https
-
--environment-list
| --el
(string)
-
Specifies a string of one or more paired values consisting of a Db2 subsystem ID and a DBM Data Service environment pair. The paired entry identifies the DBM Data Service environment to use for a subsystem that is accessible through multiple DBM Data Service environments.
Format:
<ssid1>:<env1>, <ssid2>:<env2>, …
<ssid> is the subsystem ID. <env> is an entry that is configured in the DBM Data Service environments.yaml file. For more information about configuring the DBM Data Service, see the Database Management Solutions for Db2 for z/OS documentation at https://techdocs.broadcom.com/db2mgmt.
Example: ssid:prod@host1.net:7300,ssid2:test@host2.net:7300
Examples
An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the CA Endevor Bridge for Git server of your choice.
Usage
zowe profiles update ebg-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ebg profile. You can load this profile by using the name on commands that support the "--ebg-profile" option.
CA Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
The Endevor element location, where you specify your working environment, system and subsystem
Usage
zowe profiles update endevor-location-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new endevor-location profile. You can load this profile by using the name on commands that support the "--endevor-location-profile" option.
Options
-
--instance
| -i
(string)
- The STC/datasource of the session
-
--environment
| --env
(string)
- The Endevor environment where your project resides
-
--system
| --sys
(string)
- The Endevor system where the element resides
-
--subsystem
| --sub
(string)
- The Endevor subsystem where your element resides
-
--type
| --typ
(string)
- Name of the Endevor element's type
-
--stage-number
| --sn
(string)
-
--comment
| --com
(string)
- The Endevor comment you want to use when performing an action
-
--ccid
| --cci
(string)
- The Endevor CCID you want to use when performing an action
-
--maxrc
(number)
- The return code of Endevor that defines a failed action
The Endevor endevor profile schema, where you specify your endevor session information and credentials
Usage
zowe profiles update endevor-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new endevor profile. You can load this profile by using the name on commands that support the "--endevor-profile" option.
Options
-
--host
| --hostname
(string)
- The hostname of the endevor session
-
--port
| -p
(number)
- The port number of the endevor session
-
--user
| --username
(string)
- The username of the endevor session
-
--password
| --pass
(string)
-
--protocol
| --prot
(string)
-
--base-path
| --bp
(string)
- The base path used for connecting to Endevor Rest API
-
--reject-unauthorized
| --ru
(boolean)
- If set, the server certificate is verified against the list of supplied CAs
File Master Plus profile schema.
Usage
zowe profiles update fmp-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new fmp profile. You can load this profile by using the name on commands that support the "--fmp-profile" option.
FMP Connection Options
-
--host
| -H
(string)
- Specifies File Master Plus server host name.
-
--port
| -P
(number)
- Specifies File Master Plus server port.
-
--user
| -u
(string)
- Specifies Mainframe user name. May be the same as TSO login.
-
--password
| --pass
| --pw
(string)
- Specifies Mainframe password. May be the same as TSO password.
-
--protocol
| -o
(string)
-
--reject-unauthorized
| --ru
(boolean)
- Reject self-signed certificates.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all FMP resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information
Usage
zowe profiles update idms-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new idms profile. You can load this profile by using the name on commands that support the "--idms-profile" option.
IDMS Connection Options
-
--host
| -H
(string)
- Host name of the IDMS REST API service
-
--port
| -P
(number)
- Port for the IDMS REST API service
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login ID
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password
-
--datasource
| -d
(string)
- Identifies the IDMS system where the API request will be sent and is defined in the data sources definition file for the IDMS REST API
-
--base-path
| --bp
(string)
- The base path for your API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. Only specify this option if you are using an API Mediation Layer
-
--reject-unauthorized
| --ru
(boolean)
- Reject self-signed certificates
Examples
An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.
Usage
zowe profiles update ims-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ims profile. You can load this profile by using the name on commands that support the "--ims-profile" option.
IMS Connection Options
-
--host
| -H
(string)
- The IMS Operations API server host name.
-
--port
| -P
(number)
- The IMS Operations API server port.
-
--ims-connect-host
| --ich
(string)
- The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.
-
--ims-connect-port
| --icp
(number)
- The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.
-
--plex
| -x
(string)
- The name of the IMS plex.
-
--user
| -u
(string)
- The web server user name where the IMS Operations API resides.
-
--password
| --pass
(string)
- The web server user password where the IMS Operations API resides.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.
Usage
zowe profiles update jclcheck-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new jclcheck profile. You can load this profile by using the name on commands that support the "--jclcheck-profile" option.
JCLCheck Connection Options
-
--host
| -H
(string)
- Host name of the JCLCheck API service that is running on the mainframe system.
-
--port
| -P
(number)
- Port for the JCLCheck API service that is running on the mainframe system.
-
--user
| -u
(string)
- User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--password
| --pass
| --pw
(string)
- Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--reject-unauthorized
| --ru
(boolean)
- Reject self-signed certificates.
-
--protocol
| -o
(string)
-
--jclcheck-options
| --jo
(string)
- The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.
MAT Analyze CLI profile schema.
Usage
zowe profiles update mat-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new mat profile. You can load this profile by using the name on commands that support the "--mat-profile" option.
MAT Profile Options
-
--protocol
| --prt
(string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Allowed values: http, https
-
--hostname
| --hn
(string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port
| --pt
(number)
- Specifies the server port (e.g. 8080).
-
--username
| --user
(string)
-
--password
| --pass
(string)
-
--zowediscoverable
| --zdis
(boolean)
-
Specifies whether you want to use Zowe API Mediation Layer to process the commands for this profile. Set '--zowediscoverable true' only if you have configured the Zowe API Mediation Layer properties in your MAT REST API server settings.
Allowed values: false, true
-
--listingDir
| --ldir
(string)
- Specifies the directory where you want to store the registered program listings (e.g. 'c:\listings') for your immediate source code inspection. You can use the advantage of automated listing registration with MAT and listing retrieval through Endevor® footprints for Cobol, C/C++, and Assembler programs. When a source program listing is registered with MAT, you can enhance the histogram analysis data with the program listing details that pertain to the specific CSECT and program statement. The listing is transfered to the specified directory, which enables you to navigate directly to the line of the source code in you VS Code IDE and inspect the program statement. To use the listing retrieval option through Endevor® footprints, you need to have the Endevor® Web Services installed and configured and specify the Endevor® web server details in the MAT database configuration.
An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface
Usage
zowe profiles update mq-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new mq profile. You can load this profile by using the name on commands that support the "--mq-profile" option.
Options
-
--host
| -H
(string)
- The MQ Rest server host name
-
--port
| -P
(number)
- Port number of your MQ REST API server
-
--user
| -u
(string)
- User name to authenticate to your MQ REST API server
-
--password
| -p
(string)
- Password to authenticate to your MQ REST API server
MQ Connection Options
The OPS Web Services session profile schema, where you specify your session information and credentials
Usage
zowe profiles update ops-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ops profile. You can load this profile by using the name on commands that support the "--ops-profile" option.
OPS WEB SERVICES CONNECTION OPTIONS
-
--host
(string)
- The hostname of the server where OPS Web Services is running.
-
--port
| -p
(number)
- The port number for OPS Web Services.
-
--user
(string)
- Your z/OS user name used to authenticate to OPS Web Services
-
--password
| --pass
(string)
- Your z/OS password used to authenticate to OPS Web Services
-
--protocol
| --prot
(string)
-
--reject-unauthorized
| --ru
(boolean)
- If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.
-
--subsystem
| --subs
(string)
- Specifies the subsystem id of the OPS/MVS instance to which commands will be directed.
Examples
MAT Detect CLI profile schema.
Usage
zowe profiles update pma-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new pma profile. You can load this profile by using the name on commands that support the "--pma-profile" option.
PMA Connection Options
-
--job_acct
| --ja
(string)
- Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9)
-
--job_class
| --jc
(string)
- Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9)
-
--job_mclass
| --jmc
(string)
- Specifies the MSGCLASS parameter value and assigns the job log to the specified output class. The specified MSGCLASS value is used in all JCLs that PMA runs while you execute the commands. If you do not provide the job_mclass parameter, the default MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9)
-
--job_load
| --jl
(string)
- Specifies the PMA loadlib data set name that you defined during the PMA customization (&HLQ.CEETLOAD)
-
--job_pmahlq
| --jph
(string)
- Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files to collect the necessary data
A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.
Usage
zowe profiles update rse-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new rse profile. You can load this profile by using the name on commands that support the "--rse-profile" option.
Zowe REST Connection Options
-
--host
| -H
(string)
- The z/OS host name running the Zowe REST API.
-
--port
| -P
(number)
- The server port used by the REST API.
-
--user
| -u
(string)
- The user name for the Zowe REST API operations.
-
--password
| --pass
(string)
- The password of the user for the Zowe REST API operations.
-
--reject-unauthorized
| --ru
(boolean)
- Reject self-signed certificates.
-
--base-path
| --bp
(string)
- The base path of the API for the REST API operations.
-
--protocol
| --protocol
(string)
- http or https, depending whether a TLS handshake is required to access REST API.
-
--encoding
| --ec
(string)
- The encoding for download and upload of z/OS data set and USS files. The encoding should be specified in the form of "IBM-1047".
Profile for System Automation Plug-in
Usage
zowe profiles update sa-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new sa profile. You can load this profile by using the name on commands that support the "--sa-profile" option.
SA CONNECTTION OPTIONS
z/OS SSH Profile
Usage
zowe profiles update ssh-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new ssh profile. You can load this profile by using the name on commands that support the "--ssh-profile" option.
z/OS Ssh Connection Options
-
--host
| -H
(string)
- The z/OS SSH server host name.
-
--port
| -P
(number)
- The z/OS SSH server port.
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password.
-
--privateKey
| --key
| --pk
(string)
- Path to a file containing your private key, that must match a public key stored in the server for authentication
-
--keyPassphrase
| --passphrase
| --kp
(string)
- Private key passphrase, which unlocks the private key.
-
--handshakeTimeout
| --timeout
| --to
(number)
- How long in milliseconds to wait for the SSH handshake to complete.
The SYSVIEW format profile schema, where you specify display settings
Usage
zowe profiles update sysview-format-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new sysview-format profile. You can load this profile by using the name on commands that support the "--sysview-format-profile" option.
display options
-
--context-fields
| --cf
(array)
- Context fields to display. Defaults to hiding all context
-
--overview
| -o
(boolean)
- Display the overview section
-
--info
| -i
(boolean)
- Display the information area, if any
-
--pretty
| -p
(boolean)
-
--blank-if-zero
| --biz
| -b
(boolean)
- Show a blank space instead of '0' values
-
--truncate
| --tr
(boolean)
- Truncate displays that are too wide for the console
Examples
The SYSVIEW session profile schema, where you specify your session information and credentials
Usage
zowe profiles update sysview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new sysview profile. You can load this profile by using the name on commands that support the "--sysview-profile" option.
sysview connection options
-
--host
| -H
(string)
- The hostname of the SYSVIEW REST API
-
--port
| -P
(number)
- The port number of the SYSVIEW REST API
-
--user
| -u
(string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password
| --pass
| --pw
(string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized
| --ru
(boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid
(string)
- SSID of the SYSVIEW instance. Default value: GSVX
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Do not specify this option if you are not using an API mediation layer.
Examples
z/OS TSO/E User Profile
Usage
zowe profiles update tso-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new tso profile. You can load this profile by using the name on commands that support the "--tso-profile" option.
TSO ADDRESS SPACE OPTIONS
-
--account
| -a
(string)
- Your z/OS TSO/E accounting information.
-
--character-set
| --cs
(string)
- Character set for address space to convert messages and responses from UTF-8 to EBCDIC.
-
--code-page
| --cp
(string)
- Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.
-
--columns
| --cols
(number)
- The number of columns on a screen.
-
--logon-procedure
| -l
(string)
- The logon procedure to use when creating TSO procedures on your behalf.
-
--region-size
| --rs
(number)
- Region size for the TSO/E address space.
-
--rows
(number)
- The number of rows on a screen.
Examples
A profile for interaction with WA REST Services
Usage
zowe profiles update wa-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new wa profile. You can load this profile by using the name on commands that support the "--wa-profile" option.
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
- Reject self-signed certificates
Configuration profile for z/OS FTP
Usage
zowe profiles update zftp-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new zftp profile. You can load this profile by using the name on commands that support the "--zftp-profile" option.
Options
TLS / Secure Connection options
The NetView profile is the profile that you created to communicate with the NetView REST Server. It is required to use Z NetView Plug-ins, including Z NetView Base Plug-in, Z NetView Automation Plug-in and Z NetView Network Plug-in.
Usage
zowe profiles update znetview-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new znetview profile. You can load this profile by using the name on commands that support the "--znetview-profile" option.
Options
NetView Connection Options
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
z/OS Connect EE connection profile
Usage
zowe profiles update zosconnect-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new zosconnect profile. You can load this profile by using the name on commands that support the "--zosconnect-profile" option.
Options
z/OSMF Profile
Usage
zowe profiles update zosmf-profile <profileName> [options]
Positional Arguments
-
profileName
(string)
- Specifies the name of the new zosmf profile. You can load this profile by using the name on commands that support the "--zosmf-profile" option.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
- Reject self-signed certificates.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
Options
Examples
Perform z/OSMF provisioning tasks on Published Templates in the Service Catalog and Provisioned Instances in the Service Registry.
Deletes instance previously provisioned with z/OSMF cloud provisioning services.
Deletes selected deprovisioned instance.
Usage
zowe provisioning delete instance <name> [options]
Positional Arguments
-
name
(string)
- Deprovisioned Instance name.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
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.
Lists the z/OSMF service catalog published templates.
Usage
zowe provisioning list catalog-templates [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
List details about an instance provisioned with z/OSMF.
Usage
zowe provisioning list instance-info <name> [options]
Positional Arguments
-
name
(string)
- Provisioned Instance Name
Options
-
--display
(string)
-
Level of information to display for the provisioned instance. Possible values:
summary - summary information, no actions or variables
actions - (default) summary with actions, no variables
vars - summary information with variables, no actions
extended - extended information with actions
full - all available information
Allowed values: extended, summary, vars, actions, full
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
List a set of variables and their values for a given name.
Usage
zowe provisioning list instance-variables <name> [options]
Positional Arguments
-
name
(string)
- Provisioned Instance Name
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List the provisioned instances from the z/OSMF software registry.
Usage
zowe provisioning list registry-instances [options]
Options
-
--all-info
| --ai
(boolean)
- Display all available information about provisioned instances (summary by default).
-
--filter-by-type
| --fbt
(string)
- Filter the list of provisioned instances by type (e.g. DB2 or CICS).
-
--filter-by-external-name
| --fben
(string)
- Filter the list of provisioned instances by External Name.
-
--types
| -t
(boolean)
- Display a list of all types for provisioned instances (e.g. DB2 or CICS).
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
List details about a template published with z/OSMF Cloud Provisioning.
Usage
zowe provisioning list template-info <name> [options]
Positional Arguments
-
name
(string)
- The name of a z/OSMF cloud provisioning template.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Perform actions against instances provisioned with z/OSMF.
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
-
name
(string)
- Provisioned Instance name.
-
actionname
(string)
- The action name. Use the "zowe provisioning list instance-info <name>"
command to view available instance actions.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Using z/OSMF cloud provisioning services provision available templates.
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
-
name
(string)
- The name of a z/OSMF cloud provisioning template.
Options
-
--properties
| -p
(string)
- A sequence of string enclosed "name=value" pairs of prompt variables.
e.g: "CSQ_MQ_SSID=ZCT1,CSQ_CMD_PFX=!ZCT1".
-
--properties-file
| --pf
(string)
- Path to .yml file containing properties.
-
--domain-name
| --dn
(string)
- Required if the user has consumer authorization to more than one domain with this template name.
-
--tenant-name
| --tn
(string)
- Required if the user has consumer authorization to more than one tenant in the same domain that contains this template name.
-
--user-data-id
| --udi
(string)
- ID for the user data specified with user-data. Passed into the software services registry.
-
--user-data
| --ud
(string)
- User data that is passed into the software services registry. Can be specified only if user-data-id is provided.
-
--account-info
| --ai
(string)
- Account information to use in the JCL JOB statement. The default is the account information that is associated with the resource pool for the tenant.
-
--system-nick-names
| --snn
(string)
- Each string is the nickname of the system upon which to provision the software service defined by the template. The field is required if the resource pool associated with the tenant used for this operation is not set up to automatically select a system. Only one nickname is allowed.If the field is provided it is validated.
e.g: "SYSNAME1,SYSNAME2".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Welcome to the IBM RSE API Plug-in for Zowe CLI!
Connect to the RSE API Server authentication service and obtain a token. The token provides authentication to services that are supported by the RSE API. When you log in, the token is stored in your profile until it expires. Profiles store connection information, and are used if you do not supply connection information in a command. To take advantage of the token authentication service, you should omit username and password in profiles so that the token in the profile is used.
Log in to an authentication service to obtain a JWT Token.
Usage
zowe rse-api-for-zowe-cli auth login [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Log out of the authentication service and retire the JWT Token
Usage
zowe rse-api-for-zowe-cli auth logout [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Get back JWT Token information if it is not yet expired.
Usage
zowe rse-api-for-zowe-cli auth query [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Cancel a single job by job ID. This cancels the job if it is running or on input.
Cancel a single job by job ID
Usage
zowe rse-api-for-zowe-cli cancel job <jobid> [options]
Positional Arguments
-
jobid
(string)
- The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Change User Data on the Host
Change z/OS User Password on the Host
Usage
zowe rse-api-for-zowe-cli change password <currentPassword> <newPassword> [options]
Positional Arguments
-
currentPassword
(string)
- Current password for z/OS User ID.
-
newPassword
(string)
- New password for z/OS User ID. Must be 8 characters or less.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Change Password:
zowe rse-api-for-zowe-cli change password currentPassword newPassword
Confirm that RSE API is running on a specified system and gather information about the RSE API server and Address Space for diagnostic purposes. Obtain and update MVS mappings file
Download MVS mapping file.
Usage
zowe rse-api-for-zowe-cli check conversion-mappings [options]
Options
-
--force
(boolean)
- This will overwrite an existing rse-mappings.json file.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Display all active job address space information.
Usage
zowe rse-api-for-zowe-cli check job-address-space [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Confirm that RSE API is running on a system specified in your profile and gather information about the RSE API server for diagnostic purposes. The command outputs properties of the RSE API server such as version, hostname, and the port the server is running.
Usage
zowe rse-api-for-zowe-cli check status [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Display active system address space information.
Usage
zowe rse-api-for-zowe-cli check system-address-space [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Copy a data set
Copy a data set to another data set
Usage
zowe rse-api-for-zowe-cli copy data-set <fromDataSetName> <toDataSetName> [options]
Positional Arguments
-
fromDataSetName
(string)
- The name of the data set that you want to copy from
-
toDataSetName
(string)
- The name of the data set that you want to copy to (partitioned data set must be preallocated to copy a member to)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)':
zowe rse-api-for-zowe-cli copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)"
-
Copy the sequential data set named 'USER.FROM.PDSE' to the data set member named 'USER.TO.SETPDSE':
zowe rse-api-for-zowe-cli copy data-set "USER.FROM.PDSE" "USER.TO.SETPDSE"
Create data sets, data set members or uss files and directories
Create a data set based on the properties of an existing data set
Usage
zowe rse-api-for-zowe-cli create data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--allocation-unit
| --au
(string)
- The allocation unit (for example, CYL for Cylinders)
-
--average-blocks
| --ab
(number)
- The number of average blocks (for example, 25)
-
--block-size
| --bs
| --blksize
(number)
- The block size for the data set (for example, 6160)
-
--device-type
| --dt
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
- The number of directory blocks (for example, 25)
-
--like
| --lk
(string)
- Name of an existing data set to base your new data set's properties on
-
--primary-space
| --ps
(number)
- The primary space allocation (for example, 5)
-
--record-format
| --rf
| --recfm
(string)
- The record format for the data set (for example, FB for "Fixed Block")
-
--record-length
| --rl
| --lrecl
(number)
- The logical record length. Analogous to the length of a line (for example, 80)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--show-attributes
| -a
| --pa
(boolean)
- Show the full allocation attributes
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Create a data set with default parameters and like flag:
zowe rse-api-for-zowe-cli create data-set NEW.DATASET --like EXISTING.DATASET
-
Create a data set with default parameters, like flag, and lrecl flag:
zowe rse-api-for-zowe-cli create data-set NEW.DATASET --like EXISTING.DATASET --lrecl 1024
Create a member for a Partitioned data set.
Usage
zowe rse-api-for-zowe-cli create data-set-member <datasetMember> [options]
Positional Arguments
-
datasetMember
(string)
- The name of the data set member that you want to create like so "HLQ.DATASETNAME(NEWMEMBER)".
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create partitioned data sets (PDS)
Usage
zowe rse-api-for-zowe-cli create data-set-partitioned <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--allocation-unit
| --au
(string)
-
--average-blocks
| --ab
(number)
- The number of average blocks (for example, 25)
-
--block-size
| --bs
| --blksize
(number)
-
--device-type
| --dt
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
-
--show-attributes
| -a
| --pa
(boolean)
- Show the full allocation attributes
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create physical sequential data sets (PS)
Usage
zowe rse-api-for-zowe-cli create data-set-sequential <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--allocation-unit
| --au
(string)
-
--average-blocks
| --ab
(number)
- The number of average blocks (for example, 25)
-
--block-size
| --bs
| --blksize
(number)
-
--device-type
| --dt
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
-
--show-attributes
| -a
| --pa
(boolean)
- Show the full allocation attributes
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a uss directory.
Usage
zowe rse-api-for-zowe-cli create uss-directory <ussPath> [options]
Positional Arguments
-
ussPath
(string)
- The name of the directory.
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a uss file.
Usage
zowe rse-api-for-zowe-cli create uss-file <ussPath> [options]
Positional Arguments
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a data set or Unix System Services file
Delete a data set permanently
Usage
zowe rse-api-for-zowe-cli delete data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to delete
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a single job by job ID
Usage
zowe rse-api-for-zowe-cli delete job <jobid> [options]
Positional Arguments
-
jobid
(string)
- The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a Unix Systems Services (USS) File or directory permanently
Usage
zowe rse-api-for-zowe-cli delete uss-file <fileName> [options]
Positional Arguments
-
fileName
(string)
- The name of the file or directory that you want to delete
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Download content from z/OS data sets, USS files, and JOB Output to your PC.
Download all members from a partitioned data set to a local folder
Usage
zowe rse-api-for-zowe-cli download all-members <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set from which you want to download members
Options
-
--binary
| -b
(boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--directory
| -d
(string)
- The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
-
--encoding
| --ec
(string)
- Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--extension
| -e
(string)
- Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
-
--mappings-file
| --maps
(string)
- Location of an alternate MVS Mappings file.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Download the members of the data set "ibmuser.loadlib" to the directory "loadlib/":
zowe rse-api-for-zowe-cli download all-members "ibmuser.loadlib" -d loadlib
-
Download the members of the data set "ibmuser.cntl" as a .jcl to the directory "jcl/":
zowe rse-api-for-zowe-cli download all-members "ibmuser.cntl" -e .jcl -d jcl
-
Download the members of the data set "ibmuser.cntl" as binary.:
zowe rse-api-for-zowe-cli download all-members "ibmuser.cntl" -b
Download content from a z/OS data set to a local file
Usage
zowe rse-api-for-zowe-cli download data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to download
Options
-
--binary
| -b
(boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--encoding
| --ec
(string)
- Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--extension
| -e
(string)
- Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
-
--file
| -f
(string)
- The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
-
--mappings-file
| --maps
(string)
- Location of an alternate MVS Mappings file.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Download all job output to a local directory. Each spool DD will be downloaded to its own file in the directory.
Usage
zowe rse-api-for-zowe-cli download output <jobid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
Options
-
--directory
| -d
| --dir
(string)
- The local directory you would like to download the output for the job to.
-
--extension
| -e
(string)
- A file extension to save the job output with. Defaults to '.txt'.
-
--omit-jobid-directory
| --ojd
(boolean)
- If specified, job output will be saved directly to the specified directory rather than creating a subdirectory named after the ID of the job.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Download content from a USS file to a local file on your PC
Usage
zowe rse-api-for-zowe-cli download uss-file <ussFileName> [options]
Positional Arguments
-
ussFileName
(string)
- The name of the USS file you want to download
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Issue TSO and UNIX commands
Creates a TSO address space, issues a TSO command through the newly createdaddress space, waits for the READY prompt to print the response, and terminatesthe TSO address space. All response data are returned to the user up to (but notincluding) the TSO 'READY' prompt.
Usage
zowe rse-api-for-zowe-cli issue command <commandText> [options]
Positional Arguments
-
commandText
(string)
- The TSO command to issue.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
issues a UNIX command
Usage
zowe rse-api-for-zowe-cli issue unix <commandText> [options]
Positional Arguments
-
commandText
(string)
- The UNIX command to issue.
Required Options
-
--cwd
(string)
- Working directory in which to execute the command.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
List uss file and folders, data sets and data set members, or jobs and spool files. Optionally, you can list their details and attributes.
List all members of a partitioned data set. To view additional information about each member, use the --attributes option under the Options section of this help text.
Usage
zowe rse-api-for-zowe-cli list all-members <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set for which you want to list the members
Options
-
--pattern
| -p
(string)
- Pattern for member filter search.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
List data sets that match a pattern in the data set name
Usage
zowe rse-api-for-zowe-cli list data-set <filter> [options]
Positional Arguments
-
filter
(string)
- The name or pattern of the data set that you want to list
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Show the data set "ibmuser.asm":
zowe rse-api-for-zowe-cli list data-set "ibmuser.asm"
-
Show attributes of the data set "ibmuser.cntl":
zowe rse-api-for-zowe-cli list data-set "ibmuser.cntl" -a
-
Show all data sets of the user "ibmuser":
zowe rse-api-for-zowe-cli list data-set "ibmuser.*"
-
Show attributes of all data sets of the user "ibmuser":
zowe rse-api-for-zowe-cli list data-set "ibmuser.*" -a
List jobs on JES spool/queues. By default, the command lists jobs owned (owner) by the user specified in your profile. The default for prefix is "*". The default status is ALL. The command does not prevalidate your user ID. The command surfaces errors verbatim from the Jobs REST endpoints.
Usage
zowe rse-api-for-zowe-cli list jobs [options]
Options
-
--owner
| -o
(string)
- Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the Jobs REST endpoint documentation, which is usually in the form "USER*".
-
--prefix
| -p
(string)
- Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the Jobs REST endpoint documentation, which is usually in the form "JOB*".
-
--status
| -s
(string)
- Specify if you want to list ALL jobs or only ACTIVE, OUTPUT, or INPUT jobs.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List all jobs with default settings. The command returns jobs owned by your user ID with any job name:
zowe rse-api-for-zowe-cli list jobs
-
List all ACTIVE jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo':
zowe rse-api-for-zowe-cli list jobs -o "ibmu*" -p "myjo*" -s "ACTIVE"
-
List all jobs with default owner and prefix settings, displaying only the job ID of each job:
zowe rse-api-for-zowe-cli list jobs --rff jobid --rft table
Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the RSE API Jobs REST endpoints.
Usage
zowe rse-api-for-zowe-cli list spool-files-by-jobid <jobid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List USS files and directories in a UNIX file path
Usage
zowe rse-api-for-zowe-cli list uss-files <path> [options]
Positional Arguments
-
path
(string)
- The directory containing the files and directories to be listed
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Migrate data sets.
Migrate a data set.
Usage
zowe rse-api-for-zowe-cli migrate data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set you want to migrate.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Recall migrated data sets.
Recall a migrated data set.
Usage
zowe rse-api-for-zowe-cli recall data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set you want to recall.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Rename a Data set, Data set member,File or Directory
Rename a Data Set.
Usage
zowe rse-api-for-zowe-cli rename data-set <dataSetName> <name> [options]
Positional Arguments
-
dataSetName
(string)
- Existing data set name including HLQ.
-
name
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Rename a Data Set Member.
Usage
zowe rse-api-for-zowe-cli rename data-set-member <dataSetMemberName> <name> [options]
Positional Arguments
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Rename a Unix File or Directory.
Usage
zowe rse-api-for-zowe-cli rename uss-file <path> <name> [options]
Positional Arguments
-
path
(string)
- Existing Unix File or Directory Path.
-
name
(string)
- New name of Unix File or Directory.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Submit jobs (JCL) contained in data sets.
Submit a job (JCL) contained in a data set. The data set may be of type physical sequential or a PDS member. The command does not pre-validate the data set name. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.
Usage
zowe rse-api-for-zowe-cli submit data-set <dataset> [options]
Positional Arguments
-
dataset
(string)
- The z/OS data set containing the JCL to submit. You can specify a physical sequential data set (for example, "DATA.SET") or a partitioned data set qualified by a member (for example, "DATA.SET(MEMBER)").
Options
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait the job to complete.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit the JCL in the data set "ibmuser.cntl(deploy)":
zowe rse-api-for-zowe-cli submit data-set "ibmuser.cntl(deploy)"
-
Submit the JCL in the data set "ibmuser.cntl(deploy)", wait for the job to complete and print all output from the job:
zowe rse-api-for-zowe-cli submit data-set "ibmuser.cntl(deploy)" --vasc
Submit a job (JCL) contained in a local file. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.
Usage
zowe rse-api-for-zowe-cli submit local-file <localFile> [options]
Positional Arguments
-
localFile
(string)
- The local file containing the JCL to submit.
Options
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait the job to complete.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Submit a job (JCL) passed to the command via the stdin stream. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.
Usage
zowe rse-api-for-zowe-cli submit stdin [options]
Options
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait the job to complete.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit the JCL using stdin from the command: cat "iefbr14.txt", and then wait for the job to enter OUTPUT status before completing the command:
cat "iefbr14.txt" | zowe rse-api-for-zowe-cli submit stdin --wait-for-output
-
Submit the JCL using stdin from the command: cat "iefbr14.txt", and then printing all spool output:
cat "iefbr14.txt" | zowe rse-api-for-zowe-cli submit stdin --vasc
Upload the contents of a file to z/OS data sets or to uss
Upload files from a local directory to a partitioned data set (PDS)
Usage
zowe rse-api-for-zowe-cli upload dir-to-pds <inputdir> <dataSetName> [options]
Positional Arguments
-
inputdir
(string)
- The path for a local directory that you want to upload to a PDS
-
dataSetName
(string)
- The name of the partitioned data set to which you want to upload the files
Options
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--encoding
| --ec
(string)
- Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--mappings-file
| --maps
(string)
- Location of an alternate MVS Mappings file.
-
--migrated-recall
| --mr
(string)
-
The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error
Default value: nowait
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Upload a local directory to a USS directory.
An optional .zosattributes file in the source directory can be used to control file conversion and tagging.
An example .zosattributes file:
# pattern local-encoding remote-encoding
# Don't upload the node_modules directory
.* -
*.jpg binary binary
# Convert CICS Node.js profiles to EBCDIC
*.profile ISO8859-1 EBCDIC
Lines starting with the ‘#’ character are comments. Each line can specify up to three positional attributes:
- A pattern to match a set of files. Pattern-matching syntax follows the same rules as those that apply in .gitignore files (note that negated patterns that begin with ‘!’ are not supported). See https://git-scm.com/docs/gitignore#_pattern_format.
local-encoding, * A local-encoding to identify a file’s encoding on the local workstation. If '-' is specified for files that match the pattern are not transferred.
- A remote-encoding to specify the file’s desired character set on USS. This attribute must either match the local encoding or be set to EBCDIC. If set to EBCDIC, files are transferred in text mode and converted, otherwise they are transferred in binary mode. Remote files are tagged either with the remote encoding or as binary.
Due to a limitation, files that are transferred in text mode are converted to the default EBCDIC code page on the z/OS system. Therefore the only EBCDIC code page to specify as the remote encoding is the default code page for your system.
A .zosattributes file can either be placed in the top-level directory you want to upload, or its location can be specified by using the --attributes parameter. .zosattributes files that are placed in nested directories are ignored.
Usage
zowe rse-api-for-zowe-cli upload dir-to-uss <inputDir> <USSDir> [options]
Positional Arguments
-
inputDir
(string)
- The local directory path that you want to upload to a USS directory
-
USSDir
(string)
- The name of the USS directory to which you want to upload the local directory
Options
-
--attributes
| --attrs
(string)
- Path of an attributes file to control how files are uploaded
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--encoding
| --ec
(string)
- Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--max-concurrent-requests
| --mcr
(number)
-
Specifies the maximum number of concurrent REST API requests to upload files. Increasing the value results in faster uploads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the upload process encounters an error, the following message displays:
The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to upload all members at once without a maximum number of concurrent requests.
Default value: 1
-
--recursive
| -r
(boolean)
- Upload all directories recursively.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory:":
zowe rse-api-for-zowe-cli upload dir-to-uss "local_dir" "/a/ibmuser/my_dir"
-
Upload all files from the "local_dir" directory and all its sub-directories, to the "/a/ibmuser/my_dir" USS directory::
zowe rse-api-for-zowe-cli upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive
Upload the contents of a file to a z/OS data set
Usage
zowe rse-api-for-zowe-cli upload file-to-data-set <inputfile> <dataSetName> [options]
Positional Arguments
-
inputfile
(string)
- The local file that you want to upload to a data set
-
dataSetName
(string)
- The name of the data set to which you want to upload the file
Options
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--encoding
| --ec
(string)
- Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--mappings-file
| --maps
(string)
- Location of an alternate MVS Mappings file.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Upload content to a USS file from local file
Usage
zowe rse-api-for-zowe-cli upload file-to-uss <inputfile> <USSFileName> [options]
Positional Arguments
-
inputfile
(string)
- The local file that you want to upload to a USS file
-
USSFileName
(string)
- The name of the USS file to which you want to upload the file
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
View details of z/OS jobs on spool/JES queues.
View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the Jobs REST endpoints (expect for "no jobs found").
Usage
zowe rse-api-for-zowe-cli view job-status-by-jobid <jobid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
View status and other details of the job with the job ID JOB00123:
zowe rse-api-for-zowe-cli view job-status-by-jobid j123
-
Print only the status (for example, "OUTPUT" or "ACTIVE") of the job with the job ID JOB00123:
zowe rse-api-for-zowe-cli view job-status-by-jobid j123 --rff status --rft string
View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID. The command presents errors verbatim from the Jobs REST endpoints.
Usage
zowe rse-api-for-zowe-cli view spool-file-by-id <jobid> <spoolfileid> [options]
Positional Arguments
-
jobid
(string)
- The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
-
spoolfileid
(number)
- The spool file ID number for the spool file to view. Use the "zowe rse list spool-files-by-jobid" command to obtain spool ID numbers.No pre-validation of the ID is performed.
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Store credentials securely in profiles by encrypting them
Reverts all secure profiles to be stored in plain text
Usage
zowe secure-credential-store revert [options]
Required Options
Updates all plain text profiles to be securely stored
Usage
zowe secure-credential-store update [options]
Interact with SA Operations REST API of IBM Z System Automation.
You need to configure and start the "SA Operations REST Server".
First steps:
- Create a Zowe Profile with connection information to your Z SA Operations REST Server.
Use the command "zowe profiles create sa" and specify the required options.
- For more help of creating a profile issue "zowe profiles create sa --help".
- Make sure one sa profile is set as default profile.
Use command "zowe profiles set-default sa --help" for more information.
- For a list of possible command issue: "zowe sa --help"
Activate a setting or configuration from stored configuration data
Updates all SAPlex members (Automation Manager and -Agents) with the definition that is stored in the specified policy dataset.
Using '*' as policyName causes a refresh of current policy.
Requires (min.): SA Operations API 1.1.0
Following Success Messages can be returned by this command:
SACLI001100 - Policy activation with {PolicyDatasetName} has been requested
SACLI001110 - Re-Activation of current active policy has been requested
Usage
zowe system-automation activate policy [options]
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Create an object from template
Create a dynamic resource from template
Requires (min.): SA Operations API 1.0.0
Following Success Message can be returned by this command:
SACLI002100 - Dynamic resource {ResourceName} has been created from template {TemplateName}
Usage
zowe system-automation create resource [options]
Options
-
--template
(string)
- The name of template to be used for creation of the resource
-
--id
(string)
- The ID of the template to be used for creation of the resource
-
--name
(string)
- This is subsystem name of the new resource. It will normally be taken as the resource name as it is shown for example in the list resources command
-
--job
(string)
-
--system
(string)
- The system where to create the resource
-
--subsystem
(string)
- The subsystem name of the resource to be created
-
--sdesc
(string)
- Specifies the short descrcription for the resource to be created
-
--group
(string)
- This is the name of the resource group (APG) that will host the new resource as group member
-
--procedure
(string)
- Specifies the procedure name of the new resource
-
--comment
(string)
- This comment will be associated to this creation request
-
--path
(string)
- Specified the USS path and command to start the application represented by this resource
-
--filter
(string)
- This filter is used to monitor the USS process represented by this resource
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Create a resource with (subsys)name <SUBS_NAME> from template with name <TEMPLATE_NAME> on system <SYS_NAME>:
zowe system-automation create resource --template=TEMPLATE_NAME --name=SUBS_NAME --system=SYS_NAME
-
Create a resource with (subsys)name <SUBS_NAME> from template with ID <TEMPLATE_ID> on system <SYS_NAME>:
zowe system-automation create resource --id=TEMPLATE_ID --name=SUBS_NAME --system=SYS_NAME
Delete requests or dynamic resource instance that exist in the SAplex
Delete (cancel) a request.
Requires (min.): SA Operations API 1.1.0
Following Success Message can be returned by this command:
SACLI003200 - {Action} request on {ResourceName} from source {Source} has been deleted
Usage
zowe system-automation delete request [options]
Options
-
--id
(string)
-
--name
(string)
- The name of the resource on which a request with this source is placed. It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.
-
--type
(string)
-
The type of the resource on which a request with this source is placed
Allowed values: APL, APG, SYS, MTR, GRP, SYG, DMN, REF
-
--system
(string)
- The system hosting the resource on which a request with this source is placed
-
--source
(string)
-
--userid
(string)
- The user ID of the request that has to be deleted
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Delete the request from source INGAPI on resource with name <RESOURCE_NAME>. It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>:
zowe system-automation delete request --name=RESOURCE_NAME
-
Delete the request from source INGAPI on resource specifying name, type and system:
zowe system-automation delete request --name=RESOURCE_NAME --type=RESOURCE_TYPE --system=RESOURCE_SYSTEM
-
Deletes the request with <REQ_ID>. Use the ID that is displayed in "zowe sa list requests --showid":
zowe system-automation delete request --id=REQ_ID
Delete a resource instance created from template (dynamic resource)
Requires (min.): SA Operations API 1.0.0
Following Success Message can be returned by this command:
SACLI003100 - Resource {ResourceName} has been deleted
Usage
zowe system-automation delete resource [options]
Options
-
--id
(string)
- The ID of the dynamic resource to delete
-
--name
(string)
- The name of the dynamic resource to delete. It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.
-
--type
(string)
-
The type of the resource to delete
Allowed values: APL, APG, SYS, MTR, GRP, SYG, DMN, REF
-
--system
(string)
- The system of the resource to delete
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Delete a dynamic resource with (subsys)name <SUBS_NAME>. Use the name that is displayed in "zowe sa list resources".
It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.:
zowe system-automation delete resource --name=SUBS_NAME
-
Delete a dynamic resource specifying name, type and system:
zowe system-automation delete resource --name=RESOURCE_NAME --type=RESOURCE_TYPE --system=RESOURCE_SYSTEM
-
Delete a dynamic resource with <RESOURCE_ID>. Use the ID that is displayed in "zowe sa list resources --showid":
zowe system-automation delete resource --id=RES_ID
Disable recording or takeoverfile processing
Disable the recording processing.
Requires (min.): SA Operations API 1.1.0
Following Success Message can be returned by this command:
SACLI004100 - Recording has been disabled
Usage
zowe system-automation disable recording [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Disable the takeover handling via Takeoverfile.
Following Success Message can be returned by this command:
SACLI004200 - Takeoverfile processing has been disabled
Usage
zowe system-automation disable takeoverfile [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Enable recording or takeoverfile processing
Enable the recording processing to a specified dataset.
Requires (min.): SA Operations API 1.1.0
Following Success Message can be returned by this command:
SACLI005100 - Recording to {DatasetName} has been enabled
Usage
zowe system-automation enable recording [options]
Options
-
--dsname
(string)
- The recording dataset name
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Enable the takeover handling via takeoverfile.
Requires (min.): SA Operations API 1.1.0
Following Success Message can be returned by this command:
SACLI005200 - Takeoverfile processing has been enabled
Usage
zowe system-automation enable takeoverfile [options]
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Query resources, templates, requests and configuration members defined in an SAplex
List all configuration members currently defined
Requires (min.): SA Operations API 1.1.0
Following Success Message can be returned by this command:
SACLI006100 - Listing Members success
Usage
zowe system-automation list members [options]
Options
-
--system
(string)
- The system on which this member is running
-
--id
(string)
-
--role
(string)
-
List only members with this role
Allowed values: PAM, SAM, AGENT
-
--status
(string)
-
List only members with this state
Allowed values: NOT_READY, READY, REFRESH, PENDING, SELECTED, STOPPING, SUSPENDED
-
--release
(string)
- List only members for this release
View Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
List all members:
zowe system-automation list members
-
List all members including their ID:
zowe system-automation list members --showid
-
List all agents resources including ID:
zowe system-automation list members --role=AGENT --showid
-
List all members (agents and automation manager) running on system <SYS_NAME>:
zowe system-automation list members --system=SYS_NAME*
List the active configuration (policy) of all SAPlex members (agent and manager).
Requires (min.): SA Operations API 1.0.0
Following Success Message can be returned by this command:
SACLI006500 - Listing policies success
Usage
zowe system-automation list policies [options]
Options
-
--system
(string)
-
--role
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
List all requests currently added to resources matching the specified filter options.
Requires (min.): SA Operations API 1.1.0
Following Success Message can be returned by this command:
SACLI006200 - Listing requests success
Usage
zowe system-automation list requests [options]
Options
-
--status
(string)
-
The status of the request
Allowed values: WINNING, NOWINNING, LOSING, NOLOSING
-
--source
(string)
- The source of the request
-
--userid
(string)
- The user who issued the request
-
--name
(string)
- The name of the resource for that to list requests. Wildcard '*' is allowed. It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.
-
--type
(string)
- The type of the resource for that to list requests
-
--requestType
(string)
List Options
-
--showid
(boolean)
-
--showcomment
(boolean)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
List all requests that have been placed on all resources:
zowe system-automation list requests
-
List all requests and show their ID.:
zowe system-automation list requests --showid
-
List all request against resource with name=<RESOURCE_NAME>, type=<RESOURCE_TYPE>, system=<RESOURCE_SYSTEM>.:
zowe system-automation list requests --name=RESOURCE_NAME --type=RESOURCE_TYPE --system=RESOURCE_SYSTEM
List all resources currently being automated and matching the specified filter options in a table.
Requires (min.): SA Operations API 1.0.0
Following Success Message can be returned by this command:
SACLI006300 - Listing resources success
Usage
zowe system-automation list resources [options]
Options
View group
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
List all resources:
zowe system-automation list resources
-
List all resources including their ID:
zowe system-automation list resources --showid
-
List all AVAILABLE resources including ID:
zowe system-automation list resources --observed=available --showid
-
List all resources where name is starting with WEB:
zowe system-automation list resources --name=WEB*
List all templates currently defined matching the spcecified filter options in a table.
Requires (min.): SA Operations API 1.0.0
Following Success Message can be returned by this command:
SACLI006400 - Listing templates success
Usage
zowe system-automation list templates [options]
Options
-
--name
(string)
- List template with this name. Wildcard '*' is allowed
-
--timestamp
(string)
- List templates with this timestamp
-
--current
(boolean)
View group
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
List all templates:
zowe system-automation list templates
-
List all templates including their ID:
zowe system-automation list templates --showid
-
List all current templates including ID:
zowe system-automation list templates --current --showid
-
List all templates where name is starting with CICS:
zowe system-automation list templates --name=CICS*
Resume a component known by System Automation such as a resource.
Resumen an SAPlex member (SA Agent).
Requires (min.): SA Operations API 1.1.0
Following Success Message can be returned by this command:
SACLI007100 - Requesting resume of SAPlex member (SA Agent) success
Usage
zowe system-automation resume member [options]
Options
-
--id
(string)
- The ID of the member (SA Agent)
-
--system
(string)
- The system hosting the member (SA Agent)
-
--role
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Resume a resource.
Requires (min.): SA Operations API 1.0.0
Following Success Message can be returned by this command:
SACLI007200 - Requesting resume of resource {ResourceName} success
Usage
zowe system-automation resume resource [options]
Options
-
--id
(string)
-
--name
(string)
-
--type
(string)
-
The type of the resource
Allowed values: APL, APG, SYS, MTR, GRP, SYG, DMN, REF
-
--system
(string)
- The system of the resource
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Resume the resource with this ID <RESOURCE_ID>. Use the ID that is displayed in "zowe sa list resources --showid":
zowe system-automation resume resource --id=RESOURCE_ID
-
Resume the resource with specified name <RESOURCE_NAME>Use the name that is displayed in "zowe sa list resources".
It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.:
zowe system-automation resume resource --name=RESOURCE_NAME
Set an option of an SAPlex Member
Set an Automation Manager to Primary Automation Manager (PAM)
Requires (min.): SA Operations API 1.1.0
Following Success Message can be returned by this command:
SACLI008100 - Setting Primary Automation Manger on {SYSTEM} success
Usage
zowe system-automation set PrimaryManager [options]
Options
-
--id
(string)
- The ID of the member Automation Manager
-
--startType
(string)
-
The start type of the Automation Manager
Default value: HOT
Allowed values: HOT, WARM, COLD
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Starts an object known by System Automation such as a resource
Issues a start request, that will cause the resource to start in case the request is winning.
Requires (min.): SA Operations API 1.0.0
Following Success Message can be returned by this command:
SACLI009100 - Requesting start of resource {ResourceName} success
Usage
zowe system-automation start resource [options]
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Issue start request on resource with ID <RESOURCE_ID>. Use the ID that is displayed in "zowe sa list resources --showid":
zowe system-automation start resource --id=RESOURCE_ID
-
Issue start request on resource with name <RESOURCE_NAME>It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>:
zowe system-automation start resource --name=RESOURCE_NAME
-
Start a resource identified by ID specifying a priority and a comment.:
zowe system-automation start resource --id=RESOURCE_ID --priority=low --comment="This is a request comment"
-
Start a resource identified by ID specifying override value to the "FLG" and "STS":
zowe system-automation start resource --id=RESOURCE_ID --override=flg sts
Stops a component known by System Automation such as a resource
Issues a stop request, that will cause the resource to stop in case the request is winning.
Requires (min.): SA Operations API 1.0.0
Following Success Message can be created by this command:
SACLI010100 - Requesting stop of resource {ResourceName} success
Usage
zowe system-automation stop resource [options]
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Issue stop request on resource with ID <RESOURCE_ID>. Use the ID that is displayed in "zowe sa list resources --showid":
zowe system-automation stop resource --id=RESOURCE_ID
-
Issue stop request on resource with name <RESOURCE_NAME>It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>:
zowe system-automation stop resource --name=RESOURCE_NAME
-
Stop a resource identified by ID specifying a priority and a comment:
zowe system-automation stop resource --id=RESOURCE_ID --priority=low --comment="This is a request comment"
-
Stop a resource identified by ID specifying override value to the "FLG" and "STS":
zowe system-automation stop resource --id=RESOURCE_ID ----override=flg sts
Suspend an object known by System Automation such as a resource
Suspend an agent (SAPlex member).
Requires (min.): SA Operations API 1.1.0
Following Success Message can be created by this command:
SACLI02300 - Request suspend of agent {AgentName} success
Usage
zowe system-automation suspend member [options]
Options
-
--id
(string)
- The ID of the agent member
-
--system
(string)
- The system hosting the agent member
-
--role
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Suspend an agent member with ID <MEMBER_ID>. Use the ID that is displayed in "zowe sa list members --showid":
zowe system-automation suspend member --id=MEMBER_ID
-
Suspend the agent on specified system:
zowe system-automation suspend member --system=SYSTEM_NAME --role=AGENT
-
Suspend member running on system <SYSTEM_NAME>:
zowe system-automation suspend member --system=SYSTEM_NAME
Suspend a resource.
Requires (min.): SA Operations API 1.0.0
Following Success Message can be created by this command:
SACLI011200 - Requesting suspend of resource {ResourceName} success
Usage
zowe system-automation suspend resource [options]
Options
-
--id
(string)
-
--name
(string)
- The name of the resource. It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.
-
--type
(string)
-
The type of the resource
Allowed values: APL, APG, SYS, MTR, GRP, SYG, DMN, REF
-
--system
(string)
- The system of the resource
-
--scope
(string)
-
Whether the SUSPEND affects only the resource or both the resource and its descendants.
Default value: ONLY
Allowed values: ALL, ONLY
-
--comment
(string)
- A comment that can be specified for this request
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Suspend a resource with ID <RESOURCE_ID>. Use the ID that is displayed in "zowe sa list resources --showid":
zowe system-automation suspend resource --id=RESOURCE_ID
-
Suspend resource with name <RESOURCE_NAME>It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>:
zowe system-automation suspend resource --name=RESOURCE_NAME
-
Suspend a resource identified by ID specifying with scope and a comment.:
zowe system-automation suspend resource --id=RESOURCE_ID --scope=ONLY --comment="This is a suspend comment"
View details about an SA object
View connection information of SA Operations REST Server that would be used by any other CLI command.
In case you have connection problems with any other CLI command - you can use this command instead
to check the connection options as resulting combination from base profile, sa profile and command line
parameters that are being used to connect the SA Operations Server.
Following Success Message can be created by this command:
SACLI012500 - Connected SA Operations API REST Server: {Server} on Port: {Port}
Usage
zowe system-automation view connection [options]
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
View details of an SAPlex member (agent or automation manager)
Requires (min.): SA Operations API 1.1.0
Following Success Message can be created by this command:
SACLI012100 - Viewing member success
Usage
zowe system-automation view member [options]
Options
-
--id
(string)
-
--release
(string)
- The release / version of the member
-
--role
(string)
-
--status
(string)
-
The status of the member
Allowed values: NOT_READY, READY, REFRESH, PENDING, SELECTED, STOPPING, SUSPENDED
-
--system
(string)
View Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
View details of a member with ID <MEMBER_ID>. Use the ID that is displayed in "zowe sa list members --showid":
zowe system-automation view member --id=MEMBER_ID
-
View details of the member identified as PAM (Primary Automation Manager):
zowe system-automation view member --role=PAM
-
View details of the member that is an agent running on system with name <SYSTEM_NAME>:
zowe system-automation view member --system=SYSTEM_NAME --role=AGENT
View details of a request.
Requires (min.): SA Operations API 1.1.0
Following Success Message can be created by this command:
SACLI012200 - Viewing request success
Usage
zowe system-automation view request [options]
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
View details of one resource.
Requires (min.): SA Operations API 1.0.0
Following Success Message can be created by this command:
SACLI02300 - Request suspend of agent {AgentName} success
Usage
zowe system-automation view resource [options]
Options
-
--id
(string)
-
--name
(string)
- The name of the resource. It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.
-
--system
(string)
- The system of the resource
-
--type
(string)
-
The type of the resource
Allowed values: APL, APG, SYS, MTR, GRP, SYG, DMN, REF
View Option
-
--showvotes
(boolean)
- Show also all request and votes for this resource
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
View details of a resource with ID <RESOURCE_ID>. Use the ID that is displayed in "zowe sa list resources --showid":
zowe system-automation view resource --id=RESOURCE_ID
-
View details of a resource with name <RESOURCE_NAME>.It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.:
zowe system-automation view resource --name=RESOURCE_NAME
-
View details of resource specified by ID including all requests and votes for this resource:
zowe system-automation view resource --id=RESOURCE_ID --showvotes
View API version of connected SA Operations REST Server.
Requires (min.): SA Operations API 1.1.0
Following Success Message can be created by this command:
SACLI012400 - Connected SA Operations API {Version} is {Status}.
Usage
zowe system-automation view version [options]
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
View details of a resource with ID <RESOURCE_ID>. Use the ID that is displayed in "zowe sa list resources --showid":
zowe system-automation view version --id=RESOURCE_ID
-
View details of a resource with name <RESOURCE_NAME>.It is possible to use the syntax <NAME>/<TYPE>/<SYSTEM>.:
zowe system-automation view version --name=RESOURCE_NAME
-
View details of resource specified by ID including all requests and votes for this resource:
zowe system-automation view version --id=RESOURCE_ID --showvotes
Zowe CLI plugin for SYSVIEW
Display output from a primary command stored in a SYSVIEW capture data set
Usage
zowe sysview capture <capture-dsn> <capture-command> [options]
Positional Arguments
-
capture-dsn
(string)
- Capture data set name from which to retrieve captured commands
-
capture-command
(string)
- Captured command to retrieve
data options
-
--capture-row
| --cr
(number)
- Row number of command within capture data set
-
--capture-screen
| --cs
(string)
- Screen name, for commands which have multiple screens
-
--capture-title
| --ct
(string)
- The captured command screen title or a user supplied title specified on the CAPIMMED command
-
--fields
| -f
(array)
- Fields to be returned (by name). For example: "jobname" "cpu"
-
--all-rows
| --ar
(boolean)
- Return all rows of data, no matter how many. Overrides --row-start and --row-end
-
--row-start
| --rs
(number)
-
--row-end
| --re
(number)
-
--timeout
| --to
(number)
display options
-
--context-fields
| --cf
(array)
- Context fields to display. Defaults to hiding all context
-
--overview
| -o
(boolean)
- Display the overview section
-
--info
| -i
(boolean)
- Display the information area, if any
-
--pretty
| -p
(boolean)
-
--blank-if-zero
| --biz
| -b
(boolean)
- Show a blank space instead of '0' values
-
--truncate
| --tr
(boolean)
response format options
sysview connection options
-
--host
| -H
(string)
- The hostname of the SYSVIEW REST API
-
--port
| -P
(number)
- The port number of the SYSVIEW REST API
-
--user
| -u
(string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password
| --pass
| --pw
(string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized
| --ru
(boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid
(string)
-
--base-path
| --bp
(string)
Profile Options
-
--sysview-profile
| --sysview-p
(string)
- The name of a (sysview) profile to load for this command execution.
-
--sysview-format-profile
| --sysview-format-p
(string)
- The name of a (sysview-format) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Display the captured ACTIVITY command from MY.CAPTURE.DATASET.:
zowe sysview capture "MY.CAPTURE.DATASET" ACTIVITY
-
Display the Jobname, Jobid, and Status columns of the captured ACTIVITY command on row 3 from MY.CAPTURE.DATASET.:
zowe sysview capture "MY.CAPTURE.DATASET" ACTIVITY --capture-row 3 --fields Jobname Jobid Status
Confirm that the SYSVIEW REST server is running on a specified system.
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
-
--host
| -H
(string)
- The hostname of the SYSVIEW REST API
-
--port
| -P
(number)
- The port number of the SYSVIEW REST API
-
--user
| -u
(string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password
| --pass
| --pw
(string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized
| --ru
(boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid
(string)
-
--base-path
| --bp
(string)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Report the status of the SYSVIEW REST server that you specified in your default SYSVIEW REST profile:
zowe sysview check status
-
Report the status of the SYSVIEW REST server that you specified in a supplied SYSVIEW REST profile:
zowe sysview check status --sysview-profile SomeSysviewProfileName
-
Report the status of the SYSVIEW REST server that you specified manually via command line:
zowe sysview check status --host myhost --port 443 --user myuser --password mypass
Issue a SYSVIEW primary command and display output, including any messages
Usage
zowe sysview display <command-string> [options]
Positional Arguments
-
command-string
(string)
- Command(s) to be issued
(If more than one command, separated by a semi-colon)
Example: "ACTIVITY;SORT CPU% D"
data options
-
--fields
| -f
(array)
- Fields to be returned (by name). For example: "jobname" "cpu"
-
--all-rows
| --ar
(boolean)
- Return all rows of data, no matter how many. Overrides --row-start and --row-end
-
--row-start
| --rs
(number)
-
--row-end
| --re
(number)
-
--timeout
| --to
(number)
display options
-
--context-fields
| --cf
(array)
- Context fields to display. Defaults to hiding all context
-
--overview
| -o
(boolean)
- Display the overview section
-
--info
| -i
(boolean)
- Display the information area, if any
-
--pretty
| -p
(boolean)
-
--blank-if-zero
| --biz
| -b
(boolean)
- Show a blank space instead of '0' values
-
--truncate
| --tr
(boolean)
response format options
sysview connection options
-
--host
| -H
(string)
- The hostname of the SYSVIEW REST API
-
--port
| -P
(number)
- The port number of the SYSVIEW REST API
-
--user
| -u
(string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password
| --pass
| --pw
(string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized
| --ru
(boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid
(string)
-
--base-path
| --bp
(string)
Profile Options
-
--sysview-profile
| --sysview-p
(string)
- The name of a (sysview) profile to load for this command execution.
-
--sysview-format-profile
| --sysview-format-p
(string)
- The name of a (sysview-format) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Issue the CSMSTAT command and show the 'message' field from the context area of the response:
zowe sysview display "CSMSTAT" --cf message
-
Issue the JOBSUM command to list jobs starting with "CS" showing only the fields Jobname, Jobid, and Status:
zowe sysview display "jobs CS&VLMC" --fields Jobname Jobid Status
Issue a SYSVIEW function command and display any messages
Usage
zowe sysview execute <command-string> [options]
Positional Arguments
-
command-string
(string)
- Command(s) to be issued
(If more than one command, separated by a semi-colon)
Example: "ACTIVITY;SORT CPU% D"
display options
data options
sysview connection options
-
--host
| -H
(string)
- The hostname of the SYSVIEW REST API
-
--port
| -P
(number)
- The port number of the SYSVIEW REST API
-
--user
| -u
(string)
- Your z/OS username used to authenticate to the SYSVIEW REST API
-
--password
| --pass
| --pw
(string)
- Your z/OS password used to authenticate to the SYSVIEW REST API
-
--reject-unauthorized
| --ru
(boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--ssid
(string)
-
--base-path
| --bp
(string)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Interact with IBM Z Workload Scheduler
Execute WAPL commands. Enclose the commands in double quotes and escape any symbols that have a special meaning to the shell.
Execute one or multiple WAPL statements from a command line.
Usage
zowe workload-automation execute wapl [options]
Options
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Get resources or jobs in plan.
Get the job in plan.
Usage
zowe workload-automation get jobinplan [options]
Required Options
-
--id
(string)
- ID of the job to get. Take the ID from the list jobinplan command.
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Get the resource in plan.
Usage
zowe workload-automation get resourceinplan [options]
Required Options
-
--id
(string)
- ID of the resource to get. Take the ID from the list resourceinplan command
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Get the resource using the specified ID. Take the ID from the list resourceinplan command:
zowe workload-automation get resourceinplan --id resourceId
-
Get the resource using the specified ID with response in JSON format. Take the ID from the list resourceinplan command:
zowe workload-automation get resourceinplan --id resourceId --rfj
List jobs, jobstreams, and resources in plan, list jobstreams in model(database).
List the jobs in plan.
Usage
zowe workload-automation list jobinplan [options]
Options
-
--jobname
| --jn
(string)
- Name of the jobs to be listed, you can use the wildcard character asterisk (*)
-
--statuslist
| --sl
(array)
-
Status of the jobs
Allowed values: WAITING, READY, RUNNING, SUCCESSFUL, ERROR, CANCELED, HELD, UNDECIDED, SUPPRESS
-
--jobstreamname
| --jsn
(string)
- Name of the jobstream where the jobs are located, you can use the wildcard character asterisk (*).
-
--timerange
| --tr
(array)
- Time range, in the format YYYY-MM-DDTHH:MM:SS
-
--howmany
| --hm
(number)
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List all jobs in current plan whose name starts with A and are in SUCCESSFUL or WAITING status:
zowe workload-automation list jobinplan --jobname "A*" --statuslist SUCCESSFUL WAITING
-
List all jobs located in the jobstream named MYJOBSTREAM, limiting the response to 50 jobs:
zowe workload-automation list jobinplan --jobstreamname "MYJOBSTREAM" --howmany 50
-
List all jobs within a specified range:
zowe workload-automation list jobinplan --timerange 2019-11-10T00:00:00 2019-11-10T23:59:00
-
List all jobs by displaying only the job name and status in table format:
zowe workload-automation list jobinplan --rff jobDefinition[jclName] status[commonStatus] --rft table
List the jobstreams in model.
Usage
zowe workload-automation list jobstreaminmodel [options]
Options
-
--name
| -n
(string)
- Name of the jobstreams to be listed, you can use the wildcard character asterisk (*).
-
--owner
| --ow
(string)
-
--timerange
| --tr
(array)
- Validity time range, in the format YYYY-MM-DDTHH:MM:SS
-
--isgroup
| --igr
(boolean)
- Indicator that shows if the jobstream is a group.
-
--groupname
| --grn
(string)
- Name of the group that contains the jobstream.
-
--howmany
| --hm
(number)
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List all jobstreams whose name starts with A and have owner "JSOWNER" :
zowe workload-automation list jobstreaminmodel --name "A*" --owner "JSOWNER"
-
List all jobstreams valid within a specified range:
zowe workload-automation list jobstreaminmodel --timerange 2019-11-10T00:00:00 2019-11-10T23:59:00
-
List all jobstreams present in a group by returning only the first 10 occurrences:
zowe workload-automation list jobstreaminmodel --isgroup true --howmany 10
-
List all jobstreams by displaying only the jobstream name and owner in table format:
zowe workload-automation list jobstreaminmodel --rff key[name] ownerName --rft table
List the jobstreams in plan.
Usage
zowe workload-automation list jobstreaminplan [options]
Options
-
--name
| -n
(string)
- Name of the jobstream to list, you can use the wildcard character asterisk (*).
-
--statuslist
| --sl
(array)
-
Status of the jobstream.
Allowed values: SUCCESSFUL, CANCELED, ERROR, RUNNING, UNDECIDED, WAITING
-
--owner
| --ow
(string)
-
--timerange
| --tr
(array)
- Time range, in the format YYYY-MM-DDTHH:MM:SS
-
--howmany
| --hm
(number)
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List all jobstreams in current plan whose name starts with A and are in SUCCESSFUL or ERROR status:
zowe workload-automation list jobstreaminplan --name "A*" --statuslist SUCCESSFUL ERROR
-
List all jobstreams in WAITING, limiting response to 50 jobstreams:
zowe workload-automation list jobstreaminplan --statuslist WAITING --howmany 50
-
List all jobstreams within a specified range:
zowe workload-automation list jobstreaminplan --timerange 2019-11-10T00:00:00 2019-11-10T23:59:00
-
List all jobstreams by displaying only jobstream name and status in table format:
zowe workload-automation list jobstreaminplan --rff key[name] status[commonStatus] --rft table
List the resources in plan.
Usage
zowe workload-automation list resourceinplan [options]
Options
-
--name
| -n
(string)
- Name of the resources to list, you can use the wildcard character asterisk (*).
-
--isavailable
| --isa
| --ia
(boolean)
- Specify true to select only the resources that are available.Specify false to select only resources that are unavailable.
-
--iswaiting
| --isw
| --iw
(boolean)
- Specify true to select only the resources for which the operations are waiting.Specify false to select only resources that no operations are waiting for
-
--howmany
| --hm
(number)
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Set the status of a job in plan.
Set the status of a job in plan.
Usage
zowe workload-automation set-status jobinplan [options]
Required Options
-
--id
(string)
- ID of the job. Take the ID from the list jobinplan command.
-
--status
| --st
(string)
-
Status that you want to set for the job.
Allowed values: started, zosready, interrupted, zoserror, complete
Options
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Submit a jobstream into the plan.
Submit a jobstream to the plan.
Usage
zowe workload-automation submit jobstreaminplan [options]
Required Options
Options
-
--starttime
| --st
(string)
- Start time of the jobstream.
-
--holdall
| --ha
(boolean)
- Hold all jobs in jobstream submitted into the plan.
-
--variabletable
| --vt
(string)
- Variable table associated to the jobstream submitted into the plan.
-
--jclvariables
| --jv
(array)
- A pair composed by variable name and value to be replaced in the JCL. Must be a promptable variable.
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Submit a jobstream in the current plan whose name is 'myjobstream' with the specified start time:
zowe workload-automation submit jobstreaminplan --name myjobstream --starttime 2018-10-17T19:00:00
-
Submit a jobstream in the current plan whose name is 'myjobstream' with all jobs on hold:
zowe workload-automation submit jobstreaminplan --name myjobstream --holdall
-
Submit a jobstream in the current plan whose name is 'myjobstream' resolving promptable variables in the JCL:
zowe workload-automation submit jobstreaminplan --name myjobstream --jclvariables key1 value1 key2 value2
Update resources or jobs in plan.
Update the job in plan.
Usage
zowe workload-automation update jobinplan [options]
Required Options
-
--id
(string)
- ID of the job to update. Take the ID from get response body.
Options
-
--jobname
| --jn
(string)
-
--description
| --des
(string)
-
--workstation
| --ws
(string)
-
--parallel-servers
| --ps
(number)
- Number of parallel servers that can concurrently run the operation at the workstation
-
--r1-resources
| --r1
(number)
- Maximum capacity of workstation resource 1
-
--r2-resources
| --r2
(number)
- Maximum capacity of workstation resource 2
-
--form-number
| --fn
(string)
- Form number or Sysout forms name of the job
-
--extended-name
| --en
(string)
-
--job-class
| --jclass
(string)
- Job or sysout class of the job
-
--scheduling-environment
| --env
(string)
- Scheduling environmnent name of the job
-
--time-dependent
| --td
(boolean)
-
Jobs are to be submitted at a specific time or as soon as possible.
True: job must NOT start before the input arrival time is reached.
False: job can start as soon as predecessors are completed and resources are available.
-
--follow-job-stream-input-arrival
| --fjs-ia
| --fjs
(boolean)
- Follow jobstream input arrival time. If not specified, current value is used.
-
--start-time
| --st
(string)
-
Start time date and time of the job, in the format YYYY-MM-DDTHH:MM:SS
The date and time cannot be earlier than the application input arrival, nor later than the application deadline.
Use it in combination with the follow-job-stream-input-arrival option set to false.
-
--deadline
| --dl
(string)
-
Deadline date and time of the job, in the format YYYY-MM-DDTHH:MM:SS
The date and time cannot be earlier than the application input arrival, nor later than the application deadline.
To clear existent deadline-time pass an empty "" value. Note that any correlated actions will be cleared.
-
--deadline-action
| --dla
(string)
-
Action to be taken if the operation is still not completed when deadline day and time are reached. If you specify an action, an alert message is issued. Optional.
ALERT: Alert only.
COMPLETE: Operation is completed if its status allows this kind of change, otherwise is NOPed.
NOP: Operation and all its internal successors are NOPed.
ERROR: Operation is set to error with error code ODEA if its status allows this kind of change.
BLANK: No action.
Allowed values: ALERT, COMPLETE, NOP, ERROR, BLANK
-
--not-started-alert-date
| --nsald
(string)
-
Date and time, in the format YYYY-MM-DDTHH:MM:SS, to check if the operation has not yet started. If so, an alert is issued.
To clear existent not-started-alert-date pass an empty "" value.
-
--not-started-action-date
| --nsacd
(string)
-
Date and time, in the format YYYY-MM-DDTHH:MM:SS, to check if the operation has not yet started.This check is applied only to ready operations. If you specify date and time, an action is required.
To clear existent not-started-action-date pass an empty "" value. Note that any correlated actions will be cleared.
-
--not-started-action
| --nsa
(string)
-
Action to be taken if the operation has not yet started when the specified time is reached. If you specify an action, day and time are required.
ALERT: Alert only.
COMPLETE: Operation is completed if its status allows this kind of change, otherwise is NOPed.
NOP: Operation and all its internal successors are NOPed.
ERROR: Operation is set to error with error code OLAT if its status allows this kind of change.
Allowed values: ALERT, COMPLETE, NOP, ERROR
-
--duration
| --dur
(number)
- Estimated duration of the job, expressed in milliseconds.
-
--critical
| --crit
(string)
-
If the job is to be considered a Critical Path target, eligible for WLM assistance, or Not eligible for WLM assistance.
Allowed values: NO, PATH, WLM
-
--wlm-policy
| --wpol
(string)
-
Policy to be used for WLM assistance, if the job has been defined as critical.
LONGDURATION: job is assisted if it runs beyond its estimated duration
DEADLINE: job is assisted if it has not finished when its deadline time is reached
LATESTSTART: job is assisted if it is submitted after its latest start time
CONDITIONAL: an algorithm calculates whether to apply the Deadline or Latest start policy
DEFAULT: the policy specified in OPCOPTS is applied
Allowed values: CONDITIONAL, DEADLINE, LATESTSTART, LONGDURATION, DEFAULT
-
--wlm-class
| --wcla
(string)
-
--monitored
| --mon
(boolean)
-
--auto-release
| --ar
(boolean)
-
Jobs submitted by other than the product must be automatically released at their appropriate time, if placed in HOLD status at job submission time.
True: release jobs at their appropriate time.
False: release jobs immediately.
-
--cancel-if-late
| --clate
(boolean)
-
Job must be submitted, regardless of the fact that its assigned start time has passed.
True: suppress the submit or release of a time-dependent job, if it is late.
False: submit or release a job when ready, even if the specified time has passed.
-
--auto-submit
| --asub
(boolean)
-
Job is to be automatically started.
True: job is automatically started.
False: job is NOT automatically started.
-
--auto-error-completion
| --aerc
(boolean)
-
How error conditions are to be managed for the job.
True: error conditions are automatically tracked and the job is assigned an ended-in-error status if it fails.
False: ignore error conditions and give the job a completed status when it ends.
-
--highest-return-code
| --hrc
(number)
- Highest accepted return code for a job NOT to be reported as ended-in-error. For FT workstations, this value can be only 0.
-
--user-data
| --udata
(string)
- User descriptive text to be associated with the job or operation.
-
--cleanup-option
| --clean
(string)
-
Cleanup action to be taken on computer workstations for operations that end in error or are rerun.
Allowed values: AUTOMATIC, IMMEDIATE, MANUAL, NONE
-
--user-sysout
| --usys
(boolean)
-
If User sysout support is needed.
True: data store logs User sysout.
False: data store does not log User sysout.
-
--restartable
| --rest
(string)
-
The operation can be restarted when its primary workstation becomes inactive. Ignored for Fault-Tolerant workstations. Use installation default action.
YES: the operation can be restarted.
NO: the operation CANNOT be restarted.
DEFAULT: use installation default action.
Allowed values: YES, NO, DEFAULT
-
--reroutable
| --rero
(string)
-
The operation can be rerouted if its primary workstation is rerouted. Ignored for Fault Tolerance Workstation.
YES: operation can be rerouted.
NO: operation CANNOT be rerouted.
DEFAULT: use installation default action.
Allowed values: YES, NO, DEFAULT
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Update the jobname and workstation of the specified job:
zowe workload-automation update jobinplan --jobname myjclname --workstation myws
-
Update options start-time, monitored, and duration of the specified job:
zowe workload-automation update jobinplan --start-time 2020-10-26T10:00:00 --monitored false --duration 180000
Update the resource in plan.
Usage
zowe workload-automation update resourceinplan [options]
Required Options
-
--id
(string)
- Id of the resource to update. Take id from get response body
-
--file
| -f
(string)
- A local file containing resource JSON body to be updated.
workload-automation Connection Options
-
--host
| -H
(string)
- The Z connector server host name or API ML server host name
-
--port
| -P
(number)
- The Z connector server port or API ML server port
-
--user
| -u
(string)
-
--password
| --pwd
(string)
-
--engine
| --eng
(string)
- Name of the engine, as defined on the Z connector
-
--base-path
| --bp
(string)
- Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML
-
--reject-unauthorized
| --ru
(boolean)
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Manage NetView automation tables.
Activate an automation table.
This command activates an automation table by inserting it into the current list of active automation tables.
NOTE: If the specified automation table already exists within the list of active automation tables, this automation table will be replaced at its existing position, and the position option is ignored.
Usage
zowe znetview-automation activate automation-table <memberName> [options]
Positional Arguments
-
memberName
(string)
- The automation table member name to activate.
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Download automation table statement(s).
Download automation table statements from a data set member to a file on your local system so the contents can be modified and saved again.
Note that unpredictable results can occur in the following situations:
An automation table has syntax errors.
Data REXX is used in the automation table, etc.
Usage
zowe znetview-automation download automation-table <memberName> [options]
Positional Arguments
-
memberName
(string)
- The fully qualified DSIPARM data set and member name.
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
List the automation table statistics.
Retrieve automation table statistics for the specified member and report type.
Usage
zowe znetview-automation list automation-table-statistics <tableName> [options]
Positional Arguments
-
tableName
(string)
- The automation table name which you’d like to retrieve the statistics.
Required Options
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Run a simulated automation table test for a Canzlog message.
Replay a recorded Canzlog message and its attributes. You can either provide an automation table name or specify the path of the local file which stores the automation table statements for testing, but you can’t provide both parameters at the same time.
Note: Both the recorded member name AND a file or member that contains 1 automation table statement are valid parameters.
Usage
zowe znetview-automation test automation-table [options]
Required Options
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Test the automation table statements in the file on your local system /tmp/at/test with the message recording member TESTREC from domain CNM01:
zowe znetview-automation test automation-table --record-member-name TESTREC --automation-table-file-path "/tmp/at/test" --domain CNM01
-
Test the automation table statements in the automation table member TESTTBL with the message recording member TESTREC from domain CNM01.:
zowe znetview-automation test automation-table --record-member-name TESTREC --automation-table-name TESTTBL --domain CNM01
Upload automation table statement(s).
Upload automation table statement(s) into the specified data set and member.
Usage
zowe znetview-automation upload automation-table <memberName> [options]
Positional Arguments
-
memberName
(string)
- The fully qualified DSIPARM data set and member name.
Required Options
Options
-
--append
| -a
(boolean)
-
Specifies whether to append the new statement(s) to an existing automation table member.
The default value is false, which means that the member will be replaced.
Default value: false
-
--domain
| -D
(string)
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Validate an automation table.
Validate an automation table.
Usage
zowe znetview-automation validate automation-table [options]
Required Options
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Perform basic NetView operations.
Connect to the NetView REST Server authentication service and obtain a token, or disconnect from the NetView REST Server and revoke the token.
Log in to the NetView REST Server authentication service and obtain a token. When you log in to the NetView REST Server authentication service without any option, the token will be stored in your default NetView profile until it expires.
Usage
zowe znetview-base auth login [options]
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Log in to the NetView REST Server. The authentication token will be stored in your default NetView profile.:
zowe znetview-base auth login
-
Log in to the NetView REST Server. The authentication token will not be stored in your default NetView profile:
zowe znetview-base auth login --show-token
Log out of the NetView REST Server. The authentication token is revoked and removed from the default NetView profile, if the token was stored there.
Usage
zowe znetview-base auth logout [options]
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Log out of the NetView REST Server to revoke the authentication token that is in use and remove it from your default NetView profile:
zowe znetview-base auth logout
-
Log out of NetView REST Server to revoke the token that is specified in the --token-value option, in case you logged in to the NetView REST Server with the --show-token option:
zowe znetview-base auth logout --token-value xxxxxxxxxxxxxxxxxxxx
Issue NetView commands
Issue NetView commands and display responses. This REST API will not work for every NetView command. Any command that provides outputs in a panel will not be retrieved.
Note: No specific formatting has been done for command output.
Usage
zowe znetview-base issue command <commandText> [options]
Positional Arguments
-
commandText
(string)
- The command sent to NetView program. Some command line environments have problems with certain special characters. If your command text contains any of these characters, you may need to put your command in single quotes instead of double quotes.
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
List Canzlog messages, task utilization information, and active NetView domains.
List a message or a set of messages from Canzlog.
Usage
zowe znetview-base list canzlog <requestType> [options]
Positional Arguments
Options
-
--begin
| --beg
(string)
-
The specific time for the request type 'timestamp' or the start time for the request type 'timerange', in format of "mm/dd/yy hh:mm:ss".
Note: It is required for the request types 'timerange' and 'timestamp'.
-
--direction
| --dir
(string)
-
Specifies which direction, backward or forward, for which to retrieve additional Canzlog messages.
Note: This is valid for request types 'czid', 'timestamp'.
Default value: fwd
Allowed values: fwd, bwd
-
--domain
| -D
(string)
-
--end
(string)
-
The end time for the request type time range, in format of "mm/dd/yy hh:mm:ss".
Note: It is required for the request type 'timerange'.
-
--id
(number)
-
--number
| --num
(string)
-
Specifies the number of messages to retrieve.
Note: This is valid for request types 'czid', 'timestamp' and 'recent'.
Default value: 1
-
--show-details
| --sd
(boolean)
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
List 3 Canzlog messages starting with the message specified by czid and retrieving the next 2 messages for domain CNM01:
zowe znetview-base list canzlog czid --id 237766 --direction fwd --number 3 --domain CNM01
-
List 4 Canzlog messages starting with the message specified by the timestamp and retrieving the previous 3 messages for domain CNM01:
zowe znetview-base list canzlog timestamp --begin "09/10/20 00:00:00" --direction bwd --number 4 --domain CNM01
-
List Canzlog messages specified by the timerange for domain CNM01:
zowe znetview-base list canzlog timerange –-begin "09/10/20 00:00:00" --end "09/10/20 00:10:00" --domain CNM01
-
List the 2 most recent Canzlog messages for domain CNM01:
zowe znetview-base list canzlog recent --number 2 --domain CNM01
List data about active NetView domains in a sysplex or active domains configured to the enterprise master NetView program. The command that NetView program is running is LIST STATUS=XCFGRPS, which returns a list of z/OS® XCF groups in which the NetView program participates. Note: The DISCOVERY Tower must be enabled to retrieve data from other NetView domains configured to the enterprise master NetView program.
Usage
zowe znetview-base list domains [options]
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Lists the CPU utilization, storage utilization, number of queued messages, and the running command (if available) for active NetView tasks.
Usage
zowe znetview-base list task-info [options]
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Record a Canzlog message and its message attributes.
Record the Canzlog message and its message attributes in the topmost concatenated DSIASRC DD data set.
The recording contains all the relevant information about the message that can be retrieved from Canzlog, and much of the information is in a non-readable format.
This step should be done as soon as the Canzlog message are successfully retrieved, because the message could become unavailable in a short time.
Usage
zowe znetview-base record canzlog <czid> [options]
Positional Arguments
-
czid
(string)
- The CZID of the message to be recorded.
Required Options
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
- The port number of your NetView REST Server.
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Monitor your network with the NetView program.
List distributed Dynamic Virtual IP Address (DDVIPA) data.
List health information for distributed Dynamic Virtual IP Addresses (DDVIPAs).
Usage
zowe znetview-network list ddvipa-health [options]
Options
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
List information on the percentage of connections distributed to a specific IP address and port in comparison to the Workload Manager (WLM) recommended distribution percentage. The Workload Manager related information is also displayed. Several parameters are provided for filtering the data.
Usage
zowe znetview-network list ddvipa-stats [options]
Options
-
--begin
| --beg
(string)
- The range of sampling interval start times in “mm/dd/yy hh:mm:ss” format. An STCK value can also be specified.
-
--domain
| -D
(string)
-
--dvipa
| --dv
(string)
- The IP address for the requested DVIPA.
-
--dvipa-port
| --dp
(number)
- The port number for the DVIPA.
-
--end
(string)
- The range of sampling interval end times in “mm/dd/yy hh:mm:ss” format. An STCK value can also be specified.
-
--interval
| --in
(number)
- The number of sampling intervals for which to return data, beginning with the most recent data available.
-
--record-num
| --rn
(number)
- The number of records to display.
-
--system
| -s
(string)
- The z/OS system name. The wildcard character (*) is supported at the end of the string.
-
--tcp-name
| --tcp
(string)
- The TCP/IP stack name. The wildcard character (*) is supported at the end of the string.
NetView Connection Options
-
--host
| -H
(string)
- The host name of your NetView REST Server.
-
--port
| -P
(number)
-
--user
| -u
(string)
- The user name to authenticate to your NetView REST Server.
-
--password
| --pw
(string)
- The password to authenticate to your NetView REST Server.
-
--token-type
| --tt
(string)
- The type of the token to authenticate to your NetView REST Server.
-
--token-value
| --tv
(string)
- The value of the token to authenticate to your NetView REST Server.
-
--base-path
| --bp
(string)
-
The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.
Note: Do not specify this option if you are not using the Zowe API Mediation Layer.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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.
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.
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
-
responsekey
(string)
- The "solicited response key" provided in response to a previously issued console command. Used by the z/OSMF console API to collect any additional outstanding solicited responses from a previously issued console command. Must match regular expression:
^\[a\-zA\-Z0\-9\]\+$
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Issue z/OS console commands and optionally collect responses.
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
-
commandtext
(string)
- The z/OS console command to issue.
Options
-
--console-name
| --cn
| -c
(string)
-
The name of the z/OS extended MCS console to direct the command. You must have the required authority to access the console specified. You may also specify an arbitrary name, if your installation allows dynamic creation of consoles with arbitrary names.
Allowed values: ^[a-zA-Z0-9]+$
-
--include-details
| --id
| -i
(boolean)
- Include additional details at the end of the Zowe CLI command response, such as the "command response key" and the z/OSMF command response URL.
-
--key-only
| --ko
| -k
(boolean)
- Displays only the "command response key" returned from the z/OSMF console API. You can collect additional messages using the command key with 'zowe zos-console collect sync-responses <key>'. Note that when using this option, you will not be presented with the "first set" of command response messages (if present in the API response). However, you can view them by using the --response-format-json option.
-
--return-first
| --rf
| -r
(boolean)
- Indicates that Zowe CLI should return immediately with the response message set returned in the first z/OSMF API request (even if no responses are present). Using this option may result in partial or no response, but quicker Zowe CLI command response time. The z/OSMF console API has an implicit wait when collecting the first set of console command responses, i.e you will normally receive at least one set of response messages.
-
--solicited-keyword
| --sk
| -s
(string)
- For solicited responses (direct command responses) the response is considered complete if the keyword specified is present. If the keyword is detected, the command will immediately return, meaning the full command response may not be provided. The key only applies to the first request issued, follow up requests do not support searching for the keyword.
-
--sysplex-system
| --ss
| --sys
(string)
- Specifies the z/OS system (LPAR) in the current SYSPLEX (where your target z/OSMF resides) to route the z/OS console command.
-
--wait-to-collect
| --wtc
| -w
(number)
- Indicates that Zowe CLI wait at least the specified number of seconds before attempting to collect additional solicited response messages. If additional messages are collected on "follow-up" requests, the timer is reset until an attempt is made that results in no additional response messages.
-
--follow-up-attempts
| --fua
| -a
(number)
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Issue a z/OS console command to display the IPL information for the system:
zowe zos-console issue command "D IPLINFO"
-
Issue a z/OS console command to display the local and coordinated universal time and date:
zowe zos-console issue command "D T"
-
Issue a Db2 command to display information about the status and configuration of DDF:
zowe zos-console issue command "\-DB1G DISPLAY DDF"
Manage z/OS data sets, create data sets, and more.
Copy a data set.
Copy a data set to another data set
Usage
zowe zos-files copy data-set <fromDataSetName> <toDataSetName> [options]
Positional Arguments
-
fromDataSetName
(string)
- The name of the data set that you want to copy from
-
toDataSetName
(string)
- The name of the data set that you want to copy to (data set must be preallocated)
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET':
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET"
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)"
-
Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET(mem2)"
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET':
zowe zos-files copy data-set "USER.FROM.SET(mem1)" "USER.TO.SET"
-
Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' and replace like-named members:
zowe zos-files copy data-set "USER.FROM.SET" "USER.TO.SET" --replace
Create data sets.
Create data sets based on the properties of an existing data set
Usage
zowe zos-files create data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
- The block size for the data set (for example, 6160)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
- The number of directory blocks (for example, 25)
-
--like
| --lk
(string)
- Name of an existing data set to base your new data set's properties on
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
- The primary space allocation (for example, 5)
-
--record-format
| --rf
| --recfm
(string)
- The record format for the data set (for example, FB for "Fixed Block")
-
--record-length
| --rl
| --lrecl
(number)
- The logical record length. Analogous to the length of a line (for example, 80)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--show-attributes
| --pa
(boolean)
- Show the full allocation attributes
-
--size
| --sz
(string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--volume-serial
| --vs
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Create a data set with default parameters and like flag:
zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET
-
Create a data set with default parameters and like flag and lrecl flag:
zowe zos-files create data-set NEW.DATASET --like EXISTING.DATASET --lrecl 1024
-
Create a data set with type LIBRARY:
zowe zos-files create data-set NEW.DATASET --data-set-type LIBRARY
Create executable data sets
Usage
zowe zos-files create data-set-binary <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--show-attributes
| --pa
(boolean)
- Show the full allocation attributes
-
--size
| --sz
(string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--volume-serial
| --vs
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create data sets for C code programming
Usage
zowe zos-files create data-set-c <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--show-attributes
| --pa
(boolean)
- Show the full allocation attributes
-
--size
| --sz
(string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--volume-serial
| --vs
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create classic data sets (JCL, HLASM, CBL, etc...)
Usage
zowe zos-files create data-set-classic <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--show-attributes
| --pa
(boolean)
- Show the full allocation attributes
-
--size
| --sz
(string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--volume-serial
| --vs
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create partitioned data sets (PDS)
Usage
zowe zos-files create data-set-partitioned <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-type
| --dst
| --dsntype
(string)
- The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--show-attributes
| --pa
(boolean)
- Show the full allocation attributes
-
--size
| --sz
(string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--volume-serial
| --vs
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create physical sequential data sets (PS)
Usage
zowe zos-files create data-set-sequential <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to create
Options
-
--block-size
| --bs
| --blksize
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--device-type
| --dt
| --unit
(string)
- The device type, also known as 'unit'
-
--directory-blocks
| --db
| --dirblks
(number)
- The number of directory blocks (for example, 25)
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--primary-space
| --ps
(number)
-
--record-format
| --rf
| --recfm
(string)
-
--record-length
| --rl
| --lrecl
(number)
-
--secondary-space
| --ss
(number)
- The secondary space allocation (for example, 1)
-
--show-attributes
| --pa
(boolean)
- Show the full allocation attributes
-
--size
| --sz
(string)
- The size of the data set (specified as nCYL or nTRK - where n is the number of cylinders or tracks). Sets the primary allocation (the secondary allocation becomes ~10% of the primary).
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--volume-serial
| --vs
| --volser
(string)
- The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create a VSAM cluster
Usage
zowe zos-files create data-set-vsam <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the dataset in which to create a VSAM cluster
Options
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--data-set-organization
| --dso
| --dsorg
(string)
-
The data set organization.
Default value: INDEXED
Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--retain-for
| --rf
(number)
- The number of days that the VSAM cluster will be retained on the system. You can delete the cluster at any time when neither retain-for nor retain-to is specified.
-
--retain-to
| --rt
(string)
- The earliest date that a command without the PURGE parameter can delete an entry. Specify the expiration date in the form yyyyddd, where yyyy is a four-digit year (maximum value: 2155) and ddd is the three-digit day of the year from 001 through 365 (for non-leap years) or 366 (for leap years). You can delete the cluster at any time when neither retain-for nor retain-to is used. You cannot specify both the 'retain-to' and 'retain-for' options.
-
--secondary-space
| --ss
(number)
- The number of items for the secondary space allocation (for example, 840). The type of item allocated is the same as the type used for the '--size' option. If you do not specify a secondary allocation, a value of ~10% of the primary allocation is used.
-
--show-attributes
| --pa
(boolean)
- Show the full allocation attributes
-
--size
| --sz
(string)
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--volumes
| -v
(string)
- The storage volumes on which to allocate a VSAM cluster. Specify a single volume by its volume serial (VOLSER). To specify more than one volume, enclose the option in double-quotes and separate each VOLSER with a space. You must specify the volumes option when your cluster is not SMS-managed.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Create a VSAM data set named "SOME.DATA.SET.NAME" using default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:
zowe zos-files create data-set-vsam SOME.DATA.SET.NAME
-
Create a 5 MB LINEAR VSAM data set named "SOME.DATA.SET.NAME" with 1 MB of secondary space. Show the properties of the data set when it is created:
zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --show-attributes
-
Create a VSAM data set named "SOME.DATA.SET.NAME", which is retained for 100 days:
zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --retain-for 100
Create a UNIX directory.
Usage
zowe zos-files create uss-directory <ussPath> [options]
Positional Arguments
-
ussPath
(string)
- The name of the directory that you want to create.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create a UNIX file.
Usage
zowe zos-files create uss-file <ussPath> [options]
Positional Arguments
-
ussPath
(string)
- The name of the file that you want to create.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create a z/OS file system.
Usage
zowe zos-files create zos-file-system <fileSystemName> [options]
Positional Arguments
-
fileSystemName
(string)
- The name of the file system to create.
Options
-
--cyls-pri
| --cp
(number)
-
--cyls-sec
| --cs
(number)
-
--data-class
| --dc
(string)
- The SMS data class to use for the allocation
-
--group
| -g
(string)
- The z/OS group ID or GID for the group of the ZFS root directory.
-
--management-class
| --mc
(string)
- The SMS management class to use for the allocation
-
--owner
| -o
(string)
- The z/OS user ID or UID for the owner of the ZFS root directory.
-
--perms
| -p
(number)
-
--storage-class
| --sc
(string)
- The SMS storage class to use for the allocation
-
--timeout
| -t
(number)
-
--volumes
| -v
(array)
- The storage volumes on which to allocate the z/OS file system. Specify a single volume by its volume serial (VOLSER). To specify more than one volume, separate each VOLSER with a space. You must specify the volumes option when your cluster is not SMS-managed.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Create a ZFS named "HLQ.MYNEW.ZFS" using default values of 755 permissions, 10 primary and 2 secondary cylinders allocated, and a timeout of 20 seconds:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS
-
Create a ZFS with 100 primary and 10 secondary cylinders allocated:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS --cp 100 --cs 10
-
Create a ZFS specifying the volumes that should be used:
zowe zos-files create zos-file-system HLQ.MYNEW.ZFS -v ZFS001 ZFS002
Delete a data set or Unix System Services file.
Delete a data set or data set member permanently
Usage
zowe zos-files delete data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to delete
Required Options
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Delete a VSAM cluster permanently
Usage
zowe zos-files delete data-set-vsam <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the VSAM cluster that you want to delete
Options
Required Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Delete the VSAM data set named 'ibmuser.cntl.vsam':
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f
-
Delete all expired VSAM data sets that match 'ibmuser.AAA.**.FFF':
zowe zos-files delete data-set-vsam "ibmuser.AAA.**.FFF" -f
-
Delete a non-expired VSAM data set named 'ibmuser.cntl.vsam':
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f --purge
-
Delete an expired VSAM data set named 'ibmuser.cntl.vsam' by overwriting the components with zeros:
zowe zos-files delete data-set-vsam "ibmuser.cntl.vsam" -f --erase
Delete migrated data sets.
Usage
zowe zos-files delete migrated-data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the migrated data set you want to delete.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Delete a Unix Systems Services (USS) File or directory permanently
Usage
zowe zos-files delete uss-file <fileName> [options]
Positional Arguments
-
fileName
(string)
- The name of the file or directory that you want to delete
Required Options
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Delete the empty directory '/u/ibmuser/testcases':
zowe zos-files delete uss-file "/a/ibmuser/testcases" -f
-
Delete the file named '/a/ibmuser/my_text.txt':
zowe zos-files delete uss-file "/a/ibmuser/testcases/my_text.txt" -f
-
Recursively delete the directory named '/u/ibmuser/testcases':
zowe zos-files delete uss-file "/a/ibmuser/testcases" -rf
Delete a z/OS file system permanently.
Usage
zowe zos-files delete zos-file-system <fileSystemName> [options]
Positional Arguments
-
fileSystemName
(string)
- The name of the z/OS file system that you want to delete.
Required Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
Download content from z/OS data sets and USS files to your PC.
Download all members from a partitioned data set to a local folder
Usage
zowe zos-files download all-members <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set from which you want to download members
Options
-
--binary
| -b
(boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--directory
| -d
(string)
- The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).
-
--encoding
| --ec
(number)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--extension
| -e
(string)
- Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
-
--fail-fast
| --ff
(boolean)
-
--max-concurrent-requests
| --mcr
(number)
-
Specifies the maximum number of concurrent z/OSMF REST API requests to download members. Increasing the value results in faster downloads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the download process encounters an error, the following message displays:
The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to download all members at once without a maximum number of concurrent requests.
Default value: 1
-
--preserve-original-letter-case
| --po
(boolean)
-
--record
| -r
(boolean)
- Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Download content from a z/OS data set to a local file
Usage
zowe zos-files download data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set that you want to download
Options
-
--binary
| -b
(boolean)
- Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.
-
--encoding
| --ec
(number)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--extension
| -e
(string)
- Save the local files with a specified file extension. For example, .txt. Or "" for no extension. When no extension is specified, .txt is used as the default file extension.
-
--file
| -f
(string)
- The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.
-
--preserve-original-letter-case
| --po
(boolean)
-
--record
| -r
(boolean)
- Download the file content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Download content from a USS file to a local file on your PC
Usage
zowe zos-files download uss-file <ussFileName> [options]
Positional Arguments
-
ussFileName
(string)
- The name of the USS file you want to download
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Invoke z/OS utilities such as Access Method Services (AMS).
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
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
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
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
List data sets and data set members. Optionally, you can list their details and attributes.
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
-
dataSetName
(string)
- The name of the data set for which you want to list the members
Options
-
--attributes
| -a
(boolean)
- Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.
-
--max-length
| --max
(number)
- The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
-
--pattern
(string)
- The option --pattern specifies the match pattern used when listing members in a data set. The default is to match against all members, e.g. "*".
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Show members of the data set "ibmuser.asm":
zowe zos-files list all-members "ibmuser.asm"
-
Show attributes of members of the data set "ibmuser.cntl":
zowe zos-files list all-members "ibmuser.cntl" -a
-
Show the first 5 members of the data set "ibmuser.cntl":
zowe zos-files list all-members "ibmuser.cntl" --max 5
-
Show the first 4 members of the data set "ibmuser.cntl" matching an input pattern":
zowe zos-files list all-members "sys1.maclib" --pattern IJK* --max 4
List data sets that match a pattern in the data set name
Usage
zowe zos-files list data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name or pattern of the data set that you want to list
Options
-
--attributes
| -a
(boolean)
- Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.
-
--max-length
| --max
(number)
- The option --max-length specifies the maximum number of items to return. Skip this parameter to return all items. If you specify an incorrect value, the parameter returns up to 1000 items.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--start
| -s
(string)
- An optional search parameter that specifies the first data set name to return in the response document.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Show the data set "ibmuser.asm":
zowe zos-files list data-set "ibmuser.asm"
-
Show attributes of the data set "ibmuser.cntl":
zowe zos-files list data-set "ibmuser.cntl" -a
-
Show all data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.*"
-
Show attributes of all data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.*" -a
-
Show the first 5 data sets of the user "ibmuser":
zowe zos-files list data-set "ibmuser.cntl" --max 5
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
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
To list all mounted filesystems:
zowe zos-files list file-system
-
To list filesystems mounted to a specific path:
zowe zos-files list file-system -p /a/ibmuser
-
To list filesystems mounted with a specific name:
zowe zos-files list file-system -f MY.ZFS
List USS files and directories in a UNIX file path
Usage
zowe zos-files list uss-files <path> [options]
Positional Arguments
-
path
(string)
- The directory containing the files and directories to be listed
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Show the files and directories in path '/u/ibmuser':
zowe zos-files list uss-files "/u/ibmuser"
-
Show the files and directories in path '/u/ibmuser displaying only the file or directory name:
zowe zos-files list uss-files "/u/ibmuser" --rff name
-
Show the files and directories in path '/u/ibmuser' displaying the headers associated with the file detail:
zowe zos-files list uss-files "/u/ibmuser" --rfh
Migrate data sets.
Migrate a data set.
Usage
zowe zos-files migrate data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set you want to migrate.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Mount z/OS UNIX file systems, such as HFS, ZFS, and more. This connects you to USS file systems.
Mount a UNIX file system on a specified directory.
Usage
zowe zos-files mount file-system <fileSystemName> <mountPoint> [options]
Positional Arguments
-
fileSystemName
(string)
- The name of the file system to mount.
-
mountPoint
(string)
- The directory to use as a mount point.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Recall migrated data sets.
Recall a migrated data set.
Usage
zowe zos-files recall data-set <dataSetName> [options]
Positional Arguments
-
dataSetName
(string)
- The name of the data set you want to recall.
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Rename a data set or member.
Rename a data set.
Usage
zowe zos-files rename data-set <beforeDataSetName> <afterDataSetName> [options]
Positional Arguments
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
Rename a data set member.
Usage
zowe zos-files rename data-set-member <dataSetName> <beforeMemberName> <afterMemberName> [options]
Positional Arguments
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
Unmount file systems, such as HFS, ZFS, and more. This disconnects you from USS file systems.
Unmount a UNIX file system.
Usage
zowe zos-files unmount file-system <fileSystemName> [options]
Positional Arguments
-
fileSystemName
(string)
- The name of the file system to unmount.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Options
Profile Options
Base Connection Options
Examples
Upload the contents of a file to data sets.
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
-
inputdir
(string)
- The path for a local directory that you want to upload to a PDS
-
dataSetName
(string)
- The name of the partitioned data set to which you want to upload the files
Options
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--encoding
| --ec
(number)
- Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
-
--migrated-recall
| --mr
(string)
-
The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error
Default value: nowait
-
--record
| -r
(boolean)
- Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
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 pattern to match a set of files. Pattern-matching syntax follows the same rules as those that apply in .gitignore files (note that negated patterns that begin with ‘!’ are not supported). See https://git-scm.com/docs/gitignore#_pattern_format.
- A local-encoding to identify a file’s encoding on the local workstation. If '-' is specified for local-encoding,files that match the pattern are not transferred.
- A remote-encoding to specify the file’s desired character set on USS. This attribute must either match the local encoding or be set to EBCDIC. If set to EBCDIC, files are transferred in text mode and converted, otherwise they are transferred in binary mode. Remote files are tagged either with the remote encoding or as binary.
Due to a z/OSMF limitation, files that are transferred in text mode are converted to the default EBCDIC code page on the z/OS system. Therefore the only EBCDIC code page to specify as the remote encoding is the default code page for your system.
A .zosattributes file can either be placed in the top-level directory you want to upload, or its location can be specified by using the --attributes parameter. .zosattributes files that are placed in nested directories are ignored.
Usage
zowe zos-files upload dir-to-uss <inputDir> <USSDir> [options]
Positional Arguments
-
inputDir
(string)
- The local directory path that you want to upload to a USS directory
-
USSDir
(string)
- The name of the USS directory to which you want to upload the local directory
Options
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--recursive
| -r
(boolean)
- Upload all directories recursively.
-
--binary-files
| --bf
(string)
- Comma separated list of file names to be uploaded in binary mode. Use this option when you upload a directory in default ASCII mode, but you want to specify certain files to be uploaded in binary mode. All files matching specified file names will be uploaded in binary mode. If a .zosattributes file (or equivalent file specified via --attributes) is present, --binary-files will be ignored.
-
--ascii-files
| --af
(string)
- Comma separated list of file names to be uploaded in ASCII mode. Use this option when you upload a directory with --binary/-b flag, but you want to specify certain files to be uploaded in ASCII mode. All files matching specified file names will be uploaded in ASCII mode. If a .zosattributes file (or equivalent file specified via --attributes) is present, --ascii-files will be ignored.
-
--attributes
| --attrs
(string)
- Path of an attributes file to control how files are uploaded
-
--max-concurrent-requests
| --mcr
(number)
-
Specifies the maximum number of concurrent z/OSMF REST API requests to upload files. Increasing the value results in faster uploads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the upload process encounters an error, the following message displays:
The maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to upload all members at once without a maximum number of concurrent requests.
Default value: 1
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir"
-
Upload all files from the "local_dir" directory and all its sub-directories, to the "/a/ibmuser/my_dir" USS directory:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive
-
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory in default ASCII mode, while specifying a list of file names (without path) to be uploaded in binary mode:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary-files "myFile1.exe,myFile2.exe,myFile3.exe"
-
Upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory in binary mode, while specifying a list of file names (without path) to be uploaded in ASCII mode:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --binary --ascii-files "myFile1.txt,myFile2.txt,myFile3.txt"
-
Recursively upload all files from the "local_dir" directory to the "/a/ibmuser/my_dir" USS directory, specifying files to ignore and file encodings in the local file my_global_attributes:
zowe zos-files upload dir-to-uss "local_dir" "/a/ibmuser/my_dir" --recursive --attributes my_global_attributes
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
-
inputfile
(string)
- The local file that you want to upload to a data set
-
dataSetName
(string)
- The name of the data set to which you want to upload the file
Options
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--encoding
| --ec
(number)
- Data content in encoding mode, which means that data conversion is performed according to the encoding specified.
-
--migrated-recall
| --mr
(string)
-
The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error
Default value: nowait
-
--record
| -r
(boolean)
- Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Upload file contents to a sequential data set named "ibmuser.ps":
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps"
-
Upload file contents to a PDS member named "ibmuser.pds(mem)":
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.pds(mem)"
-
Upload file contents to a migrated data set and wait for it to be recalled:
zowe zos-files upload file-to-data-set "file.txt" "ibmuser.ps" --mr wait
Upload content to a USS file from local file
Usage
zowe zos-files upload file-to-uss <inputfile> <USSFileName> [options]
Positional Arguments
-
inputfile
(string)
- The local file that you want to upload to a USS file
-
USSFileName
(string)
- The name of the USS file to which you want to upload the file
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
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
-
dataSetName
(string)
- The name of the data set to which you want to upload data
Options
-
--binary
| -b
(boolean)
- Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.
-
--migrated-recall
| --mr
(string)
-
The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error
Default value: nowait
-
--record
| -r
(boolean)
- Data content in record mode, which means that no data conversion is performed and the record length is prepended to the data. The data transfer process returns each line as-is, without translation. No delimiters are added between records. Conflicts with binary.
-
--volume-serial
| --vs
(string)
- The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.
-
--response-timeout
| --rto
(number)
- The maximum amount of time in seconds the z/OSMF Files TSO servlet should run before returning a response. Any request exceeding this amount of time will be terminated and return an error. Allowed values: 5 - 600
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Stream content from stdin to a sequential data set named "ibmuser.ps" from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps"
-
Stream content from stdin to a partition data set member named "ibmuser.pds(mem)" from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.pds(mem)"
-
Stream content from stdin to a migrated data set and wait for it to be recalled from a Windows console:
echo "hello world" | zowe zos-files upload stdin-to-data-set "ibmuser.ps" --mr wait
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.
Allocate a sequential or partitioned dataset
Allocate a sequential or partitioned dataset
Usage
zowe zos-ftp allocate data-set <datasetName> [options]
Positional Arguments
-
datasetName
(string)
- The dataset name you'd like to allocate.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete data sets, jobs, and USS files
Delete a data set
Usage
zowe zos-ftp delete data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) which you would like to delete.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
jobid
(string)
- The ID of the job that you would like to delete
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a USS file
Usage
zowe zos-ftp delete uss-file <ussFile> [options]
Positional Arguments
-
ussFile
(string)
- The absolute path to a USS file you would like to delete.
Required Options
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Download data set, job spool, and USS file content
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
-
jobid
(string)
- The ID of the job for which you would like to list spool files
Options
-
--directory
| -d
(string)
- The local directory to save the spool content to. By default, it will be saved to "./output".
-
--omit-jobid-directory
| --ojd
(boolean)
- If you specify this, the job output will be saved directly to the specified (or default) directory. For example, if you omit this, the output would be saved to ./output/JOB00123. If you specify --ojd, the JOB00123 directory would not be included in the output path and the content would be saved to ./output.
-
--host
| -H
(string)
- The hostname or IP address of the z/OS server to connect to.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Username for authentication on z/OS
-
--password
| -p
| --pass
| --pw
(string)
- Password to authenticate to FTP.
-
--secure-ftp
(boolean)
-
Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.
Default value: true
-
--connection-timeout
| --ct
(number)
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Download the contents of a z/OS data set to a local file
Usage
zowe zos-ftp download data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) which you would like to download to a local file.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Download the contents of a USS file to a local file
Usage
zowe zos-ftp download uss-file <ussFile> [options]
Positional Arguments
-
ussFile
(string)
- The path to the USS file you would like to download.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
List data sets, data set members, uss files, jobs, spool files
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
-
pattern
(string)
- The pattern or patterns to match data sets against. Also known as 'DSLEVEL', it is somewhat similar to the concept of a 'glob' (but not identical). The following special sequences can be used in the pattern:
%: Matches any single character
*: Matches any number of characters within a data set name qualifier (e.g. "ibmuser.j*.old" matches "ibmuser.jcl.old" but not "ibmuser.jcl.very.old")
**: Matches any number of characters within any number of data set name qualifiers (e.g. "ibmuser.**.old" matches both "ibmuser.jcl.old" and "ibmuser.jcl.very.old")
However, the pattern cannot begin with any of these sequences.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List all members of the specified PDS or PDSE data set.
Usage
zowe zos-ftp list data-set-members <dsname> [options]
Positional Arguments
-
dsname
(string)
- The PDS or PDSE data set name.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
List all data sets that match a DSLEVEL pattern (see help below).
Usage
zowe zos-ftp list jobs [options]
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
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
-
jobid
(string)
- The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
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
-
directory
(string)
- The USS directory to list files in, or the directory with file name pattern
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List USS files in the directory "/u/users/ibmuser/":
zowe zos-ftp list uss-files "/u/users/ibmuser"
-
List USS files with suffix of ".txt" in the directory "/u/users/ibmuser/":
zowe zos-ftp list uss-files "/u/users/ibmuser/*.txt"
-
List USS files in the directory "/u/users/ibmuser/" and show only the file name:
zowe zos-ftp list uss-files "/u/users/ibmuser/" --rff name
Make a USS directory
Make a Unix System Services Directory
Usage
zowe zos-ftp make uss-directory <ussDirectory> [options]
Positional Arguments
-
ussDirectory
(string)
- The USS directory you'd like to make.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Rename data sets and USS files or directories
Rename a cataloged data set
Usage
zowe zos-ftp rename data-set <oldDataSet> <newDataSet> [options]
Positional Arguments
-
oldDataSet
(string)
- The current name of the data set you want to rename.
-
newDataSet
(string)
- The new name for the data set.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Rename the data set ibmuser.jcl to ibmuser.cntl:
zowe zos-ftp rename data-set ibmuser.jcl ibmuser.cntl
-
Rename the data set member "ibmuser.cntl(alloc)" to "ibmuser.cntl(alloc2)". Note: you can only rename members within the same partitioned data set. You cannot move a member to another data set with this command.:
zowe zos-ftp rename data-set "ibmuser.cntl(alloc)" "ibmuser.cntl(alloc2)"
Rename a USS file or directory
Usage
zowe zos-ftp rename uss-file <olduss> <newuss> [options]
Positional Arguments
-
olduss
(string)
- The current name of the USS file you want to rename.
-
newuss
(string)
- The new name for the USS file.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Submit jobs from local files and data sets
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
-
dataSet
(string)
- The data set containing JCL that you would like to submit
Options
-
--wait
| -w
(string)
- Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--host
| -H
(string)
- The hostname or IP address of the z/OS server to connect to.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Username for authentication on z/OS
-
--password
| -p
| --pass
| --pw
(string)
- Password to authenticate to FTP.
-
--secure-ftp
(boolean)
-
Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.
Default value: true
-
--connection-timeout
| --ct
(number)
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit a job residing in the data set "ibmuser.cntl(iefbr14)":
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)"
-
Submit a job from the data set "ibmuser.cntl(iefbr14)" and print only the job ID:
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --rff jobid --rft string
-
Submit a job from the data set "ibmuser.cntl(iefbr14)" and wait for job complete.:
zowe zos-ftp submit data-set "ibmuser.cntl(iefbr14)" --wait 5,12
Submit a job from a local file containing JCL
Usage
zowe zos-ftp submit local-file <file> [options]
Positional Arguments
-
file
(local file path)
- The file you would like to submit as jcl
Options
-
--wait
| -w
(string)
- Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--host
| -H
(string)
- The hostname or IP address of the z/OS server to connect to.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Username for authentication on z/OS
-
--password
| -p
| --pass
| --pw
(string)
- Password to authenticate to FTP.
-
--secure-ftp
(boolean)
-
Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.
Default value: true
-
--connection-timeout
| --ct
(number)
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit a job from the local file "my_build_jcl.txt":
zowe zos-ftp submit local-file "my_build_jcl.txt"
-
Submit a job from the local file "my_build_jcl.txt" and print only the job ID:
zowe zos-ftp submit local-file "my_build_jcl.txt" --rff jobid --rft string
-
Submit a job from the local file "my_build_jcl.txt" and wait for job complete.:
zowe zos-ftp submit local-file "my_build_jcl.txt" --wait 5,12
Submit a job from JCL written to the standard input (stdin) of this process.
Usage
zowe zos-ftp submit stdin [options]
Options
-
--wait
| -w
(string)
- Specify job query interval and max times of querying job status. The format of this option is comma-separated numeric values. For example, '5,12' means queries job status every 5 seconds for 12 times at most.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--host
| -H
(string)
- The hostname or IP address of the z/OS server to connect to.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Username for authentication on z/OS
-
--password
| -p
| --pass
| --pw
(string)
- Password to authenticate to FTP.
-
--secure-ftp
(boolean)
-
Set to true for both control and data connection encryption, 'control' for control connection encryption only, or 'implicit' for implicitly encrypted control connection (this mode is deprecated in modern times, but usually uses port 990). Note: Unfortunately, this plugin's functionality only works with FTP and FTPS, not 'SFTP' which is FTP over SSH.
Default value: true
-
--connection-timeout
| --ct
(number)
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit a job from stdin, redirecting the contents of my_jcl.txt in.:
zowe zos-ftp submit stdin < my_jcl.txt
-
Submit a job from the local file "my_build_jcl.txt" and wait for job complete.:
zowe zos-ftp submit stdin "my_build_jcl.txt" --wait 5,12
Upload data set and USS content
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
-
file
(local file path)
- Upload the contents of this file to the data set
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) to which you would like to upload content.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
file
(local file path)
- Upload the contents of this local file to a data set.
-
ussFile
(string)
- The USS file to which you would like to upload content.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Upload contents piped to stdin to a z/OS data set
Usage
zowe zos-ftp upload stdin-to-data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) to which you would like to upload content.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Upload from stdin to a Unix System Services File
Usage
zowe zos-ftp upload stdin-to-uss-file <ussFile> [options]
Positional Arguments
-
ussFile
(string)
- The USS file to which you would like to upload content.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
View data sets, job output, and USS content
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
-
jobid
(string)
- The ID of the job for which you would like to list spool files
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
View the contents of a z/OS data set
Usage
zowe zos-ftp view data-set <dataSet> [options]
Positional Arguments
-
dataSet
(string)
- The data set (PDS member or physical sequential data set) which you would like to view the contents of.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
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
-
jobid
(string)
- The ID of the jobfor which you would like to list spool files
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
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
-
jobid
(string)
- The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
-
spoolfileid
(number)
- The spool file ID number for the spool file to view. No pre-validation of the ID is performed.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
View the contents of a Unix System Services File
Usage
zowe zos-ftp view uss-file <ussFile> [options]
Positional Arguments
-
ussFile
(string)
- The USS file you'd like to view the contents of.
Options
TLS / Secure Connection options
Profile Options
Base Connection Options
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Manage z/OS jobs.
Cancel a single job by job ID. This cancels the job if it is running or on input.
Cancel a single job by job ID
Usage
zowe zos-jobs cancel job <jobid> [options]
Positional Arguments
-
jobid
(string)
- The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Delete a single job by job ID in OUTPUT status. This cancels the job if it is running and purges its output from the system.
Delete a single job by job ID
Usage
zowe zos-jobs delete job <jobid> [options]
Positional Arguments
-
jobid
(string)
- The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example "J123".
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Download the output of a job as separate files.
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
-
jobid
(string)
- The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
Options
-
--directory
| -d
| --dir
(string)
- The local directory you would like to download the output for the job to.
-
--extension
| -e
(string)
- A file extension to save the job output with. Defaults to '.txt'.
-
--omit-jobid-directory
| --ojd
(boolean)
- If specified, job output will be saved directly to the specified directory rather than creating a subdirectory named after the ID of the job.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
List z/OS jobs and list the spool files (DDs) for a z/OS job on the JES/spool queues.
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
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List all jobs with default settings. The command returns jobs owned by your user ID with any job name:
zowe zos-jobs list jobs
-
List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo':
zowe zos-jobs list jobs -o "ibmu*" -p "myjo*"
-
List all jobs with default owner and prefix settings, displaying only the job ID of each job:
zowe zos-jobs list jobs --rff jobid --rft table
-
List all jobs and return job execution data along with the default information:
zowe zos-jobs list jobs --exec-data
-
List all jobs owned by user IDs starting with 'ibmu' and return job execution data along with the default information:
zowe zos-jobs list jobs -o "ibmu*" --exec-data
-
List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo' and return job execution data along with the default information:
zowe zos-jobs list jobs -o "ibmu*" -p "myjo*" --exec-data
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
-
jobid
(string)
- The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Submit a job (JCL).
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
-
dataset
(string)
- The z/OS data set containing the JCL to submit. You can specify a physical sequential data set (for example, "DATA.SET") or a partitioned data set qualified by a member (for example, "DATA.SET(MEMBER)").
Options
-
--volume
| --vol
(string)
- The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not catalogued on the system.
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait for the job to complete.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols
| --js
(string)
- A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Submit the JCL in the data set "ibmuser.cntl(deploy)":
zowe zos-jobs submit data-set "ibmuser.cntl(deploy)"
-
Submit the JCL in the data set "ibmuser.cntl(deploy)", wait for the job to complete and print all output from the job:
zowe zos-jobs submit data-set "ibmuser.cntl(deploy)" --vasc
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
-
localFile
(string)
- The local file containing the JCL to submit.
Options
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait for the job to complete.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols
| --js
(string)
- A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
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
-
--wait-for-active
| --wfa
(boolean)
- Wait for the job to enter ACTIVE status before completing the command.
-
--wait-for-output
| --wfo
(boolean)
- Wait for the job to enter OUTPUT status before completing the command.
-
--view-all-spool-content
| --vasc
(boolean)
- Print all spool output. If you use this option you will wait for the job to complete.
-
--directory
| -d
(string)
- The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait for the job to complete.
-
--extension
| -e
(string)
- A file extension to save the job output with. Default is '.txt'.
-
--jcl-symbols
| --js
(string)
- A string of JCL symbols to use for substitution. For symbol values with no spaces: "symbol1=value1 symbol2=value2 ...". When a value contains spaces, enclose the value in single quotes: "symbol1='value 1 with spaces' symbol2='value 2 with spaces' ...". To embed a single quote in a value, use two single quotes: "NAME=O''Brian".
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
View details of z/OS jobs on spool/JES queues.
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
-
jobid
(string)
- The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
View status and other details of the job with the job ID JOB00123:
zowe zos-jobs view job-status-by-jobid j123
-
Print only the status (for example, "OUTPUT" or "ACTIVE") of the job with the job ID JOB00123:
zowe zos-jobs view job-status-by-jobid j123 --rff status --rft string
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
-
jobid
(string)
- The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
-
spoolfileid
(number)
- The spool file ID number for the spool file to view. Use the "zowe zos-jobs list spool-files-by-jobid" command to obtain spool ID numbers.No pre-validation of the ID is performed.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Interact with z/OS logs.
List z/OS logs by invoking z/OSMF REST API.
List z/OS operlog within a time range.
Use this operation to get the z/OS operations logs. It invokes z/OSMF REST API to retrieve logs.
Executing 'zowe zos-logs list logs' will by default return logs from current time and backwards to 10 minutes before.
Note: OPERLOG needs to be configured on z/OS server.
Usage
zowe zos-logs list logs [options]
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--user
| -u
(string)
- User name to authenticate to service on the mainframe.
-
--password
| --pass
| --pw
(string)
- Password to authenticate to service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
-
List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later:
zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m --direction forward
-
List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later. Alias version of the above command:
zowe zos-logs list logs --st 2021-07-26T03:38:37.098Z -r 5m -d forward
-
List logs starting from '2021-07-26T03:38:37.098Z' and backwards to 5 minutes before:
zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m
Issue z/OS USS commands remotely using an SSH session. Output from the commands is displayed on the local terminal.
Issue a z/OS USS command.
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
-
command
(string)
- z/OS USS command to issue
Options
-
--cwd
(string)
- Working directory in which to execute the command
z/OS Ssh Connection Options
-
--host
| -H
(string)
- The z/OS SSH server host name.
-
--port
| -P
(number)
-
--user
| -u
(string)
- Mainframe user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe password, which can be the same as your TSO password.
-
--privateKey
| --key
| --pk
(string)
- Path to a file containing your private key, that must match a public key stored in the server for authentication
-
--keyPassphrase
| --passphrase
| --kp
(string)
- Private key passphrase, which unlocks the private key.
-
--handshakeTimeout
| --timeout
| --to
(number)
- How long in milliseconds to wait for the SSH handshake to complete.
Profile Options
Base Connection Options
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Examples
Issue TSO commands and interact with TSO address spaces.
Issue TSO commands.
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
-
commandText
(string)
- The TSO command to issue.
Options
TSO ADDRESS SPACE OPTIONS
-
--account
| -a
(string)
- Your z/OS TSO/E accounting information.
-
--character-set
| --cs
(string)
-
--code-page
| --cp
(string)
-
--columns
| --cols
(number)
-
--logon-procedure
| -l
(string)
-
--region-size
| --rs
(number)
-
--rows
(number)
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile
| --tso-p
(string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Examples
Ping a TSO address space, from which you previously started and received a token (a.k.a 'servelet-key').
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
-
servletKey
(string)
- The servlet key from a previously started TSO address space.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Send data to TSO and collect responses until the prompt is reached.
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
-
servletKey
(string)
- The servlet key from a previously started TSO address space.
Required Options
-
--data
(string)
- The data to which we want to send to the TSO address space represented by the servlet key.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Start TSO/E address 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
-
--account
| -a
(string)
- Your z/OS TSO/E accounting information.
-
--character-set
| --cs
(string)
-
--code-page
| --cp
(string)
-
--columns
| --cols
(number)
-
--logon-procedure
| -l
(string)
-
--region-size
| --rs
(number)
-
--rows
(number)
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
-
--zosmf-profile
| --zosmf-p
(string)
- The name of a (zosmf) profile to load for this command execution.
-
--tso-profile
| --tso-p
(string)
- The name of a (tso) profile to load for this command execution.
-
--base-profile
| --base-p
(string)
- The name of a (base) profile to load for this command execution.
Base Connection Options
Examples
-
Start TSO/E address space:
zowe zos-tso start address-space
-
Start TSO/E address space, and receive response in JSON format:
zowe zos-tso start address-space --rfj
-
Start TSO/E address space, and print only the servlet key:
zowe zos-tso start address-space --sko
Stop TSO/E address 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
-
servletkey
(string)
- The servlet key from a previously started TSO address space.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
Create and manage z/OSMF workflows on a z/OS system.
Archive workflow instance in z/OSMF.
Archive an active workflow instance in z/OSMF.
Usage
zowe zos-workflows archive active-workflow [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Archive a workflow with workflow name "testworkflow":
zowe zos-workflows archive active-workflow --wn "testworkflow"
-
Archive multiple workflows with workflow names starting with "test":
zowe zos-workflows archive active-workflow --wn "test.*"
-
Archive a workflow with workflow key "123-456-abv-xyz":
zowe zos-workflows archive active-workflow --wk "123-456-abv-xyz"
Create a z/OSMF workflow on a z/OS system.
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
-
--variables-input-file
| --vif
(string)
- Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
-
--variables
| --vs
(string)
- Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
-
--assign-to-owner
| --ato
(boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type
| --at
(string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed
| --dc
(boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite
| --ov
(boolean)
- Replaces an existing workflow with a new workflow.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Create a workflow with name "testworkflow" using the data set "TESTID.WKFLOW" that contains the workflow definition xml on the system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exist in z/OSMF:
zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "OTHERID" --overwrite
-
Create a workflow with name "testworkflow" using data set "TESTID.WKFLOW" containing workflow definition xml, on system "TESTM1" with owner "MYSYSID" and delete succesfully completed jobs:
zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
-
Create a workflow with name "testworkflow" using data set "TESTID.WKFLOW" containing workflow definition xml, on system "TESTM1" with owner "MYSYSID" and with variable values in the member PROPERTIES of data set TESTID.DATA:
zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
-
Create a workflow with name "testworkflow" using the data set "TESTID.WKFLOW" that contains a workflow definition xml, on a system "TESTM1" with owner "MYSYSID" and with the variable name DUMMYVAR and the value DUMMYVAL. Assign it to the owner:
zowe zos-workflows create workflow-from-data-set "testworkflow" --data-set "TESTID.WKFLOW" --system-name "TESTM1" --owner "MYSYSID" --variables DUMMYVAR=DUMMYVAL --assign-to-owner
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
-
--variables-input-file
| --vif
(string)
- Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
-
--variables
| --vs
(string)
- Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
-
--assign-to-owner
| --ato
(boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type
| --at
(string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed
| --dc
(boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite
| --ov
(boolean)
- Replaces an existing workflow with a new workflow.
-
--remote-directory
| --rd
(string)
- The remote uss directory where the files are to be uploaded. The directory has to exist
-
--keep-files
| --kf
(boolean)
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
Create a workflow instance in z/OSMF using a USS file
Usage
zowe zos-workflows create workflow-from-uss-file <workflowName> [options]
Positional Arguments
-
workflowName
(string)
- Name of the workflow instance to create
Required Options
Options
-
--variables-input-file
| --vif
(string)
- Specifies an optional properties file that you can use to pre-specify values for one or more of the variables that are defined in the workflow definition file.
-
--variables
| --vs
(string)
- Includes a list of variables for the workflow. The variables that you specify here take precedence over the variables that are specified in the workflow variable input file. Make sure the value meets all regular expression requirements set for the corresponding variable.
-
--assign-to-owner
| --ato
(boolean)
- Indicates whether the workflow steps are assigned to the workflow owner.
-
--access-type
| --at
(string)
-
Specifies the access type for the workflow. Public, Restricted or Private.
Allowed values: Public, Restricted, Private
-
--delete-completed
| --dc
(boolean)
- Whether the successfully completed jobs to be deleted from the JES spool.
-
--overwrite
| --ov
(boolean)
- Replaces an existing workflow with a new workflow.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "OTHERID" and delete workflow with the same name if it already exist in z/OSMF:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "OTHERID" --overwrite
-
Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and delete successfully completed jobs:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --delete-completed
-
Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and with variable values in the member PROPERTIES of data set TESTID.DATA:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1" --owner "MYSYSID" --variables-input-file TESTID.DATA(PROPERTIES)
-
Create a workflow with name "testworkflow" using uss file "/path/workflow.xml" containing workflow definition, on system "TESTM1" with owner "MYSYSID" and with variables VAR1 and VAR2 with values DUMMYVAL1 and DUMMYVAL2, and assign it to the owner:
zowe zos-workflows create workflow-from-uss-file "testworkflow" --uss-file "/path/workflow.xml" --system-name "TESTM1"--variables VAR1=DUMMYVAL1,VAR2=DUMMYVAL2 --owner "MYSYSID" --assign-to-owner
Delete an active workflow or an archived workflow from z/OSMF.
Delete an active workflow instance in z/OSMF
Usage
zowe zos-workflows delete active-workflow [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To delete a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows delete active-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To delete a workflow instance in z/OSMF with workflow name "testWorkflow":
zowe zos-workflows delete active-workflow --workflow-name "testWorkflow"
-
To delete multiple workflow instances in z/OSMF with names starting with "test":
zowe zos-workflows delete active-workflow --workflow-name "test.*"
Delete an archived workflow from z/OSMF
Usage
zowe zos-workflows delete archived-workflow [options]
Options
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To delete an archived workflow from z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows delete archived-workflow --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To delete an archived workflow from z/OSMF with workflow name "testWorkflow":
zowe zos-workflows delete archived-workflow --workflow-name "testWorkflow"
-
To delete multiple archived workflows from z/OSMF with names beginnig with "test":
zowe zos-workflows delete archived-workflow --workflow-name "test.*"
List the z/OSMF workflows for a system or a sysplex with filter options.
Get the details of an active z/OSMF workflow
Usage
zowe zos-workflows list active-workflow-details [options]
Options
-
--workflow-name
| --wn
(string)
- List active workflow details by specified workflow name.
-
--workflow-key
| --wk
(string)
- List active workflow details by specified workflow key.
-
--list-steps
| --ls
(boolean)
- Optional parameter for listing steps and their properties.
-
--steps-summary-only
| --sso
(boolean)
- Optional parameter that lists steps summary only.
-
--list-variables
| --lv
(boolean)
- Optional parameter for listing variables and their properties.
-
--skip-workflow-summary
| --sws
(boolean)
- Optional parameter that skips the default workflow summary.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To list the details of an active workflow with key "7c62c790-0340-86b2-61ce618d8f8c" including its steps and variables:
zowe zos-workflows list active-workflow-details --workflow-key "7c62c790-0340-86b2-61ce618d8f8c" --list-steps --list-variables
-
To list the details of an active workflow with name "testWorkflow" including its steps and variables:
zowe zos-workflows list active-workflow-details --workflow-name "testWorkflow" --list-steps --list-variables
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
-
--workflow-name
| --wn
(string)
- Filter by workflow name. For wildcard use .*
-
--category
| --cat
(string)
- Filter by the category of the workflows, which is either general or configuration.
-
--system
| --sys
(string)
- Filter by the nickname of the system on which the workflows is/are active.
-
--owner
| --ow
(string)
- Filter by owner of the workflow(s) (a valid z/OS user ID).
-
--vendor
| --vd
(string)
- Filter by the name of the vendor that provided the workflow(s) definition file.
-
--status-name
| --sn
(string)
-
Filter by the status of the workflow(s).
Allowed values: in-progress, complete, automation-in-progress, canceled
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List the workflow with name "testworkflow":
zowe zos-workflows list active-workflows --wn "testworkflow"
-
List multiple active workflows on the entire syspex with names containing"workflow":
zowe zos-workflows list active-workflows --wn ".*workflow.*"
-
List multiple active workflows on system "IBMSYS" with names beginnig with "testW" that are in status "complete":
zowe zos-workflows list active-workflows --wn "test.*" --sys "IBMSYS" --sn "complete"
List the archived z/OSMF workflows for a system or sysplex.
Usage
zowe zos-workflows list archived-workflows [options]
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter
| --rff
(array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type
| --rft
(string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header
| --rfh
(boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
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
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To list the contents of a workflow definition stored in the UNIX file "/user/dir/workflow.xml" including its steps and variables:
zowe zos-workflows list definition-file-details "/user/dir/workflow.xml" --list-steps --list-variables
-
To list the contents of a workflow definition stored in the z/OS data set "USER.DATA.SET.XML" including its steps and variables:
zowe zos-workflows list definition-file-details "USER.DATA.SET.XML" --list-steps --list-variables
Start a z/OSMF workflow on a z/OS system.
Will run workflow from the beginning to the end or to the first manual step.
Usage
zowe zos-workflows start workflow-full [options]
Options
-
--workflow-key
| --wk
(string)
- Workflow key of workflow instance to be started
-
--workflow-name
| --wn
(string)
- Workflow name of workflow instance to be started
-
--resolve-conflict-by
| --rcb
(string)
-
How variable conflicts should be handled.
Options:
outputFileValue: Allow the output file values to override the existing values.
existingValue: Use the existing variables values instead of the output file values.
leaveConflict: Automation is stopped. The user must resolve the conflict manually.
Default value: outputFileValue
Allowed values: outputFileValue, existingValue, leaveConflict
-
--wait
| -w
(boolean)
- Identifies whether to wait for workflow instance to finish.
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" and wait forit to be finished:
zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --wait
-
To start a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"and if there is a conflict in variable's value use the value that is in output file:
zowe zos-workflows start workflow-full --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
-
To start a workflow instance in z/OSMF with workflow name "testWorkflow":
zowe zos-workflows start workflow-full --workflow-name "testWorkflow"
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
-
stepName
(string)
- Specifies the step name that will be run.
Options
-
--workflow-key
| --wk
(string)
- Workflow key of workflow instance to be started
-
--workflow-name
| --wn
(string)
- Workflow name of workflow instance to be started
-
--resolve-conflict-by
| --rcb
(string)
-
How variable conflicts should be handled.
Options:
outputFileValue: Allow the output file values to override the existing values.
existingValue: Use the existing variables values instead of the output file values.
leaveConflict: Automation is stopped. The user must resolve the conflict manually.
Default value: outputFileValue
Allowed values: outputFileValue, existingValue, leaveConflict
-
--perform-following-steps
| --pfs
(boolean)
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
To start step "Step1" only in a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"
-
To start a workflow instance in z/OSMF from step "Step1" with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0":
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --perform-following-steps
-
To start step "Step1" only in a workflow instance in z/OSMF with workflow key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0"and if there is a conflict in variable's value use the value that is in output file:
zowe zos-workflows start workflow-step "Step1" --workflow-key "d043b5f1-adab-48e7-b7c3-d41cd95fa4b0" --resolve-conflict-by "outputFileValue"
-
To start step "Step1" only in a workflow instance in z/OSMF with workflow name "testWorkflow":
zowe zos-workflows start workflow-step "Step1" --workflow-name "testWorkflow"
z/OS Connect EE plugin for Zowe CLI
Manage z/OS Connect EE APIs
Delete an API
Usage
zowe zosconnect api delete <apiName> [options]
Positional Arguments
-
apiName
(string)
- The name of the API to delete.
Options
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Get detailed information about an API
Usage
zowe zosconnect api info <apiName> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Install a new API
Usage
zowe zosconnect api install <file> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
List the APIs installed in the server
Usage
zowe zosconnect api list [options]
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Set an APIs status to started
Usage
zowe zosconnect api start <apiName> [options]
Positional Arguments
-
apiName
(string)
- The name of the API to start.
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Set an APIs status to stopped
Usage
zowe zosconnect api stop <apiName> [options]
Positional Arguments
-
apiName
(string)
- The name of the API to stop.
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Update an existing API
Usage
zowe zosconnect api update <apiName> <file> [options]
Positional Arguments
-
apiName
(string)
- The name of the API to update.
-
file
(string)
- The new AAR file for the API
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Manage z/OS Connect EE API Requesters
Delete an API Requester
Usage
zowe zosconnect apirequester delete <apiRequesterName> [options]
Positional Arguments
Options
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Get detailed information about an API Requester
Usage
zowe zosconnect apirequester info <apiRequesterName> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Install a new API Requester
Usage
zowe zosconnect apirequester install <file> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
List the API Requesters installed in the server
Usage
zowe zosconnect apirequester list [options]
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Set an API Requester status to started
Usage
zowe zosconnect apirequester start <apiRequesterName> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Set an API Requesters status to stopped
Usage
zowe zosconnect apirequester stop <apiRequesterName> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Update an existing API Requester
Usage
zowe zosconnect apirequester update <apiRequesterName> <file> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Manage z/OS Connect EE Services
Delete a Service
Usage
zowe zosconnect service delete <serviceName> [options]
Positional Arguments
-
serviceName
(string)
- The name of the Service to delete
Options
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Get detailed information about a Service
Usage
zowe zosconnect service info <serviceName> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Install a new Service
Usage
zowe zosconnect service install <file> [options]
Positional Arguments
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
List the Services installed in the server
Usage
zowe zosconnect service list [options]
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Set a Services status to started
Usage
zowe zosconnect service start <serviceName> [options]
Positional Arguments
-
serviceName
(string)
- The name of the Service to start.
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Set a Services status to stopped
Usage
zowe zosconnect service stop <serviceName> [options]
Positional Arguments
-
serviceName
(string)
- The name of the Service to stop.
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Update an exisiting Service
Usage
zowe zosconnect service update <serviceName> <file> [options]
Positional Arguments
-
serviceName
(string)
- The name of the Service to update.
-
file
(string)
- The new SAR file for the Service
z/OS Connect EE Connection Options
-
--address
| -a
(string)
- URI of the z/OS Connect EE server
-
--user
| -u
(string)
- User ID for accessing the server
-
--password
| -p
(string)
Options
Profile Options
Base Connection Options
-
--host
| -H
(string)
- Host name of service on the mainframe.
-
--port
| -P
(number)
- Port number of service on the mainframe.
-
--reject-unauthorized
| --ru
(boolean)
-
--token-type
| --tt
(string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value
| --tv
(string)
- The value of the token to pass to the API.
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Retrieve and show the properties of a z/OSMF web server.
Confirm that z/OSMF is running on a specified system and gather information about the z/OSMF server for diagnostic purposes.
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
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Report the status of the z/OSMF server that you specified in your default z/OSMF profile:
zowe zosmf check status
-
Report the status of the z/OSMF server that you specified in a supplied z/OSMF profile:
zowe zosmf check status --zosmf-profile SomeZosmfProfileName
-
Report the status of the z/OSMF server that you specified manually via command line:
zowe zosmf check status --host myhost --port 443 --user myuser --password mypass
Obtain a list of systems that are defined to a z/OSMF instance.
Obtain a list of systems that are defined to a z/OSMF instance.
Usage
zowe zosmf list systems [options]
Zosmf Connection Options
-
--host
| -H
(string)
- The z/OSMF server host name.
-
--port
| -P
(number)
-
The z/OSMF server port.
Default value: 443
-
--user
| -u
(string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password
| --pass
| --pw
(string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized
| --ru
(boolean)
-
--base-path
| --bp
(string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol
(string)
-
--cert-file
(local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file
(local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Examples
-
Obtain a list of systems defined to a z/OSMF instance with your default z/OSMF profile:
zowe zosmf list systems
-
Obtain a list of systems defined to a z/OSMF instance for the specified z/OSMF profile:
zowe zosmf list systems --zosmf-profile SomeZosmfProfileName
-
Obtain a list of the systems defined to a z/OSMF instance that you specified in the command line:
zowe zosmf list systems --host myhost --port 443 --user myuser --password mypass