PERFORM SHUTDOWN

Description

The PERFORM SHUTDOWN command shuts down the CICS system. The shutdown can be either normal (controlled) or immediate. Control does not return to the program issuing the command, unless an exception condition occurs.

In processing this command, CICS invokes the programs in the shutdown program list table (PLT) as part of the task that issued the command. If any program in the list requires a terminal (that is, uses the principal facility), you should not issue the command in a task that does not have one, because the task will abend on the first attempt to use the non-existent terminal. Shutdown will proceed, but the task is backed out to its most recent SYNCPOINT, and the remaining programs in the list will not be executed.

Customizing with initialization and shutdown programs contains more information about PLTs and steps in the shutdown process.

Options

DUMP

specifies that an MVS™ SDUMP of the CICS region should be taken as part of the shutdown process. In a sysplex environment, dumps of related regions also are taken, if the system dump table entry for the dump code SHUTDOWN, which governs this dump, specifies them.

IMMEDIATE

specifies that CICS is to shut down immediately, terminating all active tasks and z/OS® Communications Server sessions abnormally. If IMMEDIATE is not specified, CICS shuts down normally, allowing these tasks to complete and quiescing the sessions; it then takes a warm keypoint.

NORESTART

specifies that this CICS region should not be restarted by MVS automatic restart manager (ARM) after the CICS region has completed shutting down. This option applies to immediate shutdowns only.

NOSDTRAN

specifies that no shutdown assist transaction is to be run at CICS shutdown.

PLT(data-value)

specifies the 1 or 2-character suffix that identifies the program list table for this shutdown. (The table is named DFHPLT followed by this suffix.)

The value NO means that no PLT programs are run. If you do not supply a PLT value nor a PLTNAME value, the value specified by the PLTSD system initialization parameter, if any, is used. This option applies only to a normal shutdown; PLT programs are not invoked for an immediate shutdown.

PLTNAME(data-value)

specifies the 1 to 8-character name of the program list table for this shutdown. If you specify 1 or 2 characters it is treated as a suffix and appended to prefix DFHPLT to form the name of the table. The value NO means that no PLT programs are run. If you specify 3 to 8 characters it is treated as the full name of the table.

If you do not supply a PLTNAME value nor a PLT value, the value specified by the PLTSD system initialization parameter, if any, is used. This option applies only to a normal shutdown; PLT programs are not invoked for an immediate shutdown.

RESTART

specifies that this CICS region is to be restarted by MVS ARM after the CICS region has completed shutting down. This option applies to normal shutdowns only.

SDTRAN(data-value)

specifies the 4-character name of the shutdown assist transaction.

The shutdown assist transaction, if specified, is run at CICS warm and immediate shutdown, and can be used to ensure that CICS shuts down in an controlled way, within a reasonable time (by, for example, purging long-running tasks). For details of the default shutdown assist transaction, CESD, see Shutdown assist program (DFHCESD).

TAKEOVER

specifies that this CICS system is to be shut down normally, and then the alternate CICS system is to take over. This option is valid only when the system initialization parameter XRF=YES was specified for CICS startup.

XLT(data-value)

specifies the 2-character suffix that identifies the transaction list table (XLT) to be used for this shutdown. (The table is a load module named DFHXLT followed by this suffix.)

This table lists the transactions that can be initiated by unsolicited terminal input during the first quiesce stage of a normal shutdown. No other transactions can be initiated from a terminal during shutdown, except for CEMT, CESF, and a small number of other CICS-supplied transactions related to terminals.

This option is meaningful only when IMMEDIATE is not present; no new transactions are accepted during an immediate shutdown. A suffix of NO means that no transactions besides those cited above are allowed. If you do not supply an XLT value, the value specified by the XLT system initialization parameter, if any, is used.

Conditions

INVREQ

RESP2 values:

1

A normal shutdown was requested when shutdown was already in progress.

2

The XLT cannot be found.

3

The PLT cannot be found.

4

XRF is not in effect.

5

The transaction specified on SDTRAN is not enabled for shutdown.

6

The transaction specified on SDTRAN is defined as remote.

7

The transaction specified on SDTRAN is not enabled.

NOTAUTH

RESP2 values:

100

The user associated with the issuing task is not authorized to use this command.

TRANSIDERR

RESP2 values:

8

The shutdown transaction specified on SDTRAN was not found.