zowe › workload-automation › list › jobinplan🖨️

List the jobs in plan.

Usage

zowe workload-automation list jobinplan [options]

Options

• --jobname | --jn (string)

  • Name of the jobs to be listed, you can use the wildcard character asterisk (*)

• --statuslist | --sl (array)

  • Status of the jobs

    Allowed values: WAITING, READY, RUNNING, SUCCESSFUL, ERROR, CANCELED, HELD, UNDECIDED, SUPPRESS

• --jobstreamname | --jsn (string)

  • Name of the jobstream where the jobs are located, you can use the wildcard character asterisk (*).

• --timerange | --tr (array)

  • Time range, in the format YYYY-MM-DDTHH:MM:SS

• --howmany | --hm (number)

  • Number of jobs that the query is to return.

    Default value: 1000

workload-automation Connection Options

• --host | -H (string)

  • The Z connector server host name or API ML server host name

• --port | -P (number)

  • The Z connector server port or API ML server port

• --user | -u (string)

  • The Z connector user ID

• --password | --pwd (string)

  • The Z connector password

• --engine | --eng (string)

  • Name of the engine, as defined on the Z connector

• --base-path | --bp (string)

  • Base path of your API mediation layer instance. If a base path is specified, the plug-in connects to API ML. Specify this value according to the yaml static file added to API ML

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

  • Reject self-signed certificates

    Default value: true

Profile Options

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

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

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

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

Base Connection Options

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file path)

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

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

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

Response Format Options

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

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

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

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

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

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

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

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

    Allowed values: table, list, object, string

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

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

Examples

• List all jobs in current plan whose name starts with A and are in SUCCESSFUL or WAITING status:

  • zowe workload-automation list jobinplan --jobname "A*" --statuslist SUCCESSFUL WAITING Copy

• List all jobs located in the jobstream named MYJOBSTREAM, limiting the response to 50 jobs:

  • zowe workload-automation list jobinplan --jobstreamname "MYJOBSTREAM" --howmany 50 Copy

• List all jobs within a specified range:

  • zowe workload-automation list jobinplan --timerange 2019-11-10T00:00:00 2019-11-10T23:59:00 Copy

• List all jobs by displaying only the job name and status in table format:

  • zowe workload-automation list jobinplan --rff jobDefinition[jclName] status[commonStatus] --rft table Copy