Previous Topic: SMFQ CommandsNext Topic: Using Volume Pool Monitor Alert and Email Facilities


Tape Map (TMAP)

The Tape Map (TMAP) task provides a convenient way to list the contents of an ANSI Label (AL) or Standard Label (SL) tape. The task dynamically allocates one or more tape drives. The task mounts the requested volumes to produce a report of the files on each AL or SL tape. The tape drive is released after the requested tapes are processed. TMAP remains active and available for more tape map requests until it terminates by the STOP command.

You can run the CTSTMAP program as a batch job independent of the CTS procedure. The JCL to run CTSTMAP as a batch job is provided in hlq.CTAPJCL member CTSJTMAP.

Notes:

Startup Procedure

TMAP can be started manually or automatically when CTS is started. Starting the TMAP subtask manually is recommended.

Start the TMAP Subtask Automatically

To have the TMAP subtask started each time CTS is started, set the subtask to start automatically.

To automatically start the TMAP subtask, add the following commands to the CTSSTART member in hlq.CTAPOPTN:

SET TASK(TMAP) PGM(CTSTMAP)
START TMAP

Start the TMAP Subtask Manually

To start the TMAP subtask yourself, do not set it to start automatically and start it manually each time.

Once the CTS task has been started, you can communicate with CTS by using a MODIFY command or by WTOR. The following is an example of how to start manually the TMAP subtask under CTS by using the MODIFY command:

F CTS,SET TASK(TMAP) PGM(CTSTMAP)
F CTS,START TMAP

TMAP Commands

Commands are sent to TMAP using the CTS Message command (MSG). Use the following format on all commands that are issued to the TMAP subtask.

STOP TMAP
CANCEL TMAP
F CTS,MSG TMAP,'MAP volser1,...,volsern,UNIT=uuuu'
volser

Specifies the volume serial number of a tape that you want to map.

Range: 1 to 8

uuuu

Specifies the generic unit or unit address for the tape drive required.

Default: TAPE

You can use the following commands:

STOP

Requests TMAP to close all files and terminate.

CANCEL

Requests TMAP to cancel itself with a User 111 abend.

MAP

Maps the tape and report on the files it contains.

Command Sample

| F CTS,MSG TMAP,'MAP 101001,102033,534006,UNIT=3590' |

When you enter the preceding command, the TMAP subtask of the CTS address space allocates a 3590 tape unit. The TMAP subtask mounts the three volumes that you requested. After producing a tape map for each volume, the tape unit is deallocated. This example assumes that the TMAP subtask has already been started, either automatically or manually.

Volume Pool Monitor (VPM)

The CTSVPM subtask of the Common Tape System provides a convenient way to monitor availability of scratch tapes in user-defined volume pools. The Volume Pool Monitor (VPM) subtask uses volume pools, variables, and alerts that can trigger WTOs and emails. You define all of the items through the ISPF Volume Pool panels and save them in the VSAM Database (VDB).

When started, the VPM subtask reads the VDB to identify the following elements that are defined through CTSISPF panels:

The VPM subtask builds tables for each of the preceding items. The VPM subtask keeps the items maintained as new volume pools, variables, and alerts are created through ISPF or ongoing processing. VPM then passes the TMC and develop counts for the defined volume pools, placing volumes in a category of Active, Scratch, and Out of Service. A total volume count for the volume pool and a separate count for Never Used volumes is maintained. The Active, Scratch, and Out of Service counts add up to the total number of volumes in the volume pool.

The CA 1 Audit file monitors the tape activity. As tapes change status, the accumulators update to reflect a status change of a volume. For example, the status can change from scratch to active, or from active to scratch. When you shut down the VPM subtask, either individually with a STOP command or by stopping the CTS task, the in-memory volume pool table is written to the VDB. The in-memory is also written periodically while VPM is active, as the OPT_VPM_TIMER variable defines.

Alerts that you defined through ISPF allow you to create a condition to test and what action to take when the condition is met. When the condition that is defined in an alert is met, you can either issue a customized WTO or an email. An example is to send an email to the tape librarian when a volume pool has fewer than 500 scratch volumes available.

The VPM subtask also creates volume pool history records to allow you to detect trends in your scratch availability. Both daily and weekly volume pool history records are created. Both types of history records are written to the VDB when the VPM subtask first wakes up on a new day. The subtask typically wakes up just after 12:00 midnight. These records can be viewed using the CA GMI user interface, which ships as part of CA 1.

No changes to the CTS PROC are required for the VPM subtask. The CTSVPM subtask dynamically allocates the VDB when the task starts.

VPM Prerequisites

Before you start the VPM subtask, create the VDB and customize the subtask and email variables. You update the variables using the CTS ISPF application, so install the CTS ISPF elements too.

Allocate the SEND data set and load it with the sample WTOs and emails provided. Jobs to allocate and initialize both the VDB and SEND data sets are provided in the hlq.CTAPJCL data set.

Note: For more information about the allocate and initialize jobs, see the Programming Guide.

More information:

Using Online Inquiry and Update Facilities

VPM Subtask Variables

VPM Email Variables

VPM Subtask Variables

The VPM subtask is controlled through variables entered in the CTS ISPF panels. These variables are set when the task comes up. You can change the variables while the VPM subtask is running. The VPM subtask checks if the variables have been changed since the last time the OPT_VPM_TIMER interval has expired. If the variables controlling VPM have changed, the new variables are used.

OPT_VPM_DISPLAY_WTO_MAX

Controls the maximum number of lines output when the DISPLAY POOL or the STATUS command is issued in the VPM subtask.

Default: 20 lines

OPT_VPM_RETAIN_HISTORY_DAILY

Controls how many days VPM DAILY History records are kept before they VPM subtask automatically deletes them. Daily History records are provided to allow CA Vantage and CA GMI to produce trend reports.

Default: 90 days

OPT_VPM_RETAIN_HISTORY_WEEKLY

Controls how many days VPM WEEKLY History records are kept before the VPM subtask automatically deletes them. Like the Daily History records, the Weekly records are provided to allow CA Vantage and CA GMI to produce trend reports for a longer time.

Default: 365 days

OPT_VPM_TIMER

Controls the interval at which the VPM subtask checks for activity from the Audit file or changes in the volume pools, variables, and alerts that are defined in ISPF. This variable is specified in hh:mm:ss format. To set the interval to perform these checks every 15 minutes, enter 00:15:00.

Default: 30 minutes (00:30:00)

VPM Email Variables

The VPM subtask can issue emails and WTOs in response to alerts that have been entered through the ISPF panels that are associated with VPM. To issue emails, provide information about your email environment and default values for emails that VPM issues. Before you trigger any alerts through VPM, update the following email variables through the CTS ISPF panels. To update any of these variables, use the U line command.

You can change the variables anytime. The VPM subtask checks if the variables have been changed since the last time the OPT_VPM_TIMER interval expired. If the variables controlling VPM emails have changed, the new variables are used.

OPT_EMAIL_DEFAULT_DSN

Identifies the partitioned data set that contains the WTO or email text to create emails or WTOs. This variable is the full data set name of a fixed block (FB) 80 character (LRECL) partitioned data set. Each member of this data set defines a single WTO or email that is issued when a VPM alert is triggered. The member name is specified in the Send field of the alert definition in ISPF. The VPM subtask processes the members. Configure the variable before you run VPM. The entered value is converted to uppercase.

Default: CAI.SEND

OPT_EMAIL_DEFAULT_FORMAT

Defines the default format for the body of emails created. The options are TEXT and HTML. In TEXT format, extra blanks are removed from the input records and the text is reformatted on fewer lines. HTML format can include HTML formatting tags in the email body. You can define a different format using the x-FMT: control statement.

Default: TEXT

OPT_EMAIL_DEFAULT_FROM

Identifies the "from" address on any emails that the VPM subtask generates. Configure this variable before you run VPM.

Default: SYSPROG@YOUR.SITE

OPT_EMAIL_DEFAULT_SUBCHAR

Defines the default substitution character that is used to delimit variables in email fields for variable substitution. You can define a different substitution character for an individual email using the x-SUB: control statement.

Default: &

OPT_EMAIL_DEFAULT_TITLE

Specifies the title of all emails that the VPM subtask generates. You can provide a more specific title in the email member itself with the TITLE: control statement.

Default: EMAIL FROM CA TAPE MANAGEMENT

OPT_EMAIL_DEFAULT_TO

Defines the default recipient of emails that the VPM subtask generates. You can define different recipients using the TO: control statement. Configure this variable before you run VPM.

Default: TAPEPROG@YOUR.SITE

More information:

CA 1 ISPF Facilities

Email Environment Setup

Create three user variables for each system where emails are sent from. A naming convention that includes the SMF ID of the systems where emails are sent from has been established. The three user variables are as follows:

EMAIL_xxxx_HOSTNAME
EMAIL_xxxx_SMTP
EMAIL_xxxx_SYSOUT

Replace xxxx in the user variables with the SMF ID of the systems where emails are sent from. You can send emails by running the CTSMAIL utility or when the VPM subtask triggers an email as the result of an alert.

EMAIL_xxxx_HOSTNAME

Defines the host name for TCP/IP where emails are sent from. Create this user variable before you run VPM. You find the host name when you issue the HOMETEST TSO command. The host name returns in the following message:

TCP Host Name is: yourhost

EMAIL_xxxx_SMTP

Identifies the name of the SYSOUT writer for the SMTP PROC. Create this user variable before you run VPM.

Default: SMTP

EMAIL_xxxx_SYSOUT

Defines the SYSOUT CLASS used to send emails with SMTP. Create this user variable before you run VPM.

Default: B

Note: SMTP must be active in your system. On most systems, the procedure is called SMTP and can be started with the console command S SMTP.

Email Environment Setup Example

A site has two LPARs with SMF ID names of SYP1 and SYP2. They have chosen to use the CA 1 email capabilities provided in the VPM subtask and the CTSMAIL utility. Use the ISPF CTS Variable Add panel to create six user variables to set up their environment (three for each system).

EMAIL_SYP1_HOSTNAME
EMAIL_SYP1_SMTP
EMAIL_SYP1_SYSOUT
EMAIL_SYP2_HOSTNAME
EMAIL_SYP2_SMTP
EMAIL_SYP2_SYSOUT

You can use examples of these user variables with xxxx in the place of the SMF ID for models. Do not update the examples. Create new user variables.

Start the VPM Subtask Automatically

To have the VPM subtask started each time CTS is started, set the subtask to start automatically.

To automatically start the VPM subtask, add the following commands to the CTSSTART member in hlq.CTAPOPTN:

SET TASK(VPM) PGM(CTSVPM)
START VPM

Start the VPM Subtask Manually

To start the VPM subtask yourself, do not set it to start automatically and start it manually each time.

Once the CTS task has been started, you can communicate with CTS by using a MODIFY command or by WTOR. The following is an example of how to start manually the VPM subtask under CTS by using the MODIFY command:

F CTS,SET TASK(VPM) PGM(CTSVPM)
F CTS,START VPM

Operator Commands

You can use the following operator commands:

DISPLAY Command
F CTS,MSG,VPM,’DISPLAY P’
F CTS,MSG,VPM,’D P’
F CTS,MSG,VPM,’D POOL=PRODPOOL’
F CTS,MSG,VPM,’D POOL=N*’

Displays the current counts for all volume pools in the following format:

F CTS,MSG,VPM,’D POOL=N*’   
     TO VPM D POOL=N*                                                    
CA$F510I CTSVPM DISPLAY COMMAND RECEIVED: D,POOL=N*                       
CA$F511I --------Volume Pool Name--------  Type=REG                    
CA$F512I --Total---  --Active--  --Scratch-  Out-of-Srv  Never-Used
CA$F513I NEWPOOL 2                                                      
CA$F514I 99,999,999  99,999,999  99,999,999  99,999,999  99,999,999     
CA$F513I New STK T10000K Range                                          
CA$F514I 99,999,999  99,999,999  99,999,999  99,999,999  99,999,999  

In the preceding example, all volume pools that begin with N are displayed up to the maximum number of lines. The OPT_VPM_DISPLAY_WTO_MAX variable controls this number.

You can also request the type of counts for these pools using the additional TYPE= parameter. These types are regular, low, and high values:

F CTS,MSG,VPM,’D P=N*,TYPE=LOW’
F CTS,MSG,VPM,’D P=N*,TYPE=HIGH’
F CTS,MSG,VPM,’D P=N*,TYPE=REG’
LOW

Gives the lowest values that the pool encounters.

HIGH

Gives the highest values that the pool encounters.

REG

Gives the regular value, or the current count.

If type is not specified, the command assumes TYPE=REG and displays the current count.

You can also view this information using the CTS ISPF panels VPM Pool Detail panel or VPM Range Detail panel for a specific range.

STATUS Command
F CTS,MSG,VPM,STATUS
F CTS,MSG,VPM,S

Displays the status of the CTSVPM in the following format:

F CTS,MSG,VPM,S   
     TO VPM S                                                    
CA$F510I CTSVPM COMMAND RECEIVED: STATUS                       
CA$F517I CTSVPM Subtask Status Display
CTSVPM is Active, awaiting command
*** CA 1 is batch active ***                   
CTSVPM maintenance level is T5Q3220 created on 11/29/xx 14.49
CTSVPM Timer last expired at:      20xx/341 16:11:21:40   
CTSVPM Last Audit scan completed:  20xx/341 16:11:24:14   
CTSVPM Parameters in effect      
  OPT_VPM_DISPLAY_WTO_MAX          999    
  OPT_VPM_RETAIN_HISTORY_DAILY     1,000    
  OPT_VPM_RETAIN_HISTORY_WEEKLY    5,000      
  OPT_VPM_TIMER                    00:15:00
CTSVPM Summary information                                               
  Alerts                5     Last Refreshed: 20xx/341 15:40:58:28  
  Variables            76     Last Refreshed: 20xx/341 16:01:22:55  
  Volume Pools          8     Last Refreshed: 20xx/340 12:36:22:79 
CTSVPM Alerts currently being monitored  
  My-Alert-1   
  My-Alert-2   
  My-Alert-3   
  My-Alert-4    
  My-Alert-5       
CA$F518I CTSVPM End of Status Display     

In the preceding example, all of the alerts display up to the maximum number of lines as the OPT_VPM_DISPLAY_WTO_MAX variable controls.

REBUILD Command
F CTS,MSG,VPM,REBUILD

Causes VPM to tear down existing volume pools, alerts, and variable tables and to recreate them using the most current definitions in the VDB. After the volume pools, alerts and variable tables have been built, VPM passes the TMC and develops counts for the defined volume pools. VPM places the volumes in a category of Active, Scratch, and Out of Service. To limit the use of CPU and IO that are associated with the scan of the TMC, use this command sparingly.

REFRESH Command
F CTS,MSG,VPM,REFRESH
F CTS,MSG,VPM,R

Requests that VPM checks to see if new alerts, variables, or volume pools (or volume pool ranges) have been entered in ISPF. If new or updated alerts, variables, or volume pools are found, the in-memory versions of these tables are updated. If the CTS VPM subtask option variables are updated, the new values are used when those variables are next referenced (after the current OPT_VPM_TIMER interval has expired or after you issue an UPDATE command).

Use care when defining new volume pools or new volume pool ranges because they can trigger alerts that are associated with percentage value conditions. The counters that are associated with a new volume pool or volume pool range are correct only after the VPM subtask stops and starts. Or the counters are correct after the REBUILD command is issued. These actions cause the TMC to be rescanned and all volume pool counters rebuilt.

START Command
F CTS,START,VPM

Starts the VPM subtask. The VDB is read to create the volume pools, variables, and alerts that you defined. The TMC is read and analyzed to update the in-memory volume pool table. Monitoring of volume status initiates.

STOP Command
F CTS,STOP,VPM

Stops the VPM subtask. The volume pools that are defined through the ISPF interface are monitored only after the VPM subtask is started again. You can start the VPM subtask either manually by the modify command or by restarting the CTS task. No history records are written while the VPM task is stopped.

UPDATE Command
F CTS,MSG,VPM,UPDATE
F CTS,MSG,VPM,U

Causes the VPM subtask to preempt the timer and check the alerts, variables, or volume pools (or volume pool ranges) definitions for any changes through ISPF. The timer loop that the OPT_VPM_TIMER value controls is reset and a new timer interval is checked for. The VPM subtask updates any alerts, variables, or volume pools that have been changed through ISPF. The CA 1 Audit file is scanned to identify any volume status change activity.