og/mvs omegamon ii for sms data interface...

OMEGAMON II® for SMS Data InterfaceOMEGACENTER Gateway™ for MVS

Version 340

GC32-9230-00

September 2002

Candle Corporation201 North Douglas Street

El Segundo, California 90245-9796

2 OMEGACENTER Gateway for MVS OMEGAMON II for SMS Data Interface Version 340

Registered trademarks and service marks of Candle Corporation: AF/OPERATOR, AF/PERFORMER, AF/REMOTE, Availability Command Center, Candle, Candle Command Center, Candle Direct logo, Candle Electronic Customer Support, Candle logo, Candle Management Server, Candle Management Workstation, CandleNet Portal, Candle Technologies, CL/CONFERENCE, CL/SUPERSESSION, CommandWatch, CandleNet Command Center, CT, CT/Data Server, CT/DS, DELTAMON, eBA, eBA*ServiceMonitor, eBA*ServiceNetwork, eBusiness Assurance, eBusiness Institute, ETEWatch, IntelliWatch, IntelliWatch Pinnacle, MQSecure, MQView, OMEGACENTER, OMEGAMON, OMEGAMON/e, OMEGAMON II, OMEGAMON Monitoring Agent, OMEGAVIEW, OMEGAVIEW II, PQEdit, Solutions for Networked Applications, Solutions for Networked Businesses, and Transplex.Trademarks and service marks of Candle Corporation: Alert Adapter, Alert Adapter Plus, Alert Emitter, AMS, Amsys, AutoBridge, AUTOMATED FACILITIES, Availability Management Systems, Candle Alert, Candle Business Partner Logo, Candle Command Center/SentinelManager, Candle CommandPro, Candle CIRCUIT, Candle eDelivery, CandleLight, CandleNet, CandleNet 2000, CandleNet eBP, CandleNet eBP Access, CandleNet eBP Administrator, CandleNet eBP Broker Access, CandleNet eBP Configuration, CandleNet eBP Connector, CandleNet eBP File Transfer, CandleNet eBP Host Connect, CandleNet eBP Object Access, CandleNet eBP Object Browser, CandleNet eBP Secure Access, CandleNet eBP Service Directory, CandleNet eBP Universal Connector, CandleNet eBP Workflow Access, CandleNet eBusiness Assurance, CandleNet eBusiness Exchange, CandleNet eBusiness Platform, CandleNet eBusiness Platform Administrator, CandleNet eBusiness Platform Connector, CandleNet eBusiness Platform Connectors, CandleNet eBusiness Platform Powered by Roma Technology, CandleNet eBusiness Platform Service Directory, CCC, CCP, CEBA, CECS, CICAT, CL/ENGINE, CL/GATEWAY, CL/TECHNOLOGY, CMS, CMW, Command & Control, Connect-Notes, Connect-Two, CSA ANALYZER, CT/ALS, CT/Application Logic Services, CT/DCS, CT/Distributed Computing Services, CT/Engine, CT/Implementation Services, CT/IX, CT/Workbench, CT/Workstation Server, CT/WS, !DB Logo, !DB/DASD, !DB/EXPLAIN, !DB/MIGRATOR, !DB/QUICKCHANGE, !DB/QUICKCOMPARE, !DB/SMU, !DB/Tools, !DB/WORKBENCH, Design Network, DEXAN, e2e, eBAA, eBAAuditor, eBAN, eBANetwork, eBAAPractice, eBP, eBusiness Assurance Network, eBusiness at the speed of light, eBusiness at the speed of light logo, eBusiness Exchange, eBusiness Institute, eBX, End-to-End, ENTERPRISE, Enterprise Candle Command Center, Enterprise Candle Management Workstation, Enterprise Reporter Plus, EPILOG, ER+, ERPNet, ESRA, ETEWatch Customizer, HostBridge, InterFlow, Candle InterFlow, Lava Console, MessageMate, Messaging Mastered, Millennium Management Blueprint, MMNA, MQADMIN, MQEdit, MQEXPERT, MQMON, NBX, NetGlue, NetGlue Extra, NetMirror, NetScheduler, OMA, OMC Gateway, OMC Status Manager, OMEGACENTER Bridge, OMEGACENTER Gateway, OMEGACENTER Status Manager, OMEGAMON Management Center, OSM, PC COMPANION, Performance Pac, PowerQ, PQConfiguration, PQScope, Response Time Network, Roma, Roma Application Manager, Roma Broker, Roma BSP, Roma Connector, Roma Developer, Roma FS/A, Roma FS/Access, RomaNet, Roma Network, Roma Object Access, Roma Secure, Roma WF/Access, Roma Workflow Access, RTA, RTN, SentinelManager, Somerset, Somerset Systems, Status Monitor, The Millennium Alliance, The Millennium Alliance logo, The Millennium Management Network Alliance, TMA2000, Tracer, Unified Directory Services, Volcano and ZCopy.Trademarks and registered trademarks of other companies: AIX, DB2, MQSeries and WebSphere are registered trademarks of International Business Machines Corporation. SAP is a registered trademark and R/3 is a trademark of SAP AG. UNIX is a registered trademark in the U.S. and other countries, licensed exclusively through X/Open Company Ltd. HP-UX is a trademark of Hewlett-Packard Company. SunOS is a trademark of Sun Microsystems, Inc. All other company and product names used herein are trademarks or registered trademarks of their respective companies.

Copyright © August 2002, Candle Corporation, a California corporation. All rights reserved. International rights secured.

Threaded Environment for AS/400, Patent No. 5,504,898; Data Server with Data Probes Employing Predicate Tests in Rule Statements (Event Driven Sampling), Patent No. 5,615,359; MVS/ESA Message Transport System Using the XCF Coupling Facility, Patent No. 5,754,856; Intelligent Remote Agent for Computer Performance Monitoring, Patent No. 5,781,703; Data Server with Event Driven Sampling, Patent No. 5,809,238; Threaded Environment for Computer Systems Without Native Threading Support, Patent No. 5,835,763; Object Procedure Messaging Facility, Patent No. 5,848,234; End-to-End Response Time Measurement for Computer Programs, Patent No. 5,991,705; Communications on a Network, Patent Pending; Improved Message Queuing Based Network Computing Architecture, Patent Pending; User Interface for System Management Applications, Patent Pending.

NOTICE: This documentation is provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by the Government is subject to restrictions set forth in the applicable license agreement and/or the applicable government rights clause.This documentation contains confidential, proprietary information of Candle Corporation that is licensed for your internal use only. Any unauthorized use, duplication, or disclosure is unlawful.

Contents 3

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Syntax Diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9Documentation Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11Adobe Portable Document Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

What’s New in OG/MVS Version 340 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 1. Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19What this OG/MVS Function Can Do For You . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20The VU API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21VU API Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23IBM Storage Management Subsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24OMEGAMON II for SMS Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25Candle Management Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26

Chapter 2. VU API Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Logging On and Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28LOGON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29LOGOFF. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31VU Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32VU Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34OMEGAMON II for SMS Base Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Chapter 3. Putting It All Together . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Using the VU API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44Data Format Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45LOGON to CMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46Defragmenting DASD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47Migrating or Releasing Space on Non-SMS DASD. . . . . . . . . . . . . . . . . . . . . . . . . . . . .50Enabling Caching on a List of 3390 DASD Volumes . . . . . . . . . . . . . . . . . . . . . . . . . . .55Enabling Caching on Production 3390 DASD Volumes. . . . . . . . . . . . . . . . . . . . . . . . .57LOGOFF from Candle Management Server and Cleanup . . . . . . . . . . . . . . . . . . . . . . .59

Chapter 4. Installation and Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Requirements for OMEGAMON II for SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .62Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63Adding the OG/MVS Loadlib to the CMS TKANMOD Concatenation . . . . . . . . . . . . . .64Adding the VUSERVER pluapplid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65Manual Procedures Required after Installing OMEGAMON II for SMS V500 or V520 . .67Increasing OMEGAVIEW Virtual Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68

Contents


Chapter 5. VU Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69VUQUERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70VUINSERT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73VUDELETE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75VUSUBST. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78VUOPEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .80VUFETCH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82VUCLOSE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85VUDROP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86Reuse of Request Handles (REQHDLs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87Redirecting the Output of VUFETCH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .88Function Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89

Chapter 6. Syntax for Constructing a Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Comparison Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96Data Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98Substitution Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100Predicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101Predicate Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102Search Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104

Appendix A. VU Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105

Appendix B. OMEGAMON II for SMS Base Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137ACTEFTRTAB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139ACTREQTAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141ACTRESPTAB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147APPL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148CACHE_CU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149CACHE_DET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151CACHE_DEV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156CACHE_ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158CHAN_PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159DASD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161DASD_USERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165DSN_ENQS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166DSN_IO_ST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167DSN_LOC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169DSN_SMS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170DSNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171HSM_CDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175HSM_DS_RV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .176HSM_FUN_DA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .177

Contents 5

HSM_FUN_ST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178HSM_REQS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180HSM_STATUS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .182HSM_STOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184JOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186LCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .187RMF_ENV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189SMS_CONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .190SMS_DAT_CL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191SMS_MAN_CL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193SMS_ST_CL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195SMS_ST_GRP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .196SYSTEM_ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198

Appendix C. Identifying and Locating Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Appendix D. Guide to Candle Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201Base Maintenance Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202Enhanced Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206Customer Support Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .207

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Preface 7

Preface

About this documentThis document describes the OMEGAMON II® for SMS Data Interface function of OG/MVS®. It contains all the information you need to install the function at your site and start using OMEGAMON II for SMS data. This document contains:

n a description of the function’s components

n an explanation of the VU Application Programming Interface

n a description of the OMEGAMON II for SMS Candle Management Server®

n scenarios demonstrating how to use the interface

The following manuals comprise the OG/MVS documentation set:

n OG/MVS Configuration and Customization Guide

n OG/MVS User’s Guide

n OG/MVS Command Reference Manual

n OG/MVS OMEGAMON II for SMS Data Interface

n OG/MVS: Using the Subsystem Logging Facility

n Candle Product Messages Manual

For additional information on OMEGAMON II for SMS, consult the OMEGAMON II for SMS User’s Guide.

Note: To make use of the OG/MVS OMEGAMON II for SMS Data Interface, your OMEGAMON II for SMS product must be at a level currently supported by Candle Corporation.

P


Where to look for more informationFor more information related to this product and other related products, please see the

n technical documentation CD-ROM that came with your product

n technical documentation information available on the Candle Web site at www.candle.com

n online help provided with this and the other related products.

Ordering additional documentationTo order additional product manuals, contact your Candle Customer Support representative.

We would like to hear from youCandle welcomes your comments and suggestions for changes or additions to the documentation set. A user comment form, located at the back of each manual, provides simple instructions for communicating with the Candle Information Development department.

You can also send email to [email protected]. Please include "OMEGACENTER Gateway for MVS OMEGAMON II for SMS Data Interface Version 340" in the subject line.

Preface 9

Syntax Diagrams

Syntax DiagramsThis manual uses the format below to describe the syntax of the OG/MVS commands.

n Some commands can be abbreviated. If an abbreviation is applicable, it is shown in parentheses next to the command name.

n Read the syntax diagrams from left to right, from top to bottom, following the path of the line.

n The symbol below indicates the statement is continued:

n The symbol below indicates that a line is continued from the previous line:

n The symbol below indicates the end of a statement:

n Required items appear on the horizontal line (the main path).

n Optional items appear below the main path.

n When you can choose from two or more items, they are stacked vertically.

If you must choose one of the items, the item at the top of the stack appears on the main path.

If choosing one of the items is optional, the entire stack appears below the main path.

>

>

> <

Required Item ><STATEMENT

OPTIONAL ITEM

><STATEMENT

Required Choice1 ><

Required Choice2

STATEMENT

Optional Choice1

><STATEMENT

Optional Choice2

Syntax Diagrams


n An arrow returning to the left above the main line indicates an item that can be repeated.

A repeat arrow above a stack indicates that you can make more than one choice from the stacked items, or repeat a single choice.

n If punctuation marks, parentheses, arithmetic operators, or other symbols are shown, they must be entered as part of the syntax.

n An operand name ending in /s specifies a choice of one or more of the operands, the various choices separated by space(s). For example:

option/s

specifies

option1 option2 ...

n An operand name ending in ,s specifies a choice of one or more of the operands, the various choices separated by commas. For example:

pattern,s

specifies

pattern1,pattern2,...

Default operands are underlined.

STATEMENT ><

<

Repeatable item

Preface 11

Documentation Conventions


IntroductionCandle documentation adheres to accepted typographical conventions for command syntax. Conventions specific to Candle documentation are discussed in the following sections.

Panels and figuresThe panels and figures in this document are representations. Actual product panels may differ.

Required blanksThe slashed-b (b) character in examples represents a required blank. The following example illustrates the location of two required blanks.

beBA*ServiceMonitorb0990221161551000

Revision barsRevision bars (|) may appear in the left margin to identify new or updated material.

Variables and literalsIn examples of command syntax, uppercase letters are actual values (literals) that the user should type; lowercase letters are used for variables that represent data supplied by the user. Default values are underscored.

LOGON APPLID (cccccccc)

In the above example, you type LOGON APPLID followed by an application identifier (represented by cccccccc) within parentheses.

Note: In ordinary text, variable names appear in italics.



SymbolsThe following symbols may appear in command syntax:

Table 1. Symbols in Command Syntax

Symbol Usage

| The “or” symbol is used to denote a choice. Either the argument on the left or the argument on the right may be used. Example:

YES | NOIn this example, YES or NO may be specified.

[ ] Denotes optional arguments. Those arguments not enclosed in square brackets are required. Example:

APPLDEST DEST [ALTDEST]In this example, DEST is a required argument and ALTDEST is optional.

{ } Some documents use braces to denote required arguments, or to group arguments for clarity. Example:

COMPARE {workload} -REPORT={SUMMARY | HISTOGRAM}

The workload variable is required. The REPORT keyword must be specified with a value of SUMMARY or HISTOGRAM.

_ Default values are underscored. Example:

COPY infile outfile - [COMPRESS={YES | NO}]In this example, the COMPRESS keyword is optional. If specified, the only valid values are YES or NO. If omitted, the default is YES.

Preface 13

Adobe Portable Document Format


Printing this bookCandle supplies documentation in the Adobe Portable Document Format (PDF). The Adobe Acrobat Reader will print PDF documents with the fonts, formatting, and graphics in the original document. To print a Candle document, do the following:

1. Specify the print options for your system. From the Acrobat Reader Menu bar, select File > Page Setup… and make your selections. A setting of 300 dpi is highly recommended as is duplex printing if your printer supports this option.

2. To start printing, select File > Print... on the Acrobat Reader Menu bar.

3. On the Print pop-up, select one of the Print Range options forn Alln Current pagen Pages from: [ ] to: [ ]

4. (Optional). Select the Shrink to Fit option if you need to fit oversize pages to the paper size currently loaded on your printer.

Printing problems?The print quality of your output is ultimately determined by your printer. Sometimes printing problems can occur. If you experience printing problems, potential areas to check are:n settings for your printer and printer driver. (The dpi settings for both your driver and

printer should be the same. A setting of 300 dpi is recommended.)n the printer driver you are using. (You may need a different printer driver or the Universal

Printer driver from Adobe. This free printer driver is available at www.adobe.com.)n the halftone/graphics color adjustment for printing color on black and white printers (check

the printer properties under Start > Settings > Printer). For more information, see the online help for the Acrobat Reader.

n the amount of available memory in your printer. (Insufficient memory can cause a document or graphics to fail to print.)

For additional information on printing problems, refer to the documentation for your printer or contact your printer manufacturer.

Contacting AdobeIf additional information is needed about Adobe Acrobat Reader or printing problems, see the Readme.pdf file that ships with Adobe Acrobat Reader or contact Adobe at www.adobe.com.

http://www.adobe.com



What’s New in OG/MVS Version 340 15

What’s New in OG/MVSVersion 340

This section provides a description of the new features that have been incorporated into OG/MVS Version 340.

TCP/IP connectivity enhancementsTCP/IP communications have been simplified by permitting you to optionally remove the AF packet header when communicating between OG/MVS and systems or applications that are unable to comply with the Candle AF packet header protocol. You accomplish this by means of a new option on the LINK DEFINE and COMM START commands. In addition, new SEND and RECEIVE datatypes have been added to the COMSDRCV REXX function. You must use the SEND and RECEIVE datatypes when you want to transfer data over a link having the AF packet header turned off.

New keywords have been added to COMM START and COMM STOP commands. The CONNECT_EXEC keyword on the COMM START command identifies a named exec that runs whenever a connection to the server is established and is mandatory when you have specified AFPACKET(OFF). The CID keyword on the COMM STOP command identifies a particular connection to a server to be stopped.

A new COMADMIN REXX function provides GIVE and TAKE options that permit passing ownership of a connection from one match to another.

Passing larger amounts of data on a TCP/IP match

You can now pass more data to an individual match. OG/MVS will permit passing a larger amount of parameter data to a REXX procedure. In addition, it will provide the capability to create a conversation between matches so that multiple 32K packets can be transferred. This is accomplished by permitting the DATARPLY datatype to code the replylength keyword on the COMSDRCV REXX function.

Automated peer-to-peer link managementBy predefining link attributes, it is now possible to automatically establish connections at OG/MVS startup. The following product changes support this function:

n The optional RECOVERY keyword on the LINK DEFINE command indicates that an INACTIVE link having a desired state of ACTIVE is to be automatically started when the specified server becomes available.

W


n The new ACTIVATE keyword on the LINK DEFINE command indicates that a LINK START is to be automatically attempted for a particular linkid, assuming a successful link definition.

n The new SCOPE keyword on the LINK START command specifies those links that are to be selected for LINK START processing according to their activation state.

n Two new startup parameters, HOSTNAME and LINKDEFS are added. HOSTNAME(xxxxxxxx) overrides the default name of the trusted hostnames member in RKANPAR. The LINKDEFS(xxxxxxxx) parameter overrides the default name of the link definitions member in RKANPAR. During product startup, when TIMEOUT(nnn) is specified on the LINKDEFS keyword, it specifies the amount of time to wait for the LINK START command issued immediately after processing the LINKDEFS member to complete before startup is allowed to continue.

Changes to the OPER command when RESP is specifiedThe OPER command issues an MVS or subsystem command. On this command, the RESP parameter specifies that a set of line variables will receive the response text resulting from the command. Additional parameters have been added to the OPER command when specified with the RESP parameter:

n TIMEOUT(pp,ss): The new ss value specifies the number of seconds (from 1 through 3600) that OG/MVS is to wait for each response message line from a multi-line write to operator before assuming the response is complete.

n MAXLINES(nnnn): This new parameter specifies that a response is to be deemed complete when the specified number of lines is received.

n ENDMSG(prefix): This new parameter specifies that the response is to be deemed complete when the specified prefix is encountered in one of the response lines.

The ss value is also added to the OPERRESP OG/MVS startup parameter.

In addition, the CMDSDRCV function has been modified such that when it causes an OPER command with RESP specified to be executed on a remote system, it also causes an AOCASE variable to be built when the reply from the remote system is received.

Additional modificationsn New global variables have been added for COM matches.

n A DUB_AS_PROCESS command, having the same function as the OG/MVS startup parameter of the same name, has been provided.

Storage Constraint ReliefThe amount of storage constraint relief realized will vary depending on OG startup parameters and will be equal to (MAXMAT - MAXRUN) * 480 bytes.

What’s New in OG/MVS Version 340 17

Online documentationWith Version 340, Candle Corporation has moved AF/OPERATOR manuals from IBM BookMaster to Adobe FrameMaker. This move was made to better enable us to address our customers’ needs by providing tools that enhance productivity.

One of the results of the move is that it is no longer possible to create BookManager versions of the AF/OPERATOR manuals. However, the manuals remain available online in the Adobe PDF version on CD-ROM and are also available on the Candle Corporation website at www.Candle.com.

The documentation CD being provided with this release has robust and easy-to-use search capabilities. You can search for information in multiple volumes, multiple versions, and across products. The CD also provides easy setup of search indexes with a single click of the mouse.

If you want to order printed copies of the documentation, please contact your Candle Support Services representative.

Enhancements to product documentationn Additional documentation about obtaining SMF data has been added to the OG/MVS

User’s Guide.

n Additional documentation about using the Probe Directive, Probe Input, and Misc. Parms fields has been added to the OMEGACENTER Status Manager User’s Guide.

Before You Begin 19

Before You Begin

IntroductionThe OG/MVS OMEGAMON II for SMS Data Interface function adds the VU Application Programming Interface (VU API), a bidirectional interface, to one or more OMEGAMON II for SMS products. The VU API enables OG/MVS to query and manipulate data collected by OMEGAMON II for SMS, to pass this statistical information on to other applications, and to execute actions on a storage system.

This function is intended to support your implementation of system managed storage for managing and controlling your enterprise’s storage resources.

Chapter ContentsWhat this OG/MVS Function Can Do For You . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20The VU API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21VU API Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23IBM Storage Management Subsystem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24OMEGAMON II for SMS Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Candle Management Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

1

What this OG/MVS Function Can Do For You


What this OG/MVS Function Can Do For You

IntroductionThe OMEGACENTER Gateway for MVS VU API enables you to automate DASD management tasks. You can, for example, have an automation REXX exec to

n query the fragmentation index of DASD volumes and submit batch jobs to defragment those with a high fragmentation index

n monitor non-SMS-managed DASD volumes, to determine when free space can be reclaimed, and initiate free space release or HSM dataset migration

n search for production 3390 DASD volumes with disabled caching and enable caching on all volumes or on selected volumes

AudienceThis function is intended for system programmers, storage administrators, data center personnel, and others who are responsible for implementing automation procedures for DASD administration, recoverability, availability, and performance management.

What you need to knowYou must be familiar with these Candle products:

n The current version of OG/MVS n The current version of OMEGAMON II for SMS

You will also need a working knowledge of REXX programming language. For information on REXX, consult the following IBM manuals:

n TSO Extensions Version 2 REXX Referencen TSO/E REXX/MVS Reference

Before You Begin 21

The VU API

The VU API

Introduction to the VU APIThe VU Application Programming Interface (VU API) is a synchronous communications interface. It establishes a VTAM® connection between OG/MVS and OMEGAMON II for SMS, making OG/MVS a client of the Candle Management Server™ (CMS™) facility.

The VU API consists of the following components:

n Extensions to the LOGON and LOGOFF commands

n REXX function package

n VU Templates

n TKANSAM (samples)

Commands This function modifies two OG/MVS commands:

n AF LOGON

n AF LOGOFF

These commands establish and terminate LU0 sessions with CMS.

REXX function packageThe REXX function package is a set of 8 REXX callable functions which provide an application programming interface for automation procedures running in the OG/MVS address space.

For a complete description of each VU function, see “VU API Components” on page 27.

Function Description

VUQUERY() Compiles a query request.

VUINSERT() Compiles an insert request.

VUDELETE() Compiles a delete request.

VUSUBST() Substitutes symbols into compiled requests.

VUOPEN() Executes a request.

VUFETCH() Retrieves one or more rows of a table.

VUCLOSE() Closes an active request.

VUDROP() Destroys a request.

The VU API


VU TemplatesVU Templates are Candle supplied views that generate predefined requests used in query, insert, and delete operations. Each VU Template specifies a view of the CMS base tables. A view defines the tables, columns, and rows that the client application needs. A VU Template can retrieve all or a subset of the columns contained in one or more CMS base tables.

TKANSAMTKANSAM contains sample REXX programs designed to carry out specific storage management tasks. TKANSAM programs are not intended for you to use in their present state. Candle has provided them as models you can refer to while writing your own REXX execs. If you want to use one of these programs, you will need to customize it to suit your environment.

The sample programs used in this manual match those in TKANSAM.

Before You Begin 23

VU API Environment

VU API Environment

System Managed StorageThe VU API is intended for your automated storage management environment. You use Candle’s OMEGAMON II for SMS and the IBM Storage Management Subystem to monitor, control, and automate storage systems across your enterprise. You may have additional Candle Availability Management Systems products installed.

Diagram of the VU API operating environmentThis figure illustrates the relationship between the VU API, OG/MVS, and SMS in your enterprise.

ComponentsThe basic operating environment for the VU Application Programming Interface consists of these components:

n OG/MVS

n OMEGAMON II for SMS

n Candle Management Server

n Storage Management Subsystem (SMS)

IBM Storage Management Subsystem


IBM Storage Management Subsystem

IntroductionThe IBM Storage Management Subsystem (SMS) automates storage management. SMS gives the storage administrator the ability to centralize, automate, and prioritize storage allocation by the performance characteristics of the storage media. SMS does not provide realtime storage data.

SMS componentsSMS consists of hardware and software components. The SMS hardware components are

n cache control units

n DASD

n Optical storage devices

The SMS software components are:

Component Description

DFSMSdfp™ An IBM data facility product that provides storage, data, program, and device management functions.

DFSMSdss™ A dataset services product that provides data movement, copy, dump, and space management functions.

DFSMShsm™ A hierarchical storage manager that provides backup, recovery, migration, and space management functions.

DFSMSrmm™ A removable media manager that provides management functions for removable media such as tape cartridges, reels, and optical volumes.

Before You Begin 25

OMEGAMON II for SMS Data

OMEGAMON II for SMS Data

IntroductionOMEGAMON II for SMS is Candle’s realtime performance monitor for your storage resources. It provides status indicators, data displays, and built-in action capabilities. OMEGAMON presents a high-level overview of the status of your storage resources through the Storage Management Status Overview panel.

OMEGAMON II for SMS consists of the following components:

n application address space

n Candle Management Server (data collection address space)

n Candle Subsystem

What data OMEGAMON collectsOMEGAMON II for SMS uses data collection programs, probes, that execute in the data collection address space. Probes collect information on:

n Channel Path

n Logical Control Unit

n Cache Control Unit

n SMS storage groups

n user-defined storage groups

n datasets

n applications

n Data Facility Hierarchical Storage Manager (DFHSM or HSM)

OMEGAMON II for SMS manages DASD device statistics and dataset I/O statistics with its Candle Management Server facility.

Candle Management Server


Candle Management Server

IntroductionThe Candle Management Server (CMS) is a data collector that runs in its own address space and collects, manages, and distributes data for OMEGAMON II for SMS. It stores the statistical information the probes gather in rectangular data structures (tables, columns, and rows). CMS allows multiple host queries from a single point. You can send a query to every CMS on your system and receive data back in one homogeneous table.

The VU API provides direct access to the data managed by Candle Management Server. This gives you the ability to query, update, insert, and delete data in CMS tables.

The CMS facility consists of the:

n CMS Catalog

n base tables

n Application Programming Interface

Candle Management Server CatalogThe CMS Catalog is the functional equivalent of the data dictionary for a database management system. The Catalog contains definitions of CMS objects (base tables, columns, request handles, views, and applications) and information on their interrelationship. No data can be queried or manipulated unless it is defined in the CMS catalog.

Candle Management Server base tablesBase tables are the rectangular data structures in which OMEGAMON II for SMS stores information. A table is a logical structure of data element values arranged in rows of column values. A table column represents one attribute of a data object (for example, I/Os per second for a volser on a specific DASD volume). Every column has a unique name identifying its data type. A table row represents an occurence of the data (for example, 0.8 for I/Os per second). Rows do not have names. The number of rows indicates how many times the table data occurs. In a realtime server, the number of rows a table contains is unpredictable; they may vary widely over a few milliseconds.

A set of predefined OMEGAMON II for SMS probes build each CMS table. The structure of the base tables is fixed (See “OMEGAMON II for SMS Base Tables” on page 137). To understand the data returned from a query to CMS, you must know the design of the individual base tables.

VU API Components 27

VU API Components

IntroductionThis chapter describes the components needed for a successful data query and manipulation. In “Putting It All Together” on page 43, the scenarios will demonstrate how you can use these components to

1. log on to CMS2. use the VU functions within the framework of various VU templates to acquire data from

base tables3. log off

ContentsLogging On and Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28LOGON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29LOGOFF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31VU Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32VU Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34OMEGAMON II for SMS Base Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

2

Logging On and Off


Logging On and Off

IntroductionThe VU API is implemented through extensions to the LOGON and LOGOFF AFHOST environment commands and by a REXX function package. This section describes the LOGON and LOGOFF commands. Other components of the REXX function package are discussed in “VU Functions” on page 32.

ModificationsThe LOGON and LOGOFF commands have been modified to establish and terminate LU0 sessions to a VU server dialog defined in the CMS address space where OMEGAMON II for SMS probes are installed. The VU server dialog dispatches a process after a successful LOGON.

Refer to “Syntax Diagrams” on page 9 for conventions used in describing command syntax.


LOGON

LOGON

IntroductionLOGON initiates an LU0 session with the VU server dialog that resides in the CMS address space used by OMEGAMON II for SMS for data collection.

Syntax

The following parameters have modified meanings for this enhancement. Ignore all other options when establishing a VU API session.

appltype The type of VTAM application. Enter CTDS to establish a VU API session.

APPLID(applid)

The APPLID of the VTAM application. When you define CMS as the appltype, applid specifies the VTAM LU0 APPLID of the VU server dialog that runs the CMS address space used by OMEGAMON II for SMS for data collection.

Note: This applid must be identical to the pluapplid specified with the START command in member KDSCNFG. See “Adding the VUSERVER pluapplid” on page 65.

NAME(applname)

A user-defined name assigned to the LU0 session. When specified during a successful logon, it is passed as an argument to subsequent VU API function calls.

TRACE If specified, enables diagnostic messages.

USERID(userid/password)

The user ID and password required to validate access to CMS. The password appears as asterisks in the system log. A CMS session requires a user ID and password combination that is known to the security system installed in the CMS address space. See “Security” on page 63 for more information.

LOGON appltype APPLID(applid) NAME(applname)

Options: DATA(text) INTERVAL(time) LTERM(luid) PASSWORD(password) SSIZE(n) TRACE USERID(userid/password)

><

option(s)

LOGON


Return Codes

Commentsn The LOGON command is often issued by a startup REXX exec.

n The maximum logon time default is 20 seconds, unless overridden by the LOGONTLM startup option. The range available is 1 to 99 seconds. See the AF/OPERATOR Configuration and Customization Guide for more information.

ExamplesYou must establish a session between the CMS address space and OMEGAMON II for SMS’s address space (data collection) before you make a data query or request.

Following is an example of the LOGON command in a REXX exec used to log onto a CMS session through the VTAM APPL RGOGVU00. OG/MVS supplies the CT/Engine™ external security system with the user ID CANUSER and the user password CANPSWD. The connection name, OMIISMS, is used to identify the communications session.

ADDRESS AFHOST “LOGON CTDS APPLID(RGOGVU00)”,“NAME(OMIISMS) USERID(CANUSER/CANPSWD)”

status=rcIF status<>0 THEN SAY “LOGON TO APPLID(RGOGVU00) FAILED”

Note: You can establish multiple sessions to multiple address spaces or to the same CMS address space.

All examples shown in “Putting It All Together” on page 43 reuse the same connection created by this example.

Return Code Reason

0 VTAM session successfully established.

16 Invalid syntax.

Non-zero Logon failed.


LOGOFF

LOGOFF

IntroductionLOGOFF terminates an LU0 session with the VU server dialog that resides in the CMS address space used by OMEGAMON II for SMS for data collection.

Syntax

Return Codes

ExamplesTerminate a session with the data collection address space by issuing the LOGOFF command.

This is an example of the LOGOFF command in a REXX exec used to log off of a CMS session through the VTAM APPL OMIISMS:

ADDRESS AFHOST “LOGOFF OMIISMS”status=rcIF status<>0 THEN DO

SAY “LOGOFF FROM APPLID(RGOGVU00) FAILED”END

Any outstanding queries or data manipulation requests are closed and dropped automatically with an error following successful logoff processing. Action requests submitted to OMIISMS continue to execute.

name The name (applname) assigned to the LU0 session by the NAME operand in the LOGON command that initiated the session.This operand is required. Any active requests are closed and dropped before logoff processing completes.

Return Code Reason

0 VTAM session successfully terminated.

16 Invalid syntax.

Non-zero Logoff failed.

LOGOFF name

VU Functions


VU Functions

IntroductionThe REXX function package is a set of REXX callable functions that provides an application programming interface for automation procedures running in the OG/MVS address space. The API is supported only for REXX execs that execute within the OG/MVS address space.

ProcessThe VU function process is as follows:

1. LOGON establishes a session to the CMS address space.2. The name of the session is then passed to the VUQUERY, VUINSERT, or VUDELETE

function in order to compile a query, insert, or delete request. Compilation of requests allows reuse of requests without recompiling and minimizes the resources required to interpret the request.

3. Compiled requests can be of more general use by introducing substitution symbols that allow values to be assigned after compilation. You must substitute values before you use VUOPEN to execute a request by a call to the VUSUBST function.

4. CMS allows the query and manipulation of data similar to that of a relational database management system. Compiled requests are executed by calling the VUOPEN function. When you execute VUOPEN, the data collected for a query is assembled into a result table.

5. After a successful query, you can fetch the rows in the result table by calling the VUFETCH function.

6. When request processing is completed, and all rows have been fetched for queries, you can call the VUCLOSE function to release resources occupied by the result table, if any.

7. Additional calls to VUSUBST and VUOPEN can be issued after VUCLOSE is issued to re-execute a request without recompiling.

8. A call to the VUDROP function releases resources occupied by a compiled request. Once VUDROP is executed, the dropped request is no longer valid for any subsequent VU API function calls.

9. LOGOFF terminates the session with the CMS address space. All compiled requests, result tables, and associated resources are automatically released during the logoff.


VU Functions

Function sequenceThe following table shows the normal processing sequence of VU API service calls.

Complete descriptions of each function are provided in “VU Functions” on page 69.

API Command or Function

Prerequisite Description

LOGON command Active SLU APPLID Establish LU0 session to CMS.

VUQUERY(), VUINSERT(), or VUDELETE() functions

LOGON Compile and create CMS request.

VUSUBST() function VUQUERY(), VUINSERT(), or VUDELETE() function

Substitute values into compiled statement before execution.

VUOPEN() function VUQUERY(), VUINSERT(), or VUDELETE() function

Execute a request.

VUFETCH() function VUOPEN() Retrieve one or more rows of result table.

VUCLOSE() function VUOPEN() Close an active request.

VUDROP() function VUQUERY(), VUINSERT(), or VUDELETE() function

Destroy a compiled request. If the request to be dropped is not yet closed, a VUCLOSE will be issued before the request is dropped to ensure integrity of insert, delete, or update requests.

LOGOFF command LOGON Terminate LU0 session with CMS. Any outstanding requests are automatically closed and dropped as a result of the session termination.

VU Templates


VU Templates

IntroductionVU Templates generate predefined queries and data management requests used by the VUQUERY, VUINSERT, and VUDELETE functions. Each VU Template defines the following:

n base table name or names

n column names of the base table(s)

n search criteria

VU Template naming conventionVU Template names begin with the letters DF, the Candle product identifier for OMEGAMON II for SMS.

Modifying viewsA view associates a table with a list of columns and a filter (which identifies specific rows of the table). You cannot add to the tables or columns defined in a view, but you can narrow a view’s focus to fetch only the data required by an application. You can modify a view definition to

n select a subset of the column data

n rearrange the order of the columns fetched

n retrieve only a subset of rows by adding to the search criteria

To modify the columns and rows selected by a view, use the list of column names and search criteria arguments. The list of column names specifies the columns to be retrieved. The search criteria optional argument specifies the rows to be retrieved.

Using a list of column namesUse the VUQUERY list of column names argument to specify the list of columns. The argument is a character string specifying a subset of the desired columns. The column names must be separated by commas and must be a subset of the column names identified by the VU Template.

You can rearrange the order of columns fetched by a query or exclude unnecessary columns to improve data collection performance. See “VUQUERY” on page 70 for additional information.


VU Templates

Using search criteriaUse the VUQUERY and VUDELETE optional search criteria argument to determine the rows fetched or deleted. The criteria you specify is logically ANDed to the search criteria specified by the VU Template. This option enables you to make more selective query and delete operations.

Search criteria may contain substitution symbols that allow a VU Template to be reused without being recompiled. Substitution symbols appear as “?” in the search criteria arguments. See “VUQUERY” on page 70 and “VUDELETE” on page 75 for additional information.

Joined tablesVU Templates that refer to more than one base table are created by joining the tables by one or more common column values. You can only query VU Templates of joined tables; you cannot insert or delete rows. All VU Templates for joined tables are applicable only to VUQUERY function calls.

Template descriptionsThe following table lists the names of the VU Templates included in the VU API, the page in “VU Templates” on page 105 where a detailed description of each template can be found, the function it performs, and a description of information that the view contains.

VU Template Name Page Valid Operations

VU Template Description

DF.ACTION page 107 VUQUERY List of all the DASD volume and dataset actions available from OMIISMS.

DF.ACTIONREQ page 107 VUQUERY, VUINSERT, VUDELETE

Access and manipulate action requests issued by OMIISMS. Queries return action request status. Inserts submit new action requests. Deletes cancel pending requests or remove completed action requests.

DF.ACTIONRESP page 109 VUQUERY Responses issued by completed action requests.

DF.ACTIVEJOB page 109 VUQUERY Current active jobs in the system.

DF.CACHECU page 110 VUQUERY Cache control unit status and performance.

DF.CACHEDETAIL page 111 VUQUERY Detailed cached DASD device performance statistics.

DF.CACHEDEVICE page 112 VUQUERY Cached DASD device performance statistics.

DF.CACHEENV page 112 VUQUERY Cache collection interval information.

DF.CHANNELPATH page 113 VUQUERY Channel path information by CHPID.

VU Templates


DF.DASD page 113 VUQUERY Direct Access Storage Devices.

DF.DASDCACHE page 114 VUQUERY List DASD volume and cache performance data for all online DASD volumes.

DF.DASDCACHEBYJOBNAME page 115 VUQUERY List DASD volume and cache performance data for all volumes being accessed by a specific address space.

DF.DASDCACHEDETAIL page 116 VUQUERY List DASD volume and detailed cached performance data for all online DASD volumes.

DF.DASDUSER page 117 VUQUERY List of address spaces and datasets being accessed on a specific DASD volume.

DF.DSBYASID page 117 VUQUERY List of all datasets being accessed by a specific address space, given its address space ID.

DF.DSBYDSNAME page 118 VUQUERY DSCB and space information for each occurrence of a specific cataloged dataset on 1 or more (multiple) volumes.

DF.DSBYJOBNAME page 118 VUQUERY Datasets accessed by a specific address space by JOBNAME.

DF.DSBYVOLUME page 118 VUQUERY DSCB and space information for all datasets on a volume.

DF.DSENQ page 119 VUQUERY List of jobnames and ENQs for a specified dataset name.

DF.DSIOBYDSNAME page 120 VUQUERY Data set I/O and cache performance statistics by dataset name.

DF.DSIOBYJOBNAME page 121 VUQUERY Dataset I/O and cache performance statistics by job name.

DF.DSIOBYVOLUME page 121 VUQUERY Dataset I/O and cache performance statistics by volume.

DF.DSLOC page 122 VUQUERY VOLSER and device number for a specified dataset name.

DF.DSSMS page 122 VUQUERY SMS information for a specific dataset.

DF.HSMCDS page 122 VUQUERY Space utilization information for HSM control datasets.

DF.HSMDSRV page 123 VUQUERY HSM recovery versions for a specified dataset. One row for each backup version is available for recovery.




VU Templates

DF.HSMFUNDA page 123 VUQUERY Processing statistics for major HSM functions within the current HSM processing interval.

DF.HSMFUNST page 124 VUQUERY Hold status and activity status for major functions within HSM.

DF.HSMREQ page 124 VUQUERY, VUDELETE

Active and queued HSM request processing information.

DF.HSMSTATUS page 125 VUQUERY Status and activity information for HSM collected within the current HSM processing interval.

DF.HSMSTORAGE page 125 VUQUERY Status of virtual storage in the HSM address space.

DF.LCU page 126 VUQUERY Logical control unit information from RMF.

DF.LCUIORATE page 126 VUQUERY Logical control unit information from RMF with total DASD I/O rate.

DF.RMFENV page 127 VUQUERY Information about the RMF environment (collection interval) for the current MVS system.

DF.SMSCONFIG page 128 VUQUERY SMS base configuration data.

DF.SMSDATACLASS page 128 VUQUERY SMS data class information.

DF.SMSDSBYDSNAME page 129 VUQUERY SMS managed dataset attributes with SMS classes.

DF.SMSDSBYVOLUME page 130 VUQUERY List of detailed information for an SMS managed dataset, given the DASD volume serial number.

DF.SMSDSIOBYJOBNAME page 131 VUQUERY Allows comparison of dataset I/O statistics with SMS storage class objectives for all datasets accessed by a specific address space.

DF.SMSDSIOBYVOLUME page 132 VUQUERY Allows comparison of dataset I/O statistics with SMS storage class objectives for all datasets on a specific SMS managed DASD volume.

DF.SMSMANAGEMENTCLASS page 133 VUQUERY SMS management class information.

DF.SMSSTORAGECLASS page 133 VUQUERY SMS storage class information.

DF.SMSSTORAGEGROUP page 134 VUQUERY SMS storage group information.

DF.SYSTEMENV page 134 VUQUERY MVS and DFP environment information.



VU Templates


DF.VOLUMEBYJOBNAME page 135 VUQUERY DASD volumes being accessed by a specific active address space, given its jobname.




OMEGAMON II for SMS Base Tables


IntroductionThis section describes the OMEGAMON II for SMS base tables currently defined in the CMS catalog.

Matching formatsWhen you use the VUFETCH function call to retrieve rows of data returned by a query request, you must be aware that the format of the values in the variables depends on the format of the base table columns as specified in this section. Any comparison of values specified in VUINSERT, VUSUBST, VUQUERY, or VUDELETE function calls requires you to match exactly the specific column format.

CHAR and VARCHAR type columns are returned as character strings in REXX stem variables. Other values may require scaling:

n INTEGER columns are returned in numeric decimal format. Some numeric values include fractional values that have been scaled into integers by multiplying them by a factor of 10 or by clock milliseconds.

n BITSTRING columns are returned as character strings. You can compare them to hexadecimal literals in REXX execs (for example, ‘02’x, ‘00 FF 1A’x) or you can convert them from character format to decimal numerics using the C2D standard REXX function.

DescriptionThe following table describes the base tables supported by this enhancement. Valid operations for the base tables listed are:

ACTREQTAB Query, insert, delete

HSM_REQS Query, delete

All other base tables Query

Base Table Name Page Table Description

ACTEFTRTAB page 139 Action Effector Table. List of all actions that can be inserted into the ACTREQTAB Table.

ACTREQTAB page 141 Action Request Table. Asynchronous DFDSS and DFHSM action requests used for SMS Services.

ACTRESPTAB page 147 Action Response Table. Responses issued by completed action requests (for SMS Services).

APPL page 148 Application Table. Volume and data set usage counts by jobname.



CACHE_CU page 149 Cache Control Unit Table. Cache control unit status and performance for each Control Unit.

CACHE_DET page 151 Cached Device Details Table. Cache performance by volser and device number.

CACHE_DEV page 156 Cached Device Table.

CACHE_ENV page 158 Cache Collection Environment Table. Cache collection interval information.

CHAN_PATH page 159 Channel Path Table. Channel path information by CHPID.

DASD page 161 DASD Table. Direct Access Storage Device data by VOLSER, UCB address, and device number.

DASD_USERS page 165 DASD Users Volume Table. List of jobnames and dataset names for a specified volser and device number.

DSN_ENQS page 166 Dataset Users Table. List of jobnames and ENQs for a specified dataset name.

DSN_IO_ST page 167 Dataset I/O Statistics Table. Dataset I/O and cache performance statistics by volser, device number, dataset name, and jobname.

DSN_LOC page 169 Dataset Cataloged Volser Table. Volser and device number for a specified dataset name.

DSN_SMS page 170 Dataset SMS Table. SMS information for a specific dataset.

DSNS page 171 DSCB/Space Information Table. DSCB and space information for one of the following:n all datasets on a volumen a specific data set on a specific volumen each occurrence of a specific cataloged dataset on 1 or

more (multiple) volumes

HSM_CDS page 175 HSM Space Utilization Table. Space utilization information for HSM control datasets.

HSM_DS_RV page 176 HSM Recovery Table. HSM recovery versions for a specified dataset. One row for each backup version is available for recovery.

HSM_FUN_DA page 177 HSM Function Data Table. Processing statistics for major HSM functions within the current HSM processing interval.

HSM_FUN_ST page 178 HSM Function Status Table. Hold and activity statuses for major functions within HSM.

HSM_REQS page 180 HSM Request Data Table. Active and queued HSM request processing information.

HSM_STATUS page 182 HSM Status Table. Status and activity information for HSM collected within the current HSM processing interval.

HSM_STOR page 184 HSM Address Space Virtual Storage Utilization Table.

JOB page 186 Active Job Table. Current active jobs in the system.

LCU page 187 LCU Data Table. Logical control unit information from RM.



RMF_ENV page 189 RMF Environment Table. Information about the RMF environment (collection interval) for the current MVS system.

SMS_CONFIG page 190 SMS Base Configuration Data Table.

SMS_DAT_CL page 191 SMS Data Class Data Table.

SMS_MAN_CL page 193 SMS Management Class Data Table.

SMS_ST_CL page 195 SMS Storage Class Data Table.

SMS_ST_GRP page 196 SMS Storage Group Data Table.

SYSTEM_ENV page 198 System Environment Table. MVS and DFP environment information.

Putting It All Together 43

Putting It All Together

IntroductionThis chapter explains how to use the VU API. It covers the process for creating a REXX exec using VU Templates and the VU function package. Included are 6 usage scenarios that show how to use the VU API to carry out specific storage management tasks.

n logging on to Candle Management Servern defragmenting DASDn migrating or releasing space on Non-SMS DASDn enabling caching on a list of 3390 DASDn ensuring that caching is enabled on production 3390 DASDn logging off of Candle Management Server and cleanupThis chapter also gives information on the scaling and format of CMS data.

Chapter ContentsUsing the VU API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Data Format Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45LOGON to CMS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46Defragmenting DASD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Migrating or Releasing Space on Non-SMS DASD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Enabling Caching on a List of 3390 DASD Volumes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Enabling Caching on Production 3390 DASD Volumes . . . . . . . . . . . . . . . . . . . . . . . . . . 57LOGOFF from Candle Management Server and Cleanup . . . . . . . . . . . . . . . . . . . . . . . . 59

3

Using the VU API


Using the VU API

IntroductionThis section describes the steps in the process of writing and executing a REXX exec using the VU API. It explains how the VU API communicates with the Candle Management Server.

Using TKANSAMThe REXX execs used in the scenarios in this chapter can be found in TKANSAM. The TKANSAM programs are not intended for you to use in their present state. They are provided as models that you can refer to while writing your own REXX execs. If you want to use one of these programs, you will need to customize it to suit your systems.

SecuritySecurity access to the VU API is verified when a LOGON command is issued to establish an LU0 connection between OG/MVS and CMS. See “Security” on page 63 for more information.

Design processThis list gives the stages in the process for using the VU API to request data from or insert data into Candle Management Server tables.

1. Begin by reviewing the VU Templates to determine what information they retrieve from Candle Management Server.

2. Select the template or templates that will retrieve the information you require.

3. Decide on overrides for columns and search criteria if necessary.

4. Select a VU function that will accomplish the action required.

5. Include the VU Template name, column names, and search criteria as arguments for the function.

6. Using one of the scenarios as a model, write a REXX program that includes the VU Template and the VU function.

7. Enter the LOGON command to establish an LU0 session with OMEGAMON II for SMS.

8. Execute the REXX exec you have created.

Program DescriptionKOGVUX00 LOGON to Candle Management Server.KOGVUX0 Deframent DASD with high FRAGINDEX.KOGVUX0 Migrate or release space on non-SMS DASD.KOGVUX0 Enable caching on a list of 3390 DASD.KOGVUX04 Ensure that caching is enabled on all production 3390 DASD volumes.KOGVUX99 LOGOFF from Candle Management Server.


Data Format Considerations

Data Format Considerations

IntroductionThe format of the values returned by VUFETCH depends on the format of the base table columns. Because of the way Candle Management Server stores character and integer data, you will need to refer to the CMS base table descriptions to determine the column formats and the range of values.

CHAR and VARCHAR columnsCHAR and VARCHAR type columns are returned as character strings in REXX stem variables.

BITSTRING columnsBITSTRING columns are returned in character strings. These may be compared to hex literals in REXX execs or can be converted from character format into decimal numerals using the C2D standard REXX function.

Integer data scalingINTEGER columns are returned in numeric decimal format. Some numeric values include fractional values that are scaled into integers by multiplying them by a factor of 10 or by clock milliseconds. You must determine the scaling factor for numeric values returned by VUFETCH. Check the descriptions of each integer column in the base tables to determine the scaling factor, if any.

For example, in the LCU table ( page 187) the value in column ALL_CP_BSY is per cent (%) multiplied by 1000. The value in column PCT_CUBUSY of the same table is % multiplied by 10. In comparison operations, the scaling and format of the values being compared must match.

See “Syntax for Constructing a Search” on page 95 for additional information about formatting.

LOGON to CMS


LOGON to CMS

IntroductionThe following example shows a typical LOGON command. All scenarios that follow reuse the same connection created by this example. See “Logging On and Off” on page 28 for more information about the LOGON command.

Example KOGVUX00The line numbers in the following scenario are for reference purposes only.

Usage notesn Logon from OG/MVS to OMEGAMON II for SMS using the application type CTDS. See

“LOGON” on page 29 for details. In this example, TOD Trap KOGVUX04 periodically executes REXX exec KOGVUX04, which searches for production 3390 DASD volumes with caching disabled. This exec is decribed in “Example KOGVUX04” on page 57.

n The pluapplid for the CMS address space is RGOGVU00.

000001 /* REXX */000002 applid=”RGOGVU00”000003 ADDRESS AFHOST “LOGON CTDS APPLID(RGOGVU00)”,000004 “NAME(OMIISMS) USERID(CANUSER/CANPSWD)”000005 status=rc000006000007 IF status<>0 THEN SAY “LOGON TO APPLID(RGOGVU00) FAILED”000008 ELSE DO000009 /* Initialize TOD TRAP for Scenario 4 for every 5 minutes */000010 ADDRESS AFHOST “TRAP ADD(KOGVUX04) TOD(*) INTERVAL(00:05:00)”,000011 “ENABLE ACTION(‘EX KOGVUX04’)”000012 END000013 RETURN status


Defragmenting DASD

Defragmenting DASD

IntroductionThis scenario shows how an automation REXX exec can be used to query the fragmentation index of DASD volumes so that batch jobs to defragment these volumes can be submitted. Selective defragmentation minimizes the dedicated maintenance time required to defragment DASD by limiting processing to only those volumes requiring attention.

The defragmentation procedure can be customized with OG/MVS options to select different groups of volumes on different days of the week.

Defragmentation policyIdeally, this automation procedure should be executed once daily during off-hours.

Defragmenting DASD



This example shows all calls associated with a query.

000001 /* REXX */000002 status=VUQUERY(“OMIISMS”, “reqhdl”,,000003 “DF.DASD”,,000005 “VOLSER, DEV_TYPE”,,000006 “FRAG_IDX > 800”)000007000008 IF status<>0 THEN SAY “VUQUERY error. status =” status000009 ELSE DO000010 /* VUQUERY was successful. Run Query */000011 status=VUOPEN(reqhdl)000012 IF status<>0 THEN SAY “VUOPEN error. status =”status000013 ELSE DO000014 /* VUOPEN was successful, Fetch Data */000015 volser.0=0000016 status=VUFETCH(reqhdl, “*”, “volser., dev_type.”)000017 IF status<>0 THEN SAY “VUFETCH error. status =”status000018 /* Close request */000019 closestatus=VUCLOSE(reqhdl)000020 IF closestatus<>0 THEN SAY “VUCLOSE error. status =” closestatus000021 END000022 dropstatus=VUDROP(reqhdl)000023 IF dropstatus<>0 THEN SAY “VUDROP error. status =” dropstatus000024 END000025000026 IF status=0 THEN DO000027 /* VUFETCH was successful and one or more volumes were selected.*/000028 /* Submit a batch job to defragment each volume selected. */000029 DO i=1 to volser.0000030 /* Call external function to format and submit a batch job to */000031 /* defragment the volume with a target fragmentation index(500)*/000032 IF dev_type.i=’0E’x THEN unit=”3380”000033 ELSE IF dev_type.i=’0F’x THEN unit=”3390”000033 ELSE unit=””000034 submitstatus=KOGVUXSJ(“DEFRAG”, volser.i, unit, 500)000035 END000036 END000037000038 RETURN status


Defragmenting DASD

Usage notesn The VUQUERY function call compiles a query request. This request uses the DF.DASD

VU template. The VOLSER and DEV_MODEL columns are the only columns required for the query. Only data for DASD volumes with a fragmentation index greater that 800 is retrieved. VUQUERY initializes a request handle which is passed to all subsequent VU calls. The handle uniquely identifies this query request and is stored in variable reqhdl.

n The requested data is fetched from CMS. The resulting data is a list of all the volsers that have fragmentation indexes greater than 800, if there are any. The request is then terminated and resources are freed (VUCLOSE) and, since the handle is no longer needed, it is destroyed (VUDROP).

n For each VOLSER satisfying the query criteria, a call to KOGVUXSJ is made to submit a DASD defragmentation job for each volume. The KOGVUXSJ REXX program (found in TKANSAM) takes a jobtype argument to determine the JCL to be submitted. The VOLSER and target fragmentation index values are passed to KOGVUXSJ so that these values may be substituted into control cards to defragment the specified DASD volume.

Migrating or Releasing Space on Non-SMS DASD



IntroductionThis REXX exec accepts 3 arguments to determine if space on non-SMS-managed DASD volumes should be reclaimed. A call to VUQUERY is issued to find all DASD volumes that are

n online (MVS_STATUS<>0X02)

n non-SMS-managed (SMS_CONVFG=0)

n have a free space percentage that exceeds the value passed in the FREEPCT parameter

All volumes retrieved by the query are analyzed by calling REXX internal functions estrelse and estmigrt. These functions issue queries to predict the effects of DFDSS free space release and of HSM dataset migration. Automation actions to initiate a DFHSM dataset migration or submit a batch job to release free space from datasets on the volume are taken depending on the values returned by these functions.


000001 /* REXX */000002 IF ARG()=1 THEN000003 PARSE VAR ARG(1) freepct days relspct .000004 ELSE000005 ARG freepct, days, relspct .000006000007 /* freepct Threshold percent of free space for Migrate/Release */000008 /* days Number of days of non-reference before dataset is */000009 /* considered for migration. */000010 /* relspct Percent of free space to be released from dataset */000011000012 status=VUQUERY(“OMIISMS”, “reqhdl”, “DF.DASD”,,000013 “VOLSER, DEV_TYPE, NUM_CYLS, TRK_P_CYL”,,000014 “MVS_STATUS<>0X02 AND SMS_CONVFG=0X00 AND FREE_PCT<=”freepct*10)000015000016 IF status<>0 THEN SAY “VUQUERY error. status =” status000017 ELSE DO000018 /* VUQUERY was successful. Run Query */000019 status=VUOPEN(reqhdl)000020 IF status<>0 THEN SAY “VUOPEN error. status =”status000021 ELSE DO000022 /* VUOPEN was successful, Fetch Data */000023 volser.0=0000024 status=VUFETCH(reqhdl, “*”,,000025 “volser., dev_type., numcyl., trkpcyl.”)000026 IF status<>0 THEN SAY “VUFETCH error. status =”status000027 /* Close request */000028 closestatus=VUCLOSE(reqhdl)000029 IF closestatus<>0 THEN SAY “VUCLOSE error. status =” closestatus



000030 END000031 dropstatus=VUDROP(reqhdl)000032 IF dropstatus<>0 THEN SAY “VUDROP error. status =” dropstatus000033 END000034000035 IF status=0 & volser.0>0 THEN DO000036 SAY volser.0 “NON-SMS volumes found with <“ freepct”% free space”000037 DO i=1 to volser.0 WHILE status=0000038 /* Determine the type of DASD */000039 IF dev_type.i = ‘0E’x THEN unit=”3380”000040 ELSE unit=”3390”000041 /* Compute target free space=20% of volume capacity in tracks */000042 targetfreetrks=TRUNC(numcyl.i * trkpcyl.i * freepct/100 + .9)000043 SAY “Attempting to reclaim” targetfreetrks” tracks on “volser.i000044 /* See if DFDSS free space release from datasets will */000045 /* reclaim enough free space to satisfy the target. */000046 releasetrks=estrelse(volser.i,relspct)000047 SAY “Estimated freespace reclaimed on” volser.i “is” releasetrks “tracks”000048 IF releasetrks > targetfreetrks THEN DO000049 /* Submit job to release free space up to the “relspct” */000050 SAY “Submitting job to release” releasetrks “tracks on” volser.i000051 status=KOGVUXSJ(“RELSPACE”, volser.i, unit, relspct)000052 IF status<>0 THEN000053 SAY “RELSPACE job submittal error. status =” status000054 END



Usage notesn This exec queries all volumes with a low amount of free space and, if found, passes the

names of the volumes to one or both of the subroutines estrelse and estmigrt for further query and analysis.

n Subroutines may be called repeatedly by the parent exec. Request handles are reused inside the match.

n The VUDROP function must be called by the parent routine to ensure that each request handle is destroyed before completion.

000055 ELSE DO000056 /* See if HSM Migrating datasets will reclaim enough */000057 /* free space to meet the target. */000058 migratetrks=estmigrt(volser.i,days)000059 SAY “Estimated reclaimed space on” volser.i “is” migratetrks “tracks”000060 IF migratetrks > targetfreetrks THEN DO000061 SAY “Migrating datasets to get” migratetrks “tracks on” volser.i000062 ADDRESS AFHOST,000063 “OPER ‘F DFHSM,MIGRATE”,000064 “VOLUME(“volser.i” MIGRATE(“days”))’”000065 status=rc000066 IF status<>0 THEN SAY “MIGRATE error. status =” status000067 END000068 ELSE IF (releasetrks + migratetrks) > targetfreetrks THEN DO000069 /* Issue both a release and a migrate */000070 SAY “Migrating datasets to get” migratetrks “tracks on” volser.i000071 ADDRESS AFHOST,000072 “OPER ‘F DFHSM,MIGRATE”,000073 “VOLUME(“volser.i” MIGRATE(“days”))’”000074 status=rc000075 IF status<>0 THEN SAY “MIGRATE error. status =” status000076 ELSE DO000077 SAY “Submitting job to release” releasetrks “tracks on” volser.i000078 status=KOGVUXSJ(“RELSPACE”, volser.i, unit)000079 IF status<>0 THEN000080 SAY “RELSPACE job submittal error. status =” status000081 END000082 END000083 ELSE000084 ADDRESS AFHOST,000085 “WTO ‘Unable to achieve target free space on”,000086 “volume=”volser.i”’ NOMSGID”000087 END000088 END /* of DO WHILE */000089 END000090000091 /* Drop request handles created and reused by subroutines */000092 dropstatus=VUDROP(relsehdl)000093 dropstatus=VUDROP(migrthdl)000094 SAY “KOGVUX02 completed”000095000096 RETURN status



Subroutine estrelseThis subroutine estimates the number of tracks that can be released by DFDSS.The variable relsehdl is exposed so that the compiled query handle may be reused.

Subroutine estmigrtThis subroutine estimates the number of tracks that can be freed using a DFHSM migrate operation.The variable migrthdl is exposed so that compiled queries may be reused.

000001 estrelse: PROCEDURE EXPOSE relsehdl000002 ARG volser, relspct000003 /* volser DASD volume serial to be analyzed. */000004 /* relspct Percent of free space to be released */000005 /* from dataset for release */000006000007 releasetrks=0000008 status=0000009 IF relsehdl=”RELSEHDL” THEN DO000010 /* Query not yet compiled. Call VUQUERY */000011 status=VUQUERY(“OMIISMS”, “relesehdl”,,000012 “DF.DSBYVOLUME”, “TRKS_ALLOC”,,000013 “TRKS_ALLOC>=10 AND PCT_USED<=?”)000014 IF status<>0 THEN SAY “VUQUERY error. status =” status000015 END000016000017 IF status=0 THEN DO000018 /* VUQUERY successful or relsehdl was already initialized */000019 /* and the query can be reused. */000020 status=VUSUBST(relesehdl, volser, (100-relspct)*10)000021 IF status<>0 THEN SAY “VUSUBST error. status = “ status000022 END000023000024 IF status=0 THEN DO000025 /* VUSUBST successful. Now call VUOPEN to execute the query. */000026 status=VUOPEN(relsehdl)000027 IF status<>0 THEN SAY “VUOPEN error. status =” status000028 ELSE DO000029 /* VUOPEN was successful, Fetch Data */000030 tracks.0=0000031 status=VUFETCH(relsehdl, “*”, “tracks.”)000032 IF status<>0 THEN SAY “VUFETCH error. status =”status000033 /* Close request */000034 closestatus=VUCLOSE(relsehdl)000035 IF closestatus<>0 THEN SAY “VUCLOSE error. status =” closestatus000036 END000037 END000038000039 IF status=0 THEN DO000040 DO I=1 TO tracks.0000041 releasetrks=releasetrks + TRUNC(tracks.i * relspct/100 + .9)000042 END000043 END000044 RETURN releasetrks



000001 estmigrt: PROCEDURE EXPOSE migrthdl000002 ARG volser, ndays000003 /* volser DASD volume serial to be analyzed. */000004 /* ndays Number of days of non-reference */000005 /* before a dataset is migrated */000006000007 status=0000008 migratetrks=0000009 IF migrthdl=”MIGRTHDL” THEN DO000010 /* Query not yet compiled. Call VUQUERY */000011 status=VUQUERY(“OMIISMS”, “migrthdl”,,000012 “DF.DSBYVOLUME, TRKS_ALLOC”,,000013 “REF_DATE<=?”)000014 IF status<>0 THEN SAY “VUQUERY error. status =” status000015 END000016000017 IF status=0 THEN DO000018 /* VUQUERY successful or relsehdl was already initialized. */000019 /* Compute the date ndays ago in Julian format. */000020 jdateago=DATE(“J”)-ndays000021 IF (jdateago//1000)>366 THEN DO000022 /* Note: jdateago//1000 returns the day from a Julian date*/000023 /* jdateago was in previous year if remainder > 366 */000024 /* Normalize the date by subtracting off 635 and add 1 if */000025 /* a leap year and date is beyond February 28th (59th day)*/000026 jdateago=jdateago - 635000027 IF TRUNC(jdateago/1000)//4=0 & jdateago//1000>59 THEN DO000028 /* Note: TRUNC(jdateago/1000) returns the year in */000029 /* a Julian date. If the year is divisible by 4, */000030 /* the year is assumed to be a leap year. */000031 jdateago=jdateago+1000032 END000033 END000034 /* Substitue volser and Julian date ndays ago into query. */000035 status=VUSUBST(migrthdl, volser,000036 D2C(TRUNC(jdateago/1000),1)||D2C(jdateago//1000,2)) /*@01*/

000037 IF status<>0 THEN SAY “VUSUBST error. status = “ status000038 END000039000040 IF status=0 THEN DO000041 /* VUSUBST successful. Call VUOPEN to execute the query. */000042 status=VUOPEN(migrthdl)000043 IF status<>0 THEN SAY “VUOPEN error. status =”status000044 ELSE DO000045 /* VUOPEN was successful, Fetch Data */000046 tracks.0=0000047 status=VUFETCH(migrthdl, “*”, “tracks.”)000048 IF status<>0 THEN SAY “VUFETCH error. status =”status000049 /* Close request */000050 closestatus=VUCLOSE(migrthdl)000051 IF closestatus<>0 THEN SAY “VUCLOSE error. status =” closestatus000052 END000053 END000054000055 IF status=0 THEN DO000056 DO I=1 TO tracks.0000057 migratetrks=migratetrks + tracks.i000058 END000059 END000060 RETURN migratetrks


Enabling Caching on a List of 3390 DASD Volumes


IntroductionThis scenario shows a VUINSERT call to enable caching on a list of 3390 DASD volumes. The REXX exec accepts one or more serial numbers of volumes on which caching will be enabled. Actions are accomplished by issuing a request to OMEGAMON II for SMS to initiate a SetCacheVol action. Action responses may be obtained by issuing a query on the DF.ACTIONRESP VU Template or by reviewing completed actions from the OMEGAMON II for SMS DASD Services Status displays.




Usage notesn This example shows how the request handle created by the VUINSERT call can be reused

across matches by storing the value of the handle in a REXX shared variable.

n kogvux03hdl is the name of a REXX shared variable that contains the value of the handle.

000001 /* REXX */000002000003 volser.0=ARG()000004 /* Get list of VOLSER from argument list */000005 DO i=1 to ARG()000006 volser.i=ARG(i)000007 END000008000009 /* Compile INSERT request if not yet compiled */000010 status=SHARVGET(“SYSTEM”, “kogvux03hdl”)000011 IF status=8 THEN DO000012 status=VUINSERT(“OMIISMS”, “kogvux03hdl”, “DF.ACTIONREQ”)000013 IF status<>0 THEN SAY “VUINSERT error. status =” status000014 ELSE DO000015 status=SHARVPUT(“SYSTEM”, “kogvux03hdl”)000016 IF status<>0 THEN SAY “SHARVPUT error. status = “status000017 END000018 END000019 ELSE IF status<>0 THEN SAY “SHARVGET error. status = “status000020000021 IF status=0 THEN DO000022 /* VUINSERT was successful or request handle could be reused */000023 IF SYSVGET(“AOTASK”)=0 THEN aotask=”OG/MVS”000024 DO I=1 to volser.0 WHILE status=0000025 status=VUSUBST(kogvux03hdl,,000026 “SetCacheVOL”,,000027 volser.i,,000028 “UNIT(3390) DEVICE(ON)”,,000029 aotask,,000030 “ “)000031 IF status<>0 THEN SAY “VUSUBST error. status =” status000032 ELSE DO000033 status=VUOPEN(kogvux03hdl)000034 IF status<>0 THEN SAY “VUOPEN error. status =” status000035 ELSE DO000036 status=VUCLOSE(kogvux03hdl)000037 IF status<>0 THEN SAY “VUCLOSE error. status =” status000038 END000039 END000040 END000041 END000042000043 RETURN status


Enabling Caching on Production 3390 DASD Volumes


IntroductionThis scenario shows a REXX exec that periodically executes a search for production 3390 DASD volumes with caching disabled. If one or more volumes are found, a call is made to KOGVUX03 to enable caching on the volume.

A Time of Day (TOD) trap is used to execute the REXX exec at periodic intervals. See “Example KOGVUX00” on page 46 for the TRAP ADD statement that is used to call the following REXX exec.




Usage notesn This example shows how the request handle created by the VUQUERY call can be reused

across matches by storing the value of the handle in a REXX shared variable.

n kogvux04hdl is the name of a REXX shared variable that contains the value of the handle.

n This parent exec uses KOGVUX03 as a subroutine in which the insert operation (to turn on caching) is performed.

n Single quotes (‘) are used in the argument to VUQUERY because imbedded double quotes (“) are required in the character string.

000001 /* REXX */000002000003 status=SHARVGET(“SYSTEM”, “kogvux04hdl”)000004 IF status=8 THEN DO000005 /* Compile query request if not yet compiled */000006 status=VUQUERY(“OMIISMS”, “kogvux04hdl”,,000007 “DF.CACHEDEVICE”, “VOLSER”,,000008 “CU_MODEL=0X03 AND CACH_STAT=2 AND”,000009 ‘VOLSER>”PROD00” AND VOLSER<“PROD99”’)000010 IF status<>0 THEN SAY “VUQUERY error. status =” status000011 ELSE DO000012 status=SHARVPUT(“SYSTEM”, “kogvux04hdl”)000013 IF status<>0 THEN SAY “SHARVPUT error. status = “status000014 END000015 END000016 ELSE IF status<>0 THEN SAY “SHARVGET error. status = “status000017000018 IF status=0 THEN DO000019 /* VUQUERY successful or kogvux04hdl can be reused */000020 status=VUOPEN(kogvux04hdl)000021 IF status<>0 THEN SAY “VUOPEN error. status =”status000022 ELSE DO000023 /* VUOPEN was successful, Fetch Data */000024 volser.0=0000025 status=VUFETCH(kogvux04hdl, “*”, “volser.”)000026 IF status<>0 THEN SAY “VUFETCH error. status =”status000027 /* Close request */000028 closestatus=VUCLOSE(kogvux04hdl)000029 IF closestatus<>0 THEN SAY “VUCLOSE error. status =” closestatus000030 END000031 END000032000033 IF status=0 THEN DO000034 DO I=1 to volser.0000035 status=KOGVUX03(volser.i)000036 IF status<>0 THEN000037 SAY “Unable to enable caching on volume =” volser.i000038 END000039 END000040 RETURN status


LOGOFF from Candle Management Server and Cleanup


IntroductionUse the LOGOFF command to terminate the VU API LU0 session.


This example shows cleanup tasks that are performed before you log off.

Usage notesn REXX shared variables created in examples KOGVUX04 and KOGVUX03 are deleted.

n The TOD TRAP (created during logon, see “Example KOGVUX00” on page 46) that periodically executes KOGVUX04 is deleted.

000001 /* REXX */000002000003 /* Delete the TOD TRAP for KOGVUX04 */000004 ADDRESS AFHOST “TRAP DELETE(KOGVUX04) TOD”000005000006 /* Get rid of request handle used in example KOGVUX04, if it exists */000007 IF SHARVGET(“SYSTEM”, “kogvux03hdl”)=0 THEN DO000008 status=VUDROP(kogvux03hdl)000009 IF status<>0 THEN SAY “VUDROP error. status = “status000010 ELSE DO000011 status=SHARVDEL(“SYSTEM”, “kogvux03hdl”)000012 IF status<>0 THEN SAY “SHARVDEL error. status = “ status000013 END000014 END000015000016 /* Get rid of request handle used in example KOGVUX04, if it exists */000017 IF SHARVGET(“SYSTEM”, “kogvux04hdl”)=0 THEN DO000018 status=VUDROP(kogvux04hdl)000019 IF status<>0 THEN SAY “VUDROP error. status = “status000020 ELSE DO000021 status=SHARVDEL(“SYSTEM”, “kogvux04hdl”)000022 IF status<>0 THEN SAY “SHARVDEL error. status = “ status000023 END000024 END000025000026 /* Terminate CTDS session */000027 ADDRESS AFHOST “LOGOFF OMIISMS”000028 status=rc000029 IF status<>0 THEN DO000030 SAY “LOGOFF FROM OMIISMS FAILED”000031 END000032000033 RETURN status

Installation and Customization 61

Installation and Customization

IntroductionTo install this function, you must perform the following procedures:

n Add the OG/MVS load module to the CMS loadlib concatenation.

n Add the START command to RKANPAR(KDSENV).

n Add the pluapplid to SYS1.VTAMLST.

n Increase the number of virtual terminals for OMEGAVIEW®.

“Adding the OG/MVS Loadlib to the CMS Loadlib Concatenation” on page 64 begins the discussion of these procedures.

Note: Versions previous to DF500 are no longer supported for use with OG/MVS.

Chapter ContentsRequirements for OMEGAMON II for SMS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Adding the OG/MVS Loadlib to the CMS Loadlib Concatenation. . . . . . . . . . . . . . . . . . . 64Adding the VUSERVER pluapplid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Manual Procedures Required after Installing OMEGAMON II for SMS V500 or V520 . . . . 67Increasing OMEGAVIEW Virtual Terminals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

4

Requirements for OMEGAMON II for SMS


Requirements for OMEGAMON II for SMS

Considerations after installing OMEGAMON II for SMS Version 500 or laterThis version of OG/MVS requires OMEGAMON II for SMS Version 500 or later. However, once you have installed OMEGAMON II for SMS Version 500, you can no longer access previous versions of OMEGAMON II for SMS from OG/MVS. This occurs because:

n OMEGAMON II for SMS V500 uses a newer version of the Candle Management Server (CMS).

n This version of the CMS implements a dynamic load list to reduce virtual storage requirements. This prevents the OG/MVS-to-OMEGAMON II for SMS load module from being loaded.

You must, therefore, perform the manual procedure described in “Manual Procedures Required after Installing OMEGAMON II for SMS V500 or V520” on page 67 to enable the interface between OG/MVS and OMEGAMON II for SMS. This manual procedure must be performed after every refresh of the runtime environment datasets.


Security

SecurityThe following options are provided for enabling security in the CMS (data collection) address space:

n No security

n NAM database security

n ACF2 external security

n RACF™ external security

Refer to the CT/Engine Customization Guide for the steps needed to enable security. A summary of those security setup procedures follows:

n Modification of the KDSINNAM member in the OMEGAMON II for SMS RKANPAR runtime dataset is required to specify the desired security option.

n If you select the NAM security option, you must allocate and initialize the RKDSNAM VSAM dataset.

n If you select the ACF2 security option, you must assemble and link edit the security exit, KLVA2NEV.

n Other external security related steps are required to configure access rights or rules.

Note: OMEGAMON II for SMS does not enable security in the CMS address space during installation. Candle recommends that you do not enable security at this time unless it is absolutely required to minimize security inconsistencies with other components of OMEGAMON II for SMS.

Adding the OG/MVS Loadlib to the CMS Loadlib Concatenation


Adding the OG/MVS Loadlib to the CMS Loadlib Concatenation

ProcedureAdd the OG/MVS load module library (TKANMODL) to the list of libraries referenced by the STEPLIB DD and RKANMODL DD concatenation in the JCL for the CMS address space delivered with OMEGAMON II for SMS. Specify DD statements in the JCL for the CMS started task procedure.

DescriptionThe last DD statement in the following example,

DD DISP=SHR,DSN=&OGHILEVL.TKANMODL

specifies the target library containing the OG/MVS load modules.

CMS loadlib concatenation:

//STEPLIB DD DISP=SHR,DSN=&RHILEV..&SYS..RKANMOD// DD DISP=SHR,DSN=&THILEV.TKANMODL// DD DISP=SHR,DSN=&OGHILEV.TKANMODL//RKANMODL DD DISP=SHR,DSN=&THILEV.TKANMODL// DD DISP=SHR,DSN=&OGHIKLEV.TKANMODL

This JCL is normally delivered and configured by OMEGAMON II for SMS installation software.


Adding the VUSERVER pluapplid


ProcedureAdd the pluapplid specified in “Adding the VUSERVER pluapplid” on page 65 to the SYS1.VTAMLST member that defines the other applids for the CMS address space. An example of the pluapplid follows:

RGOGVU00 APPL PARSESS=YES,SRBEXIT=YES,EAS=1, X

AUTH=(ACQ,PASS,SPO,NVPACE)

DescriptionThe following figure shows an example of the SYS1.VTAMLST member with the applid definition added to the last two lines.



This VTAM major node member is normally delivered and configured by OMEGAMON II for SMS installation software.

*---------------------------------------------------------------------**- COPYRIGHT (C) 1992-1995 CANDLE CORPORATION -**- ALL RIGHTS RESERVED, USE PERMISSIBLE BY LICENSE ONLY -**---------------------------------------------------------------------**- -**- NAME: DF9DNODE -**- PURPOSE: CT VTAM MAJOR NODE AND APPLIDS -**- -**---------------------------------------------------------------------*DF9DNODE VBUILD TYPE=APPL CT MAJOR NODE** THE FOLLOWING DEFINES THE CT APPLICATION*DF9DDDS APPL ACBNAME=DF9DDDS, APPLID FOR ACB X APPC=YES, APPC SUPPORT X AUTH=(ACQ), CAN ACQ X AUTOSES=0, AUTO ACTIVATED SESSIONS X DDRAINL=ALLOW, DRAINING ALLOWED X . . . . . .DF9DDPD2 APPL ACBNAME=DF9DDPD2, APPLID FOR ACB X APPC=YES, APPC SUPPORT X AUTH=(ACQ), CAN ACQ X AUTOSES=2, AUTO ACTIVATED SESSIONS X DDRAINL=ALLOW, DRAINING ALLOWED X DLOGMOD=CANCTDCS, DEFAULT LOGMODE ENTRY X DMINWNL=7, LOCAL CONTENTION WINNER SESSIONS X DMINWNR=7, REMOTE CONTENTION WINNER SESSIONS X DRESPL=ALLOW, NO DRAINING ALLOWED X DSESLIM=14, SESSION LIMIT X MODETAB=KDFMTAB2, MODE TABLE NAME X PARSESS=YES, PARALLEL SESSION SUPPORT X VPACING=3 PACING VALUE**** PLU APPLID FOR THE VU SERVER**RGOGVU00 APPL PARSESS=YES,SRBEXIT=YES,EAS=1, X AUTH=(ACQ,PASS,SPO,NVPACE)


Manual Procedures Required after Installing OMEGAMON II for SMS V500 or V520

Manual Procedures Required after Installing OMEGAMON II for SMS V500 or V520

To reenable the interface between OG/MVS and OMEGAMON II for SMS after the installation of OMEGAMON II for SMS Version 500 or Version 520:

1. Edit the RKANPAR (KDSSYSIN) member to add the following statement after the last LOADLIST statement:

LOADLIST(KOGLLIST)

2. Create or modify the member RKANPAR(KOGLLIST) to add the following statement:KOGVUSRV

This ensures that the interface support load module KOGVUSRV is properly loaded at CMS startup.

3. If you are using OMEGAMON II for SMS V500 (CMS V300), ensure that the following program is assigned to the KDS_START instruction in RKANPAR(KDSENV):

KDS_START=\KDSOPTSK;\KOGVUSRV pluapplid 0

where pluapplid is the Primary Logical Unit APPLID used for the interface to OG/MVS.

If you are using OMEGAMON II for SMS V520 ...

Note: You must perform this procedure after every refresh of the runtime environment datasets.

Increasing OMEGAVIEW Virtual Terminals


Increasing OMEGAVIEW Virtual Terminals

ProcedureThe applids used for CMS communications will use the same virtual terminal pool and VTAM SLU applids as defined for communications with OMEGAVIEW.

n If you have not configured the OMEGAVIEW interface and want to use the VU API, you must now configure the interface in order to define the virtual terminal pool.

n If you have already configured the OMEGAVIEW interface, you must increase the number of virtual terminals defined in the AOVTPLU0 load module by the number of sessions expected between the OG/MVS and the CMS address spaces.

n Review the secondary logical unit application IDs defined for the OMEGAVIEW interface to determine if you need to increase the virtual terminal pool.

Using the OG/MVS CustomizerThe most convenient way to complete this modification is to use the OG/MVS Customizer to increase the number of virtual terminals defined for the OMEGAVIEW interface by the appropriate number. See the discussion of virtual terminals in the AF/OPERATOR Configuration and Customization Guide for more information.

These parameters are normally delivered and configured by OG/MVS installation software.

VU Functions 69

VU Functions

IntroductionThis chapter describes REXX callable functions in detail, the reuse of request handles, and the impact of the REDIRECT function on VUFETCH.

Chapter ContentsIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69VUQUERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70VUINSERT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73VUDELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75VUSUBST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78VUOPEN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80VUFETCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82VUCLOSE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85VUDROP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Reuse of Request Handles (REQHDLs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Redirecting the Output of VUFETCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Function Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

5

VUQUERY


VUQUERYCompiles a predefined query view. If the compilation is successful, OG/MVS creates a request handle variable that can be used during subsequent calls to other VU API functions.

Syntax

applname Application name specified on a LOGON command. During logon, applname establishes an LU0 session between OG/MVS and the CMS address space that is used by OMEGAMON II for SMS for data collection.

reqhdl Character string specifying the name of the REXX local variable to be updated with a request handle if the view is successfully compiled. The value is passed on to subsequent VU API function calls.

VUTemplate Character string specifying the name of a predefined view that designates the base table(s), columns to be fetched, and default search criteria for the query request.

col1,col2...,coln

Character string specifying a list of column names to be returned by queries on VU Templates. The column names in the list must ben separated by commasn specified as a single argument (that is, within quotes)n a subset of the columns defined for the VU Template (that is, comprised of one

or more of the names of the columns defined for the specified VU Template)Include only the columns necessary for your query. This minimizes the data collection and transfer overhead.

searchcriteria

Optional. Search criteria in the format (described in “Syntax for Constructing a Search” on page 95) that will override the default search criteria generated by the VU Template. If specified, the search criteria mustn include required search columns as documented by the specified viewn be syntactically acceptableThe search criteria may contain substitution symbols (designated by question marks in this argument). If specified, you must assign values to the symbols by calling VUSUBST before you call VUOPEN to execute the query. The number of values and order of substitution is determined by the number and position of substitution symbols generated by the VU template and this argument.

>> ) ><

>> >VUQUERY(“applname”,”reqhdl”,”VUTemplate”,

,”searchcriteria”V

<

,coln

“col1 “

VU Functions 71

VUQUERY

Function codesThe following table lists several of the VU client, VU server, and CMS return codes specific to the VUQUERY function. For a complete list of all return codes for this and all other functions, see “Function Return Codes” on page 89.

In the following table, rrrr specifies a reason code; if the reason code is unspecified, rrrr equals 0000.

Code Description

0 The function completed successfully.

1 The argument is invalid.

200 A CMS compilation failure occurred.

201 The parser found invalid input.

202 A CMS catalog error occurred.

206 An access plan creation error occurred.

350 A syntax error occurred. Check the syntax of the search criteria argument passed to VUDELETE and VUQUERY.

351 The symbol is too long.

352 A parser error occurred.

353 The hexadecimal data is invalid or too long.

-1001rrrr A control block initialization error occurred in the VU server.

-1005rrrr A request initialization error occurred from the VU server.

-1012rrrr An invalid continuation packet was received by the VU server.

-1013rrrr An invalid continuation sequence number was received by the VU server.

-1121rrrr The number of arguments is greater than the maximum allowed.

-1125rrrr An error occurred during an attempt to obtain storage.

-1127rrrr The applname was not found. Be sure that the applname specified matches LOGON NAME(applname). Unexpected termination of the logon session can also cause this error.

-1131rrrr An internal error is calling $VTM1BUF with INQMAX.

-1141rrrr The OG/MVS REXX shared variable pool cannot be accessed.

-1144rrrr An error occurred during an attempt to obtain an OG/MVS REXX shared variable.

-1145rrrr An error occurred during an attempt to obtain a REXX local variable.

-1150rrrr The template name was not found.

-1151rrrr An internal error occurred during the processing of a function subroutine.

-1152rrrr An invalid column name was specified in the column names argument. The reason code indicates the relative position of the invalid name.

VUQUERY


Usage notesn Free the resources occupied by a compiled request by calling the VUDROP function.

n You can use the search criteria argument to further limit the rows deleted by the default criteria of the specified view.

ExampleIn the following example, a query is using VU Template DF.DASD to compile a view of data included in columns VOLSER and DEV_MODEL with the search criteria FRAG_IDX > 800.

status=VUQUERY(“OMIISMS”, “queryhdl”,,“DF.DASD”,,“VOLSER, DEV_MODEL”,,“FRAG_IDX > 800”)

IF status<>0 THEN SAY “VUQUERY error. status =” status

-1153rrrr A recompile of the same handle has been attempted.

-1192rrrr Warning: The function replaced the value of an existing local variable. Processing continues.

-1193rrrr Warning: A session termination exit was not established. Logoff will not automatically clean up all OG/MVS REXX shared variables used by the VU API. Use the VUDROP function to drop all handles for this session before logoff. Processsing continues.

Code Description

VU Functions 73

VUINSERT

VUINSERTCompiles a predefined insert view to add a new row into a table. If the compilation is successful, OG/MVS creates a request handle variable that can be used during subsequent calls to other VU API functions.

Syntax>>--- VUINSERT("applname","reqhdl","VUTemplate")---><

Function codesThe following table lists several of the VU client, VU server, and CMS return codes specific to the VUINSERT function. For a complete list of all return codes for this and all other functions, see “Function Return Codes” on page 89.



reqhdl Character string specifying the name of the REXX local variable to be updated with a request identifier if the view is successfully compiled. The value is passed on to subsequent VU API function calls.

VUTemplate Character string specifying the name of a predefined view that designates the table and columns in the row that will be inserted.

The column values that will be inserted are specified by symbols that are generated by the VU template. You must assign values to the symbols by calling VUSUBST before you call VUOPEN to execute the query. The number of values and order of substitution is determined by the number and position of symbols generated by the template.

Code Description







350 A syntax error occurred.




VUINSERT


Usage noteFree the resources occupied by a compiled request by calling the VUDROP function.

ExampleAn example of an insert into the Action Request Table follows.

status=VUINSERT(“OMIISMS”, “inserthdl”, “DF.ACTIONREQ”)IF status<>0 THEN SAY “VUINSERT error. status =” status






-1127rrr The applname was not found. Be sure that the applname specified matches LOGON NAME(applname). Unexpected termination of the logon session can also cause this error.









VU Functions 75

VUDELETE

VUDELETECompiles a predefined delete view. If the compilation is successful, OG/MVS creates a request handle variable that can be used during subsequent calls to other VU API functions.

Syntax


reqhdl Character string specifying the name of the REXX local variable to be updated with a request identifier if the view is successfully compiled. The value is passed on to subsequent VU API function calls.

VUTemplate Character string specifying the name of a predefined view that designates the table and default search criteria for the delete request.

searchcriteria

Optional. Search criteria in the format (described in “Syntax for Constructing a Search” on page 95) that will override the default search criteria for the specified view. If specified, the search criteria mustn include required search columns as documented by the specified viewn be syntactically acceptable

The search criteria may contain substitution symbols (designated by question marks in this argument). If specified, you must assign values to the symbols by calling VUSUBST before you call VUOPEN to execute the delete. The number of values and order of substitution is determined by the number and position of substitution symbols generated by the VU Template and this argument.

>> ) ><

>> >VUDELETE(“applname”,”reqhdl”,”VUTemplate”,

,”searchcriteria”

VUDELETE


Function codesThe following table lists several of the VU client, VU server, and CMS return codes specific to the VUDELETE function. For a complete list of all return codes for this and all other functions, see “Function Return Codes” on page 89.


Code Description
















-1127rrrr The applname was not found. Be sure that the applname specified matches LOGON NAME(applname). Unexpected termination of the logon session can also cause this error.




-1150rrr The template name was not found.




VU Functions 77

VUDELETE

Usage notesn Free the resources occupied by a compiled request by calling the VUDROP function.

n You can use the search criteria argument to further limit the rows deleted by the default criteria of the specified view.

ExampleAn example of a deletion of a specific action request follows. The request ID will be specified in a subsequent call to VUSUBST.

status=VUDELETE(“OMIISMS”, “deletehdl”, “DF.ACTIONREQ”,””)IF status<>0 THEN SAY “VUDELETE error. status = “status

VUSUBST


VUSUBSTSubstitutes symbols (?) in successfully compiled requests. This function allows you to reuse compile requests (VUQUERY, VUINSERT, and VUDELETE requests) and to make substitutions in compiled requests during run time.

Syntax

reqhdl Request ID returned by a successful function call to VUQUERY, VUINSERT, or VUDELETE. The request ID is associated with a compile query or data manipulation request containing argument markers.

value1,value2...,valuen

List of values that you want substituted in symbols found in the data stream that is specified to compile the request. You must ensure that the number and order of values that you specify match the number and order of the substitution symbols and search criteria specified in the VU Templates used to call to VUQUERY, VUINSERT, or VUDELETE functions.

Caution: Unassigned substitution symbols will cause unpredictable results.

>> VUSUBST(”reqhdl”,”value1,

,valuen

“ ) ><

V

VU Functions 79

VUSUBST

Function codesThe following table lists several of the VU client, VU server, and CMS return codes specific to the VUSUBST function. For a complete list of all return codes for this and all other functions, see “Function Return Codes” on page 89.In the following table, rrrr specifies a reason code; if the reason code is unspecified, rrrr equals 0000.

ExampleThe following example shows the VUSUBST function coded in preparation for a VUOPEN function call.

status=VUSUBST(deletehdl, actreqid)IF status<>0 THEN SAY “VUSUBST error. status = “ status

Code Description


-2rrrr The VU request handle is invalid.

-3rrrr VUSUBST tried to substitute values into a request that was already open.

-5rrrr VUSUBST specified too many values.

-6rrrr VUSUBST specified too few values.

-7rrrr VUSUBST specified a value that did not convert to the required format.




-1124rrrr An internal error is parsing the input arguments.


-1143rrrr The variable name is too long for REXX.



-1154rrrr An invalid handle was specified. If reason code 1 appears, the handle had probably been dropped before the current function call.

-1155rrrr An invalid internal VU control block was found.

-1156rrrr The number of values to be specified does not match the number of substitution symbols. Ensure that the number of values specified equals the substitution symbols required by the VU Template plus any additional substitution symbols specified in the search criteria argument of the VUDELETE and VUQUERY function calls used to define the VU request.

-1157rrrr A substitution value was larger than allowed.

-3000rrrr Warning: One or more substitution values exceeded the maximum length acceptable by the substitution symbol.

VUOPEN


VUOPENExecutes a compiled request and initiates the collection of any returned data. If the request is a query, CMS creates a result table that contains the data satisfying the search criteria. You can then fetch the data by using a call to the VUFETCH function.

Syntax

Note: During slow periods, the VUOPEN function will time out after a default time of 10 minutes. You can extend this time by setting the OG/MVS match variable AOVUTIMO to some value betwen 5 and 99,999 seconds.

If you set AOVUTIMO to 0, it indicates that VUOPEN is not to time out and is to wait indefinitely for some data returned as the result of a compiled request.

Function codesThe following table lists several of the VU client, VU server, and CMS return codes specific to the VUOPEN function. For a complete list of all return codes for this and all other functions, see “Function Return Codes” on page 89.


reqhdl Request ID returned by a successful function call to VUQUERY, VUINSERT, or VUDELETE.

colcountvarname

Optional. Variable name that will be updated with an integer value that specifies the number of columns in the result table that has been retrieved by a successful query request execution. The returned value is zero for insert and delete requests.

) ><>> VUOPEN(reqhdl

,”colcountvarname”

) ><

VU Functions 81

VUOPEN

Usage noteThe result table for a query is held in memory until you release it by calling the VUCLOSE function.

ExampleThe following example shows the VUOPEN function after a VUSUBST function call and in preparation for a VUFETCH function call.

status=VUOPEN(queryhdl)IF status<>0 THEN SAY “VUOPEN error. status =” status

Code Description


79 No rows were selected for a query or delete operation. Check the search criteria to ensure that required substitution symbols have been assigned values before reissuing the VUOPEN function.

2020 An invalid value for the ACTNAMEAQ column was specified during an insert operation. Check the value specified for the column in the VUSUBST call for the insert request.

2030 An incorrect date and time value was specified for the DATATIMEAQ column during an insert operation. Check the value specified for the column in the VUSUBST call for the insert request. A blank value specifies that the action request begins execution immediately.

2040 An insert operation internal error occurred.

2050 An action request that is currently executing cannot be deleted.

2060 Action requests have been disabled. No new action requests will be accepted by an insert operation.


-3rrrr VUOPEN tried to open a request that was already open.

-6rrrr VUOPEN was called before substitution values were assigned.



-1142rrrr The REXX variable name is invalid.




.-1155rrrr An invalid internal VU control block was found.


VUFETCH


VUFETCHRetrieves some or all of the rows returned by a query request. This data is returned in REXX stem variables.

Each fetch operation sequentially returns one or more rows from a query request executed when the VUOPEN function completed. VUFETCH returns data from the rows retrieved by the query. A result table is built during VUOPEN execution. It comprises rows reflecting the data collected at the time the VUOPEN function executed.

As rows are fetched from the result table, the position of the last row fetched (the cursor position) is updated forward so that each fetch operation returns successive rows of the result table. After the last row of the result table is fetched, no more data can be fetched; a request must be closed and re-opened if a new sample of data is required.

Syntax

reqhdl Request ID returned by a successful function call to VUQUERY.

norows Integer value that specifies the maximum number of rows to be retrieved from the result table created by a query request. You can use an asterisk (*) to specify that all rows are to be fetched. The number of rows actually fetched is placed in the stem1.0 variable (see below).

If an asterisk is not specified, the stem1.0 variable must be tested to determine if the maximum number of rows was fetched and more rows remain to be fetched. Remaining rows are fetched by repetitive calls to the VUFETCH function until a non-zero return code is issued or stem1.0 indicates a value less than the norows value.

stem1.,stem2. ...,stemn.

REXX stem variable name or names that will be created and will contain the data returned by a successful query request. These are user-assigned variable names for columns to be fetched from the query request. They must ben separated by commasn specified as a single argument (that is, within quotes)Note: The total number of rows of data returned is stored in the .0 variable of the first column only (stem1.0).

>> VUFETCH(reqhdl,norows,”stem1

,stemn

“ ) ><

V

VU Functions 83

VUFETCH

Function codesThe following table lists several of the VU client, VU server, and CMS return codes specific to the VUFETCH function. For a complete list of all return codes for this and all other functions, see “Function Return Codes” on page 89.


Usage notesWhen you use VUFETCH, you must be aware that the format of the values in the variables depends on the format of the base table columns as specified in this appendix. During any comparison operation, such as a VUINSERT, VUSUBST, or VUDELETE function call, you must match exactly the specific column values with those in the function search criteria. See “Syntax for Constructing a Search” on page 95 for additional information.

CHAR and VARCHAR type columns are returned as character strings in REXX stem variables. Other values may require scaling:

n INTEGER columns are returned in numeric decimal format. Some numeric values include fractional values that have been scaled to integers by multiplying them by a factor of 10 or by clock milliseconds.

n BITSTRING columns are returned as character strings. You can, compare them to hexadecimal literals in REXX execs (for example, ‘02’x, ‘00 FF 1A’x) or you can convert them from character format to decimal numerics using the C2D REXX standard function.

VUFETCH returns data from the specified query request and stores the data in compound REXX variables whose stem names you specify. VUFETCH appends a number to the stem indicating the row number. For example, if you specify a stem name of volser., as shown in the following code fragment:

status=VUFETCH(queryhdl, “*”, “volser.”)IF status<>0 THEN SAY “VUFETCH error. status =”status

the first row of data is returned in variable volser.1, the second row of data is returned in variable volser.2, and so on. The total number of rows returned is stored in variable volser.0.

Code Description



-8rrrr VUFETCH tried to fetch beyond the end of the result table.

.-1124rrrr An internal error is parsing the input arguments.

-1126rrrr A non-numeric value was found in an argument that requires numeric input.




-1158rrrr The compiled column count was not equal to the input.

VUFETCH


ExampleThe following example shows the VUFETCH function after a VUOPEN function call.

status=VUQUERY(“OMIISMS”, “queryhdl”,,“DF.DASD”,,“VOLSER, DEV_MODEL”,,“FRAG_IDX > 800”)

IF status<>0 THEN SAY “VUQUERY error. status =” status/* VUQUERY was successful. Run Query */

ELSE DOstatus=VUOPEN(queryhdl)IF status<>0 THEN SAY “VUOPEN error. status =”statusELSE DO

volser.0=0status=VUFETCH(queryhdl, “*”, “volser., devmodel.”)IF status<>0 THEN SAY “VUFETCH error. status =”status

:END

:END

Candle recommends that you give the fetched stem a name (devmodel, in the example above) similar to the original column name (DEV_MODEL, in the example) to avoid confusion.

VU Functions 85

VUCLOSE

VUCLOSETerminates an open request and frees resources occupied by the result table built for a query request.

Syntax

Function codesThe following table lists several of the VU client, VU server, and CMS return codes specific to the VUCLOSE function. For a complete list of all return codes for this and all other functions, see “Function Return Codes” on page 89.


Usage noteTo re-execute a compiled request, you can issue a call to VUOPEN after a VUCLOSE call successfully closes.

ExampleAn example of the VUCLOSE function follows.

closestatus=VUCLOSE(queryhdl)IF closestatus<>0 THEN SAY “VUCLOSE error. status =” closestatus


Code Description



-4rrrr VUCLOSE tried to close a request that was already closed.





>>--- VUCLOSE(reqhdl)---><

VUDROP


VUDROPDestroys a successfully compiled request and frees resources occupied by the request. Once dropped, the request ID specified by the reqhdl argument is invalidated, and the request cannot be reopened for execution.

Syntax

Function codesThe following table lists several of the VU client, VU server, and CMS return codes specific to the VUDROP function. For a complete list of all return codes for this and all other functions, see “Function Return Codes” on page 89.


Usage noteIf you issue a call to VUDROP on an open request, an orderly closure of the request executes before the request is dropped.

ExampleIn the following example, the VUDROP function drops request handle queryhdl.

status=VUDROP(queryhdl)IF status<>0 THEN SAY “VUDROP error. status = “status


Code Description






-1154rrrr An invalid handle was specified. The logon session has terminated.

>>--- VUDROP(reqhdl)---><

VU Functions 87

Reuse of Request Handles (REQHDLs)

Reuse of Request Handles (REQHDLs)

DescriptionThe VUQUERY, VUINSERT, and VUDELETE functions return a request handle in a REXX local variable whose name is specified in the reqhdl argument for each function. The request handle identifies a compiled VU request in order to query or manipulate data managed by CMS.

You can reuse the request handle for repetitive requests until you issue a VUDROP function for the handle or until the CMS session is terminated. Reuse of requests reduces the CPU overhead required to compile a request when it is required again.

Usage notesFollow these rules:

n Use substitution symbols when you customize a compile request so that you can make late substitutions of values into the request. You can issue multiple VUSUBST, VUOPEN, VUFETCH, and VUCLOSE functions to substitute values and execute a precompiled request. Repetitive queries for the same data are thus retrieved when you compile the VU request once and then repeat VUSUBST, VUOPEN, VUFETCH, and VUCLOSE calls.

n Save a request handle across the life of an OG/MVS match by copying it into a system or shared variable. This allows subsequent matches to retrieve the request handle for a precompiled request and then reuse the request for repetitive operations.

For example, you can use a time of day (TOD) trap to repeatedly execute a REXX exec that issues a query for DASD cache status:

– The REXX exec first attempts to retrieve the request handle for the query from a shared variable. If the shared variable is not yet defined, the REXX exec calls VUQUERY to compile the request and saves the request handle returned by the function into the shared variable. It then continues with the query by calling VUSUBST, VUOPEN, VUFETCH, and VUCLOSE.

– If the shared variable already exists, the REXX exec reuses the request handle stored in the shared variable and bypasses the call to VUQUERY.

n Although you can reuse a request handle within a single match and across multiple matches, issue only one VUOPEN for the request handle. If more than one VUOPEN call is issued on any VU request, an error status is returned.

Redirecting the Output of VUFETCH


Redirecting the Output of VUFETCH

What the REDIRECT function doesThe OG/MVS REDIRECT function allows you to redirect the output of OG/MVS-supplied REXX functions and commands which return data in variables to REXX variables whose names you can specify. The VUFETCH function is one of the OG/MVS functions whose output can be redirected.

For the complete syntax of the REDIRECT function see OG/MVS Command Reference Manual.

Using REDIRECT with VUFETCHWhen you use the REDIRECT function with VUFETCH, the max argument of REDIRECT is ignored. The norows argument of VUFETCH, which is functionally equivalent to the max argument of REDIRECT, overrides the value specified on REDIRECT.

ExampleIn the following example, the REDIRECT function’s max argument value (an asterisk) specifies that all available variables will be returned. However, this specification is overriden by the value of the VUFETCH function’s norows argument, which specifies that a maximum of 100 rows of data will be returned.

/* REXX */:.

status=REDIRECT(“tablex.”, “*”)vustatus=VUFETCH(queryhdl, 100, “cola.,colb.,colc.,cold.”)

:.

Since output redirection is requested by calling REDIRECT, each variable returned by VUFETCH is prefixed with the stem name you specified (tablex., in this case). Variables returned from this VUFETCH call have 3-part names of the form: tablex.cola.n, tablex.colb.n, tablex.colc.n, and tablex.cold.n (where n indicates the row number returned. In this example, n can range between 1-100 depending on the number of rows retrieved by the VUFETCH call). The total number of fetched rows is stored in variable tablex.cola.0.

VU Functions 89

Function Return Codes


IntroductionThe tables in this section list the following return codes for VU functions.

n CMS

n ACTREQTAB table and DF.ACTIONREQ VU Template return codes for VU functions.

n VU client

n VU server

Candle Management Server status codesThe following table describes the CMS status codes.

Code Description



2 The object is invalid.

3 The object is busy.

4 The function is a duplicate.

5 The object does not exist.

6 A protocol error occurred.

7 A resource (memory) shortage exists.

8 A system error occurred.

9 An unknown error occurred.

11 An authorization error occurred.

50 A memory shortage exists.

79 No rows were selected for a query or delete operation. Check the search criteria to ensure that required substitution symbols have been assigned values before reissuing the VUOPEN function.

101 CMS is inoperative.

107 The requester is at an incompatible release level.





300 The request handle is invalid.



ACTREQTAB table return codesThe following table describes return codes issued as a result of QUERY, INSERT, or DELETE operations on the ACTREQTAB table and the DF.ACTIONREQ VU Template.

VU client return codesIn the following table, rrrr specifies a reason code; if the reason code is unspecified, rrrr equals 0000.





Code Description

2020 An invalid value for the ACTNAMEAQ column was specified during an insert operation. Check the value specified for the column in the VUSUBST call for the insert request.

2030 An incorrect date and time value was specified for the DATATIMEAQ column during an insert operation. Check the value specified for the column in the VUSUBST call for the insert request. A blank value specifies that the action request begins execution immediately.

2040 An insert operation internal error occurred.

2050 An action request that is currently executing cannot be deleted.

2060 Action requests have been disabled. No new action requests will be accepted by an insert operation.

Code Description

-1120rrrr A required argument has a null value.


-1122rrrr One or more required arguments is missing.

-1124rrrr An internal error is parsing the input arguments.

-1126rrrr A non-numeric value was found in an argument that requires numeric input.

-1127rrrr The applname was not found. Be sure that the applname specified matches the LOGON NAME(applname). Unexpected termination of the logon session can also cause this error.

-1130rrrr An internal processing error occurred.



VU Functions 91


-1134rrrr An error occurred during an attempt to send data to CMS, probably due to an unexpected session termination.

-1136rrrr An error occurred during an attempt to receive data from CMS, probably due to an unexpected session termination.

-1137rrrr A timeout occurred while waiting to receive data from CMS. Do not make additional calls to VU API functions from the current match when this return code is received. Instead, complete execution of the current match or terminate the session with CMS by issuing LOGOFF to avoid possible synchronization errors.

If this problem occurred in a call to a function issuing a large query, update the value of the AOVUTIMO global variable (using GLBVPUT) to increase the timeout limit to the desired value in number of seconds. A numeric value from 5 to 32767 is acceptable. The default value is 600 seconds for VUOPEN. All other VU API functions default to 150 seconds.

If the request handle is reused by another match after a timeout occurs, the handle may be unavailable. If so, timeouts will occur in matches that reuse the handle.


-1140rrrr A VU server communications error occurred.


-1142rrrr The REXX variable name is invalid.

-1143rrrr The variable name is too long for REXX.





-1152rrrr An invalid column name was specified in the column names argument. The reason code indicates the relative position of the invalid name.


-1154rrrr An invalid handle was specified. If reason code 1 appears, the handle had probably been dropped before the current function call. This code may also appear during a VUDROP function if the logon session has terminated.


-1156rrrr The number of values to be specified does not match the number of substitution symbols. Ensure that the number of values specified equals the substitution symbols required by the VU Template plus any additional substitution symbols specified in the search criteria argument of the VUDELETE and VUQUERY function calls used to define the VU request.

-1157rrrr A substitution value was larger than allowed.

-1158rrrr The compiled column count was not equal to the input.



VU server return codesThe following table describes the VU server return codes.

-1190rrrr Warning: An attempt to free buffers failed. Processing continues.

-1191rrrr Warning: A disconnect from a VTM1 connection was unsuccessful. Processing continues.


-1194rrrr Warning: An invalid timeout value was found for the AOVUOPTO global variable. This variable is not required to be set in OG/MVS, but, if it exists, it must have an acceptable numeric value. Processing continues using the default timeout value. To avoid this warning code, delete the AOVUOPTO variable, or redefine it with a valid value. Avoid the DCL NOTRUNC option, as unintended padding may make your value unacceptable. See error code -1137rrrr for more information.

Code Description


-3rrrr VUOPEN or VUSUBST tried to open or substitute values into a request that was already open.

-4rrrr VUCLOSE tried to close a request that was already closed.

-5rrrr VUSUBST specified too many values.

-6rrrr VUSUBST specified too few values or VUOPEN was called before substitution values were assigned.

-7rrrr VUSUBST specified a value that did not convert to the required format.

-8rrrr VUFETCH tried to fetch beyond the end of the result table.

-1000rrrr A memory allocation shortage exists in the VU server.


-1002rrrr A thread creation error occurred in the VU server.

-1003rrrr An unrecognized request type was received by the VU server.

-1004rrrr An invalid function was specified to the VU server.

-1005rrrr A request initialization error was detected by the VU server.

-1006rrrr A session/path initialization error was detected by the VU server.

-1007rrrr An invalid VTAM packet format was detected by the VU server.

-1008rrrr A communication failure was detected by the VU server.

-1009rrrr An invalid VTAM packet format was detected by the VU server.

-1010rrrr An invalid VTAM packet format. was detected by the VU server

VU Functions 93


-1011rrrr An invalid VTAM packet sequence number was detected by the VU server.



-1014rrrr A VTAM send error was detected by the VU server.

-2000rrrr A request parsing error was detected by the VU server (PDU error).

-2001rrrr The RUSIZE to VTAM session is too small to transmit the response packet.

-3000rrrr Warning: One or more substitution values exceeded the maximum length acceptable by the substitution symbol.

Syntax for Constructing a Search 95

Syntax for Constructing a Search

IntroductionThis chapter discusses the elements you need to know when constructing a search.

Chapter ContentsComparison Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Data Constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Operators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Substitution Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Predicates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Predicate Evaluation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Search Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

6

Comparison Considerations


Comparison Considerations

IntroductionOG/MVS to OMEGAMON II for SMS communication requires exact matches for operations to execute successfully within the VU API. When you use a search argument, the data is passed to CMS, which accepts the data only if it is presented according to certain syntax requirements. This chapter discusses in detail the requirements previously described in “Putting It All Together” on page 43. Candle recommends that you become familiar with these language elements.

n data constants

n operators

n substitution symbols

n expressions

n predicates

n predicate evaluation

n search conditions

CharactersIn CMS communications, characters are classified as letters, digits, operator characters, delimiter characters, CMS special characters, and invalid characters, as follows:

Letters A B ... Z; a b ... z

Digits 0 1 2 3 4 5 6 7 8 9

Operator characters

+ - * / = . , ( ) { }

Delimiter characters

<blank> “ . ,

Special characters

_ ? : %

Invalid characters

Any character not listed above.


Data Constants

Data Constants

IntroductionCMS supports 3 types of data constants:

n character strings

n decimal integers

n hexacecimals

Character stringsA character string constant is a sequence of zero or more characters enclosed in double quotes (“). The storage length of the string is the number of characters between the quotes, 1 byte per character. Blanks and all printable characters can be in string constants. CMS invalid characters can be in string constants only. Examples follow:

“This is a string constant.”“*** ERROR ****”“3.141592636”“#@%$!!”

Decimal integers (numerics)A decimal integer constant is an optional sign, positive (+) or negative (-), followed by 1 or more decimal digits. No decimal point can be specified; it is assumed that a decimal point follows the last digit. Examples follow:

1999-327670-4096+4512147483647

HexadecimalsHexadecimal is not a CMS column type, but hexadecimal constants are acceptable representations of the values of CMS columns with numeric, bitstring, or boolean data types. Following the hexadecimal convention of C language, CMS hexadecimal constants consist of the digit 0 followed by the letter x (or X), followed then by 2, 4, or 8 hexadecimal digits. Examples follow:

0x4fffffff0X400000000xFF0X1a2c0x01

Operators


Operators

IntroductionCMS has 3 classes of operators:

n arithmetic

n comparison

n grouping

Arithmetic operatorsThe following arithmetic operators have their customary meanings:

+ - * /

Comparison operatorsThe following comparison operators have their customary meanings, except for < >, which means is not equal to.

= <> > < >= <=

Grouping operatorsParentheses, ( ), are used in all contexts where grouping is required or permitted, such as for governing the order of evaluation of predicates in compound search criteria.


Substitution Symbols

Substitution Symbols

DescriptionIn CMS, a substitution symbol is a question mark (?). It can be used in search criteria instead of a column value to communicate to CMS that the value being replaced will not be specified until execution time.

ExampleAn example follows.

GRS.QUEUE_STAT = ?

Expressions


Expressions

DefinitionSemantically, an expression specifies a value.

Syntactically, it can be a data constant, column name, or substitution symbol; a sequence that represents the invocation of a CMS system function; or an arithmetic expression in which subexpressions are combined by arithmetic operators.

Expression formatThe format of an expression is as follows:

ExamplesExamples of expressions follow:

0XFFFFVOLSER?4096CSA_ALLOC + CSASTR.ECSA_ALLOC(USED_TRKS / ALLOC_TRKS) * 100

Constant Decimal integer, hexadecimal, or string constant.

Columnname Name of a table or view column.

? Substitution symbol.


Predicates

Predicates

DefinitionSemantically, a predicate specifies a condition that is true or false about a given row. Predicates are the mechanisms by which a CMS application selects the rows it wants to process and filters out the rest.

Syntactically, a predicate consists of 2 expressions joined by a comparison operator.

Predicate formatThe format of a predicate is:

ExamplesExamples of predicates follow:

I_O_RATE > ?ONLINE_CNT = 2JOBNAME <> “JES2”PAGEOUTS >= PAGEINS / 3SWAP_REAS = 0X01

LINK =

<>

>

<

>=

><

<=

Predicate Evaluation



IntroductionEvaluation of a predicate involves a comparison of the value specified by the operand to the left of the comparison operator with the value specified by the operand to the right. To understand the CMS comparison process, you must first understand CMS data types.

Column data typesA data type is a category that identifies the basic nature of the data values of a CMS column. CMS supports the following data types:

INTEGER2 or SHORT

Binary integer with a precision of 15 bits. The range of INTEGER2 is -32768 to 32767.

INTEGER4 or LONG

Binary integer with a precision of 31 bits. The range of INTEGER4 is -2147483648 to 2147483647.

FLOAT Floating point number in the floating point format of the host machine executing the Candle Management Server process that accesses the number. For example, for any host of the 370x family, FLOAT values range from (approximately) 5.4 x 10-79 to 7.2 x 10 + 75, with a maximum precision of 17 decimal digits.

Even though data type FLOAT is supported by the Candle Management Server, floating point data constants are not valid tokens.

CHARn Sequence of a fixed number of characters. All values of a column of type CHAR have the same length.

VARCHARn

Sequence of a varying number of characters, up to a defined maximum. Different values of a column of type VARCHAR can have different lengths, and any one value can have different lengths at different times.

BITSTRINGn

Sequence of a fixed number of bytes with each byte permitted to have any 8-bit pattern.

BOOLEAN One-byte value with only 2 meaningful values:

0 False.

1 True.



Comparison processThe comparison process makes assumptions and imposes requirements on the operands of a predicate, as follows:

n At least one operand must include a columnname or system function name, so that the data collector entry can identify a range of values whose data type and length can guide the comparison process.

n If both operands identify ranges of values, then those ranges must be the same, or else strictly compatible, as follows:

– The shorter string operand will be padded with blanks to the length of the longer string operand before the comparison, if each operand is of type CHAR or VARCHAR or if both operands are of type BITSTRING.

– A SHORT value will be converted to LONG before the comparison, if the operands are decimal integers of different lengths.

n If a range of values can be derived from only one operand, then the data type and length of that range govern the comparison. The Candle Management Server only performs limited processing to convert the other operand to the governing data type and length. It does not do type conversions (for example, FLOAT to INTEGER), but it does pad (with blanks) or truncate character strings, bit strings, and hexadecimal constants to the governing length.

n If the governing range of values has type BITSTRING, then the only operators supported are is equal to (=) and is not equal to (<>). A predicate evaluation cannot be based on individual bits within a bit string.

n There are no BOOLEAN values for true or false. BOOLEAN values must compare either equal or not equal to 0X00 (hex 00).

Search Conditions


Search Conditions

DefinitionSemantically, a search condition specifies a condition that is true or false about a given row.

Syntactically, it is a predicate or 2 or more predicates connected with the logical operators AND or OR.

The result of a search condition is derived by the application of the specified logical operators (AND or OR) to the result of each specified predicate. If the logical operators are not specified, the result of the search condition is the result of the specified predicate.

DescriptionSearch conditions within parentheses are evaluated first. Where parentheses are not present to direct the order of evaluation, AND takes precedence over OR. Two examples follow:

pred1 AND pred2 OR pred3 ==> (pred1 AND pred2) OR pred3pred1 OR pred2 AND pred3 ==> pred1 OR (pred2 AND pred3)

Simple predicates in which a column name occurs in the expression may allow an index to locate the qualifying row(s).

ExamplesSearch condition examples follow:

PAGEOUTS >= PAGEINS / 3JOBNAME <> “JES2” AND JOBNAME <> “$RMFA”FREE_CYLS = 0 AND FREE_TRKS = 0HOST_RESP > ? OR NET_RESP > ?JOBNAME = “NET01” AND (AREA = “CSA” OR AREA = “ECSA”)

VU Templates 105

VU Templates

IntroductionThis appendix provides a detailed description of each VU Template view. The VU Templates are listed in alphabetical order.

ContentsDF.ACTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107DF.ACTIONREQ. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107DF.ACTIONRESP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109DF.ACTIVEJOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109DF.CACHECU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110DF.CACHEDETAIL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111DF.CACHEDEVICE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112DF.CACHEENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112DF.CHANNELPATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113DF.DASD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113DF.DASDCACHE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114DF.DASDCACHEBYJOBNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115DF.DASDCACHEDETAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116DF.DASDUSER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117DF.DSBYASID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117DF.DSBYDSNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118DF.DSBYJOBNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118DF.DSENQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119DF.DSIOBYDSNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120DF.DSIOBYJOBNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121DF.DSIOBYVOLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121DF.DSLOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122DF.DSSMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122DF.HSMCDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122DF.HSMDSRV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123

A


DF.HSMFUNDA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123DF.HSMFUNST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124DF.HSMREQ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124DF.HSMSTATUS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125DF.HSMSTORAGE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125DF.LCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126DF.LCUIORATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126DF.RMFENV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127DF.SMSCONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128DF.SMSDATACLASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128DF.SMSDSBYDSNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129DF.SMSDSBYVOLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130DF.SMSDSIOBYJOBNAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131DF.SMSDSIOBYVOLUME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132DF.SMSMANAGEMENTCLASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133DF.SMSSTORAGECLASS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133DF.SMSSTORAGEGROUP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134DF.SYSTEMENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134DF.VOLUMEBYJOBNAME. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

VU Templates 107

DF.ACTIONDF.ACTION lists all DASD volume and dataset actions available from OMIISMS.

The data is derived from base table OMSMS.ACTEFTRTAB (see page 139).

VUQUERY

VUQUERY creates the following columns:

DF.ACTIONREQDF.ACTIONREQ lists the status of all OMIISMS action requests in progress. You can use the

n VUINSERT function to perform insert operations that allow you to submit new actions on DASD volumes and datasets. The DF.ACTION VU Template lists all available actions.

You can use the ACTIONREQ VU Template to initiate automation actions when the response to completed requests must be retained for future reference. Otherwise, you can use the OG/MVS OPER command or submit a batch job as alternative methods for automation actions.

n VUDELETE function to perform delete operations that allow the removal of completed requests from the action request table. Status and response information for all actions are retained until they are deleted.

The data is derived from base table OMSMS.ACTREQTAB (see page 141).

VUQUERY


ACTDESCAE ACTNAMEAE OBJCLASSAE

ACTDESCAQ APPL_NAME COMPTIMEAQ KEYAQ OBJECTAQ RESPCNTAQACTNAMEAQ CLIENTAQ DATETIMEAQ OBJCLASSAQ PARMSAQ RETCODEAQSTATUSAQ


Default criteria

Selects all rows.

Notes:

1. The KEYAQ column returns a unique integer value that you can use in VUDELETE operations to remove a specific action request from the table.

2. The PARMSAQ value may contain optional arguments for the requested action. The arguments accepted depend on the requested action to be issued. See the PARMSAQ description in page 141 for the complete list of valid values.

3. Use the APPL_NAME column to limit the action requests selected by a specific product name (OGMVS or OMSMS).

4. Use the CLIENTAQ column to limit the action requests retrieved by a specific user ID or address space ID (ASID).

VUINSERT

VUINSERT inserts a row with the following columns:

Notes:

1. You must replace values for ACTNAMEAQ, OBJECTAQ, PARMSAQ, CLIENTAQ, and DATETIMEAQ columns by calling VUSUBST() in this order before calling VUOPEN(). Failure to substitute values before executing the request causes VUOPEN to issue a non-zero return code.

2. The ACTNAMEAQ column must specify a valid action name as described in the ACTREQTAB table.

3. The OBJECTAQ column must specify a DASD volume serial number (for DASD volume actions) or a dataset name (for dataset actions).

4. You can specify values for the optional PARMSAQ column depending on the action name specified in the ACTNAMEAQ column. See the PARMSAQ description in page 141 for the complete list of valid values.

5. The CLIENTAQ column must be filled with a unique user ID or address space ID associated with the action requester. You can use this value later to query this VU Template in order to determine the status of requested actions.

6. If there is a blank value for the DATETIMEAQ column, the action is executed immediately. You can specify a date and time value consistent with the format described in the ACTREQTAB table for the DATETIMEAQ column to indicate when the action to be executed some time in the future.

ACTNAMEAQ OBJECTAQ PARMSAQ CLIENTAQ DATETIMEAQ APPL_NAME

VU Templates 109

Invalid formatting of this column results in a VUINSERT error. The action inserted into this table is checkpointed to a VSAM dataset by the CMS address space. Thus, actions scheduled in the future will be restored if the CMS address space is shut down and restarted.

7. The APPL_NAME column will always be OGMVS for the submitting application name.8. The results of the action request are retained by the ACTRESPTAB table until you delete

the action request row. You can retrieve responses by issuing a query on the DF.ACTIONRESP VU template or by using the OMEGAMON II for SMS services status displays.

VUDELETE

VUDELETE deletes a specific action request row.

Default criteria

Selects a row with a specific request key value (KEYAQ).

Notes:

1. You must replace the substitution symbol for the KEYAQ column by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Issue a query on the ACTIONREQ VU Template to find the KEYAQ value for a specific action request.

DF.ACTIONRESPDF.ACTIONRESP lists the responses to a completed action request.

The data is derived from base table OMSMS.ACTRESPTAB (see page 147).

VUQUERY


Notes:

1. You must replace the substitution symbol for the KEYAQ column by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Issue a query on the ACTIONREQ VU Template to find the KEYAQ value for a specific action request.

DF.ACTIVEJOBDF.ACTIVEJOB lists all active address spaces and their I/O rates.

The data is derived from base table OMSMS.JOB (see page 186).

TEXTAR


VUQUERY


Default criteria

Selects all rows.

DF.CACHECUDF.CACHECU lists control and performance data on all cache control units.

The data is derived, and includes all columns, from base table OMSMS.CACHE_CU (see page 149).

VUQUERY


Default criteria

Selects all rows.

Notes:

1. Select specific control units by the SD_ID or the SSID columns. 2. Select a group of control units by adding the CU_MODEL as a search criteria.3. You must query the CACHEENV VU Template to verify that the elapsed time of data

collection is long enough for an acceptable reading of performance data.

ASID IO_RATE NAME

ACTIVE_CNT CACH_STAT DFW_HIT_P NVS_CONF READ_PCT TRK_DEST_RBYP_CACH_P CFW_READ_P DFW_RETRY NVS_PINNED SD_ID WRIT_HIT_PCACH_AVAIL CFW_WRIT_P INACT_CNT NVS_STAT SSIDCACH_CONF CU_MODEL INH_CACH_P READ_HIT_P TIMEOUT_CT

VU Templates 111

DF.CACHEDETAILDF.CACHEDETAIL provides detailed cache performance for any cached DASD volumes.

The data is derived, and includes all columns, from base table OMSMS.CACHE_DET (see page 151).

VUQUERY


Default criteria

Selects all rows.

Notes:

1. Select a specific DASD volume by specifying the VOLSER column in the search criteria.2. Select specific volumes by the SD_ID, SD_ID2, or the SSID columns. 3. Select a group of volumes by adding the CU_MODEL as a search criteria.4. You must query the CACHEENV VU Template to verify that the elapsed time of data


BYP_CACH_1 DC_SQST_T DUALC_DEV RD_SQ2_HP VOLSER WR_NORM2_RBYP_CACH_2 DEV_NUM INH_CACH_1 RD_SQ2_HR WR_CFW_HP WR_SEQ_HPCACH_STAT DFW_NM_HP INH_CACH_2 RD_TOT_HP WR_CFW_HR WR_SEQ_HRCACH_STAT2 DFW_NM_HR PINNED_ST RD_TOT_HR WR_ESC_HR WR_SEQL1_PCD_NMDS_R DFW_RETRY RD_CFW_HP RD_TOT1_HP WR_ESC_HR WR_SEQL1_RCD_NMDS_T DFW_SQ_HP RD_CFW_HR RD_TOT1_HR WR_NM1_HP WR_SEQL2_PCU_MODEL DFW_SQ_HR RD_NM1_HP RD_TOT2_HP WR_NM1_HR WR_SEQL2_RDC_NMST_R DFW_STAT RD_NM1_HR RD_TOT2_HR WR_NM2_HP WR_TOT_HPDC_NMST_T DFW_TOT_HP RD_NM2_HP READ_PCT WR_NM2_HR WR_TOT_HRDC_NOPR_R DFW_TOT_HR RD_NM2_HR SD_ID_1 WR_NORM1_PDC_NOPR_T DUALC_ST2 RD_SQ1_HP SD_ID_2 WR_NORM1_R


DF.CACHEDEVICEDF.CACHEDEVICE provides an abridgement of the data provided by the DF.CACHEDETAIL VU Template.

The data is derived, and includes all columns, from base table OMSMS.CACHE_DEV (see page 156).

VUQUERY


Default criteria

Selects all rows.

Notes:

1. Select a specific DASD volume by specifying the VOLSER column in the search criteria.2. Select specific volumes by the SD_ID, SD_ID2, or the SSID columns. 3. Select a group of volumes by adding the CU_MODEL as a search criteria.4. You must query the CACHEENV VU Template to verify that the elapsed time of data


DF.CACHEENVDF.CACHEENV lists the current cache collection elapsed time and collection interval.

The data is derived from base table OMSMS.CACHE_ENV (see page 158).

VUQUERY


Default criteria

Selects all rows.

BYP_CACH_1 CU_MODEL DFW_TOT_HP RD_TOT_HP SSIDBYP_CACH_2 DEV_NUM INH_CACH_1 READ_PCT VOLSERCACH_STAT DFW_RETRY INH_CACH_2 SD_ID_1 WR_CFW_HPCACH_STAT2 DFW_STAT RD_CFW_HP SD_ID_2 WR_TOT_HP

ELAPSED INTRVL_LEN

VU Templates 113

DF.CHANNELPATHDF.CHANNELPATH lists channel path status and performance information.

The data is derived, and includes all columns, from base table OMSMS.CHAN_PATH (see page 159).

VUQUERY


Default criteria

Selects all rows.

Note: Select a specific channel path or group of channel paths by specifying the CHPID1 column in the search criteria.

DF.DASDDF.DASD lists DASD volume configuration, control, status, and performance information.

The data is derived, and includes all columns, from base table OMSMS.DASD (see page 161).

VUQUERY


BUSY_PCT CHPID3 CHPID6 DIOC_STAT SHARE_STAT TYPECHPID1 CHPID4 CHPID7 LPAR_BUSY SMSVOL_CNTCHPID2 CHPID5 CHPID8 NONSMS_CNT STATUS

AV_OPENDCB CHPON_CNT DIOR_STATE IOSQ PENDING TOT_FREEBUSY_PCT CHPON_FLAG DIRBSY_DLY LCU_NUMBER RESV_PCT TRK_CAPCHPID_CNT CHPON_MASK DISCONNECT LFREE_AREA SGNAME_LEN TRK_P_CYLCHPID1 CONN_PCT FRAG_IDX LFREE_CYL SMS_CONVFG UCB_ADDRCHPID2 CONNECT FREE_CYL LFREE_TRK SMS_LRGFRE UCB_FL1CHPID3 CU_MODEL FREE_DSCB MOUNT_STAT SMS_STAT_A UCB_STATCHPID4 CUBBSY_DLY FREE_EXT MSR SMS_STATUS VOLSERCHPID5 DEV_MODEL FREE_PCT MVS_STAT_A SMS_TOTCAP VTOC_TYPECHPID6 DEV_NUM FREE_TRK MVS_STATUS SMS_TOTFRE


Default criteria

Selects all rows.

Notes:

1. Select specific DASD volumes by specifying the VOLSER or DEV_NUM column in the search criteria.

2. Select a group of DASD volumes by adding various columns in the search criteria, for example, DEV_MODEL, STGRP_NAME, SMS_STATUS, MVS_STATUS, and so on.

3. Use performance and capacity data in the search criteria to select DASD volume data by service criteria.

4. You must query the RMFENV VU Template to verify that the elapsed time of data collection is long enough for an acceptable reading of performance data.

DF.DASDCACHEDF.DASDCACHE lists DASD volume data and cache performance data for all online DASD volumes. The VU Template combines data from multiple base tables to return data about DASD configuration, performance, and cache performance simultaneously.

The data is derived, and includes all columns, from base tables OMSMS.DASD (see page 161) and OMSMS.CACHE_DEV (see page 156), except for the CACHE_DEV.VOLSER, CACHE_DEV.CU_MODEL, and CACHE_DEV.DEV_NUM columns.

VUQUERY


DASD: AV_OPENDCB CHPON_CNT DIOR_STATE IOSQ PENDING TOT_FREEBUSY_PCT CHPON_FLAG DIRBSY_DLY LCU_NUMBER RESV_PCT TRK_CAPCHPID_CNT CHPON_MASK DISCONNECT LFREE_AREA SGNAME_LEN TRK_P_CYLCHPID1 CONN_PCT FRAG_IDX LFREE_CYL SMS_CONVFG UCB_ADDRCHPID2 CONNECT FREE_CYL LFREE_TRK SMS_LRGFRE UCB_FL1CHPID3 CU_MODEL FREE_DSCB MOUNT_STAT SMS_STAT_A UCB_STATCHPID4 CUBBSY_DLY FREE_EXT MSR SMS_STATUS VOLSERCHPID5 DEV_MODEL FREE_PCT MVS_STAT_A SMS_TOTCAP VTOC_TYPECHPID6 DEV_NUM FREE_TRK MVS_STATUS SMS_TOTFRECHPID7 DEV_TYPE FREE_VIR NUM_CYLS STGRP_NAMECHPID8 DEVBSY_DLY IO_RATE OPEN_DCBS TOT_CAPAC CACHE_DEV:

VU Templates 115

Default criteria

Selects all rows.

Notes:

1. Use the search criteria argument of the VUQUERY function to limit the rows returned by the query.

2. You must query the RMFENV and CACHEENV VU Template to verify that the elapsed time of data collection is long enough for an acceptable reading of performance data.

DF.DASDCACHEBYJOBNAMEDF.DASDCACHEBYJOBNAME lists DASD volume data and cache performance data for all DASD volumes being accessed by a specific address space. The VU Template combines data from multiple base tables to return data about DASD configuration, performance, and cache performance simultaneously.

The data is derived, and includes all columns, from base tables OMSMS.APPL (see page 148), OMSMS.DASD (see page 161), and OMSMS.CACHE_DEV (see page 156), except for the CACHE_DEV.VOLSER, CACHE_DEV.CU_MODEL, and CACHE_DEV.DEV_NUM columns. APPL.ASID is the only column included from the OMSMS.APPL base table.

VUQUERY


APPL: ASID DASD: AV_OPENDCB CHPON_CNT DIOR_STATE IOSQ PENDING TOT_FREEBUSY_PCT CHPON_FLAG DIRBSY_DLY LCU_NUMBER RESV_PCT TRK_CAPCHPID_CNT CHPON_MASK DISCONNECT LFREE_AREA SGNAME_LEN TRK_P_CYLCHPID1 CONN_PCT FRAG_IDX LFREE_CYL SMS_CONVFG UCB_ADDRCHPID2 CONNECT FREE_CYL LFREE_TRK SMS_LRGFRE UCB_FL1CHPID3 CU_MODEL FREE_DSCB MOUNT_STAT SMS_STAT_A UCB_STATCHPID4 CUBBSY_DLY FREE_EXT MSR SMS_STATUS VOLSERCHPID5 DEV_MODEL FREE_PCT MVS_STAT_A SMS_TOTCAP VTOC_TYPECHPID6 DEV_NUM FREE_TRK MVS_STATUS SMS_TOTFRECHPID7 DEV_TYPE FREE_VIR NUM_CYLS STGRP_NAMECHPID8 DEVBSY_DLY IO_RATE OPEN_DCBS TOT_CAPAC CACHE_DEV:


Notes:

1. You must substitute an 8-byte value for the JOBNAME of the address space by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.



DF.DASDCACHEDETAILDF.DASDCACHEDETAIL lists DASD volume data and detailed cache performance data for all online DASD volumes. The VU Template combines data from multiple base tables to return data about DASD configuration, performance, and cache performance simultaneously.

The data is derived, and includes all columns, from base tables OMSMS.DASD (see page 161) and OMSMS.CACHE_DET (see page 151), except for the CACHE_DET.VOLSER, CACHE_DET.CU_MODEL, and CACHE_DET.DEV_NUM columns.

VUQUERY


DASD: AV_OPENDCB CHPON_CNT DIOR_STATE IOSQ PENDING TOT_FREEBUSY_PCT CHPON_FLAG DIRBSY_DLY LCU_NUMBER RESV_PCT TRK_CAPCHPID_CNT CHPON_MASK DISCONNECT LFREE_AREA SGNAME_LEN TRK_P_CYLCHPID1 CONN_PCT FRAG_IDX LFREE_CYL SMS_CONVFG UCB_ADDRCHPID2 CONNECT FREE_CYL LFREE_TRK SMS_LRGFRE UCB_FL1CHPID3 CU_MODEL FREE_DSCB MOUNT_STAT SMS_STAT_A UCB_STATCHPID4 CUBBSY_DLY FREE_EXT MSR SMS_STATUS VOLSERCHPID5 DEV_MODEL FREE_PCT MVS_STAT_A SMS_TOTCAP VTOC_TYPECHPID6 DEV_NUM FREE_TRK MVS_STATUS SMS_TOTFRECHPID7 DEV_TYPE FREE_VIR NUM_CYLS STGRP_NAMECHPID8 DEVBSY_DLY IO_RATE OPEN_DCBS TOT_CAPAC CACHE_DET: BYP_CACH_1 DFW_NM_HP INH_CACH_2 RD_TOT_HP WR_ESC_HR WR_SEQL1_PBYP_CACH_2 DFW_NM_HR PINNED_ST RD_TOT_HR WR_ESC_HR WR_SEQL1_RCACH_STAT DFW_RETRY RD_CFW_HP RD_TOT1_H WR_NM1_HP WR_SEQL2_PCACH_STAT2 DFW_SQ_HP RD_CFW_HR RD_TOT1_H WR_NM1_HR WR_SEQL2_RCD_NMDS_R DFW_SQ_HR RD_NM1_HP RD_TOT2_H WR_NM2_HP WR_TOT_HPCD_NMDS_T DFW_STAT RD_NM1_HR RD_TOT2_H WR_NM2_HR WR_TOT_HRDC_NMST_R DFW_TOT_HP RD_NM2_HP READ_PCT WR_NORM1_P

VU Templates 117

Notes:

1. Select specific DASD volumes by specifying the VOLSER or DEV_NUM column in the search criteria.

2. Select a group of DASD volumes by adding various columns in the search criteria, for example, DEV_MODEL, STGRP_NAME, SMS_STATUS, MVS_STATUS, and so on.

3. Use performance and capacity data in the search criteria to select DASD volume data by service criteria.



DF.DASDUSERDF.DASDUSER lists all address spaces accessing a specific DASD volume.

The data is derived from base table OMSMS.DASD_USERS (see page 165).

VUQUERY


Note: You must substitute a 6-byte value for VOLSER by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

DF.DSBYASIDDF.DSBYASID lists all datasets being accessed by a specific address space, given its address space ID.

The data is derived from base table OMSMS.APPL (see page 148).

VUQUERY


Note: You must substitute an integer value for the ASID of the address space by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

ASID DDNAME DSNAME JOBNAME OPEN_COUNT

DSNAME JOBNAME VOLSER


DF.DSBYDSNAMEDF.DSBYDSNAME lists detailed information for all cataloged datasets, given the name of the dataset.

The data is derived, and includes all columns, from base table OMSMS.DSNS (see page 171).

VUQUERY


Notes:

1. You must substitute a 44-byte value for DSNAME by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Information about cataloged datasets is returned. Specify the VOLSER column in the search criteria to obtain information about an uncataloged dataset.

DF.DSBYJOBNAMEDF.DSBYJOBNAME lists all datasets being accessed by a specific address space, given its JOBNAME.

The data is derived from base table OMSMS.APPL (see page 148).

VUQUERY


Note: You must substitute an 8-byte value for the JOBNAME of the address space by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

BLKSIZE EXTENT2 EXTENT9 EXTENT16 REF_DATE TRKS_USEDCRE_DATE EXTENT3 EXTENT10 KEY_DISP SECALC_FLG VOL_COUNTDSNAME EXTENT4 EXTENT11 KEY_LENGTH SECALC_SIZ VOL_EXTSDSORG EXTENT5 EXTENT12 LRECL SMS_FLAGS VOL_SEQEXP_DATE EXTENT6 EXTENT13 NUM_EXTS SPCEXT_FLG VOLSEREXT_17_255 EXTENT7 EXTENT14 PCT_USED SPCEXT_VALEXTENT1 EXTENT8 EXTENT15 RECFM TRKS_ALLOC

ASID DSNAME VOLSER

VU Templates 119

DF.DSBYVOLUMEDF.DSBYVOLUME lists detailed information for all datasets and a specific DASD volume, given the volume serial number of the volume.

The data is derived, and includes all columns, from base table OMSMS.DSNS (see page 171).

VUQUERY


Notes:

1. You must substitute a 6-byte value for VOLSER by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Information about cataloged datasets is returned. Specify the VOLSER column in the search criteria to obtain information about an uncataloged dataset.

DF.DSENQDF.DSENQ lists dataset performance information, given the volume serial number of a specific DASD volume.

The data is derived, and includes all columns, from base table OMSMS.DSN_ENQS (see page 166).

VUQUERY


Note: You must substitute a 44-byte value for DSNAME by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

BLKSIZE EXTENT2 EXTENT9 EXTENT16 REF_DATE TRKS_USEDCRE_DATE EXTENT3 EXTENT10 KEY_DISP SECALC_FLG VOL_COUNTDSNAME EXTENT4 EXTENT11 KEY_LENGTH SECALC_SIZ VOL_EXTSDSORG EXTENT5 EXTENT12 LRECL SMS_FLAGS VOL_SEQEXP_DATE EXTENT6 EXTENT13 NUM_EXTS SPCEXT_FLG VOLSEREXT_17_255 EXTENT7 EXTENT14 PCT_USED SPCEXT_VAL

ENQ_STATUS ENQ_TYPE JOB_TYPE JOBNAME SYSTEM


DF.DSIOBYDSNAMEDF.DSIOBYDSNAME lists dataset performance information, given a specific dataset name.

The data is derived, and includes all columns, from base table OMSMS.DSN_IO_ST (see page 167).

VUQUERY



AVG_IOSQ ELG_C_WRIT IO_RATE PENDING SEQ_RD_HIT VOLSERBYP_C_CNT ELG_C_READ IO_SERVICE RAW_CONN SEQ_READS WRIT_H_CNTBYP_CACH_P ELG_CACH_P JOB_ASID RAW_DISC SEQ_WR_HIT WRIT_HIT_PCONNECT INH_C_CNT JOB_START RAW_PEND SEQ_WRITESDEV_NUM INH_CACH_P JOBNAME RD_WRT_P SEQL_IO_PDISCONNECT IO_COUNT NON_C_READ READ_H_CNT TOT_HIT_P

VU Templates 121

DF.DSIOBYJOBNAMEDF.DSIOBYJOBNAME lists dataset performance information, given the job name of a specific address space.


VUQUERY


Note: You must substitute an 8-byte value for the JOBNAME of the address space by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

DF.DSIOBYVOLUMEDF.DSIOBYVOLUME lists dataset performance information, given the volume serial number of a specific DASD volume.


VUQUERY


Note: You must substitute a 6-byte value for VOLSER by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.




DF.DSLOCDF.DSLOC lists device and volume serial number for a specific dataset, given the name of the dataset.

The data is derived, and includes all columns, from base table OMSMS.DSN_LOC (see page 169).

VUQUERY



DF.DSSMSDF.DSSMS lists SMS classes assigned to a specific dataset.

The data is derived, and includes all columns, from base table OMSMS.DSN_SMS (see page 170).

VUQUERY


Note: You must substitute a value for DSNAME by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

DF.HSMCDSDF.HSMCDS lists space utilization of HSM control datasets.

The data is derived, and includes all columns, from base table OMSMS.HSM_CDS (see page 175).

VUQUERY


Default criteria

Selects all rows.

DEV_NUM VOLSER

DATA_CLASS DS_TYPE MAN_CLASS SMS_STAT ST_CLASS

CDS_TYPE NUM_EXTS PCT_FULL SECEXT_BYT TOTEXT_BYTFREE_BYTES PCT_FREE PRIEXT_BYT SPACE_THR

VU Templates 123

DF.HSMDSRVDF.HSMDSRV lists information about HSM recovery versions for a specific dataset.

The data is derived, and includes all columns, from base table OMSMS.HSM_DS_RV (see page 176).

VUQUERY



DF.HSMFUNDADF.HSMFUNDA lists processing statistics for major HSM functions within the current HSM processing interval.

The data is derived, and includes all columns, from base table OMSMS.HSM_FUN_DA (see page 177).

VUQUERY


Default criteria

Selects all rows.

BKUP_DATE, BKUP_TIME, CAT_STATUS, GENERATION, VERSION

AUTO_REQS BYTS_WRITE FUNC_TYPE GIGS_WRITE TRKS_WRITEBYTS_READ FAIL_REQS GIGS_READ TRKS_READ USER_REQS


DF.HSMFUNSTDF.HSMFUNST lists hold status and activity status for major HSM functions.

The data is derived, and includes all columns, from base table OMSMS.HSM_FUN_ST (see page 178).

VUQUERY


Default criteria

Selects all rows.

DF.HSMREQDF.HSMREQ lists HSM requests being processed and queued for processing.

The data is derived, and includes all columns, from base table OMSMS.HSM_REQS (see page 180).

VUQUERY


Default criteria

Selects all rows.

VUDELETE

VUDELETE deletes a specific HSM request given a request number (REQ_NUM).

Notes:

1. You must substitute an integer value for REQ_NUM by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Retrieve the list of outstanding requests with associated REQ_NUM values by issuing a VUQUERY on this template.

AG_BACK_ST AUDIT_ACTF EXPIRBV_ST MIGRATE_ST RECYCLE_ST TP_RCOV_STAG_RECV_ST AUDIT_ST JRNL_BU_FG OCDS_BU_FG REPORT_ST TP_REPL_STAU_BACK_ST BACKUP_ST LIST_ACTF RECALL_ST REPRT_ACTFAU_DUMP_ST BCDS_BU_FG LIST_ST RECOVER_ST TP_COPY_STAU_MIG_ST DUMP_ST MCDS_BU_FG RECYC_ACTF TP_RCAL_ST

REQ_ABCC REQ_DSNAME REQ_NUM REQ_STATUS REQ_VOLSERREQ_AGNAME REQ_FLAG1 REQ_RC REQ_TIME SUBPOOLREQ_DATE REQ_JOBN REQ_REASON REQ_TYPE WAIT_TYPE

VU Templates 125

DF.HSMSTATUSDF.HSMSTATUS lists general information about the status and activity of HSM within the current HSM processing interval.

The data is derived, and includes all columns, from base table OMSMS.HSM_STATUS (see page 182).

VUQUERY


Default criteria

Selects all rows.

DF.HSMSTORAGEDF.HSMSTORAGE lists storage utilization information for the HSM address space.

The data is derived, and includes all columns, from base table OMSMS.HSM_STOR (see page 184).

VUQUERY


Default criteria

Selects all rows.

EXPBV_EKEY HSM_ASID INTVL_ABND INTVL_STIM VOL_BKUPS VOL_MIGSEXPBV_SKEY HSM_STIM INTVL_CPUT TP_BUV_RCY VOL_DMP_FL VOL_RESTSHSM_ACTIVE HSM_VERS INTVL_REQS TP_ML2_RCY VOL_DUMPS VOL_RST_FL

CS_ACT_L ESTOR_FMCT HIGH_UIC3 LOW_UIC3 UIC2_FMCTCS_INACT_L FIXED_FMCT HIGH_UIC4 LOW_UIC4 UIC3_FMCTCS_MAX HIGH_UIC1 LOW_UIC1 REAL_FMCT UIC4_FMCTCS_USED HIGH_UIC2 LOW_UIC2 UIC1_FMCT


DF.LCUDF.LCU lists logical control unit configuration and performance data.

The data is derived, and includes all columns, from base table OMSMS.LCU (see page 187).

VUQUERY


Note: You must query the RMFENV VU Template to verify that the elapsed time of data collection is long enough for an acceptable reading of performance data.

DF.LCUIORATEDF.LCUIORATE lists LCU performance and configuration data along with the total I/O rate for all DASD volumes attached to the LCU.

The data is derived, and includes all columns, from base table OMSMS.LCU (see page 187). IO_RATE is derived from the DASD.IO_RATE column of the DASD base table (see page 161). The total IO_RATE column is a computed value created by summing the individual IO_RATE columns of all DASD volumes attached to each LCU. The computed value is named IO_RATE.

VUQUERY


Note: You must substitute an integer value for NUMBER by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

ALL_CP_BSY CHPID2 CHPID6 CHPID2_DAT CHPID6_DAT NUMBERAVG_DELAYQ CHPID3 CHPID7 CHPID3_DAT CHPID7_DAT PCT_CUBUSYCHPID_CNT CHPID4 CHPID8 CHPID4_DAT CHPID8_DAT PCT_DEFERCHPID1 CHPID5 CHPID1_DAT CHPID5_DAT CONT_RATE PCT_DEVBSY

LCU: ALL_CP_BSY CHPID2 CHPID6 CHPID2_DAT CHPID6_DAT NUMBERAVG_DELAYQ CHPID3 CHPID7 CHPID3_DAT CHPID7_DAT PCT_CUBUSYCHPID_CNT CHPID4 CHPID8 CHPID4_DAT CHPID8_DAT PCT_DEFERCHPID1 CHPID5 CHPID1_DAT CHPID5_DAT CONT_RATE PCT_DEVBSY DASD:

VU Templates 127

DF.RMFENVDF.RMFENV lists the status, collection elapsed time, and collection interval of the RMF environment for the currently active system.

The data is derived, and includes all columns, from base table OMSMS.RMF_ENV (see page 189).

VUQUERY


Default criteria

Selects all rows.

CYCLE_TIME INT_ELAP INT_LENGTH INT_START RMF_LEVEL STATUS


DF.SMSCONFIGDF.SMSCONFIG lists SMS base configuration data.

The data is derived, and includes all columns, from base table OMSMS.SMS_CONFIG (see page 190).

VUQUERY


Default criteria

Selects all rows.

DF.SMSDATACLASSDF.SMSDATACLASS lists information about all SMS data classes.

The data is derived, and includes all columns, from base table OMSMS.SMS_DAT_CL (see page 191).

VUQUERY


Default criteria

Selects all rows.

Note: Information about all data classes is returned by the query. Use the NAME column to limit returned information for a specific data class.

CUR_SYS DFT_TRKCYL DFT_UNIT LUPD_TIME SYS_ARRAYDFT_MCNAME DFT_TRKSIZ LUPD_DATE LUPD_USER

ALLOC_UNIT CI_SIZE INDEX_OPT LUPD_DATE NAME RETN_DAYSAVGREC_SCL DIR_BLOCKS KEY_LENGTH LUPD_TIME PRIM_SPACE SEC_SPACECA_FREE EXPDT_DAY KEY_OFFSET LUPD_USER RECFM X_REG_SHARCI_FREE EXPDT_YEAR LRECL MAX_VOLS RECORG X_SYS_SHAR

VU Templates 129

DF.SMSDSBYDSNAMEDF.SMSDSBYDSNAME lists detailed information for a SMS managed dataset, given the name of the dataset.

The data is derived, and includes all columns, from base tables OMSMS.DSNS (see page 171) and OMSMS.DSN_SMS (see page 170), except DSN_SMS.DSNAME.

VUQUERY


Notes:

1. You must substitute a 44-byte value for DSNAME by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Only information about cataloged SMS managed datasets is returned.

DSNS: BLKSIZE EXTENT2 EXTENT9 EXTENT16 REF_DATE TRKS_USEDCRE_DATE EXTENT3 EXTENT10 KEY_DISP SECALC_FLG VOL_COUNTDSNAME EXTENT4 EXTENT11 KEY_LENGTH SECALC_SIZ VOL_EXTSDSORG EXTENT5 EXTENT12 LRECL SMS_FLAGS VOL_SEQEXP_DATE EXTENT6 EXTENT13 NUM_EXTS SPCEXT_FLG VOLSEREXT_17_255 EXTENT7 EXTENT14 PCT_USED SPCEXT_VALEXTENT1 EXTENT8 EXTENT15 RECFM TRKS_ALLOC DSN_SMS:


DF.SMSDSBYVOLUMEDF.SMSDSBYVOLUME lists detailed information for a SMS managed dataset, given the name of the DASD volume serial number.

The data is derived, and includes all columns, from base tables OMSMS.DSNS (see page 171) and OMSMS.DSN_SMS (see page 170), except DSN_SMS.DSNAME.

VUQUERY


Notes:

1. You must substitute a 6-byte value for VOLSER by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Only information about cataloged SMS managed datasets is returned.

DSNS: BLKSIZE EXTENT2 EXTENT9 EXTENT16 REF_DATE TRKS_USEDCRE_DATE EXTENT3 EXTENT10 KEY_DISP SECALC_FLG VOL_COUNTDSNAME EXTENT4 EXTENT11 KEY_LENGTH SECALC_SIZ VOL_EXTSDSORG EXTENT5 EXTENT12 LRECL SMS_FLAGS VOL_SEQEXP_DATE EXTENT6 EXTENT13 NUM_EXTS SPCEXT_FLG VOLSEREXT_17_255 EXTENT7 EXTENT14 PCT_USED SPCEXT_VALEXTENT1 EXTENT8 EXTENT15 RECFM TRKS_ALLOC DSN_SMS:

VU Templates 131

DF.SMSDSIOBYJOBNAMEDF.SMSDSIOBYJOBNAME allows comparison of dataset I/O statistics with SMS storage class objectives for datasets being accessed by a specific address space.

The data is derived, and includes all columns, from base tables OMSMS.DSN_IO_ST (see page 167) and OMSMS.SMS_ST_CL (see page 195). Substitution symbol data is derived from base table OMSMS.DSN_SMS (see page 170).

VUQUERY


Notes:

1. You must substitute an 8-byte value for the JOBNAME of the address space by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Use the JOB_ASID column in the search criteria to select a specific address space.3. Use the DSNAME column in the search criteria to select a specific dataset.

DSN_IO_ST: AVG_IOSQ ELG_C_WRIT IO_RATE PENDING SEQ_RD_HIT VOLSERBYP_C_CNT ELG_C_READ IO_SERVICE RAW_CONN SEQ_READS WRIT_H_CNTBYP_CACH_P ELG_CACH_P JOB_ASID RAW_DISC SEQ_WR_HIT WRIT_HIT_PCONNECT INH_C_CNT JOB_START RAW_PEND SEQ_WRITESDEV_NUM INH_CACH_P JOBNAME RD_WRT_P SEQL_IO_PDISCONNECT IO_COUNT NON_C_READ READ_H_CNT TOT_HIT_PDSNAME IO_ERRORS NON_C_WRIT READ_HIT_P TOTAL_MSR SMS_ST_CL:


DF.SMSDSIOBYVOLUMEDF.SMSDSIOBYVOLUME allows comparison of dataset I/O statistics with SMS storage class objectives for all datasets on a specific SMS managed DASD volume.

The data is derived, and includes all columns, from base tables OMSMS.DSN_IO_ST (see page 167) and OMSMS.SMS_ST_CL (see page 195). Substitution symbol data is derived from base table OMSMS.DSN_SMS (see page 170).

VUQUERY


Notes:

1. You must substitute a 6-byte value for the VOLSER of an SMS controlled DASD volume by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

2. Use the JOB_ASID column in the search criteria to select a specific address space.3. Use the DSNAME column in the search criteria to select a specific dataset.

DSN_IO_ST: AVG_IOSQAD ELG_C_READ IO_RATE PENDING SEQ_RD_HIT VOLSERBYP_C_CNT ELG_C_WRIT IO_SERVICE RAW_CONN SEQ_READS WRIT_H_CNTBYP_CACH_P ELG_CACH_P JOB_ASID RAW_DISC SEQ_WR_HIT WRIT_HIT_PCONNECT INH_C_CNT JOB_START RAW_PEND SEQ_WRITESDEV_NUM INH_CACH_P JOBNAME RD_WRT_P SEQL_IO_PDISCONNECT IO_COUNT NON_C_READ READ_H_CNT TOT_HIT_PDSNAME IO_ERRORS NON_C_WRIT READ_HIT_P TOTAL_MSR SMS_ST_CL:

VU Templates 133

DF.SMSMANAGEMENTCLASSDF.SMSMANAGEMENTCLASS lists information about all SMS data classes.

The data is derived, and includes all columns, from base table OMSMS.SMS_MAN_CL (see page 193).

VUQUERY


Default criteria

Selects all rows.

Note: Information about all management classes is returned by the query. Use the NAME column to limit returned information for a specific management class.

DF.SMSSTORAGECLASSDF.SMSSTORAGECLASS lists information about all SMS storage classes.

The data is derived, and includes all columns, from base table OMSMS.SMS_ST_CL (see page 195).

VUQUERY


Default criteria

Selects all rows.

Note: Information about all storage classes is returned by the query. Use the NAME column to limit returned information for a specific storage class.

AUTOBACKUP BKUP_FREQ EXP_CDAYS GDGS_PRIM MIN_D_LEV1 RETN_LIMITAUTOMIGRAT BKUP_VDSDL EXP_CDDAY LUPD_DATE MIN_D_PRIM ROLL_GDS_ABKRET_ONLY BKUP_VERS EXP_CDYEAR LUPD_TIME NAMEBKRET_XTRA CMD_BACKUP EXP_NONUSE LUPD_USER PART_REL

AVAIL DIR_MSR_OB GUAR_SYNCH LUPD_TIME NAME SEQ_MSR_OBDIR_BIAS GUAR_SPACE LUPD_DATE LUPD_USER SEQ_BIAS


DF.SMSSTORAGEGROUPDF.SMSSTORAGEGROUP lists information about all SMS storage groups.

The data is derived, and includes all columns, from base table OMSMS.SMS_ST_GRP (see page 196).

VUQUERY


Default criteria

Selects all rows.

Note: Information about all storage groups is returned by the query. Use the NAME column to limit returned information for a specific storage group.

DF.SYSTEMENVDF.SYSTEMENV lists MVS and DF/P system environment information.

The data is derived, and includes all columns, from base table OMSMS.SYSTEM_ENV (see page 198).

VUQUERY


Default criteria

Selects all rows.

AUTO_BKUP AUTO_MIGR HI_THRESH LUPD_USER TYPEAUTO_BSYS AUTO_MSYS LO_THRESH NAME VIO_MAXAUTO_DSYS BKUP_FREQ LUPD_DATE ST_ARRAY VIO_UTYPEAUTO_DUMP DUMP_CLASS LUPD_TIME STATUS VOLSER_IDX

DFP_LEVEL IEAIPS_SFX IPL_DATE IPL_TIME MODE SMF_IDIEAICS_SFX IEAOPT_SFX IPL_DEVICE IPL_VOLSER MVS_LEVEL SMS_STATUS

VU Templates 135

DF.VOLUMEBYJOBNAMEDF.VOLUMEBYJOBNAME lists all DASD volumes being accessed by a specific active address space.

The data is derived from base table OMSMS.APPL (see page page 148).

VUQUERY


Note: You must substitute an 8-byte value for JOBNAME by calling VUSUBST() before calling VUOPEN(). Failure to substitute values before executing the request results in an error status from the VUOPEN() function.

ASID DSN_COUNT VOLSER

OMEGAMON II for SMS Base Tables 137


IntroductionThis appendix contains, in alphabetical order, the OMEGAMON II for SMS base tables currently defined in the CMS catalog.

Note: The full name of each base table begins with the high-level qualifier, OMSMS. Thus the full name of table ACTEFTRTAB is OMSMS.ACTEFTRTAB, and so on.

Appendix ContentsACTEFTRTAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139ACTREQTAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141ACTRESPTAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147APPL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148CACHE_CU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149CACHE_DET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151CACHE_DEV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156CACHE_ENV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158CHAN_PATH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159DASD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161DASD_USERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165DSN_ENQS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166DSN_IO_ST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167DSN_LOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169DSN_SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170DSNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171HSM_CDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175HSM_DS_RV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176HSM_FUN_DA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177HSM_FUN_ST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178HSM_REQS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180HSM_STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182HSM_STOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

B


JOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186LCU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187RMF_ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189SMS_CONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190SMS_DAT_CL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191SMS_MAN_CL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193SMS_ST_CL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195SMS_ST_GRP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196SYSTEM_ENV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198


ACTEFTRTAB

ACTEFTRTAB

DefinitionThe Action Effector Table lists all action effector routines that can be executed for various classes of objects. It is a read-only table. ACTEFTRTAB provides a catalog of available action effector routines and data for validation of insert operations into the ACTREQTAB table (ActionAQ column validation).

DescriptionThe following columns are provided.

Column NameColumn Data

Type Description

ACTDESCAE VARCHAR32 Description of action performed by the action effector. Current valid values are:n Backup Datasetn Convert Volume to SMS Formatn Copy/Move Datasetn Incremental Backup of Volumen Migrate Datasetn Migrate Datasets on Volumen Prepare Volume for SMSn Recall Datasetn Release Unused Space in Datasetn Release Unused Space on Volumen Recover Datasetn Set DASD Caching Optionsn Test SMS Volume ConversionValues in this column are case-sensitive.

ACTEFTRTAB


ACTIONAE CHAR8 Action Request Name. Current values are:n KDFXRBKD Backup Datasetsn KDFXRCAV Set DASD Volume Caching Optionsn KDFXRSCV Convert Volume to SMS Formatn KDFXRCYD Copy/Move a Datasetn KDFXRIBV Incremental Backup of Volumen KDFXRMGD Migrate a Datasetn KDFXRMGV Migrate Datasets Volumen KDFXRSPV Prepare Volume for SMSn KDFXRRCD Recall Datasetn KDFXRRVD Recover a Dataset from Backupn KDFXRRLD Release Unused Space in Datasetn KDFXRRLV Release Unused Space on Volumen KDFXRSTV Test SMS Volume Conversion

ACTNAMEAE VARCHAR16 Long name for Action Effector. Current values are:n BackupDSn ConvertVOLn CopyDSn IncBackupVOLn MigrateDSn MigrateVOLn PrepareVOLn RecallDSn RecoverDSn ReleaseSpaceDSn ReleaseSpaceVOLn SetCacheVOLn TestConvertVOLValues in this column are case-sensitive.

OBJCLASSAE VARCHAR16 Type of object to which this action effector applies. Current valid values are:n DASD Volumen DatasetValues in this column are case-sensitive.

SPACEAE VARCHAR64 Specifies primary and secondary allocation parameters for the dynamic allocation.


Type Description


ACTREQTAB

ACTREQTAB

DefinitionThe Action Request Table enables any Candle Management Server application to become an action client by allowing insert, delete, and select operations. Each action request is represented as a row in the Action Request table. Each row in the table remains in the table until a client explicitly deletes the row.

The Action Effector Table lists all action effector routines that can be executed for various classes of objects. It is a read-only table. ACTREQTAB provides a catalog of available action effector routines and data for validation of insert operations into the ACTREQTAB table (ActionAQ column validation).

DescriptionThe following columns are provided.


Type Description

ACTDESCAQ VARCHAR32 Description of action to be taken (for example, RECALL DATASET, or MIGRATE DATASETS ON VOLUME). This value is copied from the ACTDESCAE column of ACTEFTRTAB during the insert operation by the the inserter probe component and is ignored if specified in an insert statement.

ACTIONAQ CHAR8 Action Effector Name. This is the foreign key to ACTEFTRTAB. This value is copied from THE ACTEFTRTAB column ACTIONAE during the insert operation by the the inserter probe component and is ignored if specified in an insert statement.

ACTNAMEAQ VARCHAR16 Long name of action effector (for example, RECALLDS, or MIGRATEVOL). This value must be specified during an insert operation.

Note: Values inserted into this column are case-sensitive and must match the ACTNAMEAE column in a row of the ACTEFTRTAB table. If not, a return code is issued.

APPL_NAME CHAR8 Application name issuing the action request. This is the foreign key to SYSAPPLS. The SYSAPPLS table is a CMS system defined table containing the list of all probe-owning applications defined in the CMS catalog. This value is optional during an insert operation. It defaults to null and can include mixed-case and binary text. Use this column in select statements to limit action request queries to those inserted by a specific client application.

ACTREQTAB


CLIENTAQ VARCHAR255 Unique application instance originating the request. This value is optional during an insert operation. It defaults to null. Use this column in select statements to limit action request queries to those inserted by a specific user ID and session address. If specified, the user ID and session address information can also be used to audit and log action requests.

COMPTIMEAQ CHAR19 Time stamp specifying the date and time when the action request completed execution. The time stamp is a character string in YYYY-MM-DD-HH.MM.SS format:

YYYY 4-digit year

MM 2-digit month number of the year (01-12)

DD 2-digit day number of the month (01-31)

HH 2-digit hour of the day (00-23)

MM 2-digit minute of the hour (00-59)

SS 2-digit second of the minute (00-59)

All time values are assumed to be local time (not GMT).

This column will contain N/A if the associated action has not yet completed execution (that is, StATUSAQ contains AWAITING EXECUTION or EXECUTING) or if the action completion was not checkpointed (that is, STATUSAQ contains NOT STARTED DUE TO SHUTDOWN or COMPLETION IN DOUBT).

DATETIMEAQ CHAR19 Time stamp specifying the date and time when the action must be executed. This value is optional during an insert operation. It defaults to the current time if a value is not specified. The timestamp is a character string in YYYY-MM-DD-HH.MM.SS format:

YYYY 4-digit year

MM 2-digit month number of the year (01-12)

DD 2-digit day number of the month (01-31)

HH 2-digit hour of the day (00-23)

MM 2-digit minute of the hour (00-59)

SS 2-digit second of the minute (00-59)

All time values are assumed to be local time (not GMT).

The value must be greater than the current time and less than 365 days into the future.


Type Description


ACTREQTAB

DSNAMEAQ CHAR64 Name of the action response dataset containing the response text for this action when it completes. This value is automatically updated by the inserter probe component during the insert operation and is ignored if specified on an insert statement. A null value in this column indicates that the responses for this action have been consolidated into the checkpoint dataset.

KEYAQ INTEGER4 Action request ID. This is the primary key. This value is automatically generated by the action probes after a successful insert operation into the Action Request Table. The range of values is 1 to 4,294,967,295. If a value is specified during an insert operation, the value will be ignored. Zero cannot be used because it is reserved as the key of the administration record in the action probes checkpoint dataset.

OBJCLASSAQ VARCHAR16 Class of object. Current valid values are:n Datasetn DASD VolumeThis value is copied from ACTEFTRTAB column OBJCLASSAE during an insert operation by the inserter probe component and is ignored if specified in an insert statement.

OBJECTAQ VARCHAR255 Action object. This is the volume serial number if it is a volume action or the dataset name if it is a dataset action. This value is required during an insert operation.


Type Description

ACTREQTAB


PARMSAQ VARCHAR255 Optional action parameters. Formats for both KEYWORD and KEYWORD(value) parameters are accepted. Valid values depend on the ACTNAMEAQ value. This value is optional during an insert operation and defaults to null if no value is provided.

Valid values accepted by the PARMSAQ column depend on the action requested (as specified in the ACTNAMEAQ column). The parameters are:

BackupDS Backup dataset. See the discussion of the BACKDS command in IBM’s DFSMShsm Storage Administration Reference.

ConvertVOL

Convert volume to SMS format. See the discussion of the CONVERTV SMS control statement in IBM’s DFSMSdss Storage Administration Reference.

CopyDS Copy or move dataset. See the discussion of the COPY DATASET control statement in IBM’s DFSMSdss Storage Administration Reference.

IncBackupVOL

Incremental backup of volume. See the discussion of the BACKVOL INCREMENTAL command in IBM’s DFSMShsm Storage Administration Reference.

MigrateDS Migrate dataset. See the discussion of the MIGRATE DATASETNAME command in IBM’s DFSMShsm Storage Administration Reference.

MigrateVOL

Migrate datasets on volume. See the discussion of the MIGRATE VOLUME command in IBM’s DFSMShsm Storage Administration Reference.

PrepareVOL

Prepare volume for SMS. See the discussion of the CONVERTV PREPARE control statement in IBM’s DFSMSdss Storage Administration Reference.

RecallDS Recall dataset. See the discussion of the RECALL command in IBM’s DFSMShsm Storage Administration Reference.


Type Description


ACTREQTAB

PARMSAQ (continued)

VARCHAR255 RecoverDS Recover dataset from backup. See the discussion of the RECOVER command in IBM’s DFSMShsm Storage Administration Reference.

ReleaseSpaceDS

Release unused space in dataset. See the discussion of the RELEASE control statement

in IBM’s DFSMSdss Storage Administration Reference.

ReleaseSpaceVOL

Release unused space on volume. See the discussion of the RELEASE control statement in IBM’s DFSMSdss Storage Administration Reference.

SetCacheVOL

Set DASD caching options. For 3880 storage control, see the discussion of the SETCACHE control statement in IBM’s Cache Device Administration. For 3990 storage control, see the discussion of the SETCACHE control statement in IBM’s 3990 Planning, Installation, and Storage Administration Guide.

TestConvertVOL

Test SMS volume conversion. See the discussion of the CONVERTV SMS TEST control statement in IBM’s DFSMSdss Storage Administration Reference.

RESPCNTAQ INTEGER4 An integer value specifying the number of response lines received when the action request completes. Zero indicates that no lines have yet been received for the action. This value is automatically updated by the inserter probe component during the insert operation and is ignored if specified on an insert statement.


Type Description

ACTREQTAB


RETCODEAQ INTEGER4 Integer code return by the service provider. This value is set by the action effector when an action request completes. It is automatically updated by the inserter probe component after completion of the requested action and is ignored if specified in an insert statement.

The STATUSAQ column indicates a request completion with either of the following values:n Completed successfullyn Completed non-zero rcThe action probes for this base table do not impose a specific meaning to the return code value. The meaning of the return code depends on the action effector called to satisfy the action service request. By convention, the meanings are:

0 Normally indicates that the request has been completed sucessfully.

Positive return codes (non-zero)

Set by the action effector. Examine the name of the action effector and the possible return codes returned by it to determine the exact meaning of the value.

Negative return codes

Indicate that the invocation of the action effector failed. Messages for problem determination accompanying the error can be found in the SYSTSPRT or TLVLOG files allocated to the CMS address space or in the MVS system log.

STATUSAQ VARCHAR32 Current action request status. Valid values include:n Awaiting executionn Executingn Completed successfullyn Completed non-zero rcn Not started due to shutdownn Completion in doubtThis value is automatically updated by the inserter probe component as the requested action completes and is ignored if specified in an insert statement.


Type Description


ACTRESPTAB

ACTRESPTAB

DefinitionThe Action Response Table contains the response text for action requests that have completed, either successfully or unsuccessfully. It is a read-only table. If you delete a row from ACTREQTAB, you simultaneously delete from ACTRESPTAB all responses associated with the action request.

DescriptionThe following columns are provided:


Type Description

CCHARAR CHAR1 Carriage control character generated by the service provider. This is the TEXTAR action response text. The column may be null for some service providers.

KEYAR INTEGER4 Action Request ID. This is the foreign key to ACTREQTAB table. It is non-unique in this table.

TEXTAR VARCHAR132 Action response text.

APPL


APPL

DefinitionAPPL provides application monitoring data. One row per dataset or volser per job is available. If the DSNAME column is included in the request, 1 row per dataset per job is available and the VOLSER column provides the first volser for that dataset. If the VOLSER column is not included in the request, 1 row per volser per job is available.



Type Description

ASID INTEGER2 Address space ID for job; 2-byte hexadecimal; optional index column.

DSN_COUNT INTEGER2 Number of datasets in use by job; numeric short.

DSNAME CHAR44 Name of dataset; character length 44.

JOBNAME CHAR8 Name of job; character length 8; required index column.

VOL_COUNT INTEGER2 Number of volumes in use by job; numeric short.

VOLSER CHAR6 Volume serial; character length 6.


CACHE_CU

CACHE_CU

DefinitionCACHE_CU provides information about cache control units. There is 1 row available for each control unit identified by the SSID or SD_ID_1/2 columns. The information originates from cache information services.



Type Description

ACTIVE_CNT INTEGER2 Number of devices with caching active; numeric short.

BYP_CACH_P INTEGER4 Total bypass cache percentage for all devices on control unit; numeric long to 1/10th percent.

CACH_AVAIL INTEGER4 Amount of available cache; numeric long.

CACH_CONF INTEGER4 Amount of configured cache; numeric long.

CACH_STAT INTEGER4 Status of cache; numeric long (see “CACHE_DET” on page 151)

CFW_READ_P INTEGER4 Total cache fast-write read percentage for all devices on control unit; numeric long to 1/10th percent.

CFW_WRIT_P INTEGER4 Total cache fast-write percentage for all devices on control unit; numeric long to 1/10th percent.

CU_MODEL INTEGER4 Control unit type/model; numeric long:

1 3880-13

2 3880-23

3 3990-3

4 3990-6

DFW_HIT_P INTEGER4 Total DFW hit percentage for all devices on control unit; numeric long to 1/10th percent.

DFW_RETRY INTEGER4 Total DFW retry percentage for all devices on control unit; numeric long to 1/10th percent.

INACT_CNT INTEGER2 Number of devices with caching inactive; numeric short.

INH_CACH_P INTEGER4 Total inhibit cache percentage for all devices on control unit; numeric long to 1/10th percent.

NVS_CONF INTEGER4 Amount of configured nonvolatile storage (3990-3); numeric long.

NVS_PINNED INTEGER4 Amount of pinned nonvolatile storage (3990-3); numeric long.

NVS_STAT INTEGER4 Nonvolatile storage status (3990-3); numeric long.

CACHE_CU


READ_HIT_P INTEGER4 Total cache read hit percentage for all devices on control unit; numeric long to 1/10th percent.

READ_PCT INTEGER4 Total read percentage for all devices on control unit; numeric long to 1/10th percent.

SD_ID INTEGER2 Storage director identification (not 3990); 1-byte hexadecimal.

SSID INTEGER2 Subsystem identification (3990-3); 2-byte hexadecimal.

TIMEOUT_CT INTEGER4 Number of devices that timed out so that device statistics were not obtained (not known if active or inactive); numeric short.

TRK_DEST_R INTEGER4 Total track destage rate per second for all devices on control unit; numeric long to 1/10th unit.

WRIT_HIT_P INTEGER4 Total cache write hit percentage for all devices on control unit; numeric long to 1/10th percent.


Type Description


CACHE_DET

CACHE_DET

DefinitionCACHE_DET provides detailed information about cache devices. One row is available for each device identified by the VOLSER (or DEV_NUM) column. For numeric fields:

The information comes from cache information services.


-1 Data is not applicable (n/a) for the given device.

-2 Data is not currently computable due to a denominator of 0.


Type Description

BYP_CACH_1 INTEGER4 Bypass cache operation percentage (3990-3 and 3880-nn first storage director only); numeric long to 1/10th percent.

BYP_CACH_2 INTEGER4 Bypass cache operation percentage (3880-nn second storage director only); numeric long to 1/10th percent.

CACH_STAT INTEGER4 Status of cache; numeric long:

1 Caching active

2 Caching inactive

3 Device pending cache active

4 Device pending cache inactive

5 Device timed out - cache data values invalid

CACH_STAT2 INTEGER4 Status of cache for second storage director (3880-nn only); numeric long:

1 Caching active

2 Caching inactive




CD_NMDS_R INTEGER4 Cache to DASD normal destages of tracks rate per second (3990 only); numeric long to 1/10th unit.

CD_NMDS_T INTEGER4 Cache to DASD normal destages of tracks total (3990 only); numeric long.

CACHE_DET



1 3880-13

2 3880-23

3 3990-3

4 3990-6

DC_NMST_R INTEGER4 DASD to cache normal stages of tracks rate per second (3990 only); numeric long to 1/10th unit.

DC_NMST_T INTEGER4 DASD to cache normal stages of tracks total (3990 only); numeric long.

DC_NOPR_R INTEGER4 Rate per second of number of operations where track promotion did not occur because of lack of free segments in cache (3990 only); numeric long to 1/10th unit.

DC_NOPR_T INTEGER4 Number of operations where track promotion did not occur because of lack of free segments in cache (3990 only); numeric long.

DC_SQST_R INTEGER4 DASD to cache sequential stages of tracks rate per second (3990 only); numeric long to 1/10th unit.

DC_SQST_T INTEGER4 DASD to cache sequential stages of tracks total (3990 only); numeric long.

DEV_NUM INTEGER2 Device number; 2-byte hexadecimal.

DFW_NM_HP INTEGER4 DASD fast-write normal-write hit percentage (3990-3 only); numeric long to 1/10th percent.

DFW_NM_HR INTEGER4 DASD fast-write normal-write rate per second (3990-3 only); numeric long to 1/10th unit.

DFW_RETRY INTEGER4 DASD fast-write retry percentage; numeric long to 1/10th percent.

DFW_SQ_HP INTEGER4 DASD fast-write sequential write hit percentage (3990-3 only); numeric long to 1/10th percent.

DFW_SQ_HR INTEGER4 DASD fast-write sequential write rate per second (3990- only); numeric long to 1/10th unit.

DFW_STAT INTEGER4 Status of DASD fast-write (3990-3 only); numeric long:

1 DFW active

2 DFW inactive

DFW_TOT_HP INTEGER4 DASD fast-write total hit percentage (3990-3 only); numeric long to 1/10th percent.

DFW_TOT_HR INTEGER4 DASD fast-write total hit rate per second (3990-3 only); numeric long to 1/10th unit.


Type Description


CACHE_DET

DUALC_ST2 INTEGER4 Dual copy status; numeric long:

-1 n/a

1 Dual copy available

2 Dual copy pending

3 Dual copy suspended, no mapping to primary

4 Dual copy suspended, mapping to primary

DUALC_STAT INTEGER4 Dual copy status; numeric long:

-1 n/a

1 Dual copy primary volume

2 Dual copy secondary volume

DUALC_DEV INTEGER2 Dual copy device number; 2-byte hexadecimal or, if not applicable, X’FFFF’.

INH_CACH_1 INTEGER4 Inhibit cache operation percentage (3990-3 and 3880-nn first storage director only); numeric long to 1/10th percent.

INH_CACH_2 INTEGER4 Inhibit cache operation percentage (3880-nn second storage director only); numeric long to 1/10th percent.

PINNED_ST INTEGER4 Pinned status; numeric long:

-1 n/a

1 no device pinned data

2 device has pinned data, DASDFW not suspended

3 device has pinned data, DASDFW suspended

RD_CFW_HP INTEGER4 Cache fast-write read hit percentage (3990-3 only); numeric long to 1/10th percent.

RD_CFW_HR INTEGER4 Cache fast-write read hit rate per second (3990-3 only); numeric long to 1/10th unit.

RD_NM1_HP INTEGER4 Normal read hit percentage (3990-3 or first 3880-nn storage director); numeric long to 1/10th percent.

RD_NM1_HR INTEGER4 Normal read hit rate per second (3990-3 or first 3880-nn storage director); numeric long to 1/10th unit.

RD_NM2_HP INTEGER4 Normal read hit percentage (second 3880-nn storage director only); numeric long to 1/10th percent.

RD_NM2_HR INTEGER4 Normal read hit rate per second (second 3880-nn storage director only); numeric long to 1/10th unit.

RD_SQ1_HP INTEGER4 Sequential read hit percentage (3990-3 or first 3880-nn storage director); numeric long to 1/10th percent.

RD_SQ1_HR INTEGER4 Sequential read hit rate per second (3990-3 or first 3880-nn storage director); numeric long to 1/10th unit.


Type Description

CACHE_DET


RD_SQ2_HP INTEGER4 Sequential read hit percentage (second 3880-nn storage director only); numeric long to 1/10th percent.

RD_SQ2_HR INTEGER4 Sequential read hit rate per second (second 3880-nn storage director only); numeric long to 1/10th unit.

RD_TOT_HP INTEGER4 Total cache read hit percentage; numeric long to 1/10th percent.

RD_TOT_HR INTEGER4 Total cache read hit rate per second; numeric long to 1/10th unit.

RD_TOT1_HP INTEGER4 Total cache read hit percentage; numeric long to 1/10th per cent (3990-3 or first 3880-nn storage director).

RD_TOT1_HR INTEGER4 Total cache read hit rate per second; numeric long to 1/10th unit (3990- 3 or first 3880-nn storage director).

RD_TOT2_HP INTEGER4 Total cache read hit percentage; numeric long to 1/10th per cent (second 3880- nn storage director only).

RD_TOT2_HR INTEGER4 Total cache read hit rate per second; numeric long to 1/10th unit (second 3880-nn storage director only).

READ_PCT INTEGER4 Read to write percentage; numeric long to 1/10th percent.

SD_ID_1 INTEGER2 Storage director ID (first; not 3990-3); 1-byte hexadecimal.

SD_ID_2 INTEGER2 Storage director ID (second; not 3990-3); 1-byte hexadecimal.

SSID INTEGER4 Subsystem ID (3990-3); 2-byte hexadecimal.

VOLSER CHAR6 Volume serial for device; character length 6. This column can be used as an index.

WR_CFW_HP INTEGER4 Cache fast-write write hit percentage (3990-3 only); numeric long to 1/10th percent.

WR_CFW_HR INTEGER4 Cache fast-write write hit rate per second (3990-3 only); numeric long to 1/10th unit.

WR_ESC_HP INTEGER4 Write hit percentage of requests received on ESCON™ port (3990 only); numeric long to 1/10th percent.

WR_ESC_HR INTEGER4 Write hit rate per second of requests received on ESCON port (3990 only); numeric long to 1/10th unit.

WR_NM1_HP INTEGER4 Normal-write hit percentage (3990-3 or first 3880-13 storage director); numeric long to 1/10th percent.

WR_NM1_HR INTEGER4 Normal-write hit rate per second (3990-3 or first 3880-13 storage director); numeric long to 1/10th unit.

WR_NM2_HP INTEGER4 Normal-write hit percentage (second 3880-13 storage director only); numeric long to 1/10th percent.

WR_NM2_HR INTEGER4 Normal-write hit rate per second (3880-13 second storage director only); numeric long to 1/10th unit.

WR_NORM1_P INTEGER4 Normal-write operations percentage (3880-23 first storage director only); numeric long to 1/10th percent.


Type Description


CACHE_DET

WR_NORM1_R INTEGER4 Normal-write operations rate per second (3880-23 first storage director only); numeric long to 1/10th unit.

WR_NORM2_P INTEGER4 Normal-write operations percentage (3880-23 second storage director only); numeric long to 1/10th percent.

WR_NORM2_R INTEGER4 Normal-write operations rate per second (3880-23 second storage director only);

WR_SEQ_HP INTEGER4 Sequential-write hit percentage (3990-3 only); numeric long to 1/10th percent.

WR_SEQ_HR INTEGER4 Sequential-write hit rate per second (3990-3 only); numeric long to 1/10th unit.

WR_SEQL1_P INTEGER4 Sequential-write operations percentage (3880-23 first storage director only); numeric long to 1/10th percent.

WR_SEQL1_R INTEGER4 Sequential-write operations rate per second (3880-23 first storage director only); numeric long to 1/10th unit.

WR_SEQL2_P INTEGER4 Sequential-write operations percentage (3880-23 second storage director only); numeric long to 1/10th percent.

WR_SEQL2_R INTEGER4 Sequential-write operations rate per second (3880-23 second storage director only); numeric long to 1/10th unit.

WR_TOT_HP INTEGER4 Total write hit percentage (3990-3 and 3880-13 only); numeric long to 1/10th percent.

WR_TOT_HR INTEGER4 Total write hit rate per second (3990-3 and 3880-13 only); numeric long to 1/10th unit.


Type Description

CACHE_DEV


CACHE_DEV

DefinitionCACHE_DEV provides an abridgement of the detailed information presented by the CACHE_DET table. One row is available for each device identified by the VOLSER (or DEV_NUM) column. For numeric fields:

The information comes from cache information services.


-1 Data is not applicable (n/a) for the given device.

-2 Data is not currently computable due to a denominator of 0.


Type Description

BYP_CACH_1 INTEGER4 Bypass cache operation percentage (3990-3 and 3880-nn first storage director only); numeric long to 1/10th percent.

BYP_CACH_2 INTEGER4 Bypass cache operation percentage (3880-nn second storage director only); numeric long to 1/10th percent.

CACH_STAT INTEGER4 Status of cache; numeric long:

1 Caching active

2 Caching inactive




CACH_STAT2 INTEGER4 Status of cache for second storage director (3880-nn only); numeric long:

1 Caching active

2 Caching inactive





1 3880-13

2 3880-23

3 3990-3

4 3990-6


CACHE_DEV

DEV_NUM INTEGER2 Device number; 2-byte hexadecimal.

DFW_RETRY INTEGER4 DASD fast-write retry percentage; numeric long to 1/10th percent.

DFW_STAT INTEGER4 Status of DASD fast-write (3990-3 only); numeric long:

1 DFW active

2 DFW inactive

DFW_TOT_HP INTEGER4 DASD fast-write total hit percentage (3990-3 only); numeric long to 1/10th percent.

INH_CACH_1 INTEGER4 Inhibit cache operation percentage (3990-3 and 3880-nn first storage director only); numeric long to 1/10th percent.

INH_CACH_2 INTEGER4 Inhibit cache operation percentage (3880-nn second storage director only); numeric long to 1/10th percent.

RD_CFW_HP INTEGER4 Cache fast-write read hit percentage (3990-3 only); numeric long to 1/10th percent.

RD_TOT_HP INTEGER4 Total cache read hit percentage; numeric long to 1/10th percent.

READ_PCT INTEGER4 Read to write percentage; numeric long to 1/10th percent.

SD_ID_1 INTEGER2 Storage director ID (first; not 3990-3); 1-byte hexadecimal.

SD_ID_2 INTEGER2 Storage director ID (second; not 3990-3); 1-byte hexadecimal.

SSID INTEGER4 Subsystem ID (3990-3); 2-byte hexadecimal.

VOLSER CHAR6 Volume serial for device; character length 6. This column can be used as an index.

WR_CFW_HP INTEGER4 Cache fast-write write hit percentage (3990-3 only); numeric long to 1/10th percent.

WR_TOT_HP INTEGER4 Total write hit percentage (3990-3 and 3880-13 only); numeric long to 1/10th percent.


Type Description

CACHE_ENV


CACHE_ENV

DefinitionCACHE_ENV provides information about the cache data collection environment, including the collection interval for display at the top of cache device panels. Only one row is available. The information comes from cache information services.



Type Description

ELAPSED INTEGER4 The time elapsed in current interval; numeric double, store clock format of time.

INTRVL_LEN INTEGER4 The collection or refresh interval for data; numeric long, 100ths of second format of time.


CHAN_PATH

CHAN_PATH

DefinitionCHAN_PATH provides information about channel paths. One row is available for each channel path identified by the CHPID column. The information comes from the RMF and SRM.



Type Description

BUSY_PCT INTEGER4 Percent channel path is busy; numeric long to 1/10th of percent. For MVS/ESA™ 4.3.0 and above (LPAR mode), this percent is for the whole complex.

CHPID1 thru CHPID8

INTEGER2 Channel path ID; 1-byte hexadecimal.

DIOC_STAT BITSTRING1 Dynamic I/O Configuration status; 1-byte indicator:

0 Data not available or no status

1 Added

2 Deleted

3 Modified

LPAR_BUSY INTEGER4 Percent channel path is busy for current LPAR, if in LPAR mode; if not, for the whole system (see “SYSTEM_ENV” on page 198 for mode); numeric long to 1/10th of percent.

This value comes from CPMF. If it is unavailable, the value is -1. The value is valid for MVS/ESA 4.3.0 and above.

NONSMS_CNT INTEGER4 Count of non-SMS volumes on channel path; numeric long.

SHARE_STAT BITSTRING1 Channel path share status; 1-byte indicator:

0 Not shared

1 Shared

255 Data not available (CPMF)

SMSVOL_CNT INTEGER4 Count of SMS volumes on channel path; numeric long.

STATUS BITSTRING1 Status of channel path; 1-byte indicator:

0 Invalid

1 Online

2 Offline

3 Vary activity

CHAN_PATH


TYPE BITSTRING1 Type of channel path; 1-byte indicator:

0 Unknown

1 Block

2 Byte

3 ES-DIR

4 ES-CHN

5 ES-CNV

6 RMF undetermined (in OMEGAMON for MVS this shows as a blank).

7 CTC.


Type Description


DASD

DASD

DefinitionDASD provides information about DASD devices. One row is available for each device identified by the VOLSER column (or by UCB_ADDR or DEV_NUM). The information originates from the UCB, SMS construct access services, LSPACE, and RMF.



Type Description

AV_OPENDCB INTEGER4 Average number of open DCBs for the volume in the RMF interval to 1 decimal place.

BUSY_PCT INTEGER4 Percent device is busy; numeric long (% * 10).

CHPID_CNT INTEGER2 Number of installed channel paths for the device; 2-byte numeric. Identifies how many of the CHPIDn entries are valid. Invalid entries are set to X’FFFF’.

CHPID1 thru CHPID8

INTEGER2 ID of installed channel path for the device; 2-byte hexadecimal.

CHPON_CNT INTEGER2 Number of online channel paths for the device; 2-byte numeric.

CHPON_FLAG BITSTRING1 Flag to indicate whether or not all installed channel paths are online; 1-byte hex:

0 All installed paths are online.

1 One or more installed paths are offline.

CHPON_MASK BITSTRING1 Mask byte indicating which of the installed channel paths are online; for example, X’F0’ indicates that CHPID1, CHPID2, CHPID3, and CHPID4 are online.

CONN_PCT INTEGER4 Percent device connected; numeric long (% * 10).

CONNECT INTEGER4 Connect time; numeric long (ms * 10).

CU_MODEL BITSTRING1 Control unit type DASD is attached to; 1-byte indicator:

X’04’ 3880-23

X’11’ 3990-1

X’05’ 3990-2

X’06’ 3990-3

X’15’ 3990-6

X’00’ Unknown

CUBBSY_DLY INTEGER4 Average control unit busy delay; numeric long (ms * 10)

DASD


DEV_MODEL BITSTRING1 Model type for DASD; 1-byte indicator:

X’14’ 3380-A

X’1C’ 3380-D

X’1B’ 3380-E

X’21’ 3380-J

X’23’ 3380-K

X’26’ 3390-1

X’27’ 3390-2

X’24’ 3390-3

X’32’ 3390-9

X’00’ Unknown

DEV_NUM INTEGER2 System address device number; 2-byte hexadecimal.

DEV_TYPE BITSTRING1 Type of DASD device; 1-byte indicator:

X’0E’ 3380

X’0F’ 3390

DEVBSY_DLY INTEGER4 Average device busy delay; numeric long (ms * 10).

DIOR_STATE BITSTRING1 Dynamic I/O reconfiguration state:

80 Pinned

40 Pin status unknown

03 Installation static

02 Dynamic

01 Static

DIRBSY_DLY INTEGER4 Average director post busy delay; numeric long (ms * 10).

DISCONNECT INTEGER4 Disconnect time; numeric long (ms * 10).

FRAG_IDX INTEGER4 Fragmentation index; numeric long.

FREE_CYL INTEGER4 Number of free cylinders; numeric long.

FREE_DSCB INTEGER4 Number of free DSCBs; numeric long.

FREE_EXT INTEGER4 Number of free extents; numeric long.

FREE_PCT INTEGER4 Percent of free space; numeric long (% * 10).

FREE_TRK INTEGER4 Number of free tracks (excluding free cylinders); numeric long.

FREE_VIR INTEGER4 Number of free VIRs; numeric long.

IO_RATE INTEGER4 I/O rate per second; numeric long (s * 10).

IOSQ INTEGER4 IOSQ time; numeric long (ms * 10).


Type Description


DASD

LCU_NUMBER INTEGER2 LCU number to which the device is attached; 2-bytes hexadecimal.

LFREE_AREA INTEGER4 Largest free area in megabytes; numeric long.

LFREE_CYL INTEGER4 Largest free area in cylinders; numeric long.

LFREE_TRK INTEGER4 Largest free area in tracks (excluding largest free cylinders); numeric long.

MOUNT_STAT BITSTRING1 Mount status for device; 1-byte indicator:

1 Private

2 Public

3 Storage

MSR INTEGER4 Total response time in milliseconds; numeric long (ms * 10).

MVS_STAT_A CHAR8 MVS status array for all SMS systems. Array of eight 1-byte indicators:

1 Online

2 Offline

3 Pending offline

4 Boxed

5 Not ready

MVS_STATUS BITSTRING1 Status with respect to MVS system currently running; 1-byte indicator:

1 Online

2 Offline

3 Pending offline

4 Boxed

5 Not ready

NUM_CYLS INTEGER4 Number of physical cylinders on the device.

OPEN_DCBS INTEGER2 Number of open DCBs; numeric long.

PENDING INTEGER4 Pending time; numeric long (ms * 10).

RESV_PCT INTEGER4 Percent reserved; numeric long (% * 10).

SGNAME_LEN INTEGER2 Length of STGRP_NAME for this device (significant length).

SMS_CONVFG BITSTRING1 SMS volume conversion status:

00 Volume not converted

01 Volume in SMS initial status

02 Volume converted to SMS

SMS_LRGFRE INTEGER4 Largest free extent in megabytes as seen by SMS.


Type Description

DASD


SMS_STAT_A CHAR8 SMS status array for all SMS systems. Array of eight 1-byte indicators:

1 Online

2 Offline

3 Pending offline

4 Boxed

5 Not ready

SMS_STATUS BITSTRING1 Status with respect to SMS for the system currently running; 1-byte indicator:

0 Notcon

1 Enable

2 Quiall

3 Quinew

4 Disall

5 Disnew

SMS_TOTCAP INTEGER4 Total capacity in megabytes as seen by SMS; numeric long.

SMS_TOTFRE INTEGER4 Free space in megabytes as seen by SMS; numeric long.

STGRP_NAME CHAR30 SMS storage group name or NON-SMS PRIVATE/PUBLIB/STORAGE; maximum character length 30.

TOT_CAPAC INTEGER4 Total capacity in megabytes; numeric long.

TOT_FREE INTEGER4 Total free space in megabytes; numeric long.

TRK_CAP INTEGER4 Track capacity for the device in bytes.

TRK_P_CYL INTEGER4 Number of tracks per cylinder for the device.

UCB_ADDR BITSTRING4 Address of the UCB for the DASD device; 4-byte hexadecimal address.

UCB_FL1 BITSTRING1 Flag byte UCBFL1 from the UCB for this device.

UCB_STAT BITSTRING1 Flag byte UCBSTAT from the UCB for this device.

VOLSER CHAR6 Volume name for DASD device; character length 6.

VTOC_TYPE BITSTRING1 VTOC index indicator;

FF VTOC is not indexed.

00 VTOC status could not be obtained.

01 VTOC index enabled.

02 VTOC index disabled.


Type Description


DASD_USERS

DASD_USERS

DefinitionDASD_USERS provides information about users of a given DASD volume. One row is available for each dataset, ddname, and jobname in use on the given volume. Therefore, there are multiple rows per job, giving each ddname/dataset name combination in use on the volume for each job.



Type Description

ASID INTEGER2 Address space ID for job; 2-byte hexadecimal.

DDNAME CHAR8 Name of DD statement; character length 8.

DSNAME CHAR44 Name of dataset; character length 44.

JOBNAME CHAR8 Name of job using device; character length 8.

OPEN_COUNT INTEGER2 Number of times dataset is open; numeric short:

0 Dataset is not open.

1 or more Dataset is open.

DSN_ENQS


DSN_ENQS

DefinitionDSN_ENQS provides information about users of a given dataset. One row is available for each jobname and system using the dataset.



Type Description

ENQ_STATUS BITSTRING1 Status of enqueue; 1-byte indicator:

0 Waiting

1 Owner

ENQ_TYPE BITSTRING1 Type of enqueue; 1-byte indicator:

0 Exclusive

1 Shared

JOB_TYPE BITSTRING1 Type of job; 1-byte indicator:

0 Unknown due to different system

1 Batch

2 STC

3 TSO

4 Mount

5 Not dequeued (job gone)

JOBNAME CHAR8 Name of job using dataset; character length 8.

SYSTEM CHAR8 Name of system on which enqueue was issued; character length 8.


DSN_IO_ST

DSN_IO_ST

DefinitionDSN_IO_ST provides information about dataset I/O statistics. One row is available for each dataset and jobname that matches the input criteria.

When multiple rows for a dataset are returned, a summary row is provided at the end of that set of rows (with the jobname, ALL JOBS).



Type Description

AVG_IOSQ INTEGER4 Average IOSQ time; numeric long (ms * 10).

BYP_C_CNT INTEGER4 Number of bypass cache I/Os within interval; numeric long.

BYP_CACH_P INTEGER4 Bypass cache percent; numeric long (% * 10).

CONNECT INTEGER4 Average connect time; numeric long (ms * 10).

DEV_NUM INTEGER2 Device number for which dataset information is obtained; 2-byte hexadecimal.

DISCONNECT INTEGER4 Average disconnect time; numeric long (ms * 10).

DSNAME CHAR44 The name of dataset; character length 44.

ELG_C_WRIT INTEGER4 Number of write I/Os eligible to use cache.

ELG_C_READ INTEGER4 Number of read I/Os eligible to use cache.

ELG_CACH_P INTEGER4 Percent of I/Os that were cache eligible; numeric long (% * 10).

INH_C_CNT INTEGER4 Number of I/Os that requested that cache use be inhibited; numeric long.

INH_CACH_P INTEGER4 Percent of I/Os that inhibited cache use; numeric long (% * 10).

IO_COUNT INTEGER4 Total number of I/Os; numeric long.

IO_ERRORS INTEGER4 Number of I/O errors; numeric long

IO_RATE INTEGER4 Number of I/Os per second; numeric long (s * 10).

IO_SERVICE INTEGER4 Average I/O service time (DISC+CONN+PEND); numeric long(ms * 10).

JOB_ASID INTEGER2 ASID of job using dataset; numeric short.

JOB_START DOUBLE8 Start time of job using dataset; 8-byte STCK format of time.

JOBNAME CHAR8 Name of job using dataset; character length 8.

DSN_IO_ST


NON_C_READ INTEGER4 Number of read I/Os that were not eligible to use cache; numeric long.

NON_C_WRIT INTEGER4 Number of write I/Os that were not eligible to use cache; numeric long.

PENDING INTEGER4 Average pending time; numeric long (ms * 10).

RAW_CONN INTEGER4 Accumulated connect time for all I/Os in microsecs/128.

RAW_DISC INTEGER4 Accumulated disconnect time for all I/Os in microsecs/128.

RAW_PEND INTEGER4 Accumulated pending time for all I/Os in microsecs/128.

RD_WRT_P INTEGER4 Read to write percentage (% of total I/Os that were read); numeric long (% * 10).

READ_H_CNT INTEGER4 Number of cache read hits.

READ_HIT_P INTEGER4 Read cache hit percent; numeric long (% * 10).

SEQ_RD_HIT INTEGER4 Sequential read hit percent; numeric long(% * 10).

SEQ_READS INTEGER4 Number of sequential read I/Os.

SEQ_WR_HIT INTEGER4 Sequential write hit percent; numeric long (% * 10).

SEQ_WRITES INTEGER4 Number of sequential write I/Os.

SEQL_IO_P INTEGER4 Sequential I/O percent; numeric long (% * 10).

TOT_HIT_P INTEGER4 Total cache hit percent; numeric long (% * 10).

TOTAL_MSR INTEGER4 Average response time for dataset; numeric long (ms * 10).

VOLSER CHAR6 Volser for which dataset information is obtained; character length 6.

WRIT_H_CNT INTEGER4 Number of cache write hits.

WRIT_HIT_P INTEGER4 Write cache hit percent; numeric long (% * 10).


Type Description


DSN_LOC

DSN_LOC

DefinitionDSN_LOC provides the cataloged volsers for a given dataset. One row is available for each volser in the catalog. For most purposes, presentation code only uses the first volser.



Type Description

DEV_NUM INTEGER2 Device number for volser; 2-byte hexadecimal.

VOLSER CHAR6 Volume serial; character length 6.

DSN_SMS


DSN_SMS

DefinitionDSN_SMS provides SMS information for a given dataset. One row is available for the dataset.



Type Description

DATA_CLASS CHAR30 Data class name for dataset; character length 30.

DS_TYPE INTEGER4 Type of dataset; numeric long:

1 PDSE

0 Other

DSNAME CHAR44 Name of dataset; character length 44; index column.

MAN_CLASS CHAR30 Management class name for dataset; character length 30.

SMS_STAT BITSTRING1 Dataset controlled or not controlled by SMS; 1-byte indicator:

0 No

1 Yes

ST_CLASS CHAR30 Storage class name for dataset; character length 30.


DSNS

DSNS

DefinitionDSNS provides dataset DSCB and space information for one of the following:

n all datasets on a volume

n a specific dataset on a specific volume

n each occurrence of a specific cataloged dataset on 1 or more (multiple) volumes

One row is available for each dataset on a given volume. When you request a multivolume dataset without specifying a volume, a row is available for each occurrence of that dataset.


Column Name

Column Data Type Description

BLKSIZE INTEGER2 Block size value for dataset or CISIZE for a VSAM component; 2-byte integer value.

CRE_DATE BITSTRING3 Creation date; 3-byte hexadecimal. The format is X’YYDDDD’.

DSNAME CHAR44 Name of dataset; character length 44 bytes.

DSORG BITSTRING2 Dataset organization; 2-bytes hexadecimal (bitstring format) from DSCB.

Byte 1:

B’1000000x’ IS (Indexed sequential)

B’0100000x’ PS (Physical sequential)

B’0010000x’ DA (Direct access)

B’0000001x’ PO (Partitioned organization)

B’xxxxxxx1’ U (Unmovable)

Byte 2:

B’xxxx1xxx’ VS (VSAM)

EXP_DATE BITSTRING3 Expiration date; 3-byte hexadecimal. The format is X’YYDDDD’, or zeros, if not specified.

DSNS


EXT_17_255 CHAR1912 Extent descriptions for extent numbers 17 through 255. The data is an array of one hundred seven 8-byte hexadecimal entries, with the following format:

+0 Len(2) Lowest cylinder number allocated to the extent.

+2 Len(2) Lowest track number within the lowest allocated cylinder.

+4 Len(2) Highest cylinder number allocated to the extent.

+6 Len(2) Highest track number within the highest allocated cylinder.

EXTENT1 thru

EXTENT16

BITSTRING8 Extent descriptor information for a DASD extent allocated to a dataset. Format is 8 bytes of hexadecimal data as follows:

+0 Len(2) Lowest cylinder number allocated to the extent.

+2 Len(2) Lowest track number within the lowest allocated cylinder.

+4 Len(2) Highest cylinder number allocated to the extent.

+6 Len(2) Highest track number within the highest allocated cylinder.

KEY_DISP INTEGER2 Key position for a keyed dataset; 2-byte hex field.

KEY_LENGTH

BITSTRING1 Length of keys for a keyed dataset; 1-byte hex field.

LRECL INTEGER2 Logical record length for dataset or maximum record length for a VSAM component; 2-byte integer value.

NUM_EXTS INTEGER4 Number of extents in the dataset; 4-byte integer field.

PCT_USED INTEGER4 Percent of allocated space within the dataset that is used; 4 byte integer field expressed in 10ths of a percent (that is, 1 decimal point).

RECFM INTEGER4 Record format; 1-byte hexadecimal (bitstring format) from DSCB as follows:

B’10xxxxxx’ F (Fixed length records)

B’01xxxxxx’ V (Variable length records)

B’11xxxxxx’ U (Undefined record length)

B’xx1xxxxx’ T (Track overflow allowed for records)

B’xxx1xxxx’ B (Records are blocked)

B’xxxx1xxx’ S (Spanned records for variable length)

B’xxxx1xxx’ S (Standard blocks for fixed length)

B’xxxxx1xx’ A (ANSI control characters in records)

B’xxxxxx1x’ M (Machine control characters in records)

REF_DATE BITSTRING3 Last reference date; 3-byte hexadecimal. The format is X’YYDDDD’ or zeros if not available.

Column Name



DSNS

SECALC_FLG BITSTRING1 Secondary allocation flags; 1-byte hexadecimal (bitstring format) from DSCB as follows:

B’00xxxxxx’ Absolute track allocation

B’11xxxxxx’ Cylinder allocation

B’10xxxxxx’ Track allocation

B’01xxxxx0’ Average Block allocation

B’01xxxxx1’ Average block and round allocation

B’xx1xxxxx’ Mass storage group volume

B’xxx1xxxx’ Secondary space extension exists

B’xxxx1xxx’ Contiguous allocation

B’xxxxx1xx’ MXIG request

B’xxxxxx1x’ ALX request

B’xxxxxxx1’ Round requested for average block

SECALC_SIZ INTEGER4 Secondary allocation amount; 3-byte hexadecimal.

SMS_FLAGS BITSTRING1 SMS indicators; 1-byte hexadecimal (bitstring format) from DSCB as follows:

B’1xxxxxxx’ Dataset is SMS managed

B’x1xxxxxx’ No BCS entry for dataset

B’xx1xxxxx’ Dataset may be reblocked

B’xxx1xxxx’ DADSM create originated blocksize

B’xxxx1xxx’ PDSE format dataset

SPCEXT_FLG BITSTRING1 Space extension flags; 1-byte hexadecimal (bitstring format) from DSCB as follows:

B’1xxxxxxx’ Space extension value = original block length

B’x1xxxxxx’ Space extension value is in megabytes

B’xx1xxxxx’ Space extension value is in kilobytes

B’xxx1xxxx’ Space extension value is in bytes

B’xxxx1xxx’ Space extension value compacted by 256

B’xxxxx1xx’ Space extension value compacted by 65536

SPCEXT_VAL INTEGER2 Space extension value; 2-byte hexadecimal.

TRKS_ALLOC INTEGER4 Number of tracks allocated to the dataset; 4-byte integer field.

TRKS_USED INTEGER4 Number of tracks used within TRKS_ALLOC; 4-byte integer field.

VOL_COUNT INTEGER4 Number of volumes on which a dataset resides; 4-byte integer. The returned value is always 1, unless you make a request for a specific multivolume dataset without identifying a volser.

VOL_EXTS BITSTRING1 Number of extents in the dataset on this volume.

Column Name


DSNS


VOL_SEQ INTEGER2 Volume sequence number for this occurrence of the dataset; 2-byte integer.

VOLSER CHAR6 Volume on which this dataset resides; 6-byte character.

Column Name



HSM_CDS

HSM_CDS

DefinitionHSM_CDS provides space utilization information for HSM control datasets. One row is available for each dataset (BCDS, MCDS, OCDS, and Journal).



Type Description

CDS_TYPE CHAR1 Type of control dataset; 1-byte character field, with the following values:

B BCDS

M MCDS

O OCDS

J Journal

FREE_BYTES INTEGER4 Number of free bytes within allocated extents; 4-byte integer, set to -1(x’ffffffff’) to indicate not available.

NUM_EXTS INTEGER2 Number of allocated extents; 2-byte integer, set to -1(x’ffff’) to indicate not available.

PCT_FREE INTEGER4 Percent free space (unallocated, unused and still available for allocation and use) in dataset; numeric long (% * 10).

PCT_FULL INTEGER4 Percent used space within allocated space in the dataset; long (% * 10).

PRIEXT_BYT INTEGER4 Number of bytes in the primary extent of the dataset; 4-byte integer, set to -1(x’ffffffff’) to indicate not available.

SECEXT_BYT INTEGER4 Number of bytes in each secondary extent of the dataset; 4-byte integer, set to -1(x’ffffffff’) to indicate not available.

SPACE_THR INTEGER2 HSM threshold percent for space utilization within the CDS; 2-byte integer, set to -1(x’ffff’) to indicate not available.

TOTEXT_BYT INTEGER4 Total number of bytes within all allocated extents; 4-byte integer, set to - 1(x’ffffffff’) to indicate not available.

HSM_DS_RV


HSM_DS_RV

DefinitionHSM_DS_RV provides information about HSM recovery versions for a given dataset. One row is available for each backup version available for recovery.

DescriptionThe following column is provided:


Type Description

BKUP_DATE INTEGER4 The date for the backup; numeric long (decimal, format yyyydddc).

BKUP_TIME INTEGER4 Time for the backup; numeric long (decimal, format hhmmssth).

CAT_STATUS BITSTRING1 Dataset was or was not cataloged at the time of backup; 1-byte indicator:

1 Yes

0 No

GENERATION INTEGER4 Generation number for HSM dataset backup; numeric long.

VERSION INTEGER4 Version number of HSM dataset backup; numeric long.


HSM_FUN_DA

HSM_FUN_DA

DefinitionHSM_FUN_DA provides processing statistics for HSM major functions within the current HSM processing interval. One row is available for each function defined in FUNC_TYPE.



Type Description

AUTO_REQS INTEGER2 Number of auto requests for function during the current interval; 2-byte integer.

BYTS_READ INTEGER4 Total number of bytes (less than a gigabyte) read during processing; 4-byte integer.

BYTS_WRITE INTEGER4 Total number of bytes (less than a gigabyte) written during processing; 4-byte integer.

FAIL_REQS INTEGER2 Number of request failures for a function during the current interval; 2-byte integer.

FUNC_TYPE BITSTRING1 Type of major function; 1-byte hexadecimal field with values as follows:

01 Primary to level 1 migration

02 Level 1 to level 2 migration

03 Primary to level 2 migration

04 Level 1 to primary recall

05 Level 2 to primary recall

06 Delete migrated datasets

07 Daily backup

08 Spill backup

09 Recovery

10 Recycle of backup volumes

11 Delete from user volumes (delete by age)

12 Recycle of level 2 migration volumes

GIGS_READ INTEGER4 Total number of gigabytes read during processing; 4-byte integer.

GIGS_WRITE INTEGER4 Total number of gigabytes written during processing; 4-byte integer.

TRKS_READ INTEGER4 Total number of tracks read during processing; 4-byte integer.

TRKS_WRITE INTEGER4 Total number of tracks written during processing; 4-byte integer.

USER_REQS INTEGER2 Number of user requests for function during the current interval; 2-byte integer.

HSM_FUN_ST


HSM_FUN_ST

DefinitionHSM_FUN_ST provides hold status and activity status for major functions within HSM. This is a single row table with one column for each function and activity. Each column is a single byte value. The following values are for hold status columns:

The following values are for activity status columns:


00 Function not held

01 Function held

02 Function held at end of volume

03 Function partially held or held for TSO

00 Function not active

01 Function active


Type Description

AG_BACK_ST BITSTRING1 Aggregate group backup hold status.

AG_RECV_ST BITSTRING1 Aggregate group recovery hold status.

AU_BACK_ST BITSTRING1 Auto backup hold status.

AU_DUMP_ST BITSTRING1 Auto dump hold status.

AU_MIG_ST BITSTRING1 Auto migration hold status.

AUDIT_ACTF BITSTRING1 Audit active flag.

AUDIT_ST BITSTRING1 Audit hold status.

BACKUP_ST BITSTRING1 Back up hold status.

BCDS_BU_FG BITSTRING1 BCDS backup active flag.

DUMP_ST BITSTRING1 Dump hold status.

EXPIRBV_ST BITSTRING1 Expirebv hold status.

JRNL_BU_FG BITSTRING1 Journal backup active flag.

LIST_ACTF BITSTRING1 List active flag.

LIST_ST BITSTRING1 List hold status.

MCDS_BU_FG BITSTRING1 MCDS backup active flag.


HSM_FUN_ST

MIGRATE_ST BITSTRING1 Migration hold status.

OCDS_BU_FG BITSTRING1 OCDS backup active flag.

RECALL_ST BITSTRING1 Recall hold status.

RECOVER_ST BITSTRING1 Recovery hold status.

RECYC_ACTF BITSTRING1 Recycle active flag.

RECYCLE_ST BITSTRING1 Recycle hold status.

REPORT_ST BITSTRING1 Report hold status.

REPRT_ACTF BITSTRING1 Report active flag.

TP_COPY_ST BITSTRING1 Tape copy hold status.

TP_RCAL_ST BITSTRING1 Tape recall hold status.

TP_RCOV_ST BITSTRING1 Tape recovery hold status.

TP_REPL_ST BITSTRING1 Tape replace hold status.


Type Description

HSM_REQS


HSM_REQS

DefinitionHSM_REQS provides information about the requests actively being processed, and queued for processing, in the HSM address space. One row is available for each active or queued request.



Type Description

REQ_ABCC INTEGER4 System abend code for abended request; 4-byte hexadecimal field.

REQ_AGNAME CHAR30 Name of aggregate group for a request; 30-byte character field. This is all zeros for nonaggregate requests.

REQ_DATE INTEGER4 Date request was issued; 4-byte packed field. The format is X’yyyyddds’:

yyyy Year

ddd Julian date

s Packed decimal sign value

REQ_DSNAME CHAR44 Name of dataset processed by request; 44-byte character field. This is all zeros or blanks for volume requests.

REQ_FLAG1 BITSTRING1 1-byte hexadecimal field with values as follows:

00 Dataset request

01 Volume request

REQ_JOBN CHAR8 Jobname of the issuer of the request; 8-byte character field.

REQ_NUM INTEGER4 HSM request number processed request; 4-byte integer.

REQ_RC INTEGER4 HSM return code for processed request; 4-byte integer.

REQ_REASON INTEGER4 HSM reason code for processed request; 4-byte integer.

REQ_STATUS BITSTRING1 Status of request within HSM; 1-byte hexadecimal field with values as follows:

00 Request queued for processing

01 HSM is processing the request

02 Request processing abended

03 Request processing completed

04 Request cancelled prior to processing

REQ_TIME INTEGER4 Time request was issued; 4-byte integer field representing time in 100ths of a second.


HSM_REQS

REQ_TYPE BITSTRING1 Type of request; 1-byte hexadecimal field with values as follows:

03 Recall

05 Recover

06 Migrate

07 Backup

12 Delete

13 Aggregate backup

14 Aggregate recovery

254 Restore

255 Dump

REQ_VOLSER CHAR6 Name of volser processed by a request; 6-byte character field.

SUBPOOL BITSTRING1 MVS subpool number of the storage containing the HSM MWE for this request.

WAIT_TYPE BITSTRING1 Wait status requested by issuer of the request; 1-byte hexadecimal field with values as follows:

00 Issuer requested to WAIT for completion

01 Issuer specified NOWAIT for completion


Type Description

HSM_STATUS


HSM_STATUS

DefinitionHSM_STATUS provides general information about the status and activity of HSM within the current HSM processing interval. Only one row is available for this table.

DescriptionThe following columns are available:


Type Description

EXPBV_EKEY CHAR8 ExpireBV planned end key; 8-byte character field.

EXPBV_SKEY CHAR8 ExpireBV last stored BCDS key; 8-byte character field.

HSM_ACTIVE BITSTRING1 Current status of HSM; 1-byte hexadecimal field with values as follows:

00 HSM is not active

01 HSM is active

HSM_ASID INTEGER2 Address space ID for the HSM address space; 2-byte hexadecimal value.

HSM_STIM DOUBLE8 Start date/time for the HSM address space; 8-byte field in TOD format.

HSM_VERS CHAR4 HSM version/release/modification number; 4-byte character value. The format is ‘VVRM’:

VV Version

R Release

M Modification

INTVL_ABND INTEGER4 Number of HSM task abends in the current interval; 4-byte integer

INTVL_CPUT INTEGER4 Amount of CPU time used in the current interval by HSM; 4-byte integer. The format is milliseconds.

INTVL_REQS INTEGER4 Number of requests received in current interval by HSM; 4-byte integer.

INTVL_STIM INTEGER4 Start time for the current HSM interval; 4-byte hexadecimal field. The format is 100ths of a second.

TP_BUV_RCY INTEGER2 Number of tape backup volumes recycled in the current interval; 2-byte integer.

TP_ML2_RCY INTEGER2 Number of tape migration volumes recycled in the current interval; 2-byte integer.

VOL_BKUPS INTEGER2 Number of volume backups requested in current interval; 2-byte integer.


HSM_STATUS

VOL_DMP_FL INTEGER2 Number of volume dump failures in current interval; 2-byte integer.

VOL_DUMPS INTEGER2 Number of volume dumps requested in current interval; 2-byte integer.

VOL_MIGS INTEGER2 Number of volume migrations requested in current interval; 2-byte integer.

VOL_RESTS INTEGER2 Number of volume restores requested in current interval; 2-byte integer.

VOL_RST_FL INTEGER2 Number of volume restore failures in current interval; 2-byte integer.


Type Description

HSM_STOR


HSM_STOR

DefinitionHSM_STOR provides storage utilization information for HSM. This is a single-row table.

Description


Type Description

CS_ACT_L INTEGER2 Percent of the maximum amount of common storage that can be allocated to anything other than batch WAIT MWEs while HSM is active; 2-byte integer.

CS_INACT_L INTEGER2 Percent of the maximum amount of common storage that can be allocated to anything other than batch WAIT MWEs while HSM is inactive; 2-byte integer.

CS_MAX INTEGER4 Maximum amount of common storage (in bytes) to be used by HSM; 4-byte integer.

CS_USED INTEGER4 Amount of common storage (in bytes) in use by HSM; 4-byte integer.

ESTOR_FMCT INTEGER4 Amount of expanded storage (in frames) in use by HSM; 4-byte integer. The value is -1 (n/a) if no expanded storage is on the system.

FIXED_FMCT INTEGER4 Amount of fixed central storage (in frames) in use by HSM; 4-byte integer. The value is -1 (n/a) if HSM is swapped out.

HIGH_UIC1 INTEGER2 High threshold for first UIC (unreferenced interval column) range for real frames in use on the system; 2-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

HIGH_UIC2 INTEGER2 High threshold for second UIC range for real frames in use on the system; 2-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

HIGH_UIC3 INTEGER2 High threshold for third UIC range for real frames in use on the system; 2-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

HIGH_UIC4 INTEGER2 High threshold for fourth UIC range for real frames in use on the system; 2-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

LOW_UIC1 INTEGER2 Low threshold for first UIC range for real frames in use on the system; 2-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.


HSM_STOR

LOW_UIC2 INTEGER2 Low threshold for second UIC range for real frames in use on the system; 2-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

LOW_UIC3 INTEGER2 Low threshold for third UIC range for real frames in use on the system; 2-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

LOW_UIC4 INTEGER2 Low threshold for fourth UIC range for real frames in use on the system; 2-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

REAL_FMCT INTEGER4 Amount of central storage (in frames) in use by HSM; 4-byte integer. The value is -1 (n/a) if HSM is swapped out.

UIC1_FMCT INTEGER4 Number of central storage frames in use by HSM that have UIC values in the first UIC range for the system; 4-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

UIC2_FMCT INTEGER4 Number of central storage frames in use by HSM that have UIC values in the second UIC range for the system; 4-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

UIC3_FMCT INTEGER4 Number of central storage frames in use by HSM that have UIC values between the third UIC range for the system; 4-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.

UIC4_FMCT INTEGER4 Number of central storage frames in use by HSM that have UIC values between the fourth UIC range for the system; 4-byte integer. This value is for SP4.2 systems and above; for other systems, the value returned is -1.


Type Description

JOB


JOB

DefinitionJOB provides current active jobs in the system. One row is available for each job. It is used for matching active jobs with user-provided masks.



Type Description

ASID INTEGER2 Address space ID.

IO_RATE INTEGER4 I/O rate for job; numeric long; rate per second to 1/10ths (nn.n).

NAME CHAR8 Name of job; character length 8.


LCU

LCU

DefinitionLCU provides logical control unit information. One row is available for each LCU identified by the NUMBER column. The information originates from RMF.



Type Description

ALL_CP_BSY INTEGER4 Percent all channel paths busy; numeric long (% * 1000).

AVG_DELAYQ INTEGER4 Average delay queue; numeric long (n * 1000). For CPU models prior to the 3090™, this is the actual delay queue length.

CHPID_CNT INTEGER2 Number of installed channel paths attached to the LCU; numeric short. This is 0 for pre-3090 CPU models; for 3090 CPU models and above, it indicates the number of CHPIDx_DAT entries that are valid for the LCU.

CHPID1 thru

CHPID8

INTEGER2 Channel path ID for LCU; 2-byte hexadecimal. Invalid entries (CHPID not installed) are set to X’FFFF’.

CHPID1_DAT

thru CHIPID8_DAT

CHAR18 18 bytes of information for each installed channel path for the LCU. There are 1 to 4 entries for pre-ESCON environments and 1 to 8 entries for ESCON environments. The number of valid entries is by CHPID-CNT. Zero values are returned for unused entries if they are requested. The format of the subfields in each entry is as follows:n Number of control units attached to the channel path for this

LCU; numeric short:Control unit 1 ID 2-byte hexadecimal

Control unit 2 ID 2-byte hexadecimal

Control unit 3 ID 2-byte hexadecimal

Control unit 4 ID 2-byte hexadecimaln Channel path I/Os per second (rate) for I/Os to this LCU;

numeric long (rate * 1000).n Percent of I/O requests deferred, due to control unit busy for

I/Os, to the LCU by the channel path; numeric long (% * 1000).

CONT_RATE INTEGER4 Contention rate; numeric long (n * 1000). For pre-3090 CPU models, this is the I/O rate per second.

NUMBER INTEGER2 Number given to identify the LCU; 2-byte hexadecimal.

LCU


PCT_CUBUSY INTEGER4 Percent of deferred I/Os for the LCU due to control unit busy; numeric long (% * 10). This value is for pre-3090 CPU models only.

PCT_DEFER INTEGER4 Percent of deferred I/Os for the LCU; numeric long (% * 10). This value is for pre-3090 CPU models only.

PCT_DEVBSY INTEGER4 Percent of deferred I/Os for the LCU due to device busy; numeric long (% * 10). This value is for pre-3090 CPU models only.


Type Description


RMF_ENV

RMF_ENV

DefinitionRMF_ENV provides information about the RMF environment for the currently active system. Only one row is available. The information originates from RMF.



Type Description

CYCLE_TIME DOUBLE8 RMF cycle time in timer units; numeric double word.

INT_ELAP INTEGER4 Time elapsed in interval in 1/100ths of a second; numeric long.

INT_LENGTH INTEGER4 Interval length in 1/100ths of a second; numeric long.

INT_START INTEGER4 Interval start time in 1/100ths of a second; numeric long.

RMF_LEVEL CHAR8 Version of RMF currently running; character 8 (for example, n.n.n).

STATUS BITSTRING1 Status of monitor I; 1-byte indicator.

0 Active

1 Inactive

SMS_CONFIG


SMS_CONFIG

DefinitionSMS_CONFIG provides information about SMS base configuration. Only 1 row is available. Use it to obtain the array of system names in the configuration for use with status arrays in the storage group and DASD tables. The information originates from SMS construct access services.


Column NameColumn

Data Type Description

CUR_SYS INTEGER2 Index in array to current system name; numeric short.

DFT_MCNAME CHAR30 Default management class name; maximum character length 30.

DFT_TRKCYL INTEGER4 Default number of tracks per cylinder; numeric long.

DFT_TRKSIZ INTEGER4 Default track size in bytes; numeric long.

DFT_UNIT CHAR8 Default unit name; character length 8.

LUPD_DATE CHAR10 Date last updated in format mm/dd/yyyy; character length 10.

LUPD_TIME CHAR8 Time last updated in format hh.mm.ss; character length 8.

LUPD_USER CHAR8 User ID of last updater; character length 8.

SYS_ARRAY CHAR64 Eight element array of system names; each element is character length 8 (total length 64).


SMS_DAT_CL

SMS_DAT_CL

DefinitionSMS_DAT_CL provides information about SMS data classes. One row is available for each data class identified by the NAME column. The information originates from SMS construct access services.



Type Description

ALLOC_UNIT INTEGER4 Allocation unit amount; numeric long.

AVGREC_SCL BITSTRING1 AVGREC scale; 1-byte indicator:

1 Bytes

2 Kilobytes

3 Megabytes

CA_FREE INTEGER2 VSAM CA free space percent; numeric short.

CI_FREE INTEGER2 VSAM CI free space percent; numeric short.

CI_SIZE INTEGER4 VSAM CI size for KSDS, ESDS, or RRDS; numeric long.

DIR_BLOCKS INTEGER4 Number of directory blocks; numeric long.

EXPDT_DAY INTEGER2 Expiration date (absolute day of year); numeric short.

EXPDT_YEAR INTEGER2 Expiration date year; numeric short.

INDEX_OPT BITSTRING1 VSAM index options; 1-byte indicator:

0 No imbed, no replicate

64 No imbed, replicate

128 Imbed, no replicate

192 Imbed, replicate

KEY_LENGTH BITSTRING1 VSAM key length; 1-byte numeric.

KEY_OFFSET INTEGER2 VSAM key offset; numeric short.

LRECL INTEGER4 Record length; numeric long.

LUPD_DATE CHAR10 Date last updated in format mm/dd/yyyy; character length 10.

LUPD_TIME CHAR8 Time last updated in format hh:mm:ss; character length 8.

LUPD_USER CHAR8 User ID of last user to update; character length 8.

MAX_VOLS INTEGER2 Maximum volume count for extend; numeric short.

NAME CHAR30 Name of data class; maximum character length 30. You can use this name as an index to select 1 data class.

SMS_DAT_CL


PRIM_SPACE INTEGER4 Primary space amount; numeric long.

RECFM BITSTRING1 Data set RECFM; 1-byte indicator:

0 Null

1 Undefined

2 Variable

3 Variable spanned

4 Variable blocked

5 Variable blocked spanned

6 Fixed

7 Fixed standard

8 Fixed blocked

9 fixed blocked spanned

RECORG BITSTRING1 Data set recorg; 1-byte indicator:

0 Null, SAM

1 VSAM KSDS

2 VSAM ESDS

3 VSAM RRDS

4 VSAM LDS

RETN_DAYS INTEGER4 Retention period in number of days; numeric long.

SEC_SPACE INTEGER4 Secondary space amount; numeric long.

X_REG_SHAR BITSTRING1 VSAM cross-region share options; 1-byte numeric.

X_SYS_SHAR BITSTRING1 VSAM cross-system share options; 1-byte numeric.


Type Description


SMS_MAN_CL

SMS_MAN_CL

DefinitionSMS_MAN_CL provides information about SMS management classes. One row is available for each management class identified by the NAME column. The information originates from SMS construct access services.



Type Description

AUTOBACKUP BITSTRING1 Autobackup allowed or not allowed; 1-byte indicator:

1 Yes

0 No

AUTOMIGRAT BITSTRING1 Command or auto migrate; 1-byte indicator:

0 No migration allowed

1 Migrate on command only

2 Auto migrate or on command

BKRET_ONLY INTEGER2 Days to keep only backup version; numeric short: The value for NOLIMIT is -1.

BKRET_XTRA INTEGER2 Days to keep extra backup versions; numeric short: The value for NOLIMIT is -1.

BKUP_FREQ INTEGER2 Backup frequency; numeric short.

BKUP_VDSDL INTEGER2 Number of DS deleted backup versions; numeric short.

BKUP_VERS INTEGER2 Number of backup versions; numeric short.

CMD_BACKUP BITSTRING1 Command backup allowed or not; 1-byte indicator:

0 No user or administrator backup

1 Allow administrator command backup

2 Allow administrator or user command

EXP_CDAYS INTEGER4 Expire after x days since day created; numeric long. The value for NOLIMIT is -1.

EXP_CDDAY INTEGER2 Expire after x date since day created; numeric short.The value for NOLIMIT is -1.

EXP_CDYEAR INTEGER2 Expire after x date since yeat created; numeric short. The value for NOLIMIT is -1.

EXP_NONUSE INTEGER4 Expire after x days of non usage; numeric long. The value for NOLIMIT is -1.

GDGS_PRIM INTEGER2 Number of GDG elements on primary; numeric short.

SMS_MAN_CL


LUPD_DATE CHAR10 Date last updated, in format mm/dd/yyyy; character length 10.

LUPD_TIME CHAR8 Time last updated, in format hh:mm:ss; character length 8.


MIN_D_LEV1 INTEGER2 Minimum days on level 1 and last use; numeric short. The value for NOLIMIT is -1.

MIN_D_PRIM INTEGER2 Minimum days on primary and last use; numeric short.

NAME CHAR30 Name of management class; maximum character length 30. You can use this name as an index to select 1 management class.

PART_REL BITSTRING1 Data set eligible for partial release; 1-byte indicator:

0 No

1 Yes

2 Conditional

RETN_LIMIT INTEGER2 Retention limit x number of days; numeric short. The value for NOLIMIT is -1.

ROLL_GDS_A BITSTRING1 Rolled-off GDS action; 1-byte indicator:

1 Migrate

0 Expire


Type Description


SMS_ST_CL

SMS_ST_CL

DefinitionSMS_ST_CL provides information about SMS storage classes. One row is available for each storage class identified by the NAME column. The information originates from SMS construct access services.



Type Description

AVAIL BITSTRING1 Availability; 1-byte indicator:

0 No availabliity specified

1 Standard

2 Continuous

DIR_BIAS BITSTRING1 Direct bias; 1-byte indicator:

0 No bias specified

1 Read

2 Write

DIR_MSR_OB INTEGER4 Direct response time objective in microseconds; numeric long.

GUAR_SPACE BITSTRING1 Guaranteed space; 1-byte indicator:

0 No

1 Yes

GUAR_SYNCH BITSTRING1 Guaranteed synchronous write; 1-byte indicator:

0 No

1 Yes


LUPD_TIME CHAR8 Time last updated, in format hh:mm:ss; character length 8.


NAME CHAR30 Name of storage class; maximum character length 30. You can use this name as an index to select 1-storage class.

SEQ_BIAS BITSTRING1 Sequential bias; 1-byte indicator:

0 No bias specified

1 Read

2 Write

SEQ_MSR_OB INTEGER4 Sequential response time objective in microseconds; numeric long.

SMS_ST_GRP


SMS_ST_GRP

DefinitionSMS_ST_GRP provides information about SMS storage groups. One row is available for each storage group identified by the NAME column. The information originates from SMS construct access services.


Column Name Column Data Type Description

AUTO_BKUP BITSTRING1 Automatic backup requested; 1-byte indicator:

1 Yes

0 No

AUTO_BSYS CHAR8 Automatic backup system; character length 8.

AUTO_DSYS CHAR8 Automatic dump system; character length 8.

AUTO_DUMP BITSTRING1 Automatic dump requested; 1-byte indicator:

1 Yes

0 No

AUTO_MIGR BITSTRING1 Automatic migration requested; 1-byte indicator:

1 Yes

0 No

AUTO_MSYS CHAR8 Automatic migration system; character length 8.

BKUP_FREQ INTEGER4 Guaranteed backup frequency; numeric long. The value for NOLIMIT is -1.

DUMP_CLASS CHAR40 Five element array of dump classes for autodump; each element is character length 8 (total length 40).

HI_THRESH BITSTRING1 Allocation/migration high threshold, 0 to 99 percent; 1-byte numeric (0–99).

LO_THRESH BITSTRING1 Allocation/migration low threshold, 0 to 99 percent; 1-byte numeric (0–99).


LUPD_TIME CHAR8 Time last updated, in format hh.mm.ss; character length 8.


NAME CHAR30 Name of storage group; maximum character length 30. You can use this column as an index.


SMS_ST_GRP

ST_ARRAY CHAR8 Eight element array of SMS status values for each system in the system array; each element is a 1-byte indicator (total length 8):

0 Notcon

1 Enable

2 Quiall

3 Quinew

4 Disall

5 Disnew

STATUS BITSTRING1 Storage group status from perspective of current system; 1-byte indicator:

0 Notcon

1 Enable

2 Quiall

3 Quinew

4 Disall

5 Disnew

TYPE BITSTRING1 Storage group type; 1-byte indicator:

0 Pool

1 Vio

2 Dummy

VIO_MAX INTEGER4 VIO maximum dataset size; numeric long.

VIO_UTYPE CHAR4 VIO unit type; character length 4.

VOLSER_IDX CHAR6 Volser index column to obtain group for certain volser; character length 6. You can use this column as an index; if not, it is blank.

Note: The following information about SMS storage groups is also required. It is summary data produced by requests using the DASD table, not column data:n total volumes in storage groupn total space capacity of all volumes in storage groupn total free space of all volumes in storage group

Column Name Column Data Type Description

SYSTEM_ENV


SYSTEM_ENV

DefinitionSYSTEM_ENV provides information about the system and DF/P environments for the MVS system currently active. Only 1 row is available. The information originates from various control blocks.



Type Description

DFP_LEVEL CHAR8 Version of DF/P currently running; character length 8 (for example, n.n.n).

IEAICS_SFX CHAR2 Parmlib IEAICS suffix; character length 2.

IEAIPS_SFX CHAR2 Parmlib IEAIPS suffix; character length 2.

IEAOPT_SFX CHAR2 Parmlib IEAOPT suffix; character length 2.

IPL_DATE INTEGER4 Date of IPL; packed decimal date (4 bytes).

IPL_DEVICE INTEGER2 Device number IPLd; 2-byte hexadecimal.

IPL_TIME INTEGER4 Time of IPL in 1/100ths of a second; numeric long.

IPL_VOLSER CHAR6 Volume serial for device IPLd; character length 6.

MODE BITSTRING1 Basic/LPAR mode; 1-byte indicator:

1 LPAR

0 Basic

MVS_LEVEL CHAR8 The version of MVS currently running; character length 8 (for example, spn.n.n).

SMF_ID CHAR4 SMF ID of the system.

SMS_STATUS BITSTRING1 Status of SMS; 1-byte indicator:

1 Active

0 Inactive

Identifying and Locating Messages 199

Identifying and Locating Messages

The following table describes and locates messages that can help you diagnose errors.

Prefix Description Location

!AOP or OB VTM1 LOGON and LOGOFF messages that describe status, configuration errors, and session disconnect conditions.

Written to then RKOGLOGM ddname of the

OG/MVS address spacen MVS system logDocumented in the OG/MVS online messages dataset (TKANTENU)

KOGV Error and information messages. Written to the TLVLOG ddname of the CMS address space

Documented in the OG/MVS online messages dataset (TKANTENU)

C

Guide to Candle Customer Support 201

Guide to CandleCustomer Support

IntroductionCandle Corporation is committed to producing top-quality software products and services. To assist you with making effective use of our products in your business environment, Candle is also committed to providing easy-to-use, responsive customer support.

Precision, speed, availability, predictability—these terms describe our products and Customer Support services.

Included in this Guide to Candle Customer Support is information about the following:

Base Maintenance Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202– Telephone Support

– eSupport

– Description of Severity Levels

– Service-level objectives

– Recording and monitoring calls for quality purposes

– Customer Support Escalations

– Above and Beyond

Enhanced Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206– Assigned Support Center Representative (ASCR)

– Maintenance Assessment Services (MAS)

– Multi-Services Manager (MSM)

Customer Support Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207– Link to Worldwide Support Telephone and E-mail information

D

Base Maintenance Plan



OverviewCandle offers a comprehensive Base Maintenance Plan to ensure that you realize the greatest value possible from your Candle software investments. We have more than 200 technicians providing support worldwide, committed to being responsive and to providing expedient resolutions to support requests. Technicians are available worldwide at all times during the local business day. In the event of an after-hours or weekend emergency, our computerized call management and forwarding system will ensure that a technician responds to Severity One situations within one hour. For customers outside of North America, after-hours and weekend support is provided in English language only by Candle Customer Support technicians located in the United States.

Telephone supportCandle provides consistently reliable levels of service—thanks to our worldwide support network of dedicated experts trained for specific products and operating systems. You will always work with a professional who truly understands your problem.

We use an online interactive problem management system to log and track all customer-reported support requests. We give your support request immediate attention by routing the issue to the appropriate technical resource, regardless of geographic location.

Level 0 Support is where your call to Candle Customer Support is first handled. Your support request is recorded in our problem management system, then transferred to the appropriate Level 1 support team. We provide Level 0 manual interaction with our customers because we support more than 170 products. We feel our customers would prefer personal interaction to a complex VRU or IVR selection menu.

Level 1 Support is the service provided for initial support requests. Our Level 1 team offers problem determination assistance, problem analysis, problem resolutions, installation assistance, and preventative and corrective service information. They also provide product usage assistance.

Level 2 Support is engaged if Level 1 cannot provide a resolution to your problem. Our Level 2 technicians are equipped to analyze and reproduce errors or to determine that an error is not reproducible. Problems that cannot be resolved by Level 2 are escalated to Candle’s Level 3 R&D support team.

Level 3 Support is engaged if a problem is identified in Candle product code. At Level 3, efforts are made to provide error correction, circumvention or notification that a correction or circumvention is not available. Level 3 support provides available maintenance modifications and maintenance delivery to correct appropriate documentation or product code errors.



eSupportIn order to facilitate the support process, Candle also provides eSupport, an electronic full-service information and customer support facility, using the World Wide Web at www.candle.com/support/. eSupport allows you to open a new service request and update existing service requests, as well as update information in your customer profile. New and updated service requests are queued to a support technician for immediate action. And we can respond to your request electronically or by telephone—it is your choice.

eSupport also contains a continually expanding knowledge base that customers can tap into at any time for self-service access to product and maintenance information.

The Candle Web Site and eSupport can be accessed 24 hours a day, 7 days a week by using your authorized Candle user ID and password.

Description of Candle severity levelsResponses to customer-reported product issues and usage questions are prioritized within Candle according to Severity Code assignment. Customers set their own Severity Levels when contacting a support center. This ensures that we respond according to your individual business requirements.

Severity 1 Crisis

A crisis affects your ability to conduct business, and no procedural workaround exists. The system or application may be down.

Severity 2High

A high-impact problem indicates significant business effect to you. The program is usable but severely limited.

Severity 3Moderate

A moderate-impact problem involves partial, non-critical functionality loss or a reasonable workaround to the problem. A “fix” may be provided in a future release.

Severity 4Low

A low-impact problem is a “how-to” or an advisory question.

Severity 5Enhancement Request

This is a request for software or documentation enhancement. Our business units review all requests for possible incorporation into a future release of the product.

http://www.candle.com/support/



Candle has established the following service-level objectives:

Recording and Monitoring Calls for Quality PurposesCandle is committed to customer satisfaction. To ensure that our customers receive high levels of service, quality and professionalism, we’ll monitor and possibly record incoming and outgoing Customer Support calls. The information gleaned from these calls will help us serve you better. If you prefer that your telephone call with Candle Customer Support in North America not be monitored or recorded, please advise the representative when you call us at (800) 328-1811 or (310) 535-3636.

Customer Support EscalationsCandle Customer Support is committed to achieving high satisfaction ratings from our customers. However, we realize that you may occasionally have support issues that need to be escalated to Candle management. In those instances, we offer the following simple escalation procedure:

If you experience dissatisfaction with Candle Customer Support at any time, please escalate your concern by calling the Candle support location closest to you. Ask to speak to a Customer Support manager. During standard business hours, a Customer Support manager will be available to talk with you or will return your call. If you elect to hold for a manager, you will be connected with someone as soon as possible. If you wish a return call, please tell the Candle representative coordinating your call when you will be available. After contacting you, the Customer Support manager will develop an action plan to resolve your issue. All escalations or complaints received about support issues are logged and tracked to ensure responsiveness and closure.

Call Status Severity 1 Goal

Severity 2 Goal

Severity 3 Goal

Severity 4 Goal

Severity 5Goal

First Call Time to Answer

90% within one minute

Level 1 Response

(Normal Business Hours)

90% within 5 minutes

90% within one hour

Level 2 Response

(Normal Business Hours)

Warm Transfer

90% within two hours

90% within eight hours

Scheduled follow-up (status update)

Hourly or as agreed

Daily or as agreed

Weekly or as agreed Notification is made when an enhancement is incorporated into a generally available product.

Notification is made when a fix is incorporated into a generally available product.

The above information is for guideline purposes only. Candle does not guarantee or warrant the above service levels. This information is valid as of October 1999 and is subject to change without prior notice.



Above and BeyondWhat differentiates Candle’s support services from our competitors? We go the extra mile by offering the following as part of our Base Maintenance Plan:

n Unlimited multi-language defect, installation and operations support

n eSupport using the World Wide Web

n Regularly scheduled product updates and maintenance provided at no additional charge

n Over 200 specialized technicians providing expert support for your Candle products

Enhanced Support Services


Enhanced Support Services

OverviewOur Base Maintenance Plan provides a high level of software support in a packaged offering. However, in addition to this plan, we have additional fee-based support services to meet unique customer needs.

The following are some examples of our added-value support services:

n Assigned Support Center Representative Services (ASCR)

– An assigned focal point for managing support escalation needs

– Proactive notification of available software fixes

– Proactive notification of product version updates

– Weekly conference calls with your ASCR to review active problem records

– Monthly performance reviews of Candle Customer Support service levels

– Optional on-site visits (extra charges may apply)

n Maintenance Assessment Service (MAS)

– On-site assessment services

– Advice about product maintenance and implementation

– Training your staff to develop efficient and focused procedures to reduce overall cost of ownership of your Candle software products

– Analysis of your Candle product environment: versions, updates, code correction history, incident history and product configurations

– Reviews to ensure that purchased Candle products and solutions are used effectively

n Multi-Services Manager (MSM)

Multi-Services Manager provides highly valued services to customers requiring on-site full time expertise to complement their technical resources.

– Dedicated on-site Candle resource (6 months or one year) at your site to help ensure maximum use and effectiveness of your Candle products

– Liaison for all Candle product support activities, coordination and assistance with implementation of all product updates and maintenance releases

– Works with your staff to understand business needs and systems requirements

– Possesses technical and systems management skills to enhance your staff ’s knowledge and expertise

– Other projects as defined in Statement of Work for MSM services


Customer Support Contact Information


Link to Worldwide Support Telephone and E-mail informationTo contact Customer Support, the current list of telephone numbers and e-mail addresses can be found on the Candle Web site, www.candle.com/support/.

Select Support Contacts from the list on the left of the page.

http://www.candle.com/support/

Glossary 209

Glossary

This glossary defines words and phrases that have special meanings in the context of OMEGACENTER Gateway for MVS or within the systems interacting with OG/MVS.

Special charactersSpecial characters are alphabetized in this glossary as follows:

A

Abend Abnormal end of a task due to an error.

ACF/VTAM® Advanced Communication Function for the Virtual Telecommunications Access Method. Synonym for VTAM.

Action Effector Table Contains a list of all action effector routines that may be executed for various classes of objects. It is a read-only table and acts as a catalog of available action effector routines for validation of INSERT operations in the ACTREQTAB table.

Action Request Table Enables any CMS application to become an Action Client by allowing insert, delete, and select operations. Each action request is represented as a row in the Action Request table. Each row remains in the table until a client explicitly deletes the row.

Action Routine A user-supplied REXX program executed to resolve a problem or react to a set of conditions.

Alphabetic Character One of A-Z or a-z.

Alphanumeric Character One of A-Z, a-z, or 0-9.

Ampersand (&) An ampersand is prefixed to a variable name in symbolic substitution. See also Double Ampersand.

Angle Bracket (< >) In a conventional on-screen command syntax description, <A> means that element A is optional.

Application Program Identification (APPLID) The symbolic name that identifies an application program to VTAM. It is defined in the acbname parameter of the APPL statement.

< > See Angle Bracket.

& See Ampersand.

&& See Double Ampersand.

* See Asterisk.

{} See Braces.

[] See Brackets.

$ See Dollar Sign.

^ See Escape Sign.

= See Equal Sign.

- See Minus Sign.

% See Modulo.

| See Or Bar.

# See Pound Sign.

? See Question Mark.

’ See Quote.

G


Application Program Interface (API) The programming language interface between a program and its user.

Arithmetic Operator Takes one or two expressions as input and returns the result of an arithmetic operation.

Asterisk (*) (1) A pattern character that matches any string. (2) As an arithmetic operator: Multiplies expressions. (3) In an expression: The sign for multiplication. (4) In certain commands: In some cases, using the asterisk as the only character in a keyword subfield is equivalent to not using the keyword. (5) In TOD commands: Represents the current (system) time.

Autorefresh Option The option invoked by AF AUTOREF.

Availability Management Systems (AMS) An Availability Management System is an OG/MVS implementation designed using Candle’s methodology for managing systems from a business orientation.

B

Bind A request to activate a session between two logical units (LUs) in an SNA network. See also SNA Network.

Blank (1) A parsing device that divides the target string (between “words”). (2) A pattern character that matches one or more blanks.

Boolean Operates on one or two comparisons to make a condition. One of the following: AND, OR, or NOT.

Braces ({}) In a conventional command syntax description, {A} means that element A is required. Note that an unbracketed element is also required.

Brackets ([]) In a conventional printed command syntax description, [A] means that element A is optional.

C

Cache Unit A physical control unit with built-in high-speed storage and attached DASD devices.

Call a File Sometimes used to mean executing a command file with the EXEC command. Note that “execute a (command) file” is a more precise usage.

Call a Program To run a program by issuing the CALL command from a command file.

Channel Path Performs I/O operations, linking central storage with I/O devices. Channel operations are controlled by the channel subsystem (CSS), which directs I/O traffic. The CSS is responsible for switching instructions and data among channel pathways to optimize data flow.

Character String A concatenation of printable characters. A character string is one kind of constant in OG/MVS command syntax. It must be enclosed in quotes unless it contains only alphanumeric characters.

Character Type A variable of character type contains as its value a string of printable characters (including spaces).

Comment In a command file or REXX exec, text used for documentation that is marked off so that it plays no part in the file execution.

Comparator One of six abbreviations (EQ NE GT LT GE LE) that (1) expresses a quantitative comparison, or (2) stands between expressions in a comparison.

Comparison A clause in a condition statement of the form: expression comparator expression. For example: COUNT GE 2.

Condition (or Condition Statement) Part of a conditional command that consists of a comparison or a Boolean combination of comparisons. For example, VAR1 LT 1 or VAR1 GT 1.

Conditional Command A type of command that takes action depending on whether a given

Glossary 211

condition statement is true or false. A conditional command contains one of the following structures: DO UNTIL, DO WHILE END, IF THEN ELSE.

Constant A numeric integer coded in decimal, hexadecimal, or binary, or a character string enclosed in quotes.

Continuation, Line See Line Continuation.

D

Definition Statement In VTAM, the means of describing a network element.

Delete a File Erase a file from DASD

Division (/) Arithmetic Operator Divides the first expression by the second.

Dollar Sign ($) An initial dollar sign is used to form the name of an OG/MVS function; for example, $DAYOFWEEK.

Domain The MVS image on which a managed object resides.

Domain ID The identifier associated with a domain.

Double Ampersand (&&) A double ampersand (&&) in an arithmetic function indicates “anding” of numeric values. When used in the ACTION or ALTACT portion of a trap, indicates that the named variable is evaluated when the trap fires, instead of when it is added to the system.

E

End User The originator or recipient of application information flowing through an SNA network. An end user can be an application program or a terminal user.

Equal Sign (=) Assigns a value to a variable.

Escape Sign (^) If the escape sign occurs just before an instance of a special pattern character, that instance is not counted as a pattern character, but as an ordinary alphanumeric character.

Exec A REXX program or an OG/MVS automation procedure written in REXX.

Expression Either a constant or a variable or part of a command that resolves to one of these. Examples are 2, VAR1, VAR1 + 2, $HHMMSS(VAR1 + 2).

F

Function Part of a command that takes one or more arguments (expressions) as input and returns a value as output.

G

Group Command A series of commands between DO and END that OG/MVS treats syntactically as one command.

H

Hexadecimal Type A variable of hexadecimal type contains as its value a hexadecimal number.

Hexadecimal Number A number expressed in base 16.

HSM The program that controls data availability. It handles dataset archiving, backup, and recovery and manages available space on DASD volumes. It stores data by compressing it and migrating it from normal DASD to HSM-controlled DASD and tape.

I

Integer A positive or negative whole number.


Integer Type A variable of integer type contains as its value an unsigned integer.

K

Keyword A word in a command with spelling and meaning specified by OG/MVS command syntax. For example, ADD in TRAP ADD.

L

Line Continuation A command in a command file may be written so as to continue over more than one physical line by using one or more plus signs as continuation characters.

Logical Control Unit (LCU) The logical representation of one or more physical control units or a group of physical control units that share devices.

Logical Unit (LU) A port or entry point into an SNA network through which an end user accesses network services and communicates with other network users.

LOGON An initiation request for a session between logical units in an SNA network.

LOGON Mode A set of session parameters entered in a VTAM Logon Mode table that specify LU-LU session requirements.

LOGON Mode Table A VTAM table that contains sets of entries for each logon mode. A logon mode name (MODEENT) identifies each logon mode.

LU Logical Unit.

LU-LU Session A temporary connection between two logical units that is the vehicle for end-user communication in an SNA network.

LU0 In SNA (Systems Network Architecture), a type of session between 2 LU-LU half-sessions using SNA-defined protocols for transmission control and data flow control, but using end-user or product-defined protocols to augment or

replace FMD (functional management data) services protocols.

M

Minus Sign (-) In an expression, the minus sign represents either the unary (change-of-sign) or the binary (subtraction) function.

MODEENT A parameter in a VTAM APPLID definition statement that defines an entry in a logon mode table containing session parameters for a given application.

MODETAB A parameter in a VTAM APPLID definition statement that defines the name of the logon mode table to be used for a given application.

MODULO (%) Returns remainder from dividing the first expression by the second.

N

Name In command syntax a name consists of up to eight alphanumeric (including national) characters and begins with an alphabetic character.

Name Field A subfield in an operand set that must be occupied by a name.

Network Addressable Unit (NAU) In an SNA network, the logical unit, physical unit, or system services control point that is the origin or destination of information transmitted by the SNA path control network. Each NAU has a network address that represents it to the path control network.

Network Name The name of the APPL statement that defines a VTAM application program.

Node In VTAM, a physical point in a network defined by a symbolic name. In SNA, a physical point in a network that contains one or more network components.

Glossary 213

Notification List A list of names, methods, and times to be used in the notification process.

Numeric Numeric characters are 0-9.

O

Operand A unit of a command other than the command verb.

Operand Set An operand possibly followed by a subfield.

Operator Console An operator console is a computer terminal specifically assigned for use by computer operators to monitor operator messages and issue operator commands.

Operator, Arithmetic See Arithmetic Operator.

Or Bar (|) In an expression, an or bar means the logical “oring” of two numbers. In a command syntax description, A | B | C means to choose only one of the set ABC.

P

Substitution Symbol A query value that must be specified immediately before a request is executed (Opened). Substitution symbols allow a generalized statement to be tailored at runtime so that it can be reused without compilation. Substitution symbols appear as “?” in source statements.

Period (.) (1) A pattern character that terminates a pattern variable. (2) A parsing device that skips a word (a string between blanks).

Plus Sign (+) (1) The line continuation character in command files. (2) Adds expressions.

Positional Operand An operand required by OG/MVS syntax to occur in a certain place in a command relative to other operands.

Pound Sign (#) A pattern character that matches any numeric character in a full pattern.

Probe A program written in REXX that collects data about a managed object.

Q

Question Mark (?) A special pattern character that matches any alphanumeric character in a full pattern.

Quote (’) The single quote character (’) when referring to quoted strings.

Quoted String A parsing device that divides at the string.

R

Result Table A work area containing the rows retrieved by the execution of a SELECT statement.

S

SAA Systems Applications Architecture®. The IBM facility that defines the logical structure, format, and operational sequences of applications.

Scope of a Variable A region from which the variable can be referred to (local, global, or system).

Session A controlled exchange of information between two users in an SNA network.

Session Parameters The entries that define session requirements (such as pacing) for a session between two network addressable units.

Signed Integer +/- N When used as a parsing device, moves the parsing pointer nn positions forward or back.

SNA Systems Network Architecture. The IBM facility that defines the logical structure, formats,


protocols, and operational sequences that must be adhered to in controlling the configuration, operation, and information exchange in an SNA network.

SNA Network Portion of a distributed data processing network adhering to the format and protocols of the IBM Systems Network Architecture. It consists of the network addressable units (NAUs), boundary function components, and the path control network.

Storage Group A collection of physical volumes (DASD, optical, tape, or paging) with common attributes that SMS treats as a single logical entity.

Symbolic Variable A variable preceded by one or more ampersands for symbolic substitution.

Synchronous A mode of operation that requires the requester of a service to be “blocked” until the service is completed.

System ID An identifier representing the MVS image on which a probe executes. To be distinguished from the domain ID, which is the MVS image the probe monitors. The domain and the system may be identical.

System Services Control Point (SSCP) The focal point in an SNA network that functions as the network configurator and manager. The SSCP resides in a host processor.

System Variable A variable that can be referenced from any OG/MVS file.

T

Threshold The user-specified value against which the current attribute value is compared to derive a status.

Index 215

Symbols!AOP prefix messages 199

AACF2 63ACTEFTRTAB base table 139action effector routines 139Action Effector Table 139action responses

DF.ACTIONRESP 55obtaining 55

ACTREQTAB base table 141ACTRESPTAB base table 147Adobe portable document format 13AF/OPERATOR messages 199APPL base table 148application address space 25application session

starting 29terminating 31

APPLID, assigning 29applids

for CMS 68applname

LU0 session 29, 31arguments

applid 29applname 29, 31column names 34norows 88password 29reqhdl 87search criteria 35TRACE 29userid 29

arithmetic operators 98ASCR

assigned support center representative 206assigned support center representative

ASCR 206assigning

APPLID 29NAME 29

audience 20

Bbase tables

ACTEFTRTAB 139ACTREQTAB 141ACTRESPTAB 147APPL 148BITSTRING 45CACHE_CU 149CACHE_DET 151CACHE_DEV 156CACHE_ENV 158CHAN_PATH 159CHAR 45DASD 161DASD_USERS 165data format 45definition 26DSN_ENQS 166DSN_IO_ST 167DSN_LOC 169DSN_SMS 170DSNS 171HSM_CDS 175HSM_DS_RV 176HSM_FUN_DA 177HSM_FUN_ST 178HSM_REQS 180HSM_STATUS 182HSM_STOR 184JOB 186LCU 187probes and 26RMF_ENV 189SMS_CONFIG 190SMS_DAT_CL 191SMS_MAN_CL 193SMS_ST_CL 195SMS_ST_GRP 196SYSTEM_ENV 198VARCHAR 45

BITSTRING 102data format 39, 45operands 103

BOOLEAN 102operands 103

Index


CC2D() function 39, 45Cache Control Unit 25CACHE_CU base table 149CACHE_DET base table 151CACHE_DEV base table 156CACHE_ENV base table 158caching, enabling 55, 57Candle Management Server 25

application programming interface 26applids 68base tables 26Catalog 26CMS Catalog 26data constants 97data storage 26data types 102description 26logging off 59logging on to 46logging onto 29LOGOFF 44LOGON 44multiple host queries 26probes 26security 63

Candle Subsystem 25CHAN_PATH base table 159CHAR 39

data format 45operands 103

charactersdelimiter 96digits 96letters 96operator 96

cleanup 59CMS

logging onto 30column names 34column type

BITSTRING 39, 102CHAR 39, 102integer 39, 102VARCHAR 39, 102

columnnames 100columns

data types 102defined 26

comma, in syntax diagrams 10comparison considerations 96comparison operations

data format 39, 97data scaling 45

comparison operators 98CT/DS

logging off 31CT/Engine

address space 29CTDS argument 29customer support

base maintenance plan 202contact information 207enhanced support services 206eSupport 203severity levels 203telephone support 202

DDASD

3390 DASD volumes 57caching 55, 57DASD 50dataset migration 50defragmentation 47fragmentation index 47release free space 50

DASD base table 161DASD Services Status displays 55DASD_USERS base table 165data collection address space 25

probesREXXprograms

data constants 97character strings 97decimal integers 97hexadecimals 97

Data Facility Hierarchical Storage Manager (DFHSM or HSM) 25

data formatbase tables 45BITSTRING 39, 45, 102BOOLEAN 102C2D() function 39CHAR 39, 45, 102comparison operations 39data scaling 39, 45FLOAT 102floating point number 102hexadecimals 97integer 39, 45INTEGER2 102INTEGER4 102LONG 102matching 39

Index 217

SHORT 102VARCHAR 39, 45, 102with VUFETCH 39

data scalingcomparison operations 45fractional values 45integer 45

data typesBITSTRING 45, 102BOOLEAN 102CHAR 45, 102CMS columns 102definition 102FLOAT 102integer 45INTEGER2 102INTEGER4 102LONG 102SHORT 102VARCHAR 45, 102

dataset migrationestmigrt 50

datasets 25defaults in syntax diagrams 10defragmenting DASD

customizing 47policy 47

delimiter characters 96DF.ACTION template 107DF.ACTIONREQ template 107DF.ACTIONRESP 55DF.ACTIONRESP template 109DF.ACTIVEJOB template 109DF.CACHECU template 110DF.CACHEDETAIL template 111DF.CACHEDEVICE template 112DF.CACHEENV template 112DF.CHANNELPATH template 113DF.DASD template 113DF.DASDCACHE template 114DF.DASDCACHEBYJOBNAME template 115DF.DASDCACHEDETAIL template 116DF.DASDUSER template 117DF.DSBYASID template 117DF.DSBYDSNAME template 118DF.DSBYJOBNAME template 118DF.DSBYVOLUME template 119DF.DSENQ template 119DF.DSIOBYDSNAME template 120DF.DSIOBYJOBNAME template 121DF.DSIOBYVOLUME template 121DF.DSLOC template 122

DF.DSSMS template 122DF.HSMCDS template 122DF.HSMDSRV template 123DF.HSMFUNDA template 123DF.HSMFUNST template 124DF.HSMREQ template 124DF.HSMSTATUS template 125DF.HSMSTORAGE template 125DF.LCU template 126DF.LCUIORATE template 126DF.RMFENV template 127DF.SMSDATACLASS template 128DF.SMSDSBYDSNAME template 129DF.SMSDSBYVOLUME template 130DF.SMSDSIOBYJOBNAME template 131DF.SMSDSIOBYVOLUME template 132DF.SMSMANAGEMENTCLASS template 133DF.SMSSTORAGECLASS template 133DF.SMSSTORAGEGROUP template 134DF.SYSTEMENV template 134DF.VOLUMEBYJOBNAME template 135digits 96DSN_ENQS base table 166DSN_IO_ST base table 167DSN_LOC base table 169DSN_SMS base table 170DSNS base table 171

Eerror messages

!AOP prefix 199KOGV prefix 199MVS system log 199OB prefix 199online messages 199RKOGLOGM 199TKANTENU dataset 199

estmigrt 50, 52, 53estrelse 50, 52, 53eSupport

customer support 203expressions

definition 100format 100

FFLOAT 102

operands 103floating point number 102fractional values

scaling 39scaling factor 45


fragmentation index 47function codes 89

VUCLOSE 85VUDELETE 76VUDROP 86VUFETCH 83VUINSERT 73VUQUERY 71VUSUBST 79, 80

functionsC2D() 39, 45input handles 33output handles 33prerequisites 33processing sequence 33REDIRECT 88VUCLOSE 85VUDELETE 75VUDROP 86VUFETCH 82VUINSERT 73VUOPEN 80VUQUERY 70VUSUBST 78, 79, 80

Gglossary 209

HHSM 25HSM_CDS base table 175HSM_DS_RV base table 176HSM_FUN_DA base table 177HSM_FUN_ST base table 178HSM_REQS base table 180HSM_STATUS base table 182HSM_STOR base table 184

Iinput handles 33INTEGER

operands 103integer 39

INTEGER2 102INTEGER4 102LONG 102scaling 45SHORT 102

INTEGER4 102

JJOB base table 186

KKOGV prefix messages 199KOGVUX00 44

example 46KOGVUX01 44

example 48KOGVUX02 44

example 50KOGVUX03 44, 58

example 55KOGVUX03hdl 56

3390 DASD volumes 57KOGVUX04 44

example 57KOGVUX99 44KOGVUXSJ 49

Llanguage elements

characters 96data constants 97expressions 100operators 98predicate evaluation 102predicates 101search conditions 104substitution symbols 99

LCU base table 187letters 96LOADLIB 64logging off VU API 59logging on to Candle Management Server 46logical control unit (LCU) 25LOGOFF command 21

LU0 session 31messages 199OG/MVS 31return codes 31syntax 31VU API 59

LOGON command 21example 46LU0 session 29, 46messages 199return codes 30syntax 29VU API 46

LONG 102operands 103

Index 219

LU0 sessionapplname 29logging off 31, 59logging on to 29, 46

Mmaintenance assessment service

MAS 206managed storage environment

Candle Management Server 25OG/MVS 23OMEGAMON II for SMS 23, 25

MASmaintenance assessment service 206

matching formats 39messages

!AOP prefix 199KOGV prefix 199MVS system log 199OB prefix 199RKOGLOGM 199TKANTENU dataset 199

migrthdl 53MSM

multi-services manager 206multi-services manager

MSM 206MVS system log 199

NNAM 63NAME, assigning 29norows argument 88

OOB prefix messages 199OG/MVS

LOADLIB 64LOGOFF command 21LOGON command 21

OMEGAMON external security 29OMEGAMON II for SMS

Candle Management Server 25Candle Subsystem 25components 25DASD Services Status displays 55data, retrieving 25description 25

online messages!AOP prefix 199KOGV prefix 199MVS system log 199

OB prefix 199RKOGLOGM 199TKANTENU dataset 199

operandsBITSTRING 103BOOLEAN 103CHAR 103columnname 103comparison process 103FLOAT 103INTEGER 103LONG 103SHORT 103values 103VARCHAR 103

operator characters 96operators

arithmetic 98comparison 98grouping 98parentheses 98

output handles 33

Pparameters

applids 68pluapplid 65

parenthesesgrouping operators 98

pluapplid 29, 65predicate evaluation 102

column data types 102comparison process 103

predicatesdefinition 101evaluation 102

printing problems 13probes

and base tables 26Candle Management Server 26definition 25

punctuation, in syntax diagrams 10

Qquestion mark 99quotes

double 58in character strings 58, 97single 58

RREDIRECT function 88


example 88release free space

estrelse 50relsehdl 53reqhdl 87request handles 49, 56, 87

in subroutines 52KOGVUX03hdl 56reusing 56, 58

return codes 89LOGOFF command 31LOGON command 30

REXX function packageVUCLOSE() 21VUDELETE() 21VUDROP() 21VUFETCH() 21VUINSERT() 21VUOPEN() 21VUQUERY() 21VUSUBST() 21

REXX manuals 20REXX programs

TKANSAM 44VU Templates 22

REXX shared variablesdeleting 59KOGVUX03hdl 56

RKOGLOGM 199RMF_ENV base table 189rows

defined 26

Sscaling factor 45scaling fractional values 39, 45search conditions 104search criteria 35security

enabling 63LOGON command 44

user ID 29options 63

severity levelscustomer support 203

SHORToperands 103

slash, in syntax diagrams 10SMS storage group 25SMS_CONFIG base table 190SMS_DAT_CL base table 191SMS_MAN_CL base table 193SMS_ST_CL base table 195

SMS_ST_GRP base table 196startup

LOGON 30VU session logon 30

status codes 89Storage Management Subsystem 23, 24

DFSMdfp 24DFSMSdss 24DFSMShsm 24DFSMSrmm 24hardware components 24SMS storage group 25software components 24

subroutinesestmigrt 52estrelse 52KOGVUX03 58request handles 52

substitution symbols 87example 99question mark 99

SYSTEM_ENV base table 198

Ttelephone support

customer support 202template

DF.ACTION 107DF.ACTIONREQ 107DF.ACTIONRESP 109DF.ACTIVEJOB 109DF.CACHECU 110DF.CACHEDETAIL 111DF.CACHEDEVICE 112DF.CACHEENV 112DF.CHANNELPATH 113DF.DASD 113DF.DASDCACHE 114DF.DASDCACHEBYJOBNAME 115DF.DASDCACHEDETAIL 116DF.DASDUSER 117DF.DSBYASID 117DF.DSBYDSNAME 118DF.DSBYJOBNAME 118DF.DSBYVOLUME 119DF.DSENQ 119DF.DSIOBYDSNAME 120DF.DSIOBYJOBNAME 121DF.DSIOBYVOLUME 121DF.DSLOC 122DF.DSSMS 122DF.HSMCDS 122

Index 221

DF.HSMDSRV 123DF.HSMFUNDA 123DF.HSMFUNST 124DF.HSMREQ 124DF.HSMSTATUS 125DF.HSMSTORAGE 125DF.LCU 126DF.LCUIORATE 126DF.RMFENV 127DF.SMSCONFIG 128DF.SMSDATACLASS 128DF.SMSDSBYDSNAME 129DF.SMSDSBYVOLUME 130DF.SMSDSIOBYJOBNAME 131DF.SMSDSIOBYVOLUME 132DF.SMSMANAGEMENTCLASS 133DF.SMSSTORAGECLASS 133DF.SMSSTORAGEGROUP 134DF.SYSTEMENV 134DF.VOLUMEBYJOBNAME 135

time of day trap 57TKANSAM 22

contents 44KOGVUX00 44, 46KOGVUX01 44, 48KOGVUX02 44, 50KOGVUX03 44, 55KOGVUX04 44, 57KOGVUX99 44KOGVUXSJ 49REXX programs 44using REXX programs 44VU API component 21

TKANTENU dataset 199TOD trap 57TRACE, enabling 29traps

time of day 57time of day traps 59

Uunderlining in syntax diagrams 10

VVARCHAR 39, 102

data format 45operands 103

variablesmigrthdl 53relsehdl 53REXX shared variables 59

view

definition 22modifying 34

virtual terminals 68VTAM application

APPLID 29LOGON appltype 29terminating a session 31

VU APIdefinition 21LOGOFF command 21LOGON command 21operating environment 23process 44TKANSAM 21, 44

VU server dialogLU0 session with 29VTAM LU0 APPLID 29

VU session LOGOFF command 31VU session LOGON command 29VU Templates

definition 22modifying 34result table 22template descriptions 35view 22

VU templatesSee also template

VUCLOSE functionfunction codes 85syntax 85

VUDELETE functionfunction codes 76syntax 75usage 75

VUDROP functionfunction codes 86syntax 86

VUFETCH functiondata format 39function codes 83norows argument 88redirecting output 88syntax 82with REDIRECT 88

VUINSERT functionfunction codes 73syntax 73

VUOPEN functionsyntax 80

VUQUERY functioncolumn names 34function codes 71search criteria 35


syntax 70VUSUBST function

function codes 79, 80syntax 78

og/mvs omegamon ii for sms data interface...

Documents