Function
Includes the following features:
- Detect the occurrence or failure of HyperSwap® by monitoring IOSHM0414I message and IOSHM0415I message.
- When an IOSHM0414I message is detected, it refers to the pair status of the specified TrueCopy for Mainframe copy group and confirms that HyperSwap® has occurred at specified TrueCopy for Mainframe copy group.
- When an IOSHM0415I message is detected, it outputs WTOR message that prompts to confirm the status of HyperSwap®.
- When the occurrence of HyperSwap® is confirmed, the backup job is stopped and then a WTOR message is output to confirm the stop. If the job name is not specified, a WTOR message will be output to prompt the user to stop the job.
Important: This REXX exec supports monitoring of HyperSwap® created with IBM® Copy Services Manager.
Format
PREFIX(prefix) Δ1 DAD(dadid) [Δ1 CONSNAME(console-name)] [Δ1 WTO({Y|N|V})] [Δ1 VERBOSE({ON|OFF})] [Δ1 AUTO({YES|token})]
Parameters
- PREFIX(prefix)
- Specify the prefix for the TrueCopy for Mainframe copy group definition file.
- DAD(dadid)
- The device address domain ID (DADID) of the mainframe server to which storage system of the TrueCopy for Mainframe copy group is connected.
- CONSNAME(console-name)
- Specify the console name to be monitored.
- When the CONSNAME parameter is omitted, the CONSNAME is assumed to be TSO/E user ID+"C" if the TSO/E user ID is 1 to 7 characters, or TSO/E user ID if it is 8 characters.
- WTO({Y|N|V})
- Specify whether or not to output SYSTSPRT output messages to the console. When omitted, the default value is N.
- Y: Outputs a message to the console. TSO/E environment error and parameter error messages (YK5100E, YK5101E, YK5102E, and YK5110E) and trace information message (YK5127I) are excluded.
- N: Does not output a message to the console. YK5123I and YK5125W are excluded.
- V: Outputs a message to the console. TSO/E environment error and parameter error messages (YK5100E, YK5101E, YK5102E, and YK5110E) are excluded.
If a CLI error occurs and the WTO(Y) or WTO(V) parameter is specified, Business Continuity Manager outputs messages (excluding the YKZ310I and YKZ311I messages) with the same message ID to the console up to 10 times each time a CLI command is run. Check SYSTSPRT to see all Business Continuity Manager messages.
- VERBOSE({ON|OFF})
- Specify whether or not to output the contents of the process being executed to SYSTSPRT. When omitted, the default value is OFF.
- ON: Outputs the contents of the process being executed as YK5127I message.
- OFF: Does not output the contents of the process being executed.
- CAUTION:Do not use ON under normal circumstances, as it might cause the spool to overflow with too much output.
- AUTO({YES|token}) <token> ~ (1-8 characters)
- Specify this parameter to reduce the CPU overhead of the message monitor process. When this parameter is specified, the IOSHM0414I and IOSHM0415I messages must be specified with the AUTO option in the MPFLSTxx parmlib member.
- YES: The IOSHM0414I and IOSHM0415I messages are monitored as being eligible for automation processing. For the IOSHM0414I and IOSHM0415I messages, make sure to specify AUTO(YES) in the message attribute of the MPFLSTxx parmlib member.
- token: The messages with the AUTO(token) set are monitored as being eligible for automation processing. For the IOSHM0414I and IOSHM0415I messages, make sure to specify AUTO(token) in the message attribute of the MPFLSTxx parmlib member.CAUTION:To reduce the CPU overhead of the message monitoring process, it is recommended to specify the AUTO parameter under normal circumstances.
Configuration information
See Configuration information data set (YKDDCONF) description format.
Return codes
Return code | Meanings |
---|---|
-3 | The REXX exec was run in a non‑TSO/E environment |
0 | Successful. |
4 | A CLI error occurred while monitoring the TrueCopy for Mainframe copy group, and then stop monitoring this copy group. |
8 | Exit the REXX exec because other than Y was responded to in the WTOR message confirming that the job is stopped. |
12 | Failed to execute the YKCONMSG command. The user executing the REXX exec does not have CONSOLE permissions. |
40 | Open or I/O of the data set assigned to YKDDCONF failed. |
44 | Failed to execute CLI. For more information, see the message that the REXX exec outputs. |
48 | The record specified in YKDDCONF or parameter of this REXX exec is incorrect. |
Important: Prerequisite conditions
- Configuration file: Business Continuity Manager TrueCopy for Mainframe copy group configuration file with HS linkage option.
- Server to execute: Backup server.
- How to start
- Hitachi Mainframe Cyber Resiliency and Hitachi Business Continuity Manager to be run on the z/OS® server TSO/E space installed.
- Assign Hitachi Business Continuity Manager load library to STEPLIB.
- Assign Hitachi Mainframe Cyber Resiliency REXX exec library to SYSEXEC.
- Assign a configuration information data set whose sequence fields are blanks to the ddname of YKDDCONF. Note: When number mode is on, use the UNNUMBER macro command to blank out the sequence fields. For details of the UNNUMBER macro command, see the IBM® document z/OS® ISPF Edit and Edit Macros.
- Submit the job.
Example
The following shows an example JCL for execution.
//JOBNAME JOB //IEFPROC EXEC PGM=IKJEFT01,TIME=1440,REGION=4096K //SYSTSPRT DD SYSOUT=* //SYSABEND DD SYSOUT=* //STEPLIB DD DISP=SHR,DSN=HDSYK.Vmmmmmm.HDSYLNKT //SYSEXEC DD DISP=SHR,DSN=HTC1.CRS.Vnnnnnn.HDSCEXET //YKDDCONF DD DISP=SHR,DSN=userid.PARMLIB(YKCRSMON) //SYSTSIN DD * %YKCRSMON PREFIX(userid.PREFIX) DAD(LOCAL) /* //