The event code that is passed, upper-cased, to API rules in the AOF variable API.ID. This code can be up to 10 characters long.
+
Repository identifier.
-
eventText(string)
+
reportHandle(string)
-
The event text that is passed, unaltered, to API rules in the AOF variable API.TEXT. This text can be up to 255 characters long.
+
Report handle.
+
+
+
+
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.
-
OPS/MVS Web Services / REST API connection options
+
Options
-
--user(string)
+
--convert-to-pdf | --to-pdf(boolean)
-
Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
Converts text report to PDF.
+
Default value: false
+
-
--password | --pass(string)
+
--page-orientation | --orientation(string)
-
Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
The hostname of the server where OPS/MVS Web Services / REST API is running.
+
+
Font size for converted PDF.
+
Default value: 12
+
-
--port | -p(number)
+
--green-bar(boolean)
-
The port number for OPS/MVS Web Services / REST API.
+
+
Include green-bar background in converted PDF.
+
Default value: false
+
-
--reject-unauthorized | --ru(boolean)
+
--pages(string)
-
If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.
-
Default value: true
+
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+)?))*
-
--protocol | --prot(string)
+
--content-filter | --filter(string)
-
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
-
Default value: https
-Allowed values: http, https
+
Filter text report content using a permanent filter definition.
+If the product instance does not support this feature, this option is ignored.
+
+
OM Web Viewer Connection Options
+
+
+
--host | --hostname(string)
+
+
Hostname or ip address of the target OM Web Viewer instance.
+
-
--subsystem | --subs(string)
+
--port(number)
-
Specifies the subsystem ID of the OPS/MVS instance to which commands will be directed. This parameter is ignored with the 'show status' and 'show subsystem' commands.
-
Default value: OPSS
+
Port of the target OM Web Viewer instance.
+
Default value: 443
-
--rest-api | --ra(boolean)
+
--user | --username(string)
+
User name used to authenticate against the target OM Web Viewer instance.
+
+
-
If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.
-
Default value: false
+
--password(string)
+
+
Password used to authenticate against the target OM Web Viewer instance.
+
+
+
+
--base-path(string)
+
+
+
Context name of the target OM Web Viewer instance.
+
Default value: web-viewer
-
--base-path | --bp(string)
+
--protocol(string)
-
NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.
+
+
Protocol of the target OM Web Viewer instance.
+
Default value: https
+Allowed values: http, https
+
Profile Options
-
--ops-profile | --ops-p(string)
+
--omview-profile | --omview-p(string)
-
The name of a (ops) profile to load for this command execution.
+
The name of a (omview) profile to load for this command execution.
+
+
+
+
--caview-profile | --caview-p(string)
+
+
The name of a (caview) profile to load for this command execution.
@@ -19887,6 +19976,15 @@
Profile Options
Base Connection Options
+
--reject-unauthorized | --ru(boolean)
+
+
+
Reject self-signed certificates.
+
Default value: true
+
+
+
+
--token-type | --tt(string)
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
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.
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+)?))*
-
OPS/MVS Web Services / REST API connection options
+
OM Web Viewer Connection Options
-
--user(string)
+
--host | --hostname(string)
-
Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
+
Hostname or ip address of the target OM Web Viewer instance.
-
--password | --pass(string)
+
--port(number)
-
Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
Port of the target OM Web Viewer instance.
+
Default value: 443
+
-
--host(string)
+
--user | --username(string)
-
The hostname of the server where OPS/MVS Web Services / REST API is running.
+
User name used to authenticate against the target OM Web Viewer instance.
-
--port | -p(number)
+
--password(string)
-
The port number for OPS/MVS Web Services / REST API.
+
Password used to authenticate against the target OM Web Viewer instance.
-
--reject-unauthorized | --ru(boolean)
+
--base-path(string)
-
If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.
-
Default value: true
+
Context name of the target OM Web Viewer instance.
+
Default value: web-viewer
-
--protocol | --prot(string)
+
--protocol(string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
+
Protocol of the target OM Web Viewer instance.
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. This parameter is ignored with the 'show status' and 'show subsystem' commands.
-
Default value: OPSS
-
-
-
-
--rest-api | --ra(boolean)
+
Profile Options
-
If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.
-
Default value: false
-
-
-
-
-
--base-path | --bp(string)
+
--omview-profile | --omview-p(string)
-
NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.
+
The name of a (omview) profile to load for this command execution.
-
-
Profile Options
-
-
--ops-profile | --ops-p(string)
+
--caview-profile | --caview-p(string)
-
The name of a (ops) profile to load for this command execution.
+
The name of a (caview) profile to load for this command execution.
@@ -20045,6 +20135,15 @@
Profile Options
Base Connection Options
+
--reject-unauthorized | --ru(boolean)
+
+
+
Reject self-signed certificates.
+
Default value: true
+
+
+
+
--token-type | --tt(string)
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
Output format. This option is ignored if '--response-format-json' is specified.
+
Default value: tabular
+Allowed values: tabular, csv, json, xml
+
-
rule(string)
+
--output-header | --header(boolean)
-
The name of the rule.
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
OPS/MVS Web Services / REST API connection options
+
+
+
OM Web Viewer Connection Options
-
--user(string)
+
--host | --hostname(string)
-
Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
+
Hostname or ip address of the target OM Web Viewer instance.
-
--password | --pass(string)
+
--port(number)
-
Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
Port of the target OM Web Viewer instance.
+
Default value: 443
+
-
--host(string)
+
--user | --username(string)
-
The hostname of the server where OPS/MVS Web Services / REST API is running.
+
User name used to authenticate against the target OM Web Viewer instance.
-
--port | -p(number)
+
--password(string)
-
The port number for OPS/MVS Web Services / REST API.
+
Password used to authenticate against the target OM Web Viewer instance.
-
--reject-unauthorized | --ru(boolean)
+
--base-path(string)
-
If set to true, the server certificate is verified against the list of supplied CAs. If set to false, certificate verification is not performed.
-
Default value: true
+
Context name of the target OM Web Viewer instance.
+
Default value: web-viewer
-
--protocol | --prot(string)
+
--protocol(string)
-
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
+
Protocol of the target OM Web Viewer instance.
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. This parameter is ignored with the 'show status' and 'show subsystem' commands.
-
Default value: OPSS
-
-
-
-
--rest-api | --ra(boolean)
+
Profile Options
-
If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.
-
Default value: false
-
-
-
-
-
--base-path | --bp(string)
+
--omview-profile | --omview-p(string)
-
NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.
+
The name of a (omview) profile to load for this command execution.
-
-
Profile Options
-
-
--ops-profile | --ops-p(string)
+
--caview-profile | --caview-p(string)
-
The name of a (ops) profile to load for this command execution.
+
The name of a (caview) 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
+
+
+
--reject-unauthorized | --ru(boolean)
+
+
+
Reject self-signed certificates.
+
Default value: true
+
+
+
+
+
--token-type | --tt(string)
+
+
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
+
+
+
+
--token-value | --tv(string)
+
+
The value of the token to pass to the API.
+
+
+
+
--cert-file(local file path)
+
+
+
The file path to a certificate file to use for authentication.
+
Note: The CLI does not support certificate files that require a password. For more information, search 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 export rules defined for a report.
+Use the returned 'Identifier' in the 'export report' command to reference that rule.
+
Usage
+
zowe omview list export-rules <reportId> [options]
+
Positional Arguments
+
+
+
reportId(string)
+
+
Report ID (Name).
+
+
+
+
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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
+
Default value: Identifier,Name,Description
+Allowed values: Identifier, Name, Description, Owner, Public
+
+
+
+
+
OM Web Viewer Connection Options
+
+
+
--host | --hostname(string)
+
+
Hostname or ip address of the target OM Web Viewer instance.
+
+
+
+
--port(number)
+
+
+
Port of the target OM Web Viewer instance.
+
Default value: 443
+
+
+
+
+
--user | --username(string)
+
+
User name used to authenticate against the target OM Web Viewer instance.
+
+
+
+
--password(string)
+
+
Password used to authenticate against the target OM Web Viewer instance.
+
+
+
+
--base-path(string)
+
+
+
Context name of the target OM Web Viewer instance.
+
Default value: web-viewer
+
+
+
+
+
--protocol(string)
+
+
+
Protocol of the target OM Web Viewer instance.
+
Default value: https
+Allowed values: http, https
+
+
+
+
+
Profile Options
+
+
+
--omview-profile | --omview-p(string)
+
+
The name of a (omview) profile to load for this command execution.
+
+
+
+
--caview-profile | --caview-p(string)
+
+
The name of a (caview) 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
+
+
+
--reject-unauthorized | --ru(boolean)
+
+
+
Reject self-signed certificates.
+
Default value: true
+
+
+
+
+
--token-type | --tt(string)
+
+
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
+
+
+
+
--token-value | --tv(string)
+
+
The value of the token to pass to the API.
+
+
+
+
--cert-file(local file path)
+
+
+
The file path to a certificate file to use for authentication.
+
Note: The CLI does not support certificate files that require a password. For more information, search 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 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 omview list report index-names <repositoryId> <reportHandle> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
reportHandle(string)
+
+
Report handle.
+
+
+
+
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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
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 omview list report index-values <repositoryId> <reportHandle> <indexNameHandle> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
reportHandle(string)
+
+
Report handle.
+
+
+
+
indexNameHandle(string)
+
+
Index name handle.
+
+
+
+
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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
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 omview list report logical-views <repositoryId> <reportHandle> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
reportHandle(string)
+
+
Report handle.
+
+
+
+
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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
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 omview list reports <repositoryId> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
Options
+
+
+
--filter-name | -n(string)
+
+
+
Filter (include) based on report name. Use the asterisk (*) as a wildcard to represent any number of characters.
Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
+
+
+
+
--output-header | --header(boolean)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--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.
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 omview list repositories [options]
+
Options
+
+
+
--filter-name | -n(string)
+
+
Filter (include) based on repository name. Use the question mark (?) as a wildcard to represent a single character. Use the asterisk (*) as a wildcard to represent any number of characters.
+
+
+
+
--filter-path | -p(string)
+
+
+
Filter (include) based on repository path. Use the percent sign (%) as a wildcard to represent a single character. 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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
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 omview search index names <repositoryId> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
Options
+
+
+
--filter-reports | --reports(string)
+
+
+
Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.
+
Default value: *
+
+
+
+
+
--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.
Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
+
+
+
+
--online-only | --online(boolean)
+
+
+
Include only those reports that are available online.
+
Default value: true
+
+
+
+
+
--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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
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 omview search index reports <repositoryId> <indexNameHandle> <valueHandle> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
indexNameHandle(string)
+
+
Index name handle.
+
+
+
+
valueHandle(string)
+
+
Index value handle.
+
+
+
+
Options
+
+
+
--filter-reports | --reports(string)
+
+
+
Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.
Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
+
+
+
+
--online-only | --online(boolean)
+
+
+
Include only those reports that are available online.
+
Default value: true
+
+
+
+
+
--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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
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 omview search index values <repositoryId> <indexNameHandle> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
indexNameHandle(string)
+
+
Index name handle.
+
+
+
+
Options
+
+
+
--filter-reports | --reports(string)
+
+
+
Filter (include) based on report names (IDs). Use the asterisk (*) as a wildcard to represent any number of characters.
+
Default value: *
+
+
+
+
+
--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.
Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format.
+
+
+
+
--online-only | --online(boolean)
+
+
+
Include only those reports that are available online.
+
Default value: true
+
+
+
+
+
--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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
Set distribution id for current user in repository.
+
Usage
+
zowe omview set user distribution <repositoryId> <distributionId> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
distributionId(string)
+
+
Distribution ID.
+
+
+
+
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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
zowe omview set user mode <repositoryId> <mode> [options]
+
Positional Arguments
+
+
+
repositoryId(number)
+
+
Repository identifier.
+
+
+
+
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)
+
+
+
Include header with field names in the output when you specify 'tabular' or 'csv' for the output format.
+This option is ignored when you specify any other output format.
+
Default value: true
+
+
+
+
+
--output-field | -f(array)
+
+
+
Field to include in the output. Multiple fields can be specified. Fields appear in the order you specify.
The event code that is passed, upper-cased, to API rules in the AOF variable API.ID. This code can be up to 10 characters long.
+
+
+
+
eventText(string)
+
+
The event text that is passed, unaltered, to API rules in the AOF variable API.TEXT. This text can be up to 255 characters long.
+
+
+
+
OPS/MVS Web Services / REST API connection options
+
+
+
--user(string)
+
+
Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
+
+
--password | --pass(string)
+
+
Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
+
+
--host(string)
+
+
The hostname of the server where OPS/MVS Web Services / REST API is running.
+
+
+
+
--port | -p(number)
+
+
The port number for OPS/MVS Web Services / REST API.
+
+
+
+
--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.
+
Default value: true
+
+
+
+
+
--protocol | --prot(string)
+
+
+
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
+
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. This parameter is ignored with the 'show status' and 'show subsystem' commands.
+
Default value: OPSS
+
+
+
+
+
--rest-api | --ra(boolean)
+
+
+
If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.
+
Default value: false
+
+
+
+
+
--base-path | --bp(string)
+
+
NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.
+
+
+
+
Profile Options
+
+
+
--ops-profile | --ops-p(string)
+
+
The name of a (ops) 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
+
+
+
Create a generic AOF event, "EVENTCODE" for API rules processing on the "OPSS" subsystem.:
OPS/MVS Web Services / REST API connection options
+
+
+
--user(string)
+
+
Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
+
+
--password | --pass(string)
+
+
Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
+
+
--host(string)
+
+
The hostname of the server where OPS/MVS Web Services / REST API is running.
+
+
+
+
--port | -p(number)
+
+
The port number for OPS/MVS Web Services / REST API.
+
+
+
+
--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.
+
Default value: true
+
+
+
+
+
--protocol | --prot(string)
+
+
+
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
+
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. This parameter is ignored with the 'show status' and 'show subsystem' commands.
+
Default value: OPSS
+
+
+
+
+
--rest-api | --ra(boolean)
+
+
+
If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.
+
Default value: false
+
+
+
+
+
--base-path | --bp(string)
+
+
NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.
+
+
+
+
Profile Options
+
+
+
--ops-profile | --ops-p(string)
+
+
The name of a (ops) 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
+
+
+
Disable the rule "MYRULE" in the ruleset "OPSRULES" for the "OPSS" subsystem.:
OPS/MVS Web Services / REST API connection options
+
+
+
--user(string)
+
+
Your z/OS user name that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
+
+
--password | --pass(string)
+
+
Your z/OS password that is used to authenticate to OPS/MVS Web Services / REST API.
+
+
+
+
--host(string)
+
+
The hostname of the server where OPS/MVS Web Services / REST API is running.
+
+
+
+
--port | -p(number)
+
+
The port number for OPS/MVS Web Services / REST API.
+
+
+
+
--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.
+
Default value: true
+
+
+
+
+
--protocol | --prot(string)
+
+
+
The protocol that is used for connecting to OPS/MVS Web Services / REST API.
+
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. This parameter is ignored with the 'show status' and 'show subsystem' commands.
+
Default value: OPSS
+
+
+
+
+
--rest-api | --ra(boolean)
+
+
+
If set to true, the plug-in executes the command against the OPS/MVS REST API. If set to false, the plug-in executes against the OPS/MVS Web Services.
+
Default value: false
+
+
+
+
+
--base-path | --bp(string)
+
+
NOTE: This can only be used with the REST API server. The base path for your Zowe 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 Zowe API Mediation Layer.
+
+
+
+
Profile Options
+
+
+
--ops-profile | --ops-p(string)
+
+
The name of a (ops) profile to load for this command execution.
@@ -28250,6 +30792,12 @@
Required Options
Options
+
--ignore-not-found | -i | --inf(boolean)
+
+
Suppress errors if the data set does not exist.
+
+
+
--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.
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
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
@@ -28937,15 +31530,6 @@
Zosmf Connection Options
-
Options
-
-
-
--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
The name of the data set from which you want to download members
+
+
+
+
pattern(string)
+
+
The pattern or patterns to match members 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 member
+You can specify multiple patterns separated by commas, for example "Mem*, Test*"
+
+
+
+
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.
+
+
+
+
--fail-fast | --ff(boolean)
+
+
+
Set this option to false to continue downloading data set members if one or more fail.
+
Default value: true
+
+
+
+
+
--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)
+
+
+
Specifies if the automatically generated directories and files use the original letter case.
+
Default value: false
+
+
+
+
+
--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)
+
+
+
Reject self-signed certificates.
+
Default value: true
+
+
+
+
+
--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)
+
+
+
The protocol used (HTTP or HTTPS)
+
Default value: https
+Allowed values: http, https
+
+
+
+
+
--cert-file(local file path)
+
+
The file path to a 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.
+
+
+
+
--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.
+
+
+
+
Examples
+
+
+
Download the members of the data set "ibmuser.loadlib" that begin with "Test" to the directory "loadlib/":
Download the members of the data set "ibmuser.cntl" that begin with "Test" & "M" to the directory "output",
+and exclude members that begin with "M2".:
Download content from a z/OS data set to a local file.
Usage
@@ -29852,6 +32656,12 @@
Positional Arguments
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.
Edit the contents of a data set or USS file with your terminal and default editor.
@@ -32005,7 +34821,7 @@
Positional Arguments
searchString(string)
-
The parameter to search for
+
The parameter to search for.
@@ -32021,6 +34837,12 @@
Options
+
--encoding | --ec(string)
+
+
Search the file content with encoding mode, which means that data conversion is performed using the file encoding specified.
+
+
+
--mainframe-search | --ms(boolean)
@@ -32041,7 +34863,7 @@
Options
--timeout | --to(number)
-
The number of seconds to search before timing out
+
The number of seconds to search before timing out.
@@ -32566,6 +35388,12 @@
Options
+
--encoding | --ec(string)
+
+
Data content in encoding mode, which means that data conversion is performed according to the 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
Path of an attributes file to control how files are uploaded.
+
+
+
--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
@@ -38075,66 +40915,558 @@
Base Connection Options
-
Examples
+
Examples
+
+
+
Delete all of your jobs in output status with a job name starting with "ibmuser":
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.
+
+
+
+
--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.
+
+
+
+
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)
+
+
+
Reject self-signed certificates.
+
Default value: true
+
+
+
+
+
--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)
+
+
+
The protocol used (HTTP or HTTPS)
+
Default value: https
+Allowed values: http, https
+
+
+
+
+
--cert-file(local file path)
+
+
The file path to a 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.
+
+
+
+
--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.
+
+
+
+
Examples
+
+
+
Download all the output of the job with job ID JOB00234 to an automatically generated directory.:
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
+
+
+
--owner | -o(string)
+
+
Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "USER*".
+
+
+
+
--prefix | -p(string)
+
+
Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "JOB*".
+
+
+
+
--exec-data | --ed(boolean)
+
+
Use this option to retrieve execution data for jobs via the z/OSMF REST API.
+
+
+
+
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)
+
+
+
Reject self-signed certificates.
+
Default value: true
+
+
+
+
+
--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)
+
+
+
The protocol used (HTTP or HTTPS)
+
Default value: https
+Allowed values: http, https
+
+
+
+
+
--cert-file(local file path)
+
+
The file path to a 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.
+
+
+
+
--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.
+
+
+
+
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)
+
+
+
Reject self-signed certificates.
+
Default value: true
+
+
+
+
+
--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)
+
+
+
The protocol used (HTTP or HTTPS)
+
Default value: https
+Allowed values: http, https
+
+
+
+
+
--cert-file(local file path)
+
+
The file path to a 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.
+
+
+
+
--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.
+
+
+
+
Response Format Options
-
Delete all of your jobs in output status with a job name starting with "ibmuser":
+
--response-format-filter | --rff(array)
-
zowe zos-jobs delete old-jobs -p "ibmuser*"
+
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.
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)
+
--response-format-type | --rft(string)
-
The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
-
+
+
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
-
Options
-
+
-
--directory | -d | --dir(string)
+
--response-format-header | --rfh(boolean)
-
The local directory you would like to download the output for the job to.
+
If "--response-format-type table" is specified, include the column headers in the output.
+
+
Examples
+
-
--extension | -e(string)
+
List the spool files of the job with JOBID JOB00123:
-
A file extension to save the job output with. Defaults to '.txt'.
If specified, job output will be saved directly to the specified directory rather than creating a subdirectory named after the ID of the job.
+
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
+
-
--binary | -b(boolean)
+
--jobclass(string)
-
If specified, job output will be downloaded in binary format instead of performing text conversion. Conflicts with record.
+
The job class (e.g. 'A', 'B', ...) assigned to the job.
-
--record | -r(boolean)
+
--hold(boolean)
-
If specified, job output will be downloaded in record format instead of performing text conversion. Conflicts with binary.
+
Setting this flag will prevent a job from executing until entering a second command with the '--release' flag
-
--encoding | --ec(string)
+
--release(boolean)
-
Download the spool file content with encoding mode, which means that data conversion is performed using the file encoding specified.
+
Flag that releases a held a job for execution
@@ -38238,36 +41570,78 @@
Base Connection Options
Examples
-
Download all the output of the job with job ID JOB00234 to an automatically generated directory.:
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.
The job name to search. Wildcards are accepted for the job name. You can use, for example "USERJOB*" to search all jobs that start with USERJOB.
+
+
+
Options
-
--owner | -o(string)
+
--search-string | --string(string)
-
Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "USER*".
+
The string to search for in the spool output.
-
--prefix | -p(string)
+
--search-regex | --regex(string)
-
Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the z/OSMF Jobs REST endpoint documentation, which is usually in the form "JOB*".
+
The regular expression to search for in the spool output.
-
--exec-data | --ed(boolean)
+
--case-insensitive | --ci(boolean)
-
Use this option to retrieve execution data for jobs via the z/OSMF REST API.
+
+
The search is case insensitive or not.
+
Default value: true
+
+
+
+
+
--search-limit | --sl(number)
+
+
+
The maximum number of matching lines to return for an individual spool file.
+
Default value: 100
+
+
+
+
+
--file-limit | --fl(number)
+
+
+
The maximum number of spool files to search.
+
Default value: 100
+
@@ -38368,83 +41742,84 @@
Base Connection Options
-
Response Format Options
+
Examples
-
--response-format-filter | --rff(array)
+
Search all jobs named USERJOB for the string "RC=0000":
-
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.
Search all jobs that start with USER for the string "ENDED":
-
-
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.
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
-
List all jobs with default settings. The command returns jobs owned by your user ID with any job name:
+
dataset(string)
-
zowe zos-jobs list jobs
+
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
+
-
List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo':
+
--volume | --vol(string)
-
zowe zos-jobs list jobs -o "ibmu*" -p "myjo*"
+
The volume serial (VOLSER) where the data set resides. The option is required only when the data set is not catalogued on the system.
-
List all jobs with default owner and prefix settings, displaying only the job ID of each job:
+
--wait-for-active | --wfa(boolean)
-
zowe zos-jobs list jobs --rff jobid --rft table
+
Wait for the job to enter ACTIVE status before completing the command.
-
List all jobs and return job execution data along with the default information:
+
--wait-for-output | --wfo(boolean)
-
zowe zos-jobs list jobs --exec-data
+
Wait for the job to enter OUTPUT status before completing the command.
-
List all jobs owned by user IDs starting with 'ibmu' and return job execution data along with the default information:
+
--view-all-spool-content | --vasc(boolean)
-
zowe zos-jobs list jobs -o "ibmu*" --exec-data
+
Print all spool output. If you use this option you will wait for the job to complete.
-
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:
+
--directory | -d(string)
-
zowe zos-jobs list jobs -o "ibmu*" -p "myjo*" --exec-data
+
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.
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
+
+
--extension | -e(string)
+
A file extension to save the job output with. Default is '.txt'.
+
+
-
jobid(string)
+
--jcl-symbols | --js(string)
-
The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.
+
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".
@@ -38576,45 +41951,92 @@
Response Format Options
Examples
-
List the spool files of the job with JOBID JOB00123:
+
Submit the JCL in the data set "ibmuser.cntl(deploy)":
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.
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".
+
The local file containing the JCL to submit.
Options
-
--jobclass(string)
+
--wait-for-active | --wfa(boolean)
-
The job class (e.g. 'A', 'B', ...) assigned to the job.
+
Wait for the job to enter ACTIVE status before completing the command.
-
--hold(boolean)
+
--wait-for-output | --wfo(boolean)
-
Setting this flag will prevent a job from executing until entering a second command with the '--release' flag
+
Wait for the job to enter OUTPUT status before completing the command.
-
--release(boolean)
+
--view-all-spool-content | --vasc(boolean)
-
Flag that releases a held a job for execution
+
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)
+
+
+
The logical record length of the JCL being submitted.
+
Default value: 80
+
+
+
+
+
--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
+
@@ -38715,80 +42137,107 @@
Base Connection Options
-
Examples
+
Response Format Options
-
Modify class of job with job ID JOB0000:
+
--response-format-filter | --rff(array)
-
zowe zos-jobs modify job JOB0000 --jobclass A
+
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.
-
Hold job with job ID JOB0000:
+
--response-format-type | --rft(string)
-
zowe zos-jobs modify job JOB0000 --hold
+
+
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
+
-
Release job with job ID JOB0000:
+
--response-format-header | --rfh(boolean)
-
zowe zos-jobs modify job JOB0000 --release
+
If "--response-format-type table" is specified, include the column headers in the output.
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
-
--search-string | --string(string)
+
--wait-for-active | --wfa(boolean)
-
The string to search for in the spool output.
+
Wait for the job to enter ACTIVE status before completing the command.
-
--search-regex | --regex(string)
+
--wait-for-output | --wfo(boolean)
-
The regular expression to search for in the spool output.
+
Wait for the job to enter OUTPUT status before completing the command.
-
--case-insensitive | --ci(boolean)
+
--view-all-spool-content | --vasc(boolean)
+
Print all spool output. If you use this option you will wait for the job to complete.
+
+
-
The search is case insensitive or not.
-
Default value: true
+
--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".
-
--search-limit | --sl(number)
+
--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.
+
+
-
The maximum number of matching lines to return for an individual spool file.
-
Default value: 100
+
--job-record-length | --jrl(number)
+
+
+
The logical record length of the JCL being submitted.
+
Default value: 80
-
--file-limit | --fl(number)
+
--job-record-format | --jrf(string)
-
The maximum number of spool files to search.
-
Default value: 100
+
The record format of the JCL being submitted, where V is variable, and F is fixed.
+
Default value: F
+Allowed values: F, V
@@ -38890,50 +42339,64 @@
Base Connection Options
-
Examples
+
Response Format Options
-
Search all jobs named USERJOB for the string "RC=0000":
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.
-
Search all jobs that start with USER for the string "ENDED":
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
+
-
Search all jobs named USERJOB for the string "COND CODE", with the options case sensitive and a search limit of 5:
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
+
Examples
-
dataset(string)
+
Submit the JCL in the file "iefbr14.txt" via standard in:
-
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)").
+
zowe zos-jobs submit stdin < iefbr14.txt
+
+
+
+
Submit the JCL in the file "iefbr14.txt" via standard in from the output of another command:
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
-
--volume | --vol(string)
+
file(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.
+
Path to the USS file that contains the JCL to submit.
+
+
Options
+
--wait-for-active | --wfa(boolean)
@@ -39099,93 +42562,159 @@
Response Format Options
Examples
-
Submit the JCL in the data set "ibmuser.cntl(deploy)":
+
Submit the JCL in the USS file "/a/ibmuser/compile.jcl":
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.
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.
The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
Options
-
--wait-for-active | --wfa(boolean)
+
--encoding | --ec(string)
-
Wait for the job to enter ACTIVE status before completing the command.
+
Download the spool file content with encoding mode, which means that data conversion is performed using the file encoding specified.
+
+
Zosmf Connection Options
+
-
--wait-for-output | --wfo(boolean)
+
--host | -H(string)
-
Wait for the job to enter OUTPUT status before completing the command.
+
The z/OSMF server host name.
-
--view-all-spool-content | --vasc(boolean)
+
--port | -P(number)
-
Print all spool output. If you use this option you will wait for the job to complete.
+
+
The z/OSMF server port.
+
Default value: 443
+
-
--directory | -d(string)
+
--user | -u(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.
+
Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--extension | -e(string)
+
--password | --pass | --pw(string)
-
A file extension to save the job output with. Default is '.txt'.
+
Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--jcl-symbols | --js(string)
+
--reject-unauthorized | --ru(boolean)
-
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".
+
+
Reject self-signed certificates.
+
Default value: true
+
-
--job-encoding | --je(string)
+
--base-path | --bp(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.
+
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.
-
--job-record-length | --jrl(number)
+
--protocol(string)
-
The logical record length of the JCL being submitted.
-
Default value: 80
+
The protocol used (HTTP or HTTPS)
+
Default value: https
+Allowed values: http, https
-
--job-record-format | --jrf(string)
+
--cert-file(local file path)
+
The file path to a certificate file to use for authentication
+
+
-
The record format of the JCL being submitted, where V is variable, and F is fixed.
-
Default value: F
-Allowed values: F, V
+
--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.
+
+
+
+
--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.
+
+
+
+
Examples
+
+
+
View all spool files for the job with job ID JOB00234:
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").
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)
+
View status and other details of the job with the job ID JOB00123:
-
Print all spool output. If you use this option you will wait for the job to complete.
+
zowe zos-jobs view job-status-by-jobid j123
-
--directory | -d(string)
+
Print only the status (for example, "OUTPUT" or "ACTIVE") of the job with the job ID JOB00123:
-
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.
+
zowe zos-jobs view job-status-by-jobid j123 --rff status --rft string
-
-
--extension | -e(string)
-
-
A file extension to save the job output with. Default is '.txt'.
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.
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)
+
jobid(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.
+
The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.
-
--job-record-length | --jrl(number)
+
spoolfileid(number)
-
-
The logical record length of the JCL being submitted.
-
Default value: 80
-
+
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.
-
-
--job-record-format | --jrf(string)
+
+
Options
-
The record format of the JCL being submitted, where V is variable, and F is fixed.
-
Default value: F
-Allowed values: F, V
-
+
--encoding | --ec(string)
+
+
Download the spool file content with encoding mode, which means that data conversion is performed using the file encoding specified.
@@ -39487,98 +42982,52 @@
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 file "iefbr14.txt" via standard in:
-
-
zowe zos-jobs submit stdin < iefbr14.txt
-
-
-
-
Submit the JCL in the file "iefbr14.txt" via standard in from the output of another command:
+
View the spool file with ID 4 for the job with job ID JOB00123:
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.
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-jobs submit uss-file <file> [options]
-
Positional Arguments
-
-
-
file(string)
-
-
Path to the USS file that contains the JCL to submit.
-
-
-
+
zowe zos-logs list logs [options]
Options
-
--wait-for-active | --wfa(boolean)
+
--start-time | --st(string)
-
Wait for the job to enter ACTIVE status before completing the command.
+
Specify the time in ISO-8601 time format from when z/OSMF will start to retrieve the logs. For example, '2021-01-26T03:33:18.065Z', '2021-01-26T11:33:18.065+08:00'. Default is the current time.
-
--wait-for-output | --wfo(boolean)
+
--direction | -d(string)
-
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.
-
+
Specify the direction when retrieving the message log. Either 'forward' or 'backward' is valid, case insensitive.
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)
+
--range | -r(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".
+
Specify a time range in which the logs will be retrieved. The format is like nnnu, nnn is 1-999, u is one of 's', 'm', 'h', for example, '999s', '20m', '3h'.
+
Default value: 10m
+
@@ -39679,102 +43128,120 @@
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)
+
Examples
-
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)
+
List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later:
-
If "--response-format-type table" is specified, include the column headers in the output.
+
zowe zos-logs list logs --start-time 2021-07-26T03:38:37.098Z --range 5m --direction forward
-
-
Examples
-
-
Submit the JCL in the USS file "/a/ibmuser/compile.jcl":
+
List logs starting from '2021-07-26T03:38:37.098Z' and forwards to 5 minutes later. Alias version of the above command:
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.
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.
The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.
+
z/OS USS command to issue.
Options
-
--encoding | --ec(string)
+
--cwd(string)
-
Download the spool file content with encoding mode, which means that data conversion is performed using the file encoding specified.
+
Working directory in which to execute the command.
-
Zosmf Connection Options
+
z/OS Ssh Connection Options
--host | -H(string)
-
The z/OSMF server host name.
+
The z/OS SSH server host name.
--port | -P(number)
-
The z/OSMF server port.
-
Default value: 443
+
The z/OS SSH server port.
+
Default value: 22
--user | -u(string)
-
Mainframe (z/OSMF) user name, which can be the same as your TSO login.
+
Mainframe 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.
+
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
+
+
+
--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
+
--reject-unauthorized | --ru(boolean)
@@ -39785,25 +43252,24 @@
Zosmf Connection Options
-
--base-path | --bp(string)
+
--token-type | --tt(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.
+
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
--protocol(string)
+
--token-value | --tv(string)
-
-
The protocol used (HTTP or HTTPS)
-
Default value: https
-Allowed values: http, https
-
+
The value of the token to pass to the API.
--cert-file(local file path)
-
The file path to a certificate file to use for authentication
+
+
The file path to a certificate file to use for authentication.
+
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
+
@@ -39813,55 +43279,114 @@
Zosmf Connection Options
-
Profile Options
+
Examples
-
--zosmf-profile | --zosmf-p(string)
+
Issue a simple command, giving the working directory:
-
The name of a (zosmf) profile to load for this command execution.
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.
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").
The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.
+
+
The logon procedure to use when creating TSO procedures on your behalf.
+
Default value: IZUFPROC
+
+
+
+
+
--region-size | --rs(number)
+
+
+
Region size for the TSO/E address space.
+
Default value: 4096
+
+
+
+
+
--rows(number)
+
+
+
The number of rows on a screen.
+
Default value: 24
+
@@ -39941,6 +43466,12 @@
Profile Options
+
--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.
@@ -39962,74 +43493,27 @@
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:
+
Issue the TSO command "status" to display information about jobs for your user ID.:
-
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.
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
-
-
-
--encoding | --ec(string)
+
servletKey(string)
-
Download the spool file content with encoding mode, which means that data conversion is performed using the file encoding specified.
+
The servlet key from a previously started TSO address space.
@@ -40133,48 +43617,113 @@
Base Connection Options
Examples
-
View the spool file with ID 4 for the job with job ID JOB00123:
+
Ping the TSO address space identified by IBMUSER-329-aafkaaoc:
Specify the time in ISO-8601 time format from when z/OSMF will start to retrieve the logs. For example, '2021-01-26T03:33:18.065Z', '2021-01-26T11:33:18.065+08:00'. Default is the current time.
+
Your z/OS TSO/E accounting information.
-
--direction | -d(string)
+
--character-set | --cs(string)
-
Specify the direction when retrieving the message log. Either 'forward' or 'backward' is valid, case insensitive.
Character set for address space to convert messages and responses from UTF-8 to EBCDIC.
+
Default value: 697
-
--range | -r(string)
+
--code-page | --cp(string)
-
Specify a time range in which the logs will be retrieved. The format is like nnnu, nnn is 1-999, u is one of 's', 'm', 'h', for example, '999s', '20m', '3h'.
-
Default value: 10m
+
Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.
+
Default value: 1047
+
+
+
+
+
--columns | --cols(number)
+
+
+
The number of columns on a screen.
+
Default value: 80
+
+
+
+
+
--logon-procedure | -l(string)
+
+
+
The logon procedure to use when creating TSO procedures on your behalf.
+
Default value: IZUFPROC
+
+
+
+
+
--region-size | --rs(number)
+
+
+
Region size for the TSO/E address space.
+
Default value: 4096
+
+
+
+
+
--rows(number)
+
+
+
The number of rows on a screen.
+
Default value: 24
+
+
+
+
+
Required Options
+
+
+
--app-key | --ak(string)
+
+
App key of application running at TSO address space, app key should be the value established when app instance was started
+
+
+
+
--servlet-key | --sk(string)
+
+
Servlet Key of TSO address space
+
+
+
+
Options
+
+
+
--receive-until-ready | --rur(boolean)
+
+
+
Receives data until keyword is received or timeout
+
Default value: false
+
+
+
+
+
--timeout | -t(number)
+
+
+
Timeout length in seconds, all data at the time of timeout will be returned to user
+
Default value: 600
@@ -40255,6 +43804,12 @@
Profile Options
+
--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.
@@ -40276,193 +43831,140 @@
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
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.
The servlet key from a previously started TSO address space.
-
Options
+
Required Options
-
--cwd(string)
+
--data(string)
-
Working directory in which to execute the command.
+
The data to which we want to send to the TSO address space represented by the servlet key.
-
z/OS Ssh Connection Options
+
Zosmf Connection Options
--host | -H(string)
-
The z/OS SSH server host name.
+
The z/OSMF server host name.
--port | -P(number)
-
The z/OS SSH server port.
-
Default value: 22
+
The z/OSMF server port.
+
Default value: 443
--user | -u(string)
-
Mainframe user name, which can be the same as your TSO login.
+
Mainframe (z/OSMF) 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
+
Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--keyPassphrase | --passphrase | --kp(string)
+
--reject-unauthorized | --ru(boolean)
-
Private key passphrase, which unlocks the private key.
-
-
-
--handshakeTimeout | --timeout | --to(number)
-
-
How long in milliseconds to wait for the SSH handshake to complete.
-
+
Reject self-signed certificates.
+
Default value: true
-
Profile Options
-
-
-
--ssh-profile | --ssh-p(string)
-
-
The name of a (ssh) profile to load for this command execution.
-
-
--base-profile | --base-p(string)
+
--base-path | --bp(string)
-
The name of a (base) profile to load for this command execution.
+
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.
-
-
Base Connection Options
-
-
--reject-unauthorized | --ru(boolean)
+
--protocol(string)
-
Reject self-signed certificates.
-
Default value: true
+
The protocol used (HTTP or HTTPS)
+
Default value: https
+Allowed values: http, https
-
--token-type | --tt(string)
+
--cert-file(local file path)
-
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
+
The file path to a certificate file to use for authentication
-
--token-value | --tv(string)
+
--cert-key-file(local file path)
-
The value of the token to pass to the API.
+
The file path to a certificate key file to use for authentication
-
-
--cert-file(local file path)
+
+
Profile Options
-
The file path to a certificate file to use for authentication.
-
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
+
--zosmf-profile | --zosmf-p(string)
+
+
The name of a (zosmf) profile to load for this command execution.
-
--cert-key-file(local file path)
+
--base-profile | --base-p(string)
-
The file path to a certificate key file to use for authentication
+
The name of a (base) profile to load for this command execution.
-
Examples
+
Base Connection Options
-
Issue a simple command, giving the working directory:
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.
The servlet key from a previously started TSO address space.
-
-
-
-
Zosmf Connection Options
+
zowe zos-tso start address-space [options]
+
TSO ADDRESS SPACE OPTIONS
-
--host | -H(string)
+
--account | -a(string)
-
The z/OSMF server host name.
+
Your z/OS TSO/E accounting information.
-
--port | -P(number)
+
--character-set | --cs(string)
-
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.
-
+
Character set for address space to convert messages and responses from UTF-8 to EBCDIC.
+
Default value: 697
-
-
--password | --pass | --pw(string)
-
-
Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru(boolean)
+
--code-page | --cp(string)
-
Reject self-signed certificates.
-
Default value: true
+
Codepage value for TSO/E address space to convert messages and responses from UTF-8 to EBCDIC.
+
Default value: 1047
-
--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)
+
--columns | --cols(number)
-
The protocol used (HTTP or HTTPS)
-
Default value: https
-Allowed values: http, https
+
The number of columns on a screen.
+
Default value: 80
-
--cert-file(local file path)
+
--logon-procedure | -l(string)
-
The file path to a certificate file to use for authentication
-
-
-
--cert-key-file(local file path)
-
-
The file path to a certificate key file to use for authentication
-
+
The logon procedure to use when creating TSO procedures on your behalf.
+
Default value: IZUFPROC
-
Profile Options
-
-
-
--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
+
--region-size | --rs(number)
-
--token-type | --tt(string)
-
-
The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
-
+
Region size for the TSO/E address space.
+
Default value: 4096
-
-
--token-value | --tv(string)
-
-
The value of the token to pass to the API.
-
-
Examples
-
-
Ping the TSO address space identified by IBMUSER-329-aafkaaoc:
App key of application running at TSO address space, this app key value should be referenced when sending or receiving messages from the application instance
+
+
+
+
--startup | --sc(string)
+
+
Command to be ran to start application at the TSO address space
+
+
+
Options
-
--servlet-key-only | --sko(boolean)
+
--queue-id | --qi(string)
-
Specify this option to print only the servlet key
+
Queue ID of TSO address space
+
+
+
+
--servlet-key | --sk(string)
+
+
Servlet Key of TSO address space
@@ -41070,27 +44554,6 @@
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: