zowe › zos-jobs › submit › data-set🖨️

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

• dataset (string)

  • 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

• --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.

• --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)

  • 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".

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

• Submit the JCL in the data set "ibmuser.cntl(deploy)":

  • zowe zos-jobs submit data-set "ibmuser.cntl(deploy)" Copy

• Submit the JCL in the data set "ibmuser.cntl(deploy)", wait for the job to complete and print all output from the job:

  • zowe zos-jobs submit data-set "ibmuser.cntl(deploy)" --view-all-spool-content Copy