zowe › ims › stop › region🖨️

Stop an IMS region.

Usage

zowe ims stop region [options]

Options

• --region-ids | --ri (array)

  • Region identifier numbers for the regions you want to stop. You must specify either this option or --job-name.

• --job-name | --jn (string)

  • The name of the job for the IMS region you want to stop. You must specify either this option or --region-ids.

• --route | --rte (array)

  • The region(s) to route the command to

• --abdump (string)

  • Specify this option to cause abnormal termination (ABEND) of an application program. If the transaction indicated by this argument is currently running in the specified region, an error message is received at the master terminal, indicating an application program ABEND. The region will remain active, but the transaction will be stopped. The command is ignored if the transaction is not currently scheduled in the region.

• --cancel (boolean)

  • Use this option if the region cannot be stopped with a stop region --abdump command. To use this option, you must have already submitted a stop region command using the --abdump option.

• --transaction (string)

  • Specify a transaction in wait-for-input mode to stop its message processing within the specified region.

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.

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

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

Base Connection Options

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

• Stop a region with job name JOBNM1:

  • zowe ims stop region --job-name "JOBNM1" Copy

• Stop multiple regions with region identifiers:

  • zowe ims stop region --region-ids 4 5 Copy

• Stop a region with region identifier and cause the abnormal termination (ABEND) of the application program:

  • zowe ims stop region --region-ids 4 --abdump "TRAN1" Copy

• Stop a region with region identifier and specify 'cancel' because the 'abdump' option failed to stop the region:

  • zowe ims stop region --region-ids 4 --cancel true Copy

• Stop a region with job name JOBNM4 specifying optional connection parameters:

  • zowe ims stop region --job-name "JOBNM4" --user "username" --pass "pass1234" --host "localhost" --port 8080--ich "zos1" --icp 9999 --plex "PLEX1" Copy