Use the CTGARM utility
to register the CICS® Transaction Gateway. This
utility is supplied in the load library SCTGAUTH. It is used to register
and deregister with ARM, around the Gateway daemon JCL
step, which invokes the ctgstart script through CTGBATCH.
To use ARM you need ARM and a Sysplex controller.
You need to define policies for automatic restart management; see z/OS MVS™ Programming:
Sysplex Services Guide, SA22-7617. If XA support
is enabled, create a policy that restarts the CICS Transaction Gateway in the same z/OS® image
as the CICS server.
The SCTGAUTH load library must be defined as APF-authorized. To
do this dynamically, use a command like the following:
SETPROG APF,ADD,dsname=xxxxxxx,volume(xxxxxx)
To
register the library permanently, include an entry in the appropriate
SYS1.PARMLIB member 'PROGxx'.
The CTGARM utility takes one of the following parameters:
- 'R[egister] ARM_ID [ARM_TYPE]'
- 'D[eregister]'
CTGARM messages are written to the SYSPRINT DD destination, which
must be defined in the calling JCL step. If SYSPRINT is not defined,
the step will fail.
ARM_ID is
a unique 16–character ID.
ARM_TYPE is
an 8–character restart level; the default is SYSLVL2. Valid characters
for both
ARM_ID and
ARM_TYPE are:
- Uppercase alphabetic characters
- The numbers 0 through 9
- $, #, @, and underscore (_).
The first character might not be a number.
CTGARM returns the following codes:
- 0
- No errors.
- 4
- Restarting.
- 8
- Miscellaneous error, including already registered or not unique
ID.
- 12
- Severe error, for example ARM is not installed.
For ARM error codes see z/OS MVS Programming:
Sysplex Services Reference, SA22-7618.