REGISTER

Requests registration (or re-registration) of a user with automatic restart manager. The user can be a batch job, started task, or an abstract resource that automatic restart manager is to restart when the work fails or the system on which the work is currently registered fails.

WAITPRED

Requests that automatic restart manager suspend the processing of the issuing program during restart processing for the element until any predecessor elements in the same restart group that are also being restarted have indicated that they are ready. The predecessors to the element that has issued this WAITPRED request are identified from “level” specifications in the active automatic restart management policy.

READY

Requests that automatic restart manager mark a registered user as READY to accept work. If a WAITPRED request has not previously been issued by the user, the READY request will perform an implicit WAITPRED to wait for predecessor elements to initialize. The system will suspend the current task until all predecessor elements have indicated that they are ready to accept work.

DEREGISTER

Requests deregistration of a registered user. The DEREGISTER request must be issued from the same address space that issued the REGISTER request, with the following exceptions:

• If the REGISTER request specified ELEMBIND=CURSYS, the DEREGISTER may be done from any address space.
• Any element may be DEREGISTERed from an address space termination resource manager running in the MASTER address space, if the RMTOKEN returned on the REGISTER is supplied. The application should only issue this request from the master address space while running under a resource manager. If the address space under which the REGISTER request was issued is not terminating and the application issues any IXCARM requests from that address space after a DEREGISTER from the master address space, results are unpredictable.

ASSOCIATE

Requests that a registered user be associated with another element for takeover or restart processing purposes. This “association” suppresses all automatic restart manager restarts of the element identified in the TELEMENT parameter of this macro. The element issuing the ASSOCIATE request must be in the “available” state (that is, have issued the IXCARM REQUEST=READY macro).

If the issuer of the ASSOCIATE request terminates or deregisters from automatic restart manager, then the association is broken and the element specified in TELEMENT again becomes eligible for automatic restart manager restarts.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 32-byte area where the system will put the registration information.

CURJOB

The element has a minimum bind to the batch job or started task under which the element is registering. Specify ELEMBIND=CURJOB if the batch job or started task represented by the element needs to be restarted if it fails. The IXCARM request must be issued under a batch job or started task. There can be only one automatic restart management element registered with ELEMBIND=CURJOB per batch job or started task.

CURSYS

The element has a minimum bind to the system on which the element is registering. The element represents an abstract resource. An abstract resource is a program or a set of programs that is only associated with (or has a bind to) the system on which it is running. Specify ELEMBIND=CURSYS if the application registering with automatic restart management needs to be restarted only when the system fails. No address space, batch job, or started task failure will cause the element to be restarted. A REGISTER request that specifies ELEMBIND=CURSYS can be issued from any address space.

There can be more than one automatic restart management element registered with ELEMBIND=CURSYS per batch job, started task, or address space because the element is not associated with any of these units of work. There is no persistent restart text to restart the element. Therefore, the text of the command to restart this element must be specified either by the application when it registers, in the automatic restart management policy, or by an installation-written element restart exit. If the system fails and restart command text is not provided, the element will be deregistered.

ELEMBIND=CURSYS cannot be specified with TERMTYPE=ELEMTERM.

• Valid characters are:
  • Uppercase alphabetic characters
  • The numbers 0 through 9
  • $, #, @, and underscore (_).
• The first character may not be a number.
• The name must be 16 characters long, padded on the right with blanks
• The name must be unique across the sysplex

Element names that start with A through I and SYS are reserved for use by IBM®.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-byte field that contains the name of the element.

• To facilitate the assigning of a “level” that is used to sequence the restarts of multiple elements during automatic restart management restarts after a system failure.
• To communicate the element type to listeners of the automatic restart management ENF Code 38 for events that pertain to this element.

Element types that start with A through I and SYS are reserved for use by IBM. See z/OS MVS Programming: Sysplex Services Guide for a list of the assigned ELEMTYPE values.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of an 8-byte field that contains the type of element being registered.

The event exit must be contained in the authorized linklib concatenation or LPA (not steplib or tasklib) of both the system where the REGISTER request was invoked and any potiential target restart systems. The event exit will be invoked vith a BALR/BAKR sequence of instructions.

The event exit name must be 8 characters long, padded on the right with blanks.

An unauthorized application cannot specify an event exit routine when registering with automatic restart management.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of an 8-byte field that contains the name of the event exit routine.

Automatic restart management makes a copy of this parameter list to pass to the event exit. The parameter list should not contain data that is MVS-image dependent (such as addresses) because the exit may run on another MVS™ image (an automatic restart manager may restart the element on another image).

If this parameter is specified, you must specify a value for EXITPLLEN.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the parameter list to be used by the event exit.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field that contains the length of the event exit parameter list.

Use MF=L to specify the list form of the macro. Use the list form together with the execute form of the macro for applications that require reentrant code. The list form defines an area of storage that the execute form uses to store the parameters. Only the PLISTVER parameter can be coded with the list form of the macro.

NORM

Automatic restart management is to wait 5 minutes (the normal time-out value) for this restarted element to issue the IXCARM REQUEST=REGISTER request.

LONG

Automatic restart management is to wait up to 6 hours (the long time-out value) for this restarted element to issue the IXCARM REQUEST=REGISTER request.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that will contain the return code when the request has completed.

• The restart manager token is returned by an IXCARM REQUEST=REGISTER request. The contents of the restart token must not be modified by the application registering the element.
• When registering with ELEMBIND=CURJOB, applications can specify the restart manager token on subsequent REQUEST=DEREGISTER requests issued from the master address space. Applications cannot specify the restart manager token on READY, WAITPRED, ASSOCIATE, or DEREGISTER requests from the address space in which the element is registered.
• When registering with ELEMBIND=CURSYS, applications must specify the restart manager token on subsequent READY, WAITPRED, ASSOCIATE, and DEREGISTER requests to identify the element. The applications can specify the restart manager token on these requests from any address space.

If the IXCARM invocation is in AR ASC mode, the area containing the restart manager token can be in either the primary address space or in an address or data space that is addressable through a public entry on the caller's DU-AL.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the 16-byte field containing the restart manager token.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 4-byte field that will contain the reason code (if any) when the request has completed.

If the IXCARM invocation is in AR ASC mode, the text can be in either the primary address space or in an address/data space that is addressable through a public entry on the caller's DU-AL.

If this parameter is specified, it will take precedence over the automatic restart manager's reuse of the START command that most recently started this element (persistent restart text). A command specified with the STARTXT parameter can be overridden by a RESTART_METHOD specified for the element in the active ARM policy, unless the RESTART_METHOD defaults to or specifies PERSIST.

The STARTXT pafameter is valid only for started tasks. If specified with a REGISTER request from a batch job, the registration request will be rejected.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of the text of the command to be used to restart this element.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a fullword field that contains the length of the command text.

To Code: Specify the RS-type name or address (using a register from 2 to 12) of a 16-byte field that contains the name of the element to be associated with the element issuing the IXCARM macro.

ALLTERM

Automatic restart manager is to restart this element for all unexpected failures as appropriate. The ELEMBIND keyword determines which types of failures are appropriate to restart the element.

ELEMTERM

Automatic restart manager is to restart the element when the element fails but not when the system on which the element is registered is removed from the sysplex or unexpectedly terminates. TERMTYPE=ELEMTERM cannot be specified with ELEMBIND=CURSYS.

SYSTERM

Automatic restart manager is to restart this element when the system on which the element is registered is removed from the sysplex or unexpectedly terminates, but not when the element unexpectedly terminates.