zowe › zos-jobs › view › job-status-by-jobid🖨️

View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the z/OSMF Jobs REST endpoints (expect for "no jobs found").

Usage

zowe zos-jobs view job-status-by-jobid <jobid> [options]

Positional Arguments

• jobid (string)

  • The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.

Zosmf Connection Options

• --host | -H (string)

  • The z/OSMF server host name.

• --port | -P (number)

  • The z/OSMF server port.

    Default value: 443

• --user | -u (string)

  • Mainframe (z/OSMF) user name, which can be the same as your TSO login.

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

  • Mainframe (z/OSMF) password, which can be the same as your TSO password.

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

  • 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

• --completion-timeout | --cto (number)

  • The amount in time, in seconds, a REST operation should wait to complete before timing out

• --establish-connection-timeout | --ecto (number)

  • The amount of time, in seconds, a REST operation should wait while connecting to the server before timing out

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

• View status and other details of the job with the job ID JOB00123:

  • zowe zos-jobs view job-status-by-jobid j123 Copy

• Print only the status (for example, "OUTPUT" or "ACTIVE") of the job with the job ID JOB00123:

  • zowe zos-jobs view job-status-by-jobid j123 --response-format-filter status --response-format-type string Copy