zowe › ims › start › program🖨️

Start an IMS application program.

Usage

zowe ims start program [name...] [options]

Positional Arguments

• name... (string)

  • The name of the application program(s) to start. The maximum length of a program name is eight characters.

Options

• --attributes | --att (array)

  • The attributes that are to be started

    Default value: SCHD

    Allowed values: SCHD, TRACE, REFRESH

• --route | --rte (array)

  • The region(s) to route the command to

IMS Connection Options

• --host | -H (string)

  • The IMS Operations API server host name.

• --port | -P (number)

  • The IMS Operations API server port.

• --ims-connect-host | --ich (string)

  • The hostname of your instance of IMS Connect. This is typically the hostname of the mainframe LPAR where IMS Connect is running.

• --ims-connect-port | --icp (number)

  • The port of your instance of IMS Connect. This port can be found in your IMS Connect configuration file on the mainframe.

• --plex | -x (string)

  • The name of the IMS plex.

• --user | -u (string)

  • The web server user name where the IMS Operations API resides.

• --password | --pass (string)

  • The web server user password where the IMS Operations API resides.

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

Profile Options

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

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

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

• Start an application program named PGM123:

  • zowe ims start program "PGM123" Copy

• Start all application programs beginning with ACC*:

  • zowe ims start program "ACC*" Copy

• Start an application program named PGM234 and start tracing:

  • zowe ims start program "PGM234" --attributes "SCHD TRACE" Copy

• Start an application program named PGM890 routing to control regions IMS1 and IMS2:

  • zowe ims start program "PGM890" --route "IMS1 IMS2" Copy

• Start an application programs named XYZ1 specifying optional connection parameters:

  • zowe ims start program "XYZ1" --user "username" --pass "pass1234" --host "localhost" --port 8080 --ich "zos1" --icp 9999 --plex "PLEX1" Copy