zowe › rse-api-for-zowe-cli › list › jobs🖨️

List jobs on JES spool/queues. By default, the command lists jobs owned (owner) by the user specified in your profile. The default for prefix is "*". The default status is ALL. The command does not prevalidate your user ID. The command surfaces errors verbatim from the Jobs REST endpoints.

Usage

zowe rse-api-for-zowe-cli list jobs [options]

Options

• --owner | -o (string)

  • Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the Jobs REST endpoint documentation, which is usually in the form "USER*".

• --prefix | -p (string)

  • Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the Jobs REST endpoint documentation, which is usually in the form "JOB*".

• --status | -s (string)

  • Specify if you want to list ALL jobs or only ACTIVE, OUTPUT, or INPUT jobs.

Profile Options

• --rse-profile | --rse-p (string)

  • The name of a (rse) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --host | -H (string)

  • Host name of service on the mainframe.

• --port | -P (number)

  • Port number of service on the mainframe.

• --user | -u (string)

  • User name to authenticate to service on the mainframe.

• --password | --pass | --pw (string)

  • Password to authenticate to service on the mainframe.

• --reject-unauthorized | --ru (boolean)

  • 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

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

Response Format Options

• --response-format-filter | --rff (array)

  • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.

• --response-format-type | --rft (string)

  • The command response output format type. Must be one of the following:

    table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

    list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

    object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

    string: Formats output data as a string. JSON objects/arrays are stringified.

    Allowed values: table, list, object, string

• --response-format-header | --rfh (boolean)

  • If "--response-format-type table" is specified, include the column headers in the output.

Examples

• List all jobs with default settings. The command returns jobs owned by your user ID with any job name:

  • zowe rse-api-for-zowe-cli list jobs Copy

• List all ACTIVE jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo':

  • zowe rse-api-for-zowe-cli list jobs -o "ibmu*" -p "myjo*" -s "ACTIVE" Copy

• List all jobs with default owner and prefix settings, displaying only the job ID of each job:

  • zowe rse-api-for-zowe-cli list jobs --rff jobid --rft table Copy