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*".
Zosmf Connection Options
-
--host | -H (string)
- The z/OSMF server host name.
-
--port | -P (number)
-
The z/OSMF server port.
Default value: 443
-
--user | -u (string)
- Mainframe (z/OSMF) user name, which can be the same as your TSO login.
-
--password | --pass | --pw (string)
- Mainframe (z/OSMF) password, which can be the same as your TSO password.
-
--reject-unauthorized | --ru (boolean)
-
--base-path | --bp (string)
- The base path for your API mediation layer instance. Specify this option to prepend the base path to all z/OSMF resources when making REST requests. Do not specify this option if you are not using an API mediation layer.
-
--protocol (string)
-
--cert-file (local file path)
- The file path to a certificate file to use for authentication
-
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication
Profile Options
Base Connection Options
Response Format Options
-
--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
-
--response-format-type | --rft (string)
-
The command response output format type. Must be one of the following:
table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
string: Formats output data as a string. JSON objects/arrays are stringified.
Allowed values: table, list, object, string
-
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.
Examples
-
List all jobs with default settings. The command returns jobs owned by your user ID with any job name:
zowe zos-jobs list jobs
-
List all jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo':
zowe zos-jobs list jobs -o "ibmu*" -p "myjo*"
-
List all jobs with default owner and prefix settings, displaying only the job ID of each job:
zowe zos-jobs list jobs --rff jobid --rft table