Welcome to Zowe CLI!
Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.
For additional Zowe CLI documentation, visit https://docs.zowe.org
For Zowe CLI support, visit https://www.zowe.org
Options
Global Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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!
All the available commands are listed in the COMMANDS section.
Manually adds temporary, one-time, preexecution user or predecessor job requirements
Usage
zowe ca7 commands addrq [options]
Required Options
Options
-
--depjob (string)
-
example: PAYJOB
Defines a temporary one-time job dependency requirement.
The DEPJOB value specifies the job name that must complete execution
or must be manually posted complete before the job identified by JOB is eligible for submission.
DEPJOB is required unless USR is used, in which case, omit DEPJOB.
This requirement is satisfied automatically when the predecessor job completes.
Only in unusual situations would this requirement must be satisfied manually.
That is, any time that a normal completion did not occur.
Required: Yes, unless USR is used.
Limits: 1 to 8 alphanumeric characters
-
--usr (string)
-
example: USER WILL CALL TO RELEASE
Defines the description of a temporary, one-time user requirement.
This requirement must be manually satisfied before the job identified by JOB is eligible for submission.
If any commas are included as part of the text, enclose the entire requirements text in parentheses.
This requirement is satisfied automatically when the predecessor job completes.
Only in unusual situations would this requirement must be satisfied manually.
That is, any time that a normal completion did not occur.
Required: USR is required unless DEPJOB is used, in which case, omit USR.
Limits: 1 to 36 alphanumeric characters
-
--rmtjob (string)
-
example: RMT_JOB
Names the job in the remote scheduler that is required by the job specified in the JOB field.
Limits: RMTJOB should accept up to 64 characters
valid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),
colon (:), and pound (#); do not include embedded spaces or tabs.
-
--rmtschd (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
For CPU jobs, the CANCEL command only removes the job from the queues.
For XPJOB jobs, the CANCEL command removes the job from the queues.
For agent definition jobs (AGJOBs), the CANCEL command sends a request to the agent and removes the job from the queues.
Usage
zowe ca7 commands cancel [options]
Required Options
Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Cancel ca7 number, 0016:
zowe ca7 commands cancel --ca7num 0016
The demanded jobs are placed in the request queue and assigned a unique CA 7 job number.
JOB and JOBL are mutually exclusive.
Usage
zowe ca7 commands demand [options]
Required Options
Options
-
--jobl (string)
-
--arfset | --as (string)
-
arfset={arfsetname|**NONE**}
Defines the ARF set name that is used for this run of the job.
If you specify **NONE**, no ARF processing is performed for this run of the job.
Limits: 1 to 8 alphanumeric characters or **NONE**
-
--cc (string)
-
cc=1234
Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.
If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.
Default: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.
Limits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.
-
--class (string)
-
--count (string)
-
count=nnnn
Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.
Default: None. The job continues repeating until the STOP time is reached.
Limits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.
-
--date (string)
-
date={+nn|yyddd}
Defines due-out and submit dates.
Limits: If used, specify DOTM or TIME.
+nn
Defines the number of days after the current date.
Limits: 1 to 2 numeric characters from 1 to 99
yyddd
Defines the Julian date to run the job.
-
--depjob | --dj (string)
-
--dotm (string)
-
dotm=hhmm
Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.
If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.
Limits: hh= 2 numeric characters from 0 to 24
mm= 2 numeric characters from 00 to 59
Required: No (unless DATE is used, if so, DOTM or TIME must be specified)
-
--exec | -e (string)
-
exec={NO|YES}
Specifies whether to execute the job (YES/NO).
If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.
Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.
-
--interval | -i (string)
-
interval=hhmm
Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.
If INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
Limits: hh=2 numeric characters from 0 to 23
mm=2 numeric characters from 00 to 59
-
--jclid | --ji (string)
-
jclid=10
Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.
-
--jcllib | --jl (string)
-
jcllib=&SPECIAL
Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
-
--late (string)
-
--leadtm | --lt (string)
-
--mainid | --mi (string)
-
mainid={ALL|SYn|/SYn|-SYn}
Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:
ALL
Specifies all CPUs are acceptable for executing the job.
SYn
n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.
/SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
-SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
Limits: Invalid for internal cross-platform jobs.
-
--prty (string)
-
--rms (string)
-
rms={NO|YES}
Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.
The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
Limits: Invalid for internal cross-platform jobs.
-
--ro (string)
-
ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}
Specifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.
EQ
Equal to
LT
Less than
GT
Greater than
GE
Greater than or equal to
LE
Less than or equal to
NE
Not equal to
#S
Step condition code tests to be made based on a #SCC statement.
IG
No evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.
Limits: Invalid with agent jobs.
-
--schid | --si (string)
-
schid={1|nnn}
Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.
Default: 1
Limits: 1 to 3 numeric characters from 1 to 999 (See Note)
No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)
-
--set (string)
-
set={NDB|NTR|SKP}
Specifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.
SKP
Specifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.
NTR
Specifies normal triggering is disabled only for this run of the job.
NDB
Allows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.
-
--stop (string)
-
stop=hhmm
Defines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.
Default: 1439 minutes (24 hours minus 1 minute) after the submit time
Limits: hh=1 through 2 numeric characters from 0 to 23
mm=2 numeric characters from 00 to 59
-
--time (string)
-
--type (string)
-
type={CLOCK|END|RES|START}
Indicates that the job is being scheduled for rerun.
The value must be specified as shown.
TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 commands demandh [options]
Required Options
Options
-
--jobl (string)
-
--arfset | --as (string)
-
arfset={arfsetname|**NONE**}
Defines the ARF set name that is used for this run of the job.
If you specify **NONE**, no ARF processing is performed for this run of the job.
Limits: 1 to 8 alphanumeric characters or **NONE**
-
--cc (string)
-
cc=1234
Defines, with RO (relational operator), the job-level condition codes that are used to determine whether a job executes successfully.
If specified, this value overrides the RO defined for the job in the CA WA CA 7 Edition database. RO is required when CC is specified.
Default: The job definition panel COND-CODE value when the job is defined to CA WA CA 7 Edition; otherwise 0.
Limits: 1 to 4 numeric characters from 0 to 4095. Invalid with agent jobs.
-
--class (string)
-
--count (string)
-
count=nnnn
Defines the maximum number of times to repeat the job. COUNT is ignored if INTERVAL is not specified.
Default: None. The job continues repeating until the STOP time is reached.
Limits: 1 to 4 numeric characters from 0 to 1439. The leading zeros can be discarded.
-
--date (string)
-
date={+nn|yyddd}
Defines due-out and submit dates.
Limits: If used, specify DOTM or TIME.
+nn
Defines the number of days after the current date.
Limits: 1 to 2 numeric characters from 1 to 99
yyddd
Defines the Julian date to run the job.
-
--depjob | --dj (string)
-
--dotm (string)
-
dotm=hhmm
Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.
If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.
Limits: hh= 2 numeric characters from 0 to 24
mm= 2 numeric characters from 00 to 59
Required: No (unless DATE is used, if so, DOTM or TIME must be specified)
-
--exec | -e (string)
-
exec={NO|YES}
Specifies whether to execute the job (YES/NO).
If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.
Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.
-
--interval | -i (string)
-
interval=hhmm
Identifies that the job is repeated (executed more than once) and defines the amount of time between each iteration.
If INTERVAL is specified, the TIME and TYPE keywords are required. If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
Limits: hh=2 numeric characters from 0 to 23
mm=2 numeric characters from 00 to 59
-
--jclid | --ji (string)
-
jclid=10
Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.
-
--jcllib | --jl (string)
-
jcllib=&SPECIAL
Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
-
--late (string)
-
--leadtm | --lt (string)
-
--mainid | --mi (string)
-
mainid={ALL|SYn|/SYn|-SYn}
Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:
ALL
Specifies all CPUs are acceptable for executing the job.
SYn
n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.
/SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
-SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
Limits: Invalid for internal cross-platform jobs.
-
--prty (string)
-
--rms (string)
-
rms={NO|YES}
Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.
The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
Limits: Invalid for internal cross-platform jobs.
-
--ro (string)
-
ro={EQ|LT|GT|GE|LE|NE|#S|IG|0}
Specifies the relational operator of the condition code (CC) or if the step level #SCC statements are being used in the JCL of the job.
EQ
Equal to
LT
Less than
GT
Greater than
GE
Greater than or equal to
LE
Less than or equal to
NE
Not equal to
#S
Step condition code tests to be made based on a #SCC statement.
IG
No evaluation of the job is done. CA WA CA 7 Edition always assumes that the job completes successfully, regardless of condition codes, abend codes, or run-time JCL errors.
Limits: Invalid with agent jobs.
-
--schid | --si (string)
-
schid={1|nnn}
Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.
Default: 1
Limits: 1 to 3 numeric characters from 1 to 999 (See Note)
No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)
-
--set (string)
-
set={NDB|NTR|SKP}
Specifies skip the next scheduled cycle for the job (SKP), disable triggering (NTR), or bypass the database updating at the job completion.
SKP
Specifies this run of the job takes the place of the next scheduled run. This value has the same effect as entering NXTCYC,SET=SKP. It is reflected on output from LJOB and LLOCK commands as if NXTCYC,SET=SKP was used. This parameter is invalid if the job has no schedule. SET=SKP has no impact on repeating jobs that are already in the queues.
NTR
Specifies normal triggering is disabled only for this run of the job.
NDB
Allows a job to bypass all load processing at the job completion, but allows other processing to proceed typically.
-
--stop (string)
-
stop=hhmm
Defines the clock time after which the job is not repeated. STOP is ignored if INTERVAL is not specified.
Default: 1439 minutes (24 hours minus 1 minute) after the submit time
Limits: hh=1 through 2 numeric characters from 0 to 23
mm=2 numeric characters from 00 to 59
-
--time (string)
-
--type (string)
-
type={CLOCK|END|RES|START}
Indicates that the job is being scheduled for rerun.
The value must be specified as shown.
TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
This function is available on the QM.1 panel with a FILL value of H.
Depending on the timing and whether you have any other
predecessor situations, the QM.3 panel can sometimes accomplish this process.
For more information on HOLD command, see the techdocs folder in this project.
Usage
zowe ca7 commands hold [options]
Options
-
-q (string)
- example: RDY
Specifies to hold the contents of an entire queue.
Possible values:
REQ
Specifies to hold all jobs currently in the request queue.
RDY
Specifies to hold all jobs currently in the ready queue.
Required: Yes, unless job number is used.
-
--ca7num (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Holds the entire RDYQ:
zowe ca7 commands hold --q RDY
The JCLOVRD command establishes or satisfies JCL override requirements.
Usage
zowe ca7 commands jclovrd [options]
Required Options
-
--ca7num (string)
-
--set (string)
-
example: ON
Specifies to establish or satisfy JCL override requirements.
When a job fails with a JCL error, the JCL override requirement is automatically
set to ON when the job returns to the request queue.
ON
Establishes a JCL override requirement for the specified job.
The SET=ON option is used for jobs in the request queue to indicate that
an override is needed before execution is to occur.
OFF
Satisfies a JCL override requirement for the specified job. The SET=OFF option indicates that a previously defined
need (requirement) for overrides has been satisfied and execution can be safely attempted.
When a JCL override requirement is set to OFF,
that requirement no longer appears on a requirements list for the job
When a REPL is done from the QM.5 panel, the JCL override requirement is automatically set to OFF.
WLM
Sets job to allow the insertion of SCHENV= keyword on the JOB
statement at submission time when these conditions are true:
The scheduling environment insertion feature is activated.
A scheduling Environment VRM definition is attached to the job (or SCHENV global default).
NOWLM
Sets job to suppress the insertion of a SCHENV= keyword on the JOB statement at submission
time even when one is typically associated with the job.
This option can be used when the validation of an associated IBM WLM scheduling environment
has failed causing the job to be requeued (see Browse message SSM0-42).
FSetting the NOWLM option lets you submit the job without SCHENV= keyword insertion.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
The POST command indicates to the CA Workload Automation CA 7 Editionsystem that a preexecution requirement for a job in the request queue is satisfied
Usage
zowe ca7 commands post [options]
Required Options
Options
-
--usr (string)
-
example: USER WILL CALL TO RELEASE
(Optional) Identifies a user-defined description of a requirement to post as satisfied.
Mutually exclusive with DEPJOB and DSN.
When used, must match the text that is used to define the requirement on the DB.6 panel or with the ADDRQ command.
Limits: 1 to 36 alphanumeric characters
-
--depjob (string)
-
example: PAYJOB
(Optional) Identifies a predecessor job dependency requirement to post as satisfied.
Value must be a specific job name.
Mutually exclusive with DSN and USR.
In normal situations, CA WA CA 7 Edition automatically posts this type of requirement when the predecessor job completes its execution successfully.
A manual posting is only necessary if a job defined as a requirement was not to be run,
or ran unsuccessfully and a successor job is to be run.The DEPJOB must be posted if it is not currently defined to CA WA CA 7 Edition
(an external job).
Limits: 1 to 8 alphanumeric characters
-
--dsn (string)
-
example: CA7.DSN1
(Optional) Identifies a data set requirement to post as satisfied.
Value can be a specific data set name or a CA WA CA 7 Edition data set number.
If you are using a number, only the number can be specified without the DS prefix.
Mutually exclusive with DEPJOB and USR.
dsname
Indicates a specific data set name.
Limits: 1 to 44 alphanumeric characters
dsnumber
Indicates a specific data set number.
Limits: 1 to 8 numeric characters
-
--internal (string)
- example: YES
(Optional) Valid only with DSN to indicate that the data set being posted is internal to the CA WA CA 7 Edition workload.
YES is the only acceptable value.
Mutually exclusive with USR, DEPJOB, and PREQ.
In normal situations, CA WA CA 7 Edition automatically posts requirements for internal data sets.
Limits: YES is the only acceptable value.
-
--preq (string)
- example: (17,19,20,32)
(Optional) Valid only with DSN to identify up to 11 numeric values to include
with other CA WA CA 7 Edition log data logged as a result of the POST command being issued.
Mutually exclusive with USR, DEPJOB, and INTERNAL.
Code values in sublist form, within parentheses.
You can code up to 11 values that are separated by commas between the parentheses.
Each value cannot exceed 4 numeric digits.
This optional field can be useful for logging any meaningful numbers, such as batch numbers, which can later be reviewed in the log data set.
-
--rmtjob (string)
-
example: RMT_JOB
Names the job in the remote scheduler that is required by the job specified in the JOB field.
Limits: RMTJOB should accept up to 64 characters
valid characters are a-z, A-Z, 0-9, period (.), underscore (_), hyphen (-),
colon (:), and pound (#); do not include embedded spaces or tabs.
-
--rmtschd (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
The PRSCF command frees a shared, exclusive, or RCT resource that is connected to a job
Usage
zowe ca7 commands prscf [options]
Options
-
--job (string)
-
--rsrc (string)
-
example: RESOURCE.TYPE2.EXEC
Specifies the fully qualified resource name to free.
You can optionally specify * to indicate to free all resources that are connected to the job.
Limits: 1 to 44 alphanumeric characters
-
--force (string)
-
example: YES
(Optional) FORCE=YES indicates that CA WA CA 7 Edition is not to evaluate
the availability of the named resources for this run of the job only.
This run of the job does not use the named resources.
This keyword can be used on an exception basis to let a job in a
W-RSRC status bypass VRM checking for one or more resources defined for it on the RM.1 panel.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
The PRSQA command activates a corequisite resource
Usage
zowe ca7 commands prsqa [options]
Options
-
--rsrc (string)
-
--internal (string)
-
example: YES
(Optional) If YES or Y is specified, the command is not forwarded to other CA 7 instances
even if VRM Corequisite Propagation is enabled and the resource name matches the selection criteria.
Default: NO
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Usage
zowe ca7 commands release [options]
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.
-
--ca7num (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Re-queues jobs from the ready or active queues back to the request queue.
Usage
zowe ca7 commands requeue [options]
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Work that is scheduled by a trigger or on-request work that is DEMANDed or RUN has no direct relationship to a base calendar and therefore does not require the use of this function.
Usage
zowe ca7 commands resolv [options]
Required Options
-
--job (string)
-
example: AJOB*
Limits selection for resolution to the jobs specified. If omitted, all job schedules are candidates for resolution. Value can be a specific job name or a generic name that identifies multiple jobs beginning with the specified characters.
An asterisk (*) must be used to delimit the generic job name. The asterisk can appear in any of the eight positions but must immediately follow the last significant character of the job name requested.
For example:
AB* causes all jobs beginning with AB to be selected for resolution.
* causes all job schedules to be selected for resolution.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Usage
zowe ca7 commands restart [options]
Required Options
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=JS050
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
-
--lpstp (string)
-
lpstp=COPY010
Indicates an optional step name referencing a procedure that has its last condition code value reset
in the CA Workload Automation Restart Option for z/OS Schedulers CMT.
If LPSTP is used, also code LSTP and LCC.
This option is honored only if 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 | --pe (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 (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 | --se (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 | --ss (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 | --su (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
-
--ca11rstp | -c (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
The RMTSUB command is used by a scheduling product that has a remote job dependency on a CA 7 job.
Usage
zowe ca7 commands rmtsub [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
The RMTTRK defines a dependency on a job in a remote CA 7 workload.
Usage
zowe ca7 commands rmttrk [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Usage
zowe ca7 commands run [options]
Options
-
--job (string)
-
--jobl (string)
-
--arfset | --as (string)
-
arfset={arfsetname|**NONE**}
Defines the ARF set name that is used for this run of the job.
If you specify **NONE**, no ARF processing is performed for this run of the job.
Limits: 1 to 8 alphanumeric characters or **NONE**
-
--class (string)
-
--dotm (string)
-
dotm=hhmm
Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.
If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.
Limits: hh= 2 numeric characters from 0 to 24
mm= 2 numeric characters from 00 to 59
Required: No (unless DATE is used, if so, DOTM or TIME must be specified)
-
--exec | -e (string)
-
exec={NO|YES}
Specifies whether to execute the job (YES/NO).
If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.
Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.
-
--jclid | --ji (string)
-
jclid=10
Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.
-
--jcllib | --jl (string)
-
jcllib=&SPECIAL
Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
-
--late (string)
-
--leadtm | --lt (string)
-
--mainid | --mi (string)
-
mainid={ALL|SYn|/SYn|-SYn}
Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:
ALL
Specifies all CPUs are acceptable for executing the job.
SYn
n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.
/SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
-SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
Limits: Invalid for internal cross-platform jobs.
-
--rms (string)
-
rms={NO|YES}
Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.
The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
Limits: Invalid for internal cross-platform jobs.
-
--schid | --si (string)
-
schid={1|nnn}
Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.
Default: 1
Limits: 1 to 3 numeric characters from 1 to 999 (See Note)
No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)
-
--time (string)
-
--type (string)
-
type={CLOCK|END|RES|START}
Indicates that the job is being scheduled for rerun.
The value must be specified as shown.
TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Usage
zowe ca7 commands runh [options]
Options
-
--job (string)
-
--jobl (string)
-
--arfset | --as (string)
-
arfset={arfsetname|**NONE**}
Defines the ARF set name that is used for this run of the job.
If you specify **NONE**, no ARF processing is performed for this run of the job.
Limits: 1 to 8 alphanumeric characters or **NONE**
-
--class (string)
-
--dotm (string)
-
dotm=hhmm
Defines the due-out time-of-day for the job in hours (hh) and minutes (mm).
If DOTM is specified on the DEMAND/DEMANDH command and the value that is given is earlier than the current time, the due-out day is assumed to be the following day.
If DOTM and LEADTM are both omitted, then deadline start time is assumed to be the current time plus the LEADTM.
Limits: hh= 2 numeric characters from 0 to 24
mm= 2 numeric characters from 00 to 59
Required: No (unless DATE is used, if so, DOTM or TIME must be specified)
-
--exec | -e (string)
-
exec={NO|YES}
Specifies whether to execute the job (YES/NO).
If NO (N) is used, the job does not run but shows a normal completion as if it did run. The value that is specified here overrides the value that is coded on the job definition EXEC field.
Default: The job definition panel EXEC value if the job is defined to CA WA CA 7 Edition; otherwise YES.
-
--jclid | --ji (string)
-
jclid=10
Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a numeric INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 1 to 3 numeric characters from 0 through 254 and from 256 through 999. 255 is reserved.
-
--jcllib | --jl (string)
-
jcllib=&SPECIAL
Defines the JCL data set that contains the execution JCL to be submitted.
If used, the value must be a symbolic INDEX associated with the wanted JCL data set (on the JCL statement in the initialization file).
If the job is defined in the database, the value must be the same as the value on the DB.1 panel or the Optional PARMLIB/Parmlib value on the DB.10 and DB.11 panels.This field or the JCLLIB field is required if the job is not defined in the database. JCLID and JCLLIB are mutually exclusive.Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
-
--late (string)
-
--leadtm | --lt (string)
-
--mainid | --mi (string)
-
mainid={ALL|SYn|/SYn|-SYn}
Specifies the MAINID, as defined in the initialization file CPU statement, to which you want to redirect the job.
The value that is specified here overrides the value that is coded on the job definition MAINID field. The name must be one of the following values:
ALL
Specifies all CPUs are acceptable for executing the job.
SYn
n defines the CPU to which the job is being redirected. The value of n can range from 1 to 7.
/SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
-SYn
n defines a CPU to which the job cannot be submitted. The value of n can range from 1 to 7.
Limits: Invalid for internal cross-platform jobs.
-
--rms (string)
-
rms={NO|YES}
Specifies whether CA WA CA 7 Edition inserts the CA Workload Automation Restart Option for z/OS Schedulers RMS step.
Specify YES (Y) to insert the step with the CA Workload Automation Restart Option for z/OS Schedulers processing code of P. Enter NO (N) to indicate that the RMS step is not inserted.
The value that is specified here overrides the value that is coded on the job definition INSERT-RMS field.
Default: The job definition panel INSERT-RMS value if job defined to CA WA CA 7 Edition; otherwise NO.
Limits: Invalid for internal cross-platform jobs.
-
--schid | --si (string)
-
schid={1|nnn}
Indicates the schedule ID to be used for evaluating JCL overrides that are scheduled with the #Jx or #Xx commands.
Default: 1
Limits: 1 to 3 numeric characters from 1 to 999 (See Note)
No (unless the SCHEDULE statement in the initialization file specifies SCHID=YES, then this parameter is required)
-
--time (string)
-
--type (string)
-
type={CLOCK|END|RES|START}
Indicates that the job is being scheduled for rerun.
The value must be specified as shown.
TYPE=RES is optional.If used, a restart requirement is placed on the job, and the job has to be manually restarted.Limits: RES, CLOCK, START, or END
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
The SUBMIT top line command modifies and expedites the process of job submission for jobs already residing in the queues
Usage
zowe ca7 commands submit [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
SUBTM modifies the required submit time-of-day for a job in the request queue
Usage
zowe ca7 commands subtm [options]
Required Options
-
--ca7num (string)
-
ca7num=0016
Specifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.
Limits: 1 to 4 alphanumeric characters
Options
-
--time | --tm (string)
-
example: 1830
(Optional) Specifies the new submit time-of-day in hours and minutes.
TIME is required to add a submit time-of-day requirement when none exists or to change an existing requirement.
If TIME is omitted, an existing submit time-of-day restriction is removed. Format:hhmm
Defines the time-of-day where hh is hours (0 through 24) and
mm is minutes (00 through 59). Maximum is 2400.
If the value given is less than the current time (when the command is processed), the submit day is incremented by one.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
The VERIFY command establishes or satisfies a manual verification requirement for a currently scheduled run of the job in the request queue before its execution.
Usage
zowe ca7 commands verify [options]
Required Options
-
--ca7num (string)
-
ca7num=0016
Specifies the CA 7 job number of the job or which you want to add, modify, or remove a submit time-of-day requirement.
Limits: 1 to 4 alphanumeric characters
-
--set (string)
-
example: ON
Sets the verification requirement.
ON
Establishes a manual verification requirement that did not previously exist.
OFF
Indicates that a previously established manual verification requirement is satisfied and can be
removed. A verification requirement no longer appears on the requirements list in the request 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Creates predecessor requirement for a job.
Usage
zowe ca7 create-job-definition req-predecessor [options]
Required Options
-
--job (string)
- The name of the job that requires the predecessor
-
--schid (string)
- The schedule id of requiring job
-
--predtype (string)
-
--nextrun (string)
- The status of predecessor for next run of job
[ YES, ONLY, SKIP ]
-
--predobject (string)
- The predecessor. Values vary with predtype.
The predecessor. Values vary with predtype.
When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
Options
-
--leadtime (string)
- The satisfaction lead time in hours.
This may be honored when “predtype” is “job or “DSN”
-
--permanent (string)
- Indicates that this predecessor is permanent, that is always considered satisfied.
This parameter only applies when “predtype” is “DSN”
[ Y, N ]
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create schedule parameters
Usage
zowe ca7 create-job-definition schedule [options]
Required Options
-
--job (string)
-
--schid (string)
- Specifies the numeric schedule ID on which the user wants to perform the specified action.
Limits: 1 to 3 numeric characters from 1 through 999
Options
-
--scal (string)
- Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.
Limits: 2 alphanumeric characters
-
--default-scal | --dscal (string)
- Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL
Limits: 2 alphanumeric characters
-
--due-out-time | --dot (string)
- Specifies the due-out time of day for this schedule ID.
Limits: 4 numeric characters that are specified as hhmm
where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
-
--lead-time | --lt (string)
- Specifies the due-out time of day for this schedule ID.
Limits: 4 numeric characters that are specified as hhmm
where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
-
--submit-time | --st (string)
- Specifies the submit time of day for this schedule ID.
If specified, the job is not submitted before this time.
If the submit time is before deadline start time,
the submit time requirement is automatically satisfied when the job enters the queue.
A submit time of zeros is the same as not specifying it, and no submit time is set up.
Note:If the submit time is after the due-out time, the submit day value is set to the previous day.
Limits: 4 numeric characters that are specified as hhmm
where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
-
--daily (string)
- Specifies that the user wants to define a daily schedule.
Daily means every available processing day as defined by the Base Calendar.
If DAILY is used, the ROLL has no effect.
Limits: One of Y or N
-
--roll (string)
- Specifies the action to take when a schedule day falls on a base calendar non available processing day.
This value is not used if the DAILY option is used
If DAILY is used, the ROLL has no effect.
If used, the value must be one of the following values:
B: Roll the schedule back to the previous available processing day in the Base Calendar.
F: Roll forward the schedule to the next available processing day.
N: Do not roll. Schedule day must stand.
D: Do not roll and do not schedule.
Default:D
-
--index (string)
- Specifies an adjustment to schedule days.
After you exercise the ROLL option, the schedule is adjusted,
forward for plus or backward for minus, by the number of working days entered.
Limits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:
Use this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:
specify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.
-
--interval (string)
- Specifies that the job should be repeated (executed more than once) and
specifies the amount of time between each iteration.
If INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.
If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
Limits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59
-
--type (string)
- Determines how the submit time requirement is calculated for repeating jobs.
A TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's
submit time requirement to determine the new submit time requirement.
A TYPE of START and END indicates that the INTERVAL is added to the previous iteration's
last (most recent) start and end times,respectively, to determine the new submit time requirement.
TYPE is required if INTERVAL is specified.
TYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END
-
--count (string)
- Specifies the maximum number of times to repeat the job.
COUNT is discarded if INTERVAL is not specified.
If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.
If COUNT is not specified, the job repeats until the STOP time is reached.TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.
-
--weekly (string)
- Specifies that the user wants to define a weekly schedule.
If WEEKLY is used, the run days of the week must be specified using DAYS field
Limits:Y or N
-
--days (string)
- Defines specific days of the week on which to run the job.
as comma separated list of day name abbreviations.
Limits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat
-
--monthly (string)
- Specifies that the user wants to define a monthly schedule.
If this field is used, the user can optionally specify on which particular months the job is to run.
If specific months are not specified in the months property, all months are assumed.Limits: Y or N
-
--months (string)
- Defines specific months on which to run the job.
as comma separated list of month name abbreviations.
Limits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
-
--weeks-of-month | --wom (string)
- Specifies the weeks of the month to run the job.
The values that are specified can be positive (unsigned), negative (-) or slash (/).
Positive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.
Negative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.
Slashes indicate the job will not run the following value.
Limits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.
The values are separated by comma
-
--day-of-week | --dow (string)
- Specifies which days of the week to run the job.
If used, each day must be the first three letters of the wanted run days.
If you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.
Limits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive
-
--relative-day | --rd (string)
- Specifies relative days of the month on which the job is to run. Used with MONTHLY.
A day relative to the beginning or end of the month is specified.
If a positive (unsigned) value is used, the job runs that day relative to the first of the month.
Also, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.
Valid positive values range from 1 to 31.
Valid negative values range from -0 to -30.
Limits:1 to 60 numeric characters, separated by comma.
Note:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,
in which case relative-day(s) represents processing days.
-
--annual (string)
- Defines an annual schedule.
Limits: If annual is used, day is required. One of Y, N
-
--day-of-year | --doy (string)
- Specifies on which days of the annual schedule the user wants to run the job.
Days are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.
Slash indicates the job will not run this day.
For example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242
Limits: 1 to 55 numeric characters and required if annual is used.
The numbers will be separated by comma
-
--symmetric (string)
- Used with the START and SPAN fields, defines a symmetric schedule.
With this option, schedules are defined as beginning on the date specified with
the START field and recurring every nnn days as specified with the SPAN field.
Limits: One of Y, N
-
--start (string)
- This field is required when the SYMETRIC option is taken.
Value must be specified as the Julian day of the year on which the symmetric schedule is to begin.
This value should be evaluated yearly before schedule resolution and may need to be changed each year.
If the schedule will be resolved on a July-June basis, the start date must be within
the first of the two years in which the schedule overlaps.
For January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.
If the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,
the START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.
If the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)
the start date must specify the first day on which the job would actually run.
This requires manually setting (verifying) the START value each year before the RESOLV.
If a nonprocessing day is specified, the start day is the next processing day found in the calendar.
For example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,
and 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).
SPAN is based from January 2 in this example rather than January 1.
For other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.
Limits: 3 numeric characters specified as Julian day of the year from 1 to 365
-
--span (string)
- Used with SYMETRIC and START, defines symmetric schedules.
This field is required if the SYMETRIC option is taken.
When used, specifies the number of days between scheduled processing cycles.
If the calendar against which the SCHID will be resolved was generated with processing days
only (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days
between and including the next processing date as opposed to the actual number of days.
With this type of calendar, the ROLL and INDEX options serve no practical purpose.
For other calendar types, the SPAN value is specified as the number of calendar days
between processing cycles and the ROLL and INDEX options can be used as necessary.
Limits: 1 to 3 numeric characters from 1 to 255
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Create Resource Count Resource parameters
Usage
zowe ca7 create-resource-definition resource-count-resource [options]
Required Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands listed in the Dataset section.
Create Dataset
Usage
zowe ca7 dataset create-dataset [options]
Required Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create Dataset Trigger
Usage
zowe ca7 dataset create-dataset-trigger [options]
Options
-
--dataset-name | --dname (string)
- (Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
Note: For VSAM files, specify the cluster name.
Limits: 1 to 44 alphanumeric characters
-
--dataset-number | --dnum (string)
- (Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
Limits: 1 to 8 numeric characters
-
--schid (string)
- (Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
Default: 0 (all schedule IDs)
Limits: 1 to 3 numeric characters from 0 through 999
-
--triggered-job-schid | --tjs (string)
- (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
Default: 0 (no replacement)
Limits: 1 to 3 numeric characters from 0 through 999
Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
-
--triggered-job-due-out-time | --tjdot (string)
- (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
If this parameter is used, triggered-job-queue-time must be omitted.
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
-
--triggered-job-queue-time | --tjqt (string)
- (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
Deadline time is calculated as current date/time plus queue time.
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
The mm can be 00 through 59, the highest value being 2400.
-
--triggered-job-lead-time | --tjlt (string)
- (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
Default: 0000
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
The mm can be 00 through 59, the highest value being 2400.
-
--triggered-job-submit-time | --tjst (string)
-
(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
The triggered-job-submit-time is always rounded down to 15-minute increments.
Default: 0 (no specific submit time requirement)
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.
Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.
If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.
Required 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Dataset
Usage
zowe ca7 dataset delete-dataset [options]
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Dataset Trigger
Usage
zowe ca7 dataset delete-dataset-trigger [options]
Options
Required 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Rename a existing Dataset
Usage
zowe ca7 dataset rename-dataset [options]
Options
Required 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Modify Dataset
Usage
zowe ca7 dataset update-dataset [options]
Options
-
--dataset-name | --dname (string)
- (Required if dataset-number is omitted) Specifies the data set and must be the fully qualified data set name.
Limits: 1 to 44 alphanumeric characters
Note: dataset-name is not required to conform to MVS data set name standards. Embedded blanks and special characters such as slashes, dashes, and underscores are permitted. All alphabetic characters are uppercased.
-
--dataset-number | --dnum (string)
- (Required if dataset-name is omitted) Specifies the data set to use. The value must be the numeric value that CA 7 already assigned.
Limits: 1 to 8 numeric characters
-
--type (string)
- (Optional) Specifies the data set type.
Valid values are:
NORM = Internal means both the creating-job and using-jobs for this data set are known to CA 7.
External means the creating-job, using-jobs, or both for this data set are not known to CA 7.PERM = Specifies this data set is always available for inputDefault: NORM
Note: When a data set is marked PERM, no SMF records are captured. PERM means no data set triggering can occur with this type of data set
-
--gdg (string)
- (Optional) Specifies whether this data set is a generation data group.
Valid values are:
Y = The data set is a generation data groupN = The data set is not a generation data groupDefault: N
Note: The specific GDG creations cannot be used for posting requirements or for triggering jobs. Posting and triggering are done based on the creation/updating (SMF 15 record) of any generation of the GDG.
-
--smf-feedback-required | --sfr (string)
- (Optional) Specifies whether the interface to System Management Facility (SMF) inserts the values for DSORG, RECFM, LRECL, and BLKSIZE when this data set is next used. Unless the value is reset, this insertion is only done once.
Valid values are:
Y = SMF inserts the values when the data set is next usedN = SMF does not insert the values when the data set is next usedDefault: Y
Note: After the first time the job that creates this data set runs under CA 7, this field is reset to N. If the data set attributes change, this field must be reset to Y. The changed attribute field (that is, DSORG, RECFM) must be zeroed (if numeric) or blanked out. This process causes CA 7 to record the new values when the job is run again.
-
--post-at-close-time | --pact (string)
- (Optional) Specifies when to post the creation or update of a data set to the database and queues. This process does not ensure successful step or job termination.
Valid values are:
Y = The action takes place when the SMF data set creation record is received (when the data set is closed)N = Causes triggering or posting action to take place at the job terminationDefault: N
-
--device (string)
- (Optional) Specifies a device type.
Valid values are:
TAPEDASD
-
--dsorg (string)
- (Optional) Specifies the data set organization. This value is the same as the DSORG specified in the DCB subparameter in the JCL.
Limits: 1 to 3 alphanumeric characters
-
--recfm (string)
- (Optional) Specifies the record format of the data set. This value is the same as the RECFM specified in the DCB subparameter in the JCL.
Limits: 1 to 5 alphanumeric characters
-
--lrecl (string)
- (Optional) Specifies the logical record length of the data set. This value is the same as the LRECL specified in the DCB subparameter in the JCL.
Limits: 1 to 5 numeric characters
-
--blksize (string)
- (Optional) Specifies the block size of the data set. This value is the same as the BLKSIZE specified in the DCB subparameter in the JCL.
Limits: 1 to 5 numeric characters
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Modify Dataset Trigger
Usage
zowe ca7 dataset update-dataset-trigger [options]
Options
-
--dataset-name | --dname (string)
- (Required if dataset-number is omitted) Specifies the data set name whose creation/update causes triggering of a job.
Note: For VSAM files, specify the cluster name.
Limits: 1 to 44 alphanumeric characters
-
--dataset-number | --dnum (string)
- (Required if dataset-name is omitted) Specifies the existing data set number whose creation causes triggering. The number is the value that CA 7 assigned to the data set.
Limits: 1 to 8 numeric characters
-
--schid (string)
- (Optional) Specifies for which schedule ID of the triggering dataset the triggered-job is scheduled.
Note: If the data set is one that is tracked with use of SASSXDSN (externally tracked data sets), the schid field must be 000 for the trigger to work
Default: 0 (all schedule IDs)
Limits: 1 to 3 numeric characters from 0 through 999
-
--triggered-job-schid | --tjs (string)
- (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
Default: 0 (no replacement)
Limits: 1 to 3 numeric characters from 0 through 999
Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
-
--triggered-job-due-out-time | --tjdot (string)
- (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
If this parameter is used, triggered-job-queue-time must be omitted.
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
-
--triggered-job-queue-time | --tjqt (string)
- (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
Deadline time is calculated as current date/time plus queue time.
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
The mm can be 00 through 59, the highest value being 2400.
-
--triggered-job-lead-time | --tjlt (string)
- (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
Default: 0000
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
The mm can be 00 through 59, the highest value being 2400.
-
--triggered-job-submit-time | --tjst (string)
-
(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
The triggered-job-submit-time is always rounded down to 15-minute increments.
Default: 0 (no specific submit time requirement)
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.
Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.
If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.
Required 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Delete predecessor requirement for a job.
Usage
zowe ca7 delete-job-definition req-predecessor [options]
Required Options
-
--job (string)
- The name of the job that requires the predecessor
-
--schid (string)
- The schedule id of requiring job
-
--predtype (string)
-
--nextrun (string)
- The status of predecessor for next run of job
[ YES, ONLY, SKIP ]
-
--predobject (string)
- The predecessor. Values vary with predtype.
The predecessor. Values vary with predtype.
When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
Options
-
--leadtime (string)
- The satisfaction lead time in hours.
This may be honored when “predtype” is “job or “DSN”
-
--permanent (string)
- Indicates that this predecessor is permanent, that is always considered satisfied.
This parameter only applies when “predtype” is “DSN”
[ Y, N ]
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete an existing date/time schedule
Usage
zowe ca7 delete-job-definition schedule [options]
Required Options
-
--job (string)
-
--schid (string)
- Specifies the numeric schedule ID on which the user wants to perform the specified action.
Limits:
1 to 3 numeric characters from 1 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Delete a Resource Count resource
Usage
zowe ca7 delete-resource-definition resource-count-resource [options]
Required Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Available request is listed below.
Usage
zowe ca7 event-manager-requests job-status [options]
Required 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands listed in the Job Definition section.
Add Address Space Resource
Usage
zowe ca7 job-definition create-address-space-resource [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Add Corequisite Resource
Usage
zowe ca7 job-definition create-corequisite-resource [options]
Required Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Add Exclusive Resource
Usage
zowe ca7 job-definition create-exclusive-resource [options]
Required Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create Job Definition
Usage
zowe ca7 job-definition create-job [options]
Required Options
Options
-
--long-name | --ln (string)
- (Optional) Defines the long job name.
Limits: 1 to 64 alphanumeric characters, case sensitive
-
--system (string)
- (Optional) Specifies the user-defined application system name of which this job is a part.
Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
-
--uid (string)
- (Optional) Specifies the CA 7 user security identification.
Default: 0 (no internal security protection)
Limits: 1 to 3 numeric characters from 0 through 999
-
--jobnet (string)
- (Optional) Specifies the name of a CPU job network of which this job is a part.
Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
-
--owner (string)
- (Optional) Specifies the ID identifying ownership of this job. Depending on the startup options taken, the external security product being used and contents of the JCL, this value can be offered to the external security package by CA 7 at job submission time as the authority for this job to be executed.
Limits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists
-
--jcl-member | --jm (string)
- (Optional) Specifies the JCL library member name and required when the member name and job name are different.
Valid when: job-type is CPU
Default: Job name
Limits: 1 to 8 alphanumeric characters
-
--id (string)
- (Optional) Specifies a numeric index value that is associated with a JCL library where the JCL member is located. NOTE: the id and lib properties are mutually exclusive.
Valid when: job-type is CPU
Default: 0
Limits: 1 to 3 numeric characters in the range 0-253 or 256-999
-
--lib (string)
- (Optional) Specifies a JCL library identification consisting of a symbolic INDEX assigned to a JCL statement. NOTE: the id and lib properties are mutually exclusive.
Valid when: job-type is CPU
Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
-
--reload (string)
- (Optional) Specifies whether to reload the JCL of this job. When a job comes into the request queue, it is either flagged for load processing or it is not flagged.
Valid when: job-type is CPU
Default: N
Valid values are:
Y = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfullyN = The job is not flagged for load processing unless it is the first time it has run in CA 7X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used
-
--execute (string)
- (Optional) Indicates whether to execute this job.
Default: Y
Valid values are:
Y = The job will be executedN = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs
-
--retain (string)
- (Optional) Specifies whether to retain the execution JCL in the trailer queue after a successful run.
Valid when: job-type is CPU or XPJOB
Default: N
Valid values are:
Y = Retain the JCL in the trailer queue after a successful run.N = Do not retain the JCL in the trailer queue after a successful run
-
--hold (string)
- (Optional) Specifies whether to place this job in a hold status when it enters the request queue.
Default: N
Valid values are:
Y = The job will be heldN = The job will not be held
-
--jcl-override | --jo (string)
- (Optional) Specifies whether this job needs manual JCL overrides before it can be submitted. Similar to the JCLOVRD command.
Valid when: job-type is CPU
Default: N
Valid values are:
Y = The job needs manual JCL overrides before it can be submittedN = The job does not need manual JCL overrides before it can be submitted
-
--use-jcl-override-library | --ujol (string)
- (Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only. This field is automatically set back to N the next time the job comes into the request queue.
Default: N
Valid values are:
Y = The JCL is retrieved from the JCL Override library for the next runN = The JCL is not retrieved from the JCL Override library for the next run
-
--verify (string)
- (Optional) Specifies whether this job requires any pre-submission manual verification. Similar to VERIFY command.
Default: N
Valid values are:
Y = The job requires any pre-submission manual verificationN = The job does not require any pre-submission manual verification
-
--maintenance | --maint (string)
- (Optional) Specifies whether this job is a maintenance job (for example, a system utility) with no production data set requirements. If Y is specified, all input data set requirements are ignored. None of the output data sets created by this job is posted back to CA 7.
Marking a job as maintenance enables job triggering but not data set triggering.
Also, if the LOADDSNS keyword is used on the DBASE statement in the initialization file, the LOAD process does not build any DD or data set information for jobs that are marked as maintenance. This means that there are not any data set connections for these jobs unless added manually.
Valid when: job-type is CPU
Default: N
Valid values are:
Y = The job is a maintenance jobN = The job is not a maintenance job
-
--job-requirement-lead-time | --jrlt (string)
- (Optional) Specifies the number of hours to be considered when satisfying job-dependent requirements.
Default: 0
Valid values are:
0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queuenn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98
-
--dataset-requirement-lead-time | --drlt (string)
- (Optional) Specifies the number of hours to be considered when satisfying data set requirements.
Valid when: job-type is CPU
Default: 0
Valid values are:
0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queuenn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98
-
--arfset (string)
- (Optional) Names the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for non-executable jobs.
Limits: 1 to 8 alphanumeric characters
-
--mainid (string)
- (Optional) Specifies on which CPU the job can or cannot be scheduled. If the job requirements impose CPU restrictions, specify SYn or /SYn where n is the system number and / indicates not this system. System numbers must be consistent with the initialization file CPU statement MAINIDS parameters.
Valid when: job-type is CPU
Default: ALL (lets the job run on any CPU)
Limits: 1 to 4 alphanumeric characters
-
--insert-ca11-rms | --icr (string)
- (Optional) Specifies whether to insert the WA Restart Option RMS step automatically at execution time by CA 7.
Valid when: job-type is CPU
Default: N
Valid values are:
Y = Inserts the step with the WA Restart Option processing code of PN = Does not insert the RMS step
-
--condition-code | --cc (string)
- (Optional) Used with relational-operator property to define the job-level condition codes used to determine whether a job executes successfully.
Valid when: job-type is CPU or XPJOB
Note: All condition codes that are returned from an XPJOB job are treated as positive values. Any negative value returned is converted to an absolute (positive) value
Default: 0
Limits: For job-type = CPU: 1 to 4 numeric characters in the range 0-4095
For job-type = "XPJOB": 1 to 4 numeric characters in the range 0-9999
-
--relational-operator | --ro (string)
- (Optional) Specifies the relational operator of the condition-code property or if the step level #SCC statements are being used in the job's JCL.
Valid when: job-type is CPU or XPJOB
Default: 0
Valid values are:
EQ = Equal toLT = Less thanGT = Greater thanGE = Greater than or equal toLE = Less than or equal toNE = Not equal to#S = Make step condition code tests based on #SCC statements in the JCLIG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N0 = No condition test will be madeNOTE: If 0 is used, no test is made on the job's condition code. The highest condition code that this job generates is tested by this pair of parameters. For example, if condition-code is set at 8 and RO is set at LT, the job is marked as completing abnormally if 8 is less than the job's highest condition code
-
--do-not-schedule-before-date | --dnsbd (string)
- (Optional) Specifies not to schedule this job before this date (in YYDDD format, or 00000)
-
--do-not-schedule-before-time | --dnsbt (string)
- (Optional) Specifies not to schedule this job before this time (in HHMM format)
-
--do-not-schedule-after-date | --dnsad (string)
- (Optional) Specifies not to schedule this job after this date (in YYDDD format, or 99999)
-
--do-not-schedule-after-time | --dnsat (string)
- (Optional) Specifies not to schedule this job after this time (in HHMM format)
-
--lterm (string)
- (Optional) Routes the messages about this job to this logical terminal name.
Default: If not entered, the LTERM associated with the JCL library in the initialization file JCL statement is used. If LTERM is not specified on the JCL statement, the default is MASTER
Limits: 1 to 8 alphanumeric characters
-
--list-requirements | --lr (string)
- (Optional) Specifies whether to list pre-execution requirements for this job when it enters the request queue.
Default: Y
Valid values are:
Y = The pre-execution requirements will be listedN = The pre-execution requirements will not be listed
-
--prompts (string)
- (Optional) Specifies whether to issue prompt messages when this job is late.
Default: Y
Valid values are:
Y = Prompt messages will be issued when the job is lateN = Prompt messages will not be issued when the job is late
-
--requirements-not-used | --rnu (string)
- (Optional) Specifies whether to issue error messages for job requirements not used.
Default: Y
Valid values are:
Y = Messages will be issued if requirements are not usedN = Messages will not be issued if requirements are not used
-
--dsn-not-found | --dnf (string)
- (Optional) Specifies whether to list error messages for data sets used at execution time but not found in the CA 7 database.
Valid when: job-type is CPU
Default: Y
Valid values are:
Y = Messages will be issued if data sets used are not found in the CA 7 databaseN = Messages will not be issued if data sets used are not found in the CA 7 database
-
--job-region | --jr (string)
- (Optional) Specifies the region size that is required by this job (information only).
Valid when: job-type is CPU
Default: 0
Limits: 1 to 4 numeric characters
-
--elapsed-time | --et (string)
- (Optional) CA 7 maintains certain SMF feedback data in its database, including a weighted average elapsed runtime. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
Default: 0000
Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
-
--average-cpu-time | --act (string)
- (Optional) CA 7 maintains weighted average CPU time usage values for each job in its database. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
Valid when: job-type is CPU
Default: 0000
Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
-
--wlb-job-class | --wjc (string)
-
(Optional) Specifies the CA 7 WLB job class. If not specified, a WLB class of A is automatically assigned. This value does not have to match the JOB statement CLASS value.
NOTE: The value specified here does not apply when the job enters the queue as a result of a RUN(H) command. Class 9 is assigned by default. To override class 9, use the RUNCLASS keyword on the OPTIONS statement in the initialization file.
NOTE: The value specified here does not apply when the job enters the queue as a result of a LOAD(H) command. Class 8 is assigned by default. To override class 8, use the LOADCLASS keyword on the OPTIONS statement in the initialization file
Default: A space
Limits: 1 alphanumeric character
-
--wlb-priority | --wp (string)
- (Optional) Specifies the CA 7 WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed
Default: 0
Limits: 1 to 3 numeric characters in the range 0 - 255
-
--message-class | --mc (string)
- (Optional) Specifies the job's message class. This field is informational only. Even though this field can be changed, it does not cause the JCL to be changed. Also, no validity checking is done on this field.
Valid when: job-type is CPU
Default: A space
Limits: 1 alphanumeric character
-
--drclass | --dc (string)
- (Optional) Specifies the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.
Limits: 1 to 8 alphanumeric characters. Disaster recovery class values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks
-
--number-1-tape-man | --n1tm (string)
- (Optional) Specifies a manual override value for the number of TYPE1 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE1 tape drives.
Valid when: job-type is CPU
Default: 0
Limits: 1 to 3 numeric characters in the range 0 - 255
-
--number-2-tape-man | --n2tm (string)
- (Optional) Specifies a manual override value for the number of TYPE2 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE2 tape drives.
Valid when: job-type is CPU
Default: 0
Limits: 1 to 3 numeric characters in the range 0 - 255
-
--xp-node | --xn (string)
- (Required when job-type is XPJOB) Defines the CAICCI node to which the execution of this job is targeted. This field should state the primary node. If this node is unavailable and the node definition has alternate nodes defined, the execution of this job can be directed to an alternate node.
Valid when: job-type is XPJOB
Limits: 1 to 44 alphanumeric characters, although current z/OS CAICCI restricts this name to eight characters
-
--xp-exec | --xe (string)
- (Required when job-type is XPJOB) Defines the executable (file, command) to execute at the targeted cross-platform node. If the targeted platform is a mainframe scheduling system such as CA 7, this value indicates the job name to execute on that platform. If the targeted platform is Workload Automation AE system, this value indicates a job that is defined in the Workload Automation AE system. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. Otherwise, the field is passed to the target system as-is and in its entirety. This value includes any embedded blanks and quotation marks.
Valid when: job-type is XPJOB
Limits: Up to 244 alphanumeric characters, and file delimiters of forward slash (/) and backward slash (\) signs. Note: Each backward slash character must be escaped by specifying (\\)
-
--xp-parm | --xp (string)
- (Optional) Defines up to 128 bytes of parameter data to pass to the file or command being executed on the alternate platform. This data is supplied as PARM1 to the data being transmitted to the alternate platform. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. This value may be overridden if the PARMLIB/MEMBER field PARM1 is coded.
Valid when: job-type is XPJOB
Limits: Up to 128 EBCDIC characters
-
--parmlib | --pl (string)
- (Optional) Defines extra, optional indexed, or symbolic (PDS) library from where execution data to be associated with this job can be found. This information is typically PARM1 through PARM64 keywords but can vary based on CA 7 system configuration options. If the PARM1 field is found within this file, it overrides the data that is specified in the XP PARM field that is listed on the panel.
Valid when: job-type is XPJOB or AGENT
Limits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253 or 256 - 999), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and must denote the library variable as defined using a /JCL command.
Note: Specifying data in the PARMLIB/MEMBER fields is in addition to anything specified in the XPPARM field. If XPPARM is coded, and if the PARMLIB/Member contains a PARM1 statement, the PARMLIB specification overrides the XP PARM field. Thus, if both XPPARM and PARMLIB PARM1 fields contain data, the data that is obtained from the PARMLIB/MEMBER is used in the data that is transmitted to the target node
-
--member (string)
- (Optional) Indicates the PDS member name in the parmlib library where the parameters for this job reside.
Valid when: job-type is XPJOB or AGENT
Default: Same as the job property
Limits: 1 to 8 alphanumeric characters, beginning with an alphabetic character
-
--sutype (string)
- (Optional) Specifies the type of "switch user" command to execute at the UNIX target node.
Valid when: job-type is XPJOB
Default: Y
Valid values are:
Y = Executes an "SU -" causing the environment setup to include execution of the ".PROFILE" for the target userN = Executes an "SU" command without the profile option
-
--xp-trace | --xt (string)
- (Optional) Indicates whether to trace the activity that is associated with this job as it moves through the queues.
Valid when: job-type is XPJOB
Default: N
Valid values are:
Y = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log recordN = Do not activate tracing for this job
-
--agent-job-type | --ajt (string)
- (Required when job-type is AGENT) Defines the type of agent job. For more information about the Agent job types see:
[CA 7 Documentation](https://techdocs.broadcom.com/us/en/ca\-mainframe\-software/automation/ca\-workload\-automation\-ca\-7\-edition/12\-1/configuring/interfaces/cross\-platform\-scheduling/ca\-workload\-automation\-agents/ca\-7\-agent\-job\-types.html/)
Valid when: job-type is AGENT
Default: There is no default value
Valid values are:
UNIX_JOB - Generic UNIXNT_JOB - Microsoft WindowsFILE_TRIGGER - File TriggerFTP_JOB - FTPSCP_JOB - Secure CopySFTP_JOB - Secure File TransferBDC_JOB - SAP Batch Input SessionBWIP_JOB - SAP Business Warehouse InfoPackageBWPC_JOB - SAP Business Warehouse Process ChainSAP_JOB - SAP GenericSAPA_JOB - SAP ArchiveSAPE_JOB - SAP Event MonitorSAPM_JOB - SAP Process MonitorPS_JOB - PeopleSoftOA_JOB - Oracle RequestOAC_JOB - Oracle CopyCPU_MON - CPU MonitorDISK_MON - Disk MonitorIP_MON - IP MonitorPROCESS_MON - Process MonitorTEXT_MON - Text File MonitorEVENTLOG_MON - Event Log MonitorSERVICE_MON - Service MonitorSQL_JOB - Database SQLDBSP_JOB - Database Stored ProcedureDB_MON - Database MonitorDB_TRIG - Database TriggerAS400_JOB - AS400/OS400JMSP_JOB - J2EE JMS PublishJMSS_JOB - J2EE JMS SubscribeEJBE_JOB - J2EE Entity BeanHTTP_JOB - J2EE HTTP/ServletPOJO_JOB - J2EE POJORMI_JOB - J2EE RMIEJB_JOB - J2EE Session BeanJMXB_JOB - JMX-Mbean Attribute GetJMXA_JOB - JMX-Mbean Attribute SetJMXO_JOB - JMX-Mbean OperationJMXS_JOB - JMX-Mbean SubscribeJMXN_JOB - JMX-Mbean Create InstanceJMXR_JOB - JMX-Mbean Remove InstanceSNPG_JOB - SNMP Get AttributeSNPS_JOB - SNMP Set AttributeSNPC_JOB - SNMP SubscribeSNPE_JOB - SNMP TrapSendWEB_SERV - Web ServicesWOL_JOB - Wake-On-LANPROXY_JOB - Remote ExecutionNONSTOP_JOB - HP Integrity NonStop
-
--agent (string)
- (Required when job-type is AGENT) Identifies the explicit distributed platform where the job is to run.
Valid when: job-type is AGENT
Limits: 1 to 16 alphanumeric characters. The value must be defined to CA 7 using the IASAGENT DD statement
-
--agent-user | --au (string)
- (Optional) Defines the user ID that is passed to the distributed platform where the job is to run.
Valid when: job-type is AGENT
Limits: 1 to 128 alphanumeric characters
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Add Job Trigger
Usage
zowe ca7 job-definition create-job-trigger-successor [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
Default: 0 (all schedule IDs)
Limits: 1 to 3 numeric characters from 0 through 999
-
--triggered-job-schid | --tjs (string)
- (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
Default: 0 (no replacement)
Limits: 1 to 3 numeric characters from 0 through 999
Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
-
--triggered-job-due-out-time | --tjdot (string)
- (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
If this parameter is used, triggered-job-queue-time must be omitted.
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
-
--triggered-job-queue-time | --tjqt (string)
- (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
Deadline time is calculated as current date/time plus queue time.
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
The mm can be 00 through 59, the highest value being 2400.
-
--triggered-job-lead-time | --tjlt (string)
- (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
Default: 0000
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
The mm can be 00 through 59, the highest value being 2400.
-
--triggered-job-submit-time | --tjst (string)
-
(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
The triggered-job-submit-time is always rounded down to 15-minute increments.
Default: 0 (no specific submit time requirement)
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.
If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Add Resource Count Resource
Usage
zowe ca7 job-definition create-resource-count-resource [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Post Shared Resource
Usage
zowe ca7 job-definition create-shared-resource [options]
Required Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Add Variable Resource
Usage
zowe ca7 job-definition create-variable-resource [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Address Space Resource
Usage
zowe ca7 job-definition delete-address-space-resource [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Corequisite Resource
Usage
zowe ca7 job-definition delete-corequisite-resource [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied.
A zero default cannot be specified for one connection and a nonzero schedule ID used for
a subsequent connection to the same job with the same user requirement description.
An attempt to make such a connection results in an error message that is issued.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Exclusive Resource
Usage
zowe ca7 job-definition delete-exclusive-resource [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Job Definition
Usage
zowe ca7 job-definition delete-job [options]
Required Options
-
--job (string)
-
--type (string)
- The type of deletion.
Valid values are:
DELETE
Deletes a job and its associated data from the database (documentation, schedules, and so forth).DD
Same as DELETE, but deletes any data sets that this job references if the data sets have no users and
no documentation, and do not cause job triggering.
This includes all virtual resources that are connected to the job.PURGE
Same as DD, but also deletes job trigger definitions that trigger the job being deleted,
job requirement definitions that require the job being deleted;
and, if the WA Restart Option interface is active, deletes the WA Restart Option
CMT member for the job being deleted.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Delete Job named JOBA:
zowe ca7 job-definition delete-job --job JOBA --type DELETE
Delete Job Trigger
Usage
zowe ca7 job-definition delete-job-trigger-successor [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
Default: 0 (all schedule IDs)
Limits: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Resource Count Resource
Usage
zowe ca7 job-definition delete-resource-count-resource [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Shared Resource
Usage
zowe ca7 job-definition delete-shared-resource [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete Variable Resource
Usage
zowe ca7 job-definition delete-variable-resource [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies the schedule ID (of this job) for which a user requirement is applied. A zero default cannot be specified for one connection and a nonzero schedule ID used for a subsequent connection to the same job with the same user requirement description. An attempt to make such a connection results in an error message.
Default: 0, which indicates that the requirement holds for all schedule IDs
Limits: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
List Job Definiton
Usage
zowe ca7 job-definition list-job [options]
Required Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get Job Trigger Successor
Usage
zowe ca7 job-definition list-job-trigger-successor [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Modify Address Space Resource
Usage
zowe ca7 job-definition update-address-space-resource [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Modify Corequisite Resource
Usage
zowe ca7 job-definition update-corequisite-resource [options]
Required Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
ExclusiveResource
Usage
zowe ca7 job-definition update-exclusive-resource [options]
Required Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
JobDefinition
Usage
zowe ca7 job-definition update-job [options]
Required Options
Options
-
--long-name | --ln (string)
- (Optional) Defines the long job name.
Limits: 1 to 64 alphanumeric characters, case sensitive
-
--system (string)
- (Optional) Specifies the user-defined application system name of which this job is a part.
Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
-
--uid (string)
- (Optional) Specifies the CA 7 user security identification.
Default: 0 (no internal security protection)
Limits: 1 to 3 numeric characters from 0 through 999
-
--jobnet (string)
- (Optional) Specifies the name of a CPU job network of which this job is a part.
Limits: 1 to 8 alphanumeric characters. This field cannot contain a comma
-
--owner (string)
- (Optional) Specifies the ID identifying ownership of this job. Depending on the startup options taken, the external security product being used and contents of the JCL, this value can be offered to the external security package by CA 7 at job submission time as the authority for this job to be executed.
Limits: 1 to 8 alphanumeric characters. Although this field supports up to 8 characters, some external security packages only accept up to 7 characters. This field must not exceed any such limit that exists
-
--jcl-member | --jm (string)
- (Optional) Specifies the JCL library member name and required when the member name and job name are different.
Valid when: job-type is CPU
Default: Job name
Limits: 1 to 8 alphanumeric characters
-
--id (string)
- (Optional) Specifies a numeric index value that is associated with a JCL library where the JCL member is located. NOTE: the id and lib properties are mutually exclusive.
Valid when: job-type is CPU
Default: 0
Limits: 1 to 3 numeric characters in the range 0-253 or 256-999
-
--lib (string)
- (Optional) Specifies a JCL library identification consisting of a symbolic INDEX assigned to a JCL statement. NOTE: the id and lib properties are mutually exclusive.
Valid when: job-type is CPU
Limits: 2 to 16 alphanumeric characters beginning with ampersand (&)
-
--reload (string)
- (Optional) Specifies whether to reload the JCL of this job. When a job comes into the request queue, it is either flagged for load processing or it is not flagged.
Valid when: job-type is CPU
Default: N
Valid values are:
Y = The job is flagged for load processing. The reload flag is automatically reset to N once the load completes successfullyN = The job is not flagged for load processing unless it is the first time it has run in CA 7X = The job is only flagged for load processing when the LOAD command is used and is never automatically changed even if the LOAD command is used
-
--execute (string)
- (Optional) Indicates whether to execute this job.
Default: Y
Valid values are:
Y = The job will be executedN = The job does not run but shows a normal completion as if it did run. JCL is not required for non-executable jobs
-
--retain (string)
- (Optional) Specifies whether to retain the execution JCL in the trailer queue after a successful run.
Valid when: job-type is CPU or XPJOB
Default: N
Valid values are:
Y = Retain the JCL in the trailer queue after a successful run.N = Do not retain the JCL in the trailer queue after a successful run
-
--hold (string)
- (Optional) Specifies whether to place this job in a hold status when it enters the request queue.
Default: N
Valid values are:
Y = The job will be heldN = The job will not be held
-
--jcl-override | --jo (string)
- (Optional) Specifies whether this job needs manual JCL overrides before it can be submitted. Similar to the JCLOVRD command.
Valid when: job-type is CPU
Default: N
Valid values are:
Y = The job needs manual JCL overrides before it can be submittedN = The job does not need manual JCL overrides before it can be submitted
-
--use-jcl-override-library | --ujol (string)
- (Optional) Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only. This field is automatically set back to N the next time the job comes into the request queue.
Default: N
Valid values are:
Y = The JCL is retrieved from the JCL Override library for the next runN = The JCL is not retrieved from the JCL Override library for the next run
-
--verify (string)
- (Optional) Specifies whether this job requires any pre-submission manual verification. Similar to VERIFY command.
Default: N
Valid values are:
Y = The job requires any pre-submission manual verificationN = The job does not require any pre-submission manual verification
-
--maintenance | --maint (string)
- (Optional) Specifies whether this job is a maintenance job (for example, a system utility) with no production data set requirements. If Y is specified, all input data set requirements are ignored. None of the output data sets created by this job is posted back to CA 7.
Marking a job as maintenance enables job triggering but not data set triggering.
Also, if the LOADDSNS keyword is used on the DBASE statement in the initialization file, the LOAD process does not build any DD or data set information for jobs that are marked as maintenance. This means that there are not any data set connections for these jobs unless added manually.
Valid when: job-type is CPU
Default: N
Valid values are:
Y = The job is a maintenance jobN = The job is not a maintenance job
-
--job-requirement-lead-time | --jrlt (string)
- (Optional) Specifies the number of hours to be considered when satisfying job-dependent requirements.
Default: 0
Valid values are:
0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each predecessor job must complete typically while this job is in the request queuenn = Since the last run of this job, specifies that each predecessor job must have run within the last nn hours. Values for nn can be from 1 to 98
-
--dataset-requirement-lead-time | --drlt (string)
- (Optional) Specifies the number of hours to be considered when satisfying data set requirements.
Valid when: job-type is CPU
Default: 0
Valid values are:
0 = No lead time is considered when satisfying this job's requirements99 = Specifies the requirement is never considered as already satisfied when the job enters the queues. Each data set requirement must be satisfied typically while this job is in the request queuenn = Since the last run of this job, specifies that each data set requirement must be satisfied within the last nn hours. Values for nn can be from 1 to 98
-
--arfset (string)
- (Optional) Names the collection of ARF definitions that apply to this job. Remember that ARF recovery is not invoked for non-executable jobs.
Limits: 1 to 8 alphanumeric characters
-
--mainid (string)
- (Optional) Specifies on which CPU the job can or cannot be scheduled. If the job requirements impose CPU restrictions, specify SYn or /SYn where n is the system number and / indicates not this system. System numbers must be consistent with the initialization file CPU statement MAINIDS parameters.
Valid when: job-type is CPU
Default: ALL (lets the job run on any CPU)
Limits: 1 to 4 alphanumeric characters
-
--insert-ca11-rms | --icr (string)
- (Optional) Specifies whether to insert the WA Restart Option RMS step automatically at execution time by CA 7.
Valid when: job-type is CPU
Default: N
Valid values are:
Y = Inserts the step with the WA Restart Option processing code of PN = Does not insert the RMS step
-
--condition-code | --cc (string)
- (Optional) Used with relational-operator property to define the job-level condition codes used to determine whether a job executes successfully.
Valid when: job-type is CPU or XPJOB
Note: All condition codes that are returned from an XPJOB job are treated as positive values. Any negative value returned is converted to an absolute (positive) value
Default: 0
Limits: For job-type = CPU: 1 to 4 numeric characters in the range 0-4095
For job-type = "XPJOB": 1 to 4 numeric characters in the range 0-9999
-
--relational-operator | --ro (string)
- (Optional) Specifies the relational operator of the condition-code property or if the step level #SCC statements are being used in the job's JCL.
Valid when: job-type is CPU or XPJOB
Default: 0
Valid values are:
EQ = Equal toLT = Less thanGT = Greater thanGE = Greater than or equal toLE = Less than or equal toNE = Not equal to#S = Make step condition code tests based on #SCC statements in the JCLIG = Make no evaluation of the job. CA 7 always assumes the job completes successfully, regardless of condition codes, abend codes, or runtime JCL errors. When this is used, the insert-ca11-rms property should be N0 = No condition test will be madeNOTE: If 0 is used, no test is made on the job's condition code. The highest condition code that this job generates is tested by this pair of parameters. For example, if condition-code is set at 8 and RO is set at LT, the job is marked as completing abnormally if 8 is less than the job's highest condition code
-
--do-not-schedule-before-date | --dnsbd (string)
- (Optional) Specifies not to schedule this job before this date (in YYDDD format, or 00000)
-
--do-not-schedule-before-time | --dnsbt (string)
- (Optional) Specifies not to schedule this job before this time (in HHMM format)
-
--do-not-schedule-after-date | --dnsad (string)
- (Optional) Specifies not to schedule this job after this date (in YYDDD format, or 99999)
-
--do-not-schedule-after-time | --dnsat (string)
- (Optional) Specifies not to schedule this job after this time (in HHMM format)
-
--lterm (string)
- (Optional) Routes the messages about this job to this logical terminal name.
Default: If not entered, the LTERM associated with the JCL library in the initialization file JCL statement is used. If LTERM is not specified on the JCL statement, the default is MASTER
Limits: 1 to 8 alphanumeric characters
-
--list-requirements | --lr (string)
- (Optional) Specifies whether to list pre-execution requirements for this job when it enters the request queue.
Default: Y
Valid values are:
Y = The pre-execution requirements will be listedN = The pre-execution requirements will not be listed
-
--prompts (string)
- (Optional) Specifies whether to issue prompt messages when this job is late.
Default: Y
Valid values are:
Y = Prompt messages will be issued when the job is lateN = Prompt messages will not be issued when the job is late
-
--requirements-not-used | --rnu (string)
- (Optional) Specifies whether to issue error messages for job requirements not used.
Default: Y
Valid values are:
Y = Messages will be issued if requirements are not usedN = Messages will not be issued if requirements are not used
-
--dsn-not-found | --dnf (string)
- (Optional) Specifies whether to list error messages for data sets used at execution time but not found in the CA 7 database.
Valid when: job-type is CPU
Default: Y
Valid values are:
Y = Messages will be issued if data sets used are not found in the CA 7 databaseN = Messages will not be issued if data sets used are not found in the CA 7 database
-
--job-region | --jr (string)
- (Optional) Specifies the region size that is required by this job (information only).
Valid when: job-type is CPU
Default: 0
Limits: 1 to 4 numeric characters
-
--elapsed-time | --et (string)
- (Optional) CA 7 maintains certain SMF feedback data in its database, including a weighted average elapsed runtime. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
Default: 0000
Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
-
--average-cpu-time | --act (string)
- (Optional) CA 7 maintains weighted average CPU time usage values for each job in its database. If the database is updated with a time of 0000, the counters for number of runs, number of times late, and number of restarts are also reset to 0000. One use of this value is deadline prompting. If 2359 is specified, deadline prompt time is not adjusted. It remains due-out time minus lead time.
Valid when: job-type is CPU
Default: 0000
Limits: 4 numeric characters in HHMM format where HH can be 00 - 23 and MM can be from 00 - 59
-
--wlb-job-class | --wjc (string)
-
(Optional) Specifies the CA 7 WLB job class. If not specified, a WLB class of A is automatically assigned. This value does not have to match the JOB statement CLASS value.
NOTE: The value specified here does not apply when the job enters the queue as a result of a RUN(H) command. Class 9 is assigned by default. To override class 9, use the RUNCLASS keyword on the OPTIONS statement in the initialization file.
NOTE: The value specified here does not apply when the job enters the queue as a result of a LOAD(H) command. Class 8 is assigned by default. To override class 8, use the LOADCLASS keyword on the OPTIONS statement in the initialization file
Default: A space
Limits: 1 alphanumeric character
-
--wlb-priority | --wp (string)
- (Optional) Specifies the CA 7 WLB job priority. A value of 255 indicates an express priority used to bypass WLB priority scheduling criteria. If using WLB, any job without a specified priority is automatically assigned a priority of 100 unless the default is changed
Default: 0
Limits: 1 to 3 numeric characters in the range 0 - 255
-
--message-class | --mc (string)
- (Optional) Specifies the job's message class. This field is informational only. Even though this field can be changed, it does not cause the JCL to be changed. Also, no validity checking is done on this field.
Valid when: job-type is CPU
Default: A space
Limits: 1 alphanumeric character
-
--drclass | --dc (string)
- (Optional) Specifies the job's disaster recovery class. This field has no impact on processing during normal execution. When running in disaster recovery mode, the disaster recovery class is used to determine whether the job should execute.
Limits: 1 to 8 alphanumeric characters. Disaster recovery class values must start with a letter, #, or $ (not @) and can include letters, #, $, @, and numbers. Disaster recovery classes cannot contain embedded blanks
-
--number-1-tape-man | --n1tm (string)
- (Optional) Specifies a manual override value for the number of TYPE1 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE1 tape drives.
Valid when: job-type is CPU
Default: 0
Limits: 1 to 3 numeric characters in the range 0 - 255
-
--number-2-tape-man | --n2tm (string)
- (Optional) Specifies a manual override value for the number of TYPE2 tape drives needed for the job. Normally this field is only used to update a job where tape drive requirements have been changed, higher or lower, and the job has not been reloaded after the change. A value of 255 can be used to specify that the job uses 0 TYPE2 tape drives.
Valid when: job-type is CPU
Default: 0
Limits: 1 to 3 numeric characters in the range 0 - 255
-
--xp-node | --xn (string)
- (Required when job-type is XPJOB) Defines the CAICCI node to which the execution of this job is targeted. This field should state the primary node. If this node is unavailable and the node definition has alternate nodes defined, the execution of this job can be directed to an alternate node.
Valid when: job-type is XPJOB
Limits: 1 to 44 alphanumeric characters, although current z/OS CAICCI restricts this name to eight characters
-
--xp-exec | --xe (string)
- (Required when job-type is XPJOB) Defines the executable (file, command) to execute at the targeted cross-platform node. If the targeted platform is a mainframe scheduling system such as CA 7, this value indicates the job name to execute on that platform. If the targeted platform is Workload Automation AE system, this value indicates a job that is defined in the Workload Automation AE system. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. Otherwise, the field is passed to the target system as-is and in its entirety. This value includes any embedded blanks and quotation marks.
Valid when: job-type is XPJOB
Limits: Up to 244 alphanumeric characters, and file delimiters of forward slash (/) and backward slash (\) signs. Note: Each backward slash character must be escaped by specifying (\\)
-
--xp-parm | --xp (string)
- (Optional) Defines up to 128 bytes of parameter data to pass to the file or command being executed on the alternate platform. This data is supplied as PARM1 to the data being transmitted to the alternate platform. If this field begins and ends in single quote (') marks, these marks are removed before being passed in the transmission data. This value may be overridden if the PARMLIB/MEMBER field PARM1 is coded.
Valid when: job-type is XPJOB
Limits: Up to 128 EBCDIC characters
-
--parmlib | --pl (string)
- (Optional) Defines extra, optional indexed, or symbolic (PDS) library from where execution data to be associated with this job can be found. This information is typically PARM1 through PARM64 keywords but can vary based on CA 7 system configuration options. If the PARM1 field is found within this file, it overrides the data that is specified in the XP PARM field that is listed on the panel.
Valid when: job-type is XPJOB or AGENT
Limits: 1 to 16 alphanumeric characters. If this field starts with a numeric value, the value is treated as a JCL Index value (0 - 253 or 256 - 999), and the associated numbered JCL library, as defined in the initialization file JCL statement, is used. If the first character is not numeric, the field must start with an ampersand (&) and must denote the library variable as defined using a /JCL command.
Note: Specifying data in the PARMLIB/MEMBER fields is in addition to anything specified in the XPPARM field. If XPPARM is coded, and if the PARMLIB/Member contains a PARM1 statement, the PARMLIB specification overrides the XP PARM field. Thus, if both XPPARM and PARMLIB PARM1 fields contain data, the data that is obtained from the PARMLIB/MEMBER is used in the data that is transmitted to the target node
-
--member (string)
- (Optional) Indicates the PDS member name in the parmlib library where the parameters for this job reside.
Valid when: job-type is XPJOB or AGENT
Default: Same as the job property
Limits: 1 to 8 alphanumeric characters, beginning with an alphabetic character
-
--sutype (string)
- (Optional) Specifies the type of "switch user" command to execute at the UNIX target node.
Valid when: job-type is XPJOB
Default: Y
Valid values are:
Y = Executes an "SU -" causing the environment setup to include execution of the ".PROFILE" for the target userN = Executes an "SU" command without the profile option
-
--xp-trace | --xt (string)
- (Optional) Indicates whether to trace the activity that is associated with this job as it moves through the queues.
Valid when: job-type is XPJOB
Default: N
Valid values are:
Y = Issue WTOs as the job enters into the submission process. Retain up to 256 characters of the data that is sent for inclusion in a log recordN = Do not activate tracing for this job
-
--agent-job-type | --ajt (string)
- (Required when job-type is AGENT) Defines the type of agent job. For more information about the Agent job types see:
[CA 7 Documentation](https://techdocs.broadcom.com/us/en/ca\-mainframe\-software/automation/ca\-workload\-automation\-ca\-7\-edition/12\-1/configuring/interfaces/cross\-platform\-scheduling/ca\-workload\-automation\-agents/ca\-7\-agent\-job\-types.html/)
Valid when: job-type is AGENT
Default: There is no default value
Valid values are:
UNIX_JOB - Generic UNIXNT_JOB - Microsoft WindowsFILE_TRIGGER - File TriggerFTP_JOB - FTPSCP_JOB - Secure CopySFTP_JOB - Secure File TransferBDC_JOB - SAP Batch Input SessionBWIP_JOB - SAP Business Warehouse InfoPackageBWPC_JOB - SAP Business Warehouse Process ChainSAP_JOB - SAP GenericSAPA_JOB - SAP ArchiveSAPE_JOB - SAP Event MonitorSAPM_JOB - SAP Process MonitorPS_JOB - PeopleSoftOA_JOB - Oracle RequestOAC_JOB - Oracle CopyCPU_MON - CPU MonitorDISK_MON - Disk MonitorIP_MON - IP MonitorPROCESS_MON - Process MonitorTEXT_MON - Text File MonitorEVENTLOG_MON - Event Log MonitorSERVICE_MON - Service MonitorSQL_JOB - Database SQLDBSP_JOB - Database Stored ProcedureDB_MON - Database MonitorDB_TRIG - Database TriggerAS400_JOB - AS400/OS400JMSP_JOB - J2EE JMS PublishJMSS_JOB - J2EE JMS SubscribeEJBE_JOB - J2EE Entity BeanHTTP_JOB - J2EE HTTP/ServletPOJO_JOB - J2EE POJORMI_JOB - J2EE RMIEJB_JOB - J2EE Session BeanJMXB_JOB - JMX-Mbean Attribute GetJMXA_JOB - JMX-Mbean Attribute SetJMXO_JOB - JMX-Mbean OperationJMXS_JOB - JMX-Mbean SubscribeJMXN_JOB - JMX-Mbean Create InstanceJMXR_JOB - JMX-Mbean Remove InstanceSNPG_JOB - SNMP Get AttributeSNPS_JOB - SNMP Set AttributeSNPC_JOB - SNMP SubscribeSNPE_JOB - SNMP TrapSendWEB_SERV - Web ServicesWOL_JOB - Wake-On-LANPROXY_JOB - Remote ExecutionNONSTOP_JOB - HP Integrity NonStop
-
--agent (string)
- (Required when job-type is AGENT) Identifies the explicit distributed platform where the job is to run.
Valid when: job-type is AGENT
Limits: 1 to 16 alphanumeric characters. The value must be defined to CA 7 using the IASAGENT DD statement
-
--agent-user | --au (string)
- (Optional) Defines the user ID that is passed to the distributed platform where the job is to run.
Valid when: job-type is AGENT
Limits: 1 to 128 alphanumeric characters
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Modify Job Trigger Successor
Usage
zowe ca7 job-definition update-job-trigger-successor [options]
Required Options
Options
-
--schid (string)
- (Optional) Specifies for which schedule ID of the triggering job the triggered-job is scheduled.
Default: 0 (all schedule IDs)
Limits: 1 to 3 numeric characters from 0 through 999
-
--triggered-job-schid | --tjs (string)
- (Optional) Denotes a replacement schedule ID to use when the triggered-job is placed into the request queue.
Default: 0 (no replacement)
Limits: 1 to 3 numeric characters from 0 through 999
Note: If triggered-job-schid is used, it replaces the schid value of the triggered job. Any jobs triggered (by triggered-job or data sets it creates) use this triggered-job-schid for their schedule ID unless they also have a triggered-job-schid value.
-
--triggered-job-due-out-time | --tjdot (string)
- (Required if triggered-job-queue-time is omitted) Specifies the due-out time of day of the triggered-job rounded down to 10-minute increments.
If this parameter is used, triggered-job-queue-time must be omitted.
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400. If specified, the lowest value is 10.
Note: If used and the due-out-time of the triggering job is after the triggered-job-due-out-time, the following calendar day is assumed.
-
--triggered-job-queue-time | --tjqt (string)
- (Required if triggered-job-due-out-time is omitted) Specifies the elapsed queue time of triggered-job rounded down to 10-minute increments.
If this parameter is used, triggered-job-due-out-time must be omitted because due-out time is then calculated as deadline time plus runtime.
Deadline time is calculated as current date/time plus queue time.
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
The mm can be 00 through 59, the highest value being 2400.
-
--triggered-job-lead-time | --tjlt (string)
- (Optional) Specifies the elapsed lead time for triggered-job rounded to 10-minute increments. This parameter specifies the lead or processing time necessary to ensure triggered-job meets its due-out time.
Default: 0000
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24.
The mm can be 00 through 59, the highest value being 2400.
-
--triggered-job-submit-time | --tjst (string)
-
(Optional) Imposes a submit time of day requirement on triggered-job. When used, the job is not submitted before this time.
The triggered-job-submit-time is always rounded down to 15-minute increments.
Default: 0 (no specific submit time requirement)
Limits: 4 numeric characters that are specified as hhmm, where hh can be 00 through 24 and mm can be 00 through 59, the highest value being 2400.Note: If triggered-job-queue-time is used, the date for the submit time requirement is the same as the deadline start date.
If triggered-job-due-out-time is used and the triggered-job-submit-time is less than the triggered-job-due-out-time, the date for the triggered-job-submit-time is the same as the deadline start date. Otherwise, the triggered-job-submit-time date is the previous day.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Modify Resource Count Resource
Usage
zowe ca7 job-definition update-resource-count-resource [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Modify Shared Resource
Usage
zowe ca7 job-definition update-shared-resource [options]
Required Options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands listed in the Job Instance section.
List waiting Resource
Usage
zowe ca7 job-instance list-waiting-resource [options]
Options
-
--job (string)
- (Optional) Specifies a fully qualified or generic job name.
* - Specifies all jobs.
job - Specifies a fully qualified job name
Limits:: 1 to 8 alphanumeric characters
job - Specifies multiple jobs that a generic job name specifies.
Limits:: 1 to 7 alphanumeric characters that are terminated with an asterisk.
-
--schid (string)
- (Optional) A SCHID value of 0 applies to connections for all schedules and
therefore is listed with connections for any schedule ID requested. Default:: Null (causes connections for all schedule IDs to appear)Limits:: 1 to 3 numeric characters from 0 through 999
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
TODO:
zowe ca7 job-instance list-waiting-resource TODO
All the available commands are listed in the COMMANDS section.
Get a list of the job definitions for one or more jobs.
Usage
zowe ca7 list-job-definition job [options]
Required Options
-
--all (string)
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get a list of the prose information for one or more jobs.
Usage
zowe ca7 list-job-definition prose [options]
Required Options
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get a list of the predecessors for one or more jobs.
Usage
zowe ca7 list-job-definition requirement-predecessor [options]
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
Required Options
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get a list of the successor jobs for one or more jobs.
Usage
zowe ca7 list-job-definition requirement-successor [options]
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
Required Options
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get a list of the job resources for one or more jobs.
Usage
zowe ca7 list-job-definition resource [options]
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
Required Options
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get a list of the job schedules for one or more jobs.
Usage
zowe ca7 list-job-definition schedule [options]
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
Required Options
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get a list of the job STEP and DD information for one or more jobs.
Usage
zowe ca7 list-job-definition step-dd [options]
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
Required Options
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get a list of the trigger objects for one or more jobs.
Usage
zowe ca7 list-job-definition trigger-predecessor [options]
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
Required Options
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get a list of the triggered jobs for one or more jobs.
Usage
zowe ca7 list-job-definition trigger-successor [options]
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
Required Options
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Get a list one or more jobs from the prior-run queue.
Usage
zowe ca7 list-job-history prior-run [options]
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
Required Options
-
--jobname (string)
-
jobname=TESTJOB01
The CA 7 job name
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Display active resources by job.
Usage
zowe ca7 list-job-instance active-resource [options]
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Displays JCL for a job in the active workload.
Usage
zowe ca7 list-job-instance jcl [options]
Required Options
-
--ca7no (string)
-
ca7no=0231
The CA 7 job number
Options
-
--db (string)
-
db=TESTJOB01
The CA 7 database name
-
--showNo (boolean)
-
showNo=true
Show line numbers in JCL
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Displays information about jobs in the active workload.
Usage
zowe ca7 list-job-instance list [options]
Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Displays information about jobs in the active workload.
Usage
zowe ca7 list-job-instance listCustom [options]
Options
-
--ca7no (number)
-
ca7no=0231
The CA 7 job number
-
--databasename | --db (string)
-
databasename=TESTDB01
The CA 7 database name
-
--jobname (string)
-
jobname=CA7TEST
The CA 7 job name
-
--job (boolean)
-
--queueName (boolean)
-
--ca7Num (boolean)
-
--status (boolean)
-
status=true/false
The job status
-
--entryMode (boolean)
-
--abended (boolean)
-
--agentIntervention (boolean)
-
agentIntervention=true/false
Y if INTERVENTION REQUIRED condition exists for this agent job, N if not
-
--agentJobNumber (boolean)
-
--agentName (boolean)
-
--agentStatus (boolean)
-
--agentStatusData (boolean)
-
--agentSubmitted (boolean)
-
--agentType (boolean)
-
--agentUser (boolean)
-
--ajbBuildError (boolean)
-
--arf (boolean)
-
--arfAttachErr (boolean)
-
--arfCompMatched (boolean)
-
--arfDate (boolean)
-
arfDate=true/false
Y if the job uses ARF
-
--arfErrorCond (boolean)
-
--arfjJob (boolean)
-
--arfJobComplete (boolean)
-
--arfRecovery (boolean)
-
--arfRecoveryErr (boolean)
-
--arfset (boolean)
-
--arfTime (boolean)
-
--autofDone (boolean)
-
--ca11JesNode (boolean)
-
--ca11RestartStep (boolean)
-
--ca11RmsCc (boolean)
-
--ca11Subsystem (boolean)
-
ca11Subsystem=true/false
The CA 11 subsystem name
-
--ca7System (boolean)
-
--compCode (boolean)
-
--cpmJfm (boolean)
-
--cpuTableIndex (boolean)
-
--cputime (boolean)
-
--currStepNum (boolean)
-
--defNotFound (boolean)
-
--doNotPrompt (boolean)
-
--drclass (boolean)
-
--drmode (boolean)
-
--dueOutExists (boolean)
-
--dueOutTime (boolean)
-
--dupJob (boolean)
-
--dupJobWait (boolean)
-
--elapsedTime (boolean)
-
--endTime (boolean)
-
--executable (boolean)
-
--express (boolean)
-
--externalInput (boolean)
-
--externalJob (boolean)
-
--externalSatisfied (boolean)
-
--externalTotal (boolean)
-
--forcedComplete (boolean)
-
--forcedSubmit (boolean)
-
--fromXpRequest (boolean)
-
--hasCa11 (boolean)
-
--hasCpuTime (boolean)
-
--hasJo (boolean)
-
--hasStepTime (boolean)
-
--held (boolean)
-
--heldByJob (boolean)
-
--heldSkeleton (boolean)
-
--skeleton (boolean)
-
--holdOnEntry (boolean)
-
--hostName (boolean)
-
--inCpmFlow (boolean)
-
--insertRms (boolean)
-
--jclAllocErr (boolean)
-
--jclCount (boolean)
-
--jclError (boolean)
-
--jclFromAltlib (boolean)
-
--jclLibrary (boolean)
-
--jesHi (boolean)
-
jesHi=true/false
JES supports ID > 99999
-
--loadOnly (boolean)
-
--loadStepDone (boolean)
-
--locked (boolean)
-
--longName (boolean)
-
--lterm (boolean)
-
--mainid (boolean)
-
--maint (boolean)
-
--manualRequeue (boolean)
-
--memberName (boolean)
-
--mustStartExists (boolean)
-
--needsAutof (boolean)
-
--nextRunReq (boolean)
-
--nodeFailed (boolean)
-
--nodeOffline (boolean)
-
--nodeStopped (boolean)
-
--noUserId (boolean)
-
--noXpsiParmlib (boolean)
-
--noXpsiXpsparm (boolean)
-
--override (boolean)
-
--overrideApplied (boolean)
-
--prompt (boolean)
-
--promptAck (boolean)
-
--prompted (boolean)
-
--qjclUpdated (boolean)
-
--queueJcl (boolean)
-
--repeatCount (boolean)
-
--repeatDiff (boolean)
-
--ca7No (boolean)
-
--repeatInterval (boolean)
-
--repeatLeadTime (boolean)
-
--repeatStopExists (boolean)
-
--repeatStopTime (boolean)
-
--repeatType (boolean)
-
--restartStep (boolean)
-
--retainJcl (boolean)
-
--rqmtCount (boolean)
-
--schdAdjusted (boolean)
-
--nosecurity (boolean)
-
--setNdb (boolean)
-
--smfNeeded (boolean)
-
--startTime (boolean)
-
--submitted (boolean)
-
--submitTime (boolean)
-
--triggered (boolean)
-
--uid (boolean)
-
--verify (boolean)
-
--waitSubmitTime (boolean)
-
--xpAltNode (boolean)
-
--xpPrimaryNode (boolean)
-
--xpsJob (boolean)
-
--xpStatus (boolean)
-
--xtrackerInact (boolean)
-
--xplatNode (boolean)
-
--responseError (boolean)
-
--ca11FailingStepNum (boolean)
-
--completeOk (boolean)
-
--jesNum (boolean)
-
--needsLoad (boolean)
-
--deadline (boolean)
-
--jclfrom254 (boolean)
-
--proseNum (boolean)
-
--scheduleId (boolean)
-
--triggeringJobNum (boolean)
-
--triggers (boolean)
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Displays information about requirements for jobs in the active workload.
Usage
zowe ca7 list-job-instance requirements [options]
Required Options
-
--ca7no (string)
-
ca7no=0231
The CA 7 job number
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Retrieves a Resource Count Resource Information
Usage
zowe ca7 list-resource-definition resource-count-resource [options]
Required Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Update requirement definition for a job
Usage
zowe ca7 update-job-definition job [options]
Required Options
Options
-
--execute (string)
- Indicates whether to execute this job.
Valid values are: Y/N
-
--use-jcl-override-library | --ujol (string)
- Specifies whether to retrieve the JCL from the JCL Override library (JCLID=254) for the next run only (Y or N).
This field is automatically set back to N the next time the job comes into the request queue
-
--do-not-schedule-before-date | --dnsbd (string)
- Specifies not to schedule this job before this date (in YYDDD format, or 00000)
-
--do-not-schedule-before-time | --dnsbt (string)
- Specifies not to schedule this job before this time (in HHMM format)
-
--do-not-schedule-after-date | --dnsad (string)
- Specifies not to schedule this job after this date (in YYDDD format, or 99999)
-
--do-not-schedule-after-time | --dnsat (string)
- Specifies not to schedule this job after this time (in HHMM format)
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Update requirement definition for a job
Usage
zowe ca7 update-job-definition requirement-predecessor [options]
Required Options
-
--job (string)
- The name of the job that requires the predecessor
-
--schid (string)
- The schedule id of requiring job
-
--predtype (string)
-
--nextrun (string)
- The status of predecessor for next run of job
[ YES, ONLY, SKIP ]
-
--predobject (string)
- The predecessor. Values vary with predtype.
The predecessor. Values vary with predtype.
When “predtype”:”DSN”,”predobject” is 1-44 name of required dataset.
When “predtype”:”USER” then “predobject” is 1-44 character user requirement text.
Options
-
--leadtime (string)
- The satisfaction lead time in hours.
This may be honored when “predtype” is “job or “DSN”
-
--permanent (string)
- Indicates that this predecessor is permanent, that is always considered satisfied.
This parameter only applies when “predtype” is “DSN”
[ Y, N ]
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Modify schedule parameters
Usage
zowe ca7 update-job-definition schedule [options]
Required Options
-
--job (string)
-
--schid (string)
- Specifies the numeric schedule ID on which the user wants to perform the specified action.
Limits: 1 to 3 numeric characters from 1 through 999
Options
-
--scal (string)
- Specifies the override of the default SCAL for this SCHID. Specify scal if you want to override the default scal.
Limits: 2 alphanumeric characters
-
--default-scal | --dscal (string)
- Specifies the default SCAL for this job. If this is not specified, an LJOB will be issued to fetch the SCAL
Limits: 2 alphanumeric characters
-
--due-out-time | --dot (string)
- Specifies the due-out time of day for this schedule ID.
Limits: 4 numeric characters that are specified as hhmm
where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
-
--lead-time | --lt (string)
- Specifies the due-out time of day for this schedule ID.
Limits: 4 numeric characters that are specified as hhmm
where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
-
--submit-time | --st (string)
- Specifies the submit time of day for this schedule ID.
If specified, the job is not submitted before this time.
If the submit time is before deadline start time,
the submit time requirement is automatically satisfied when the job enters the queue.
A submit time of zeros is the same as not specifying it, and no submit time is set up.
Note:If the submit time is after the due-out time, the submit day value is set to the previous day.
Limits: 4 numeric characters that are specified as hhmm
where hh can be 00 through 24 and mm can be 00 through 59. Must be greater than 0000.
-
--daily (string)
- Specifies that the user wants to define a daily schedule.
Daily means every available processing day as defined by the Base Calendar.
If DAILY is used, the ROLL has no effect.
Limits: One of Y or N
-
--roll (string)
- Specifies the action to take when a schedule day falls on a base calendar non available processing day.
This value is not used if the DAILY option is used
If DAILY is used, the ROLL has no effect.
If used, the value must be one of the following values:
B: Roll the schedule back to the previous available processing day in the Base Calendar.
F: Roll forward the schedule to the next available processing day.
N: Do not roll. Schedule day must stand.
D: Do not roll and do not schedule.
Default:D
-
--index (string)
- Specifies an adjustment to schedule days.
After you exercise the ROLL option, the schedule is adjusted,
forward for plus or backward for minus, by the number of working days entered.
Limits:4 numeric characters that are specified as Innn where I can be plus (unsigned) or minus (-) and nnn can be 0 to 365 daysUsage:
Use this field with the RDAY field to schedule a job to run three workdays before the 15th of the month:
specify -3 in the INDEX field, X in the MONTHLY field, and 15 in the RDAY field.
-
--interval (string)
- Specifies that the job should be repeated (executed more than once) and
specifies the amount of time between each iteration.
If INTERVAL is specified, the SBTM (submit time requirement) and TYPE fields are required.
If both INTERVAL and COUNT are specified, the INTERVAL value times the COUNT value must total less than 24 hours.
Limits:4 numeric characters in hhmm format where hh can be from 0 to 23 and mm can be from 00 to 59
-
--type (string)
- Determines how the submit time requirement is calculated for repeating jobs.
A TYPE of CLOCK indicates that the INTERVAL is added to the previous iteration's
submit time requirement to determine the new submit time requirement.
A TYPE of START and END indicates that the INTERVAL is added to the previous iteration's
last (most recent) start and end times,respectively, to determine the new submit time requirement.
TYPE is required if INTERVAL is specified.
TYPE is discarded if INTERVAL is not specifiedLimits:CLOCK, START, or END
-
--count (string)
- Specifies the maximum number of times to repeat the job.
COUNT is discarded if INTERVAL is not specified.
If both COUNT and STOP are specified, the job stops repeating when the COUNT reaches zero or the STOP time is reached, whichever comes first.
If COUNT is not specified, the job repeats until the STOP time is reached.TYPE is required if INTERVAL is specified. TYPE is discarded if INTERVAL is not specifiedLimits:1 to 4 numeric characters from 0 to 1439. Leading zeros can be discarded.
-
--weekly (string)
- Specifies that the user wants to define a weekly schedule.
If WEEKLY is used, the run days of the week must be specified using DAYS field
Limits:Y or N
-
--days (string)
- Defines specific days of the week on which to run the job.
as comma separated list of day name abbreviations.
Limits: A comma separated list of Sun,Mon,Tue,Wed,Thu,Fri,Sat
-
--monthly (string)
- Specifies that the user wants to define a monthly schedule.
If this field is used, the user can optionally specify on which particular months the job is to run.
If specific months are not specified in the months property, all months are assumed.Limits: Y or N
-
--months (string)
- Defines specific months on which to run the job.
as comma separated list of month name abbreviations.
Limits: A comma separated list of Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec
-
--weeks-of-month | --wom (string)
- Specifies the weeks of the month to run the job.
The values that are specified can be positive (unsigned), negative (-) or slash (/).
Positive values 1, 2, 3, 4, or 5 are used to indicate the week relative to the beginning of the month.
Negative values -0, -1, and -2 are used to indicate occurrence of week relative to the end of the month.
Slashes indicate the job will not run the following value.
Limits: 1 to 14 numeric characters and required if MONTHLY and DAY-OF-WEEK are used.
The values are separated by comma
-
--day-of-week | --dow (string)
- Specifies which days of the week to run the job.
If used, each day must be the first three letters of the wanted run days.
If you want to specify multiple days, use a comma separated list for example MON,TUE,FRI.
Limits: A comma separated list of SUN, MON, TUE, WED, THU, FRI, SAT, case insensitive
-
--relative-day | --rd (string)
- Specifies relative days of the month on which the job is to run. Used with MONTHLY.
A day relative to the beginning or end of the month is specified.
If a positive (unsigned) value is used, the job runs that day relative to the first of the month.
Also, if you have days of the month when this job is not to run,a slash (/) can be used with the unsigned or negative values.
Valid positive values range from 1 to 31.
Valid negative values range from -0 to -30.
Limits:1 to 60 numeric characters, separated by comma.
Note:relative-day(s) represents calendar days, unless the base calendar was generated with OPTIONS=SCHDYONLY,
in which case relative-day(s) represents processing days.
-
--annual (string)
- Defines an annual schedule.
Limits: If annual is used, day is required. One of Y, N
-
--day-of-year | --doy (string)
- Specifies on which days of the annual schedule the user wants to run the job.
Days are entered as 1 through 366 and are prefixed by positive (unsigned) or slash (/) values.
Slash indicates the job will not run this day.
For example, if a job is to run on days 121, 132, 240, and 241, but is not to run on days 122, 242, and 1,the user would specify: /1,121,/122,132,240,241,/242
Limits: 1 to 55 numeric characters and required if annual is used.
The numbers will be separated by comma
-
--symmetric (string)
- Used with the START and SPAN fields, defines a symmetric schedule.
With this option, schedules are defined as beginning on the date specified with
the START field and recurring every nnn days as specified with the SPAN field.
Limits: One of Y, N
-
--start (string)
- This field is required when the SYMETRIC option is taken.
Value must be specified as the Julian day of the year on which the symmetric schedule is to begin.
This value should be evaluated yearly before schedule resolution and may need to be changed each year.
If the schedule will be resolved on a July-June basis, the start date must be within
the first of the two years in which the schedule overlaps.
For January-December schedules, it is simply relative to January 1 of the year specified on a RESOLV command.
If the calendar against which this SCHID will be resolved does not have the OPTIONS=SCHDYONLY,
the START day is adjusted each year to maintain the job's symmetric schedule from the job's original specified START day.
If the calendar against which the SCHID will be resolved was generated with overall available processing days only (OPTIONS=SCHDYONLY)
the start date must specify the first day on which the job would actually run.
This requires manually setting (verifying) the START value each year before the RESOLV.
If a nonprocessing day is specified, the start day is the next processing day found in the calendar.
For example, if January 1 is a nonprocessing day and the calendar was generated with OPTIONS=SCHDYONLY,
and 1 is specified as the START day, January 2 is the actual START day (provided it is an available processing day).
SPAN is based from January 2 in this example rather than January 1.
For other types of calendars, the start date is determined at RESOLV time based on the ROLL and INDEX options taken.
Limits: 3 numeric characters specified as Julian day of the year from 1 to 365
-
--span (string)
- Used with SYMETRIC and START, defines symmetric schedules.
This field is required if the SYMETRIC option is taken.
When used, specifies the number of days between scheduled processing cycles.
If the calendar against which the SCHID will be resolved was generated with processing days
only (OPTIONS=SCHDYONLY), the SPAN value is specified as the number of available processing days
between and including the next processing date as opposed to the actual number of days.
With this type of calendar, the ROLL and INDEX options serve no practical purpose.
For other calendar types, the SPAN value is specified as the number of calendar days
between processing cycles and the ROLL and INDEX options can be used as necessary.
Limits: 1 to 3 numeric characters from 1 to 255
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Update JCL for a job
Usage
zowe ca7 update-job-instance jcl [options]
Required Options
-
--ca7no (string)
-
--sourcedataset (string)
- The source data set name containing the new JCL
-
--sourcemember (string)
- The source data set member name containing the new JCL
-
--sourcetype (string)
Options
-
--postjclovrd (string)
- Indicates whether to post the JCL override requirement when the JCL is updated
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
All the available commands are listed in the COMMANDS section.
Modify Resource Count Resource parameters
Usage
zowe ca7 update-resource-definition resource-count-resource [options]
Required Options
CA7 Connection Options
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Manage JSON project and global configuration
Automatically generate a config from APIML
Usage
zowe config auto-init [options]
Automatic Config Initialization Options
-
--user-config | --uc (boolean)
-
--global-config | --gc (boolean)
-
--dry-run | --dr | --dry (boolean)
- Display the outcome of the initialization without saving
-
--edit | -e (boolean)
- Open in editor after initializing the configuration
-
--overwrite | --ow (boolean)
-
--for-sure | -f (boolean)
APIML Connection Options
-
--host | -H (string)
- Host name of the mainframe running the API Mediation Layer.
-
--port | -P (number)
- Port number of API Mediation Layer on the mainframe.
-
--user | -u (string)
- User name to authenticate to the API Mediation Layer on the mainframe.
-
--password | --pass | --pw (string)
- Password to authenticate to the API Mediation Layer on the mainframe.
-
--reject-unauthorized | --ru (boolean)
-
--token-type | --tt (string)
- The type of token to get and use for the API Mediation Layer. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--token-value | --tv (string)
- The value of the token to pass to the API Mediation Layer.
-
--cert-file (local file path)
- The file path to a certificate file to use to authenticate to the API Mediation Layer
-
--cert-key-file (local file path)
- The file path to a certificate key file to use to authenticate to the API Mediation Layer
Profile Options
Convert v1 profiles to a global zowe.config.json file.
Usage
zowe config convert-profiles [options]
Options
-
--prompt (boolean)
-
--delete (boolean)
- Delete the existing profiles on disk and any securely stored secrets.
Examples
Edit an existing config file in your system's default text editor.
In a graphical environment, the application associated with JSON files will be launched. In a command-line environment, vi will be launched. To override the command-line editor used, specify it in the ZOWE_EDITOR environment variable.
Usage
zowe config edit [options]
Options
Examples
-
Edit global config file:
zowe config edit --global-config
Import config files from another location on disk or from an Internet URL.
If the config `$schema` property points to a relative path, the schema will also be imported.
Usage
zowe config import <location> [options]
Positional Arguments
-
location (string)
- File path or URL to import from.
Options
-
--global-config | --gc (boolean)
-
--user-config | --uc (boolean)
-
--overwrite | --ow (boolean)
Connection Options
Examples
Initialize config files. Defaults to initializing "zowe.config.json" in the current working directory unless otherwise specified.
Use "--user-config" to init "zowe.config.user.json". Use "--global-config" to initialize the configuration files in your home "~/.zowe" directory.
Use "--no-prompt" to skip prompting for values in a CI environment.
Usage
zowe config init [options]
Options
-
--global-config | --gc (boolean)
-
--user-config | --uc (boolean)
-
--prompt (boolean)
-
--overwrite | --ow (boolean)
- Replace existing config files instead of merging the new changes.
-
--for-sure | --fs (boolean)
-
--dry-run | --dr | --dry (boolean)
- Display the outcome of the initialization without saving it.
-
--edit | -e (boolean)
- Open in editor after initializing the configuration
Examples
-
Initialize configuration files in your home "~/.zowe" directory:
zowe config init --global-config
-
Do a dry run of initializing configuration files in your home "~/.zowe" directory:
zowe config init --global-config --dry-run
-
Initialize the user config files:
zowe config init --user-config
-
Initialize the user config files and do not prompt for secure values:
zowe config init --user-config --prompt false
-
Do a dry run of initializing the user config files and do not prompt for secure values:
zowe config init --user-config --prompt false --dry-run
-
Overwrite any existing global config files:
zowe config init --global-config --overwrite --for-sure
-
Overwrite any existing user config files:
zowe config init --user-config --overwrite --for-sure
List config properties
Usage
zowe config list [property] [options]
Positional Arguments
-
property (string)
- The config property to list. Blank to list all properties.
Options
-
--locations (boolean)
- Separate the config properties into their respective config file locations. Helpful to determine where configuration value is specified.
-
--root (boolean)
- List only the root level property names. For example, specify in addition to '--locations' to get a list of config file paths only.
Examples
-
List property names for a specified config property:
zowe config list "defaults"
-
List only root level property names for a specified config property:
zowe config list "defaults" --root
-
List config properties by separating them by their respective config file locations:
zowe config list --locations
-
List only the root level configuration property names:
zowe config list --root
-
List only the root level configuration properties by separating them by their respective config file locations:
zowe config list --locations --root
Displays profile paths.
Usage
zowe config profiles [options]
Examples
-
Display profile paths:
zowe config profiles
Reports key items from your environment and identifies problem conditions
Usage
zowe config report-env [options]
Examples
Dumps the JSON schema for the config. The schema is dynamically created based on your available plugins. Direct the output of this command to a file and include in your config with '$schema' property to get editor completion.
Usage
zowe config schema [options]
Examples
prompt for secure configuration properties
Usage
zowe config secure [options]
Options
Examples
create or update a configuration property
Usage
zowe config set <property> [value] [options]
Positional Arguments
-
property (string)
- The property to set. You may specify a path using dot notation (e.g. profiles.host1.profiles.service1.properties.setting)
-
value (string)
- The property value to set. The value may be JSON. Use '--json' to indicate.
Options
Examples
-
Set the property in global config:
zowe config set "profiles.host1.profiles.service1.properties.setting" "value" --global-config
-
Set the property in user config:
zowe config set "profiles.host1.profiles.service2.properties.setting" "value" --user-config
-
Set property value to JSON:
zowe config set "profiles.host1.profiles.service3.properties.setting" "{"property":"value"}" --json
-
Store the property value:
zowe config set "profiles.host1.profiles.service1.properties.setting" "value" --secure
-
Set a default zosmf profile:
zowe config set "defaults.zosmf" "zosmfProfileName"
-
Set a default tso profile:
zowe config set "defaults.tso" "tsoProfileName"
Update schema files by looking up the directory structure.
Schema files up in higher level directories will always be updated. To also update schema files down in lower level directories, specify the `--depth` flag.
Usage
zowe config update-schemas [options]
Options
Examples
Perform operations that control the daemon-mode functionality of the Zowe CLI. Daemon-mode runs the CLI command processor as a daemon to improve performance.
Disables daemon-mode operation of the Zowe CLI.
Usage
zowe daemon disable [options]
Examples
Enables daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.
Usage
zowe daemon enable [options]
Examples
Restart the Zowe CLI daemon.
Usage
zowe daemon restart [options]
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
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 generate ddl' command.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 check ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 high-level change summary report and a parseable impact analysis report. You can execute the script that is generated from this command using the 'zowe dbm execute compare-script' command.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 compare ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
-
--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:
- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
- <schema> must be between 1 and 128 characters.
- <version> must be between 1 and 64 characters.
A mask specification can include the following wildcard characters:
Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.
Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.
Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.
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.
- The matchSetValues options-profile option has the same behavior as the match-set-file command option.
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
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 that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or 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 the table schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
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.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--rule-set | --rs (string)
-
Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, 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 during a command execution.
Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, 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 name of the local output file that contains the change summary report in text format. This report tracks changes to Db2 objects on the target Db2 subsystem, but it does not describe how changes are made.
Default value: summary.txt
-
--output-impact-file | --oif (string)
-
Specifies the name of the local output file that contains the parseable impact analysis report in JSON or YAML format. This report identifies the significant DDL operations that are performed on Db2 objects. The report provides the total number and type of DDL operations that are performed on each object type, the list of DDL operations performed on each object instance, and the state of any pending changes.
To determine the report format, supply one of the following extensions in the file name:
- .json for JSON
- .yaml or .yml for YAML
If no extension is provided, the format is set to JSON.
Default value: impact.json
For more information about the impact analysis report, see the RC/Migrator documentation at https://techdocs.broadcom.com/db2rcmig
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies 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 current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 rule set 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.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 deploy ddl <local-input-ddl-filename> [options]
Positional Arguments
Required Options
Options
-
--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:
- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
- <schema> must be between 1 and 128 characters.
- <version> must be between 1 and 64 characters.
A mask specification can include the following wildcard characters:
Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.
Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.
Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.
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.
- The matchSetValues options-profile option has the same behavior as the match-set-file command option.
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
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 that modify attributes of Db2 objects. Depending on the backend configuration, the changes apply to either ALL objects in the DDL or 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 the table schema (creator) and tablespace names:
TBCR TEST% PROD%
TBTS TESTTS% PRODTS%
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.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--rule-set | --rs (string)
-
Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, 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
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies 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 current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 compare ddl' command to implement the Db2 object changes on the Db2 subsystem specified within the script. This command also generates a recovery script to undo compare script changes.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 execute compare-script <local-input-compare-script-filename> [options]
Positional Arguments
Options
-
--output-recovery-script | --ors | --output-recovery-file | --orf (string)
-
Specifies the local output file name that contains the recovery script that is generated during execution of this command. Executing the recovery script using the 'zowe dbm 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.
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies 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 current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 prepare migration' command to migrate Db2 objects (DDL) and table data from a source subsystem to a target subsystem. The source and target subsystem IDs are specified within the script.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 execute migration-script <local-input-migrate-script-filename> [options]
Positional Arguments
Options
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 execute compare-script' command. If execution of the script fails, you can execute it again using the 'script-section' or 'restart' options. You can edit the script and make changes before you execute or restart it.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 execute script <local-input-bp-script-filename> [options]
Positional Arguments
Options
-
--target-db2 | --td (string)
-
Specifies the target Db2 subsystem or data sharing group where you want to execute the script. If this option is not specified, the target subsystem is identified by the first .CONNECT statement in the script.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
The target-db2 option takes precedence over any other value that is specified for the Db2 subsystem or data sharing group.
-
--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.
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies 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 current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 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 compare ddl' command.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 generate ddl [options]
Required Options
Options
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
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 that modify attributes of Db2 objects.
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 the table 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.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--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)
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies 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 current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 execute migration-script' command.
For details about command usage for automation, see DBM-Db2 samples at https://github.com/BroadcomMFD/dbm\-db2\-for\-zowe\-cli
Usage
zowe dbm-db2 prepare migration [options]
Required Options
-
--object | -o (string)
-
Specifies the Db2 objects to be migrated. Use the optional include clause to include related Db2 objects.
Format: see the object-file description
Note: The --object and --object-file options are mutually exclusive.
-
--object-file | --of (string)
-
Specifies the name of the local input file that contains a list of Db2 objects to be migrated. Use a semicolon to separate objects. Use the optional include clause 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[.version]>
FUNCTION <schema.name[.version]>
PROCEDURE <schema.name[.version]>
The optional include clause (<related-object-type>,...) identifies one or more related Db2 object types to include in the object list.
You can specify the following object types: 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.
-
--source-db2 | --sd (string)
-
Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
-
--target-db2 | --td (string)
-
Specifies the target Db2 subsystem or data sharing group where you want to use a command.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
Options
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
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 that modify attributes of Db2 objects.
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 the table 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.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--output-migrate-script | --oms (string)
-
--output-ddl-file | --odf (string)
-
--error-file | --ef (string)
-
Specifies the local output error file in YAML format. The file contains basic execution information, connection details, dbm-db2 profile parameters, used arguments, and errors that occurred during execution of the command.
Default value: error.log
-
--modification | -m (string)
-
Specifies 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 current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
Profile Options
-
--dbm-db2-options-profile | --dbm-db2-options-p (string)
- The name of a (dbm-db2-options) profile to load for this command execution.
-
--dbm-db2-profile | --dbm-db2-p (string)
- The name of a (dbm-db2) profile to load for this command execution.
-
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.
DBM-Db2 Connection Options
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Welcome to the EJES RESTapi Manager
This plug-in allows you to interact with EJES on the host to emulate EJES Batch under TSO and to query the EJES monitoredspool and host libraries to retreive tabular and report information
Make requests with the (E)JES REST API to the (E)JES API using options that correspond to object models in the (E)JES REST API swagger documentation. You should refer to that document, refer to chapter 10 of the (E)JES Reference, and issue "zowe ejes api init --helpApp" further details.
All responses are returned in JSON format by using the --rfj (--response-format-json) option.
The tools necessary manage the spool with (E)JES are provided. You will be able to download sysout, email it as PDF, and submit jobs from MVS and the local workstation. All downloads are saved to a file in the current working directory, or to the path specified on the EJES_DOWNLOAD_PATH environment variable.
The CLI generates exit codes. 0 indicates the transaction completed, but you should check the output for (E)JES errors. A non-zero exit code below 100 indicates a problem coding an options or a download file filesystem issue. An exit code above 100 is a response code from the host through the API. If use the host host "return" command in the --command option, you will receive a 500 exit code. Use a stateless init request or issue a term request to avoid this result.
This CLI was developed to provide an easy scripting option to avoid coding directly to the REST API. However, it can be used to experiment with the REST API. The --debug option will return the host requests and responses as objects and properties in JSON.
Cancels a streaming download of PDF or Text data. A download is initiated via the -d option on an Exec request. Refer to the (E)JES REST API swagger documentation for details on mapped options.
For a command group overview, issue: zowe ejes api -h
Usage
zowe ejes api cancel-download [options]
Query Item Options
-
--cookie (string)
-
Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic management of the cookie without scraping from stdout.
--cookie [<cookie-value>|read[<pin>]|write[<pin>]
The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Examples
Executes an API command in an existing (stateful) or new transient (stateless) session.
Returns items as requested by the query parameters. An existing session is used when a valid cookie is used as an argument on the --cookie option. This is the preferred scenario when multiple transactions are expected since it provides significant performance benefits. It requires server affinity for sessions in a clustered server environment.
A new transient session will be created if a --authorization or --user option is provided and a --cookie option is not. A transient session exists only for the current transaction and meets the goal of statelessness as defined by ROA and REST. However, it is much less efficient than using an existing session across multiple transactions, and does not preserve the state of the underlying (E)JES API. Nevertheless, it is the prefered scenario where a single transaction and statelessness suffice.
See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell. Options flagged with "initParms model" are valid only for stateless transactions on the exec command.
For a command group overview, issue: zowe ejes api -h
Usage
zowe ejes api exec [options]
Query Item Options
-
--authorization (string)
- If you do not specify the --cookie option, you must include --user and --password or this option. The base64 encoded authentication string can be of the form userid:password or userid:group:password. If supplied, it overrides the profile user and password settings and starts a new session.
-
--cookie (string)
-
Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic managment of the cookie without scraping from stdout.
--cookie [<cookie-value>|read[<pin>]|write[<pin>]
The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.
-
-c (string)
-
A list of comma separated, case-insensitive names of columns to include in the response. If omitted, all columns for the current tabular display are included.
This parameter only applies to enumerated data containing columns, specifically, the columns and rows items of the q parameter.
Limiting the included columns to only those you need can dramatically improve the resonse time of the request and significantly reduce system resources.
-
-q (string)
-
A list of comma separated, case-insensitive items to include in the response. If omitted, no items are included.
Limiting the included items to only those you need can improve response time.
The following items are supported: columns, environment, execParms, find, function, initParms, jobs, keys, lines, loginfo, rows, lineCommands, message, notice, platformEncoding, position, screen, submittedJobs, userLog, and version. These represent the response properties as described in the models section of this help. The value all can be used to include all of the above items, but generally you should only request the items you need.
-
-d (string)
-
A download type, either pdf or text.
When specified, all other query parameters are ignored. The Content-Type response header will report either application/pdf or text/plain (charset utf-8) if no error occurred, and application/json if an error occurred. If no error occurred, a Content-Disposition response header will supply a suggested filename.
A pdf or text property may be included in the POST data to override default pdf and text formatting options.
This parameter provides pdf or text data in the output stream and does not require enumeration.
The API must be positioned on a browser type display to download data. Afterwards, the positioning may have changed depending on the amount specified.
You can use CancelDownload to cancel a long running download.
-
-m (string)
-
A mail attachment type, either pdf or text.
At a minimum, a mail property is required in the POST data to specify one or more recipients. A pdf or text property may also be included to override default pdf and text formatting options.
The API must be positioned on a browser type display to send a mail attachment. Afterwards, the positioning may have changed depending on the amount specified.
Note that you cannot use CancelDownload to cancel a long running mail attachement request because the response
containing the needed Cookie is not sent until after mail has been sent.
Init Request Options
-
--casKey (string)
- See the initParms model in the Swagger documentation.
-
--columns (string)
- See the initParms model in the Swagger documentation.
-
--extractdd (string)
- See the initParms model in the Swagger documentation.
-
--ipaddress (string)
- See the initParms model in the Swagger documentation.
-
--luName (string)
- See the initParms model in the Swagger documentation.
-
--patterndd (string)
- See the initParms model in the Swagger documentation.
-
--rows (string)
- See the initParms model in the Swagger documentation.
-
--subsystem (string)
-
--useragent (string)
- See the initParms model in the Swagger documentation.
Exec Request Options
-
--command (string)
- See the execParms model in the Swagger documentation.
-
--commanddata (string)
- See the execParms model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
-
--commanddatafile (string)
- The contents of this file (usually JCL on the local workstation file system) must be escaped properly for --commanddata. See the execParms model in the Swagger documentation. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
-
--enumtime (number)
- See the execParms model in the Swagger documentation.
-
--enumvalue (number)
- See the execParms model in the Swagger documentation.
-
--showhiddencolumns (boolean)
- See the execParms model in the Swagger documentation.
-
--translatescreen (boolean)
- See the execParms model in the Swagger documentation.
-
--waitforresponse (boolean)
- See the execParms model in the Swagger documentation.
PDF and TEXT Common Options
-
--amount (number)
- See the pdf or text model in the Swagger documentation.
-
--blockid (number)
- See the pdf or text model in the Swagger documentation.
-
--cc (string)
- See the pdf or text model in the Swagger documentation. (Carriage-control)
-
--count (number)
- See the pdf or text model in the Swagger documentation.
-
--recordid (number)
- See the pdf or text model in the Swagger documentation.
-
--start (number)
- See the pdf or text model in the Swagger documentation.
-
--todend (number)
- See the pdf or text model in the Swagger documentation.
-
--todstart (number)
- See the pdf or text model in the Swagger documentation.
PDF Download Options
-
--decorate (string)
- See the pdf model in the Swagger documentation.
-
--font (string)
- See the pdf model in the Swagger documentation.
-
--orientation (string)
- See the pdf model in the Swagger documentation.
-
--overflow (string)
- See the pdf model in the Swagger documentation.
-
--pagesize (string)
- See the pdf model in the Swagger documentation.
PDF Security Property Options
-
--allowassembly (boolean)
- See the pdf model in the Swagger documentation.
-
--allowcopying (boolean)
- See the pdf model in the Swagger documentation.
-
--allowmodification (boolean)
- See the pdf model in the Swagger documentation.
-
--allowprinting (boolean)
- See the pdf model in the Swagger documentation.
-
--masterpassword (string)
- See the pdf model in the Swagger documentation.
-
--openpassword (string)
- See the pdf model in the Swagger documentation.
Mail Options
-
--bcc (string)
- See the mail model in the Swagger documentation.
-
--body (string)
- See the mail model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
-
--bodyfile (string)
- See the mail model in the Swagger documentation. The contents of the file are read and escaped properly for --body. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
-
--carboncopy (string)
- See the cc property the mail model in the Swagger documentation.
-
--from (string)
- See the mail model in the Swagger documentation.
-
--html (string)
- See the mail model in the Swagger documentation.
-
--subject (string)
- See the mail model in the Swagger documentation.
-
--to (string)
- See the mail model in the Swagger documentation.
Platform-encoding Options
Debug Visualization Options
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Examples
- Perform a stateless transaction that submits a job using the --command option. It shows the status of jobs with the same name, sorting so the most recent is shown first. The --enumvalue option is requesting the top 5 lines. The query parameter -q is requesting the message array that will contain the submit result, lines of output, and the array of jobs submitted in this session. The --commanddata option supplies the JCL to submit referred to by the "api-array". The "\n" are line separators an editor would supply.
Example:
* `$ zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddata "//IEFBR14 JOB IEFBR14,'IEFBR14',CLASS=A,MSGCLASS=H\n//EXEC EXEC PGM=IEFBR14\n//"`
- Perform the same stateless transaction above but use the --commanddatafile option to read a file from the workstation. If EJES_SUBMIT_PATH is defined in the environment, that will be used as the file path, otherwise the same directory the CLI is run in will be used if a full path is not supplied.
Example:
* `$ zowe ejes api exec --command "submit api-array;st iefbr14;sort time d;upd" --enumvalue 5 -q message,lines,submittedJobs --rfj --commanddatafile "iefbr14.jcl"`
- Perform a stateful request. In this case, a previous request positioned the (E)JES api in a job browser. This example downloads the file as PDF using the -d option. It causes the carriage control symbols to be interpretted with the --cc option. Then specifies stateful session with the cookie it generated specified on the --cookie option. The sysout is download to a file with the name consistent with the browsed data set or browser. If EJES_DOWNLOAD_PATH exists in the environment, the path is used for the download. Otherwise, the file is created in the current working directory. (For managed cookie stateful request examples, issue: Zowe ejes api -h)
Example:
* `$ zowe ejes api exec -d text --cc interpret --cookie "EJESWEB_54761=B6910D...;path=/EjesWeb;Secure;HttpOnly"`
Creates an API session and optionally issues an API command. Returns items as requested by the -q and -c options. A Set-Cookie header is included in the response. The value of the returned cookie identifies the session and should be supplied as an argument on the --cookie option on subsequent API data, exec, and term requests. Cookies can be managed for you. See the --cookie option for details. Close the session with an API term request when it is no longer needed to free up system resources. Sessions that are idle for more than two minutes will be automatically closed. See the (E)JES REST API swagger documentation for details on the mapped options. Enclose all option arguments in double quotes if they include spaces, semicolons, or symbols that are reserved in your terminal shell or if they might otherwise be ambiguous to the shell.
For a command group overview, issue: zowe ejes api -h
Usage
zowe ejes api init [options]
Query Item Options
-
--authorization (string)
- If you do not specify the --cookie option, you must include --user and --password or this option. The base64 encoded authentication string can be of the form userid:password or userid:group:password. If supplied, it overrides the profile user and password settings and starts a new session.
-
--cookie (string)
-
Supply the cookie output by a stateful request. This option supports optional syntax to enable automatic management of the cookie without scraping from stdout.
--cookie [<cookie-value>|read[<pin>]|write[<pin>]
The CLI can manage a stateful cookie transaction proactively. On the init, specify --cookie write or --cookie write-pin where pin can be any alphanumeric string. On the exec, cancel-download, and term specify --cookie read or --cookie read-pin. The cookie generated by the host is managed in the user's work directory. A pin is required only when there are multiple simultaneous sessions.
-
-c (string)
-
A list of comma separated, case-insensitive names of columns to include in the response. If omitted, all columns for the current tabular display are included.
This parameter only applies to enumerated data containing columns, specifically, the columns and rows items of the q parameter.
Limiting the included columns to only those you need can dramatically improve the resonse time of the request and significantly reduce system resources.
-
-q (string)
-
A list of comma separated, case-insensitive items to include in the response. If omitted, no items are included.
Limiting the included items to only those you need can improve response time.
The following items are supported: columns, environment, execParms, find, function, initParms, jobs, keys, lines, loginfo, rows, lineCommands, message, notice, platformEncoding, position, screen, submittedJobs, userLog, and version. These represent the response properties as described in the models section of this help. The value all can be used to include all of the above items, but generally you should only request the items you need.
Init Request Options
-
--casKey (string)
- See the initParms model in the Swagger documentation.
-
--columns (string)
- See the initParms model in the Swagger documentation.
-
--extractdd (string)
- See the initParms model in the Swagger documentation.
-
--ipaddress (string)
- See the initParms model in the Swagger documentation.
-
--luName (string)
- See the initParms model in the Swagger documentation.
-
--patterndd (string)
- See the initParms model in the Swagger documentation.
-
--rows (string)
- See the initParms model in the Swagger documentation.
-
--subsystem (string)
-
--useragent (string)
- See the initParms model in the Swagger documentation. Shows on the (E)JES Session panel and is a best practise to use.
Exec Request Options
-
--command (string)
- See the execParms model in the Swagger documentation. The argument is a (E)JES command stack. Refer to chapter 5 of the (E)JES Reference.
-
--commanddata (string)
- See the execParms model in the Swagger documentation. Insert "\n" in the string to indicate line breaks.
-
--commanddatafile (string)
- See the execParms model in the Swagger documentation. The contents of the file are read and escaped properly for --commanddata. Uses EJES_SUBMIT_PATH for the path if it exists in the environment.
-
--enumtime (number)
- See the execParms model in the Swagger documentation.
-
--enumvalue (number)
- See the execParms model in the Swagger documentation.
-
--showhiddencolumns (boolean)
- See the execParms model in the Swagger documentation.
-
--translatescreen (boolean)
- See the execParms model in the Swagger documentation.
-
--waitforresponse (boolean)
- See the execParms model in the Swagger documentation.
Platform-encoding Options
Debug Visualization Options
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Examples
-
Initalize a session by using --command to display the status screen, then output the JCL of the first job. Use --enumValue to request 10 lines. The option -q requests the message array, lines of output, and the function array. Though browsed output is requested, if the first job does not have JCL, the status screen will be returned to show that the job that did not meet the criteria. The --rfj option visualizes the output as JSON. Without it, the CLI returns only the cookie.
Example:
zowe ejes api init --command "status;1 j" --enumvalue 10 -q message,lines,function --rfj
Terminates the API session.
For a command group overview, issue: zowe ejes api -h
Usage
zowe ejes api term [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Examples
- Terminate an existing session by specifying the session on the --cookie option. No output is returned if the transaction completes without error.
Example:
* `$ zowe ejes api term --cookie "EJESWEB_54761=0F6E5A...;path=/EjesWeb;Secure;HttpOnly"`
The (E)JES batch interface provides much of the power of the on-line environment to automated programs or scripts.
Using the batch interface, procedures may be created that issue commands or alter other resources based upon the condition of jobs in the JESplex and the contents of spool information (e.g., reports, condition codes, JES messages) produced by those jobs. System housekeeping functions containing (E)JES batch procedures may be submitted at scheduled times, on demand, or when certain system conditions are met. Practically any function that requires access to spool or other (E)JES-provided information can be automated.
Display jobs in all active address spaces for the JESplex or sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch activity [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display APF-authorized libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch apfds [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display job classes defined for the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch class [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Issues a starting command stack. It connects to the host and allows you to use an enhanced set of EJES BATCH commands.
Usage
zowe ejes batch cmdstack <parameter-list> [options]
Positional Arguments
-
parameter-list (string)
- A required command stack enclosed in double-quotes. The command stack may contain meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For information about (E)JES host primary commands and their parameters, read Chapter 5 (E)JES Commands in the (E)JES Reference.
Options
-
--blanks | -b (string)
- Display blank lines to stderr (starts with blanks on)
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--resume | -r (array)
- For use with the pause meta command. Use "off" to prevent resuming an auto pin session.
-
--screen | -s (array)
- Display host screen output to stderr.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display the long command processor, then enter the EJES Batch Shell.
Usage
zowe ejes batch command [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of Dependent Job Control networks in the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch djc [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of MVS dynamic exits defined within the current sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch dynexit [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of WLM enclaves defined within the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch enclave [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of information about ENQs and RESERVEs in the sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch enq [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of information about ENQ contention in the sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch enqc [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of information about ENQ SYSDSN resources in the sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch enqd [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display the (E)JES entry panel, then enter the EJES Batch Shell.
Usage
zowe ejes batch entry [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of Functional Subsystems defined for the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch fss [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of Generalized Main Scheduler parameters for job class groups in the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch group [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the about checks registered with IBM Health Checker for z/OS, then enter the EJES Batch Shell.
Usage
zowe ejes batch hcheck [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the sysout in the Hold queue, then enter the EJES Batch Shell.
Usage
zowe ejes batch hold [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of JES2-managed batch initiators defined for the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch init [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of all jobs in the JESplex that are in pre-execution and execution status, then enter the EJES Batch Shell.
Usage
zowe ejes batch input [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of JES images in your z/OS JESplex, then enter the EJES Batch Shell. A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex.
Usage
zowe ejes batch jesplex [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the active job groups in the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch jgroup [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the lines that connect NJE nodes to your JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch line [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch lnklst [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display the log, then enter the EJES Batch Shell. You may optionally specify operlog or syslog, or command stack 'logattr on' to see the operlog display in MCS Console colors.
Usage
zowe ejes batch log [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch lpalst [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues, then enter the EJES Batch Shell.
Usage
zowe ejes batch mds [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of real and virtual memory requirements of jobs and other tasks running within your sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch memusage [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display or control the (E)JES menu, then enter the EJES Batch Shell.
Usage
zowe ejes batch menu [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of mounted file systems within the sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch mounts [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of NJE (Network Job Entry) connection, then enter the EJES Batch Shell.
Usage
zowe ejes batch netconn [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of NJE network servers, then enter the EJES Batch Shell.
Usage
zowe ejes batch netserv [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues, then enter the EJES Batch Shell.
Usage
zowe ejes batch nje [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the NJE nodes defined to the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch node [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Start or resume a session with no operation. Most useful in conjunction with --resume.
Usage
zowe ejes batch nop [options]
Options
-
--blanks | -b (string)
- Display blank lines to stderr (starts with blanks on)
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--resume | -r (array)
- For use with the pause meta command. Use "off" to prevent resuming an auto pin session. Most useful in conjunction with --resume.
-
--screen | -s (array)
- Display host screen output to stderr.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the JES2 spool offload devices in your JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch offload [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of sysout in the JES2 Output queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.
Usage
zowe ejes batch Output [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of paging resources defined to the systems in your sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch pageds [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of information about system parameter libraries defined to the systems in your sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch parmlib [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch printer [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of information about your JES proclib concatenations, then enter the EJES Batch Shell.
Usage
zowe ejes batch proclib [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of z/OS UNIX processes running in the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch pstatus [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display displays or primary commands your credentials authorize, then enter the EJES Batch Shell. The positional operand is required and may be 'auth' or 'auth display'.
Usage
zowe ejes batch query <parameter-list> [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of JES resources for the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch resmon [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the WLM Resources defined for the current sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch resource [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the WLM Scheduling Environments defined for the current sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch schenv [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of all active (E)JES sessions, then enter the EJES Batch Shell.
Usage
zowe ejes batch session [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Starts the EJES Batch Shell without logging on. It allows you to connect to the host and use an enhanced set of EJES BATCH commands.
Usage
zowe ejes batch shell [options]
Options
-
--blanks | -b (string)
- Display blank lines to stderr (starts with blanks on)
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--resume | -r (array)
- For use with the pause meta command. Use "off" to prevent resuming an auto pin session.
-
--screen | -s (array)
- Display host screen output to stderr.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the SPOOL partition configuration of your JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch spart [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the SPOOL volume extent configuration of your JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch spvol [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display jobs in the JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch status [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of all the MVS subsystems defined to the systems in your sysplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch subsys [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space, then enter the EJES Batch Shell.
Usage
zowe ejes batch symbol [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, an invocation system selection override, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the sysout class configuration for your JESplex, then enter the EJES Batch Shell.
Usage
zowe ejes batch syscls [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of the connected system images in your z/OS sysplex, then enter the EJES Batch Shell. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).
Usage
zowe ejes batch sysplex [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain an invocation system selection override and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF), then enter the EJES Batch Shell. Outstanding replies and action messages for the entire sysplex are shown.
Usage
zowe ejes batch sysreq [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display the user log console browser, then enter the EJES Batch Shell. The optional parameter allows you to specify a console name other than that which would normally be chosen automatically. Please refer to the CONSOLE command documentation for considerations when specifying a console name.
Usage
zowe ejes batch ulog [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of sysout in the JES3 Writer queue, then enter the EJES Batch Shell. The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.
Usage
zowe ejes batch writer [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Display a table of sysout data sets created by JES3 internal facilities, then enter the EJES Batch Shell.
Usage
zowe ejes batch zero [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, and/or a command stack. The command stack may contain both host commands and meta commands like echo and download. For a list of meta commands, use the option --helpApp meta. For invocation parameters, see the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
Options
-
--blanks | -b (array)
- Display blank lines to stderr (screen on). Off by default. Specify with no argument to turn on.
-
--cmdstack | -c (string)
- Start with a host command stack, separated by semicolons and enclosed in quotes.
-
--autoupdate | -a | --aup (array)
- Append the UPDATE command to the command stack when you press enter (if it doesn't end with an UPDATE). Not recommended when issuing FIND requests. Off by default. Specify with no argument to turn on.
-
--debug | --dbg | --dv | --debug-value (number)
- Specify a numeric debugging mode.
-
--echo | -e (array)
- Display host screen output to stdout. Off by default. Specify with no argument to turn on.
-
--inactivity | -i (number)
- Specify host activity timeout in minutes (starts set to 2).
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--screen | -s (array)
- Display host screen output to stderr. Off by default. Specify with no argument to turn on.
-
--terminal | -t (string)
- Set terminal emulation size or type. String: [*|[<number>[,|x] <number>]|[2|3|4|5]
-
--quiet | -q (array)
- Prevent output of interactive details, including version title on start and exit code on exit.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Issue a system command by sending the positional parameters to the host. (E)JES will respond with output sent to your user log.
Submit a job from the local host with the local: prefix, or a MVS data set or z/OS UNIX path. Responds with submission messages and a table providing a description of a successful submission.
Usage
zowe ejes issue submit <command> [options]
Positional Arguments
-
command (string)
- Any of MVS data set name, z/OS UNIX path name, or a workstation file prefixed by 'local:'. The environment variable EJES_SUBMIT_PATH is used to provide a path for a local workstation file if only a file name is provided. When not present, the current working directory is used instead. While the use of the command line options below is recommended, you may instead append to the command string arguments for the submit command listed in the (E)JES Reference.
Options
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Examples
Issue a system command and receive console output as a report in text format.
Usage
zowe ejes issue syscmd <command> [options]
Positional Arguments
-
command (string)
- System console command enclosed in double-quotes. If you wish to issue multiple commands, follow each command with a semicolon and a slash(;/)
Options
-
--debug | --dbg (number)
- Specify a numeric debugging mode.
-
--dry-run | -n (array)
- Run under dry-run protocols.
-
--jes2 | -2 (boolean)
- Use the JES2 spooler instead of the default spooler.
-
--jes3 | -3 (boolean)
- Use the JES3 or JES3plus spooler instead of the default spooler.
-
--lines | -y (string)
- Maximum lines in a table or report. [1000 | tty-default | number | all]
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
-
--width | -x (string)
- Maximum characters per line or row. [tty-default | number | all]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
Profile Options
Examples
-
Display the time:
zowe ejes issue syscmd "d t"
-
Display time and ppt:
zowe ejes issue syscmd "d t;/d ppt"
Output the tail end of the host log to stdout, optionally streaming new records. Positioning, searching, and limiting options are supported, including specifying which log type and what system.
Outputs the operations log or system log to stdout. Behaves like a Linux tail function with support for standard tail options --follow (-f), --lines (-n), -q, -v, and --version.
Set the position in the log to begin output using \-\-find, \-\-line, \-\-time, and \-\-offset.
Use OPERLOG Message Filtering Options to create a windowed log by filtering for and outputting only lines that fit criteria, e.g., fetch only lines associated with an IAT6xxxx message by specifying: \-\-msgId "IAT6\*". After filtering the log, output is positioned at the bottom. Use position options to change that.
Turn on highlighting for \-\-find using \-\-hilite. Perform regex text matching with highlighting using \-\-match. Enable MCS console color emulation with \-\-mcs. To prevent ANSI escape characters from being output and to instead use accessibility\-friendly text\-only indicators, specify: \-\-nocolor "on".
The order of host commands issued during initialization are fixed in this program in this order:
-
All OPERLOG message filtering options, e.g., --msgId and --msgTxt
-
--line
-
--time
-
--find
-
--offset
Conceptually and depending on specified options, the program can create a window into the log data using message filtering options, then can point to a line in the data such as the first line, then can position at a time, then find arbitrary text, then offset the view up and down by seconds to days or a number of lines.
The program outputs trailer diagnostic lines at the end of the run to stderr. Use this information to make your queries more efficient. The trailer and header lines can be muted using the --quiet (-q) option or setting the EJES_LOG_CLI_QUIET environment variable. The program outputs a bottom-of-data line to stdout that is considered an output line by --lines with a line-count argument. To disable it, set the EJES_LOG_CLI_NO_BOTTOM environment variable.
Usage
zowe ejes log stream [log-type] [options]
Positional Arguments
-
log-type (string)
- Optional. If not specified, the Operations Log is output if the Operations Log is active for the current MVS system. Otherwise, the System Log is output. Must match regular expression:
operlog|oper|o|syslog|sys|s
Options
ANSI Color Options
Find String and Position Options
Positioning Options
-
--line (array)
-
Position at a specific line in the log. With no argument, it positions to top of the displayable log (like the TOP command). Positioning done before --time, --find, and --offset.
Allowed values: first, last, ^[1-9]\d*$
-
--head (boolean)
- Position at top of log same as --line without an argument. Positioning done before --time, --find, and --offset.
-
--time (array)
-
Positions a time on the current day or to a time and date. With no argument, positions to the beginning of the day. Positioning done before --find and --offset, but after --line.
The argument is hh:mm:ss:th\-date, where ss or ss:th and the date are optional.
The date, if specified, is specified as yyyy.ddd, yyyy-ddd, yyyy/mm/dd, yyyy/dd/mm, mm/dd/yyyy, dd/mm/yyyy, yyyy-mm-dd, yyyy-dd-mm, mm-dd-yyyy, or dd-mm-yyyy. The Julian date form is always valid.
The Gregorian date form depends upon your current date format setting, though both slash (/) and dash (\-) are accepted as separator characters. Specify "?" to return the Gregorian date format and quit, i.e., \-\-time "?"
Two copy\-paste date\-time formats are supported. A date\-time may copied from the log and pasted, enclosed in quotes, after the \-\-time option. Operlog: "yyyydddd hh:mm:ss.th". Syslog: "yyyyddd hhmmsst".
Allowed values: (?:^(20\d{5}) (\d{7})$)|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|(?:^(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3}$)|(?:^\d{4}(?:[\/|-]\d{2}){2}$)|(?:^(?:\d{2}[\/|-]){2}\d{4})))*){0,1}$|^\?$)
Positioning Offset Options
-
--offset | --off (array)
-
Offset positioning by time or line count after the final position arrived at by message filtering, --line, --time, and --find. Optional directional indicators are next or + (later in log) or prev (earlier). If the directional indicator is omitted, earlier in the log is assumed. Valid trailing time indicators are s, m, h, or d. A number without a time indicator assumes h on OPERLOG, but on SYSLOG positions by adding to the current data set number (if 0, it positions at the top of the current data set). The l indicator is a line count indicator. Specify this to offset by n lines. Without an argument, prev4l is assumed, which is helpful when specifying --find to provide context even when -n 10 (the default) is specified.
Allowed values: ^(\+|next|prev)*(\d+[smhdl]{0,1})$
OPERLOG Message Filtering Options
-
--system-name | --systemName | --sysname | --sn (array)
- Filter for up to 4 provided system name(s). Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time of the OPERLOG browser can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
-
--job-name | --jobName | --jname | -j (array)
- Filter OPERLOG for up to 4 provided job names. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
-
--job-id | --jobId | --jid (array)
- Filter OPERLOG for up to 4 provided job ids, e.g, J0632369. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
-
--console | --con (array)
- Filter OPERLOG for up to 4 provided consoles. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
-
--message-id | --messageId | --msgId | --mi (array)
- Filter OPERLOG for up to 3 provided message ids of up to 12 characters. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
-
--message-text | --messageText | --msgText | --msgTxt | --mtxt | --mx (array)
- Filter OPERLOG for message text of up to 34 characters. Multiline messages are output in their entirety. Generic (*) and placeholder (%) mask characters allowed. To filter for strings inside a message's text, use generic characters, e.g., "*logon*". Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
-
--routing-codes | --routingCodes | --routing | -r (array)
-
Filter OPERLOG for routing codes. Up to 34 characters that may be ALL, NONE, or a list of decimal routing codes or ranges. For example: 1,3,6-9,100-128. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
Default value: ALL
-
--descriptor-codes | --descriptorCodes | --descriptor | --dc (array)
-
Filter OPERLOG for descriptor codes. Up to 34 characters that may be ALL, NONE, or a list of decimal descriptor codes or ranges. For example: 1,3,6-9. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
Default value: ALL
-
--window-bottom | --windowBottom | --winBot | --wb | --bot | --high-time-date | --htd (array)
-
Filter OPERLOG by setting the time and optionally the date of the bottom of the log to use. Up to 23 characters.
The boundary specifications may be either fixed time\-date values, e.g."16:00:12:90\-2021/02/12" (see “Time\-Date Values” in the (E)JES Reference) or calculated relative to the time stamp associated with the record shown at 57 lines from the bottom of the log at start\-up.
A relative value is indicated by the presence of a next (\+) or previous preceding the boundary specification, e.g., prev1h. After the next or previous you may specify either a number of seconds, minutes, hours, or days as indicated by using a 's', 'm', 'h', or 'd' suffix. Assumes 'h' if omitted.
Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
Allowed values: ^(\+|next|prev)*(\d+[smhd]{0,1})$|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|^(?:(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3})|(?:\d{4}(?:[\/|-]\d{2}){2})|(?:(?:\d{2}[\/|-]){2}\d{4})))*){0,1}|\?)$
-
--window-top | --windowTop | --winTop | --wt | --top | --low-time-date | --ltd (array)
-
Filter OPERLOG by setting the time and optionally the date of the top of the log to use. Up to 23 characters.
The boundary specifications may be either fixed time\-date values, e.g."16:00:12:90\-2021/02/12" (see “Time\-Date Values” in the (E)JES Reference) or calculated relative to the time stamp associated with the record shown at 57 lines from the bottom of the log at start\-up.
A relative value is indicated by the presence of a next (\+) or previous preceding the boundary specification, e.g., prev1h. After the next or previous you may specify either a number of seconds, minutes, hours, or days as indicated by using a 's', 'm', 'h', or 'd' suffix. Assumes 'h' if omitted.
Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
Allowed values: ^(\+|next|prev)*(\d+[smhd]{0,1})$|(?:^(20\d{5}) ((\d\d:\d\d:\d\d.\d\d))$)|^(?:(\d\d\:\d\d(?:\:\d\d){0,2}(?:-(?:(?:\d{4}[.-]\d{3})|(?:\d{4}(?:[\/|-]\d{2}){2})|(?:(?:\d{2}[\/|-]){2}\d{4})))*){0,1}|\?)$
-
--mpf-exit-flags | --mpfExitFlags | --mpf (array)
-
Filter OPERLOG for MPF/Exit flags with a "value mask" of eight hexadecimal characters, e.g., 00000291. Use in conjunction with the "result directive" (see --result-directive).
The filtering is performed by ANDing the hexadecimal value mask against a message’s MPF/Exit Flags value and then displaying the message based upon the result directive (zero or non\-zero). For example, a mask and result directive of 00000001 and NZ will display messages that were suppressed by MPF. Specifying 00000001 and Z displays messages that were not suppressed.
Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display. Multiline messages are output in their entirety.
Default value: FFFFFFFF
Allowed values: ^[0-9A-F]{8}$, ^[0-9a-f]{8}$
-
--result-directive | --resultDirective | --rd (array)
-
Provide the result directive for the --mpf-exit-flags option (see the option for more information). A mask and result directive of 00000001 and NZ will display messages that were suppressed by MPF. A mask and result directive of 00000001 and Z displays messages that were not suppressed. Multiline messages are output in their entirety. Note: The response time can be seriously impacted by the use of filtering criteria that results in too few messages being considered for display.
Default value: NZ
Allowed values: NZ, Z, EQ, NE
Log Options
JES-type Options
-
--jes2 | -2 (boolean)
-
--jes3 | -3 (boolean)
-
--subsystem (string)
- Specify the JES spooler system to use instead of the default spooler.
EJES Connection Options
-
--protocol | --prot (string)
-
--host | -H (string)
- The (E)JES server host name.
-
--port | -P (number)
-
The (E)JES server port.
Default value: 443
-
--user | -U (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --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 (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
EJES CLI Runtime Options
-
--enum-value | --enumval | --ev (number)
-
--refresh-interval | --refreshInterval | --refresh | --ri | --sleep-interval | --sleep | -s (number)
-
--debug | --dbg | --dv | -d (number)
-
Invoke debugging code with additive flags. 1=request, 2=minimum response, 4=full response, 8=housekeeping, 16=show record info, 32=show fetch metadata.
Default value: 0
-
--detailed-json | --detailedjson | --detail | --dj (boolean)
Profile Options
Examples
-
Output 10 lines at the tail of the log:
zowe ejes log stream
-
Output 40 lines at head of the log with no header or trailer lines. The -n option is an alias for --lines and -q is an alias for --quiet:
zowe ejes log stream --head -n 40 -q
-
Stream the tail of the default log defined for your credentials until you press CTRL+C. The -f option is an alias for --follow:
zowe ejes log stream --follow
-
Stream the tail of the syslog:
zowe ejes log stream syslog --follow
-
Stream the tail of the operlog:
zowe ejes log stream operlog --follow
-
Match and highlight user logons in output lines. (NOTE: This does not position to the string; it *only* highlights them *if* they are in the output.) Match can also work with a simple string, or a regex string with no forward slash characters, implying the "ig" flags (ignore-case and global-match):
zowe ejes log stream --match "/[Ll]ogo.{1,2}|force|Signoff/g"
-
Match and mark user logons without ANSI color escape sequences. The --nc option is an alias for --no-color:
zowe ejes log stream --match "/[Ll]ogo.{1,2}|force|Signoff/g" --nc on
-
Find your logon Id in the log:
zowe ejes log stream --find yourLogonId
-
Find your logon Id in the log and highlight the found text:
zowe ejes log stream --hilite --find yourLogonId
-
Find your logon id in the log with a few lines above it for context. The --offset option is down 4 lines (prev4l) if the argument is not specified:
zowe ejes log stream --find yourLogonId --offset
-
Find your TSO logons and logoffs for today by specifying you logon id followed by "- log" in the log. Note that if the find string includes spaces or special characters, you need to enclose it in single-quotes. Find without a find without a search type uses NEXT, searching forward from a position. Using the --time option without an argument positions to the start of the current day before finding. Without the --time option, the default position is 53 lines from the bottom. (NOTE: The space after the trailing apostrophe and before the double quote is a work-around for a zowe parsing issue.):
zowe ejes log stream --find "'yourLogonId - log' " --time
-
Find your unix home directory in the log. Note that if find string is case sensitive, you need to enclose it in single-quotes prefixed with the letter c, e.g., c'String':
zowe ejes log stream --find "c'DSN=/u/userName' last"
-
Find beginning of speed boost with highlighting:
zowe ejes log stream --find "'speed boost is active' first" --hilite
-
Find beginning of speed boost but mark found lines without ANSI color escape sequences. The --ht option is an alias for --hilite and --nc is an alias for --no-color:
zowe ejes log stream --find "'speed boost is active' first" --ht --nc on
-
Find all speed boost messages with highlighting and only output found lines:
zowe ejes log stream --find "'speed boost is active' first" --ht --only -n all
-
Find all speed boost messages with highlighting and output five lines of context (the default):
zowe ejes log stream --find "'speed boost is active' first" --ht --only --context -n all
-
Filter for IPL and boost informational messages that appear in the IEA681I message. The message can include generic characters to specify classes or subclasses of messages. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:
zowe ejes log stream --msgId "IEA681I"
-
Filter for all informational IEA messages. The % character is a placeholder that matches any character. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:
zowe ejes log stream --msgId "IEA%%%I"
-
Filter for "boost" in the text of any message. Note the use of the generic character * that matches any number of characters before or after the string. These are necessary for this type of search. The entire multiline message is output if the message is multiline. Other OPERLOG filtering options can be found under Message Filters Options:
zowe ejes log stream --msgTxt "*boost*"
-
Filter using descriptor codes for audible alarm errors and warning messages with MCS console color emulation on. The program will beep.The option --dc is an alias for --descriptorCodes. OPERLOG filtering options can be found under Message Filt ers Options:
zowe ejes log stream --descriptorCodes "1,2,11" --mcs
-
Find all system messages that required action for the hour after midnight. Specifying --only shows just found lines. Specifying --lines with "1h" tells the program to output lines up to one hour from the first line output. The --top option here specifies a time without a date, which means the current day. This logically sets the top of the log, windowing it, to midnight today (with no lines above it). Specifying --find with the first verb tells to search from the top. The character in the find string has a special meaning indicating that a message requires action. The special characters "|", "-", "@", " * ", and "+" can be indexed from column 54 and " * " is a column 4 character, thus 58 below.
https://www.ibm.com/docs/en/zos/2.4.0?topic=consoles\-special\-screen\-characters:
zowe ejes log stream --find "'*' first 58 58" --only --top "00:00" --lines 1h
-
Same result as previous example but with different options and colorized to emulate an MCS color console. Specifying --time without an argument positions at the beginning of the current day. The difference from above is that --top sets the first line of the log the program sees and positions at the bottom. The --time option positions before --find runs. No directional argument is specified on the --find option so it runs starting as positioned by the --time option.:
zowe ejes log stream --find "'*' 58 58" --only --time --lines 1h --mcs
-
Stream the tail of the log until you press CTRL+C. The -f option is an alias for --follow:
zowe ejes log stream --follow
Query the host using (E)JES. Return host spool, dataset, and library tables. Return browsable data as reports. Query commands specify which primary table to query. Each primary table may also have child tables or child reports you can query using the --table and/or --report options. You can access only those primary tables you are authorized to use. Issue these commands as an introduction: (1) "zowe ejes query list" to show available tables.(2) "zowe ejes query status --owner help" to demonstrate how to find how it all works. (3) "zowe ejes query status --owner list" to demonstrate how to find appropriate arguments. (4) "zowe ejes query status --owner myuserid --sort time d" to view a sorted table of your jobs.(5) "zowe ejes query status --owner myuserid --sort time d --report " to view the first job in report form (truncated to your screen).
Select a table of all the jobs in all active address spaces for the JESplex or sysplex.
Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query activity [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- AC. List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query activity --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query activity --metafilter help`
Select a table of APF-authorized libraries defined to the systems in your sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query apfds [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query apfds --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query apfds --metafilter help`
Select table of job classes defined for the JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query class [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query class --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query class --metafilter help`
Select a table of Dependent Job Control networks in the JESplex.
Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query djc [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query djc --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query djc --metafilter help`
Select a table of MVS dynamic exits defined within the current sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query dynexit [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query dynexit --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query dynexit --metafilter help`
Select a table of WLM enclaves defined within the JESplex.
Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query enclave [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query enclave --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query enclave --metafilter help`
Select a table of information about ENQs and RESERVEs in the sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query enq [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query enq --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query enq --metafilter help`
Select a table of information about ENQ contention in the sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query enqc [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query enqc --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query enqc --metafilter help`
Select a table of information about ENQ SYSDSN resources in the sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query enqd [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters and/or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query enqd --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query enqd --metafilter help`
Select a table of Functional Subsystems defined for the JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query fss [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query fss --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query fss --metafilter help`
Select a table of Generalized Main Scheduler parameters for job class groups in the JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query group [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query group --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query group --metafilter help`
Select a table of the about checks registered with IBM Health Checker for z/OS.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query hcheck [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Select a table of the sysout in the Hold queue.
Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query hold [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query hold --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query hold --metafilter help`
Select a table of JES2-managed batch initiators defined for the JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query init [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query init --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query init --metafilter help`
Select a table of all jobs in the JESplex that are in pre-execution and execution status.
Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query input [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query input --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query input --metafilter help`
Select a table of JES images in your z/OS JESplex.
A JES2 JESplex is also known as a Multi-Access SPOOL configuration or MAS. A JES3 JESplex is also known as a JES3 complex. Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query jesplex [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query jesplex --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query jesplex --metafilter help`
Select a table of the active job groups in the JESplex.
Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query jgroup [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query jgroup --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query jgroup --metafilter help`
Select a table of the lines that connect NJE nodes to your JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query line [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query line --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query line --metafilter help`
Display a list of all the primary display tables you are authorized to query on the host.
Usage
zowe ejes query list [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Select a table of data sets in the link list concatenation of the link list libraries defined to the systems in your sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query lnklst [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query lnklst --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query lnklst --metafilter help`
Select a table of data sets in the LPA concatenation of the link pack libraries defined to the systems in your sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query lpalst [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query lpalst --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query lpalst --metafilter help`
Select a table of jobs in the JESplex that are currently delayed in one of the Main Device Scheduler queues.
Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query mds [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query mds --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query mds --metafilter help`
Select a table of real and virtual memory requirements of jobs and other tasks running within your sysplex.
Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query memusage [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query memusage --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query memusage --metafilter help`
Select a table of mounted file systems within the sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query mounts [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query mounts --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query mounts --metafilter help`
Select a table of NJE (Network Job Entry) connections.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query netconn [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query netconn --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query netconn --metafilter help`
Select a table of NJE network servers.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query netserv [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query netserv --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query netserv --metafilter help`
Select a table of sysout in the Bulk Data Transfer and TCP/IP NJE queues.
Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query nje [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query nje --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query nje --metafilter help`
Select a table of the NJE nodes defined to the JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query node [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query node --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query node --metafilter help`
Select a table of the JES2 spool offload devices in your JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query offload [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query offload --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query offload --metafilter help`
Select a table of paging resources defined to the systems in your sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query pageds [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query pageds --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query pageds --metafilter help`
Select a table of information about system parameter libraries defined to the systems in your sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query parmlib [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query parmlib --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query parmlib --metafilter help`
Select a table of JES writers which drive local, FSS, and signed-on/logged-on remote printer and punch devices attached to the JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query printer [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query printer --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query printer --metafilter help`
Select a table of information about your JES proclib concatenations.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query proclib [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query proclib --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query proclib --metafilter help`
Select a table of z/OS UNIX processes running in the JESplex.
Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query pstatus [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters, invocation primary selection criteria, or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query pstatus --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query pstatus --metafilter help`
Select a table of JES resources for the JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query resmon [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query resmon --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query resmon --metafilter help`
Select a table of the WLM Resources defined for the current sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query resource [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query resource --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query resource --metafilter help`
Select a table of the WLM Scheduling Environments defined for the current sysplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query schenv [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query schenv --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query schenv --metafilter help`
Select a table of all active (E)JES sessions.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query session [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query session --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query session --metafilter help`
Select a table of the SPOOL partition configuration of your JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query spart [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query spart --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query spart --metafilter help`
Select a table of the SPOOL volume extent configuration of your JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query spvol [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query spvol --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query spvol --metafilter help`
Select a table of all jobs in the JESplex.
Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query status [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query status --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query status --metafilter help`
Select a table of all the MVS subsystems defined to the systems in your sysplex.
Use Primary Selection options to modify which rows are included in a table (for example, --sysnames sys* includes only systems starting with "sys"). Use General Use options to narrow your selected rows further. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query subsys [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the selection columns available for this table.
The "list" argument may be used on any option. A descriptive table for that option will be displayed and any other work will stop. The table may display available columns or positional input fields depending on the option.
Example:
* `$ zowe ejes query subsys --select list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query subsys --metafilter help`
Select a table of z/OS system symbols as well as JES and JCL symbols defined for the current address space.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query symbol [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query symbol --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query symbol --metafilter help`
Select a table of the sysout class configuration for your JESplex.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query syscls [options]
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query syscls --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query syscls --metafilter help`
Select a table of the connected system images in your z/OS sysplex. In a monoplex, you manage the current system only (i.e., the image on which your (E)JES session is executing).
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query sysplex [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain an invocation system selection override. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query sysplex --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query sysplex --metafilter help`
Select a table of outstanding replies and messages retained by the MVS Action Message Retention Facility (AMRF). Outstanding replies and action messages for the entire sysplex are shown.
Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query sysreq [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other wor`k will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query sysreq --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query sysreq --metafilter help`
Select a table of sysout in the Output queue (JES2) or Writer queue (JES3). The interchangeable terms Output queue and Writer queue are used by the two JESes to describe the queue from which JES-managed or FSS-managed printers can select work.
Use Primary Selection options to modify which rows are included in a table (for example, --jobname sys* includes only jobs starting with "sys"). Use General Use options to narrow your selected rows further. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query writer [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query writer --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query writer --metafilter help`
Select a table of sysout data sets created by JES3 internal facilities.
Use Use General Use options like --select and --metafilter to modify which rows are included in your table. Use --table to drill down to a child table and --report to output the contents of a spool data set, a MVS data set, or report instead of the table. Use --command to issue commands against the rows included in the table.
Usage
zowe ejes query zero [parameter-list] [options]
Positional Arguments
-
parameter-list (string)
- Optional list enclosed in double-quotes. May contain optional parameters or invocation primary selection criteria. See the (E)JES Reference Manual for information for the corresponding command for details about content and the list's internal order.
EJES Connection Options
-
--protocol | --prot (string)
-
Protocol used to access (E)JES server.
Default value: https
Allowed values: http, https, list, help
-
--host (string)
- The (E)JES server host name.
-
--port (number)
-
The (E)JES server port.
Default value: 443
-
--user (string)
- Mainframe (E)JES user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (E)JES password, which can be the same as your TSO password.
-
--reject-unauthorized | --rejectunauthorized | --ru (boolean)
-
--base-path | --basepath | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all (E)JES resources when making REST requests.
-
--color-scheme | --scheme | --cs (string)
-
Accessibility option: Specify the name of a color scheme. User scheme files may also be created and specified to provide better contrast or to favor easier to see colors. For a how-to, use "zowe ejes emulate batch --helpApp scheme-info". Zowe ejes log stream ignores this option as it outputs plain text by default, only colorizing when ANSI color options are specified.
Allowed values: dark, light, powershell, nono, none, user-scheme-file, list, help
Default value: dark
-
--no-color | --nocolor | --nc (string)
- Accessibility option: Specify to prevent colorization of the CLI. Same effect as defining NO_COLOR or FORCE_COLOR=0.
General Use Options
General Primary Selection Options
-
--dest (string)
-
Establish up to 8 destination filters. Filters these tables: hold, hold datasets, writer (output), writer datasets, job status, job status datasets, and job zero.
Allowed values: off, destination-mask(s), list, help
-
--jobclass (string)
-
Establish up to 4 job class filter masks. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, jobclass-mask(s), list, help
-
--jobname | -j (string)
-
Establish up to 8 job name filter masks. Filters these tables: activity, input, hold, writer (output), nje, status, and mds.
Allowed values: off, jobname-mask(s), list, help
-
--origin (string)
-
Establish up to 4 job origin filters. Filters these tables: activity, input, hold, writer (output), job status, mds, and nje.
Allowed values: off, origin-mask(s), list, help
-
--owner | -o (string)
-
Specify up to 8 owner masks.
Allowed values: off, name-mask(s), list, help
Query options
Command Processing Options
Job Submission Options
Debug and Test Options
Advanced Use Primary Selection Options
Advanced Use Options
Options
-
--subsystem (string)
- Name of the spooler to use instead of the default spooler.
Profile Options
Examples
- List the available table types for the child table.
The "list" argument may be used on any option. A table for that option will be displayed and any other work will stop. The table may display available tables, reports, columns, for positional input fields depending on the option.
Example:
* `$ zowe ejes query zero --table list`
- Provide detailed help for the metafilter option.
The "help" argument may be used on any option. Help for the option will be displayed and any other work will stop.
Example:
* `$ zowe ejes query zero --metafilter help`
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)
-
--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.
-
--charset | --char (string)
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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--backout (boolean)
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Endevor Web Services Health Check.
The check instance command triggers the web services health check for a given instance.
Usage
zowe endevor check instance [instance] [options]
Positional Arguments
-
instance (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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Confirm a manual conflict resolution inside an Endevor workspace file is complete.
Confirm a manual conflict resolution inside an Endevor workspace file is complete.
Usage
zowe endevor confirm resolution [workspace-file] [options]
Positional Arguments
-
workspace-file (string)
- An Endevor workspace file (full or relative path).
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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 or updating 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.
-
--backout (boolean)
-
--notes | -n (string)
-
--notes-from-file | --nff (string)
- Local file of notes for package.
-
--emergency-package | --ep (boolean)
- Specify if the package should be an emergency package. When not specified, the package is a standard package.
-
--sharable | --sh (boolean)
- Specify this option if the package can be edited by more than one person when in In-edit status.
-
--promotion | --pr (boolean)
- Specify this option to define the package as a promotion package.
-
--validate-scl | --vs (boolean)
endevor-location definition options
-
--maxrc (number)
-
--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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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 ", ".
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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 ", ".
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Initialize a directory as an Endevor workspace.
Initialize current directory as an Endevor workspace.
Usage
zowe endevor initialize workspace [workspace-dir] [options]
Positional Arguments
-
workspace-dir (string)
- The Endevor workspace directory, if different from current working directory.
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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 code-page-config command lists the EBCDIC code page mapping rules used by Endevor Web Services
Usage
zowe endevor list code-page-config [options]
endevor session definition options
-
--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
-
--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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 the contents of the main Endevor configuration table (C1DEFLTS)
Usage
zowe endevor list defaults [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
-
--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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 the contents of the Endevor ISPF dialog defaults table (ENDIECFG)
Usage
zowe endevor list dialog [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
-
--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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 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)
-
--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:
ALL - Full element information
BAS - Basic element information
ELE - Element change level summary
COMP - Component change level summary
When data=ALL --fo (full-output) always takes place unless there is a --rff (response-format-filter).
In all other cases default set of columns will be shown.
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 ", ".
endevor search text options
-
--search-text | --stext (string)
- Search string(s) separated with AND or OR. E.g.: string_1 AND string_2 AND string_3 OR string_4.
For complex search strings with quotation marks use search-text-file parameter.
-
--search-text-file | --stf (string)
- File which contains search string(s) separated with AND or OR. Recommended for complex search strings with quotation marks.
-
--search-in | --si (string)
-
2 letters describing where search should be performed:
es - Element Source
eh - Element History
ec - Element Changes
eu - Element Summary
cs - Components Source
ch - Components History
cc - Components Changes
cu - Components Summary.
Allowed values: es, eh, ec, eu, cs, ch, cc, cu
-
--search-from | --sf (number)
- Beginning interval of the column range for the search-text.
-
--search-to | --st (number)
- Ending interval of the column range for the search-text.
-
--search-ignore-case | --ic (boolean)
-
--search-in-binary | --bin (boolean)
- Should the text search be performed in binary elements.
-
--search-limit | --sl (number)
- Maximum search limit where 0 is NOLIMIT.
scl generation 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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 the contents of the Endevor optional features table (ENCOPTBL)
Usage
zowe endevor list features [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
-
--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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--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
output customization options
Profile Options
Base Connection Options
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--emergency-package | --ep (boolean)
- Specify if the package should be an emergency package. When not specified, the package is a standard package.
-
--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.
endevor-location definition options
-
--maxrc (number)
-
--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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 processor-groups command lists processor group information in Endevor
Usage
zowe endevor list processor-groups [proc-group] [options]
Positional Arguments
-
proc-group (string)
- Name of the Endevor processor group
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
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 processor-symbols command lists processor group symbol overrides information in Endevor
Usage
zowe endevor list processor-symbols [proc-group] [options]
Positional Arguments
-
proc-group (string)
- Name of the Endevor processor group
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
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 the Endevor site symbols
Usage
zowe endevor list symbols [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
-
--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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 asynchronous tasks submitted by this user
Usage
zowe endevor list tasks [task-id] [options]
Positional Arguments
-
task-id (string)
- The id of an asynchronous Endevor web service task.
asynchronous task options
-
--task-status (string)
-
Filter tasks by status: in-progress, finished or all.
Default value: all
Allowed values: inp, fin, all
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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 the contents of the Endevor type sequence
Usage
zowe endevor list type-sequence [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
-
--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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
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
output customization options
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
-
--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
asynchronous task options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
Merge Endevor elements from one Endevor location into another
Merge Endevor elements from one Endevor location into another. Requires an initialized Endevor workspace to perform conflict resolution. Use "synchronize workspace" command afterwards to push the result back into Endevor.
Usage
zowe endevor merge element [element] [options]
Positional Arguments
-
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
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
merge-location definition options
-
--merge-environment | --menv (string)
- Merge elements from this environment to the target environment (specified by 'environment'). Defaults to the same environment as the target.
-
--merge-stage-number | --msn (string)
- Merge elements from this stage number into the target stage number (specified by 'stage-number'). Defaults to the same stage number as the target.
-
--merge-system | --msys (string)
- Merge elements from this system into the target system (specified by 'system'). Defaults to the same system as the target.
-
--merge-subsystem | --msub (string)
- Merge elements from this subsystem into the target subsystem (specified by 'subsystem'). Defaults to the same subsystem as the target.
-
--merge-out-of-sync | --moos (boolean)
- Merge out-of-sync elements at the target location with their next version in the map, and attempt to resolve the out-of-sync during the next synchronization with Endevor.
workspace options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into the same element found in subsystem SUBTO (system, stage and env taken from current location profile):
zowe endevor merge element ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM
-
Merge any elements that are currently out of sync with their next element version up the map (map location determined by current profile):
zowe endevor merge element * --merge-out-of-sync
-
Report which elements are currently out of sync with their next element version up the map, but do not merge them yet (map location determined by current profile):
zowe endevor merge element * --merge-out-of-sync --dry-run
-
Merge all elements from system SYSFROM, subsystem SUBFROM into matching elements in system SYSTO subsystem SUBTO (system, stage and env taken from current location profile):
zowe endevor merge element * --system SYSTO --subsystem SUBTO --merge-system SYSFROM --merge-subsystem SUBFROM
-
Merge element ELEMENT1 of type COBPGM from subsystem SUBFROM into SUBTO, retrieving both elements using the provided ccid & comment, with signout, and overriding signout if necessary:
zowe endevor merge element ELEMENT1 --type COBPGM --subsystem SUBTO --merge-subsystem SUBFROM --ccid MYCCID --comment 'my comment' --signout --overrride-signout
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)
-
--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 ", ".
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
-
--headings (boolean)
- Specify it if you want to 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 ", ".
-
--charset | --char (string)
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
-
--headings (boolean)
- Specify it if you want to 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 ", ".
-
--charset | --char (string)
asynchronous task options
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
The print member command prints a member from a specified dataset.
Usage
zowe endevor print member <member> [options]
Positional Arguments
input sources options
options
asynchronous task options
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
asynchronous task 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
-
--signout (boolean)
- Specify if you want to perform the action with 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.
-
--get-fingerprint | --gfg (boolean)
-
--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 ", ".
-
--charset | --char (string)
output location options
-
--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
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
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)
- 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.
-
--file-extension | --ext (string)
-
The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:
none: File name is equal to element name, no extension is added.
file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.
type\-name: The type name is used as the file extension.
mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.
Default value: mixed
Allowed values: none, file-ext, type-name, mixed
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
Retrieve the result of an asynchronous task
Usage
zowe endevor retrieve result [task-id] [options]
Positional Arguments
-
task-id (string)
- The id of an asynchronous Endevor web service task.
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
endevor-location definition options
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
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)
-
--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 ", ".
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 CA 7 scheduler.
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
endevor-location definition options
-
--maxrc (number)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Synchronize remote Endevor inventory with the local Endevor workspace.
Synchronize a selected subset of remote Endevor inventory with a local Endevor workspace
Usage
zowe endevor synchronize workspace [workspace-dir] [options]
Positional Arguments
-
workspace-dir (string)
- The Endevor workspace directory, if different from current working directory.
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
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
workspace options
-
--element | --ele | --elem (string)
-
--dry-run | --dr (boolean)
- List all actions the synchronization would perform, without executing them.
-
--reset | --rst (boolean)
- Revert any local changes, resetting the local workspace to match the current state of the remote Endevor inventory.
-
--limit | --lim (number)
-
--one-way (boolean)
- Do not update Endevor elements with local changes, only retrieve remote changes from Endevor and resolve any conflicts.
-
--allow-deletes | --del (boolean)
- Allow workspace synchronization to delete unchanged Endevor elements when it detects the corresponding local files have been deleted. Default is off to maintain backward compatibility.
-
--file-extension | --ext (string)
-
The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:
none: File name is equal to element name, no extension is added.
file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.
type\-name: The type name is used as the file extension.
mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.
Default value: mixed
Allowed values: none, file-ext, type-name, mixed
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Synchronize all elements in the map location defined by the currently active endevor-location profile with current directory:
zowe endevor synchronize workspace
-
Synchronize all elements in the map location defined by the currently active endevor-location profile with workspace directory 'C:/projects/myWorkspace':
zowe endevor synchronize workspace 'C:/projects/myWorkspace'
-
Synchronize all elements in system SYSTEM1 subsystem SUBSYS1 from environment DEV stage 1, whose type begins with 'ASM', with current directory:
zowe endevor synchronize workspace --environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'
-
Synchronize all elements in the map location defined by the currently active endevor-location profile, whose name is 'PRFX' followed by any 2 characters and ending with '11', with workspace directory 'C:/projects/myWorkspace':
zowe endevor synchronize workspace 'C:/projects/myWorkspace' --ccid myccid --comment 'my changes' --element PRFX%%11
-
Display all actions needed to synchronize all elements in the map location defined by endevor-location profile 'mysandbox' with current directory, without performing them:
zowe endevor synchronize workspace --dry-run --endevor-location-profile mysandbox
-
Revert all local changes in the map location defined by the currently active endevor-location profile, resetting your workspace to match Endevor:
zowe endevor synchronize workspace --reset
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)
-
--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.
-
--override-signout | --os (boolean)
- Specify if you want to override the Signout of an Endevor element 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.
asynchronous task 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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Remove a synchronized Endevor inventory from a local Endevor workspace and delete any related metadata.
Remove a selected subset of remote Endevor inventory from a local Endevor workspace
Usage
zowe endevor unsynchronize workspace [workspace-dir] [options]
Positional Arguments
-
workspace-dir (string)
- The Endevor workspace directory, if different from current working directory.
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
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
workspace 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Remove all elements in the map location defined by the currently active endevor-location profile from current directory:
zowe endevor unsynchronize workspace
-
Remove all elements in the map location defined by the currently active endevor-location profile from current directory, throwing away any local changes not saved in Endevor:
zowe endevor unsynchronize workspace --force
-
Remove all elements in the map location defined by the currently active endevor-location profile from workspace directory 'C:/projects/myWorkspace':
zowe endevor unsynchronize workspace 'C:/projects/myWorkspace'
-
Remove all elements in system SYSTEM1 subsystem SUBSYS1 environment DEV stage 1, whose type begins with 'ASM', from current directory:
zowe endevor unsynchronize workspace --environment DEV --stage_number 1 --system SYSTEM1 --subsystem SUBSYS1 --type ASM* --ccid myccid --comment 'my changes'
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)
-
--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.
-
--charset | --char (string)
-
--sync | -s (boolean)
- Specify if you want to synchronize source and current level of the Elements while performing this action.
-
--sync-with-history | --swh (boolean)
- Specify if you want to preserve the change history of the Elements while performing the synchronization during element update.
-
--sync-fingerprint | --sfg (string)
- Specifies the fingerprint of the element directly up the map that the updated element should be synchronized with. Prevents the sync if the element up the map doesn't match the fingerprint.
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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 or updating 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.
-
--backout (boolean)
-
--notes | -n (string)
-
--notes-from-file | --nff (string)
- Local file of notes for package.
-
--emergency-package | --ep (boolean)
- Specify if the package should be an emergency package. When not specified, the package is a standard package.
-
--sharable | --sh (boolean)
- Specify this option if the package can be edited by more than one person when in In-edit status.
-
--promotion | --pr (boolean)
- Specify this option to define the package as a promotion package.
-
--validate-scl | --vs (boolean)
-
--append | -a (boolean)
- Specify this option to append the SCL you are adding to the existing package SCL. Otherwise it would be replaced.
endevor-location definition options
-
--maxrc (number)
-
--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
output customization options
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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 ", ".
-
--charset | --char (string)
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
asynchronous task 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
output customization options
-
--to-file | --tf (string)
- The file name in which the data from the command output is stored
-
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
-
--report-file | --file-name (string)
- File name for saving reports from Endevor SCM locally.
-
--report-dir (string)
- Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.
-
--write-report (boolean)
- Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Use the Endevor Bridge for Git plug-in to manage your Git-Endevor mappings and build your local Git changes before synchronizing them to Endevor.
Manage the branches of your Git-Endevor mapping.
Add a branch to an existing mapping
Usage
zowe endevor-bridge-for-git branch add <context> <mapping> <branch> [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).
-
branch (string)
- Name of the branch that will be added/removed.
Options
-
--endevor-system | --endevorsys | --system (string)
- The Endevor system where your project resides.
-
--endevor-subsystem | --endevorsub | --sub | --subsystem (string)
- The Endevor subsystem where your project resides.
-
--system-alias (string)
- The alias of Endevor system.
-
--subsystem-alias (string)
- The alias of Endevor subsystem.
-
--endevor-environment | --endevorenv | --env | --environment (string)
- The Endevor environment where your project resides.
-
--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 Endevor stage where your project resides (only for read only mappings).
-
--mapping-mode (string)
-
Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')
Allowed values: FULL, WORK_ENV_ONLY, MIRROR
-
--like (string)
- Add branch using parameters from another branch in the same repository
-
--repository-check (string)
-
If set to allowNonEmpty, user can proceed with initialization of the branch even if the branch exists.
Default value: REQUIRE_EMPTY
Allowed values: REQUIRE_EMPTY, ALLOW_NON_EMPTY
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)
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile:
zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --endevor-environment ENVNAME --endevor-system SYSNAME --endevor-subsystem SUBNAME
-
Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different environment:
zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-environment DIFFERENT_ENVIRONMENT
-
Add a branch to my Git-Endevor mapping 'MY-CONTEXT / MY-MAPPING' using the default EBG and Endevor profile by using another branch as a template with different system/subsystem:
zowe endevor-bridge-for-git branch add MY-CONTEXT MY-MAPPING MY-BRANCH --like TEMPLATE_BRANCH --endevor-system DIFFERENT_SYSTEM --endevor-subsystem DIFFERENT_SUBSYSTEM
Remove a branch from an existing mapping
Usage
zowe endevor-bridge-for-git branch delete <context> <mapping> <branch> [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).
-
branch (string)
- Name of the branch that will be added/removed.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
List the branches of an existing mapping
Usage
zowe endevor-bridge-for-git branch list <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 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Build changes from git local repository in Endevor
Build changes against remote git repository's Endevor Bridge for Git synchronized branch, using work area or build subsystem.It does not support autogen for building dependencies.
Usage
zowe endevor-bridge-for-git build execute [options]
Options
-
--endevor-instance | --endevori (string)
- The Endevor Web Services Endevor configuration name.
-
--work-dir | --wd (string)
-
--listing-dir (string)
-
--listing-rc (number)
-
--force-cleanup | --fc (boolean)
Endevor work area options
-
--work-area-id | --waid (string)
- Endevor work area ID. Name-masking is not allowed.
-
--endevor-subsystem | --endevorsub (string)
- The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.
-
--endevor-environment | --endevorenv (string)
- The Endevor SCM environment where your build subsystem resides.
-
--endevor-system | --endevorsys (string)
- The Endevor SCM system where your build subsystem resides.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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]
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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]
Options
-
--endevor-instance | --endevori (string)
- The Endevor Web Services Endevor configuration name.
-
--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 work area options
-
--work-area-id | --waid (string)
- Endevor work area ID. Name-masking is not allowed.
-
--endevor-subsystem | --endevorsub (string)
- The Endevor SCM build subsystem. Note: The build subsystem can be cleared without prior permission.
-
--endevor-environment | --endevorenv (string)
- The Endevor SCM environment where your build subsystem resides.
-
--endevor-system | --endevorsys (string)
- The Endevor SCM system where your build subsystem resides.
Required 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 connections to Endevor Web Services used by Endevor Bridge for Git.
Create new Endevor connection for Endevor Bridge for Git.
Usage
zowe endevor-bridge-for-git endevor-connection create <connection> [options]
Positional Arguments
Options
Endevor options (alternatively use an 'endevor' profile)
-
--endevor-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)
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Create the Endevor connection 'MY-CONNECTION' using the default EBG and Endevor profile:
zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-instance INSTANCE
-
Create the Endevor connection 'MY-CONNECTION' using the default EBG profile:
zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --endevor-protocol http --endevor-host endevor-host --endevor-port 12345 --endevor-instance INSTANCE
-
Create the Endevor connection 'MY-CONNECTION' using the default Endevor profile:
zowe endevor-bridge-for-git endevor-connection create MY-CONNECTION --protocol http --host bridge-host --port 8080 --endevor-instance INSTANCE
Delete existing Endevor connection defined to Endevor Bridge for Git.
Usage
zowe endevor-bridge-for-git endevor-connection delete <connection> [options]
Positional Arguments
Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
List Endevor connections used by Endevor Bridge for Git.
Usage
zowe endevor-bridge-for-git endevor-connection list [options]
Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
Rename existing Endevor connection defined to Endevor Bridge for Git.
Usage
zowe endevor-bridge-for-git endevor-connection rename <connection> <new-connection> [options]
Positional Arguments
-
connection (string)
-
new-connection (string)
- New Endevor connection name.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Update your Endevor credentials for the Endevor connection.
Usage
zowe endevor-bridge-for-git endevor-connection update-credentials <connection> [options]
Positional Arguments
Endevor options (alternatively use an 'endevor' profile)
Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 Endevor connection MY-CONNECTION using the default EBG and Endevor profile:
zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION
-
Update the Endevor credentials for the Endevor connection MY-CONNECTION using the default EBG profile but not using an Endevor profile:
zowe endevor-bridge-for-git endevor-connection update-credentials MY-CONNECTION --endevor-user my-user --endevor-password my-password
Manage the token you use for secure communication with BridgeForGit when using the local hook validation.
Generate a new local hook token for Endevor Bridge for Git.
Usage
zowe endevor-bridge-for-git local-hook-token generate [options]
Options
Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
List your local hook token.
Usage
zowe endevor-bridge-for-git local-hook-token list [options]
Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Revoke your local hook token.
Usage
zowe endevor-bridge-for-git local-hook-token revoke [options]
Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
Profile Options
Base Connection Options
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Manage the Git-Endevor mappings.
Add an element from up the map in your Endevor to your Git repository.
Usage
zowe endevor-bridge-for-git mapping add-element <context> <mapping> [options]
Positional Arguments
-
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
-
--element-name | --name (string)
- The name of the Endevor element you want to add.
-
--element-type | --type (string)
- The type of the Endevor element you want to add
-
--endevor-system | --endevorsys | --system (string)
- The Endevor system where your element resides.
-
--endevor-subsystem | --endevorsub | --sub | --subsystem (string)
- The 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)
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--connection (string)
-
--endevor-instance | --endevori (string)
- The Endevor Web Services Endevor configuration name.
-
--endevor-system | --endevorsys | --system (string)
- The Endevor system where your project resides.
-
--endevor-subsystem | --endevorsub | --sub | --subsystem (string)
- The Endevor subsystem where your project resides.
-
--system-alias (string)
- The alias of Endevor system.
-
--subsystem-alias (string)
- The alias of Endevor subsystem.
-
--endevor-environment | --endevorenv | --env | --environment (string)
- The Endevor environment where your project resides.
-
--branch | -b (string)
-
--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 Endevor stage where your project resides (only for read only mappings).
-
--type-filters (array)
- Type filters that your mapping will be using. There can be multiple separated by a space. eg --type-filters "COBOL" "COPY".
-
--name-filters (array)
- Name filters that your mapping will be using. There can be multiple separated by a space. eg --name-filters "ELE*" "CO*".
-
--repository-check (string)
-
If set to allowNonEmpty, user can proceed with initialization even if the repository is not empty.
Default value: REQUIRE_EMPTY
Allowed values: REQUIRE_EMPTY, ALLOW_NON_EMPTY
-
--mapping-mode (string)
-
Mapping mode of the mapping ('FULL', 'WORK_ENV_ONLY' or 'MIRROR')
Allowed values: FULL, WORK_ENV_ONLY, MIRROR
-
--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)
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 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 --connection endevor-connection-name --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).
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
Manage the processor groups of your mapping
List processor groups used by a type in your mapping
Usage
zowe endevor-bridge-for-git processor-group list [options]
Options
-
--work-dir | --wd (string)
-
--endevor-system | --endevorsys (string)
- The Endevor system or alias of the system where your project resides.
-
--endevor-subsystem | --endevorsub (string)
- The Endevor subsystem or alias of the subsystem where your project resides.
-
--type | --type (string)
- The type of the Endevor element
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 processor group of a specific element in your local repository
Usage
zowe endevor-bridge-for-git processor-group update <element> <processor-group> [options]
Positional Arguments
-
element (string)
- The name of the Endevor element that its processor group will be modified
-
processor-group (string)
- The name of the processor group you want to use
Options
-
--work-dir | --wd (string)
-
--endevor-system | --endevorsys (string)
- The Endevor system or alias of the system where your project resides.
-
--endevor-subsystem | --endevorsub (string)
- The Endevor subsystem or alias of the subsystem where your project resides.
-
--type | --type (string)
- The type of the Endevor element
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.
Update the processor group of all changed elements of a specific type
Usage
zowe endevor-bridge-for-git processor-group update-all <processor-group> [options]
Positional Arguments
-
processor-group (string)
- The name of the processor group you want to use
Options
-
--work-dir | --wd (string)
-
--endevor-system | --endevorsys (string)
- The Endevor system or alias of the system where your project resides.
-
--endevor-subsystem | --endevorsub (string)
- The Endevor subsystem or alias of the subsystem where your project resides.
-
--type | --type (string)
- The type of the Endevor element
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.
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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
-
--protocol (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Default value: cajclcheck/api/v1
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--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.
Default value: cajclcheck/api/v1
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 '""').
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 CallerID details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:
zowe mat monitor codeview callerid --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Csect mode for monitor number 5:
zowe mat monitor codeview csect --mon_num 5
-
Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile:
zowe mat monitor codeview csect --profile TESTPROF
-
Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor codeview csect --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined:
zowe mat monitor codeview histogram --mon_num 5 --csect "TUNCOB01" --module "RUNCOB" --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Module mode for monitor number 5:
zowe mat monitor codeview module --mon_num 5
-
Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:
zowe mat monitor codeview module --profile TESTPROF
-
Get the CodeView measurement details in Module mode for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor codeview module --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 the DB2View details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor db2 db2view --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1, and with the specific MAT profile details defined:
zowe mat monitor db2 sqlstmt --mon_num 5 --dbrm CUPBTSDY --stmtnum 464 --totalsamps 1 --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 address details for majorcategory "PC routine delay" and minorcategory "PC CALL" for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor delayview address --mon_num 5 –-majorcategory "PC routine delay" –-minorcategory "PC CALL" --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the DelayView measurement details for monitor number 5:
zowe mat monitor delayview delay --mon_num 5
-
Get the DelayView measurement details for the latest monitor in the TESTPROF profile:
zowe mat monitor delayview delay --profile TESTPROF
-
Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor delayview delay --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF:
zowe mat monitor history --profile TESTPROF
-
Get the list of all available measurements that are stored in the history of the monitor profile TESTPROF, with the specific MAT profile details defined:
zowe mat monitor history --profile TESTPROF --host "example.com" --port 12345 --user johndoe --password qwerty
Get the IDMS measurement details.
Get the IDMS measurement details in DML mode.
Usage
zowe mat monitor idms dml [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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Module mode for monitor number 5:
zowe mat monitor idms dml --mon_num 5
-
Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:
zowe mat monitor idms dml --profile TESTPROF
-
Get the dml details of the measurement for monitor number 5:
zowe mat monitor idms dml dml --mon_num 5
Get the IDMS measurement details.
Usage
zowe mat monitor idms 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.
-
--module (string)
- Specifies the module of the measurement.
-
--taskid (number)
- Specifies the taskid number.
-
--ruid (number)
- Specifies the ruid number.
-
--linecmd (string)
- Specifies the line command to be used for the row data
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the idms details of the measurement for monitor number 5:
zowe mat monitor idms module --mon_num 5
-
Get the idms details of the measurement for the latest monitor in the TESTPROF profile:
zowe mat monitor idms module --profile TESTPROF
-
Get the module details of the measurement for monitor number 5:
zowe mat monitor idms module module --mon_num 5
-
Specify the module | taskid | ruid | linecmd option of the measurement for the module mode:
zowe mat monitor idms module --module SQLA01D | --taskid 1 | --ruid 19333 | --linecmd dispatch
Get the IDMS measurement details in Task mode.
Usage
zowe mat monitor idms task [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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Module mode for monitor number 5:
zowe mat monitor idms task --mon_num 5
-
Get the CodeView measurement details in Module mode for the latest monitor in the TESTPROF profile:
zowe mat monitor idms task --profile TESTPROF
-
Get the task details of the measurement for monitor number 5:
zowe mat monitor idms task task --mon_num 5
Get the IMS measurement details.
Get the IMS View DBDName details for the measurement.
Usage
zowe mat monitor imsview dbdname [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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View DBDName details for monitor number 5:
zowe mat monitor imsview dbdname --mon_num 5
-
Get the IMS View DBDName details for the latest monitor in the TESTPROF profile, :
zowe mat monitor imsview dbdname --profile TESTPROF
Get the IMS View details for the measurement.
Usage
zowe mat monitor imsview imsview [options]
Options
-
--mon_num (number)
- Specifies the unique monitor number of the measurement.
-
--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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View details for monitor number 5:
zowe mat monitor imsview imsview --mon_num 5
-
Get the IMS View details for the latest monitor in the TESTPROF profile, :
zowe mat monitor imsview imsview --profile TESTPROF
Get the IMS View PSBName details for the measurement.
Usage
zowe mat monitor imsview psbname [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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View PSBName details for monitor number 5:
zowe mat monitor imsview psbname --mon_num 5
-
Get the IMS View PSBName details for the latest monitor in the TESTPROF profile, :
zowe mat monitor imsview psbname --profile TESTPROF
Get the IMS View Region details for the measurement.
Usage
zowe mat monitor imsview region [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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View Region details for monitor number 5:
zowe mat monitor imsview region --mon_num 5
-
Get the IMS View Region details for the latest monitor in the TESTPROF profile, :
zowe mat monitor imsview region --profile TESTPROF
Get the IMS View SSA details for the measurement.
Usage
zowe mat monitor imsview ssa [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.
-
--call (string)
- Specifies the call details for the specified monitor number or profile name.
-
--dbdname (string)
- Specifies the dbdname details for the specified monitor number or profile name.
-
--psbname (string)
- Specifies the psbname details for the specified monitor number or profile name.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor imsview ssa --mon_num 5 --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME
-
Get the IMS View SSA details for the latest monitor in the TESTPROF profile,with the specific MAT profile details defined :
zowe mat monitor imsview ssa --profile TESTPROF --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME
-
Get the IMS View SSA details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor imsview ssa --mon_num 5 --call TESTCALL --dbdname TESTDBDNAME --psbname TESTPSBNAME
Get the IMS View Statement details for the measurement.
Usage
zowe mat monitor imsview statement [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.
-
--trancode (string)
- Specifies the trancode for specified monitor number or profile name
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the IMS View Statement details for monitor number 5with trancode TESTTRANCODE:
zowe mat monitor imsview statement --mon_num 5 --trancode TESTTRANCODE
-
Get the IMS View Statement details for the latest monitor in the TESTPROF profile, with trancode TESTTRANCODE:
zowe mat monitor imsview statement --profile TESTPROF --trancode TESTTRANCODE
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 for monitor number 5:
zowe mat monitor overview --mon_num 5
-
Get the overview details of the measurement for the latest monitor in the TESTPROF profile:
zowe mat monitor overview --profile TESTPROF
-
Get the measurement overview details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor overview --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the TranView measurement details.
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview all [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.
-
--tran (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.
-
--type (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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview 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.
-
--tran (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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview callstack [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.
-
--tran (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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Get the CodeView measurement details in Csect mode.
Usage
zowe mat monitor tranview 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.
-
--tran (string)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the CodeView measurement details in Csect mode for monitor number 5:
zowe mat monitor tranview csect --mon_num 5
-
Get the CodeView measurement details in Csect mode for the latest monitor in the TESTPROF profile:
zowe mat monitor tranview csect --profile TESTPROF
-
Get the CodeView measurement details in Csect mode for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor tranview csect --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the delay details for the measurement.
Usage
zowe mat monitor tranview 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.
-
--tran (string)
- Specifies the unique monitor number of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the DelayView measurement details for monitor number 5:
zowe mat monitor tranview delay --mon_num 5
-
Get the DelayView measurement details for the latest monitor in the TESTPROF profile:
zowe mat monitor tranview delay --profile TESTPROF
-
Get the DelayView measurement details for monitor number 5, with the specific MAT profile details defined:
zowe mat monitor tranview delay --mon_num 5 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview 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.
-
--tran (string)
- Specifies the transaction of the measurement.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Get the Tranview measurement details in Module mode for monitor number 5:
zowe mat monitor tranview module --mon_num 5
-
Get the Tranview measurement details in Module mode for the latest monitor in the TESTPROF profile:
zowe mat monitor tranview module --profile TESTPROF
-
Get the Tranview measurement details in Module mode for transaction number MVGT, with the specific MAT profile details defined:
zowe mat monitor tranview module --tran MVGT
Get the CodeView measurement details in Module mode.
Usage
zowe mat monitor tranview stat [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.
-
--tran (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.
-
--type (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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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).
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system:
zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31
-
Create the PROFILE1 monitor profile to measure for 90 seconds job JOB1 that runs on the AA31 and AA32 systems:
zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31,AA32 --elapstime 90s
-
Create the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system, with the specific MAT profile details defined:
zowe mat profile create --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty
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.
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system with the specific MAT profile details defined:
zowe mat profile invoke --profile PROFILE1 --jobname JOB1 --targsys AA31 --host "example.com" --port 12345 --user johndoe --password qwerty
Get the list of available monitor profiles.
Usage
zowe mat profile list [options]
MAT Profile Options
-
--protocol | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 that ensure the collection of 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 omspool issue command <command-text> [options]
Positional Arguments
-
command-text (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
-
--omspool-profile | --omspool-p (string)
- The name of a (omspool) 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
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
Show first steps required to set up plugin for use.
Usage
zowe plugins show-first-steps [plugin] [options]
Positional Arguments
-
plugin (string)
-
The name of the installed plug-in to show first steps for.
If the plug-in argument is omitted, no action is taken.
Examples
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.
Warning: This group has been deprecated.
Recommended replacement: The 'config init' command
Create new configuration profiles.
Warning: This group has been deprecated.
Recommended replacement: The 'config init' command
Base profile that stores values shared by multiple service profiles
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create base-profile <profileName> [options]
Positional Arguments
-
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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
-
--host | -H (string)
- Host name of the CA7 API service that is running on the mainframe system.
-
--port | -P (number)
- Port for the CA7 API service that is running on the mainframe system.
-
--user | -u (string)
- User name for authenticating connections to the CA7 API service that is running on the mainframe system.
-
--password | --pass | --pw (string)
- Password for authenticating connections to the CA7 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.
-
--protocol | -o (string)
-
--reject-unauthorized | --ru (boolean)
Options
Configuration profile for View
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create caview-profile <profileName> [options]
Positional Arguments
-
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)
-
--host | --hostname (string)
- Hostname or ip address of the target View REST API instance.
-
--port (number)
-
--base-path (string)
-
--user | --username (string)
- User name used to authenticate against the target View REST API instance.
-
--password (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
A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create cics-profile <profileName> [options]
Positional Arguments
-
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
Cics Connection Options
Examples
A profile for interaction with Db2 for the z/OS region
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create db2-profile <profileName> [options]
Positional Arguments
-
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 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create dbm-db2-options-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the "--dbm-db2-options-profile" option.
Options
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
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-values | --csv (array)
-
Specifies the global change specifications that modify Db2 object attributes during a command execution.
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 the table 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.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--description | -d (string)
- Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
-
--id (string)
-
Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.
Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--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-values | --msv (array)
-
Specifies 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:
- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
- <schema> must be between 1 and 128 characters.
- <version> must be between 1 and 64 characters.
A mask specification can include the following wildcard characters:
Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.
Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.
Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.
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.
- The matchSetValues options-profile option has the same behavior as the match-set-file command option.
-
--modification | -m (string)
-
Specifies 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 current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--rule-set | --rs (string)
-
Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, 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
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--source-db2 | --sd (string)
-
Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
-
--target-db2 | --td (string)
-
Specifies the target Db2 subsystem or data sharing group where you want to use a command.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--type | -t (string)
-
Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.
Allowed values: drop, create
-
--verify | -v (string)
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--overwrite | --ow (boolean)
- Overwrite the dbm-db2-options 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.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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 Options
-
--host | -H (string)
- Specifies the DBM Data Service REST API server host name or TCP/IP address to use.
-
--port | -P (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.
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Default value: https
Allowed values: http, https
-
--reject-unauthorized | --ru (boolean)
-
--environment-list | --el (string)
-
Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
Default value: [object Object]
-
--job-cards | --jc (array)
-
Specifies a string array of z/OS JCL JOB statements.
Default value: //DB2DVOPS JOB CLASS=A,,// MSGCLASS=X
-
--work-dataset-prefix | --wdp (string)
-
--delete-work-datasets | --dwd (boolean)
-
--overwrite-output-files | --oof (boolean)
-
--authid | -a (string)
-
--sqlid | -s (string)
-
--termination-character | --tc (string)
-
Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
Default value: ;
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Options
Examples
-
Create a DBM-Db2 profile named profile_name1 and default values for all the 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 --environment-list "SUBA:prod@host1.com:322,SUBB:test@host2.net:522"
-
Create a DBM-Db2 profile named dbm126 that uses specified job cards for every mainframe job:
zowe profiles create dbm-db2-profile dbm126 --job-cards "//DB2DVOPS JOB (123456789),'DB2 PROVISIONING',NOTIFY=&SYSUID," "// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1)," "// REGION=0M,TIME=NOLIMIT"
An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create ebg-profile <profileName> [options]
Positional Arguments
-
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.
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
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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)
-
--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)
-
--override-signout | --os (boolean)
-
--file-extension | --ext (string)
-
The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:
none: File name is equal to element name, no extension is added.
file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.
type\-name: The type name is used as the file extension.
mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.
Default value: mixed
Allowed values: none, type-name, file-ext, mixed
-
--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 profile schema, where you specify your endevor session information and credentials
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create endevor-profile <profileName> [options]
Positional Arguments
-
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)
-
The protocol used for connecting to Endevor Rest API
Default value: https
Allowed values: http, https
-
--base-path | --bp (string)
-
--reject-unauthorized | --ru (boolean)
- If set, the server certificate is verified against the list of supplied CAs
-
--report-dir | --rd (string)
-
--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/api/v2 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/api/v2 --reject-unauthorized false
File Master Plus profile schema.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create fmp-profile <profileName> [options]
Positional Arguments
-
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)
-
--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
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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.
-
--protocol (string)
-
--reject-unauthorized | --ru (boolean)
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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)
-
--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.
Default value: cajclcheck/api/v1
-
--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
Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create jclx-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the new jclx profile. You can load this profile by using the name on commands that support the "--jclx-profile" option.
Options
-
--remote-home-dir (string)
- The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
-
--remote-temp-dir (string)
- The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
-
--language (string)
-
The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.
Default value: ENG
Allowed values: ENG, JPN
-
--response-encoding (string)
-
--overwrite | --ow (boolean)
- Overwrite the jclx profile when a profile of the same name exists.
-
--disable-defaults | --dd (boolean)
- Disable populating profile values of undefined properties with default values.
MAT Analyze CLI profile schema.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create mat-profile <profileName> [options]
Positional Arguments
-
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 | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Default value: https
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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)
-
--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 --o http --H localhost --P 1234 --u user --pw pass --base-path 'API\MAT'
-
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 --o http --H localhost --P 1234 --u user --pw pass --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
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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.
MQ Connection Options
Options
Examples
Configuration profile for Spool, where you specify information about your Spool instance
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create omspool-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the new omspool profile. You can load this profile by using the name on commands that support the "--omspool-profile" option.
SPOOL OPTIONS
Options
Examples
-
Create a profile for Spool named 'myProfile' with TSO account information '1234567890', Spool installation high level qualifier of 'SPOOL.HLQ', subsystem name 'ESF1', output response data set 'OUTPUT.RESPONSE.DS', and data set 'USER.CLIST', containing ESFZOWE REXX exec:
zowe profiles create omspool-profile myProfile --account 1234567890 --spoolhlq SPOOL.HLQ --subsys ESF1 --outds OUTPUT.RESPONSE.DS --clist USER.CLIST
The OPS Web Services session profile schema, where you specify your session information and credentials
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create ops-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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 that ensure the collection of 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.
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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".
-
--tokenType | --tt (string)
- JWT token type assigned to profile when "zowe rse auth login" is used for authentication.
-
--tokenValue | --tv (string)
- JWT token value assigned to profile when "zowe rse auth login" is used for authentication.
-
--tokenExpiration | --te (number)
- JWT token expiration assigned to profile when "zowe rse auth login" is used for authentication.
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
z/OS SSH Profile
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create ssh-profile <profileName> [options]
Positional Arguments
-
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
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
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 /my-sysview-instance/api/v1
z/OS TSO/E User Profile
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create tso-profile <profileName> [options]
Positional Arguments
-
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
Configuration profile for z/OS FTP
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create zftp-profile <profileName> [options]
Positional Arguments
-
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.
FTP Connection 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)
-
--encoding | --ec (string)
- The encoding for download and upload of z/OS data set.
TLS / Secure Connection options
Options
Examples
z/OSMF Profile
Warning: This command has been deprecated.
Recommended replacement: The 'config init' command
Usage
zowe profiles create zosmf-profile <profileName> [options]
Positional Arguments
-
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 (string)
- The encoding for download and upload of z/OS data set and USS files. The default encoding if not specified is IBM-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 'zosAPIML' to connect to z/OSMF via the Zowe API Mediation Layer running at host 'zosAPIML', port '7554', and allow for self-signed certificates. To reduce duplication, you could elect to store the 'host', 'port', 'reject-unauthorized', 'user', and 'password' values for the API Mediation Layer in a base profile and only store the 'base-path' of the service in the zosmf profile:
zowe profiles create zosmf-profile zosAPIML --host zosAPIML --port 7554 --user ibmuser --password myp4ss --reject-unauthorized false --base-path ibmzosmf/api/v1
Delete existing profiles.
Warning: This group has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Delete a base profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete base-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete ca7-profile <profileName> [options]
Positional Arguments
-
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 caview profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete caview-profile <profileName> [options]
Positional Arguments
-
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 profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete cics-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete db2-profile <profileName> [options]
Positional Arguments
-
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-options profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete dbm-db2-options-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the dbm-db2-options profile to be deleted. You can also load this profile by using the name on commands that support the "--dbm-db2-options-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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete dbm-db2-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete ebg-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete endevor-location-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete endevor-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete fmp-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete idms-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete ims-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete jclcheck-profile <profileName> [options]
Positional Arguments
-
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 jclx profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete jclx-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the jclx profile to be deleted. You can also load this profile by using the name on commands that support the "--jclx-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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete mat-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete mq-profile <profileName> [options]
Positional Arguments
-
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 omspool profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete omspool-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the omspool profile to be deleted. You can also load this profile by using the name on commands that support the "--omspool-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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete ops-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete pma-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
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 ssh profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete ssh-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete sysview-format-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete sysview-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete tso-profile <profileName> [options]
Positional Arguments
-
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 zftp profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete zftp-profile <profileName> [options]
Positional Arguments
-
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 zosmf profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.
Warning: This command has been deprecated.
Recommended replacement: Edit your Zowe V2 configuration zowe.config.json
Usage
zowe profiles delete zosmf-profile <profileName> [options]
Positional Arguments
-
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}}.
Warning: This group has been deprecated.
Recommended replacement: The 'config list' command
Base profile that stores values shared by multiple service profiles
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list base-profiles [options]
Options
Examples
A CA7 profile is required to issue commands in the CA7 command group. The CA7 profile contains your host and port for the CA7 instance of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list ca7-profiles [options]
Options
Examples
Configuration profile for View
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list caview-profiles [options]
Options
Examples
A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list cics-profiles [options]
Options
Examples
A profile for interaction with Db2 for the z/OS region
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list db2-profiles [options]
Options
Examples
The DBM-Db2 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list dbm-db2-options-profiles [options]
Options
Examples
The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list dbm-db2-profiles [options]
Options
Examples
An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list ebg-profiles [options]
Options
Examples
The Endevor element location, where you specify your working environment, system and subsystem
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list endevor-location-profiles [options]
Options
Examples
The endevor profile schema, where you specify your endevor session information and credentials
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list endevor-profiles [options]
Options
Examples
File Master Plus profile schema.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list fmp-profiles [options]
Options
Examples
An IDMS profile is required to issue IDMS CLI commands. The IDMS profile contains your host and port information
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list idms-profiles [options]
Options
Examples
An ims profile is used to issue commands in the ims command group that interact with IMS regions. The ims profile contains your IMS Operations API web server host, port, user name and password, IMS Connect host and port and IMS plex name.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list ims-profiles [options]
Options
Examples
A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list jclcheck-profiles [options]
Options
Examples
Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list jclx-profiles [options]
Options
Examples
MAT Analyze CLI profile schema.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list mat-profiles [options]
Options
Examples
An MQREST profile is required to issue commands in the MQ command group that interacts with MQSC. The mq profile contains your host, port, user name, and password for the IBM MQ System Console interface
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list mq-profiles [options]
Options
Examples
Configuration profile for Spool, where you specify information about your Spool instance
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list omspool-profiles [options]
Options
Examples
The OPS Web Services session profile schema, where you specify your session information and credentials
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list ops-profiles [options]
Options
Examples
MAT Detect CLI profile schema.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list pma-profiles [options]
Options
Examples
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list rse-profiles [options]
Options
Examples
z/OS SSH Profile
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list ssh-profiles [options]
Options
Examples
The SYSVIEW format profile schema, where you specify display settings
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list sysview-format-profiles [options]
Options
Examples
The SYSVIEW session profile schema, where you specify your session information and credentials
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list sysview-profiles [options]
Options
Examples
z/OS TSO/E User Profile
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list tso-profiles [options]
Options
Examples
Configuration profile for z/OS FTP
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list zftp-profiles [options]
Options
Examples
z/OSMF Profile
Warning: This command has been deprecated.
Recommended replacement: The 'config list' command
Usage
zowe profiles list zosmf-profiles [options]
Options
Examples
Set which profiles are loaded by default.
Warning: This group has been deprecated.
Recommended replacement: The 'config set' command
The base set default-profiles command allows you to set the default profiles for this command group. When a base command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default base-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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 caview set default-profiles command allows you to set the default profiles for this command group. When a caview command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default caview-profile <profileName> [options]
Positional Arguments
-
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 set default-profiles command allows you to set the default profiles for this command group. When a cics command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default cics-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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-options set default-profiles command allows you to set the default profiles for this command group. When a dbm-db2-options command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default dbm-db2-options-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specify a
profile for default usage within the dbm-db2-options group. When you issue commands within the dbm-db2-options 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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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 jclx set default-profiles command allows you to set the default profiles for this command group. When a jclx command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default jclx-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specify a
profile for default usage within the jclx group. When you issue commands within the jclx 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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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 omspool set default-profiles command allows you to set the default profiles for this command group. When a omspool command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default omspool-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specify a
profile for default usage within the omspool group. When you issue commands within the omspool 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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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 ssh set default-profiles command allows you to set the default profiles for this command group. When a ssh command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default ssh-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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 zftp set default-profiles command allows you to set the default profiles for this command group. When a zftp command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default zftp-profile <profileName> [options]
Positional Arguments
-
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 zosmf set default-profiles command allows you to set the default profiles for this command group. When a zosmf command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles set-default zosmf-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This group has been deprecated.
Recommended replacement: The 'config set' command
Base profile that stores values shared by multiple service profiles
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update base-profile <profileName> [options]
Positional Arguments
-
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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
-
--host | -H (string)
- Host name of the CA7 API service that is running on the mainframe system.
-
--port | -P (number)
- Port for the CA7 API service that is running on the mainframe system.
-
--user | -u (string)
- User name for authenticating connections to the CA7 API service that is running on the mainframe system.
-
--password | --pass | --pw (string)
- Password for authenticating connections to the CA7 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.
-
--protocol | -o (string)
-
--reject-unauthorized | --ru (boolean)
- Reject self-signed certificates.
Configuration profile for View
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update caview-profile <profileName> [options]
Positional Arguments
-
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
A cics profile is required to issue commands in the cics command group that interact with CICS regions. The cics profile contains your host, port, user name, and password for the IBM CICS management client interface (CMCI) server of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update cics-profile <profileName> [options]
Positional Arguments
-
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
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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 options profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes execution-dependent details.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update dbm-db2-options-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the new dbm-db2-options profile. You can load this profile by using the name on commands that support the "--dbm-db2-options-profile" option.
Options
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--change-set | --cs (string)
-
Specifies the creator and name of an existing RC/Migrator global change set that changes Db2 objects during a command execution.
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-values | --csv (array)
-
Specifies the global change specifications that modify Db2 object attributes during a command execution.
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 the table 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.
- The changeSetValues options-profile option has the same behavior as the change-set-file command option.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--description | -d (string)
- Specifies a 1- to 25-character description for the RC/Migrator compare strategy.
-
--id (string)
-
Specifies the 1- to 8-character name of the RC/Migrator compare strategy that is created on the target Db2 subsystem during a command execution.
Format: The name must begin with a non-numeric character and contain the following characters only: uppercase letters from A to Z, numbers from 0 to 9, and special characters $, #, and @.
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--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-values | --msv (array)
-
Specifies 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:
- <name> must be between 1 and 128 characters. For DATABASE and TABLESPACE, <name> must be between 1 and 8 characters.
- <schema> must be between 1 and 128 characters.
- <version> must be between 1 and 64 characters.
A mask specification can include the following wildcard characters:
Percent sign (%) indicates that zero or more characters can occupy that position and all remaining positions to the end of the name, or to the next character. The percent sign can be used anywhere in the name. However, the source and target characters must match exactly.
Hyphen or dash (-) indicates that any character can occupy that position, but a character must exist at that position, and the source and target character must match exactly. The hyphen can be repeated in several places in the name.
Asterisk (*) indicates matching values. An asterisk cannot be used with other characters.
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.
- The matchSetValues options-profile option has the same behavior as the match-set-file command option.
-
--modification | -m (string)
-
Specifies 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 current set of default values.
For more information about using the modification option, see the DBM Data Service documentation at https://techdocs.broadcom.com/db2mgmt
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--rule-set | --rs (string)
-
Specifies the creator and name of an existing RC/Migrator rule set that overrides Db2 object attributes in the target Db2 subsystem with the corresponding values from the input DDL file. The changes only apply to existing objects, 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
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--source-db2 | --sd (string)
-
Specifies the source Db2 subsystem or data sharing group where the objects that you want to use in a command are located.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
-
--target-db2 | --td (string)
-
Specifies the target Db2 subsystem or data sharing group where you want to use a command.
Note: If you specify the data sharing group, the first active Db2 subsystem in the group is used.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--type | -t (string)
-
Specifies the type of DDL statements that you want to generate. You can generate CREATE or DROP statements.
Allowed values: drop, create
-
--verify | -v (string)
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
The DBM-Db2 profile is a named set of DBM Data Service parameters that are implicitly used with the zowe dbm-db2 commands. The profile includes server connection, z/OS execution, and user-dependent details.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update dbm-db2-profile <profileName> [options]
Positional Arguments
-
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 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.
-
--protocol (string)
-
Specifies the communication protocol between zowe dbm-db2 client and DBM Data Service.
Allowed values: http, https
-
--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.
-
--environment-list | --el (string)
- Specifies a string of one or more entries consisting of a Db2 subsystem ID and a DBM Data Service REST API server host name or TCP/IP address. Use a comma to separate entries. The same Db2 subsystem can be used in multiple DBM Data Service environments. 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
-
--job-cards | --jc (array)
- Specifies a string array of z/OS JCL JOB statements.
-
--work-dataset-prefix | --wdp (string)
- Specifies the prefix (high-level qualifier) in z/OS work data set names.
-
--delete-work-datasets | --dwd (boolean)
- Specifies whether to delete work data sets on a mainframe after the request is fulfilled.
-
--overwrite-output-files | --oof (boolean)
- Specifies whether to overwrite output files if they exist.
-
--authid | -a (string)
- Specifies the primary Db2 authorization ID that is used to establish a connection between Db2 and a process.
-
--sqlid | -s (string)
- Specifies the authorization ID that is used in generated SET CURRENT SQLID statements.
-
--termination-character | --tc (string)
- Specifies the SQL termination character to use in DDL generation when the default termination character conflicts with the SQL statements that are used in triggers, XML indexes, and routines (external SQL functions and native SQL stored procedures). The default termination character is a semi-colon (;). You cannot specify a comma, double quote, single quote, left or right parentheses, or an underscore.
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all DBM DS resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
Examples
-
Update a DBM-Db2 profile named profile_name1 with a new work data set prefix:
zowe profiles update dbm-db2-profile profile_name1 --work-dataset-prefix NEWPREFX.DDL
-
Update a DBM-Db2 profile named dbm123 with a new username and password:
zowe profiles update dbm-db2-profile dbm123 --user newuser --password newp4ss
-
Update a DBM-Db2 profile named dbm124 with a new environment list. Existing subsystem SUBA will be updated with a new hostname "host4" and subsystem SUBC will be added to the list:
zowe profiles update dbm-db2-profile dbm124 --environment-list "SUBA:prod@host4.com:322,SUBC:stage@host3.net:722"
-
Update a DBM-Db2 profile named dbm125 with new job cards:
zowe profiles update dbm-db2-profile dbm125 --job-cards "//NEWJOBNM JOB (123456789)," "// CLASS=A,MSGCLASS=X,MSGLEVEL=(1,1),"
An EBG profile is required to issue commands in the ebg command group. The EBG profile contains the connection details for the Endevor Bridge for Git server of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update ebg-profile <profileName> [options]
Positional Arguments
-
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.
Endevor Bridge for Git connection options (alternatively use an 'ebg' profile)
The Endevor element location, where you specify your working environment, system and subsystem
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update endevor-location-profile <profileName> [options]
Positional Arguments
-
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
-
--override-signout | --os (boolean)
- Always override element signout, without having to specify the override signout option on each command
-
--file-extension | --ext (string)
-
The strategy for deciding what file extension to use during a bulk retrieve or workspace synchronization. Must be one of the following:
none: File name is equal to element name, no extension is added.
file\-ext: The file extension defined in the Type definition is used; If not defined, no extension is added.
type\-name: The type name is used as the file extension.
mixed: The file extension defined in Type definition is used; If not defined, the type name is used instead.
Allowed values: none, type-name, file-ext, mixed
The endevor profile schema, where you specify your endevor session information and credentials
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update endevor-profile <profileName> [options]
Positional Arguments
-
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
-
--report-dir | --rd (string)
- The default path where any reports will be written to, either absolute or relative to current directory
File Master Plus profile schema.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update fmp-profile <profileName> [options]
Positional Arguments
-
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
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
-
--protocol (string)
-
--reject-unauthorized | --ru (boolean)
- Reject self-signed certificates.
A JCLCheck profile is required to issue commands in the jcl command group that interact with JCLCheck. The JCLCheck profile contains your host and port for the JCLCheck instance of your choice.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update jclcheck-profile <profileName> [options]
Positional Arguments
-
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.
Configuration profile for the IBM Z JCL Expert Zowe CLI plugin.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update jclx-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the new jclx profile. You can load this profile by using the name on commands that support the "--jclx-profile" option.
Options
-
--remote-home-dir (string)
- The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
-
--remote-temp-dir (string)
- The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
-
--language (string)
-
--response-encoding (string)
- The encoding to translate the remote response from. An empty string value or 'binary' will result in no encoding translation. Defaults to 'utf-8' if not provided.
MAT Analyze CLI profile schema.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update mat-profile <profileName> [options]
Positional Arguments
-
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 | -o (string)
-
Specifies the protocol defined for the MAT REST API server (http or https).
Allowed values: http, https
-
--host | -H (string)
- Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost).
-
--port | -P (number)
- Specifies the server port (e.g. 8080).
-
--user | -u (string)
-
--password | --pw (string)
-
--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.
-
--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
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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.
MQ Connection Options
Configuration profile for Spool, where you specify information about your Spool instance
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update omspool-profile <profileName> [options]
Positional Arguments
-
profileName (string)
- Specifies the name of the new omspool profile. You can load this profile by using the name on commands that support the "--omspool-profile" option.
SPOOL OPTIONS
Examples
-
Update the TSO account information to '3213213210' for Spool profile named 'myProfile':
zowe profiles update omspool-profile myProfile --account 3213213210
-
Update high level qualifier of the Spool installation to 'SPOOL.HLQ' for Spool profile named 'myProfile':
zowe profiles update omspool-profile myProfile --spoolhlq SPOOL.HLQ
-
Update the Spool subsystem name to 'ESF2' for Spool profile named 'myProfile':
zowe profiles update omspool-profile myProfile --subsys ESF2
-
Update the output response data set to 'OUTPUT.RESPONSE.DS.NEW' for Spool profile named 'myProfile':
zowe profiles update omspool-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 omspool-profile myProfile --clist USER.CLIST
The OPS Web Services session profile schema, where you specify your session information and credentials
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update ops-profile <profileName> [options]
Positional Arguments
-
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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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 that ensure the collection of 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.
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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".
-
--tokenType | --tt (string)
- JWT token type assigned to profile when "zowe rse auth login" is used for authentication.
-
--tokenValue | --tv (string)
- JWT token value assigned to profile when "zowe rse auth login" is used for authentication.
-
--tokenExpiration | --te (number)
- JWT token expiration assigned to profile when "zowe rse auth login" is used for authentication.
z/OS SSH Profile
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update ssh-profile <profileName> [options]
Positional Arguments
-
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
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
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
Configuration profile for z/OS FTP
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update zftp-profile <profileName> [options]
Positional Arguments
-
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.
FTP Connection options
-
--host | -H (string)
- The hostname or IP address of the z/OS server to connect to.
-
--port | -P (number)
- The port of the z/OS FTP server.
-
--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.
-
--connection-timeout | --ct (number)
- How long (in milliseconds) to wait for the control connection to be established.
-
--encoding | --ec (string)
- The encoding for download and upload of z/OS data set.
TLS / Secure Connection options
z/OSMF Profile
Warning: This command has been deprecated.
Recommended replacement: The 'config set' command
Usage
zowe profiles update zosmf-profile <profileName> [options]
Positional Arguments
-
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Refresh the current session and obtain a newer JWT Token.
Usage
zowe rse-api-for-zowe-cli auth refreshToken [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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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. User will be prompted for user name, password, and new password.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
Change owner and permissions for a unix file
Usage
zowe rse-api-for-zowe-cli change properties <file> [options]
Positional Arguments
-
file (string)
- the file that will have its properties changed.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Change Properties:
zowe rse-api-for-zowe-cli change properties '/u/example/file123.txt' --owner exampleOwner --group exampleGroup --permission rwxrwxrwx --tag utf8
Confirm that RSE API is running on a specified system and gather information about the RSE API server and Address Space for diagnostic purposes, and information about user password expiry. 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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]
Options
-
--asid (boolean)
- Address space identifier.
-
--asidx (boolean)
- Address space identifier in hexadecimal.
-
--bytes (boolean)
- Current real storage usage in bytes.
-
--cpu (boolean)
- Accumulated CPU time consumed by and on behalf of and within the A/S, for the current job step, in microseconds (local + remote + external).
-
--cpu% (boolean)
- Percent of all CPU time consumed by and on behalf of the address space during the most recent interval measured.
-
--description (boolean)
- Address space position description.
-
--dp (boolean)
- Address space dispatching priority in hexadecimal.
-
--elapsed (boolean)
- Elapsed time the transaction has been active.
-
--frames (boolean)
- Current utilization of real storage in frames.
-
--hvcomhwm (boolean)
- High virtual common memory high-water mark in MB.
-
--hvcomused (boolean)
- High virtual common memory size in MB.
-
--io (boolean)
- EXCP rate in EXCPs per second for address space.
-
--name (boolean)
-
--page (boolean)
- Demand paging rate for address space.
-
--position (boolean)
-
--stepIO (boolean)
- A/S EXCP (I/O) count for the current job step.
-
--subtype (boolean)
- Sub-type of 1.job/initiator: JES, z/OS UNIX, or APPC, 2.started task: JES, MSTR, SYS.
-
--swapin (boolean)
-
--sysName (boolean)
- System name where job is executing.
-
--task (boolean)
- A/S CPU usage % of system total in interval - task (local + remote).
-
--task% (boolean)
- Accumulated CPU time consumed by and on behalf of the A/S, for the current job step, in microseconds (local + remote).
-
--type (boolean)
-
--userId (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Displays expiration date of user id's password.
Usage
zowe rse-api-for-zowe-cli check password-expiry [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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Manage Common Properties on z/OS RSE API server.
Copy a Common Properties namespace.
Usage
zowe rse-api-for-zowe-cli common-properties copy <fromNamespaceName> <toNamespaceName> [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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a Common Properties namespace.
Usage
zowe rse-api-for-zowe-cli common-properties create <namespaceName> [options]
Positional Arguments
-
namespaceName (string)
- The name of the Common Properties namespace.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete the namespace or a property in the namespace if --path option is specified.
Usage
zowe rse-api-for-zowe-cli common-properties delete <namespaceName> [options]
Positional Arguments
-
namespaceName (string)
- The name of the Common Properties namespace.
Options
-
--path | -p (string)
- The path to the property in the Common Properties namespace.
-
--private (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
List all public or private Common Properties namespaces.
Usage
zowe rse-api-for-zowe-cli common-properties list [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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Rename a Common Properties namespace.
Usage
zowe rse-api-for-zowe-cli common-properties rename <beforeNamespaceName> <afterNamespaceName> [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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Set a namespace property with a string, boolean, number or JSON string value.
Usage
zowe rse-api-for-zowe-cli common-properties set <namespaceName> <propertyPath> <propertyValue> [options]
Positional Arguments
-
namespaceName (string)
- The name of the Common Properties namespace.
-
propertyPath (string)
- The path to the property in the Common Properties namespace.
-
propertyValue (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.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
set a string value to a property:
zowe rse-api-for-zowe-cli common-properties set my-namespace /server/hostname www.host.com
-
set a number value to a property:
zowe rse-api-for-zowe-cli common-properties set my-namespace /server/port 1234 --type number
-
set a JSON value to a property:
zowe rse-api-for-zowe-cli common-properties set my-namespace /server '{"hostname" : "www.host.com", "port" : 1234}' --type json
View the namespace or a property in the namespace if --path option is specified.
Usage
zowe rse-api-for-zowe-cli common-properties view <namespaceName> [options]
Positional Arguments
-
namespaceName (string)
- The name of the Common Properties namespace.
Options
-
--path | -p (string)
-
--private (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Copy a z/OS UNIX System Services file/directory or 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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"
Copy a z/OS UNIX System Services file/directory to another directory
Usage
zowe rse-api-for-zowe-cli copy uss-file <path> <destination> [options]
Positional Arguments
-
path (string)
-
destination (string)
- The destination path of the new file to be appended to the parent path
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create data sets, data set members or z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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)
-
--data-set-type | --dst | --dsntype (string)
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Create a z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Delete a z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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, UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Download content from a z/OS UNIX System Services 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 z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Export Z/OS files.
Export a JES job provided job name, ID, fileID, and MVS data set.
Usage
zowe rse-api-for-zowe-cli export spool-file <jobName> <jobId> <spoolFileId> <toDataSetName> [options]
Positional Arguments
-
jobName (string)
-
jobId (string)
-
spoolFileId (number)
-
toDataSetName (string)
- MVS data set name to be exported to
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
-
Export spool file to sequential data set, 'HLQ.SEQDS':
zowe rse-api-for-zowe-cli export spool-file JOBNAME JOBID SPOOLID "USER.TO.SET"
-
Export spool file a data set member, 'HLQ.DSNAME(MEMBER)':
zowe rse-api-for-zowe-cli export spool-file JOBNAME JOBID SPOOLID "USER.TO.PDS(MEM1)"
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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
issue a UNIX shell command with streaming output
Usage
zowe rse-api-for-zowe-cli issue unix-shell <commandText> [options]
Positional Arguments
-
commandText (string)
- The UNIX command to issue.
Required Options
-
--cwd (string)
- Working directory in which to execute the command.
Options
-
--env (string)
- A comma-separated list of environment variables to be set in the executing shell.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
List z/OS UNIX System Services 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
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Rename a z/OS UNIX System Services file or directory.
Usage
zowe rse-api-for-zowe-cli rename uss-file <path> <name> [options]
Positional Arguments
-
path (string)
- Existing z/OS UNIX System Services file or directory Path.
-
name (string)
- New name of z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Search by filename, member name, and contents
Search for PDS member(s) provided the filter with a member pattern and/or content string.
Usage
zowe rse-api-for-zowe-cli search members <filter> <memberPattern> [options]
Positional Arguments
-
filter (string)
- Dataset filter string. Ex. FILTERNAME.*.
-
memberPattern (string)
- Member name pattern. Ex. MEM or *
Options
-
--content | -c (string)
- Content string to be searched. Ex. HelloWorld or *
-
--regex-member | --rm (boolean)
-
--regex-content | --rc (boolean)
-
--case-sensitive-content | --csc (boolean)
-
--number-of-results | --nor (string)
- Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.
-
--response-format-type | --rft (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Search for partitioned dataset(s) provided the filter with a dataset name pattern filter.
Usage
zowe rse-api-for-zowe-cli search partitioned-dataset <filter> <dsnPattern> [options]
Positional Arguments
-
filter (string)
- Dataset filter string. Ex. FILTERNAME.*.
-
dsnPattern (string)
- Dataset name pattern. Ex. HLQ.PDS or *
Options
-
--regex-dsn | --rd (boolean)
-
--number-of-results | --nor (string)
- Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.
-
--response-format-type | --rft (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Search for sequential dataset(s) provided the filter with a dataset name pattern and/or content string filter.
Usage
zowe rse-api-for-zowe-cli search sequential-dataset <filter> <dsnPattern> [options]
Positional Arguments
-
filter (string)
- Dataset filter string. Ex. FILTERNAME.*.
-
dsnPattern (string)
- Dataset name pattern. Ex. HLQ.PDS or *
Options
-
--content | -c (string)
- Content string to be searched. Ex. HelloWorld or *
-
--regex-dsn | --rd (boolean)
-
--regex-content | --rc (boolean)
-
--case-sensitive-content | --csc (boolean)
-
--number-of-results | --nor (string)
- Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.
-
--response-format-type | --rft (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Search for UNIX Files by specifying the path, file name, and text pattern. If Regex pattern is not used, wildcard patterns are used.
Usage
zowe rse-api-for-zowe-cli search uss-file <path> <fileName> [options]
Positional Arguments
-
path (string)
- The working directory. Example: /u/IBM/test.
-
fileName (string)
- The name of the file to perform the action on. Example: test.txt or ***.txt
Options
-
--text | -t (string)
- The text pattern to be searched for in the provided file. Example: hello
-
--regex-file-name | --rfn (boolean)
-
--regex-content | --rc (boolean)
-
--case-sensitive-file-name | --csfn (boolean)
-
--case-sensitive-content | --csc (boolean)
-
--path-results-only | --pro (boolean)
-
--response-format-type | --rft (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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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'.
-
--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".
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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'.
-
--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".
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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'.
-
--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".
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 z/OS UNIX System Services
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 z/OS UNIX System Services 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 z/OS UNIX System Services. 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 z/OS UNIX System Services directory
-
USSDir (string)
- The name of the z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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" z/OS UNIX System Services 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" z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
Upload content to a z/OS UNIX System Services 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 z/OS UNIX System Services file
-
USSFileName (string)
- The name of the z/OS UNIX System Services 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 Step Info of specified job provided JOBNAME and JOBID
Usage
zowe rse-api-for-zowe-cli view job-step-info <jobname> <jobid> [options]
Positional Arguments
-
jobname (string)
- The z/OS Job Name of the job containing the step information you want to view.
-
jobid (string)
- The z/OS JobId of the job containing the step information you want to view.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
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. 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
Submit a capture request2
Usage
zowe sysview capture-immediate <capture-file> [options]
Positional Arguments
-
capture-file (string)
- The list of SYSVIEW commands to be executed as an Event Capture.This takes the same form as a CAPLIB member.
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Examples
IBM Z JCL Expert Plug-in for Zowe CLI
Wraps an SSH call to JCLX on the remote system to validate the specified local file containing JCL.
Usage
zowe zjcl-expert local <filePath> [options]
Positional Arguments
Options
-
--output | -o (string)
-
--alias | -a (string)
- An alias to give the file name during analysis.
-
--dsn-check | -c (string)
-
Turn on or off DSN and USS file existence checking during analysis.
Default value: ON
Allowed values: ON, OFF
-
--rules | -r (string)
- The absolute path of the remote rules file used to define user site rules during analysis.
-
--local-rules | -e (local file path)
- The relative path to a local rules file that will be uploaded as a temporary file and used to define user site rules during analysis.
-
--job-class | -j (string)
- The default job class to use during JCL analysis if none is provided.
-
--log-level | -l (string)
-
The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.
Default value: FATAL
Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
-
--log-file | -d (string)
- The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
-
--remote-home-dir (string)
- The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
-
--remote-temp-dir (string)
- The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
-
--language (string)
-
The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.
Default value: ENG
Allowed values: ENG, JPN
-
--response-encoding (string)
Zosmf Connection Options
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--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
z/OS Ssh Connection Options
-
--ssh-port | -S (number)
-
--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
-
--jclx-profile | --jclx-p (string)
- The name of a (jclx) 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.
-
--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.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--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.
Wraps an SSH call to JCLX on the remote system to validate the specified remote data set.
Usage
zowe zjcl-expert remote-ds <dsn> [options]
Positional Arguments
-
dsn (string)
- The name of the data set to be analysed on the remote system.
Options
-
--output | -o (string)
-
--alias | -a (string)
- An alias to give the file name during analysis.
-
--dsn-check | -c (string)
-
Turn on or off DSN and USS file existence checking during analysis.
Default value: ON
Allowed values: ON, OFF
-
--rules | -r (string)
- The absolute path of the remote rules file used to define user site rules during analysis.
-
--job-class | -j (string)
- The default job class to use during JCL analysis if none is provided.
-
--log-level | -l (string)
-
The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.
Default value: FATAL
Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
-
--log-file | -d (string)
- The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
-
--remote-home-dir (string)
- The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
-
--remote-temp-dir (string)
- The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
-
--language (string)
-
The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.
Default value: ENG
Allowed values: ENG, JPN
-
--response-encoding (string)
Zosmf Connection Options
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--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
z/OS Ssh Connection Options
-
--ssh-port | -S (number)
-
--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
-
--jclx-profile | --jclx-p (string)
- The name of a (jclx) 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.
-
--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.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--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.
Wraps an SSH call to JCLX on the remote system to validate the specified remote zFS file.
Usage
zowe zjcl-expert remote-fs <filePath> [options]
Positional Arguments
-
filePath (string)
- The absolute file path of the USS file to be analysed on the remote system.
Options
-
--output | -o (string)
-
--alias | -a (string)
- An alias to give the file name during analysis.
-
--dsn-check | -c (string)
-
Turn on or off DSN and USS file existence checking during analysis.
Default value: ON
Allowed values: ON, OFF
-
--rules | -r (string)
- The absolute path of the remote rules file used to define user site rules during analysis.
-
--job-class | -j (string)
- The default job class to use during JCL analysis if none is provided.
-
--log-level | -l (string)
-
The level of diagnostic logging to be performed during analysis. Messages at this level and above are written to stderr if no log file is specified.
Default value: FATAL
Allowed values: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
-
--log-file | -d (string)
- The relative path of a local file that log messages are output to. If the file already exists it will be overwritten.
-
--remote-home-dir (string)
- The home directory of IBM Z JCL Expert in USS on your remote system. If this option is not set, the plug-in will rely on the PATH variable in the remote user environment.
-
--remote-temp-dir (string)
- The directory where all temporary files are created and deleted by the IBM Z JCL Expert Zowe CLI plugin. Temporary files are cleaned up after each operation. Defaults to "/tmp" if not specified.
-
--language (string)
-
The language to be used by IBM Z JCL Expert when invoked. This option will be ignored if remoteHomeDir is not specified.
Default value: ENG
Allowed values: ENG, JPN
-
--response-encoding (string)
Zosmf Connection Options
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--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
z/OS Ssh Connection Options
-
--ssh-port | -S (number)
-
--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
-
--jclx-profile | --jclx-p (string)
- The name of a (jclx) 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.
-
--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.
-
--user | -u (string)
- User name to authenticate to service on the mainframe.
-
--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.
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.
Compare the contents of a two data set members on your terminal (stdout).
Compare content of two z/OS data sets on your terminal (stdout).
Usage
zowe zos-files compare data-set <dataSetName1> <dataSetName2> [options]
Positional Arguments
-
dataSetName1 (string)
- The name of the first data set you want to compare.
-
dataSetName2 (string)
- The name of the second data set you want to compare.
Options
-
--binary | -b (boolean)
- Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
-
--binary2 | --b2 (boolean)
- Transfer the content of the second data set in binary mode.
-
--encoding | --ec (string)
- Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
-
--encoding2 | --ec2 (string)
- Transfer the content of the second data set with encoding mode.
-
--record | -r (boolean)
- Transfer the content for the first data set 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. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode. This option conflicts with binary mode.
-
--record2 | --r2 (boolean)
- Transfer the content for the second data set in record mode. Conflicts with binary2.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the first 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.
-
--volume-serial2 | --vs2 (string)
- The volume serial (VOLSER) where the second data set resides.
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser
-
--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
-
Compare the contents of the data set members "sys1.samplib(antptso)" and "sys1.samplib(antxtso)":
zowe zos-files compare data-set "sys1.samplib(antptso)" "sys1.samplib(antxtso)"
-
Compare the contents of the data set members "sys1.samplib(antptso)" and "sys1.samplib(antxtso)" without sequence numbers:
zowe zos-files compare data-set "sys1.samplib(antptso)" "sys1.samplib(antxtso)" --no-seqnum
Compare content of a local file and a z/os dataset on your terminal (stdout).
Usage
zowe zos-files compare local-file-data-set <localFilePath> <dataSetName> [options]
Positional Arguments
-
localFilePath (string)
- The path of the local file you want to compare.
-
dataSetName (string)
- The name of the data set you want to compare.
Options
-
--binary | -b (boolean)
- Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
-
--encoding | --ec (string)
- Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
-
--record | -r (boolean)
- Transfer the content for the first data set 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. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode. This option conflicts with binary mode.
-
--volume-serial | --vs (string)
- The volume serial (VOLSER) where the first 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.
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser
-
--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
-
Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)":
zowe zos-files compare local-file-data-set "./a.txt" "sys1.samplib(antxtso)"
-
Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)"without sequence numbers:
zowe zos-files compare local-file-data-set "./a.txt" "sys1.samplib(antxtso)" --no-seqnum
Compare content of a local-file and a spool-dd on your terminal (stdout).
Usage
zowe zos-files compare local-file-spool-dd <localFilePath> <spoolDescription> [options]
Positional Arguments
Options
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser
-
--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
Compare content of a local file and a z/os uss file on your terminal (stdout).
Usage
zowe zos-files compare local-file-uss-file <localFilePath> <ussFilePath> [options]
Positional Arguments
-
localFilePath (string)
- The path of the local file you want to compare.
-
ussFilePath (string)
- The path of the uss file set you want to compare.
Options
-
--binary | -b (boolean)
- Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
-
--encoding | --ec (string)
- Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser
-
--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
-
Compare the contents of the local file and the uss file "./a.txt" and "/u/user/test.txt":
zowe zos-files compare local-file-uss-file "./a.txt" "/u/user/test.txt"
-
Compare the contents of the local file and the uss file "./a.txt" and "/u/user/test.txt"without sequence numbers:
zowe zos-files compare local-file-uss-file "./a.txt" "/u/user/test.txt" --no-seqnum
Compare content of two spool dds on your terminal (stdout).
Usage
zowe zos-files compare spool-dd <spoolDescription1> <spoolDescription2> [options]
Positional Arguments
Options
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser
-
--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
-
Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2":
zowe zos-files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"
-
Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"without sequence numbers:
zowe zos-files compare spool-dd "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2" --no-seqnum
Compare the contents of two uss files on your terminal (stdout). browser.
Usage
zowe zos-files compare uss-files <ussFilePath1> <ussFilePath2> [options]
Positional Arguments
-
ussFilePath1 (string)
- The path of the first uss file you want to compare.
-
ussFilePath2 (string)
- The path of the second uss file you want to compare.
Options
-
--binary | -b (boolean)
- Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.
-
--binary2 | --b2 (boolean)
- Transfer the content of the second data set in binary mode.
-
--encoding | --ec (string)
- Transfer the content of the first data set with encoding mode, which means that data conversion is performed using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are transferred in encoding mode.
-
--encoding2 | --ec2 (string)
- Transfer the content of the second data set with encoding mode.
-
--seqnum | --sn (boolean)
-
--context-lines | --cl (number)
- The number of context lines that display before and after detected non-matching lines. By default all matching lines display. If you want to limit the amount of data returned to only lines with differences use the context lines option to reduce the matching lines to only those before and after non-matching lines. Using the value of 0 strips all matching lines.
-
--browser-view | --bv (boolean)
- Opens the diffs between two given files in browser
-
--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
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
Copy a data set to another data set on a specified LPAR
Usage
zowe zos-files copy data-set-cross-lpar <fromDataSetName> <toDataSetName> [options]
Positional Arguments
-
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. If the dataset does not exist it will be allocated automatically
Options
-
--replace | --rep (boolean)
- Specify this option as true if you wish to replace the target dataset if it already exists
-
--target-data-class | --tdc (string)
- The SMS data class to use for the allocation of the target data set.
-
--target-host | --th (string)
- The target z/OSMF server host name.
-
--target-management-class | --tmc (string)
- The SMS management class to use for the allocation of the target data set.
-
--target-password | --tpw (string)
- The target z/OSMF password, which can be the same as your TSO password.
-
--target-port | --tp (number)
- The target z/OSMF server port.
-
--target-storage-class | --tsc (string)
- The SMS storage class to use for the allocation of the target data set.
-
--target-token-type | --ttt (string)
- The value of the token to pass to the API for the target system.
-
--target-token-value | --ttv (string)
- The type of token to get and use for the API for the target system.
-
--target-user | --tu (string)
- The target z/OSMF user name, which can be the same as your TSO login.
-
--target-volume-serial | --tvs | --target-volser (string)
- The volume serial (VOLSER) on which you want the target data set to be placed.
-
--target-zosmf-profile | --t-zosmf-p | --target-zosmf-p (string)
- The name of a z/OSMF profile to load for the target host.
-
--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
-
Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET' using the --target-zosmf-p option to specify the target host using a zosmf profile:
zowe zos-files copy data-set-cross-lpar "USER.FROM.SET" "USER.TO.SET" --target-zosmf-p SYS1
-
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-cross-lpar "USER.FROM.SET(mem1)" "USER.TO.SET(mem2)" --target-zosmf-p SYS1
-
Copy the data set named 'USER.FROM.SET' to the data set member named 'USER.TO.SET(MEM2)':
zowe zos-files copy data-set-cross-lpar "USER.FROM.SET" "USER.TO.SET(mem2)" --target-zosmf-p SYS1
-
Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set named 'USER.TO.SET' using the --target-host, --target-user, and --target-password options:
zowe zos-files copy data-set-cross-lpar "USER.FROM.SET(mem1)" "USER.TO.SET" --target-host sys1.com --target-user user1 --target-password pass1
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
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--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)
-
--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
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--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)
-
--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
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--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)
-
--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
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--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)
-
--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
-
--allocation-space-unit | --asu (string)
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--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)
-
--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
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--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)
-
--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
-
--attributes | -a (boolean)
- Show the full allocation attributes
-
--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.
-
--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 --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 (string)
- 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 (string)
- 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 all data sets that match a DSLEVEL pattern (see help below). You can use several options to qualify which data sets will be skipped and how the downloaded files will be structured. Data sets that are neither physical sequential nor partitioned data sets (with members) will be excluded.
Usage
zowe zos-files download data-sets-matching <pattern> [options]
Positional Arguments
-
pattern (string)
- The pattern or patterns to match data sets against. Also known as 'DSLEVEL'. 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.You can specify multiple patterns separated by commas, for example "ibmuser.**.cntl,ibmuser.**.jcl"
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)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--exclude-patterns | --ep (string)
- Exclude data sets that match these DSLEVEL patterns. Any data sets that match this pattern will not be downloaded.
-
--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.
-
--extension-map | --em (string)
- Use this option to map data set names that match your pattern to the desired extension. A comma delimited key value pairing (e.g. "cntl=.jcl,cpgm=.c" to map the last segment of each data set (also known as the "low level qualifier" to the desired local 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 all data sets beginning with "ibmuser" and ending with ".cntl" or ".jcl" to the local directory "jcl" to files with the extension ".jcl":
zowe zos-files download data-sets-matching "ibmuser.**.cntl, ibmuser.**.jcl" --directory jcl --extension .jcl
-
Download all data sets that begin with "ibmuser.public.project" or "ibmuser.project.private", excluding those that end in "lib" to the local directory "project", providing a custom mapping of data set low level qualifier to local file extension:
zowe zos-files download data-sets-matching "ibmuser.public.project.*, ibmuser.project.private.*" --exclude-patterns "ibmuser.public.**.*lib" --directory project --extension-map cpgm=c,asmpgm=asm,java=java,chdr=c,jcl=jcl,cntl=jcl
Download content from a USS directory to a local directory on your PC
Usage
zowe zos-files download uss-directory <ussDirName> [options]
Positional Arguments
-
ussDirName (string)
- The name of the USS directory you want to download
Options
-
--attributes | --attrs (local file path)
- Path of an attributes file to control how files are downloaded
-
--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.
-
--depth (number)
- Filters content in USS based on the number of directories to traverse down.
-
--directory | -d (string)
- The directory to where you want to save the files. The command creates the directory for you when it does not already exist. By default, the command downloads the files to the current directory.
-
--encoding | --ec (string)
- Download the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--fail-fast | --ff (boolean)
-
--filesys (boolean)
- Filters content in USS based on the filesystem the data is on. true - all filesystems, false - same filesystem as search directory.
-
--group (string)
- Filters content in USS based on the owning group name or ID.
-
--include-hidden | --ih (boolean)
- Include hidden files and folders that have names beginning with a dot
-
--max-concurrent-requests | --mcr (number)
-
Specifies the maximum number of concurrent z/OSMF REST API requests to download files. 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 files at once without a maximum number of concurrent requests.
Default value: 1
-
--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.
-
--mtime (string)
- Filters content in USS based on the last modification time. N - specify an exact number of days, +N - older than N days, -N - newer than N days
-
--name (string)
- Filters files in USS based on the name of the file or directory.
-
--overwrite | --ow (boolean)
- Overwrite files that already exist in your local environment
-
--owner (string)
- Filters content in USS based on the owning user name or ID.
-
--perm (string)
- Filters content in USS based on the octal permissions string.
-
--size (string)
- Filters content in USS based on the size. Default units are bytes. Add a suffix of K for kilobytes, M for megabytes, or G for gigabytes. N - specify an exact file size, +N - larger than N size, -N - smaller than N size
-
--symlinks (boolean)
- Filters content in USS based on whether or not to follow symbolic links. true - report symlinks, false - follow symlinks
-
--type (string)
-
Filters content in USS based on the type of content. f - regular file, d - directory, l - symbolic link, p - FIFO named pipe, s - socket
Allowed values: f, d, l, p, s
-
--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 the directory "/a/ibmuser" to "./" in binary mode:
zowe zos-files download uss-directory /a/ibmuser --binary
-
Download the directory "/a/ibmuser" to "./localDir":
zowe zos-files download uss-directory /a/ibmuser --directory localDir
-
Download files from the directory "/a/ibmuser" that match the name "*.log" and were modified within the last day:
zowe zos-files download uss-directory /a/ibmuser --name "*.log" --mtime -1
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
Edit the contents of a data set or USS file with your terminal and default editor.
Edit content from a z/OS data set with your terminal and default editor.
Usage
zowe zos-files edit data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set you want to edit.
Options
-
--editor | --ed (string)
- Editor that overrides the default editor for this file type. Set the option to the editor's executable file location or the program's name: ie "--editor notepad"
-
--extension | --ext (string)
- Set the file extension of the file for editing to leverage an editor's file-type-specific formatting: ie "--extension jcl"
-
--binary | -b (boolean)
- Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
-
--encoding | --ec (string)
- Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--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
-
Edit the contents of the data set member "ibmuser.cntl(iefbr14)":
zowe zos-files edit data-set ibmuser.cntl(iefbr14) --editor notepad
-
Edit the contents of the data set member "ibmuser.cntl(iefbr14)":
zowe zos-files edit data-set ibmuser.cntl(iefbr14) --editor C:\Windows\System32\Notepad.exe
-
Edit the contents of the data set member "ibmuser.jcl(iefbr14)" and set extension as "jcl":
zowe zos-files edit data-set ibmuser.jcl(iefbr14) --binary
Edit content from a Unix System Services (USS) file with your terminal and default editor.
Usage
zowe zos-files edit uss-file <ussFilePath> [options]
Positional Arguments
-
ussFilePath (string)
- The path of the USS file you want to edit.
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
-
Edit the contents of the USS file "/a/ibmuser/my_text.txt" in notepad:
zowe zos-files edit uss-file /a/ibmuser/my_text.txt --editor notepad
-
Edit the contents of the USS file "/a/ibmuser/my_text.txt" in notepad:
zowe zos-files edit uss-file /a/ibmuser/my_text.txt --editor C:\Windows\System32\Notepad.exe
-
Edit the contents of the USS file "/a/ibmuser/my_jcl.jcl" with binary flag set:
zowe zos-files edit uss-file /a/ibmuser/my_text.txt --binary
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 (string)
- 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.
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
-
--include-hidden | --ih (boolean)
- Include hidden files and folders that have names beginning with a dot
-
--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 (string)
- 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
View the contents of a data set or USS file on your terminal (stdout).
View content from a z/OS data set on your terminal (stdout).
Usage
zowe zos-files view data-set <dataSetName> [options]
Positional Arguments
-
dataSetName (string)
- The name of the data set you want to display.
Options
-
--binary | -b (boolean)
- Transfer the file content in binary mode (no EBCDIC to ASCII conversion).
-
--encoding | --ec (string)
- Transfer the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
-
--record | -r (boolean)
- Transfer 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.
-
--range | -R (string)
- The range of records to return in either `SSS-EEE` or `SSS,NNN` format. SSS identifies the start record, EEE identifies the end record, and NNN identifies the number of retrieved records.
-
--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
-
View the contents of the data set member "ibmuser.cntl(iefbr14)":
zowe zos-files view data-set "ibmuser.cntl(iefbr14)"
-
View the contents of the data set member "ibmuser.test.loadlib(main)" in binary mode:
zowe zos-files view data-set "ibmuser.test.loadlib(main)" --binary
-
View only the first two lines of content for data set member "ibmuser.cntl(iefbr14)":
zowe zos-files view data-set "ibmuser.cntl(iefbr14)" --range 0,2
-
View only lines six through eight (zero-based) in the contents of the data set member "ibmuser.cntl(iefbr14)":
zowe zos-files view data-set "ibmuser.cntl(iefbr14)" --range 5-7
View content from a Unix System Services (USS) file on your terminal (stdout).
Usage
zowe zos-files view uss-file <file> [options]
Positional Arguments
-
file (string)
- The name of the USS file you want to display.
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
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 dataset or partitioned dataset with '--dcb "PDSTYPE=PDS"'
Usage
zowe zos-ftp allocate data-set <datasetName> [options]
Positional Arguments
-
datasetName (string)
- The dataset name you'd like to allocate.
Options
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--recursive (boolean)
- Delete the directory and all files/directories under it.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--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.
-
--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.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--prefix (string)
- Specify the job name prefix of the jobs you own and want to list. You can specify a wildcard, which is usually in the form "JOB*".
If you don't specify this option all jobs under this owner will be listed by default.
-
--owner | -o (string)
- Specify the owner user ID 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.
-
--status | -s (string)
- Specify the status of the jobs you want to list. The status is one of the following: INPUT, ACTIVE and OUTPUT.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--binary | -b (boolean)
- Upload content in binary mode.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--binary | -b (boolean)
- Upload content in binary mode.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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.
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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
-
--binary | -b (boolean)
- View content in binary form without converting to ASCII text
FTP Connection 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 or delete multiple jobs in OUTPUT status.
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
Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by your user ID that are in output status.
Usage
zowe zos-jobs delete old-jobs [options]
Options
Zosmf Connection Options
-
--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.
-
--binary | -b (boolean)
- If specified, job output will be downloaded in binary format instead of performing text conversion. Conflicts with record.
-
--record | -r (boolean)
- If specified, job output will be downloaded in record format instead of performing text conversion. Conflicts with binary.
-
--encoding | --ec (string)
- Download the spool file content with encoding mode, which means that data conversion is performed using the file encoding specified.
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
Modify the job class or the hold status of a job.
Modify the job class or the hold status of a job.
Usage
zowe zos-jobs modify 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
-
--jobclass (string)
- The job class (e.g. 'A', 'B', ...) assigned to the job.
-
--hold (boolean)
- Setting this flag will prevent a job from executing until entering a second command with the '--release' flag
-
--release (boolean)
- Flag that releases a held a job for execution
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
-
Modify class of job with job ID JOB0000:
zowe zos-jobs modify job JOB0000 --jobclass A
-
Hold job with job ID JOB0000:
zowe zos-jobs modify job JOB0000 --hold
-
Release job with job ID JOB0000:
zowe zos-jobs modify job JOB0000 --release
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".
-
--job-encoding | --je (string)
- The encoding that should be used to read the JCL into the z/OSMF JCL reader. JCL will be converted into this codepage from UTF-8 for the JES subsystem to parse.
-
--job-record-length | --jrl (number)
-
--job-record-format | --jrf (string)
-
The record format of the JCL being submitted, where V is variable, and F is fixed.
Default value: F
Allowed values: F, V
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".
-
--job-encoding | --je (string)
- The encoding that should be used to read the JCL into the z/OSMF JCL reader. JCL will be converted into this codepage from UTF-8 for the JES subsystem to parse.
-
--job-record-length | --jrl (number)
-
--job-record-format | --jrf (string)
-
The record format of the JCL being submitted, where V is variable, and F is fixed.
Default value: F
Allowed values: F, V
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) contained in a USS file. The command does not pre-validate the USS file path. The command presents errors verbatim from the z/OSMF Jobs REST endpoints. For more information about z/OSMF Jobs API errors, see the z/OSMF Jobs API REST documentation.
Usage
zowe zos-jobs submit uss-file <file> [options]
Positional Arguments
-
file (string)
- Path to the USS file that contains 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 the JCL in the USS file "/a/ibmuser/compile.jcl":
zowe zos-jobs submit uss-file "/a/ibmuser/compile.jcl"
-
Submit the JCL in the USS file "/a/ibmuser/compile.jcl", wait for the job to complete and print all output from the job:
zowe zos-jobs submit uss-file "/a/ibmuser/compile.jcl" --vasc
View details of z/OS jobs on spool/JES queues.
View the contents of each spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints.
Usage
zowe zos-jobs view all-spool-content <jobid> [options]
Positional Arguments
-
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
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
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.
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
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
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 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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
--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 exists 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 successfully 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 exists 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"
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