Vous êtes sur la page 1sur 354

Hitachi Command Suite

Tiered Storage Manager for Mainframe


User Guide

Document Organization
Product Version
Getting Help
Contents

MK-92HC207-01

2014 Hitachi, Ltd. All rights reserved.


No part of this publication may be reproduced or transmitted in any form or by any means,
electronic or mechanical, including photocopying and recording, or stored in a database or retrieval
system for any purpose without the express written permission of Hitachi, Ltd.
Hitachi, Ltd., reserves the right to make changes to this document at any time without notice and
assumes no responsibility for its use. This document contains the most current information available
at the time of publication. When new or revised information becomes available, this entire
document will be updated and distributed to all registered users.
Some of the features described in this document might not be currently available. Refer to the most
recent product announcement for information about feature and product availability, or contact
Hitachi Data Systems Corporation at https://portal.hds.com
Notice: Hitachi, Ltd., products and services can be ordered only under the terms and conditions of
the applicable Hitachi Data Systems Corporation agreements. The use of Hitachi, Ltd., products is
governed by the terms of your agreements with Hitachi Data Systems Corporation.
Hitachi is a registered trademark of Hitachi, Ltd., in the United States and other countries. Hitachi
Data Systems is a registered trademark and service mark of Hitachi, Ltd., in the United States and
other countries.
Archivas, Essential NAS Platform, HiCommand, Hi-Track, ShadowImage, Tagmaserve, Tagmasoft,
Tagmasolve, Tagmastore, TrueCopy, Universal Star Network, and Universal Storage Platform are
registered trademarks of Hitachi Data Systems.
AIX, AS/400, DB2, Domino, DS6000, DS8000, Enterprise Storage Server, ESCON, FICON,
FlashCopy, IBM, Lotus, MVS, OS/390, RS/6000, S/390, System z9, System z10, Tivoli, VM/ESA,
z/OS, z9, z10, zSeries, z/VM, and z/VSE are registered trademarks or trademarks of International
Business Machines Corporation.
All other trademarks, service marks, and company names in this document or web site are
properties of their respective owners.
Microsoft product screen shots are reprinted with permission from Microsoft Corporation.
Notice on Export Controls. The technical data and technology inherent in this Document may be
subject to U.S. export control laws, including the U.S. Export Administration Act and its associated
regulations, and may be subject to export or import regulations in other countries. Reader agrees to
comply strictly with all such regulations and acknowledges that Reader has the responsibility to
obtain licenses to export, re-export, or import the Document and any Compliant Products.

ii
Hitachi Tiered Storage Manager for Mainframe User Guide

Contents
Preface.................................................................................................. xi

Intended audience....................................................................................................xii
Product version........................................................................................................ xii
Release notes...........................................................................................................xii
Document revision level............................................................................................ xii
Document organization............................................................................................. xii
Related documents.................................................................................................. xiv
Document conventions............................................................................................. xv
Conventions for storage capacity values.....................................................................xv
Accessing product documentation............................................................................. xvi
Getting help............................................................................................................ xvi
Comments..............................................................................................................xvii

1 Overview of Hitachi Tiered Storage Manager for Mainframe..................... 1-1

About Tiered Storage Manager for Mainframe........................................................... 1-2


Overview of the Tiered Storage Manager for Mainframe functionality..........................1-4
Concepts of terms used in Tiered Storage Manager for Mainframe..............................1-5
About tiering policy groups................................................................................1-5
About tiering policies........................................................................................ 1-6
About tiering policy levels..................................................................................1-8
About the new-page assignment tier..................................................................1-9
Prerequisites for Tiered Storage Manager for Mainframe.......................................... 1-10
System configuration of Tiered Storage Manager for Mainframe............................... 1-11
About files used by Tiered Storage Manager for Mainframe...................................... 1-12
Overview of files used by Tiered Storage Manager for Mainframe....................... 1-12
Workflow for files used in Tiered Storage Manager for Mainframe...................... 1-12
Workflow for using Tiered Storage Manager for Mainframe...................................... 1-13

2 Installation and setup........................................................................... 2-1

Overview of installation and setup............................................................................2-3


Installing Tiered Storage Manager for Mainframe...................................................... 2-4
Workflow for during installation......................................................................... 2-4
Transferring the load module to a host machine................................................. 2-5
Performing an installation using SMP/E...............................................................2-8
Installing directly from the provided datasets in the target library........................ 2-9

iii
Hitachi Tiered Storage Manager for Mainframe User Guide

Library datasets to be registered after the installation........................................2-10


Settings required for using CLI commands (registration for authentication)............... 2-11
Registering the load library for LINKLIB and the KTQRYSMS command for
authentication................................................................................................ 2-11
Example of dynamically linking the LINKLIB load library to LNKLST.................... 2-12
Setting RACF security for CLI commands................................................................ 2-13
Settings for using environment configuration commands..........................................2-14
Registering a user SVC.......................................................................................... 2-15
Registering a user SVC using the KTALCSVC command..................................... 2-15
Registering a user SVC using the IEASVCxx parmlib member............................. 2-17
Setting the operating environment for Tiered Storage Manager for Mainframe (setting
environment variables or system symbols).............................................................. 2-18
About the operating environment for Tiered Storage Manager for Mainframe...... 2-18
List of operating environment setting items for Tiered Storage Manager for
Mainframe......................................................................................................2-19
Setting the operating environment by using environment variables.....................2-19
Setting the operating environment by using system symbols..............................2-21
Settings required to use Tiered Storage Manager for Mainframe on the ISPF panel.... 2-22
Using DD names to concatenate the libraries required for executing the KTSTART
command.......................................................................................................2-23
Using the ALTLIB command and LIBDEF service to concatenate the libraries required
for executing the KTSTART command.............................................................. 2-24
Registering licenses...............................................................................................2-25
Workflow for registering a license.................................................................... 2-25
Creating a license information dataset..............................................................2-26
Registering a license by using a license key file................................................. 2-27
Registering a license by entering a license key.................................................. 2-29
Verifying the setup information.............................................................................. 2-31
Overview of verifying the setup information......................................................2-31
Verifying the setup information........................................................................ 2-31
Preparing to use Tiered Storage Manager for Mainframe..........................................2-32
Calculating required memory........................................................................... 2-32
Settings required for collecting event logs.........................................................2-32
Backing up Tiered Storage Manager for Mainframe to the distribution library...... 2-33
Notes on setting up Tiered Storage Manager for Mainframe when Business Continuity
Manager is already installed...................................................................................2-34
Notes on registering a user SVC if Business Continuity Manager is installed.........2-35
Notes on setting environment variables or system symbols if Business Continuity
Manager is installed........................................................................................ 2-35
Prerequisite user SVC versions for Tiered Storage Manager for Mainframe................ 2-36
Notes for when multiple versions of Tiered Storage Manager for Mainframe coexist... 2-36
Notes on collection of CLI command execution logs...........................................2-36

3 Tiered Storage Manager for Mainframe operations when using the ISPF
panel...................................................................................................3-1

Operation description method for the ISPF panels..................................................... 3-2


Workflow for when defining and checking tiering policy groups when using the ISPF
panel..................................................................................................................... 3-2
Starting Tiered Storage Manager for Mainframe and displaying the main panel........... 3-4
Basic ISPF panel settings of Tiered Storage Manager for Mainframe........................... 3-4
Defining tiering policy groups when using the ISPF panel...........................................3-5
Scanning storage systems when using the ISPF panel......................................... 3-5

iv
Hitachi Tiered Storage Manager for Mainframe User Guide

Creating a tiering policy information CSV file when using the ISPF panel...............3-7
Defining tiering policy groups when using the ISPF panel.................................... 3-8
Applying tiering policies when using the ISPF panel.............................................3-8
Verification after scanning storage systems when using the ISPF panel.......................3-9
Checking volume information for the scanned storage system when using the ISPF
panel............................................................................................................... 3-9
Checking pool information for the scanned storage system when using the ISPF
panel............................................................................................................. 3-11
Verification after defining a tiering policy group when using the ISPF panel...............3-13
Verifying definition information for the tiering policy group when using the ISPF
panel............................................................................................................. 3-14
Verifying storage system information (summary) for the tiering policy group when
using the ISPF panel....................................................................................... 3-15
Checking SMS storage groups belonging to a tiering policy group when using the
ISPF panel......................................................................................................3-16
Verifying volume information for the tiering policy group when using the ISPF panel
..................................................................................................................... 3-17
Verifying pool information for the tiering policy group when using the ISPF panel3-19
Frequently used checking methods when using the ISPF panel.................................3-22
Checking whether the tiering policies are applied to the storage system when using
the ISPF panel................................................................................................3-22
Checking the tier relocation status for volumes when using the ISPF panel......... 3-25
Checking whether the usage of any pool equals or exceeds the threshold when using
the ISPF panel................................................................................................3-26
About changing tiering policy groups when using the ISPF panel.............................. 3-28
Changing a tiering policy when using the ISPF panel......................................... 3-28
Adding a volume to a tiering policy group when using the ISPF panel................. 3-29
Deleting a specific volume from a tiering policy group when using the ISPF panel3-30
Modifying the tiering policy information CSV file when using the ISPF panel........ 3-31
Convenient use of list panels..................................................................................3-31
Sorting items..................................................................................................3-32
Filtering displayed information......................................................................... 3-32
Searching character strings............................................................................. 3-33
Positioning the cursor at a specific line in a sorted field..................................... 3-33
Setting an action in multiple AC fields...............................................................3-34
Customizing the ISPF panels.................................................................................. 3-35
Setting the command line location................................................................... 3-35
Setting the number of displayed function keys.................................................. 3-35
Highlighting available point-and-shoot fields..................................................... 3-35

4 Tiered Storage Manager for Mainframe operations when using the CLI..... 4-1

Defining and verifying a tiering policy group when using the CLI commands............... 4-2
Defining tiering policy groups when using the CLI commands.................................... 4-3
Checking volume information when using the CLI commands.............................. 4-3
Scanning the storage system when using the CLI commands...............................4-5
Creating a tiering policy information CSV file when using the CLI commands........ 4-7
Defining tiering policy groups when using the CLI commands.............................. 4-7
Applying tiering policies when using the CLI commands...................................... 4-9
Verification after defining a tiering policy group when using the CLI commands.........4-11
Verifying tiering policies when using the CLI commands.................................... 4-11
Checking the progress of tier relocation when using the CLI commands..............4-12
Checking volume I/O performance................................................................... 4-14

v
Hitachi Tiered Storage Manager for Mainframe User Guide

About changing tiering policy groups when using the CLI commands........................ 4-15
Changing a tiering policy when using the CLI commands................................... 4-15
Adding a volume to a tiering policy group when using the CLI commands........... 4-15
Deleting a specific volume from a tiering policy group when using the CLI commands
..................................................................................................................... 4-17

5 ISPF panels ......................................................................................... 5-1

Panel relationships of Tiered Storage Manager for Mainframe.................................... 5-3


Common items in the panel..................................................................................... 5-4
About the layout of the panels...........................................................................5-4
About the action bar......................................................................................... 5-4
About the AC and COMMAND fields....................................................................5-5
About point-and-shoot field............................................................................... 5-7
About the display unit..................................................................................... 5-12
Device Scan Scope panel ...................................................................................... 5-12
Edit Defaults panel ...............................................................................................5-13
Error Code Help panel .......................................................................................... 5-14
Exception Message List panel ................................................................................5-15
Main panel............................................................................................................5-16
Main panel (common)..................................................................................... 5-16
Installation Management area..........................................................................5-17
Set Defaults area ........................................................................................... 5-18
Storage System List area.................................................................................5-19
Policy CSV List area.........................................................................................5-20
Tiering Policy Group List area.......................................................................... 5-21
Manage Licenses panel .........................................................................................5-22
Policy ID Entry panel ............................................................................................ 5-22
Pool Selection List panel ....................................................................................... 5-23
Pool Status Detail panel ........................................................................................5-24
Setting Information panel...................................................................................... 5-25
Tiering Policy Group Definition panel...................................................................... 5-26
Tiering Policy Group Pool List panel........................................................................ 5-27
Tiering Policy Group Pool Status Detail panel.......................................................... 5-28
Tiering Policy Group Storage Group List panel......................................................... 5-30
Tiering Policy Group Summary panel...................................................................... 5-31
Tiering Policy Group Volume List panel................................................................... 5-33
Tiering Policy Group Volume Status Detail panel......................................................5-35
Volume Selection List panel................................................................................... 5-36
Volume Status Detail panel.................................................................................... 5-37

6 CLI commands..................................................................................... 6-1

List of CLI Commands............................................................................................. 6-2


CLI command coding format....................................................................................6-3
REXX external routine coding format..................................................................6-4
TSO/E command coding format......................................................................... 6-4
OS console command coding format.................................................................. 6-5
REXX external routine details................................................................................... 6-5
KTACTTPG....................................................................................................... 6-5
KTDCTDEV.......................................................................................................6-6
KTDCTTPG....................................................................................................... 6-8
KTGETHDA.......................................................................................................6-9

vi
Hitachi Tiered Storage Manager for Mainframe User Guide

KTIMPORT..................................................................................................... 6-12
KTLOAD......................................................................................................... 6-14
KTQRYDEV.....................................................................................................6-17
KTQRYRLC..................................................................................................... 6-19
KTQRYTPG..................................................................................................... 6-21
KTQSTATS..................................................................................................... 6-23
KTSCAN......................................................................................................... 6-25
KTSTORE....................................................................................................... 6-28
KTWTOMSG................................................................................................... 6-32
TSO/E command details........................................................................................ 6-34
KTCONMSG.................................................................................................... 6-34
KTENV........................................................................................................... 6-36
KTERCODE.....................................................................................................6-37
KTINSCHK......................................................................................................6-39
KTSLEEP........................................................................................................ 6-41
OS console command details................................................................................. 6-42
KTALCSVC......................................................................................................6-42
KTDSPENV..................................................................................................... 6-43
KTSETENV......................................................................................................6-45

7 Files used by Tiered Storage Manager for Mainframe...............................7-1

File naming conventions used by Tiered Storage Manager for Mainframe.................... 7-2
Format of datasets used by Tiered Storage Manager for Mainframe............................7-3
Disk space requirements of configuration files...........................................................7-3
Format of tiering policy information CSV files............................................................ 7-4
Descriptive conventions of tiering policy information CSV files..............................7-4
Syntax of tiering policy information CSV files...................................................... 7-4
Configuration example of tiering policy groups and example of specifications in the
corresponding tiering policy information CSV file................................................. 7-8
Examples of changing a tiering policy information CSV file...................................7-9

8 REXX variable structures....................................................................... 8-1

List of REXX variable structures................................................................................8-2


Message structure...................................................................................................8-2
Host-discovered array index structure...................................................................... 8-3
Host-discovered array structure............................................................................... 8-4
Tiering policy group structure.................................................................................. 8-9
Device information structure.................................................................................. 8-10

9 Collecting trace information and logs......................................................9-1

Information that can be used for troubleshooting......................................................9-2


Collecting trace information..................................................................................... 9-2
Collecting trace information when using scripts...................................................9-2
Collecting trace information when using TSO/E................................................... 9-2
Log types for Tiered Storage Manager for Mainframe................................................ 9-3
Collecting event logs............................................................................................... 9-4
How to collect event logs.................................................................................. 9-4
About event log output datasets........................................................................ 9-4
Collecting event logs by using the system logger service............................................9-5
Settings for collecting event logs when using the system logger service................9-5

vii
Hitachi Tiered Storage Manager for Mainframe User Guide

Setting LOGR couple data sets...........................................................................9-6


Defining the SMS for the system logger service...................................................9-6
Defining a log stream........................................................................................9-6
Setting access privileges for system logger resources.......................................... 9-7
Starting the system logger service..................................................................... 9-7
Parameters specified when a log stream is defined............................................. 9-8
JCL example for confirming a log stream.......................................................... 9-10
JCL example for deleting a log stream.............................................................. 9-10
Preventing the event log from becoming full when the system logger service is used
..................................................................................................................... 9-10
Re-defining the log stream when the event log is full........................................ 9-11
Restarting the system logger service and re-defining the log stream when the event
log is full........................................................................................................ 9-11
Disk space requirements for the event log when the system logger service is used
..................................................................................................................... 9-12
Overview of the event log data output tool....................................................... 9-13
Outputting logs by using the event log data output tool.....................................9-13
Control statements for the event log data output tool........................................9-14
Output format of the event log data output tool................................................9-15
Collecting event logs without using the system logger service.................................. 9-16
Allocating log datasets without using the system logger service......................... 9-16
Writing to a log dataset without using the system logger service........................ 9-17
Disk space requirements for the event log when the system logger service is not
used.............................................................................................................. 9-18
Collecting ISPF logs...............................................................................................9-19
Checking ISPF logs......................................................................................... 9-19
Preventing the ISPF log dataset from becoming full...........................................9-19
Collecting the CLI command-execution log..............................................................9-20
Extracting CLI command-execution logs by using an ISPF editor........................ 9-20
Extracting CLI command-execution logs by using an extraction script................. 9-21

A XML document type definitions for configuration files..............................A-1

Elements common to configuration files................................................................... A-2


APIInfo element............................................................................................... A-2
DiskDevice element.......................................................................................... A-2
Elements in the disk configuration definition file........................................................A-3
HostDiscoveredArray element............................................................................A-3
SoftwareKeys element...................................................................................... A-3
POOL element..................................................................................................A-4
PoolTier element.............................................................................................. A-4
HostAddressedDisk element.............................................................................. A-5
Elements in the tiering policy group definition file..................................................... A-5
TieringPolicyGroup element...............................................................................A-5
TieringPolicy element........................................................................................A-6
Example of files used by Tiered Storage Manager for Mainframe................................ A-6
Example of the specifications in a tiering policy information CSV file.....................A-7
Example of a disk configuration definition file that is generated........................... A-7
Example of a tiering policy group definition file that is generated......................... A-8

B Commands that can be used in the ISPF panels......................................B-1

ERRCODE...............................................................................................................B-2

viii
Hitachi Tiered Storage Manager for Mainframe User Guide

FILTER...................................................................................................................B-2
FIND......................................................................................................................B-3
LOCATE................................................................................................................. B-3
RFIND....................................................................................................................B-4
SELECT..................................................................................................................B-4
SORT.....................................................................................................................B-5
How to specify the search or filter conditions in ISPF panels...................................... B-6

C Sample scripts......................................................................................C-1

List of sample scripts.............................................................................................. C-2


Details about sample scripts.................................................................................... C-3
KTDEMO00 (Create a disk configuration definition file)........................................C-3
KTDEMO01 (Display the contents of the disk configuration definition file)............. C-5
KTDEMO02 (Create a tiering policy group definition file)......................................C-8
KTDEMO03 (Display the contents of the tiering policy group definition file).........C-10
KTDEMO04 (Display the volume information)....................................................C-11
KTDEMO05 (Change the tiering policy of a volume back to the default).............. C-14
KTDEMO10 (Apply the tiering policy)................................................................C-15
KTDEMO11 (Check the tiering policy)...............................................................C-16
KTDEMO12 (Check the page relocation status)................................................. C-18
KTDEMO13 (Check the relocation progress)......................................................C-20
KTDEMO14 (Check I/O performance information)............................................. C-26

D Upgrading Tiered Storage Manager for Mainframe..................................D-1

Workflow for upgrading Tiered Storage Manager for Mainframe.................................D-2


Preparation for upgrading Tiered Storage Manager for Mainframe..............................D-3
Checking the setting values of the operating environment...................................D-3
Creating a backup............................................................................................ D-3
Deleting the user SVC by using the KTALCSVC environment setup command........D-4
Deleting the user SVC from the IEASVCxx parmlib member................................. D-4
Removing the library linkage.............................................................................D-5
Upgrading Tiered Storage Manager for Mainframe.................................................... D-6

E Modifying the sample JCL......................................................................E-1

Values used in the sample JCL modification examples................................................E-2


ALLOUPLD (creating datasets used for transfers)...................................................... E-2
RECVUPLD (TSO/E RECEIVE processing).................................................................. E-4
HDSKTSIN (performing installation without using SMP/E).......................................... E-5
SMPALLOC (allocating SMP/E datasets).................................................................... E-7
HDSKT1AL (allocating the distribution library and target library).................................E-9
HDSKT2DF (defining the distribution library and target library).................................E-11
HDSKT3RC (SMP/E RECEIVE processing)................................................................ E-15
HDSKT4AP (creating target libraries)...................................................................... E-16
HDSKT5AC (creating distribution libraries).............................................................. E-18

F Command syntax descriptions................................................................F-1

Command syntax descriptions..................................................................................F-2

Acronyms and abbreviations


ix
Hitachi Tiered Storage Manager for Mainframe User Guide

Glossary
Index

x
Hitachi Tiered Storage Manager for Mainframe User Guide

Preface
This document describes how to install, configure, and use the Hitachi Tiered
Storage Manager for Mainframe.
Hereafter, the above product is simply called Tiered Storage Manager for
Mainframe. In figures, the product is indicated as HTSM for MF.
This preface includes the following information:
Intended audience
Product version
Release notes
Document revision level
Document organization
Related documents
Document conventions
Conventions for storage capacity values
Accessing product documentation
Getting help
Comments

Preface
Hitachi Tiered Storage Manager for Mainframe User Guide

xi

Intended audience
This document is intended for those who:

Want to create a storage system that uses Tiered Storage Manager for
Mainframe, and to operate the system at high performance.

This document is intended for readers who are familiar with the following:

z/OS functionality

Hitachi Virtual Storage Platform and Hitachi Dynamic Tiering for


Mainframe

Product version
This document revision applies to Hitachi Tiered Storage Manager for
Mainframe version 8.0.0 or later.

Release notes
Read the release notes before installing and using this product. They may
contain requirements or restrictions that are not fully described in this
document or updates or corrections to this document.

Document revision level


Revision

Date

Description

MK-92HC207-00

July 2013

Initial Release

MK-92HC207-01

April 2014

Revision 1, supersedes and replaces


MK-92HC207-00

Document organization
The following table provides an overview of the contents and organization of
this document. Click the chapter title in the left column to go to that chapter.
The first page of each chapter provides links to the sections in that chapter.
Chapter/Appendix

xii

Description

Chapter 1, Overview of Hitachi Tiered Storage


Manager for Mainframe on page 1-1

Provides an overview of Tiered


Storage Manager for Mainframe.

Chapter 2, Installation and setup on page 2-1

Describes how to install and set up


Tiered Storage Manager for
Mainframe.

Preface
Hitachi Tiered Storage Manager for Mainframe User Guide

Chapter/Appendix

Description

Chapter 3, Tiered Storage Manager for


Describes how to use the ISPF panels
Mainframe operations when using the ISPF panel to operate Tiered Storage Manager for
Mainframe.
on page 3-1
Chapter 4, Tiered Storage Manager for
Mainframe operations when using the CLI on
page 4-1

Describes how to use CLI commands


to operate Tiered Storage Manager for
Mainframe.

Chapter 5, ISPF panels on page 5-1

Describes transition, operation


methods, and displayed items of the
ISPF panel in Tiered Storage Manager
for Mainframe.

Chapter 6, CLI commands on page 6-1

Describes the functionality of the


commands that can be used from the
CLI of Tiered Storage Manager for
Mainframe.

Chapter 7, Files used by Tiered Storage Manager Describes the formats of files that are
for Mainframe on page 7-1
used for Tiered Storage Manager for
Mainframe.
Chapter 8, REXX variable structures on page
8-1

Describes the REXX variable structures


used by Tiered Storage Manager for
Mainframe.

Chapter 9, Collecting trace information and logs


on page 9-1

Describes the trace information and


logging of Tiered Storage Manager for
Mainframe.

Appendix A, XML document type definitions for


configuration files on page A-1

Describes the structure of


configuration files of Tiered Storage
Manager for Mainframe.

Appendix B, Commands that can be used in the


ISPF panels on page B-1

Describes the commands that can be


used in the ISPF panels of Tiered
Storage Manager for Mainframe.

Appendix C, Sample scripts on page C-1

Describes the sample scripts of Tiered


Storage Manager for Mainframe.

Appendix D, Upgrading Tiered Storage Manager


for Mainframe on page D-1

Describes how to update the version


of Tiered Storage Manager for
Mainframe.

Appendix E, Modifying the sample JCL on page


E-1

Provides examples of modifying the


sample job control language (JCL) of
Tiered Storage Manager for
Mainframe.

Appendix F, Command syntax descriptions on


page F-1

Describes the symbols used in syntax


explanations and the syntax elements
that are used.

Acronyms and abbreviations on page Acronyms-1 Defines the acronyms and


abbreviations used in this document.
Glossary on page Glossary-1

Defines the special terms used in this


document.

Index

Lists the topics in this document in


alphabetical order.

Preface
Hitachi Tiered Storage Manager for Mainframe User Guide

xiii

Related documents

A manual and document related to Tiered Storage Manager for


Mainframe:

Hitachi Business Continuity Manager User Guide, MK-94RD247

Hitachi Business Continuity Manager Messages, MK-94RD262

Hitachi Business Continuity Manager Installation Guide, MK-95HC104

Hitachi Business Continuity Manager Reference Guide, MK-96HC135

A manual related to Hitachi Command Suite products:

Hitachi Command Control Interface User Guide, MK-90RD7010


Hitachi Virtual Storage Platform Provisioning Guide for Mainframe,
MK-90RD7021
Hitachi Virtual Storage Platform Hitachi Storage Navigator User Guide,
MK-90RD7027

Manuals related to z/OS:

xiv

Hitachi Command Suite Software User Guide, MK-90HC172

Manuals related to storage systems:

Hitachi Tiered Storage Manager for Mainframe Release Notes,


RN-92HC208

Manuals related to Business Continuity Manager:

Hitachi Command Suite Tiered Storage Manager for Mainframe


Messages, MK-92HC210

MVS Initialization and Tuning Reference, SA22-7592


MVS Programming: Assembler Services Reference, SA22-7606,
SA22-7607

MVS Setting Up a Sysplex, SA22-7625

MVS System Codes, SA22-7626

MVS System Commands, SA22-7627

Security Server RACF Security Administrator's Guide, SA22-7683

Security Server RACROUTE Macro Reference, SA88-8621

TSO/E Customization, SA22-7783

TSO/E Messages, SA22-7786

TSO/E Programming Services, SA22-7789

TSO/E REXX Reference, SA22-7790

TSO/E System Programming Command Reference, SA22-7793

MVS Programming: Assembler Services Guide, SA88-8577

DFSMS: Using Data Sets, SC26-7410

DFSMSdfp Utilities, SC26-7414

ISPF User's Guide Volume I, SC34-4822

DFSMS Advanced Copy Services, SC35-0428

Preface
Hitachi Tiered Storage Manager for Mainframe User Guide

Document conventions
This document uses the following typographic conventions:
Convention

Description

Bold

Indicates text on a window, including menus, menu options, buttons,


fields, and labels. Example: Click OK.

Italic

Indicates a variable, which is a placeholder for actual text provided


by the user or system. Example: copy source-file target-file
Note: Angled brackets (< >) are also used to indicate variables.

Monospace

Indicates text that is displayed on screen or entered by the user.


Example: # pairdisplay -g oradb

< > angled


brackets

Indicates a variable, which is a placeholder for actual text provided


by the user or system. Example: # pairdisplay -g <group>
Note: Italic font is also used to indicate variables.

[ ] square
brackets

Indicates optional values. Example: [ a | b ] indicates that you can


choose a, b, or nothing.

{ } braces

Indicates required or expected values. Example: { a | b } indicates


that you must choose either a or b.

| vertical bar

Indicates that you have a choice between two or more options or


arguments. Examples: [ a | b ] indicates that you can choose a, b, or
nothing. { a | b } indicates that you must choose either a or b.

This document uses the following icons to draw attention to information:


Icon

Label

Description

Note

Calls attention to important and/or additional information.

Tip

Provides helpful information, guidelines, or suggestions for


performing tasks more effectively.

Caution

Warns the user of adverse conditions and/or consequences


(e.g., disruptive operations).

WARNING

Warns the user of severe conditions and/or consequences


(e.g., destructive operations).

Conventions for storage capacity values


Physical storage capacity values (for example, disk drive capacity) are
calculated based on the following values:
Physical capacity unit
1 kilobyte (KB)

Value
1,000 (103) bytes

Preface
Hitachi Tiered Storage Manager for Mainframe User Guide

xv

Physical capacity unit

Value

1 megabyte (MB)

1,000 KB or 1,0002 bytes

1 gigabyte (GB)

1,000 MB or 1,0003 bytes

1 terabyte (TB)

1,000 GB or 1,0004 bytes

1 petabyte (PB)

1,000 TB or 1,0005 bytes

1 exabyte (EB)

1,000 PB or 1,0006 bytes

Logical storage capacity values (for example, logical device capacity) are
calculated based on the following values:
Logical capacity unit

Value

1 block

512 bytes

1 KB

1,024 (210) bytes

1 MB

1,024 KB or 1,0242 bytes

1 GB

1,024 MB or 1,0243 bytes

1 TB

1,024 GB or 1,0244 bytes

1 PB

1,024 TB or 1,0245 bytes

1 EB

1,024 PB or 1,0246 bytes

Accessing product documentation


The Tiered Storage Manager for Mainframe user documentation is available
on the Hitachi Data Systems Portal: https://portal.hds.com. Check this
site for the most current documentation, including important updates that
may have been made after the release of the product.

Getting help
Hitachi Data Systems Support Portal is the destination for technical support of
your current or previously-sold storage systems, midrange and enterprise
servers, and combined solution offerings. The Hitachi Data Systems customer
support staff is available 24 hours a day, seven days a week. If you need
technical support, log on to the Hitachi Data Systems Support Portal for
contact information: https://portal.hds.com.
Hitachi Data Systems Community is a new global online community for HDS
customers, partners, independent software vendors, employees, and
prospects. It is an open discussion among these groups about the HDS
portfolio of products and services. It is the destination to get answers,
discover insights, and make connections. The HDS Community complements
our existing Support Portal and support services by providing an area where

xvi

Preface
Hitachi Tiered Storage Manager for Mainframe User Guide

you can get answers to non-critical issues and questions. Join the
conversation today! Go to community.hds.com, register, and complete
your profile.

Comments
Please send us your comments on this document: doc.comments@hds.com.
Include the document title and number, including the revision level (for
example, -07), and refer to specific sections and paragraphs whenever
possible. All comments become the property of Hitachi Data Systems
Corporation.
Thank you!

Preface
Hitachi Tiered Storage Manager for Mainframe User Guide

xvii

xviii

Preface
Hitachi Tiered Storage Manager for Mainframe User Guide

1
Overview of Hitachi Tiered Storage
Manager for Mainframe
This chapter provides an overview of Tiered Storage Manager for Mainframe.
About Tiered Storage Manager for Mainframe
Overview of the Tiered Storage Manager for Mainframe functionality
Concepts of terms used in Tiered Storage Manager for Mainframe
Prerequisites for Tiered Storage Manager for Mainframe
System configuration of Tiered Storage Manager for Mainframe
About files used by Tiered Storage Manager for Mainframe
Workflow for using Tiered Storage Manager for Mainframe

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

1-1

About Tiered Storage Manager for Mainframe


Tiered Storage Manager for Mainframe is software that works together with
Hitachi Dynamic Tiering for Mainframe to help users manage the data on
volumes tiered to multiple kinds of storage media, such as SSD, SAS, and
SATA.
Data saved on tiered volumes can be relocated to the appropriate tier based
on the access frequency by a process called tier relocation. The following
figure shows an overview of tier relocation. Data that is accessed frequently
is moved to an upper tier, which consists of higher-speed storage media, and
data that is not so frequently accessed is moved to a lower tier, which
consists of lower-speed storage media.

Figure 1-1 Automatic data relocation across tiers according to the access
frequency
After considering the performance requirements for certain data, if you want
to locate the data in a tier appropriate for the requirements, you can directly
specify the tier in which the data is to be located. For example, you can
locate data that is not accessed frequently but requires quick response in an
upper tier.

Figure 1-2 Locating data in a specified tier according to performance


requirements

1-2

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

If only Dynamic Tiering for Mainframe is being used, a storage administrator


uses either Storage Navigator or Command Control Interface to manage
storage on a pool or volume basis.
If Dynamic Tiering for Mainframe is linked with Tiered Storage Manager for
Mainframe, the mainframe administrator can directly manage tiers because
the following operations can be performed:

Specification of the management target on an SMS storage group basis,


which mainframe administrators can use for storage management.

Specification of the management target on a volume basis by using


device addresses (DEVN or VOLSER) that the host has.

Creation of a group of SMS storage groups or volumes, and specification


of them all at one time as a single group.

Management from the mainframe administrator's perspective can be used for


tiers in which data is to be located. This means that the mainframe
administrator can manage storage according to the operating requirements,
thus reducing the storage administrator's work. This allows you to use
resources efficiently and maintain SLA, without degrading ROI or OPEX.
The following figure shows an overview of tier management using Tiered
Storage Manager for Mainframe.

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

1-3

Figure 1-3 Tier management using Tiered Storage Manager for Mainframe

Overview of the Tiered Storage Manager for Mainframe


functionality
The functionality provided by Tiered Storage Manager for Mainframe features
tier management based on tiering policy groups. It also features tier
management in conjunction with SMS, and acquisition of configuration
information of storage systems. The following is a brief overview of this
functionality:

Tier management based on tiering policy groups

1-4

Defining tiering policy groups


You can define information related to tier relocation processing, such
as grouping of objects subject to tier management and the new-page

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

assignment tier. The definitions take effect when a command is used


to apply the definitions to the storage system.

Acquisition of information related to Dynamic Tiering for Mainframe


The access frequency, data location status, and other information
related to Dynamic Tiering for Mainframe can be acquired for each
tiering policy group.

Tier management in conjunction with SMS


The tiers in which data is to be located can be managed, on an SMS
storage group basis, in conjunction with SMS.

Acquisition of the configuration information of storage systems (scan)


Information about volumes and pools can be acquired by scanning the
storage systems using the SMS storage group name, DEVN, or VOLSER as
a key. The acquired information can be used to define tiering policy
groups.

Tip: There are two methods of operation for Tiered Storage Manager for
Mainframe using ISPF panels and using CLI commands. Use the method that
suits the state of operation.

Related topics

About tiering policy groups on page 1-5

Concepts of terms used in Tiered Storage Manager for


Mainframe
This section describes the terms used in Tiered Storage Manager for
Mainframe.

About tiering policy groups


A tiering policy group is a group of multiple SMS storage groups and volumes.
Specification of the tier in which data is to be located, acquisition of
information, and other operations can be performed on a tiering policy group
basis.
The following figure shows the possible grouping patterns of tiering policy
groups.

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

1-5

Figure 1-4 Grouping patterns of tiering policy groups

About tiering policies


A tiering policy is information about the tiers in which data will be located and
about the processing of tier relocation.
You can specify a tiering policy prior to defining a tiering policy group. After
you define a tiering policy group, you must apply the specified tiering policy
to the storage system.
For example, you have applied a tiering policy that locates data in Tier 1
(SSD) and Tier 2 (SAS) for a volume. In this case, when tier relocation takes
place, pages are assigned to tiers 1 and 2, and then data is located on those
pages.
The following figure shows an overview of processing related to tiering
policies.

1-6

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Figure 1-5 Overview of tiering policies


A tiering policy can be specified by using a tiering policy information CSV file.
In a tiering policy information CSV file, the following information can be
specified:

Where data is to be located (tiering policy level)

Tier to which new pages are to be assigned (new-page assignment tier)

Whether to execute tier relocation

Related topics

About tiering policy levels on page 1-8

About the new-page assignment tier on page 1-9

Format of tiering policy information CSV files on page 7-4

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

1-7

About tiering policy levels


Tiering policy levels indicate categories of tiers in which data can be located.
There are six tiering policy levels, from 0 (default) to 5. If a tiering policy
level is specified, data is located in the tier or tiers with the specified level
when tier relocation is performed.
For example, if the tiering policy level of 1 is specified for a volume that has
three tiers, all pages on the volumes are moved to Tier 1, as shown in the
following figure. Pages that have been moved will not be moved to other tiers
when tier relocation is performed again.

Figure 1-6 When the tiering policy level of 1 is specified for a three-tier
volume
If the tiering policy level of 2 is specified for a volume that has three tiers,
pages are moved between tiers 1 and 2 according to the access frequency, as
shown in the figure below. After pages are moved, these pages are moved
between tiers 1 and 2 according to the access frequency each time tier
relocation is performed.

Figure 1-7 When the tiering policy level of 2 is specified for a three-tier
volume
The following shows the relationship between tiering policy levels and the
tiers in which data will be located.

1-8

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Table 1-1 Relationship between tiering policy levels and tiers in which
data will be located
Tiering policy
level

Tier in which data will be located


3-tier configuration

2-tier configuration

All tiers (tiers 1, 2, and 3)

All tiers (tiers 1 and 2)

Tier 1

Tier 1

Tiers 1 and 2

All tiers (tiers 1 and 2)

Tier 2

All tiers (tiers 1 and 2)

Tiers 2 and 3

All tiers (tiers 1 and 2)

Tier 3

Tier 2

Note:
The smaller the tier number, the higher the tier. For example, if an SSD
device and an SAS device make up a tiered volume, the SSD device is
Tier 1, and the SAS device is Tier 2.

About the new-page assignment tier


The new-page assignment tier is the tier to which new pages are assigned the
first time the host writes data to the volume.
For the tiers with a specified tiering policy level, the priority assigned to new
pages is determined by the combination of the values specified for the tiering
policy level and new-page assignment tier.
For example, if 0 is specified as the tiering policy level and MIDDLE is specified
as the new-page assignment tier for a three-tier volume, the priority of three
tiers is as follows: Tier 2 > Tier 3 > Tier 1. The figure below shows how pages
are assigned in this case. First, pages are assigned to Tier 2, which is the
highest priority. If Tier 2 becomes full, pages are assigned to Tier 3. If Tier 3
becomes full, pages are assigned to Tier 1.

Figure 1-8 Overview of assigning new pages to tiers


The following table describes the values that can be used to specify the newpage assignment tier.

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

1-9

Table 1-2 Values that can be used to specify the new-page assignment tier
Value
HIGH

Description
The new page is assigned from the higher tier of tiers set in the tiering policy.

MIDDLE The new page is assigned from the middle tier of tiers set in the tiering policy.
LOW

The new page is assigned from the lower tier of tiers set in the tiering policy.

For example, if newer data is accessed more frequently and older data is
accessed less frequently, you can specify HIGH for the new-page assignment
tier because new pages are then assigned in order starting from the upper
tier.

Related topics

About tiering policy levels on page 1-8

Prerequisites for Tiered Storage Manager for Mainframe


This section describes the prerequisites for Tiered Storage Manager for
Mainframe.

Prerequisite OS
z/OS from V1R10 through V2R1
Caution: VM environments are not supported by Tiered Storage Manager for
Mainframe.

Prerequisite hardware
VSP Dynamic Tiering for Mainframe volumes
Caution: The following volumes are not supported:

Volumes of a remote storage system

Volumes without a host device number assigned

Prerequisite programs

1-10

DFSMS (standard OS component)

ISPF (standard OS component)

TSO/E REXX (standard OS component)

TSO/E (standard OS component)

Security Server (RACF) (standard OS component)

Alternate Library for REXX (standard OS component) or IBM Library for


REXX on zSeries Release 4 (FMID HWJ9140)

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Hitachi Dynamic Provisioning for Mainframe

Hitachi Dynamic Tiering for Mainframe

System configuration of Tiered Storage Manager for


Mainframe
The following figure shows the system configuration of Tiered Storage
Manager for Mainframe.

Figure 1-9 System configuration of Tiered Storage Manager for Mainframe


Caution: The storage system must be connected to the z/OS host.

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

1-11

About files used by Tiered Storage Manager for Mainframe


This section describes the files used by Tiered Storage Manager for
Mainframe.

Overview of files used by Tiered Storage Manager for Mainframe


Tiered Storage Manager for Mainframe manages disk configurations and
tiering policy groups by using information defined in files.
Tiered Storage Manager for Mainframe uses the following three types of files:

Tiering policy information CSV file


A user-created CSV file that contains information about volumes or an
SMS storage group to be defined as a tiering policy group.

Disk configuration definition file


A file that defines storage system configuration information. This file is
created by scanning a storage system.

Tiering policy group definition file


A file that defines a tiering policy group. This file is created by importing a
tiering policy information CSV file and a disk configuration definition file.

The disk configuration definition file and tiering policy group definition file are
generically called configuration files.

Workflow for files used in Tiered Storage Manager for Mainframe


The following describes the workflow for files used in Tiered Storage Manager
for Mainframe.
The numbers in the figure correspond to the steps.

1-12

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Figure 1-10 Workflow for files used in Tiered Storage Manager for
Mainframe
1.

Scan the storage system.


A disk configuration definition file is created.

2.

Create a tiering policy information CSV file.


In the CSV file, the user specifies the information for the volumes or SMS
storage groups to be defined in a tiering policy group.

3.

Import a disk configuration definition file and a tiering policy information


CSV file to define a tiering policy group.
A tiering policy group definition file is created.

4.

Apply the tiering policies of the defined tiering policy group to the storage
system.
The pages will be relocated according to the defined tiering policies when
tier relocation is performed the next time.

Workflow for using Tiered Storage Manager for Mainframe


The following figure shows the workflow for using Tiered Storage Manager for
Mainframe.

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

1-13

Figure 1-11 workflow for using Tiered Storage Manager for Mainframe

Related topics

1-14

Workflow for when defining and checking tiering policy groups when using
the ISPF panel on page 3-2

Defining and verifying a tiering policy group when using the CLI
commands on page 4-2

Overview of Hitachi Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

2
Installation and setup
This chapter describes procedures for installing and setting up Tiered Storage
Manager for Mainframe.
Overview of installation and setup
Installing Tiered Storage Manager for Mainframe
Settings required for using CLI commands (registration for
authentication)
Setting RACF security for CLI commands
Settings for using environment configuration commands
Registering a user SVC
Setting the operating environment for Tiered Storage Manager for
Mainframe (setting environment variables or system symbols)
Settings required to use Tiered Storage Manager for Mainframe on the
ISPF panel
Registering licenses
Verifying the setup information
Preparing to use Tiered Storage Manager for Mainframe
Notes on setting up Tiered Storage Manager for Mainframe when Business
Continuity Manager is already installed

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-1

Prerequisite user SVC versions for Tiered Storage Manager for Mainframe
Notes for when multiple versions of Tiered Storage Manager for
Mainframe coexist

2-2

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Overview of installation and setup


The following figure provides an overview of how to install and set up Tiered
Storage Manager for Mainframe.

Figure 2-1 Overview of installation and setup


#1
A user SVC, environment variables, and system symbols of Tiered
Storage Manager for Mainframe are shared with Business Continuity
Manager. Therefore, special care is needed in an environment where
Business Continuity Manager is installed.
#2

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-3

If you are not using SMP/E for the installation, you do not need to create
a backup in the distribution library.

Related topics

Installing Tiered Storage Manager for Mainframe on page 2-4

Settings required for using CLI commands (registration for


authentication) on page 2-11

Setting RACF security for CLI commands on page 2-13

Settings for using environment configuration commands on page 2-14

Registering a user SVC on page 2-15

Setting the operating environment for Tiered Storage Manager for


Mainframe (setting environment variables or system symbols) on page
2-18

Settings required to use Tiered Storage Manager for Mainframe on the


ISPF panel on page 2-22

Registering licenses on page 2-25

Verifying the setup information on page 2-31

Calculating required memory on page 2-32

Settings required for collecting event logs on page 2-32

Backing up Tiered Storage Manager for Mainframe to the distribution


library on page 2-33

Notes on setting up Tiered Storage Manager for Mainframe when Business


Continuity Manager is already installed on page 2-34

Installing Tiered Storage Manager for Mainframe


This section provides an overview and the procedure for installing Tiered
Storage Manager for Mainframe.

Workflow for during installation


After transferring the load module for Tiered Storage Manager for Mainframe
to a host machine, you can install Tiered Storage Manager for Mainframe
using SMP/E. Alternatively, you can install it directly in the target library
without using SMP/E.
The following figure illustrates the workflow when installing Tiered Storage
Manager for Mainframe.

2-4

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Figure 2-2 Workflow for during installation of Tiered Storage Manager for
Mainframe

Related topics

Transferring the load module to a host machine on page 2-5

Performing an installation using SMP/E on page 2-8

Installing directly from the provided datasets in the target library on page
2-9

Transferring the load module to a host machine


Transfer the load module for Tiered Storage Manager for Mainframe provided
on the installation media to a host machine. During the transfer procedure,
use the JCLs provided on the installation media to create datasets used for
transfers and to extract the provided datasets.
The procedure for transferring the load module for Tiered Storage Manager
for Mainframe, which is provided on the installation media, to a host machine
is illustrated in the following figure.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-5

Figure 2-3 Procedure for transferring the load module for Tiered Storage
Manager for Mainframe to a host machine
The numbers in the figure correspond to the steps below.

Procedure
1.

2.

2-6

Copy the following files provided on the installation media to a PC:

ALLOUPLD (JCL for creating datasets used for transfers)

RECVUPLD (JCL for extracting the provided datasets (TSO/E RECEIVE))

Tiered Storage Manager for Mainframe object archives

Transfer the following JCLs from the PC to a mainframe host in ASCII


mode:

ALLOUPLD

RECVUPLD

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

3.

Edit the JCLs transferred in accordance with your installation


environment.
Details are provided at the beginning of each JCL.

4.

Create datasets used for transfers.


Execute the ALLOUPLD job that was edited in step 3. This job defines the
datasets on the mainframe host that the Tiered Storage Manager for
Mainframe files will be transferred into in the next step.

5.

Transfer the Tiered Storage Manager for Mainframe object archives from
the PC to the mainframe host.
In binary mode, transfer the Tiered Storage Manager for Mainframe
object archives from the PC to the sequential datasets (created in step 4)
on the mainframe host.

6.

Extract (execute the TSO/E RECEIVE command) the provided datasets


from the object archives that were transferred.
Execute the RECVUPLD job that was edited in step 3. This job extracts the
product datasets from the object archives transferred in step 5.

The files provided on the installation media are shown in the following table.

Table 2-1 Files provided on the installation media


No.

File name

Description

HITACHI.CHKTnnn.SMPMCS.XMIT

The SMP/E control statement for Tiered Storage


Manager for Mainframe used for SYSMOD
packaging (information to be referred to by
SMP/E RECEIVE processing (sample JCL:
HDSKT3RC))

HITACHI.CHKTnnn.F1.XMIT

Sample JCL used for installation

Sample script for CLI commands

HITACHI.CHKTnnn.F2.XMIT

Load library for LINKLIB

HITACHI.CHKTnnn.F3.XMIT

Load library for LPALIB

HITACHI.CHKTnnn.F4.XMIT

Cataloged procedure library

HITACHI.CHKTnnn.F5.XMIT

REXX Exec library

HITACHI.CHKTnnn.F6.XMIT

REXX Exec library

HITACHI.CHKTnnn.F7.XMIT

ISPF panel library

HITACHI.CHKTnnn.F8.XMIT

ISPF message library

10

HITACHI.CHKTnnn.F9.XMIT

ISPF table library

11

ALLOUPLD

JCL for creating datasets used for transfer

12

RECVUPLD

JCL for extracting (TSO/E RECEIVE) the


provided datasets

Note:

Items 1 to 10 are Tiered Storage Manager for Mainframe object


archives.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-7

The nnn part of CHKTnnn in the table varies depending on the version.

Postrequisites
Perform either of the following:

Performing an installation using SMP/E

Installing directly from the provided datasets in the target library

Related topics

Performing an installation using SMP/E on page 2-8

Installing directly from the provided datasets in the target library on page
2-9

Appendix E, Modifying the sample JCL on page E-1

Performing an installation using SMP/E


Use sample JCLs to perform an installation with SMP/E.

Procedure
1.

Edit the following sample JCLs that will be used for installation in
accordance with the user installation environment.

SMPALLOC (allocates the SMP/E dataset)

HDSKT1AL (allocates the target libraries and distribution libraries)

HDSKT2DF (defines the target libraries and distribution libraries)

HDSKT3RC (performs SMP/E RECEIVE processing)

HDSKT4AP (creates a target library)

Details are provided at the beginning of each sample JCL.


The sample JCLs are stored in the HITACHI.CHKTnnn.F1 dataset (the nnn
part varies depending on the version). If you edited the RECVUPLD job to
change the output destination dataset name for the TSO/E RECEIVE
command, the sample JCLs are stored in the dataset defined by the
change.
2.

Execute SMPALLOC.
Allocate the SMP/E control dataset as necessary. If an existing SMP/E
control dataset is to be used, skip this step.

3.

Execute HDSKT1AL.
The target library and distribution library (DLIB) are allocated.

4.

Execute HDSKT2DF.
SMP/E DDDEF is executed, and the target library and distribution library
(DLIB) are defined.

5.

2-8

Execute HDSKT3RC.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

SMP/E RECEIVE is executed, and the provided datasets are obtained and
stored in the global zone.
6.

Execute HDSKT4AP.
Perform the check operation for installing the provided datasets in the
target library. (The CHECK operand has been specified for the APPLY
command of the sample JCL.) If no errors occur (the execution completes
with a return code of 0), go on to the next step.

7.

Delete the CHECK operand from HDSKT4AP.

8.

Re-execute HDSKT4AP after the CHECK operand is deleted.


SMP/E APPLY is executed and the provided datasets are installed in the
target library.

Run the Tiered Storage Manager for Mainframe instance that was installed in
the target library. If no errors occur, back up Tiered Storage Manager for
Mainframe to the distribution library.
The following table shows the keyword (FMID) that is required for installing
with SMP/E.

Table 2-2 FMID for Tiered Storage Manager for Mainframe components
FMID

Function name
Hitachi Tiered Storage Manager for Mainframe

CHKTnnn

Note:
The nnn part of CHKTnnn varies depending on the version.

Postrequisites

Settings required for using CLI commands (registration for


authentication)

Related topics

Settings required for using CLI commands (registration for


authentication) on page 2-11

Backing up Tiered Storage Manager for Mainframe to the distribution


library on page 2-33

Appendix E, Modifying the sample JCL on page E-1

Installing directly from the provided datasets in the target library


Perform an installation directly from the provided datasets in the target
library, without using SMP/E.

Procedure
1.

Edit the sample JCL HDSKTSIN for installation in accordance with the user
installation environment.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-9

Details are provided at the beginning of the sample JCL.


The sample JCL is stored in the HITACHI.CHKTnnn.F1 dataset (the nnn
part varies depending on the version). If you edited the RECVUPLD job to
change the output destination dataset name for the TSO/E RECEIVE
command, the sample JCL is stored in the dataset after the change.
2.

Execute HDSKTSIN.
The contents of the provided datasets are registered in the target library.

Postrequisites

Settings required for using CLI commands (registration for


authentication)

Related topics

Settings required for using CLI commands (registration for


authentication) on page 2-11

Appendix E, Modifying the sample JCL on page E-1

Library datasets to be registered after the installation


This section describes the attributes of the library datasets (target libraries)
to be registered after the installation.
Attributes of the target libraries are shown in the following table.

Table 2-3 Attributes of the target libraries


Library type (DD name#)
Sample library

DSORG

LRECL
(bytes)

RECFM

BLKSIZE
(bytes)

PO

FB

80

6,160

PO

6,144

PO

6,144

PO

FB

80

6,160

PO

FB

80

6,160

PO

VB

255

6,120

PO

FB

80

6,160

(HDSKSAMT)
Load library for LINKLIB
(HDSKLNKT)
Load library for LPALIB
(HDSKLPAT)
Cataloged procedure library
(HDSKPRCT)
REXX Exec library, fixed length
format
(HDSKEXET)
REXX Exec library, variable
length format
(HDSKEXVT)
ISPF panel library

2-10

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Library type (DD name#)

DSORG

RECFM

LRECL
(bytes)

BLKSIZE
(bytes)

(HDSKPNLT)
ISPF message library

PO

FB

80

6,160

PO

FB

80

6,160

(HDSKMSGT)
ISPF table library
(HDSKTABT)

#
The DD name specified with the HDSKT1AL sample JCL (allocates the
distribution and target libraries) that was used when installing with
SMP/E. The dataset name is the one specified in each DD statement.

Settings required for using CLI commands (registration for


authentication)
To use CLI commands, you need to register the load library for LINKLIB and
the KTQRYSMS command for authentication.

Registering the load library for LINKLIB and the KTQRYSMS


command for authentication
To register the load library for LINKLIB and the KTQRYSMS command for
authentication to enable the use of CLI commands:

Procedure
1.

Concatenate the load library for LINKLIB HDSKLNKT to LNKLST.


You can concatenate by using either of the following methods:

Static method: Specify the load library for LINKLIB HDSKLNKT in the
PROGxx parmlib member as a dataset concatenated to the LNKLST.
To enable concatenation, you must perform an IPL again.
Dynamic method: Use the SETPROG LNKLST command to concatenate
the load library for LINKLIB HDSKLNKT to the LNKLST.
If you cannot perform an IPL because the system is running, use this
method to concatenate the load library. However, because performing
an IPL will invalidate concatenation, modify parmlib as defined in the
static method, above so the change will continue across an IPL.

2.

Register the load library for LINKLIB HDSKLNKT for APF authorization.
You can register by using either of the following methods:

Static method: Add the load library for LINKLIB HDSKLNKT to the
PROGxx parmlib member as a dataset to be authorized as APF.
To enable registration, you must perform an IPL again.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-11

Dynamic method: Use the SETPROG APF,ADD command to register the


load library as APF authentication.
If you cannot perform an IPL because the system is running, use this
method to perform registration. However, because performing an IPL
will invalidate registration, modify parmlib as described above in the
static method so the change will be available across an IPL.

Tip: LNKLST has APF authorization by default, so you do not have to


perform step 2, if the load library for LINKLIB HDSKLNKT was concatenated
with LNKLST in step 1. Note that there are exceptions to this rule. For
details about APF authorization related to LNKLST, see the manual MVS
Initialization and Tuning Reference.
3.

Register the KTQRYSMS command as a TSO/E authorized command.


Add the command name KTQRYSMS to the AUTHCMD section in the
IKJTSOxx parmlib member.
To enable registration, you must perform an IPL again. If you use the
PARMLIB CHECK (nn) command and the PARMLIB UPDATE (nn)
command, registration can be enabled without performing an IPL again.
For details about the PARMLIB command, see the TSO/E System
Programming Command Reference.
The KTQRYSMS command is a CLI command that is used internally by
Tiered Storage Manager for Mainframe to acquire SMS storage group
information.

For details about the SETPROG command, see the manual MVS System
Commands.

Postrequisites

Setting RACF security for CLI commands

Related topics

Example of dynamically linking the LINKLIB load library to LNKLST on


page 2-12

Setting RACF security for CLI commands on page 2-13

Example of dynamically linking the LINKLIB load library to LNKLST


This section explains an example of dynamically linking the LINKLIB load
library to LNKLST.
In this example, the currently-active LNKLST is switched from the original
LNKLST to a temporary LNKLST, and during this time, the original LNKLST is
connected to the LINKLIB load library. Dynamic changing of LNKLST affects
the jobs that are currently being executed. Before carrying out this
procedure, see the IBM manual relating to LNKLST, and check the required
notes on dynamically changing LNKLST.

2-12

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Procedure
1.

2.

Determine the active LNKLST by issuing the following command.


D PROG,LNKLST
The currently-active LNKLST (original LNKLST) is assumed to be LNKLST00.
Copy LNKLST00, and then define a temporary LNKLST (LNKLST99).
SETPROG LNKLST,DEFINE,NAME=LNKLST99,COPYFROM=LNKLST00

3.

Activate temporary LNKLST (LNKLST99).


SETPROG LNKLST,ACTIVATE,NAME=LNKLST99

4.

Apply all jobs that are being executed to the temporary LNKLST
(LNKLST99).
SETPROG LNKLST,UPDATE,JOB=*

5.

Add the LINKLIB load library to the original LNKLST (LNKLST00).


SETPROG LNKLST,ADD,NAME=LNKLST00,DSN=loadlib_dataset_name

6.

Reactivate original LNKLST (LNKLST00).


SETPROG LNKLST,ACTIVATE,NAME=LNKLST00

7.

Re-apply all jobs that are being executed to the original LNKLST
(LNKLST00).
SETPROG LNKLST,UPDATE,JOB=*

8.

Remove the temporary LNKLST (LNKLST99).


SETPROG LNKLST,UNDEFINE,NAME=LNKLST99

For details on the SETPROG command, see the manual MVS System
Commands.

Setting RACF security for CLI commands


To use Tiered Storage Manager for Mainframe CLI commands, you must set
up RACF security. Assign user permissions to use CLI operation commands or
CLI reference commands.

Procedure
1.

Define profiles for the RACF FACILITY class.


The correspondence between profiles defined for the FACILITY class and
the available CLI commands are shown in the following table.

Table 2-4 Correspondence between profiles defined for the FACILITY


class and the available CLI commands
Profile defined for the FACILITY class

Available CLI command

STGADMIN.YKA.DKT.COMMANDS

KTACTTPG

(Operation profile)

KTDCTDEV
KTDCTTPG
KTIMPORT

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-13

Profile defined for the FACILITY class

Available CLI command


KTQRYDEV
KTQRYRLC
KTQRYTPG
KTQSTATS
KTSCAN

STGADMIN.YKA.DKT.KTQUERY

KTIMPORT

(Reference profile)

KTQRYDEV
KTQRYRLC
KTQRYTPG
KTQSTATS
KTSCAN

2.

Give users permission to view the operation profile or the reference


profile.

For details about how to define RACF profiles and how to assign user
permissions to access the profiles, see the Security Server RACF Security
Administrator's Guide.
Tip: Users can use the following commands without access permissions:
KTCONMSG, KTENV, KTERCODE, KTGETHDA, KTINSCHK, KTLOAD, KTSLEEP,
KTSTORE, KTWTOMSG

Postrequisites

Settings for using environment configuration commands

Related topics

Settings for using environment configuration commands on page 2-14

Settings for using environment configuration commands


Environment configuration commands (KTALCSVC, KTSETENV, and KTDSPENV)
are used for setting up Tiered Storage Manager for Mainframe. Set up
environment configuration commands so that they can be used.

Prerequisites

2-14

Settings required for using CLI commands (registration for


authentication)

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Procedure
1.

Perform either of the following:

Concatenate the HDSKPRCT cataloged procedure library to the IEFPDSI


DD name in the MSTJCLxx parmlib member.
Copy the KTALCSVC member, KTSETENV member, and KTDSPENV
member from the HDSKPRCT cataloged procedure library to a user's
PROCLIB.

Caution: To concatenate the cataloged procedure library to a dataset,


make sure that the attributes of the cataloged procedure library are the
same as those of the dataset. For details, see the DFSMS: Using Data
Sets. For details about how to change the dataset attributes, see the
description of IEBGENER and IEBCOPY in the DFSMSdfp Utilities.
2.

Restrict user access for the KTALCSVC and KTSETENV commands.


Use the RACF program control function to assign permissions to access
the KTALCSVC and KTSETENV commands only to the system administrator
who will execute the commands. If you do not restrict user access and
the KTALCSVC or KTSETENV command is used by a regular user by
mistake, Tiered Storage Manager for Mainframe might not operate
properly. You do not need to restrict user access for the KTDSPENV
command. For details about the RACF program control function, see the
Security Server RACF Security Administrator's Guide.

Postrequisites

Registering a user SVC

Related topics

Settings required for using CLI commands (registration for


authentication) on page 2-11

Registering a user SVC on page 2-15

Registering a user SVC


You can dynamically register a user SVC by using the KTALCSVC environment
configuration command, or statically register a user SVC by using the
IEASVCxx parmlib member.
If you use the IEASVCxx parmlib member to register a user SVC, you must
perform an IPL again. If you cannot perform an IPL again because the system
is running, use the KTALCSVC command to perform registration.

Registering a user SVC using the KTALCSVC command


Use the KTALCSVC environment configuration command to dynamically
register a user SVC.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-15

Prerequisites

Settings for using environment configuration commands

Procedure
1.

Choose an unused SVC number between 200 and 255 to assign to the
user SVC.

2.

Execute the following KTALCSVC command.


START KTALCSVC, PARM='SVC-number'

Tip: The user SVC registered with the KTALCSVC command is invalidated if an
IPL is performed again. Perform either of the following in case you need to
perform an IPL again the next time:

Add the KTALCSVC command to the COMMNDxx parmlib member, so that


the user SVC is automatically registered when an IPL is performed again.

Define the user SVC in the IEASVCxx parmlib member, and use the
statically-registered user SVC from the next time an IPL is performed
again.

Specification examples
START KTALCSVC

By omitting the PARM parameter when executing this command, an unused


SVC number between 200 and 255 is assigned.
Caution:

If you used the KTALCSVC command to register a user SVC while Tiered
Storage Manager for Mainframe was running, the execution of the CLI
command continues to use the user SVC defined by the IEASVCxx parmlib
member. The registered user SVC will take effect the next time a CLI
command is executed.

User SVCs are shared between Tiered Storage Manager for Mainframe,
and Business Continuity Manager. Therefore, you must be careful when
registering a user SVC if you install Tiered Storage Manager for
Mainframe for the first time in an environment where Business Continuity
Manager is installed.

Postrequisites

Setting the operating environment for Tiered Storage Manager for


Mainframe (setting environment variables or system symbols)

Related topics

2-16

Settings for using environment configuration commands on page 2-14

Registering a user SVC using the IEASVCxx parmlib member on page


2-17

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Setting the operating environment for Tiered Storage Manager for


Mainframe (setting environment variables or system symbols) on page
2-18

Notes on registering a user SVC if Business Continuity Manager is


installed on page 2-35

KTALCSVC on page 6-42

Registering a user SVC using the IEASVCxx parmlib member


Statically register a user SVC by defining a user SVC number in the IEASVCxx
parmlib member.

Procedure
1.

Choose an unused number between 200 and 255 to be assigned for the
user SVC.

2.

Define the following SYMDEF statement (&YKSVCNO system symbol) in the


IEASYMxx parmlib member:

SYMDEF(&YKSVCNO='SVC-number')

For details, see the manual MVS Initialization and Tuning Reference.
3.

To concatenate the load library for LPALIB HDSKLPAT to LPALST, perform


either of the following:

4.

Define the load library for LPALIB HDSKLPAT in the LPALSTxx parmlib
member. For details, see the manual MVS Initialization and Tuning
Reference.
Use the SETPROG LPA command to dynamically concatenate the load
library for LPALIB HDSKLPAT to LPALST. For details, see the manual
MVS System Commands.

Define the following SVCPARM statement in the IEASVCxx parmlib member:

SVCPARM SVC-number,REPLACE,TYPE(3),EPNAME(JYUASVC),APF(NO),NPRMPT(NO),AR(NO)

For details, see the manual MVS Initialization and Tuning Reference.
To enable registration, you must perform an IPL again with the CLPA
parameter specified.
Caution: User SVCs are shared between Tiered Storage Manager for
Mainframe, and Business Continuity Manager. Therefore, you must be careful
when registering a user SVC if you install Tiered Storage Manager for
Mainframe for the first time in an environment where Business Continuity
Manager is installed.

Postrequisites

Setting the operating environment for Tiered Storage Manager for


Mainframe (setting environment variables or system symbols)

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-17

Related topics

Setting the operating environment for Tiered Storage Manager for


Mainframe (setting environment variables or system symbols) on page
2-18

Notes on registering a user SVC if Business Continuity Manager is


installed on page 2-35

Setting the operating environment for Tiered Storage


Manager for Mainframe (setting environment variables or
system symbols)
This section explains how to set the operating environment for Tiered Storage
Manager for Mainframe.

About the operating environment for Tiered Storage Manager for


Mainframe
The operating environment settings for Tiered Storage Manager for
Mainframe include the following:

The prefix of the license information dataset that registers the license key

Whether the system logger service is used to collect event logs

Whether CLI command execution logs are output to SYSLOG or the


console

Set the operating environment settings for Tiered Storage Manager for
Mainframe by using either of the following methods:

Use the environment variable (set by using the KTSETENV environment


configuration command).
Use this method if you cannot perform an IPL again because the system is
running. However, this setting is invalidated if an IPL is performed again.

Use the system symbol (set for the IEASYMxx parmlib member).
To enable this setting, you must perform an IPL again. The staticallyregistered settings can be used the next time an IPL is performed again.

Related topics

2-18

Setting the operating environment by using environment variables on


page 2-19

Setting the operating environment by using system symbols on page


2-21

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

List of operating environment setting items for Tiered Storage


Manager for Mainframe
The following table lists operating environment setting items for Tiered
Storage Manager for Mainframe.

Table 2-5 Operating environment settings items for Tiered Storage


Manager for Mainframe
Setting items
Specifies
prefixes for the
license
information
dataset.#

Environm
ent
variable

System
symbols

prefix-1

YKLCNSE

&YKLCNSE

prefix-2

YKLCNS2

Specifies whether the system


logger service is used to collect
event logs.

LOGPUT

Specifies whether to output CLI


command execution logs to
SYSLOG or the console.

SYSLOG

Specified
values

Default
values
HITACHI

&YKLCNS2

8 or fewer
alphanumeric
characters

&YKLOGPT

LOGR: Used

LOGR

None

SAM: Not used


&YKSYSLG

YES: Output
to SYSLOG

YES

CONSOLE:
Output to the
console
NO: Not
output

#:
The name of a license information dataset is decided as follows:
prefix-1.prefix-2.CCENTRAL.LICENSE

prefix-2 can be omitted. prefix-2 is enabled if prefix-1 is specified.


If you set both the environment variables and the system symbols, the
priority is as follows:
1.

Values of the environment variables

2.

Values specified for the system symbols

3.

Default values

Setting the operating environment by using environment variables


To dynamically set the following operating environments by using
environment variables, use the environment setting command KTSETENV.

The prefix of the license information dataset that registers the license key

Whether the system logger service is used to collect event logs

Whether CLI command logs are output to SYSLOG or the console

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-19

Prerequisites

Settings for using environment configuration commands

Procedure
1.

Execute the following KTSETENV command.


START KTSETENV,PARM='parameter=parameter-value'

2.

Use the KTDSPENV command as follows to confirm that the environment


variables have been specified correctly:
START KTDSPENV,PARM='DETAIL'

Example of executing the KTSETENV command

When setting the name of the license information dataset to


HTC1.HTC2.CCENTRAL.LICENSE
START KTSETENV,PARM='YKLCNSE=HTC1'
START KTSETENV,PARM='YKLCNS2=HTC2'

When specifying whether to use the system logger service to collect event
logs
START KTSETENV,PARM='LOGPUT=LOGR' (if using the system logger
service)
START KTSETENV,PARM='LOGPUT=SAM' (if not using the system logger
service)

When specifying whether to output CLI command execution logs to


SYSLOG or the console
START KTSETENV,PARM='SYSLOG=YES' (if outputting to SYSLOG)
START KTSETENV,PARM='SYSLOG=CONSOLE' (if outputting to the console)
START KTSETENV,PARM='SYSLOG=NO' (if not outputting)
Caution: If you use the KTSETENV command to set SYSLOG=CONSOLE,
Tiered Storage Manager for Mainframe version 7.5 is treated as if
SYSLOG=YES is set. Be careful in an environment in which multiple
versions coexist or when upgrading.

Tip: This setting is invalidated if an IPL is performed again. Perform either of


the following in case you need to perform an IPL again the next time:

Add the KTSETENV command to the COMMNDxx parmlib member to


automatically set the environment variables when an IPL is performed
again.

For the IEASYMxx parmlib member, specify the system symbols so that
the statically-registered settings will be used the next time an IPL is
performed.

Tip: Use either the environment variables or the system symbols to specify
both prefix-1 and prefix-2. If you use the environment variable to specify
prefix-1 and use the system symbol to specify prefix-2, the process of
determining the prefixes will be complicated.

2-20

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Tip: The license (name of the license information dataset) for Tiered Storage
Manager for Mainframe takes effect when the KTLOAD command is first
executed after the license is registered. Even if you used the KTSETENV
command to modify a prefix of the license information dataset name while
CLI commands were being executed, the corresponding license takes effect
after the KTLOAD command is executed the next time.
Caution: Environment variables are shared by Tiered Storage Manager for
Mainframe and Business Continuity Manager. Therefore, you must be careful
when setting the environment variables in an environment where Business
Continuity Manager is installed.

Postrequisites

Settings required to use Tiered Storage Manager for Mainframe on the


ISPF panel

Related topics

Settings for using environment configuration commands on page 2-14

Setting the operating environment by using system symbols on page


2-21

Settings required to use Tiered Storage Manager for Mainframe on the


ISPF panel on page 2-22

Notes on setting environment variables or system symbols if Business


Continuity Manager is installed on page 2-35

KTDSPENV on page 6-43

KTSETENV on page 6-45

Collecting event logs on page 9-4

Collecting the CLI command-execution log on page 9-20

Setting the operating environment by using system symbols


To statically set the following operating environments by using system
symbols, define the IEASYMxx parmlib member.

The prefix of the license information dataset that registers the license key

Whether the system logger service is used to collect event logs

Whether CLI command execution logs are output to SYSLOG or the


console

Procedure
1.

Define the following line in the IEASYMxx parmlib member.


SYMDEF(system-symbol='system-symbol-value')

2.

After an IPL is performed again, use the KTDSPENV command to confirm


that the system symbols have been specified correctly.
START KTDSPENV,PARM='DETAIL'

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-21

Example of defining the IEASYMxx parmlib member

When setting the name of the license information dataset to


HTC1.HTC2.CCENTRAL.LICENSE
SYMDEF(&YKLCNSE='HTC1')
SYMDEF(&YKLCNS2='HTC2')

When specifying whether to use the system logger service to collect event
logs
SYMDEF(&YKLOGPT='LOGR') (if using the system logger service)
SYMDEF(&YKLOGPT='SAM') (if not using the system logger service)

When specifying whether to output CLI command execution logs to


SYSLOG or the console
SYMDEF(&YKSYSLG='YES') (if outputting to SYSLOG)
SYMDEF(&YKSYSLG='CONSOLE') (if outputting to the console)
SYMDEF(&YKSYSLG='NO') (if not outputting)

Tip: Use either the environment variables or the system symbols to specify
both prefix-1 and prefix-2. If you use the environment variables to specify
prefix-1, and use the system symbols to specify prefix-2, the process of
determining the prefixes will be complicated.
Caution: System symbols are shared by Tiered Storage Manager for
Mainframe and Business Continuity Manager. Therefore, you must be careful
when setting system symbols in an environment where Business Continuity
Manager is installed.

Postrequisites

Settings required to use Tiered Storage Manager for Mainframe on the


ISPF panel

Related topics

Settings required to use Tiered Storage Manager for Mainframe on the


ISPF panel on page 2-22

Notes on setting environment variables or system symbols if Business


Continuity Manager is installed on page 2-35

KTDSPENV on page 6-43

Collecting event logs on page 9-4

Collecting the CLI command-execution log on page 9-20

Settings required to use Tiered Storage Manager for


Mainframe on the ISPF panel
You need to execute the KTSTART command in the ISPF panel to use Tiered
Storage Manager for Mainframe on the ISPF panel. This section describes the
settings required to execute the KTSTART command.

2-22

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

The KTSTART command is a TSO/E command that provides an ISPF panel


interface.
To execute the KTSTART command in the ISPF panel, you need to concatenate
the REXX Exec library, ISPF panel library, ISPF message library, and ISPF
table library by using either of the following methods:

Using DD names to concatenate

Using the ALTLIB command and the LIBDEF service to concatenate

Using DD names to concatenate the libraries required for executing


the KTSTART command
Use DD names to concatenate the target libraries (REXX Exec library, ISPF
panel library, ISPF message library, and ISPF table library) required for
executing the KTSTART command in the ISPF panel. The concatenation takes
effect when you log on to ISPF (if you have already logged on, you must log
on again).

Procedure
1.

Concatenate the REXX Exec library HDSKEXET or HDSKEXVT to SYSEXEC DD


name.

2.

If the existing library concatenated to SYSEXEC DD name has fixed


length format (RECFM=FB), concatenate the REXX Exec library
HDSKEXET to SYSEXEC DD name.
If the existing library concatenated to SYSEXEC DD name has variable
length format (RECFM=VB), concatenate the REXX Exec library
HDSKEXVT to SYSEXEC DD name.

Concatenate the ISPF panel library HDSKPNLT to ISPPLIB DD name.


Caution: In an environment in which the DBCS function is enabled, you
must also concatenate the ISPF panel library HDSKPNLT to ISPPALT
(alternate panel library) DD name. For details, see the ISPF User's Guide
Volume I.

3.

Concatenate the ISPF message library HDSKMSGT to ISPMLIB DD name.


Caution: In an environment in which the DBCS function is enabled, you
must also concatenate the ISPF panel library HDSKMSGT to ISPMALT
(alternate message library) DD name. For details, see the ISPF User's
Guide Volume I.

4.

Concatenate the ISPF table library HDSKTABT to ISPTLIB DD name.

When you log on to ISPF (if you have already logged on, you must log on
again), you can start the KTSTART command by selecting option 6 Command
in the ISPF Primary Option Menu panel.
Caution: To concatenate a dataset to libraries, make sure that the attributes
of the target libraries are the same as the attributes of the dataset. For

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-23

example, if the dataset attributes are DSORG=PO and RECFM=FB, the LRECL
setting must be the same among the datasets. For details, see the DFSMS:
Using Data Sets. For details about how to change dataset attributes, see the
description of IEBGENER and IEBCOPY in the DFSMSdfp Utilities.

Postrequisites

Registering a licenses

Related topics

Registering licenses on page 2-25

Using the ALTLIB command and LIBDEF service to concatenate the


libraries required for executing the KTSTART command
Use the ALTLIB command and LIBDEF service to concatenate the target
libraries (REXX Exec library, ISPF panel library, ISPF message library, and
ISPF table library) required for executing the KTSTART command in the ISPF
panel. The concatenation is invalidated when the KTSTART command
terminates.

Procedure

To concatenate the REXX Exec library HDSKEXET or HDSKEXVT, use the


TSO/E ALTLIB command.

If the existing library concatenated to SYSEXEC DD name has fixed


length format (RECFM=FB), concatenate the REXX Exec library
HDSKEXET.
If the existing library concatenated to SYSEXEC DD name has variable
length format (RECFM=VB), concatenate the REXX Exec library
HDSKEXVT.

To concatenate the panel library HDSKPNLT, message library HDSKMSGT,


and table library HDSKTABT, use the LIBDEF service of ISPF.

Caution:

2-24

In an environment in which the DBCS function is enabled, you must also


concatenate the ISPF panel library HDSKPNLT to ISPPALT (alternate panel
library) DD name, and concatenate the ISPF message library HDSKMSGT to
ISPMALT (alternate message library) DD name. For details, see the ISPF
User's Guide Volume I.

To concatenate a dataset to libraries, make sure that the attributes of the


target libraries are the same as the attributes of the dataset. For
example, if the dataset attributes are DSORG=PO and RECFM=FB, the
LRECL setting must be the same among the datasets. For details, see the
DFSMS: Using Data Sets. For details about how to change the dataset
attributes, see the description of IEBGENER and IEBCOPY in the
DFSMSdfp Utilities.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Sample REXX script


While ISPF is running, you can execute the following REXX script to
concatenate the libraries to the DD names (SYSEXEC, ISPPLIB, ISPMLIB, and
ISPTLIB), and execute the KTSTART command to start the main panel for
Tiered Storage Manager for Mainframe.
/* REXX */
ADDRESS TSO "ALTLIB ACTIVATE APPLICATION(EXEC)",
"DATASET('HDSKT.Vnnnnnn.HDSKEXET')";
ADDRESS
"LIBDEF
"LIBDEF
"LIBDEF

ISPEXEC;
ISPMLIB DATASET ID('HDSKT.Vnnnnnn.HDSKMSGT') STACK";
ISPPLIB DATASET ID('HDSKT.Vnnnnnn.HDSKPNLT') STACK";
ISPTLIB DATASET ID('HDSKT.Vnnnnnn.HDSKTABT') STACK";

"SELECT CMD(KTSTART) ";


"LIBDEF ISPTLIB";
"LIBDEF ISPPLIB";
"LIBDEF ISPMLIB";
ADDRESS TSO "ALTLIB DEACTIVATE APPLICATION(EXEC)";
Return 0;

Postrequisites

Registering a licenses

Related topics

Registering licenses on page 2-25

Registering licenses
To use Tiered Storage Manager for Mainframe, you must register a license for
it.

Workflow for registering a license


The following figure shows the workflow when registering a license for Tiered
Storage Manager for Mainframe.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-25

Figure 2-4 Workflow of registering a license for Tiered Storage Manager


for Mainframe

Related topics

Creating a license information dataset on page 2-26

Registering a license by using a license key file on page 2-27

Registering a license by entering a license key on page 2-29

Creating a license information dataset


Create a license information dataset for installing a license key.

Prerequisites

Specifying prefixes for the license information dataset using the


environment variable or system symbol

Procedure
1.

Edit the JCL that allocates the license information dataset.


Edit the dataset prefix (%PREFIX) and the volume serial number (%VSN)
in accordance with your installation environment. For the dataset prefix
(%PREFIX), specify the value that was set by using the environment
variable or system symbol.
//ALLOC JOB job info
//*
// SET PFX=%PREFIX
Data set prefix1
// SET VSN=%VSN
VOLSER
//*
//BR14
EXEC PGM=IEFBR14
//LICENSE DD DSN=&PFX..CCENTRAL.LICENSE,
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(TRK,(15)),
//
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
//
DISP=(,CATLG,DELETE)

The license information dataset has the following format:

2-26

Dataset format: Sequential dataset in fixed-length record format

Record size: 80 bytes

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Block size: Multiple of 80 bytes

2.

Submit the JCL to allocate the license information dataset.

3.

Assign the following access permissions for users who use the license
information dataset.

User who installs the license key: Write permission


Other users who operate Tiered Storage Manager for Mainframe: Read
permission

Note: Do not edit or delete the license information dataset after the license
key is installed. If you do so, Tiered Storage Manager for Mainframe cannot
be used.

Postrequisites

Registering a license

Related topics

Setting the operating environment by using environment variables on


page 2-19

Setting the operating environment by using system symbols on page 2-21

Registering a license by using a license key file on page 2-27

Registering a license by entering a license key on page 2-29

Registering a license by using a license key file


With this method, transfer the license key file to z/OS, and use the Manage
Licenses panel to register the license.
The following figure provides the procedure for registering a license by using
a license key file.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-27

Figure 2-5 Procedure for registering a license by using a license key file

Prerequisites

Creating a license information dataset

The numbers in the figure correspond to the step numbers below.

Procedure
1.

Create a license key dataset for transferring a license key file to z/OS.
Create the license key dataset with the following attributes:

Dataset format: VB or FB sequential dataset

Record length: 200 bytes or greater

Block size: Optional


Do not use hyphens in the name of the license key dataset.

2.

Transfer the license key file to the host machine.


Use the following format to transfer the license key file to the license key
dataset:

ASCII mode

Encoded (to EBCDIC)


Assume that the license key file has been transferred to a license key
dataset named LICENSE.KEYS.SAMPLE.

2-28

3.

In the ISPF Primary Option Menu panel, select option 6 Command.

4.

Enter KTSTART.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

The main panel for Tiered Storage Manager for Mainframe appears.
When you display the main panel for Tiered Storage Manager for
Mainframe for the first time, the Edit Defaults panel appears. Use this
panel to specify basic information for the ISPF panels.
5.

Select the Installation Management 'Install' point-and-shoot field.


The Installation Management area appears.

6.

Select the <Licenses> point-and-shoot field.


The Manage Licenses panel appears.

7.

Enter the name of the license key dataset (LICENSE.KEYS.SAMPLE) in the


License Key Dataset Name field, and then press Enter.
The Licenses Message List panel appears.
The license key is read from the license key dataset and installed in the
license information dataset. The KTA001I message is output if the license
key is installed correctly.
Tip: If the license key file contains the license key for Business Continuity
Manager, the license key for Business Continuity Manager is also
installed.

8.

Use the License List in the Manage Licenses panel to confirm that the
license has been installed correctly.

Postrequisites

Verifying the setup information

Related topics

Creating a license information dataset on page 2-26

Verifying the setup information on page 2-31

Edit Defaults panel on page 5-13

Installation Management area on page 5-17

Manage Licenses panel on page 5-22

Registering a license by entering a license key


Register a license by directly entering a key code into the Manage Licenses
panel.
The following figure provides the procedure for registering a license by
directly entering a license key.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-29

Figure 2-6 Procedure for registering a license by directly entering a license


key

Prerequisites

Creating a license information dataset

The numbers in the figure correspond to the steps below.

Procedure
1.

In the ISPF Primary Option Menu panel, select option 6 Command.

2.

Enter KTSTART.
The main panel for Tiered Storage Manager for Mainframe appears.
When you display the main panel for Tiered Storage Manager for
Mainframe for the first time, the Edit Defaults panel appears. Use this
panel to specify basic information for the ISPF panels.

3.

Select the Installation Management 'Install' point-and-shoot field.


The Installation Management area appears.

4.

Select the <Licenses> point-and-shoot field.


The Manage Licenses panel appears.

5.

In the Manage Licenses panel, enter the key code in the Key Code
field, and then press Enter.
Tip: If you enter the keycode for Business Continuity Manager in this
panel, the license key for Business Continuity Manager is also installed.
The Licenses Message List panel appears.
The KTA001I message is output if the license key is installed correctly.
The key code you entered is installed as the license key in the license
information dataset.

2-30

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

6.

Use the License List in the Manage Licenses panel to confirm that the
license has been installed correctly.

Postrequisites

Verifying the setup information

Related topics

Creating a license information dataset on page 2-26

Verifying the setup information on page 2-31

Edit Defaults panel on page 5-13

Installation Management area on page 5-17

Manage Licenses panel on page 5-22

Verifying the setup information


After you have completed the setup of Tiered Storage Manager for
Mainframe, check the setup.

Overview of verifying the setup information


You can execute the KTINSCHK command to check whether the following
items have been completed.

View permission required for using CLI commands has been assigned to
the reference and operation profiles.

A user SVC has been registered correctly.

Verifying the setup information


To check the setup tasks by executing the KTINSCHK command:

Procedure
1.

Execute the KTINSCHK command.


From the command execution results, confirm that the setup tasks have
been performed correctly.

2.

If the return code is 8, perform the task that has not been completed.
If the return code of the KTINSCHK command is 8, there is a problem with
the information specified during setup. Check the command execution
results and perform the task that has not been completed.

JCL example
The following shows an example of a JCL used to output the execution results
of the KTINSCHK command to SYSTSPRT DD name.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-31

//KTINSCHK JOB
//IEFPROC EXEC PGM=IKJEFT01,TIME=1440,REGION=4096K
//SYSTSPRT DD SYSOUT=*
//SYSABEND DD SYSOUT=A
//STEPLIB DD DSN=HTC1.KT.Vvvrr.LINKLIB,DISP=SHR
//SYSTSIN DD *
KTINSCHK
/*
//

For details about the example of the command output, see the description of
the KTINSCHK command.

Postrequisites

Preparations to use Tiered Storage Manager for Mainframe

Related topics

Preparing to use Tiered Storage Manager for Mainframe on page 2-32

KTINSCHK on page 6-39

Preparing to use Tiered Storage Manager for Mainframe


This section describes the preparations that need to be performed before
using Tiered Storage Manager for Mainframe, including calculating the
required memory, specifying the settings for collecting event logs, and
backing up files to the distribution library.

Calculating required memory


Use the following formula to calculate the memory size required for running
Tiered Storage Manager for Mainframe.

For a user region of less than 16 MB: 1,024 KB

For an extended user region of 16 MB or more: 4,000 KB + (4 numberof-volumes) KB

Settings required for collecting event logs


Specify the settings required for collecting event logs. The specification
method varies depending on whether you want to output event logs to the
log stream by using the system logger service or to the Tiered Storage
Manager for Mainframe log dataset without using the system logger service.

Procedure
To output event logs to the log stream by using the system logger service,
perform all the sysplex setup procedures for using the DASD-only log stream
for the system logger service described in the MVS Setting Up a Sysplex.

2-32

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

To output event logs to the Tiered Storage Manager for Mainframe log
dataset without using the system logger service, create a log dataset before
executing a CLI command.
For details about event logs, see the description about collecting event logs.

Related topics

Collecting event logs by using the system logger service on page 9-5

Collecting event logs without using the system logger service on page
9-16

Backing up Tiered Storage Manager for Mainframe to the distribution


library
If SMP/E was used when installing Tiered Storage Manager for Mainframe in
the target library and no errors occurred in the operation of Tiered Storage
Manager for Mainframe, use a sample JCL to back up Tiered Storage Manager
for Mainframe to the distribution library. This step is unnecessary if you install
it directly in the target library without using SMP/E.

Procedure
1.

Modify the following sample JCL in accordance with the user installation
environment.

HDSKT5AC

Details are shown at the beginning of the sample JCL.


The sample JCL is stored in the HITACHI.CHKTnnn.F1 dataset (the nnn
part varies depending on the version). If you edited the RECVUPLD job to
change the output destination dataset name for the TSO/E RECEIVE
command, the JCL is stored in the dataset after the change.
2.

Execute HDSKT5AC.
Perform the checking that is required for backing up the provided
datasets to the distribution library. (The CHECK operand has been
specified for the ACCEPT command.) If no errors occur (the execution
completes with a return code of 0), go on to the next step.

3.

Delete the CHECK operand from HDSKT5AC.

4.

Re-execute HDSKT5AC after the CHECK operand is deleted.


SMP/E ACCEPT is executed, and the provided datasets are backed up to
the distribution library.

Attributes of the distribution libraries (DLIB) are shown in the following table.

Table 2-6 Attributes of the distribution libraries (DLIB)


Library type (DD name#)
Sample library

DSORG
PO

RECFM
FB

LRECL
(bytes)
80

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

BLKSIZE
(bytes)
6,160

2-33

Library type (DD name#)

DSORG

LRECL
(bytes)

RECFM

BLKSIZE
(bytes)

(HDSKSAMD)
Load library for LINKLIB

PO

6,144

PO

6,144

PO

FB

80

6,160

PO

FB

80

6,160

PO

VB

255

6,120

PO

FB

80

6,160

PO

FB

80

6,160

PO

FB

80

6,160

(HDSKLNKD)
Load library for LPALIB
(HDSKLPAD)
Cataloged procedure library
(HDSKPRCD)
REXX Exec library, fixed length
format
(HDSKEXED)
REXX Exec library, variable
length format
(HDSKEXVD)
ISPF panel library
(HDSKPNLD)
ISPF message library
(HDSKMSGD)
ISPF table library
(HDSKTABD)

#
The DD name specified with the HDSKT1AL sample JCL (allocates the
distribution and target libraries) that was used when installing with
SMP/E. The dataset name is the one specified in each DD statement.

Related topics

Performing an installation using SMP/E on page 2-8

Appendix E, Modifying the sample JCL on page E-1

Notes on setting up Tiered Storage Manager for Mainframe


when Business Continuity Manager is already installed
This section provides notes on registering a user SVC and setting
environment variables and system symbols when installing Tiered Storage
Manager for Mainframe in an environment where Business Continuity
Manager is installed.

2-34

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

Notes on registering a user SVC if Business Continuity Manager is


installed
Tiered Storage Manager for Mainframe and Business Continuity Manager
share the same user SVC. Therefore, you must compare the version of the
currently enabled user SVC registered by Business Continuity Manager and
the version of the prerequisite user SVC for Tiered Storage Manager for
Mainframe, and then you must use the user SVC of the later version.
To confirm the version of the currently enabled user SVC, use the YKINSCHK
command of Business Continuity Manager.

If the confirmed user SVC version is old and does not satisfy conditions
for the prerequisite user SVC version requirement of Tiered Storage
Manager for Mainframe:
Use Business Continuity Manager to delete the user SVC, and then use
Tiered Storage Manager for Mainframe to register it again.

If the confirmed user SVC version satisfies conditions for the prerequisite
user SVC version:
You can use the currently enabled user SVC as it is.

Tip:

For details on the YKINSCHK command, see the Hitachi Business


Continuity Manager Reference Guide.

For details on how to delete the user SVC in Business Continuity Manager,
see the Hitachi Business Continuity Manager Installation Guide.

This procedure lets you install Tiered Storage Manager for Mainframe for
the first time. If you need to upgrade Tiered Storage Manager for
Mainframe, refer to the instructions for preparing for the upgrade.

Related topics

Registering a user SVC on page 2-15

Prerequisite user SVC versions for Tiered Storage Manager for Mainframe
on page 2-36

Preparation for upgrading Tiered Storage Manager for Mainframe on page


D-3

Notes on setting environment variables or system symbols if


Business Continuity Manager is installed
Tiered Storage Manager for Mainframe and Business Continuity Manager use
the same environment variables and system symbols. Do not change the
currently enabled operating environment setting values (that is, environment
variables or values set to system symbols), in the system where Business
Continuity Manager is running. In particular, if you change the prefix of a
license information dataset, you must register the Business Continuity
Manager license again because the license information dataset is shared by
Tiered Storage Manager for Mainframe and Business Continuity Manager.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-35

Change the operating environment setting values very carefully if you need to
change them.
Tip: To check the currently enabled operating environment setting values, do
the following:

If Tiered Storage Manager for Mainframe has already been installed


(when you upgrade it)
Check the operating environment setting values that were obtained when
preparing for the upgrade.

If Tiered Storage Manager for Mainframe has not been installed (when
you install it for the first time)
Use the YKDSPENV command to do the check. For details on the YKDSPENV
command, see the Hitachi Business Continuity Manager Reference Guide.

Related topics

Setting the operating environment for Tiered Storage Manager for


Mainframe (setting environment variables or system symbols) on page
2-18

Preparation for upgrading Tiered Storage Manager for Mainframe on page


D-3

Prerequisite user SVC versions for Tiered Storage Manager


for Mainframe
The following table shows the prerequisite user SVC versions for Tiered
Storage Manager for Mainframe.

Table 2-7 Prerequisite user SVC versions for Tiered Storage Manager for
Mainframe
Tiered Storage Manager for Mainframe version
7.5.0

Prerequisite user SVC version


7.5.0 or later

8.0.0

Notes for when multiple versions of Tiered Storage Manager


for Mainframe coexist
This section provides notes for when multiple versions coexist in the same
system.

Notes on collection of CLI command execution logs


The CONSOLE setting, which is configured by using the KTSETENV command
with SYSLOG=CONSOLE specified or by using the system symbol &YKSYSLG, is

2-36

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

enabled in Tiered Storage Manager for Mainframe version 8.0 or later.


Therefore, in an environment in which instances of Tiered Storage Manager
for Mainframe of versions 7.5 and 8.0 or later coexist, even if you configure
the CONSOLE setting by using the KTSETENV command with SYSLOG=CONSOLE
specified or by using the system symbol &YKSYSLG, CLI command execution
logs are output to SYSLOG in Tiered Storage Manager for Mainframe version
7.5.
In addition, the output destination of CLI command execution logs in Tiered
Storage Manager for Mainframe version 8.0 or later cannot be changed to
SYSLOG even if you execute the KTSETENV command with SYSLOG=CONSOLE
specified in Tiered Storage Manager for Mainframe version 8.0 or later, and
then execute the KTSETENV command with SYSLOG=YES specified in Tiered
Storage Manager for Mainframe version 7.5. Use the KTSETENV command in
Tiered Storage Manager for Mainframe version 8.0 to change the output
destination.

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

2-37

2-38

Installation and setup


Hitachi Tiered Storage Manager for Mainframe User Guide

3
Tiered Storage Manager for Mainframe
operations when using the ISPF panel
This chapter describes how to use the ISPF panels to operate Tiered Storage
Manager for Mainframe.
Operation description method for the ISPF panels
Workflow for when defining and checking tiering policy groups when using
the ISPF panel
Starting Tiered Storage Manager for Mainframe and displaying the main
panel
Basic ISPF panel settings of Tiered Storage Manager for Mainframe
Defining tiering policy groups when using the ISPF panel
Verification after scanning storage systems when using the ISPF panel
Verification after defining a tiering policy group when using the ISPF panel
Frequently used checking methods when using the ISPF panel
About changing tiering policy groups when using the ISPF panel
Convenient use of list panels
Customizing the ISPF panels

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-1

Operation description method for the ISPF panels


The following describes how the operation of Tiered Storage Manager for
Mainframe using the ISPF panels is described.
In operation procedures, for panels containing the AC or COMMAND field,
you are instructed to specify a slash (/) in the AC or COMMAND field to
display the action selection panel and then select an action.
The panel display can also be changed by directly specifying an action in the
AC or COMMAND field or by using point-and-shoot operations. Use the
appropriate way as required.
The function keys assigned in this product are represented by function key
names (Fnn). The nn in Fnn indicates a standard number. If a user changes
these numbers, the numbers used in this manual will be different from the
changed numbers.

Workflow for when defining and checking tiering policy


groups when using the ISPF panel
The following figure shows how to use ISPF panels to define a tiering policy
group and verify the created tiering policy group.

3-2

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Figure 3-1 Procedure for defining and verifying a tiering policy group
(ISPF panels)

Related topics

Overview of files used by Tiered Storage Manager for Mainframe on page


1-12

Basic ISPF panel settings of Tiered Storage Manager for Mainframe on


page 3-4

Scanning storage systems when using the ISPF panel on page 3-5

Creating a tiering policy information CSV file when using the ISPF panel
on page 3-7

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-3

Defining tiering policy groups when using the ISPF panel on page 3-8

Applying tiering policies when using the ISPF panel on page 3-8

Checking volume information for the scanned storage system when using
the ISPF panel on page 3-9

Checking pool information for the scanned storage system when using the
ISPF panel on page 3-11

Verifying definition information for the tiering policy group when using the
ISPF panel on page 3-14

Verifying storage system information (summary) for the tiering policy


group when using the ISPF panel on page 3-15

Checking SMS storage groups belonging to a tiering policy group when


using the ISPF panel on page 3-16

Verifying volume information for the tiering policy group when using the
ISPF panel on page 3-17

Verifying pool information for the tiering policy group when using the ISPF
panel on page 3-19

Starting Tiered Storage Manager for Mainframe and


displaying the main panel
This section describes how to start Tiered Storage Manager for Mainframe
and display the main panel.

Procedure
1.

In the ISPF Primary Option Menu panel, select 6 Command.


The ISPF Command Shell panel appears.

2.

Enter KTSTART.
The main panel for Tiered Storage Manager for Mainframe appears.
Tip: When you display the main panel for the first time, the Edit
Defaults panel appears. Use this panel to specify the basic information
for using ISPF panels to operate Tiered Storage Manager for Mainframe.

Related topics

Edit Defaults panel on page 5-13

Main panel (common) on page 5-16

Basic ISPF panel settings of Tiered Storage Manager for


Mainframe
Use the Edit Defaults panel to specify basic information necessary for using
the ISPF panels to operate Tiered Storage Manager for Mainframe.

3-4

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Procedure
1.

In the main panel, select the Set Defaults 'Defaults' point-and-shoot


field.
The Set Defaults area appears.

2.

Select the <Edit> point-and-shoot field.


The Edit Defaults panel appears.

3.

Enter values for the items, and then press Enter.


The setting is saved.
Caution: If you want to install and use Tiered Storage Manager for
Mainframe in the same system as Business Continuity Manager, you must
make sure that the prefix character strings for Business Continuity
Manager and Tiered Storage Manager for Mainframe are different. If the
same prefix is used for both Business Continuity Manager and Tiered
Storage Manager for Mainframe, the product may operate abnormally.

Tip: In each panel, press the DispConf function key (F17) to display the
basic information you specified here for the ISPF panels. As a default,
because only 12 function keys are displayed, DispConf is not displayed in the
list of function keys. To display DispConf, set the number of displayed
function keys to 24.

Related topics

Setting the number of displayed function keys on page 3-35

Edit Defaults panel on page 5-13

Set Defaults area on page 5-18

Defining tiering policy groups when using the ISPF panel


This section describes how to define a tiering policy group by using the ISPF
panels.

Scanning storage systems when using the ISPF panel


To scan storage systems, specify the scan target in the Device Scan Scope
panel, and then press the Scan function key (F6). By scanning a storage
system, you can acquire its disk configuration information. The acquired disk
configuration information is saved in the disk configuration definition file.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-5

Prerequisites

To specify the scan range by using an SMS storage group or volume serial
numbers, bring the volumes online.

Procedure
1.

In the main panel, select the Storage System List 'Storage' point-andshoot field.
The Storage System List area appears.

2.

Select the <Scan> point-and-shoot field.


The Device Scan Scope panel appears.

3.

Do either of the following:

To specify an SMS storage group to be scanned:


Enter a slash (/) in the Storage Group field and specify the name of
the target SMS storage group. Then press the Scan function key (F6).
Tip: If you perform either of the actions below without entering an
SMS storage group name, the Storage Group Selection List panel
appears. You can use it to select the desired SMS storage group from
the list.

Press the Scan function key (F6).

Point the cursor to the entry field for the SMS storage group
name, and then press Enter.

To specify volumes to be scanned:


Enter a slash (/) in the Volser or Device Number field, specify the
range of volumes to be scanned in the Start and End fields, and then
press the Scan function key (F6).
The numbers of detected volumes are displayed in the Device Scan
Scope panel.

4.

Press the Exit function key.


The Confirm Configuration File Update panel appears. Confirm that
you want to update the disk configuration definition file.

5.

Press Enter.
The scan results are saved in the disk configuration definition file, and a
list of scanned storage systems appears in the Storage System List
area.
Tip: If the disk configuration changes significantly after the scan (for
example, the storage systems are replaced or the device numbers of
volumes change due to changes in I/O definitions), you must delete the
disk configuration definition file. Then rescan the storage systems. If
necessary, define the tiering policy group again.

Postrequisites

3-6

Creating a tiering policy information CSV file

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Creating a tiering policy information CSV file when using the ISPF panel
on page 3-7

Device Scan Scope panel on page 5-12

Storage System List area on page 5-19

Creating a tiering policy information CSV file when using the ISPF
panel
To create a tiering policy information CSV file, assign the policy ID to the file
in the Policy CSV List area in the main panel, and then edit the contents of
the file.

Procedure
1.

In the main panel, select the Policy CSV List 'Policy' point-and-shoot
field.
The Policy CSV List area appears.

2.

Select the <Create> point-and-shoot field.


The Policy ID Entry Field panel appears.

3.

Specify the policy ID to be assigned to the tiering policy information CSV


file, and then press Enter.
The tiering policy information CSV file is created, and the policy ID
appears in the Policy CSV List area.

4.

Enter a slash (/) in the AC field for the policy ID.


Enter a slash (/) in the AC field for the tiering policy information CSV file
to which you assigned the policy ID.
The Policy CSV List Actions panel appears.

5.

Enter 3 in the entry field or select the Edit 'E' point-and-shoot field.
The ISPF edit panel for editing the tiering policy information CSV file
appears.

6.

Specify information about a tiering policy group to be defined in a CSV


file.

7.

Press the Exit function key.


The specified information is saved, and the Policy CSV List area appears
again.

Postrequisites

Defining tiering policy groups

Related topics

Defining tiering policy groups when using the ISPF panel on page 3-8

Policy CSV List area on page 5-20

Policy ID Entry panel on page 5-22

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-7

Chapter 7, Files used by Tiered Storage Manager for Mainframe on page


7-1

Defining tiering policy groups when using the ISPF panel


To define a tiering policy group, import the tiering policy information CSV file
in the Policy CSV List area in the main panel.

Prerequisites

Scanning the storage system

Create a tiering policy information CSV file.

Procedure
1.

In the main panel, select the Policy CSV List 'Policy' point-and-shoot
field.
The Policy CSV List area appears.

2.

Enter a slash (/) in the AC field for the tiering policy information CSV file.
The Policy CSV List Actions panel appears.

3.

Enter 4 in the entry field or select the Import 'I' point-and-shoot field.
The tiering policy information CSV file is imported and the tiering policy
group is defined. The defined information is saved in the tiering policy
group definition file.

Postrequisites

Applying tiering policies

Related topics

Scanning storage systems when using the ISPF panel on page 3-5

Creating a tiering policy information CSV file when using the ISPF panel
on page 3-7

Applying tiering policies when using the ISPF panel on page 3-8

Policy CSV List area on page 5-20

Applying tiering policies when using the ISPF panel


After you have defined a tiering policy group, you must apply the defined
tiering policies to the storage system. To apply tiering policies, in the main
panel, specify the action for the tiering policy group in the Tiering Policy
Group List area.

Prerequisites

3-8

Defining tiering policy groups.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Procedure
1.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

2.

Enter a slash (/) in the COMMAND field for the tiering policy group to
which you want to apply the tiering policies.
The Tiering Policy Group List Actions panel appears.

3.

Enter 2 in the entry field or select the Activate 'ACT' point-and-shoot


field.
The Confirm TPG Activation panel appears.

4.

Enter a slash (/) in the Yes, activate the TPG. field, and then press
Enter.
The tiering policies are applied to the storage system.

Related topics

Defining tiering policy groups when using the ISPF panel on page 3-8

Policy CSV List area on page 5-20

Verification after scanning storage systems when using the


ISPF panel
The following describes how to verify information about the volumes and
pools after scanning storage systems.

Checking volume information for the scanned storage system when


using the ISPF panel
To check the volume information for the scanned storage system, in the main
panel, from the Storage System List area, open the Volume Selection
List panel, and then check details about the selected volumes in the Volume
Status Detail panel.

Procedure
1.

In the main panel, select the Storage System List 'Storage' point-andshoot field.
The Storage System List area appears.

2.

Enter a slash (/) in the AC field for the storage system containing the
volumes whose information you want to view.
The Storage System List Actions panel appears.

3.

Enter 1 in the entry field or select the Volume Selection 'V' point-andshoot field.
The Volume Selection List panel displays a list of volumes that belong
to the specified storage system.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-9

4.

To display details about a specific volume, enter a slash (/) in the AC


field.
The Volume Selection List Actions panel appears.
Tip: In this step, you can select a point-and-shoot device number instead
of entering a slash (/) in the AC field. This will directly change the panel
display to the Volume Status Detail panel.

5.

3-10

Enter 1 in the entry field or select the Volume Status Detail 'V' pointand-shoot field.
The Volume Status Detail panel displays details about the volume.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Storage System List area on page 5-19

Volume Selection List panel on page 5-36

Volume Status Detail panel on page 5-37

Checking pool information for the scanned storage system when


using the ISPF panel
To check the pool information for the scanned storage system, in the main
panel, from the Storage System List area, open the Pool Selection List
panel, and then check details about the selected pools in the Pool Status
Detail panel.

Procedure
1.

In the main panel, select the Storage System List 'Storage' point-andshoot field.
The Storage System List area appears.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-11

2.

Enter a slash (/) in the AC field for the storage system containing the
pools whose information you want to view.
The Storage System List Actions panel appears.

3.

Enter 2 in the entry field or select the Pool Selection 'P' point-and-shoot
field.
The Pool Selection List panel displays a list of pools that belong to the
specified storage system.

4.

To display details about a specific pool, enter a slash (/) in the AC field.
The Pool Selection List Actions panel appears.
Tip: In this step, you can select a point-and-shoot pool ID instead of
entering a slash (/) in the AC field. This will directly change the panel
display to the Pool Status Detail panel.

5.

3-12

Enter 1 in the entry field or select the Pool Status Detail 'P' point-andshoot field.
The Pool Status Detail panel displays details about the pool.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Storage System List area on page 5-19

Pool Selection List panel on page 5-23

Pool Status Detail panel on page 5-24

Verification after defining a tiering policy group when using


the ISPF panel
This section describes how to verify the management targets (volumes,
pools, and SMS storage groups) after you have defined a tiering policy group.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-13

Verifying definition information for the tiering policy group when


using the ISPF panel
To verify definition information for the defined tiering policy group, in the
main panel, from the Tiering Policy Group List area, open the Tiering
Policy Group Definition panel.

Procedure
1.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

2.

Enter a slash (/) in the COMMAND field for the tiering policy group whose
information you want to view.
The Tiering Policy Group List Actions panel appears.

3.

Enter 7 in the entry field or select the Definition 'D' point-and-shoot


field.
The Tiering Policy Group Definition panel displays definition
information for the specified tiering policy group.

Related topics

3-14

Tiering Policy Group List area on page 5-21

Tiering Policy Group Definition panel on page 5-26

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Verifying storage system information (summary) for the tiering


policy group when using the ISPF panel
To verify storage system information (summary) for the defined tiering policy
group, in the main panel, from the Tiering Policy Group List area, open the
Tiering Policy Group Summary panel.

Procedure
1.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

2.

Enter a slash (/) in the COMMAND field of the tiering policy group for
which you want to view information.
The Tiering Policy Group List Actions panel appears.

3.

Enter 1 in the entry field or select the Summary 'S' point-and-shoot


field.
The Tiering Policy Group Summary panel displays storage system
information for the specified tiering policy group.

Related topics

Tiering Policy Group List area on page 5-21

Tiering Policy Group Summary panel on page 5-31

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-15

Checking SMS storage groups belonging to a tiering policy group


when using the ISPF panel
To verify information about the SMS storage groups belonging to the defined
tiering policy group, in the main panel, from the Tiering Policy Group List
area, open the Tiering Policy Group Storage Group List panel.

Procedure

3-16

1.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

2.

Enter a slash (/) in the COMMAND field for the tiering policy group whose
information you want to view.
The Tiering Policy Group List Actions panel appears.

3.

Enter 4 in the entry field or select the Storage Groups 'SG' point-andshoot field.
The Select Storage Group List panel appears.

4.

Select 1 to display a list of all SMS storage groups contained in the tiering
policy group. If you want to filter the SMS storage groups to be displayed,
select 2 and then specify the filter condition in the Storage Group Name
field.
The Tiering Policy Group Storage Group List panel displays
information about the SMS storage groups.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Tiering Policy Group List area on page 5-21

Tiering Policy Group Storage Group List panel on page 5-30

How to specify the search or filter conditions in ISPF panels on page


B-6

Verifying volume information for the tiering policy group when using
the ISPF panel
To verify information about the volumes belonging to the defined tiering
policy group, in the main panel, from the Tiering Policy Group List area,
open the Tiering Policy Group Volume List panel, and then check details
about the selected volumes in the Tiering Policy Group Volume Status
Detail panel.

Procedure
1.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

2.

Enter a slash (/) in the COMMAND field for the tiering policy group whose
information you want to view.
The Tiering Policy Group List Actions panel appears.

3.

Enter 5 in the entry field or select the Volumes 'V' point-and-shoot field.
The Select Volume List panel appears.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-17

4.

Select 1 to display a list of all volumes contained in the tiering policy


group. If you want to filter the volumes to be displayed, select 2 and then
specify filter conditions in the Volser field.
The Tiering Policy Group Volume List panel displays information about
the volumes.

5.

To display information about a specific volume, enter a slash (/) in the AC


field.
The Tiering Policy Group Volume List Actions panel appears.
Tip: In this step, you can select a point-and-shoot device number instead
of entering a slash (/) in the AC field. This will directly change the panel
display to the Tiering Policy Group Volume Status Detail panel.

6.

3-18

Enter 1 in the entry field or select the TPG Volume Status Detail 'V'
point-and-shoot field.
The Tiering Policy Group Volume Status Detail panel displays the
volume information for the tiering policy group.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Tiering Policy Group List area on page 5-21

Tiering Policy Group Volume List panel on page 5-33

Tiering Policy Group Volume Status Detail panel on page 5-35

How to specify the search or filter conditions in ISPF panels on page


B-6

Verifying pool information for the tiering policy group when using
the ISPF panel
To verify information about the pools belonging to the defined tiering policy
group, in the main panel, from the Tiering Policy Group List area, open the
Tiering Policy Group Pool List panel, and then check details about the
selected pools in the Tiering Policy Group Pool Status Detail panel.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-19

Procedure
1.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

2.

Enter a slash (/) in the COMMAND field for the tiering policy group whose
information you want to view.
The Tiering Policy Group List Actions panel appears.

3.

Enter 6 in the entry field or select the Pools 'P' point-and-shoot field.
The Select Pool List panel appears.

4.

Select 1 to display a list of all pools contained in the tiering policy group.
If you want to filter the pools to be displayed, select 2 and then specify
the filter conditions in the Pool Name field.
The Tiering Policy Group Pool List panel displays information about the
pools.

5.

To display information about a specific pool, enter a slash (/) in the AC


field.
The Tiering Policy Group Pool List Actions panel appears.
Tip: In this step, you can select a pool ID point-and-shoot field instead of
specifying a slash (/) in the AC field. This will directly change the panel
display to the Tiering Policy Group Pool Status Detail.

3-20

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

6.

Enter 1 in the entry field or select the TPG Pool Status Detail 'P' pointand-shoot field.
The Tiering Policy Group Pool Status Detail panel displays the pool
information for the tiering policy group..

Related topics

Tiering Policy Group List area on page 5-21

Tiering Policy Group Pool List panel on page 5-27

Tiering Policy Group Pool Status Detail panel on page 5-28

How to specify the search or filter conditions in ISPF panels on page


B-6

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-21

Frequently used checking methods when using the ISPF


panel
This section describes the check methods that are frequently used in the
Tiered Storage Manager for Mainframe panels.

Checking whether the tiering policies are applied to the storage


system when using the ISPF panel
To check whether the tiering policies are applied to the storage system, use
the Tiering Policy Group Summary panel displayed from the Tiering
Policy Group List area in the main panel. Use this panel to find any volumes
for which the definitions of tiering policies differ from the current status.

Procedure

3-22

1.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

2.

Enter a slash (/) in the COMMAND field for the tiering policy group to be
checked for whether tiering policies have been applied.
The Tiering Policy Group List Actions panel appears.

3.

Enter 1 in the entry field or select the Summary 'S' point-and-shoot


field.
The Mismatch field in the Tiering Policy Group Summary panel
displays the number of volumes in which the definitions of tiering policies
differ from the current status.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

4.

To check the volumes that contain inconsistencies, select the Mismatch


point-and-shoot field.
The Tiering Policy Group Volume List panel displays a list of volumes
for which the definitions of tiering policies differ from the current status.

5.

To check the tiering policies for a specific volume, enter a slash (/) in the
AC field.
The Tiering Policy Group Volume List Actions panel appears.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-23

Tip: In this step, you can select a point-and-shoot device number instead
of entering a slash (/) in the AC field. This will directly change the panel
display to the Tiering Policy Group Volume Status Detail panel.
6.

Enter 1 in the entry field or select the TPG Volume Status Detail 'V'
point-and-shoot field.
The Tiering Policy Group Volume Status Detail panel appears. Tiering
policies for which the values in the Definition field differ from the values
in the CurrentState field have not been applied to the storage system.

Related topics

3-24

Tiering Policy Group List area on page 5-21

Tiering Policy Group Summary panel on page 5-31

Tiering Policy Group Volume List panel on page 5-33

Tiering Policy Group Volume Status Detail panel on page 5-35

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Checking the tier relocation status for volumes when using the ISPF
panel
To check the tier relocation status for volumes, use the Relocation state
field in the Tiering Policy Group Summary panel displayed from the
Tiering Policy Group List area in the main panel.

Procedure
1.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

2.

Enter a slash (/) in the COMMAND field for the tiering policy group to be
checked for the tier relocation status for volumes.
The Tiering Policy Group List Actions panel appears.

3.

Enter 1 in the entry field or select the Summary 'S' point-and-shoot


field.
The Relocation state field of the Tiering Policy Group Summary panel
displays the tier relocation status.

If the number of volumes displayed in the Out of range field is 1 or


more, the tiering policy group is being relocated or is waiting for the next
relocation.
If the number of volumes displayed in the Shortage field is 1 or more,
pages in some volumes cannot be assigned to the tiers that belong to the
specified level due to insufficient pool capacity. You must take actions

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-25

such as increasing the capacity for the tiers with insufficient pool capacity,
or moving data to another pool.
4.

To check the volumes for each relocation status, select the In range,
Out of range, or Shortage point-and-shoot fields.
The Tiering Policy Group Volume List panel displays a list of volumes
in the relocation status you selected above. (The following panel appears
if you selected Shortage).

Use the PoolID field to check the ID of a pool with insufficient capacity.

Related topics

Tiering Policy Group List area on page 5-21

Tiering Policy Group Summary panel on page 5-31

Tiering Policy Group Volume List panel on page 5-33

Checking whether the usage of any pool equals or exceeds the


threshold when using the ISPF panel
To check whether the usage of any pool equals or exceeds the threshold set
in the Set Defaults area in the main panel, use the Tiering Policy Group
Summary panel displayed from the Tiering Policy Group List area in the
main panel. In this panel, check the values shown in the Pools exceeding
threshold field.

Procedure
1.

3-26

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

2.

Enter a slash (/) in the COMMAND field for the tiering policy group for
which you want to find pools whose usage equals or exceeds the
threshold.
The Tiering Policy Group List Actions panel appears.

3.

Enter 1 in the entry field or select the Summary 'S' point-and-shoot


field.
In the Tiering Policy Group Summary panel, the number of pools
whose usage equals or exceeds the threshold appears in the Pools
exceeding threshold field.

4.

To view the pools whose usage equals or exceeds the threshold, select
the Pools exceeding threshold point-and-shoot field.
The Tiering Policy Group Pool List panel displays a list of pools whose
usage equals or exceeds the threshold.

Related topics

Tiering Policy Group List area on page 5-21

Tiering Policy Group Pool List panel on page 5-27

Tiering Policy Group Summary panel on page 5-31

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-27

About changing tiering policy groups when using the ISPF


panel
This section describes how to change tiering policy groups by using the ISPF
panels.

Changing a tiering policy when using the ISPF panel


If you need to change a tiering policy due to lowered I/O performance or a
change in the purpose for which volumes are being used, modify the created
tiering policy information CSV file, update the definition, and then apply the
update to the storage system.

Procedure
1.

Change the tiering policy information CSV file.

2.

In the main panel, select the Policy CSV List 'Policy' point-and-shoot
field to update the definition of the tiering policy group.
The Policy CSV List area appears.

3.

Enter a slash (/) in the AC field for the modified tiering policy information
CSV file.
The Policy CSV List Actions panel appears.

4.

Enter 4 in the entry field or select the Import 'I' point-and-shoot field.
The modified tiering policy information CSV file is imported and the
definition of the tiering policy group is updated.

5.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

6.

Enter a slash (/) in the COMMAND field for the tiering policy group whose
definition was modified.
The Tiering Policy Group List Actions panel appears.

7.

Enter 2 in the entry field or select the Activate 'ACT' point-and-shoot


field.
The Confirm TPG Activation panel appears.

8.

Enter a slash (/) in the Yes, activate the TPG. field, and then press
Enter.
The definition of the modified tiering policy group is applied to the storage
system.

Related topics

3-28

Modifying the tiering policy information CSV file when using the ISPF
panel on page 3-31

Policy CSV List area on page 5-20

Tiering Policy Group List area on page 5-21

Format of tiering policy information CSV files on page 7-4

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Examples of changing a tiering policy information CSV file on page 7-9

Adding a volume to a tiering policy group when using the ISPF panel
To add a volume to a tiering policy group, first add the volume to the
definition of the tiering policy group, and then apply the tiering policies to the
storage system.

Prerequisites

Maybe say prior to doing a scan by SMS storage group or volume serial
numbers, the volumes must be online.

Procedure
1.

Do either of the following:

If adding a volume to an SMS storage group in a tiering policy group:


Add the volume to the definition of the SMS storage group. You do not
need to add any records to the tiering policy information CSV file.
If the volume to be added to a tiering policy group does not belong to
an SMS storage group:
In the tiering policy information CSV file, add the record for the
volume that you want to add.

2.

If the volume to be added has not been scanned, scan that volume to
update the disk configuration definition file.
Information about the volume to be added is saved in the disk
configuration definition file.

3.

In the main panel, select the Policy CSV List 'Policy' point-and-shoot
field to update the definition of the tiering policy group.
The Policy CSV List area appears.

4.

Enter a slash (/) in the AC field for the tiering policy information CSV file.
The Policy CSV List Actions panel appears.

5.

Enter 4 in the entry field or select the Import 'I' point-and-shoot field.
The tiering policy information CSV file is imported and the volume is
added to the definition of the tiering policy group.

6.

In the main panel, select the Tiering Policy Group List 'TPG' point-andshoot field.
The Tiering Policy Group List area appears.

7.

Enter a slash (/) in the COMMAND field for the tiering policy group whose
definition was modified.
The Tiering Policy Group List Actions panel appears.

8.

Enter 2 in the entry field or select the Activate 'ACT' point-and-shoot


field.
The Confirm TPG Activation panel appears.

9.

Enter a slash (/) in the Yes, activate the TPG. field, and then press
Enter.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-29

The updated definition of the tiering policy group is applied to the storage
system.

Related topics

Scanning storage systems when using the ISPF panel on page 3-5

Modifying the tiering policy information CSV file when using the ISPF
panel on page 3-31

Policy CSV List area on page 5-20

Tiering Policy Group List area on page 5-21

Format of tiering policy information CSV files on page 7-4

Examples of changing a tiering policy information CSV file on page 7-9

Deleting a specific volume from a tiering policy group when using the
ISPF panel
To delete a specific volume from a tiering policy group, first change the
tiering policy of the volume applied to the storage system back to the default
(if necessary) and then delete the volume from the definition of the tiering
policy group.
Caution: After you delete a volume from the definition, the tiering policy for
that volume can no longer be changed because Tiered Storage Manager for
Mainframe does not manipulate that volume.
Tip: You can change the tiering policy of the volume to be deleted back to
the default by changing the panel display from the Storage System List
area to the Volume Selection List panel, specifying D for the AC field, and
then executing Deactivate Device.

Procedure
1.

Do either of the following:

3-30

If the volume to be deleted belongs to an SMS storage group:


Exclude the volume from the SMS storage group.
If the volume to be deleted does not belong to an SMS storage group:
Delete the record for the volume from the tiering policy information
CSV file.

2.

In the main panel, select the Policy CSV List 'Policy' point-and-shoot
field to update the definition of the tiering policy group.
The Policy CSV List area appears.

3.

Enter a slash (/) in the AC field for the tiering policy information CSV file.
The Policy CSV List Actions panel appears.

4.

Enter 4 in the entry field or select the Import 'I' point-and-shoot field.
The tiering policy information CSV file is imported and the definition of the
tiering policy group is updated.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Modifying the tiering policy information CSV file when using the ISPF
panel on page 3-31

Storage System List area on page 5-19

Policy CSV List area on page 5-20

Volume Selection List panel on page 5-36

Format of tiering policy information CSV files on page 7-4

Modifying the tiering policy information CSV file when using the ISPF
panel
To modify the tiering policy information CSV file, specify an action for the
target file on the Policy CSV List area in the main panel.
Use the following procedure to modify the tiering policy information CSV file.

Procedure
1.

In the main panel, select the Policy CSV List 'Policy' point-and-shoot
field.
The Policy CSV List area appears.

2.

Enter a slash (/) in the AC field for the target tiering policy information
CSV file.
The Policy CSV List Actions panel appears.

3.

Enter 3 in the entry field or select the Edit 'E' point-and-shoot field.
The ISPF edit panel for editing the tiering policy information CSV file
appears.

4.

Modify the contents of the tiering policy information CSV file.

5.

Press the Exit function key.


The modifications are saved, and the Policy CSV List area appears
again.

Related topics

Policy CSV List area on page 5-20

Chapter 7, Files used by Tiered Storage Manager for Mainframe on page


7-1

Convenient use of list panels


This section describes the convenient use of list panels (panels such as the
Tiering Policy Group Volume List panels that display a list of volumes,
pools, or SMS storage groups).

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-31

Sorting items
To sort items displayed in a listing panel, select the point-and-shoot header
of the items.

Procedure
1.

Select the header in the listing panel.


The items in the field of the header are sorted.
Tip: Another way to sort the items is to enter SORT in the command line
of the ISPF panel to display the Sort Options panel, and specify the sort
conditions.

Filtering displayed information


To filter the displayed information, use the Filter Options panel to specify
filter conditions, and then press Enter.

Procedure
1.

Enter FILTER in the command line of the ISPF panel, and then press
Enter.
The Filter Options panel appears.

2.

Specify the filter conditions.


The following is an example specification. The displayed items vary
depending on the panel that called this panel.

3.

Press Enter.
The information is filtered according to the specified filter conditions.

Related topics

3-32

How to specify the search or filter conditions in ISPF panels on page


B-6

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Searching character strings


To search a character string in a listing panel, use the Find Options panel to
specify the search string, and then press Enter. To conduct another search
by using the same search string, press the Rfind function key.

Procedure
1.

Enter FIND in the command line of the ISPF panel, and then press Enter.
The Find Options panel appears.

2.

Specify the search string.


The following is an example specification.

3.

Press Enter.
The cursor is positioned at a line containing the specified search string.

4.

To conduct another search by using the same search string, press the
Rfind function key.
The cursor is positioned at another line containing the specified search
string.

Related topics

How to specify the search or filter conditions in ISPF panels on page


B-6

Positioning the cursor at a specific line in a sorted field


To position the cursor at a specific line in a sorted field, use the Locate
Options panel to specify the search string, and then press Enter.

Prerequisites

Data in the field in which the cursor is to be positioned has been sorted.

Procedure
1.

Enter LOCATE in the command line of the ISPF panel, and then press
Enter.
The Locate Options panel appears.

2.

Specify the search string.


The following is an example specification. The displayed items vary
depending on the panel that called this panel.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-33

3.

Press Enter.
The cursor is positioned at a line containing the specified search string.

Related topics

How to specify the search or filter conditions in ISPF panels on page


B-6

Setting an action in multiple AC fields


To set or cancel an action in multiple AC fields in a list panel, use the Select
Options panel to specify the target field, the condition character string for
the field, and the action, and then press Enter.

Procedure

3-34

1.

Enter SELECT in the command line of the ISPF panel, and then press
Enter.
The Select Options panel appears.

2.

Specify the AC fields for which the action is to be set or canceled by


specifying the target fields, the condition character string for the fields,
and an action.
The following is an example specification. The displayed items vary
depending on the panel that called this panel.

3.

Press Enter.
The action is set or canceled for multiple AC fields.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

Note: The action is not set or canceled for the lines that are not displayed by
the filter.

Related topics

How to specify the search or filter conditions in ISPF panels on page


B-6

Customizing the ISPF panels


This section describes the settings needed to customize the ISPF panels.

Setting the command line location


Use the ISPF Settings panel to position the command line (Command line)
at the top or bottom of the panel.

Procedure
1.

Enter SETTINGS in the command line of the ISPF panel.


The ISPF Settings panel appears.

2.

Clear the Command line at bottom check box to display the command
line at the top of the panel. Select this check box to display the command
line at the bottom of the panel.

Setting the number of displayed function keys


Use the ISPF Settings panel to set 12 or 24 as the number of displayed
function keys.

Procedure
1.

Enter PFSHOW TAILOR in the command line of the ISPF panel.


The ISPF Settings panel appears.

2.

Enter 1 (12) or 2 (24) in the Number of keys field.


If you entered 2 (24), enter 3 (All - display all keys) in the Display set
field.

Highlighting available point-and-shoot fields


Use the ISPF Settings panel to specify the setting to highlight the available
point-and-shoot fields.

Procedure
1.

Enter PSCOLOR in the command line of the ISPF panel.


The ISPF Settings panel appears.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

3-35

2.

3-36

Set REVERSE in the Highlight column of the Point-and-Shoot row.

Tiered Storage Manager for Mainframe operations when using the ISPF panel
Hitachi Tiered Storage Manager for Mainframe User Guide

4
Tiered Storage Manager for Mainframe
operations when using the CLI
This chapter describes how to use CLI commands to operate Tiered Storage
Manager for Mainframe.
Defining and verifying a tiering policy group when using the CLI
commands
Defining tiering policy groups when using the CLI commands
Verification after defining a tiering policy group when using the CLI
commands
About changing tiering policy groups when using the CLI commands

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-1

Defining and verifying a tiering policy group when using the


CLI commands
The figure below shows the workflow for defining and verifying a tiering policy
group by using the CLI commands.
This figure explains the steps of the procedure, along with the commands and
sample scripts to be executed in the procedure.

Figure 4-1 Workflow for defining and verifying a tiering policy group (CLI
commands)

4-2

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Overview of files used by Tiered Storage Manager for Mainframe on page


1-12

Checking volume information when using the CLI commands on page


4-3

Scanning the storage system when using the CLI commands on page
4-5

Creating a tiering policy information CSV file when using the CLI
commands on page 4-7

Defining tiering policy groups when using the CLI commands on page
4-7

Applying tiering policies when using the CLI commands on page 4-9

Verifying tiering policies when using the CLI commands on page 4-11

Checking the progress of tier relocation when using the CLI commands on
page 4-12

Checking volume I/O performance on page 4-14

Defining tiering policy groups when using the CLI


commands
This section describes how to define a tiering policy group by using the CLI
commands.

Checking volume information when using the CLI commands


Before defining a tiering policy group, acquire volume information from the
storage system by executing the KTQRYDEV command for the volumes to be
defined, and then check the volume information.
Based on the acquired information for volumes, consider how they are used
for tasks and examine the tiering policy group to be defined.

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-3

Figure 4-2 Checking volume information (CLI commands)

Procedure
1.

Specify a volume for which you want to acquire information, and then
execute the KTQRYDEV command.
The acquired volume information is stored in the host-discovered array
structure and the device information structure.

Reference scripts
For details about how to create the script, see sample script KTDEMO04.

Example
The following shows an example of volume information acquired by executing
sample script KTDEMO04 (KTQRYDEV command).
DKC
SN:14001,Model:VSP,Microcode:xxxxxxxx,IFType:1414
Pool
ID, Type,Pool Name
1,
DT,POOLID1

,Media(Tier1,Tier2,Tier3)
,"SSD","SAS 15K","SATA 7.2K"

Volume
Devn,Volser,CU,SSID,CCA,POOLID,TLv, Entry,Reloc
1101,VOL001,00,0000, 00,
1, 1, HIGH,
Y

Postrequisites

Scanning the storage system

Related topics

4-4

Scanning the storage system when using the CLI commands on page
4-5

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

KTQRYDEV on page 6-17

KTDEMO04 (Display the volume information) on page C-11

Scanning the storage system when using the CLI commands


To scan the storage system, first execute the KTSCAN command, and then
execute the KTSTORE command to save the scan results.

Figure 4-3 Scanning the storage system (CLI commands)

Prerequisites

To define a tiering policy group by specifying an SMS storage group or


volume serial numbers, place the volumes online to allow the volume
serial numbers to be detected.

Procedure
1.

Specify the scan range, and then execute the KTSCAN command.
The command acquires disk configuration information, and stores it in the
host-discovered array structure and host-discovered array index
structure.

2.

Execute the KTSTORE command.


The data in the host-discovered array structure is saved in the disk
configuration definition file.

Tip: To view the contents of the disk configuration definition file, execute the
KTGETHDA command.
Tip: If the disk configuration changes significantly after the scan (for
example, because the storage system is replaced or device numbers of
volumes change due to changes in I/O definitions), you must delete the disk
configuration definition file. Then rescan the storage system. If necessary,
change the definition of the tiering policy group.

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-5

Reference scripts
For details about how to create the script, see the following sample scripts.

Creating a disk configuration definition file: KTDEMO00

Checking the contents of the created disk configuration definition file:


KTDEMO01

Example 1:
The code in this example scans devices 0000 through 00FF and volumes FF00
through FFFF, and saves the scan results in the disk configuration definition
file.
CALL KTSCAN "STEM(stem1.) MSG(msgstem.) FROM(0000) TO(00FF)";
CALL KTSCAN "STEM(stem1.) MSG(msgstem.) FROM(FF00) TO(FFFF)";
CALL KTSTORE "STEM(stem1.) MSG(msgstem.) PREFIX(PREFIX1)";

Example 2:
The code in this example scans the volumes with volume serial numbers from
VOL001 through VOL999, and saves the scan results in the disk configuration
definition file.
CALL KTSCAN "STEM(stem1.) MSG(msgstem.) FROMVSN(VOL001)",
"TOVSN(VOL999)";
CALL KTSTORE "STEM(stem1.) MSG(msgstem.) PREFIX(PREFIX1)";

Example 3:
The code in this example scans the volumes that belong to SMS storage
group SG1, and saves the scan results in the disk configuration definition file.
CALL KTSCAN "STEM(stem1.) MSG(msgstem.) STORGRP(SG1)";
CALL KTSTORE "STEM(stem1.) MSG(msgstem.) PREFIX(PREFIX1)";

Postrequisites

Creating a tiering policy information CSV file

Related topics

4-6

Creating a tiering policy information CSV file when using the CLI
commands on page 4-7

KTGETHDA on page 6-9

KTSCAN on page 6-25

KTSTORE on page 6-28

KTDEMO00 (Create a disk configuration definition file) on page C-3

KTDEMO01 (Display the contents of the disk configuration definition file)


on page C-5

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

Creating a tiering policy information CSV file when using the CLI
commands
Specify information about the SMS storage groups or volumes to be defined
as a policy group in a CSV file.
For the tiering policy information CSV file, assign a name in the following
format: prefix.POLICY.policy-ID. prefix is the character string to be
specified in Configuration file prefix on the Edit Defaults panel, or the
character string to be specified in the PREFIX parameter of CLI commands.
Make sure that you specify a character string common to the three types of
files used by Tiered Storage Manager for Mainframe.

Procedure
1.

Determine the configuration of tiering policy groups, and the tiering


policies to be set for the tiering policy groups.
Specify values for the tiering policy level and the new-page assignment
tier, and whether to execute tier relocation.

2.

Create a tiering policy information CSV file.


For details on information that should be written in the CSV file, refer to
the information about tiering policy information CSV files.

Postrequisites

Defining tiering policy groups

Related topics

Defining tiering policy groups when using the CLI commands on page
4-7

Chapter 7, Files used by Tiered Storage Manager for Mainframe on page


7-1

Defining tiering policy groups when using the CLI commands


To define a tiering policy group, execute the KTIMPORT command to import
the tiering policy information CSV file and the disk configuration definition
file.
If the volumes to be defined have not been scanned yet, you can execute the
KTIMPORT command with the SCAN parameter specified to scan the volumes
and create a tiering policy group definition file simultaneously.

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-7

Figure 4-4 Defining tiering policy groups (CLI commands)

Prerequisites

Scanning the storage system

Creating a tiering policy information CSV file

Varying the volumes online if the record type of the tiering policy
information CSV file is specified as STORGRP or VOLSER.

Procedure
1.

Execute the KTIMPORT command.


The command reads the data in the tiering policy information CSV file and
disk configuration definition file, and creates a tiering policy group
definition file.
Tip: If the SCAN parameter is specified, the command scans the range of
the storage system specified in the tiering policy information CSV file, and
creates a disk configuration definition file and a tiering policy group
definition file.

Reference scripts
For details about how to create the script, see the following sample scripts.

4-8

Creating a tiering policy group definition file: KTDEMO02

Checking the contents of the created tiering policy group definition file:
KTDEMO03

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

Example 1:
The code in this example imports a disk configuration definition file whose
prefix is PREFIX1 and a tiering policy information CSV file whose policy ID is
POLICY1, and creates a tiering policy group definition file.
CALL KTIMPORT "MSG(msgstem.) PREFIX(PREFIX1) POLICY(POLICY1)";

Example 2:
The code in this example imports a tiering policy information CSV file whose
policy ID is POLICY1, and creates a disk configuration definition file whose
prefix is PREFIX1 and a tiering policy group definition file simultaneously.
CALL KTIMPORT "MSG(msgstem.) PREFIX(PREFIX1) POLICY(POLICY1) SCAN";

Postrequisites

Applying tiering policies

Related topics

Scanning the storage system when using the CLI commands on page 4-5

Creating a tiering policy information CSV file when using the CLI
commands on page 4-7

Applying tiering policies when using the CLI commands on page 4-9

KTIMPORT on page 6-12

KTDEMO02 (Create a tiering policy group definition file) on page C-8

KTDEMO03 (Display the contents of the tiering policy group definition file)
on page C-10

Applying tiering policies when using the CLI commands


After you have defined a tiering policy group, you must apply the defined
tiering policies to the storage system. To apply tiering policies, use the
KTLOAD command to load the configuration files to the REXX variable
structure, and then execute the KTACTTPG command.

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-9

Figure 4-5 Applying tiering policies (CLI commands)

Prerequisites

Defining tiering policy groups.

Procedure
1.

Execute the KTLOAD command.


Target volume information and information about the tiering policies
defined in configuration files is loaded from the configuration files to the
REXX variable structure.

2.

Execute the KTACTTPG command.


The data set in the REXX variable structures is applied to the storage
system.

Reference scripts
For details about how to create the script, see sample script KTDEMO10.

Example:
The code in this example applies the tiering policies of tiering policy groups
TPG1 and TPG2 to the storage system.
CALL KTLOAD "STEM(stem1.) MSG(msgstem.) PREFIX(PREFIX1) TPG(TPG1)";
CALL KTACTTPG "STEM(stem1.) MSG(msgstem.)";
CALL KTLOAD "STEM(stem2.) MSG(msgstem.) PREFIX(PREFIX1) TPG(TPG2)";
CALL KTACTTPG "STEM(stem2.) MSG(msgstem.)";

4-10

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

Postrequisites

Verification after defining a tiering policy group

Related topics

Defining tiering policy groups when using the CLI commands on page 4-7

Verification after defining a tiering policy group when using the CLI
commands on page 4-11

KTACTTPG on page 6-5

KTLOAD on page 6-14

KTDEMO10 (Apply the tiering policy) on page C-15

Verification after defining a tiering policy group when using


the CLI commands
This section describes how to use CLI commands to verify information after
you have defined a tiering policy group.

Verifying tiering policies when using the CLI commands


By executing the KTQRYTPG command for each tiering policy group, you can
acquire from the storage system the tiering policy information that is set to
each volume. You can view the acquired information to verify tiering policies
applied to the storage system.
If you want to acquire the tiering policy information for a volume, execute the
KTQRYDEV command.

Procedure
1.

Perform either of the following operations to acquire information about


the tiering policies from the storage system.

2.

To acquire information for each tiering policy group, execute the


KTLOAD command, and then the KTQRYTPG command.
To acquire information for each volume, execute the KTQRYDEV
command.

View the acquired information, and confirm whether the tiering policies
have been applied.

Reference scripts
For details about how to create the script, see the following sample scripts.

To verify the tiering policies of a tiering policy group: KTDEMO11

To verify the tiering policies of a volume: KTDEMO04

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-11

Example :
The following shows an example of the tiering policy information specified for
each volume in tiering policy group TPG1 acquired by executing sample script
KTDEMO11 (KTLOAD and KTQRYTPG commands).
Tiering Policy Group Name: TPG1
Volumes
Devn,Volser,STORGRP ,SN
,CU,SSID,CCA,POOLID,TLv, Entry,Reloc
0000,VOL001,SG1
,14001,00,0000, 00,
1, 1,MIDDLE,
Y
:

Related topics

KTLOAD on page 6-14

KTQRYDEV on page 6-17

KTQRYTPG on page 6-21

KTDEMO04 (Display the volume information) on page C-11

KTDEMO11 (Check the tiering policy) on page C-16

Checking the progress of tier relocation when using the CLI


commands
By executing the KTQRYTPG command or the KTQRYRLC command, you can
acquire the page relocation status of each volume in the tiering policy groups
or information about Dynamic Tiering for Mainframe pools. You can view the
acquired information to check the progress of tier relocation.

Procedure
1.

Execute the KTLOAD command.


The contents of the configuration files are loaded into REXX variable
structures.

2.

Execute either of the following commands.

3.

To acquire the page relocation status of each volume:


Execute the KTQRYTPG command.
To acquire the progress information about tier relocation for each
Dynamic Tiering for Mainframe pool:
Execute the KTQRYRLC command.

View the acquired information and check the progress of tier relocation.

Reference scripts
For details about how to create the script, see the following sample scripts.

4-12

To acquire the page relocation status of each volume: KTDEMO12

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

To acquire progress information about tier relocation for each Dynamic


Tiering for Mainframe pool: KTDEMO13

Example 1:
The following shows an example of the data allocation information for each
tier of the volume acquired by executing sample script KTDEMO12 (KTLOAD
and KTQRYTPG commands).
Tiering Policy Group Name: TPG1
Volumes Tier Status

POOL
Devn,Volser,SN
,CU,CCA, ID,TLv, Cylinders, Tier1Page, Tier2Page, Tier3Page
412D,
,14001,02, 2D, 2, 3,
3339,
0,
1,
0
412E,
,14001,02, 2E, 2, 3,
3339,
0,
1,
0

Example 2:
The following shows an example of information acquired by executing sample
script KTDEMO13 (the KTLOAD, KTQRYTPG, and KTQRYRLC commands). This
information shows the page relocation status of each volume in the tiering
policy group TPG1 and the tier relocation progress for each Dynamic Tiering
for Mainframe pool.
Tiering Policy Group Name: TPG1
Volumes

POOL
Devn,Volser,SN
,CU,CCA, ID,TLv,RelocateStatus
0000,VOL001,14001,00, 00, 1, 3,done
:

,LocatedPage/ TotalPage
,
1/
1

Pools
Relocate RelocateTime
MigrationPage
SN
, ID, Type,Monitor,active %,Start, End,ExpectedCt,MigratedCt
14001, 1,
DT,
auto,Y
100%,00:00,01:00,
0,
0
:
Pools tier status
SN
, ID,Tier,
Used/ Capacity,EntryBuf%,RelocBuf%,Media
14001, 1,
1,
1/
26
0%,
2%,"SSD"
14001, 1,
2,
263/
2631
8%,
2%,"SAS 15K"
14001, 1,
3,
1036/
131578
8%,
2%,"SATA 7.2K"
14001, 2,
1,
2/
26
0%,
2%,"SSD"
14001, 2,
2,
263/
2631
8%,
2%,"SAS 15K"
14001, 2,
3,
1036/
131578
8%,
2%,"EXTERNAL H"
:

Related topics

KTLOAD on page 6-14

KTQRYRLC on page 6-19

KTQRYTPG on page 6-21

KTDEMO12 (Check the page relocation status) on page C-18

KTDEMO13 (Check the relocation progress) on page C-20

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-13

Checking volume I/O performance


By executing the KTQSTATS command, you can acquire I/O performance
information (number of I/O operations for the drive media) for each volume
in a tiering policy group. You can view the acquired information to check if
there is any problem with the I/O performance of volumes.

Procedure
1.

Execute the KTLOAD command.


The contents of the configuration files are loaded into REXX variable
structures.

2.

Execute the KTQSTATS command.


The volume I/O performance information is acquired.

Reference scripts
For details about how to create the script, see sample script KTDEMO14.

Example:
The following shows an example of the volume I/O performance information
for tiering policy group TPG1 acquired by executing sample script KTDEMO14
(KTLOAD and KTQSTATS commands).
Tiering Policy Group Name : TPG1
Monitor Interval Time(sec): 600
Volume I/O statistics
------------------------------------------------------11:23:00 - 11:33:00
------------------------------------------------------DEVN,Volser,STORGRP,SN
,CU,CCA,Tier1 IOPS,Tier2 IOPS,Tier3 IOPS
1101,VOL001,SG1
,14001,00, 01,
100,
253,
1486
1201,VOL002,SG1
,14001,00, 01,
20,
0,
0
------------------------------------------------------11:33:00 - 11:43:00
------------------------------------------------------DEVN,Volser,STORGRP,SN
,CU,CCA,Tier1 IOPS,Tier2 IOPS,Tier3 IOPS
1101,VOL001,SG1
,14001,00, 01,
60,
0,
0
1201,VOL002,SG1
,14001,00, 01,
4,
0,
0
:

Related topics

4-14

KTLOAD on page 6-14

KTQSTATS on page 6-23

KTDEMO14 (Check I/O performance information) on page C-26

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

About changing tiering policy groups when using the CLI


commands
This section describes how to change tiering policy groups by using CLI
commands.

Changing a tiering policy when using the CLI commands


If you need to change a tiering policy due to lowered I/O performance or a
change in the purpose for which volumes are being used, modify the created
tiering policy information CSV file, update the definition, and then apply the
update to the storage system.

Procedure
1.

Change the tiering policy information CSV file.

2.

Execute the KTIMPORT command.


The definition of the tiering policy group is updated with the contents of
the modified tiering policy information CSV file.

3.

Execute the KTLOAD command.


The contents of the configuration files are loaded into REXX variable
structures.

4.

Execute the KTACTTPG command.


Information about the modified tiering policy is applied to the storage
system.

5.

Execute the KTQRYTPG command to check the tiering policy.


Confirm that the tiering policy has been applied to the storage system.

Related topics

KTACTTPG on page 6-5

KTACTTPG on page 6-5

KTIMPORT on page 6-12

KTLOAD on page 6-14

KTQRYTPG on page 6-21

Format of tiering policy information CSV files on page 7-4

Adding a volume to a tiering policy group when using the CLI


commands
To add a volume to a tiering policy group, add a volume to the definition of
the tiering policy group, and then apply the tiering policies to the storage
system.

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-15

Prerequisites

To specify the scan range by SMS storage group or volume serial number,
place the volume online.

Procedure
1.

Perform either of the following operations:

If adding a volume to an SMS storage group in a tiering policy group:


Add the volume to the definition of the SMS storage group. You do not
need to add any records to the tiering policy information CSV file.
If the volume to be added to a tiering policy group does not belong to
an SMS storage group:
In the tiering policy information CSV file, add the record for the
volume that you want to add.

2.

If the volume information to be added has not been scanned, you need to
execute the KTSCAN command with the volumes specified in the scan
range to update the disk configuration definition file.
The disk information of the volume to be added is stored in the hostdiscovered array structure and host-discovered array index structure.

3.

Execute the KTSTORE command.


The disk configuration definition file is updated.

4.

Execute the KTIMPORT command to update the definition of the tiering


policy group.
The tiering policy group definition file is updated, and the volume is
added.

5.

Execute the KTLOAD command.


The contents of the updated configuration files are loaded into REXX
variable structures.

6.

Execute the KTACTTPG command.


The contents of the updated configuration files set in the REXX variable
structures is applied to the storage system.

7.

Execute the KTQRYTPG command.


Confirm whether the tiering policy has been applied to the added volume.

Tip: You can also update the disk configuration definition file by executing
the KTIMPORT command with the SCAN parameter specified, instead of
executing the KTSCAN and KTSTORE commands.

Related topics

4-16

KTACTTPG on page 6-5

KTACTTPG on page 6-5

KTIMPORT on page 6-12

KTLOAD on page 6-14

KTQRYTPG on page 6-21

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

KTSCAN on page 6-25

KTSTORE on page 6-28

Format of tiering policy information CSV files on page 7-4

Deleting a specific volume from a tiering policy group when using the
CLI commands
To delete a specific volume from a tiering policy group, first change the
tiering policy of the volume applied to the storage system back to the default
(if necessary), and then delete the volume from the definition of the tiering
policy group.
Caution: After you delete a volume from the definition, the tiering policy for
that volume can no longer be changed because Tiered Storage Manager for
Mainframe does not manipulate that volume.
Tip: You can use the KTDCTDEV command to change the tiering policy of the
volume to be deleted back to the default.

Procedure
1.

Execute the KTQRYDEV command to view information about the volume to


be deleted.

2.

Perform either of the following operations:

3.

If the volume to be deleted belongs to an SMS storage group:


Exclude the volume from the SMS storage group.
If the volume to be deleted does not belong to an SMS storage group:
Delete the record for the volume from the tiering policy information
CSV file.

Execute the KTIMPORT command.


The volume is deleted from the definition of the tiering policy group.
Tiered Storage Manager for Mainframe does not manipulate the volume.

Reference scripts
Refer to the sample script KTDEMO05 for details on how to create scripts for
changing the tiering policy of volumes back to the default by using the
KTDCTDEV command.

Related topics

KTDCTDEV on page 6-6

KTIMPORT on page 6-12

KTQRYDEV on page 6-17

Format of tiering policy information CSV files on page 7-4

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

4-17

4-18

KTDEMO05 (Change the tiering policy of a volume back to the default) on


page C-14

Tiered Storage Manager for Mainframe operations when using the CLI
Hitachi Tiered Storage Manager for Mainframe User Guide

5
ISPF panels
This chapter describes transition, operation methods, and displayed items of
the ISPF panel in Tiered Storage Manager for Mainframe.
Panel relationships of Tiered Storage Manager for Mainframe
Common items in the panel
Device Scan Scope panel
Edit Defaults panel
Error Code Help panel
Exception Message List panel
Main panel
Manage Licenses panel
Policy ID Entry panel
Pool Selection List panel
Pool Status Detail panel
Setting Information panel
Tiering Policy Group Definition panel
Tiering Policy Group Pool List panel

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-1

Tiering Policy Group Pool Status Detail panel


Tiering Policy Group Storage Group List panel
Tiering Policy Group Summary panel
Tiering Policy Group Volume List panel
Tiering Policy Group Volume Status Detail panel
Volume Selection List panel
Volume Status Detail panel

5-2

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Panel relationships of Tiered Storage Manager for


Mainframe
The main panel is the panel that appears when Tiered Storage Manager for
Mainframe is started, and has five areas that are the gateways to each
operation. Select the area according to the operation you want to perform.
Select a point-and-shoot field or specify the action to move to the next panel.
The following figure shows the panel relationships of Tiered Storage Manager
for Mainframe.

Figure 5-1 Panel relationships of Tiered Storage Manager for Mainframe

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-3

Common items in the panel


This section describes the common items between the panels for Tiered
Storage Manager for Mainframe.

About the layout of the panels


This section describes the layout of the panels for Tiered Storage Manager for
Mainframe.
The following figure indicates the layout of the Tiering Policy Group Pool
List panel.

About the action bar


The action bar of the Tiered Storage Manager for Mainframe panel contains
the Goto, Commands, and Help menus.

Goto
The Goto pull-down menu displays the name of the panels that you can
move to from the current panel.

5-4

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Figure 5-2 Goto pull-down menu (Tiering Policy Group Pool List panel)
Tip: When you select and move to a panel from the Goto pull-down menu,
and then press Exit function key or Cancel function key in the panel that
appears, you will return to the main panel, not to the original panel.

Commands
The Commands pull-down menu displays the command that can be executed
in the current panel.

Figure 5-3 Commands pull-down menu (Tiering Policy Group Pool List
panel)

Help
The Help pull-down menu displays the name of the Help panels that can be
referenced from the current panel.

Figure 5-4 Help pull-down menu (Main panel)

Related topics

Commands that can be used in the command line

About the AC and COMMAND fields


These are fields for specifying the action of the target.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-5

The following are some example of values that can be specified for the AC or
COMMAND field. For other specifiable values, see the explanation for each
panel.
Specifiable value for
AC or COMMAND field

Action

Displays the list or detailed information of the volumes.

Displays the list or detailed information of the pools.

SG

Displays the list of SMS storage groups.

ACT

Applies the tiering policy to the storage system.

DCT

Changes the tiering policy to default status.

Displays the list of actions (actions panels) that can be


specified for each panel.

Tip: If you position the cursor in the AC or COMMAND field and then press
the Enter key, the system operates the same as when / is specified.
The following figure show an example of actions panels when / is specified to
AC or COMMAND field.

5-6

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

About point-and-shoot field


When you place the cursor on a selectable point-and-shoot field and then
press the Enter key, the action set to that field can be executed.
In this manual, selectable point-and-shoot fields are indicated in light-blue
text. In order to check which point-and-shoot fields are selectable in the
actual panel, enable the highlighting settings.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-7

Tip: Depending on the settings of the terminal emulator, you can select
point-and-shoot fields by using the mouse, instead of by pressing the Enter
key. For details on this setting, see the documentation for the terminal
emulator that you are using.
The following explains the actions that are executed when you select a pointand-shoot field.

Table 5-1 Actions that are executed when you select a point-and-shoot
field
Location

Executed action

Header of the
list

Sorts the rows based on the field value under the corresponding
header.

Field

Displays a panel that displays a list or detailed information for the


corresponding field.

Tip: If the list you are displaying has PoolID and SN as the header and you
select the PoolID point-and-shoot field, SN and PoolID will be sorted in a
multi-column sort. If the list you are displaying has CU and CCA as the
header and you select the CCA point-and-shoot field, CU and CCA will be
sorted in a multi-column sort.

Example of point-and-shoot actions

5-8

Header of the list


When you select the State header point-and-shoot field, the rows are
sorted based on the values in the State header.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Field
The following is a representative example of an action executed by
selecting a point-and-shoot field.
Point-and-shoot fields
Volume statuses such as In range,
Mismatch, and Pools exceeding
threshold

Action that is executed


Displays the list of volumes of the selected
status.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-9

Point-and-shoot fields
Volumes, pools

Action that is executed


Displays the details of the selected volumes
or pools.

The following example show the list of volumes when the volume status is
selected as the point and shoot field.

5-10

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Highlighting available point-and-shoot fields on page 3-35

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-11

About the display unit


For the panels that have a capacity or used capacity displayed, Unit: unit is
displayed on the top right-corner in the panel. The display unit is either Page
or GB.
If the list is displayed in units of GB, the number after the decimal point is
truncated and displayed for the capacity and used capacity. However, if the
value is less than 1, the displayed value is rounded up.
If you select the Unit point-and-shoot field, the following Switch the Unit
panel appears, and you can change the unit to be displayed.

Device Scan Scope panel


In this panel, you can scan a storage system volumes that are connected to a
host. Specify a scan target with an SMS storage group name, volume serial
number, or device number, and then press the Scan function key (F6).

5-12

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item
Storage Group

Description
To specify the target by SMS storage group, specify /,
and then in the input field, enter an SMS storage
group name to be scanned.
Specify /, and then without entering an SMS storage
group name, press the Enter key with the cursor on
the input field or press the Scan function key (F6) to
display the Storage Group Selection List pop-up
window. A list of selectable SMS storage groups is
displayed.

Volser

To specify the target by volume serial number,


specify /, and then specify the range of volume serial
numbers to be scanned in Start and End (order of
EBCDIC codes).
To scan only one volume, specify the same value for
Start and End.

Device Number

To specify the target by device number, specify /, and


then specify the range of device numbers to be
scanned in Start and End (ascending hexadecimal
number order).
To scan only one volume, specify the same value for
Start and End.

When scanning finishes, the panel displays the unit used for the scan, the
scope of the scan, and the number of detected volumes.
After scanning, press the Exit function key to create or update disk
configuration definition files with the following name, and save the
configuration information of the detected volumes:

prefix.DSK.SNnnnnn.LOCAL
prefix: The prefix value specified to Configuration file prefix in the Set
Defaults area
nnnnn: The serial number of the storage system

Press the Cancel function key to discard the changes and exit.

Related topics

Set Defaults area on page 5-18

Edit Defaults panel


In this pop-up window, you can edit basic settings for operating Tiered
Storage Manager for Mainframe from the ISPF panel.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-13

Item
ISPF log max

Description
Specifies the upper limit for the number of messages
that are output to the ISPF log when one command is
executed. The value for this option should be an
integer that is either 0 or between 10 and 5000,
inclusive. The recommended value is 100. If no value
is specified, 0 will be set, and the number of messages
will not be limited.

0: The number of messages is not limited (all


messages are output).

10 to 5000: The specified number (integer) of


messages are output.

Pool usage threshold

Specifies the threshold for the pool usage rate


between 0 and 100. The number of pools whose usage
rate equals or exceeds the threshold specified by this
item is displayed in Pool Summary in the Tiering
Policy Group Summary panel. If no value is
specified, 80 will be set.

Capacity unit

The capacity unit for volumes, pools, SMS storage


groups, and tiering policy groups. Specify either Page
(pages) or GB (gigabytes). If no value is specified,
Page will be set.

Related topics

Tiering Policy Group Summary panel on page 5-31

Error Code Help panel


You can specify an error code to display the error code details.

5-14

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item
Type of error

Description
Displays the type of errors.

Exception Message List panel


This pop-up window displays warnings and error messages of a requested
operation in chronological order. Operations and output messages are stored
in the ISPF log. If there are multiple messages, you can scroll across the
panel.
At the top of the line, the results of the executed command are displayed.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-15

Item
Message

Description
If the message shows an error code, the error code
details are displayed in the Error Code Help panel by
placing the cursor on the displayed error code and
then pressing the ErrCode function key (F4).

Operations and output messages are stored in the ISPF log.


Press the Cancel function key to close the panel.

Related topics

Error Code Help panel on page 5-14

Main panel
This section explains the Main panel and the areas in the panel.

Main panel (common)


The panel appears when Tiered Storage Manager for Mainframe is started. In
the main panel, you can list each target object. There are some object lines
in the middle of the panel. Select the line point-and-shoot field to expand the
accordion menu of the target object. To contract the accordian menu, select
the point-and-shoot field on the line again.

Item
Installation Management

5-16

Description
Displays operation menus related to the installation of
Tiered Storage Manager for Mainframe.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item

Description

Set Defaults

Displays basic setting for using Tiered Storage


Manager for Mainframe on ISPF panel.

Storage System List

Display a list of storage systems for storage system


actions.

Policy CSV List

Display a list of tiering policy information CSV file


actions.

Tiering Policy Group List

Display a list of tiering policy group actions.

Tip: In the upper part of the panel, items in the accordion menu are
abbreviated as a shortcut bar. The accordion menu is also expanded by
selecting a shortcut bar item that is a point-and-shoot field. Short cut bar
item is also executed from the command line by entering the item name.

Related topics

Installation Management area on page 5-17

Set Defaults area on page 5-18

Storage System List area on page 5-19

Policy CSV List area on page 5-20

Tiering Policy Group List area on page 5-21

Installation Management area


This area displays operation menus related to the installation of Tiered
Storage Manager for Mainframe.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-17

Item
<Licenses>

Description
Select the <Licenses> point-and-shoot field to go to
the Manage Licenses panel for registering or
displaying license information.

Related topics

Manage Licenses panel on page 5-22

Set Defaults area


This area displays basic settings for operating Tiered Storage Manager for
Mainframe from the ISPF panel.

Item

Description

<Edit>

Select the <Edit> point-and-shoot field to display the


Edit Defaults pop-up window where you can edit
basic settings.

ISPF log max

Displays the upper limit for the number of messages


that can be output to the ISPF log when one command
is executed.

Pool usage threshold

5-18

0: The number of messages is not limited (all


messages are output).

10 to 5000: The specified number (integer) of


messages are output.

Displays the threshold for pool usage rate. The


number of pools whose usage rate equals or exceeds
this value is displayed in Pool Summary in the
Tiering Policy Group Summary panel.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item

Description

Capacity unit

Displays the unit for capacity and usage on volumes,


pools, SMS storage groups, and tiering policy groups.

Related topics

Edit Defaults panel on page 5-13

Tiering Policy Group Summary panel on page 5-31

Storage System List area


In this area you can perform actions for storage systems.

Item

Description

<Scan>

Select the <Scan> point-and-shoot field to go to the Device Scan


Scope panel to scan storage systems.

AC

The action to be executed for the selected storage system.


You can specify the following actions:

V: Goes to the Volume Selection List panel.

P: Goes to the Pool Selection List panel.

D: Deletes the disk configuration definition file for the selected


storage system.

Related topics

Device Scan Scope panel on page 5-12

Pool Selection List panel on page 5-23

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-19

Volume Selection List panel on page 5-36

Policy CSV List area


In this area, you can perform actions for tiering policy information CSV files.

Item

Description

<Create>

Select the <Create> point-and-shoot field to display


the Policy ID Entry pop-up window for creating
tiering policy information CSV files.

AC

The action to be executed for the selected tiering


policy information CSV file.
You can specify the following actions:

V: Displays the contents of the selected tiering


policy information CSV file.

C: Copies the selected tiering policy information


CSV file. The Policy ID Entry panel for entering
the policy ID of the tiering policy information CSV
file at the copy destination appears.

E: Displays the panel for editing the contents of


the selected tiering policy information CSV file.

I: Imports the selected tiering policy information


CSV file, to create creates a tiering policy group
definition file.

D: Deletes the selected tiering policy information


CSV file.

Related topics

5-20

Policy ID Entry panel on page 5-22

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Tiering Policy Group List area


In this area, you can perform actions for tiering policy groups.

Item

Description

COMMAND

The action to be executed for the selected tiering policy group.


You can specify the following actions:

S: Goes to the Tiering Policy Group Summary panel.

ACT: Applies the tiering policy to the storage systems.

DCT: Changes the tiering policy back to the default.

SG: Goes to the Tiering Policy Group Storage Group List


panel.

V: Goes to the Tiering Policy Group Volume List panel.

P: Goes to the Tiering Policy Group Pool List panel.

D: Goes to the Tiering Policy Group Definition panel.

DEL: Deletes the tiering policy group definition file.

In addition to the action characters, the TSO/E command, REXX


exec and CLIST can be specified on the COMMAND field. Prefix and
tiering policy group ID character strings are passed to the specified
command in this order as parameters.

Related topics

Tiering Policy Group Definition panel on page 5-26

Tiering Policy Group Pool List panel on page 5-27

Tiering Policy Group Storage Group List panel on page 5-30

Tiering Policy Group Summary panel on page 5-31

Tiering Policy Group Volume List panel on page 5-33

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-21

Manage Licenses panel


In this panel, you can register a license or display the license information for
Tiered Storage Manager for Mainframe.

Item
PP Name

Description
Displays the license name.

HTSM for MF: Tiered Storage Manager for


Mainframe license

If a license key for Business Continuity Manager is


installed in the license information dataset, the
Business Continuity Manager license is also displayed.
Model

Displays the model code for the storage system. For


the displayed values, see Help.

Type

Displays the license type.

Capacity

Perm.: Permanent license

Temp.: Temporary license

Emer.: Emergency license

Displays the licensed capacity (unit: TB). If Unlimited


is displayed, the capacity is unlimited.

Policy ID Entry panel


In this panel, you can specify a policy ID for creating or copying tiering policy
information CSV files.

5-22

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item
Policy ID

Description
The policy ID for a tiering policy information CSV file.

To create a file: Specify a policy ID for the file to


be created.

To copy a file: Specify the policy ID of the copy


destination file.Specify a valid value as a symbolic
name because the policy ID is used as a qualifier
of a data set name.

Pool Selection List panel


This panel displays a list of pools in a storage system.

Item
AC

Description
Specify the action to be executed for the selected
pool.
You can specify the following actions:

V: Goes to the Volume Selection List panel.


This panel displays the list of volumes that belong
to the selected pool.

P: Goes to the Pool Status Detail panel. This


panel displays details of the selected pool.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-23

Item
PoolName

Description
Displays the pool name up to 16 characters. You can
view pool names that exceed 16 characters in the
Tiering Policy Group Pool Status Detail panel.

Related topics

Pool Status Detail panel on page 5-24

Tiering Policy Group Pool Status Detail panel on page 5-28

Volume Selection List panel on page 5-36

Pool Status Detail panel


This panel displays detail information of the selected pool.

5-24

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Current Relocation Information


Displays the current relocation status and capacity and usage information for
each tier.
Item

Description

Relocation mode

Relocation status

Progress rate

Displays the monitoring mode.

Auto: Automatic execution mode (tier relocation is performed


automatically)

Manual: Manual execution mode

Displays the relocating status.

In progress: Relocation is in progress

Finished or stopped: Relocation has finished or stopped

Displays the relocation progress (%).


If relocation has never been performed, no value is displayed.

Buffer for Entry(%) Displays the free-area-ratio for new-page assignment (%).
Reloc(%) Displays the ratio (%) of the relocation buffer area.

Previous Relocation Information


Displays the information about the result of the tier relocation that was
executed in the previous cycle. If tier relocation has never been performed,
the item will be blank.
Item

Description

Expected

Displays the expected number of migrated pages.

Migrated

Displays the migrated pages.

Basic Information
Displays the basic information of the pool.

Setting Information panel


This pop-up window displays basic information for operating Tiered Storage
Manager for Mainframe from the ISPF panel.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-25

Item

Description

ISPF Log Max

Displays the upper limit of the number of messages that are output to
the ISPF log when one command is executed.

Pool usage threshold

Displays the threshold for the pool usage rate. The number of pools
whose usage rate equals or exceeds this value is displayed in Pool
Summary in the Tiering Policy Group Summary panel.

Capacity Unit

Displays the unit for capacity and usage on volumes, pools, SMS storage
groups, and tiering policy groups.

Related topics

Tiering Policy Group Summary panel on page 5-31

Tiering Policy Group Definition panel


This panel displays the contents of the tiering policy group definition.

Item
AC

Description
Specify the action to be executed for the selected volume.
You can specify the following actions:

V: Goes to the Tiering Policy Group Volume Status Detail panel.

P: Goes to the Tiering Policy Group Pool Status Detail panel.

TLv

Displays the tiering policy level. The tier to which pages are assigned is
shown in the Tiering Policy Group Volume Status Detail panel.

Entry

Displays the tier to which new pages are assigned.

5-26

HIGH: New pages are assigned to the higher tier.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item

Reloc

Description

MIDDLE: New pages are assigned to the middle tier.

LOW: New pages are assigned to the lower tier.

Displays whether tier relocation is executed.

Y: Tier relocation is enabled.

N : Tier relocation is disabled.

Related topics

Tiering Policy Group Pool Status Detail panel on page 5-28

Tiering Policy Group Volume Status Detail panel on page 5-35

Tiering Policy Group Pool List panel


This panel displays a list of pools in a tiering policy group. To display each
tier's capacity information in the right-hand panel, either press the Next
function key or select the Next ---> point-and-shoot field. To return to the
left-hand panel, either press the Prev function key or select the <--- Prev
point-and-shoot field.
The following figure shows the left-hand panel of the Tiering Policy Group
Pool List panel:

The following figure shows the right-hand panel of the Tiering Policy Group
Pool List panel:

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-27

Item

Description

AC

Specify the action to be executed for the selected pool.


You can specify the following actions:

PoolName

P: Goes to the Tiering Policy Group Pool Status Detail panel.

Displays the pool name up to 16 characters. You can view pool names that
exceed 16 characters in the Tiering Policy Group Pool Status Detail panel.

Related topics

Tiering Policy Group Pool Status Detail panel on page 5-28

Tiering Policy Group Pool Status Detail panel


This panel displays detailed information of the selected pool that belongs to
the tiering policy group.

5-28

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Current Relocation Information


Displays the current relocation status and the capacity and usage information
for each tier.
Item
Relocation
mode

Relocation
status

Progress rate

Description
Displays the monitoring mode.

Auto: Automatic execution mode (tier relocation is performed automatically)

Manual: Manual execution mode

Displays the relocation status.

In progress: Relocation is in progress

Finished or stopped: Relocation is finished or stopped

Displays the relocation progress (%).


If relocation has never been performed, no value is displayed.

Buffer Entry(
for
%)

Displays the free-area-ratio for new-page assignment (%).

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-29

Item

Description

Reloc(
%)

Displays the ratio (%) of the relocation buffer area.

Previous Relocation Information


Displays the information about the result of the tier relocation that was
executed in the previous cycle. If relocation has never been performed, this
item is blank.
Item

Description

Expected

Displays the expected number of migrated pages.

Migrated

Displays the migrated pages.

Basic Information
Displays the basic information of the pool.

Tiering Policy Group Storage Group List panel


This panel displays a list of SMS storage groups to which the volumes in the
tiering policy group belong, and information about the capacity of those
storage groups.

Item
AC

5-30

Description
Specify the action to be executed for the selected storage group.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item

Description

V: Goes to the Tiering Policy Group Volume List panel.

Tier1, Tier2, Tier3

Displays the amount of space used on each tier by all the volumes that
belong to the SMS storage group.

%T1, %T2, %T3

Displays the distribution ratio (%) of the usage of each tier by all the
volumes that belong to the SMS storage group.

Total

Displays the total amount of space used by all the volumes that belong to
the SMS storage group.

Related topics

Tiering Policy Group Volume List panel on page 5-33

Tiering Policy Group Summary panel


This panel displays the following information about a tiering policy group:
capacity information, page relocation status, pools whose usage rate equals
or exceeds the threshold, and whether the tiering policy is correctly applied to
the storage system. In this panel, you can check the summary status
information of the tiering policy group. To go to the detailed information
panel, select a field name point-and-shoot field.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-31

TPG Summary - Capacity and usage information


Item

Description

Tier1, Tier2, Tier3

Displays the amount of space used on each tier by all volumes that belong
to tiering policy group.

%T1, %T2, %T3

Displays the distribution ratio (%) of the usage of each tier by all volumes
that belong to the tiering policy group.

Total

Displays the total amount of space used by all volumes that belong to the
tiering policy group.

Capacity

Displays the total capacity of all volumes in the tiering policy group.

Volume Summary - Relocation state


Item

Description

In range

Displays the number of volumes for which all pages in the volume are
assigned to the tiers specified by tiering policy level. Select the In range
point-and-shoot filed to display the volumes whose statuses are In range in
the Tiering Policy Group Volume List panel.

Out of range

Displays the number of volumes for which some pages in the volume are not
assigned to the tiers specified by tiering policy level. Select the Out of
range point-and-shoot filed to display the volumes whose statuses are Out
of range in the Tiering Policy Group Volume List panel.

Shortage

Displays the number of volumes for which some pages in the volume are not
assigned to the tiers specified by tiering policy level due to insufficient pool
capacity. Select the Shortage point-and-shoot filed to display the volumes
whose statuses are Shortage in the Tiering Policy Group Volume List
panel.

Tip: When a volume is in the Shortage status, you need to take measures
such as adding capacity to the pool or moving data to other pools.

Volume Summary - TPG definition and active policy comparison


Item
Mismatch

Description
Displays the number of volumes for which the tiering policy defined for the
tiering policy group is different from the tiering policy set for the storage
system. Select the Mismatch point-and-shoot filed to display the
volumeswhose statuses are Mismatch in the Tiering Policy Group Volume
List panel.

Pool Summary - Pool usage threshold


Item
Pools exceeding
threshold

5-32

Description
Displays the number of pools whose usage rate equals or exceeds the
threshold specified for Pool usage threshold in the Edit Defaults panel.
Select the Pools exceeding threshold point-and-shoot filed to display the

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item

Description
volumes whose usage rate equals or exceeds the threshold in the Tiering
Policy Group Pool List panel.

Tip: When a pool is in the Pools exceeding threshold status, you need to
take measures such as adding capacity to the pool or moving data to other
pools.

Related topics

Edit Defaults panel on page 5-13

Tiering Policy Group Pool List panel on page 5-27

Tiering Policy Group Volume List panel on page 5-33

Tiering Policy Group Volume List panel


This panel displays a list of volumes in a tiering policy group and the status of
those volumes. To display each tier's capacity information in the right-hand
panel, either press the Next function key or select the Next ---> point-andshoot field. To return to the left-hand panel, either press the Prev function
key or select the <--- Prev point-and-shoot field.
The following figure shows the left-hand panel of the Tiering Policy Group
Volume List panel:

The following figure shows the right-hand panel of the Tiering Policy Group
Volume List panel:

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-33

Item
AC

Description
Specify the action to be executed for the selected volume.

V: Goes to the Tiering Policy Group Volume Status Detail


panel.

P: Goes to the Tiering Policy Group Pool Status Detail


panel.

Diff

If the tiering policy defined in the tiering policy group definition file
is different from the tiering policy set for the storage system, * is
displayed. If these tiering policies are the same, nothing is
displayed.

TLv

Displays the tiering policy level set for the storage system. The
Tiering Policy Group Volume Status Detail panel shows which
pages are assigned to which tier.

State

Displays the volume relocation status.

In range: All pages are assigned to the tiers specified by


tiering policy level.

Out of range: Some pages are not assigned to the tiers


specified by tiering policy level.

Shortage: Some pages are not assigned to the tiers specified


by tiering policy level due to insufficient pool capacity.

Tier1, Tier2, Tier3

Displays the amount of space used on each tier by the volume.

%T1, %T2, %T3

Displays the distribution ratio (%) of the usage of each tier by the
volume.

Total

Displays the total amount of space used by the volume.

Capacity

Displays the total capacity of the volume.

5-34

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Tiering Policy Group Pool Status Detail panel on page 5-28

Tiering Policy Group Volume Status Detail panel on page 5-35

Tiering Policy Group Volume Status Detail panel


This panel displays detailed information of the selected volume that belongs
to the tiering policy group.

Tiering Policy Information


Displays the tiering policy of the definition and of the current status in the
storage system.
Item
Relocation state

Description
Displays the relocation status of the volume.

In range: All pages are assigned to the tiers specified by tiering policy
level.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-35

Item

Description

Out of range: Some pages are not assigned to the tiers specified by
tiering policy level.

Shortage: Some pages are not assigned to the tiers specified by


tiering policy level due to insufficient pool capacity.

Tier level#

Displays the tiering policy level.

Entry#

Displays the tier to which new pages are assigned.

Relocation#

HIGH: New pages are assigned to the higher tier.

MIDDLE: New pages are assigned to the middle tier.

LOW: New pages are assigned to the lower tier.

Displays whether tier relocation is executed.

Note:
The Definition column shows the value defined in the tiering policy group
definition file, and the CurrentState column shows the value set for the
storage system.

Information Per Tier


Displays information about the tiers of the volume.

Basic Information
Displays basic information about the volume.

Volume Selection List panel


This panel displays a list of volumes in the storage system.

5-36

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Item

Description

AC

Specify the action to be executed for the selected volume.


You can specify the following actions:

CCA

V: Goes to the Volume Status Detail panel. This panel displays detailed
information about the selected volume.

P: Goes to the Pool Status Detail panel. This panel displays detailed
information about the selected pool.

D: Restores the default tiering policy for the volume (tiering policy level: 0,
tier to which new pages are assigned: MIDDLE, whether to execute tier
relocation: Y).

The following information, which indicates whether the volume is an external


volume, is displayed to the right-hand side of the command control address
number.

+: The volume is an external volume.

-: The volume is not an external volume.

Blank: Whether the volume is an external volume is unknown.

Related topics

Pool Status Detail panel on page 5-24

Volume Status Detail panel on page 5-37

Volume Status Detail panel


This panel displays detail information of the selected volume.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-37

Tiering Policy Information


Displays the tiering policy of the current status in the storage system.
Item
Relocation state

Description
Displays the relocation status of the volume.

In range: All pages are assigned to the tiers specified by tiering policy
level.

Out of range: Some pages are not assigned to the tiers specified by
tiering policy level.

Shortage: Some pages are not assigned to the tiers specified by tiering
policy level due to insufficient pool capacity.

Tier level

Displays the tiering policy level specified on the storage system.

Entry

Displays the tier to which new pages are assigned that is specified on the
storage system.

Relocation

5-38

HIGH: New pages are assigned to the higher tier.

MIDDLE: New pages are assigned to the middle tier.

LOW: New pages are assigned to the lower tier.

Displays whether tier relocation is executed on the storage system.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

Information Per Tier


Displays the information about the tiers of the volume.

Basic Information
Displays basic information about the volume.

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

5-39

5-40

ISPF panels
Hitachi Tiered Storage Manager for Mainframe User Guide

6
CLI commands
This chapter describes the command functions that can be used in the Tiered
Storage Manager for Mainframe CLI.
List of CLI Commands
CLI command coding format
REXX external routine details
TSO/E command details
OS console command details

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-1

List of CLI Commands


The CLI commands provided by Tiered Storage Manager for Mainframe are
categorized into the following command types.

REXX external routines

TSO/E commands

OS console commands

The following tables describe each of the CLI command types.

Table 6-1 REXX external routines


Command
name
KTACTTPG

Applies the tiering policy for a tiering policy group.

KTDCTDEV

Changes the tiering policy of the specified volume back to the default.

KTDCTTPG

Changes the tiering policy of a tiering policy group back to the default.

KTGETHDA

Loads the disk configuration definition file to the REXX variable structure.

KTIMPORT

Reads the tiering policy information CSV file and the disk configuration
definition file, and then defines a tiering policy group (creates a tiering
policy group definition file).

KTLOAD

Loads the tiering policy group definition file to the REXX variable
structure.

Loads the disk configuration definition file to the REXX variable


structure.

KTQRYDEV

Acquires information about the tiering policy for the specified volume and
information about the pool to which the volume belongs, and then stores
the information in the REXX variable.

KTQRYRLC

Acquires information such as the progress of page tier relocation for each
Dynamic Tiering for Mainframe pool to which the tiering policy group
belongs from the storage system, and then stores the information in the
REXX variable structure.

KTQRYTPG

Acquires tiering policy information and page tier location status for a
tiering policy group from the storage system, and then stores the
information in the REXX variable structure.

KTQSTATS

Acquires I/O performance information for a tiering policy group from the
storage system, and then stores the information in the REXX variable
structure.

KTSCAN

Scans the operation-target volumes for Tiered Storage Manager for


Mainframe to acquire the information necessary to identify the volumes,
and then sets the information to the REXX variable structure.

KTSTORE

Saves the values of the host-discovered array structure generated by


the KTSCAN or KTLOAD command in the disk configuration definition
file.

Saves the values of the tiering policy group structure generated by


the KTLOAD command in the tiering policy group definition file.

KTWTOMSG

6-2

Description

Outputs the specified message ID and message text to the console.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Table 6-2 TSO/E commands


Command
name

Description

KTCONMSG

Monitors the messages output to the console.

KTENV

Outputs the following information to the TSO/E terminal:

Program product name

Prefix of the license information dataset

Output method of event logs

Whether CLI command-execution logs are output to SYSLOG or the


console

KTERCODE

Outputs the information for the specified error code and the cause of the
error to the TSO/E terminal.

KTINSCHK

Checks the setting items required for setup for incomplete or incorrect
information, and outputs the check results and settings to the TSO/E
terminal.

KTSLEEP

Suspends the execution of the script for the specified period of time.

Table 6-3 OS console commands


Command
name

Description

KTALCSVC

Registers or deletes a user SVC.

KTDSPENV

Displays the following information on the console.

KTSETENV

Program product name

Prefix of the license information dataset

Output method of event logs

Whether CLI command-execution logs are output to SYSLOG or the


console

Sets the following values using environment variables:

Prefixes of the license information dataset

Output method of event logs

Whether CLI command-execution logs are output to SYSLOG or the


console

CLI command coding format


This section describes the CLI command coding format for each command
type.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-3

REXX external routine coding format


REXX external routines provided by Tiered Storage Manager for Mainframe
must be called as subroutines. Therefore, write a REXX script as shown
below, and then execute the script.

REXX script coding format


CALL

1command-name

1"parameter"

Script coding method

Use the RESULT variable to acquire the return code of a CLI command.

When a CLI command is executed, values are set or updated in the REXX
variable structure. To check the command execution results, code a REXX
script to output the REXX variables in the REXX variable structure.

When a CLI command is executed, a message is generated by the


command. That message is stored in the REXX variable message
structure. The message structure is initialized each time a CLI command
with the same message structure name specified is called.

Before executing any one of the CLI commands listed below, you must
execute the KTLOAD command. The KTLOAD command loads the
information necessary for executing the CLI command from the
configuration file to the REXX variable structure.

KTACTTPG

KTDCTTPG

KTQRYRLC

KTQRYTPG

KTQSTATS

Multiple REXX variable structures are expanded for a single CLI command.
If only some of the REXX variable structures are deleted, subsequently
issued commands might not operate normally. To delete REXX variable
structures, you need to delete all the related REXX variable structures.

Related topics

Chapter 8, REXX variable structures on page 8-1

TSO/E command coding format


To execute a CLI command categorized as a TSO/E command from a REXX
script, code the script as follows.

REXX script coding format


ADDRESS

1TSO

1"command-name

1parameter"

Use the RC variable to acquire the return code of a TSO/E command in the
REXX script.

6-4

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

OS console command coding format


To execute a CLI command categorized as an OS console command, enter
the command preceded by the START command from the console.

OS console command coding format


START

command-name[,PARM='parameter']

REXX external routine details


This section describes details about CLI commands categorized as REXX
external routines. The commands are explained in alphabetic order.

KTACTTPG
Function
Applies the tiering policy for a tiering policy group.

Command type
REXX external routines

Format
KTACTTPG
1STEM(stem-name-1)
1MSG(stem-name-2)

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix of the tiering policy group structure to which the target
tiering policy group was loaded. This is the character string specified for
the STEM parameter of the KTLOAD command that was previously
executed. This value must end with a period.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.

Return codes
The following table lists and describes the codes returned when the KTACTTPG
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-5

Table 6-4 Return codes generated by the KTACTTPG command


Return code

Meaning

The command ended normally.

12

An unsupported device was skipped.

32

An I/O error occurred.

36

The command ended due to an invalid REXX variable


structure.

40

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible causes are as follows:

The parameters were specified incorrectly.

The KTLOAD command was not executed, or the value


specified for the STEM parameter is different from the
value of the STEM parameter of the KTLOAD command.

The command ended due to an incorrect execution method.


The possible causes are as follows:

52

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

REXX variables that are updated by the KTACTTPG command

All REXX variables in the message structure

The following REXX variables in the host-discovered array structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

LOCAL.SNnnnnn.CUxx.CCAxx.TierLevel

LOCAL.SNnnnnn.CUxx.CCAxx.Entry

LOCAL.SNnnnnn.CUxx.CCAxx.TierRelocation

Related topics

Message structure on page 8-2

Host-discovered array structure on page 8-4

KTDEMO10 (Apply the tiering policy) on page C-15

KTDCTDEV
Function
Changes the tiering policy for a volume back to the following default values.

6-6

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Tiering policy level: 0

New-page assignment tier: MIDDLE

Whether to execute tier relocation: Y

Command type
REXX external routine

Format
KTDCTDEV
1MSG(stem-name-1)
1DEVN(nnnn)

Parameters
MSG(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.
DEVN(nnnn)~<four hexadecimal characters string>
Specify the device number of the volume for which the tiering policy will
be changed back to the default.

Return codes
The following table lists and describes the codes returned when the KTDCTDEV
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-5 Return codes generated by the KTDCTDEV command


Return code

Meaning

The command ended normally.

12

An unsupported device was skipped.

32

An I/O error occurred.

40

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible cause is as follows:

52

The parameters were specified incorrectly.

The command ended due to an incorrect execution method.


The possible causes are as follows:

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-7

REXX variables that are updated by the KTDCTDEV command

All variables in the message structure

Related topics

Message structure on page 8-2

KTDEMO05 (Change the tiering policy of a volume back to the default) on


page C-14

KTDCTTPG
Function
Changes the tiering policy for a tiering policy group back to the following
default values.

Tiering policy level: 0

New-page assignment tier: MIDDLE

Whether to execute tier relocation: Y

Command type
REXX external routine

Format
KTDCTTPG
1STEM(stem-name-1)
1MSG(stem-name-2)

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix of the tiering policy group structure to which the target
tiering policy group was loaded. This is the character string specified for
the STEM parameter of the KTLOAD command that was previously
executed. This value must end with a period.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the name of the message structure that
stores messages generated by this command. This value must end with a
period.

Return codes
The following table lists and describes the codes returned when the KTDCTTPG
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

6-8

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Table 6-6 Return codes generated by the KTDCTTPG command


Return code

Meaning

The command ended normally.

12

An unsupported device was skipped.

32

An I/O error occurred.

36

The command ended due to an invalid REXX variable


structure.

40

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible causes are as follows:

The parameters were specified incorrectly.

The KTLOAD command was not executed, or the value


specified for the STEM parameter is different from the
value of the STEM parameter of the KTLOAD command.

The command ended due to an incorrect execution method.


The possible causes are as follows:

52

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

REXX variables that are updated by the KTDCTTPG command

All variables in the message structure

The following variables in the host-discovered array structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

LOCAL.SNnnnnn.CUxx.CCAxx.TierLevel

LOCAL.SNnnnnn.CUxx.CCAxx.Entry

LOCAL.SNnnnnn.CUxx.CCAxx.TierRelocation

Related topics

Message structure on page 8-2

Host-discovered array structure on page 8-4

KTGETHDA
Function
Loads the information from the disk configuration definition file to the hostdiscovered array structure and host-discovered array index structure.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-9

Command type
REXX external routine

Format
KTGETHDA
1STEM(stem-name-1)
1MSG(stem-name-2)
1PREFIX(prefix)
1SN(serial-number)

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the host-discovered array structure to
which the information will be loaded from the disk configuration definition
file. This value must end with a period.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.
PREFIX(prefix)~<prefix character string of 25 or fewer characters>
Specify the prefix of the disk configuration definition file to be read.
SN(storage-system-serial-number)~<5-12 alphanumeric characters>
Specify the serial number of the storage system from which information
will be read.

Reference note
If the KTGETHDA command with the same value specified for the STEM
parameter is executed multiple times, all execution results are valid as long
as the SN parameter, which specifies a storage system, has a unique value. If
a host-discovered array structure has already been set by executing another
CLI command, information for the same REXX variable name will be
overwritten.

Return codes
The following table lists and describes the codes returned when the KTGETHDA
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-7 Return codes generated by the KTGETHDA command


Return code
0

6-10

Meaning
The command ended normally.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Return code

Meaning

An unknown XML attribute or element is found in the input


file.

36

XML data in the input file ends with an invalid structure.

40

An error occurred during reading of the file.

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible cause is as follows:

The parameters were specified incorrectly.

The command ended due to an incorrect execution method.


The possible causes are as follows:

52

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

REXX variables that are updated by the KTGETHDA command

All variables in the message structure

All variables in the host-discovered array index structure


The prefix of the host-discovered array index structure is "HCC.HDAKT.".

The following variables in the host-discovered array structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

LOCAL.SNnnnnn.SerialNum

LOCAL.SNnnnnn.Microcode

LOCAL.SNnnnnn.IFType

LOCAL.SNnnnnn.PhysicalSerialNum

LOCAL.SNnnnnn.LDKCNum

LOCAL.SNnnnnn.CUxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.Devn

LOCAL.SNnnnnn.CUxx.CCAxx.Volser

LOCAL.SNnnnnn.CUxx.CCAxx.STORGRP

LOCAL.SNnnnnn.CUxx.CCAxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.POOLID

LOCAL.SNnnnnn.CUxx.CCAxx.Cyls

LOCAL.SNnnnnn.CUxx.CCAxx.External

LOCAL.SNnnnnn.POOLxx.NAME

LOCAL.SNnnnnn.POOLxx.Type

LOCAL.SNnnnnn.POOLxx.PageSize

LOCAL.SNnnnnn.POOLxx.Tier.0

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-11

LOCAL.SNnnnnn.POOLxx.Tier.n.Media

Related topics

Message structure on page 8-2

Host-discovered array index structure on page 8-3

Host-discovered array structure on page 8-4

KTDEMO01 (Display the contents of the disk configuration definition file)


on page C-5

KTIMPORT
Function
Reads the configuration information from the tiering policy information CSV
file and volume information from the disk configuration definition file, and
then creates a tiering policy group definition file.

Command type
REXX external routine

Prerequisites

If the SCAN parameter is not specified, volumes to be defined as a tiering


policy group must be defined in the disk configuration definition file in
advance by using the KTSCAN and KTSTORE commands.

If the record type of the tiering policy information CSV file is STORGRP or
VOLSER, the volumes must be placed online.

Format
KTIMPORT
1MSG(stem-name-1)
1PREFIX(prefix)
1POLICY(policy-ID)

1SCAN]

Parameters
MSG(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.
PREFIX(prefix)~<prefix character string of 25 or fewer characters>
Specify the prefix of the disk configuration definition file, tiering policy
group definition file, and tiering policy information CSV file.

6-12

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

POLICY(policy-ID)~<symbol name consisting of 8 or fewer characters>


Specify the policy-ID that identifies the tiering policy information CSV file
to be read. The tiering policy information CSV file whose name is PREFIXparameter-value.POLICY.policy-ID will be read.
SCAN
The volumes or the volumes belonging to the SMS storage group, which
are specified in the tiering policy information CSV file, will be scanned in
the same way as for the KTSCAN command. Then the detected volume
information will be output to the disk configuration definition file.
Tip: When you execute the KTIMPORT command, the following number of data
sets are allocated at the same time:

If you specify the SCAN parameter: The number of disk configuration


definition files to be updated# + 2
#: The number of disk configuration definition files to be updated is the
number of storage systems to be scanned.

If you do not specify the SCAN parameter: 2


Therefore, ensure that the number of datasets allocated at the same time
does not exceed the value of the DYNAMNBR parameter of the TSO/E logon
procedure or JCL.

Return codes
The following table lists and describes the codes returned when the KTIMPORT
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-8 Return codes generated by the KTIMPORT command


Return codes

Meaning

The command ended normally. REXX variables were created.

No records were defined in the tiering policy information CSV


file. Writing to the tiering policy group definition file was not
performed.

32

The specified CSV file had an error.

36

An attempt to read SMS storage group information failed.

An error occurred during internal command processing.

An error occurred during CSV file input processing.

An error occurred during writing of the REXX variables.

40

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible cause is as follows:

52

The parameters were specified incorrectly.

The command ended due to an incorrect execution method.


The possible causes are as follows:

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-13

Return codes

20000 to 20099

Meaning

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

An error occurred, possibly due to insufficient memory (the


last two digits are the REXX error number). For details about
the error, see the explanation of the IRX00nnI message
(replace nn with the last two digits of the return code) in the
manual TSO/E Messages.

REXX variables that are updated by the KTIMPORT command

All variables in the message structure

Related topics

Message structure on page 8-2

KTDEMO02 (Create a tiering policy group definition file) on page C-8

KTLOAD
Function
Loads the information necessary for Tiered Storage Manager for Mainframe
operation from the following configuration files to the REXX variable
structures.

Loads the tiering policy group definition file to the tiering policy group
structure.

Loads the disk configuration definition file to the host-discovered array


structure and host-discovered array index structure.

Command type
REXX external routine

Format
KTLOAD
1STEM(stem-name-1)
1MSG(stem-name-2)
1PREFIX(prefix)
1TPG(tiering-policy-group-ID)

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>

6-14

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Specify the prefix (any value) of the REXX variable structure to which the
information will be loaded from the configuration file. This value must end
with a period.
If the KTLOAD command with the same value specified for the STEM
parameter is executed multiple times, the REXX variable will be
overwritten. To specify operations for multiple tiering policy groups in the
same script, specify a unique value of the STEM parameter for each tiering
policy group.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.
PREFIX(prefix)~<prefix character string of 25 or fewer characters>
Specify the prefix of the configuration file from which information will be
loaded.
TPG(tiering-policy-group-ID)~<prefix character string>
Specify the tiering policy group ID.
This is the tiering policy group definition file name with prefix.TPG.
removed.

Return codes
The following table lists and describes the codes returned when the KTLOAD
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-9 Return codes generated by the KTLOAD command


Return code

Meaning

The command ended normally.

An unknown XML attribute or element was found in the input


file.

36

XML data in the input file ends with an invalid structure.

40

An error occurred during reading of the configuration file.

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible cause is as follows:

52

The parameters were specified incorrectly.

The command ended due to an incorrect execution method.


The possible causes are as follows:

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-15

REXX variables that are updated by the KTLOAD command

All variables in the message structure

All variables in the host-discovered array index structure


The prefix of the host-discovered array index structure is "HCC.HDAKT.".

The following variables in the host-discovered array structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

6-16

LOCAL.SNnnnnn.SerialNum

LOCAL.SNnnnnn.Microcode

LOCAL.SNnnnnn.IFType

LOCAL.SNnnnnn.PhysicalSerialNum

LOCAL.SNnnnnn.LDKCNum

LOCAL.SNnnnnn.CUxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.Devn

LOCAL.SNnnnnn.CUxx.CCAxx.Volser

LOCAL.SNnnnnn.CUxx.CCAxx.STORGRP

LOCAL.SNnnnnn.CUxx.CCAxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.POOLID

LOCAL.SNnnnnn.CUxx.CCAxx.Cyls

LOCAL.SNnnnnn.CUxx.CCAxx.External

LOCAL.SNnnnnn.POOLxx.NAME

LOCAL.SNnnnnn.POOLxx.Type

LOCAL.SNnnnnn.POOLxx.PageSize

LOCAL.SNnnnnn.POOLxx.Tier.0

LOCAL.SNnnnnn.POOLxx.Tier.n.Media

The following variables in the tiering policy group structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

TPG.ID

TPG.VOL.0

TPG.VOL.n.SerialNum

TPG.VOL.n.CUNum

TPG.VOL.n.CCA

TPG.VOL.n.POOLID

TPG.VOL.n.SSID

TPG.VOL.n.TierLevel

TPG.VOL.n.TierRelocation

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Related topics

Message structure on page 8-2

Host-discovered array index structure on page 8-3

Host-discovered array structure on page 8-4

Tiering policy group structure on page 8-9

KTDEMO03 (Display the contents of the tiering policy group definition file)
on page C-10

KTQRYDEV
Function
Acquires the following information about the specified volume from the
storage system, and then stores the information in the REXX variable
structure.

Tiering policy configuration information

Page tier location status

I/O performance information

Configuration information for the pool to which the volume belongs

Command type
REXX external routine

Format
KTQRYDEV
1STEM(stem-name-1)
1MSG(stem-name-2)
1DEVN(nnnn)

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the host-discovered array structure and
device information structure that store the acquired information. This
value must end with a period.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.
DEVN(nnnn)~<four hexadecimal characters string>
Specify the device number of the volume for which information will be
acquired.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-17

Return codes
The following table lists and describes the codes returned when the KTQRYDEV
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-10 Return codes generated by the KTQRYDEV command


Return code

Meaning

The command ended normally.

A storage system of unknown model was detected. REXX


variables of the specified volume were not created.

32

An I/O error occurred.

40

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible cause is as follows:

The parameters were specified incorrectly.

The command ended due to an invalid execution method. The


possible causes are as follows:

52

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

REXX variables that are updated by the KTQRYDEV command

6-18

All variables in the message structure

The following variables in the host-discovered array structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

LOCAL.SNnnnnn.SerialNum

LOCAL.SNnnnnn.Microcode

LOCAL.SNnnnnn.IFType

LOCAL.SNnnnnn.PhysicalSerialNum

LOCAL.SNnnnnn.LDKCNum

LOCAL.SNnnnnn.CUxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.Devn

LOCAL.SNnnnnn.CUxx.CCAxx.VOLSER

LOCAL.SNnnnnn.CUxx.CCAxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.POOLID

LOCAL.SNnnnnn.CUxx.CCAxx.Cyls

LOCAL.SNnnnnn.CUxx.CCAxx.External

LOCAL.SNnnnnn.CUxx.CCAxx.TierLevel

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

LOCAL.SNnnnnn.CUxx.CCAxx.Entry

LOCAL.SNnnnnn.CUxx.CCAxx.TierRelocation

LOCAL.SNnnnnn.CUxx.CCAxx.Used

LOCAL.SNnnnnn.CUxx.CCAxx.Tier.0

LOCAL.SNnnnnn.CUxx.CCAxx.Tier.n.Used

LOCAL.SNnnnnn.CUxx.CCAxx.Tier.n.IO.Ct

LOCAL.SNnnnnn.POOLxx.NAME

LOCAL.SNnnnnn.POOLxx.Type

LOCAL.SNnnnnn.POOLxx.PageSize

LOCAL.SNnnnnn.POOLxx.Tier.0

LOCAL.SNnnnnn.POOLxx.Tier.n.Media

LOCAL.SNnnnnn.POOLxx.Tier.n.Capacity

LOCAL.SNnnnnn.POOLxx.Tier.n.Used

LOCAL.SNnnnnn.POOLxx.Tier.n.Unit

LOCAL.SNnnnnn.POOLxx.Tier.n.EntryBufferPerCent

LOCAL.SNnnnnn.POOLxx.Tier.n.RelocateBufferPerCent

LOCAL.SNnnnnn.POOLxx.Tier.n.m.ExpectedMigrationPageCt

LOCAL.SNnnnnn.POOLxx.Tier.n.m.MigratedPageCt

LOCAL.SNnnnnn.POOLxx.Auto

LOCAL.SNnnnnn.POOLxx.RelocateStartTime

LOCAL.SNnnnnn.POOLxx.RelocateEndTime

LOCAL.SNnnnnn.POOLxx.Relocating

LOCAL.SNnnnnn.POOLxx.RelocatePerCent

LOCAL.SNnnnnn.POOLxx.ExpectedMigrationPageCt

LOCAL.SNnnnnn.POOLxx.MigratedPageCt

All variables in the device information structure

Related topics

Message structure on page 8-2

Host-discovered array structure on page 8-4

Device information structure on page 8-10

KTDEMO04 (Display the volume information) on page C-11

KTQRYRLC
Function
Acquires the following information about the Dynamic Tiering for Mainframe
pool from the storage system, and then stores the information in the REXX
variable structure.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-19

Progress of page relocation (moving pages between tiers) for the


Dynamic Tiering for Mainframe pool to which the volumes in the tiering
policy group belong

Configuration of the Dynamic Tiering for Mainframe pool to which the


volumes in the tiering policy group belong

Command type
REXX external routine

Format
KTQRYRLC
1STEM(stem-name-1)
1MSG(stem-name-2)

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix of the tiering policy group structure to which the target
tiering policy group information was loaded. This is the character string
specified for the STEM parameter of the KTLOAD command that was
previously executed. This value must end with a period.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.

Return codes
The following table lists and describes the codes returned when the KTQRYRLC
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-11 Return codes generated by the KTQRYRLC command


Return code

Meaning

The command ended normally.

12

An unsupported device was skipped.

32

An I/O error occurred.

36

The command ended due to an invalid REXX variable


structure.

40

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible causes are as follows:

6-20

The parameters were specified incorrectly.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Return code

Meaning

The KTLOAD command was not executed, or the value


specified for the STEM parameter is different from the
value of the STEM parameter of the KTLOAD command.

The command ended due to an incorrect execution method.


The possible causes are as follows:

52

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

REXX variables that are updated by the KTQRYRLC command

All variables in the message structure

In the host-discovered array structure, the following variables related to


the Dynamic Tiering for Mainframe pool to which the volumes in the
specified tiering policy group belong
A REXX variable name is preceded by the value specified for the STEM
parameter.

All variables beginning with LOCAL.SNnnnnn.POOLxx

Related topics

Message structure on page 8-2

Host-discovered array structure on page 8-4

KTDEMO13 (Check the relocation progress) on page C-20

KTQRYTPG
Function
Acquires the following information about the volumes that belong to a tiering
policy group from the storage system, and then stores the information in the
REXX variable structure.

Tiering policy configuration information

Page tier location status

Command type
REXX external routine

Format
KTQRYTPG
1STEM(stem-name-1)
1MSG(stem-name-2)

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-21

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix of the tiering policy group structure to which the target
tiering policy group information was loaded. This is the character string
specified for the STEM parameter of the KTLOAD command that was
previously executed.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.

Return codes
The following table lists and describes the codes returned when the KTQRYTPG
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-12 Return codes generated by the KTQRYTPG command


Return code

Meaning

The command ended normally.

12

An unsupported device was skipped.

32

An I/O error occurred.

36

The command ended due to an invalid REXX variable


structure.

40

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible causes are as follows:

52

The parameters were specified incorrectly.

The KTLOAD command was not executed, or the value


specified for the STEM parameter is different from the
value of the STEM parameter or the KTLOAD command.

The command ended due to an incorrect execution method.


The possible causes are as follows:

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

REXX variables that are updated by the KTQRYTPG command

6-22

All variables in the message structure

The following variables in the host-discovered array structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

LOCAL.SNnnnnn.CUxx.CCAxx.TierLevel

LOCAL.SNnnnnn.CUxx.CCAxx.Entry

LOCAL.SNnnnnn.CUxx.CCAxx.TierRelocation

LOCAL.SNnnnnn.CUxx.CCAxx.Used

LOCAL.SNnnnnn.CUxx.CCAxx.Tier.0

LOCAL.SNnnnnn.CUxx.CCAxx.Tier.n.Used

Related topics

Message structure on page 8-2

Host-discovered array structure on page 8-4

KTDEMO11 (Check the tiering policy) on page C-16

KTDEMO12 (Check the page relocation status) on page C-18

KTDEMO13 (Check the relocation progress) on page C-20

KTQSTATS
Function
Acquires I/O performance information for a tiering policy group from the
storage system, and then stores the information in the REXX variable
structure. The I/O performance information to be acquired is the number of
I/O operations at the back end (number of I/O operations for the drive
media).

Command type
REXX external routine

Format
KTQSTATS
1STEM(stem-name-1)
1MSG(stem-name-2)

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix of the tiering policy group structure to which the target
tiering policy group information was loaded. This is the character string
specified for the STEM parameter of the KTLOAD command that was
previously executed.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-23

Return codes
The following table lists and describes the codes returned when the KTQSTATS
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-13 Return codes generated by the KTQSTATS command


Return code

Meaning

The command ended normally.

12

An unsupported device was skipped.

32

An I/O error occurred.

36

The command ended due to an invalid REXX variable


structure.

40

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible causes are as follows:

The parameters were specified incorrectly.

The KTLOAD command was not executed, or the value


specified for the STEM parameter is different from the
value of the STEM parameter of the KTLOAD command.

The command ended due to an incorrect execution method.


The possible causes are as follows:

52

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

REXX variables that are updated by the KTQSTATS command

All variables in the message structure

The following variables in the host-discovered array structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

LOCAL.SNnnnnn.CUxx.CCAxx.Tier.n.0

LOCAL.SNnnnnn.CUxx.CCAxx.Tier.n.IO.Ct

LOCAL.SNnnnnn.CUxx.CCAxx.Tier.n.IO.diff

The following variable in the tiering policy group structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

TPG.VOL.IO.Interval

Related topics

6-24

Message structure on page 8-2

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Host-discovered array structure on page 8-4

Tiering policy group structure on page 8-9

KTDEMO14 (Check I/O performance information) on page C-26

KTSCAN
Function
Acquires the following information by scanning volumes, and then stores the
information in the REXX variable structure.

Detected volume information

Information about the Dynamic Tiering for Mainframe pool to which the
volumes belong

Information about the storage system

The range of volumes to be scanned is specified by using one of the


following:

Range specification by using the device numbers

Range specification by using the volume serial numbers

Specification of an SMS storage group name

Command type
REXX external routine

Prerequisites

To scan the volumes specified by an SMS storage group name or by


volume serial numbers, you must first place the volumes online (only
online volumes can be detected).

Format
KTSCAN
1STEM(stem-name-1)
1MSG(stem-name-2)
1{FROM(nnnn)

1TO(nnnn)

|FROMVSN(volser) 1TOVSN(volser)
|STORGRP(SMS-storage-group-name)
}
[ 1ARRAYS(stem-name-3)]

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the host-discovered array structure that
stores the scan results. This value must end with a period.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-25

MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>


Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.
FROM(nnnn)~<four hexadecimal characters string>
To filter the range of volume detection by device numbers, specify the
device number of the start volume.
TO(nnnn)~<four hexadecimal characters string>
To filter the range of volume detection by device numbers, specify the
device number of the end volume.
FROMVSN(volser)~<six or fewer alphanumeric characters>
To filter the range of volume detection by volume serial numbers, specify
the volume serial number of the start volume.
TOVSN(volser)~<six or fewer alphanumeric characters>
To filter the range of volume detection by volume serial numbers, specify
the volume serial number of the end volume.
Information in the range specified by the FROMVSN parameter and TOVSN
parameter is compared in ascending EBCDIC code order.
STORGRP(SMS-storage-group-name)~<symbol name consisting of 8 or fewer
characters>
To restrict the range of volume detection to one SMS storage group,
specify the SMS storage group name.
All volumes belonging to the SMS storage group specified by this
parameter will be scanned.
ARRAYS(stem-name-3)~<REXX prefix consisting of 64 or fewer characters>
<<HCC.KTSCAN.>>
Specify the prefix (any value) of the host-discovered array index structure
that stores the scan results. This value must end with a period. Do not
specify "HCC.HDAKT.".

Notes
If you change any function or information for the storage system, such as a
microcode number, execute the KTSCAN command and the KTSTORE command
to acquire the storage system information again and update the definition. In
this case, you only have to scan one volume to acquire the storage system
information.

Reference note

6-26

If you want to define offline volumes in a tiering policy group, specify the
device numbers for those volumes when executing the KTSCAN and
KTIMPORT commands.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

If information about the volumes in the detection range already exists in


the host-discovered array structure specified for the STEM parameter, the
existing information is overwritten by the detected information.

Return codes
The following table lists and describes the codes returned when the KTSCAN
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-14 Return codes generated by the KTSCAN command


Return code

Meaning

The command ended normally. The REXX variables for the


detected volumes were created.

The volumes for which I/O paths could not be used or the
volumes of unknown storage systems were skipped. The REXX
variables for the successfully detected volumes were created.

No volumes were found in the volume detection range


specified by the parameters.

12

An I/O error occurred. Some REXX variables could not be


created.

36

An attempt to read SMS storage group information failed.

40

An error occurred during writing of the REXX variables.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible cause is as follows:

The parameters were specified incorrectly.

The command ended due to an incorrect execution method.


The possible causes are as follows:

52

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

REXX variables that are updated by the KTSCAN command

All variables in the message structure

All variables in the host-discovered array index structure


The prefix of the structure name is the value specified for the ARRAYS
parameter.

The following variables in the host-discovered array structure


A REXX variable name is preceded by the value specified for the STEM
parameter.

LOCAL.SNnnnnn.SerialNum

LOCAL.SNnnnnn.Microcode

LOCAL.SNnnnnn.IFType

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-27

LOCAL.SNnnnnn.PhysicalSerialNum

LOCAL.SNnnnnn.LDKCNum

LOCAL.SNnnnnn.CUxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.Devn

LOCAL.SNnnnnn.CUxx.CCAxx.Volser

LOCAL.SNnnnnn.CUxx.CCAxx.STORGRP (set only when the STORGRP


parameter is specified)

LOCAL.SNnnnnn.CUxx.CCAxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.POOLID

LOCAL.SNnnnnn.CUxx.CCAxx.Cyls

LOCAL.SNnnnnn.CUxx.CCAxx.External

LOCAL.SNnnnnn.POOLxx.NAME

LOCAL.SNnnnnn.POOLxx.Type

LOCAL.SNnnnnn.POOLxx.PageSize

LOCAL.SNnnnnn.POOLxx.Tier.0

LOCAL.SNnnnnn.POOLxx.Tier.n.Media

Related topics

Message structure on page 8-2

Host-discovered array index structure on page 8-3

Host-discovered array structure on page 8-4

KTDEMO00 (Create a disk configuration definition file) on page C-3

KTSTORE
Function
Saves the values of either of the following REXX variable structures in a
configuration file.

Saves the values of the host-discovered array structure generated by the


KTSCAN or KTLOAD command in the disk configuration definition file for
each storage system.

Saves the values of the tiering policy group structure generated by the
KTLOAD command in the tiering policy group definition file.

Command type
REXX external routine

Format
KTSTORE
1STEM(stem-name-1)

6-28

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

1MSG(stem-name-2)
1PREFIX(prefix)

1ARRAYS(stem-name-3)]

1{DSK|TPG}]

1VOLUME(volser)]

1SPACE(quantity,increment)]

Parameters
STEM(stem-name-1)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix of the target REXX variable structure. If the hostdiscovered array structure has been created by executing the KTSCAN
command, specify the character string specified for the STEM parameter of
the KTSCAN command. If the REXX variable structure has been created by
executing the KTLOAD command, specify the character string specified for
the STEM parameter of the KTLOAD command. This value must end with a
period.
MSG(stem-name-2)~<REXX prefix consisting of 64 or fewer characters>
Specify the prefix (any value) of the message structure that stores
messages generated by this command. This value must end with a
period.
PREFIX(prefix)~<prefix character string of 25 or fewer characters>
Specify the prefix of the name of the configuration file that saves
information.
Caution: If you want to install and use Tiered Storage Manager for
Mainframe in the same system as Business Continuity Manager, you must
make sure that the prefix character strings for Business Continuity
Manager and Tiered Storage Manager for Mainframe are different. If the
same prefix is used for both Business Continuity Manager and Tiered
Storage Manager for Mainframe, the product may operate abnormally.
ARRAYS(stem-name-3)~<REXX prefix consisting of 64 or fewer characters>
<<HCC.KTSCAN.>>
Specify the prefix of the host-discovered array index structure that stores
the scan results. Specify the character string that was specified for the
ARRAYS parameter of the KTSCAN command only if in the disk
configuration file, you save the values of the host-discovered array
structure acquired by using the KTSCAN command with the ARRAYS
parameter specified. This value must end with a period.
{DSK|TPG}~<<DSK>>
Specify the configuration file to save the values of the REXX variables in.

DSK
The values of the host-discovered array structure are saved in the
disk configuration definition file.

TPG

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-29

The values of the tiering policy group structure are saved in the
tiering policy group definition file.
VOLUME(volser)~<character string with 6 or fewer alphanumeric
characters>
To allocate the configuration file to a specific volume, specify the serial
number of the volume to be allocated to. This parameter is enabled when
the configuration file is not managed by SMS.
SPACE(quantity,increment) ~<number>((from 1 to 16777215))
On a block basis, specify the primary quantity and secondary quantity
when allocating the configuration file. One block is 4,096 bytes. Specify
this parameter when you want to limit the primary quantity and add the
insufficient portion to the secondary quantity. If you do not specify this
parameter, the capacity of the configuration file is automatically
calculated and allocated as the primary quantity.
Tip: If the configuration file already exists when you execute the KTSTORE
command, the existing configuration file information and the information
stored in the REXX variable structure are merged. The merged information is
then saved to a newly allocated dataset. Therefore, the VOLUME parameter
and the SPACE parameter are enabled when the configuration file is updated.
Tip: When you execute the KTSTORE command, a number of datasets, equal
to the number of disk configuration definition files to be updated# + 1, are
allocated at the same time. Therefore, ensure that the number of datasets
that are allocated at the same time does not exceed the value of the
DYNAMNBR parameter of the TSO/E logon procedure or JCL.
#: The number of disk configuration definition files to be updated is the
number of storage systems that contain information in their host-discovered
array structure.

Return codes
The following table lists and describes the codes returned when the KTSTORE
command terminates. If the commands do not terminate normally, refer to
the resulting error messages for details.

Table 6-15 Return codes generated by the KTSTORE command


Return code

6-30

Meaning

The command ended normally.

36

The command ended due to an invalid REXX variable


structure.

40

An error occurred while a configuration file was being created


or updated.

44

The command ended due to invalid processing.

48

The command ended due to an invalid parameter. The


possible cause is as follows:

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Return code

Meaning

The parameters were specified incorrectly.

The command ended due to an incorrect execution method.


The possible causes are as follows:

52

20000 to 20099

The MSG parameter was specified incorrectly.

Installation was not performed correctly.

An error occurred, possibly due to insufficient memory (the


last two digits are the REXX error number). For details about
the error, see the explanation of the IRX00nnI message
(replace nn with the last two digits of the return code) in the
manual TSO/E Messages.

REXX variables that are updated by the KTSTORE command


All variables in the message structure

REXX variables saved in the configuration file by the KTSTORE


command

If the disk configuration definition file is specified for saving the REXX
variables, the following REXX variables in the host-discovered array
structure are saved in the disk configuration definition file.
A REXX variable name is preceded by the value specified for the STEM
parameter.

LOCAL.SNnnnnn.SerialNum

LOCAL.SNnnnnn.Model

LOCAL.SNnnnnn.Microcode

LOCAL.SNnnnnn.IFType

LOCAL.SNnnnnn.PhysicalSerialNum

LOCAL.SNnnnnn.CUxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.Devn

LOCAL.SNnnnnn.CUxx.CCAxx.Volser

LOCAL.SNnnnnn.CUxx.CCAxx.STORGRP

LOCAL.SNnnnnn.CUxx.CCAxx.SSID

LOCAL.SNnnnnn.CUxx.CCAxx.POOLID

LOCAL.SNnnnnn.CUxx.CCAxx.Cyls

LOCAL.SNnnnnn.CUxx.CCAxx.External

LOCAL.SNnnnnn.POOLxx.NAME

LOCAL.SNnnnnn.POOLxx.Type

LOCAL.SNnnnnn.POOLxx.PageSize

LOCAL.SNnnnnn.POOLxx.Tier.n.Media

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-31

If the tiering policy group definition file is specified for saving the REXX
variables, the following REXX variables in the tiering policy group
structure are saved in the tiering policy group definition file.
A REXX variable name is preceded by the value specified for the STEM
parameter.

TPG.ID

TPG.VOL.n.SerialNum

TPG.VOL.n.CUNum

TPG.VOL.n.CCA

TPG.VOL.n.POOLID

TPG.VOL.n.SSID

TPG.VOL.n.TierLevel

TPG.VOL.n.Entry

TPG.VOL.n.TierRelocation

Related topics

Message structure on page 8-2

Host-discovered array structure on page 8-4

Tiering policy group structure on page 8-9

KTDEMO00 (Create a disk configuration definition file) on page C-3

KTWTOMSG
Function
Outputs the specified message ID and message text to the console.

Command type
REXX external routine

Format
To output a single-line message:
KTWTOMSG

1type,text

To output a multi-line message:


KTWTOMSG 1type,text-1,text-2[,text-3][,text-4][,text-5]
[,text-6][,text-7][,text-8][,text-9][,text-10]

Parameters
type

6-32

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Specify one of the values shown below as the type of the message to be
output. The message will be output with the routing code appropriate for
the specified type.

I
Specify this for a message that reports information. The message will
be output with routing code 11.

W
Specify this for a warning message. The message will be output with
routing code 6.

E
Specify this for an error message. The message will be output with
routing code 6.

text~<125 or fewer characters>


Specify this parameter to output a single-line message. Specify the
message ID and message text to be output.
text-1~<34 or fewer characters>
Specify this parameter to output a multi-line message. Specify the
message ID and the first line of the message text to be output.
text-2~<70 or fewer characters>
Specify this parameter to output a multi-line message. Specify the second
line of the message text to be output.
text-3 to text-10~<70 or fewer characters>
Specify this parameter to output a message consisting of three or more
lines. The specification method is the same as for the text-2 parameter.

Note
A maximum of ten lines can be output in a multi-line message text.

Return codes
The following table lists and describes the codes returned when the KTWTOMSG
command terminates.

Table 6-16 Return codes generated by the KTWTOMSG command


Return code

Meaning

The command ended normally.

1004

The type is not specified.

1008

The specified type is invalid.

1012

No text is specified.

1016

The specified text is invalid.

2000

A system error occurred.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-33

Return code

Meaning

Other than the


above

See the return codes of the WTO macro. For details, see the MVS
Programming: Assembler Services Guide.

TSO/E command details


This section describes details about the TSO/E type CLI commands. The
commands are explained in alphabetic order.

KTCONMSG
Function
Monitors the messages output to the console.

Command type
TSO/E command

Format
KTCONMSG
1{OP(OPEN)[
|OP(GET)

1MSGID(message-ID)]

1TIMEOUT(timeout-value)]

1HANDLE(X'handle-value')

|OP(CLOSE)
}

1HANDLE(X'handle-value')

Parameters
OP({OPEN|GET|CLOSE})
Specify the processing type.

OPEN
Establish an EMCS console interface for monitoring messages. When
the command with the OPEN parameter specified ends normally, the
YKA098I message containing the handle value to be specified for the
OP(GET) and OP(CLOSE) parameters is returned.

GET
Messages acquired after the EMCS console interface was established
are returned in order in which they arrived.
If no messages have been acquired, either of the following operations
is performed.
If a value other than 0 is specified for the TIMEOUT parameter: If no
messages arrived when the number of seconds specified for the
TIMEOUT parameter has elapsed, the YKA096I message is output and
the command ends with return code 2.

6-34

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

If 0 is specified for the TIMEOUT parameter: The YKA096I message is


output and the command ends with return code 2.

CLOSE
Close the EMCS console interface for monitoring messages.

MSGID(message-ID) ~<6-10 alphanumeric characters> <<IEA494>>


Specify the message ID of the message to be monitored.
TIMEOUT(timeout-value)~<number>((0-60))<<15>>
Specify the timeout value in seconds.
HANDLE(X'handle-value')~<eight hexadecimal characters string>
Specify the handle value to be associated with the EMCS console interface
that has already been established. Specify the value in the YKA098I
message that was returned when the KTCONMSG OP(OPEN) command
ended.

Return codes
The following table lists and describes the codes returned when the KTCONMSG
command terminates.

Table 6-17 Return codes generated by the KTCONMSG command


Return code
-3

Meaning
The module cannot be loaded. The possible causes are as follows:

The necessary library datasets are not concatenated.

The load library for LINKLIB has not been registered for APF
authentication.

The module is protected by the RACF program control function.

-1

An interrupt occurred during command execution.

Open processing ended normally.

The message specified by the MSGID parameter was returned.

The number of seconds specified for the TIMEOUT parameter has


elapsed, but no messages arrived.

An attempt to acquire a message failed. A possible cause is that the


message was deleted because a long time has passed since the
EMCS console interface was established.

Close processing ended normally.

An invalid parameter was specified.

A system error occurred.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-35

KTENV
Function
Outputs the program product name and the operating environment settings
for Tiered Storage Manager for Mainframe to the TSO/E terminal.

Command type
TSO/E command

Format
KTENV

Return codes
The following table lists and describes the codes returned when the KTENV
command terminates.

Table 6-18 Return codes generated by the KTENV command


Return code

Meaning
The module cannot be loaded. The possible causes are as
follows:

-3

The necessary library datasets are not concatenated.

The module is protected by the RACF program control


function.

-1

An interrupt occurred during command execution.

The command ended normally.

Output items
The following table lists and describes the items output when the KTENV
command is executed, in order in which they are output.

Table 6-19 Output items of the KTENV command


Output item

6-36

Description

Hitachi Tiered Storage


Manager for Mainframe

Program product name

Environment variables
(v.r.m-nn(zz))

v.r.m-nn(zz): Version number and build number

License info DSN prefix

Prefix of the license information dataset

Event log output method

LOGR: Event logs are output by using the system


logger service.

SAM: Event logs are output without using the


system logger service.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Output item
CLI log output settings

Description

YES: CLI command-execution logs are output to


SYSLOG.

CONSOLE: CLI command-execution logs are output


to the console.

NO: CLI command-execution logs are not output.

YKLCNSE

Value of the YKLCNSE environment variable specified


by the KTSETENV command#

&YKLCNSE

Value of the &YKLCNSE system symbol#

YKLCNS2

Value of the YKLCNS2 environment variable specified


by the KTSETENV#

&YKLCNS2

Value of the system symbol &YKLCNS2#

LOGPUT

Value of the LOGPUT environment variable specified by


the KTSETENV command#

&YKLOGPT

Value of the &YKLOGPT system symbol#

SYSLOG

Value of the SYSLOG environment variable specified by


the KTSETENV command#

&YKSYSLG

Value of the &YKSYSLG system symbol#

#
If the value has not been specified, N/A is output.

Example
The following shows an example of executing the KTENV command.
READY
KTENV
Hitachi Tiered Storage Manager for Mainframe
Environment variables (v.r.m-nn(zz))
License info DSN prefix: HITACHI
Event log output method: LOGR
CLI log output settings: NO
YKLCNSE = N/A
(&YKLCNSE = "HITACHI" )
YKLCNS2 = N/A
(&YKLCNS2 = N/A
)
LOGPUT = LOGR
(&YKLOGPT = N/A
)
SYSLOG = N/A
(&YKSYSLG = N/A
)
YKZ371I KTENV command return code=0.

KTERCODE
Function
Outputs the information for the specified error code and the cause of the
error to the TSO/E terminal.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-37

Command type
TSO/E command

Format
KTERCODE
1error-code

Parameters
error-code ~<four hexadecimal characters string>
Specify the sense byte information (error code) for the storage system
contained in messages output by Tiered Storage Manager for Mainframe.
For details about error codes, see the description of storage system sense
byte information in the Hitachi Tiered Storage Manager for Mainframe
Messages.

Return codes
The following table lists and describes the codes returned when the KTERCODE
command terminates.

Table 6-20 Return codes generated by the KTERCODE command


Return code

Meaning

The command ended normally.

The description of the specified error code was not found.

16

The command ended due to an invalid parameter.

64

The module cannot be loaded. The possible causes are as


follows:

The necessary library datasets are not concatenated.

The module is protected by the RACF program control


function.

Example
The following shows an example of executing the KTERCODE command.
READY
KTERCODE 6A13
Error details:
The command could not be executed because a remote command was executed
while the command device was not defined.
Type of error:
Others.

6-38

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

KTINSCHK
Function
Checks the setting items required for setup for incomplete or incorrect
information, and then outputs a message showing the check results and the
settings.

Command type
TSO/E command

Format
KTINSCHK

Return codes
The following table lists and describes the codes returned when the KTINSCHK
command terminates.

Table 6-21 Return codes generated by the KTINSCHK command


Return code

Meaning

There were no problems with the settings.

There were problems with the settings.

32

A processing error occurred during command execution.

Output items
The following table lists and describes the items output when the KTINSCHK
command is executed, in the order in which they are output.

Table 6-22 Output items of the KTINSCHK command


Output item
Security Settings

User SVC Routine

Facility Class Profiles


Query

Description

OK: View permission required for using CLI


commands is assigned to the reference profile or
the operation profile.

FAULTY: View permission required for using CLI


commands is assigned to neither the reference
profile nor the operation profile.

OK: There are no problems with registration of the


user SVC.

FAULTY: There are problems with registration of


the user SVC.

Name of the currently defined reference profile#1

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-39

Output item

Description

Facility Class Profiles


Commands

Name of the currently defined operation profile#1

Directions

Description about permissions required for using the


operation and reference CLI commands

Version of User SVC for


this program

Prerequisite user SVC version for the running Tiered


Storage Manager for Mainframe program.

Current User
SVC

SVC Number

User SVC number that is currently enabled in the


system#2

Version

Version of the user SVC that is currently enabled in


the system#2

SVC Number

User SVC number that was dynamically registered by


using the KTALCSVC command#2

Version

Version of the user SVC that was dynamically


registered by using the KTALCSVC command#2

SVC Number

User SVC number that was statically registered by


defining the IEASYMxx parmlib member#2

Version

Version of the user SVC that was statically registered


by defining the IEASVCxx parmlib member.#2

Dynamic
registered
User SVC

Static
installed
User SVC

Directions

Description about the relationship between a user SVC


that was dynamically or statically registered and the
user SVC enabled in the system.

#1
If the value has not been specified, N/A is output.
#2
If the information cannot be acquired, N/A is output.

Example
The following shows an example of executing the KTINSCHK command.
READY
KTINSCHK
Security Settings .........: OK
User SVC Routine ..........: OK
Facility Class Profiles Query
: STGADMIN.YKA.DKT.KTQUERY
Facility Class Profiles Commands : STGADMIN.YKA.DKT.COMMANDS
Directions
The current setup is listed above.
An unregistered profile is listed as N/A.
The RACF settings are necessary in order to use CLI commands.
After a profile is defined in the RACF FACILITY class, a user can use
CLI commands by being given the access rights of the profile.
There are the following two kinds of profiles:
- Facility Class Profiles Query

6-40

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

- Facility Class Profiles Commands


To give a user the permissions necessary to use all of the CLI commands:
1. Make the RACF FACILITY class active.
2. Define the STGADMIN.YKA.DKT.COMMANDS profile in the FACILITY class.
3. Give the user the access rights of the profile.
To give a user the permissions necessary to use some of the CLI commands
(the reference commands):
4. Make the RACF FACILITY class active.
5. Define the STGADMIN.YKA.DKT.KTQUERY profile in the FACILITY class.
6. Give the user the access rights of the profile.
Version of User SVC for this program .............: v.r.m-nn(zz) or later
Current User SVC
: SVC Number 200 Version v.r.m-nn(zz)
Dynamic registered User SVC : SVC Number 200 Version v.r.m-nn(zz)
Static installed User SVC
: SVC Number 251 Version v.r.m-nn(zz)
Directions
The current users SVC routine registration number and version are listed
above.
User SVC numbers and versions that have not been acquired are listed as
N/A.
If a Dynamic registered User SVC exists, the Dynamic registered User SVC
will become the Current User SVC.
If a Dynamic registered User SVC does not exist and a Static installed
User SVC exists, the Static installed User SVC will become the Current
User SVC.
If the Current User SVC is smaller than the Version of User SVC for this
program, then the program will not run properly.
If this is the case, use the KTALCSVC command to dynamically register
the latest User SVC.
Also, register the latest User SVC if a Dynamic registered User SVC is
deleted.
The following is an example of deleting a registered User SVC:
+--------------------------------------------------------------------+
: START KTALCSVC,PARM=DELETE
:
+--------------------------------------------------------------------+
The following is an example of registering a User SVC:
+--------------------------------------------------------------------+
: START KTALCSVC
:
+--------------------------------------------------------------------+
Note:
A User SVC registered by using the KTALCSVC command will become invalid
during a re-IPL.
As a result, we recommend performing either of the following settings
in order to prepare for the next re-IPL:
- Add the KTALCSVC command to the COMMNDxx parmlib member, and then
have the User SVC automatically re-registered during a re-IPL.
- Define a User SVC in the IEASVCxx parmlib member, and then use the
User SVC that was statically installed from the next IPL.
YKK001I KTINSCHK completed. RC=00,V/R=v.r.m-nn(zz),2013/04/15 09:56:30

KTSLEEP
Function
Suspends the execution of the script for the specified period of time.

Command type
TSO/E command

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-41

Format
KTSLEEP
1{SEC(timeout-value)|MIN(timeout-value)}

Parameters
SEC(timeout-value)~<number>((1-9999))
Specify the period of time in seconds during which the script is
suspended.
MIN(timeout-value)~<number>((1-9999))
Specify the period of time in minutes during which the script is
suspended.

Note
Depending on the priority and operating status of other tasks, the script
suspended by the KTSLEEP command might not operate immediately after the
specified time has elapsed.

Return codes
The following table lists and describes the codes returned when the KTSLEEP
command terminates.

Table 6-23 Return codes generated by the KTSLEEP command


Return code

Meaning

The command ended normally.

Suspension status was canceled due to an interrupt.

16

The command ended due to an invalid parameter.

OS console command details


This section describes details about the OS console command type CLI
commands. The commands are explained in alphabetic order.

KTALCSVC
Function
Use this command to register or delete a user SVC.

Command type
OS console command

6-42

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

Format
1KTALCSVC[,PARM='{SVC-number|DELETE}']

START

Parameters
If you omitted the PARM part of the command, an unused SVC number
between 200 and 255 is assigned.
SVC-number to <number> ~ ((from 200 to 255))
Specify a SVC number to be assigned for the user SVC.
DELETE
Specify this parameter to delete a user SVC.

Notes
If you used the KTALCSVC command to delete a user SVC while Tiered
Storage Manager for Mainframe was running, CLI commands that are being
executed might terminate abnormally.

Return codes
The following table shows the return codes when the execution of the
KTALCSVC command ends.

Table 6-24 Return codes generated by the KTALCSVC command


Return code

Meaning

Successfully completed.

The user SVC is already registered.

16

Registration or deletion of the user SVC failed.

20

Processing stopped due to an error (the specified value or


execution environment is invalid).

KTDSPENV
Function
Displays the program product name and the Tiered Storage Manager for
Mainframe operating environment setting values in the console.

Command type
OS console command

Format
START 1KTDSPENV
[,PARM='[{SUMMARY|DETAIL}]']

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-43

Parameters
SUMMARY is assumed if the PARM part of the command was omitted or specified
as PARM=''.
SUMMARY
Displays the program product name, the prefix of the license information
dataset, the information about whether to use the system logger service,
and the information about whether to output CLI command-execution
logs to SYSLOG or the console.
DETAIL
Displays the content displayed when the SUMMARY parameter is specified,
and also displays the environment variables that are set dynamically by
using the KTSETENV command and the system symbol values that are set
statically.

Return codes
The following table shows return codes when the execution of the KTDSPENV
command ends.

Table 6-25 Return codes generated by the KTDSPENV command


Return code

Meaning

Successfully completed.

There is an error in the specified value. The command was


executed assuming that SUMMARY is specified.

Execution examples
Execution example without the DETAIL parameter
START KTDSPENV
KTA403I Hitachi Tiered Storage Manager for Mainframe
KTA400I Environment variables (v.r.m-nn(zz))
KTA401I License info DSN prefix: Hitachi
KTA401I Event log output method: LOGR
KTA401I CLI log output settings: YES

Execution example with the DETAIL parameter


START KTDSPENV,PARM='DETAIL'
KTA403I Hitachi Tiered Storage Manager for Mainframe
KTA400I Environment variables (v.r.m-nn(zz))
KTA401I License info DSN prefix: HTC1.HTC2
KTA401I Event log output method: SAM
KTA401I CLI log output settings: NO
KTA402I YKLCNSE = HTC1
(&YKLCNSE = N/A
)
KTA402I YKLCNS2 = HTC2
(&YKLCNS2 = N/A
)
KTA402I LOGPUT = SAM
(&YKLOGPT = "LOGR"
)
KTA402I SYSLOG = NO
(&YKSYSLG = "YES"
)

6-44

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

KTSETENV
Function
Use this command to set the following values using environment variables.

Prefixes of the license information dataset

Output method of event logs

Whether CLI command-execution logs are output to SYSLOG or the


console

Command type
OS console command

Format
START 1KTSETENV,
PARM='{YKLCNSE=[prefix-1]|
YKLCNS2=[prefix-2]|
LOGPUT=[{LOGR|SAM}]|
SYSLOG=[{YES|NO|CONSOLE}]}[,...]'

Parameters
Multiple parameters can be specified for the maximum length that can be
specified in the PARM parameter of the START command. If the same
parameter is specified more than once, the instance specified last takes
effect.
YKLCNSE=[prefix-1] ~ <8 or fewer alphanumeric characters>
Specify prefix-1 for the license information dataset so that the name of
the dataset is unique. To remove the value of the environment variable
YKLCNSE, specify PARM='YKLCNSE='.
YKLCNS2=[prefix-2]: ~ <8 for few alphanumeric characters>
Specify prefix-2 for the license information dataset so that the name of
the dataset is unique. To remove the value of the environment variable
YKLCNS2, specify PARM='YKLCNS2='.
LOGPUT=[LOGR|SAM]
Specify whether the system logger service is to be used when outputting
event logs.

LOGR
Event logs are output using the system logger service.

SAM

Event logs are output to a sequential dataset without using the


system logger service.
To remove the value of the environment variable LOGPUT, specify
PARM='LOGPUT='.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

6-45

SYSLOG=[YES|NO|CONSOLE]
Specify whether CLI command-execution logs are output to SYSLOG or
the console.

YES
CLI command-execution logs are output to SYSLOG.

CONSOLE
CLI command-execution logs are output to the console.

NO

CLI command-execution logs are not output.


To remove the value of the environment variable SYSLOG, specify
PARM='SYSLOG='.

Return codes
The following table shows the return codes when execution of the KTSETENV
command ends.

Table 6-26 Return codes generated by the KTSETENV command


Return code

6-46

Meaning

Successfully completed.

The specified value is invalid. Another value was used for


execution.

The specified value is invalid. Processing was canceled.

12

Processing was canceled due to a system error (such as a


GETMAIN error).

16

An internal error occurred.

CLI commands
Hitachi Tiered Storage Manager for Mainframe User Guide

7
Files used by Tiered Storage Manager
for Mainframe
This chapter describes the files used by Tiered Storage Manager for
Mainframe.
File naming conventions used by Tiered Storage Manager for Mainframe
Format of datasets used by Tiered Storage Manager for Mainframe
Disk space requirements of configuration files
Format of tiering policy information CSV files

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

7-1

File naming conventions used by Tiered Storage Manager for


Mainframe
The following table describes the file naming conventions for files used by
Tiered Storage Manager for Mainframe.

Table 7-1 File naming conventions used by Tiered Storage Manager for
Mainframe
File type

File name

Tiering policy information CSV file

prefix.POLICY.policy-ID

Disk configuration definition file

prefix.DSK.SNnnnnn.LOCAL

Tiering policy group definition file

prefix.TPG.tiering-policy-group-ID

prefix is the character string to be specified in Configuration file prefix


on the Edit Defaults panel, or the character string to be specified in the
PREFIX parameter of CLI commands. Make sure that you specify the
same character string for all three types of files used by Tiered Storage
Manager for Mainframe.
Caution: If you want to install and use Tiered Storage Manager for
Mainframe in the same system as Business Continuity Manager, you must
make sure that the prefix character strings for Business Continuity
Manager and Tiered Storage Manager for Mainframe are different. If the
same prefix is used for both Business Continuity Manager and Tiered
Storage Manager for Mainframe, the product may operate abnormally.

policy-ID is the identifier of a tiering policy information CSV file. This is


the value to be specified in the POLICY parameter of the KTIMPORT
command.

nnnnn is the serial number of the storage system.

tiering-policy-group-ID is the identifier of a tiering policy group. This is


specified in a tiering policy CSV file as the name of a tiering policy group.

Caution: Use the disk configuration definition file and tiering policy group
definition file as a reference only. They might not function properly if you
change the file contents.
The following table shows the maximum length and the permitted characters
for items in the filenames used by Tiered Storage Manager for Mainframe.

Table 7-2 Maximum length and permitted characters for items in


filenames used by Tiered Storage Manager for Mainframe
Maximum
length

Item
Prefix

7-2

25

Permitted characters
A string consisting of one or more parts, joined by
periods. Each part can contain from one to eight
characters, and consist of uppercase alphabetic and
numeric characters. Note that the first character of

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Maximum
length

Item

Permitted characters
each part must be an uppercase alphabetic
character.

Policy ID

One to eight uppercase alphabetic character or


numbers. This must start with an uppercase
alphabetic character.

Tiering policy
group ID

44 - (5 +
prefix)

A string consisting of one or more parts, joined by


periods. Each part can contain from one to eight
characters, and consist of uppercase alphabetic and
numeric characters. Note that the first character of
each part must be an uppercase alphabetic
character.

Format of datasets used by Tiered Storage Manager for


Mainframe
The following table explains the format of datasets used by Tiered Storage
Manager for Mainframe.

Table 7-3 Format of datasets used by Tiered Storage Manager for


Mainframe
File name

DSORG

RECFM

LRECL

BLKSIZE

Tiering policy information CSV file

PS

VB

128 or more

Any

Disk configuration definition file

PS

VB

256

4,096

Tiering policy group definition file

PS

VB

256

4,096

Disk space requirements of configuration files


The following table explains how to calculate the disk space required for
configuration files.

Table 7-4 Disk space requirements of configuration files


Configuration file

Size (unit: bytes)

Disk configuration definition file

700+A

400+B

230

Tiering policy group definition file

200+C

100+D

100

Legend:
A: Number of volumes specified in the disk configuration definition file
B: Number of pools specified in the disk configuration definition file
C: Number of volumes specified in the tiering policy group definition file
D: Number of records specified in the tiering policy group definition file

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

7-3

Format of tiering policy information CSV files


This section describes the format of tiering policy CSV files.

Descriptive conventions of tiering policy information CSV files


This subsection describes the descriptive conventions for tiering policy
information CSV files.

A record (row) with a hash mark (#) in the first column, as shown below,
is a comment.
# character-string

Any double quotation marks (") specified for a parameter are ignored.

If values after a parameter are omitted, commas (,) that are used as
separators of the values can also be omitted. In the following example,
the specification of the new-page assignment tier of the SGI storage
group and whether to execute tier relocation are omitted including
commas (,).
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2

Syntax of tiering policy information CSV files


This subsection describes the syntax of tiering policy information CSV files.

Syntax
record-type,device,tiering-policy-group-ID[,[tiering-policy-level][,
[new-page-assignment-tier][,[tier-relocation]]]]

Parameters
record-type, device
Specifies the volume or volumes for which a tiering policy is to be set.
Use one of the following patterns:

STORGRP,SMS-storage-group-name ~ <symbol name consisting of 8


or fewer characters>
Use this pattern when you specify the name of the SMS storage group
that the target volumes belong to. The tiering policy is set for all
volumes that belong to the specified SMS storage group.
DEVN,device-number ~ <4-digit hexadecimal number>
Use this pattern when you specify the device number of the target
volume.

VOLSER,volume-serial-number ~ <6 or fewer alphanumeric


characters>
Use this pattern when you specify the volume serial number of the
target volume.

tiering-policy-group-ID ~ <prefix character string>

7-4

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Specifies the name of the tiering policy group to be defined. An operation


can be performed in batch on all objects that belong to the tiering policy
group specified by this parameter.
prefix.TPG.tiering-policy-group-ID is used as the name of a tiering
policy group definition file. The maximum length of a tiering policy group
ID that can be specified is 44 - (5 + length-of-character-string-specifiedfor-prefix).
tiering-policy-level ~ <numeric characters> ((0|1|2|3|4|5)) <<0>>
Specifies a numeric characters as the tiering policy level (that determines
the tiers in which data is to be located) to be set for the specified volume.
The following table describes the relationships between tiering policy
levels and tiers in which data will be located.
The smaller the tier number, the higher the tier. For example, if an SSD
device and an SAS device make up a tiered volume, the SSD device is
Tier 1, and the SAS device is Tier 2.

Table 7-5 Relationship between tiering policy levels and tiers in which
data will be located
Tiering policy
level

Tier in which data will be located


3-tier configuration

2-tier configuration

All tiers (Tiers 1, 2, and 3)

All tiers (Tiers 1 and 2)

Tier 1

Tier 1

Tiers 1 and 2

All tiers (Tiers 1 and 2)

Tier 2

All tiers (Tiers 1 and 2)

Tiers 2 and 3

All tiers (Tiers 1 and 2)

Tier 3

Tier 2

new-page-assignment-tier ~ <alphabetic characters> ((HIGH|MIDDLE|LOW))


<<MIDDLE>>
Specifies the order of tiers to which new pages will be assigned first if
there are multiple tiers in the specified tiering policy level. The meanings
of the values that can be specified are as follows:

HIGH: The new page is assigned from the higher tier of tiers set in the
tiering policy.
MIDDLE: The new page is assigned from the middle tier of tiers set in
the tiering policy.

LOW: The new page is assigned from the lower tier of tiers set in the
tiering policy.
The following tables describe in detail the values set for the new-page
assignment tier in a 3-tier and a 2-tier configuration. how the order of
tiers to which new pages will be assigned is determined by the tiering
policy level and new-page assignment tier settings. In the table, 1>2
indicates that pages will first be assigned to Tier 1 (higher tier), and if
Tier 1 becomes full, pages will then be assigned to Tier 2 (lower tier). The

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

7-5

smaller the tier number, the higher the tier. For example, if an SSD
device and an SAS device make up a tiered volume, the SSD device is
Tier 1, and the SAS device is Tier 2.

Table 7-6 New-page assignment description (3-tier configuration)


Tiering
policy
level

Value of the new-page assignment tier setting


HIGH

MIDDLE

LOW

Description

1>2>3

2>3>1

3>2>1

The order changes according to the


value that is set. This is a case in
which setting a value is effective.

1>2>3

1>2>3

1>2>3

Because only one tier applies to this


level, the order does not change
according to the value that is set.

1>2>3

1>2>3

2>1>3

If LOW is set, Tier 2 is given higher


priority than Tier 1.

2>3>1

2>3>1

2>3>1

Because only one tier applies to this


level, the order does not change
according to the value that is set.

2>3>1

2>3>1

3>2>1

If LOW is set, Tier 3 is given higher


priority than Tier 2.

3>2>1

3>2>1

3>2>1

Because only one tier applies to this


level, the order does not change
according to the value that is set.

Table 7-7 New-page assignment description (2-tier configuration)


Value of the new-page assignment tier setting

Tiering
policy level

HIGH

MIDDLE

LOW

Description

1>2

1>2

2>1

If LOW is set, Tier 2 is given higher


priority than Tier 1.

1>2

1>2

1>2

Because only one tier applies to this


level, the order does not change
according to the value that is set.

1>2

1>2

2>1

1>2

1>2

2>1

If LOW is set, Tier 2 is given higher


priority than Tier 1.

1>2

1>2

2>1

2>1

2>1

2>1

Because only one tier applies to this


level, the order does not change
according to the value that is set.

tier-relocation ~ <alphabetic character> ((Y|N)) <<Y>>


Specifies whether to execute tier relocation for the volume or volumes.

7-6

Y: Executes tier relocation.

N: Does not execute tier relocation.

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Record priority
The priority of records in one tiering policy group is as follows.

If you specified the same SMS storage group name, device number, or
volume serial number for multiple records, the record specified last is
valid.

If you specified the same volume with both the record for the device
number and the record for the volume serial number, the record specified
last is valid.

If one record specifies a volume, and another record specifies an SMS


storage group that contains the same volume, the volume specification in
the former record takes priority.

Examples

Example of defining multiple volumes for different tiering policies


#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
DEVN
,1101 ,TPG1 ,1
DEVN
,1102 ,TPG1 ,5

Example of defining an SMS storage group and a volume belonging to


that SMS storage group
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1101 ,TPG1 ,1
,LOW
The record that specifies a specific volume takes priority.
For example, if a volume with device number 1101 belongs to SMS
storage group SG1 in the above coding, the tiering policy of the volume
with device number 1101 is as follows: the tiering policy level is 1 (not 2),
and the new-page assignment tier is LOW (not HIGH).

Example of defining the same volume for multiple tiering policy groups
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,1
STORGRP,SG1
,TPG2 ,5
Both definitions are valid. By using the KTACTTPG command to switch the
definition applied to the storage system, you can switch the definition
based on the time zone.

Example of defining the same volume more than once for a single tiering
policy group
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
DEVN
,1101 ,TPG1 ,1
DEVN
,1101 ,TPG1 ,5
The last record is valid. For example, in the above coding, tiering policy
level 5 is assigned to the volume with device number 1101.

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

7-7

Configuration example of tiering policy groups and example of


specifications in the corresponding tiering policy information CSV file
The following shows an example of configuring tiering policy groups and an
example of specifications in the corresponding tiering policy information CSV
file.

Figure 7-1 Configuration example of tiering policy groups


The following provides details about the tiering policy groups in the
configuration example.
Tiering policy group TPG1:

7-8

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Target volume

Tiering
policy level

New-page
assignment
tier

Whether to
execute tier
relocation

Volumes belonging to SMS


storage group SG1

HIGH

Not specified

Volume of device number 1101

Not specified

Not specified

Volume of device number 1202

HIGH

Not specified

Tiering policy group TPG2:


Target volume
Volumes belonging to SMS
storage groups SG2 and SG3

Tiering
policy level
5

New-page
assignment
tier
Not specified

Whether to
execute tier
relocation
Not specified

Specify as follows to define the sample configuration shown above:


Specification in the tiering policy information CSV file
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1101 ,TPG1 ,1
DEVN
,1202 ,TPG1 ,2
,HIGH
STORGRP,SG2
,TPG2 ,5
STORGRP,SG3
,TPG2 ,5
Values that must be specified for the prefix, policy ID, and tiering policy
group ID

Prefix: PREFIX1
This value will be used as the file name prefix for configuration files
and tiering policy information CSV files.
Policy ID: POLICY1
This value will be used as the file name suffix for tiering policy
information CSV files.
Tiering policy group IDs: TPG1 and TPG2
These values will be used as the file name suffixes for tiering policy
group definition files.

Examples of changing a tiering policy information CSV file


The following provides examples of changing a tiering policy information CSV
file.

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

7-9

When changing the tiering policy

Modify the tiering policy parameters in the record.


Before the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1101 ,TPG1 ,1
DEVN
,1202 ,TPG1 ,2
,HIGH
After the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1101 ,TPG1 ,1
DEVN
,1202 ,TPG1 ,5
,LOW

When changing the tiering policy back to the default

Keep the record, but delete the tiering policy parameters.


Before the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1202 ,TPG1 ,2
,HIGH
After the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1
DEVN
,1202 ,TPG1 ,2
,HIGH

7-10

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

The above example changes the tiering policy of volumes in the storage
system in the SMS storage group SG1 back to the default.
Tip: After you change the tiering policy back to the default, the status of the
volume to delete is as follows:

Tiering policy level: 0

New-page assignment tier: MIDDLE

Whether to execute tier relocation: Y

Caution: If the record (not the tiering policy parameters) is deleted, the
volume is deleted from the tiering policy group while the tiering policy
remains. Consequently, Tiered Storage Manager for Mainframe cannot
manipulate the volume.

When deleting tiering policies assigned individually to volumes in


the SMS storage group so that they match the settings on the SMS
storage group

This example deletes the record of the volume from the tiering policy
information CSV file. After the record is deleted, the tiering policies assigned
individually are deleted. The tiering policies that are set to the SMS storage
group where the volume belongs are applied.
Before the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1101 ,TPG1 ,1
DEVN
,1202 ,TPG1 ,2
,HIGH
After the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1202 ,TPG1 ,2
,HIGH
In the above example, the tiering policy level of the volume of device number
1101 in the SMS storage group SG1 is 2. The new-page assignment tier is
HIGH.

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

7-11

When adding a volume to the SMS storage group

#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH

Add a volume to the SMS storage group. You do not need to modify the
tiering policy information CSV file.

When adding a volume that does not belong to the SMS storage
group

Add the record of the volume to be added to the tiering policy information
CSV file.
Before the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
After the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1202 ,TPG1 ,2
,HIGH

7-12

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

When deleting a volume that belongs to the SMS storage group

#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1202 ,TPG1 ,2
,HIGH

Remove the volume from the SMS storage group. You do not need to modify
the tiering policy information CSV file.

When deleting a volume that does not belong to the SMS storage
group

Delete the record of the volume from the tiering policy information CSV file.
Before the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH
DEVN
,1202 ,TPG1 ,2
,HIGH
After the change:
#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
,HIGH

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

7-13

7-14

Files used by Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

8
REXX variable structures
This chapter describes the REXX variable structures used by Tiered Storage
Manager for Mainframe.
List of REXX variable structures
Message structure
Host-discovered array index structure
Host-discovered array structure
Tiering policy group structure
Device information structure

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

8-1

List of REXX variable structures


REXX variable structures are variables expanded by executing a CLI
command. REXX variable structures store the values loaded from Tiered
Storage Manager for Mainframe configuration files, information acquired from
the storage system, and the results of CLI commands. These structures are
also used for passing information between CLI commands. Some values of
REXX variable structures are saved in configuration files.
The following table lists the REXX variable structures.

Table 8-1 REXX variable structures


REXX variable
structure name

Contents

Configuration file that


stores REXX variable values

Message structure

Messages generated by CLI


commands

None (Information is not saved


in a configuration file.)

Host-discovered
array index
structure

Information about the


None (Information is not saved
configuration of a storage system
in a configuration file.)
and volumes in the storage system

Host-discovered
array structure

Values set for the storage system


Disk configuration definition
and volumes in the storage system file

Tiering policy group Values related to tiering policies


structure
that are to be set in the storage
system for the volumes belonging
to a tiering policy group

Tiering policy group definition


file

Device information
structure

None (Information is not saved


in a configuration file.)

Address information for volumes

Message structure
Messages generated by CLI commands are stored in the message structure.

When the structure is created


When a CLI command is executed

Prefix of the structure name


The prefix of the message structure name is the value specified for the MSG
parameter of each command.

REXX variable names and contents


The following table lists and describes the REXX variables in the message
structure. A REXX variable name is preceded by the prefix of the structure
name.

8-2

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

Table 8-2 Message structure


REXX variable name

Description

Number of messages output by one command (n)

n.

Information for each message is stored in the lower-level REXX variables.


Severity

Severity

Message ID and message text

Text

Additional information

Value

Host-discovered array index structure


The host-discovered array index structure stores information values that
indicate the configuration of a storage system and volumes in the storage
system.

When the structure is created


The structure is created when one of the following occurs:

The KTLOAD command is executed (the structure is created by loading


information from the disk configuration definition file).

The KTGETHDA command is executed (the structure is created by loading


information from the disk configuration definition file).

The KTSCAN command is executed.

Prefix of the structure name


The prefix of the host-discovered array index structure name is either of the
following:

If the structure is created by the KTLOAD command or KTGETHDA


command: HCC.HDAKT.

If the structure is created by the KTSCAN command: Value specified for


the ARRAYS parameter (if the ARRAYS parameter is omitted, HCC.KTSCAN.)

REXX variable names and contents


The following table lists and describes the REXX variables in the hostdiscovered array index structure. A REXX variable name is preceded by the
prefix of the structure name.

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

8-3

Table 8-3 Host-discovered array index structure


REXX variable
name

Description

Number of storage systems (n)

n.

Information for each storage system is stored in lower-level REXX variables.


Serial number of the scanned storage system

SerialNum

Fixed character string LOCAL is stored.

DADID

Prefix of the host-discovered array structure from which the last period is removed

Prefix

Map information obtained from the pool IDs

POOLMap

1 is set for the position corresponding to the pool ID. The first value indicates pool ID
00. If this value is

1, the defined pool IDs will be 01 and 03.

Map information obtained from the control unit numbers

CUMap

1 is set to the position corresponding to the control unit numbers. The first value
indicates control unit number 00. If this value is 11
numbers will be 00, 01, 03, and 05.

1, the defined control unit

Information for each control unit is stored in lower-level REXX variables. xx indicates
a control unit number (hexadecimal).

CUxx.

No information for undefined control unit numbers is stored in REXX variables. Check
the defined control unit numbers from the map information.
CCAMap

Map information obtained from the command control address


1 is set to the position corresponding to the command control address numbers. The
first value indicates command control address number 00. If this value is 1
defined command control address numbers are 00, 03, and 04.

11, the

Note:
in the table indicates a space.

Host-discovered array structure


The host-discovered array structure stores the settings for a storage system
and volumes in the storage system.

When the structure is created


The host-discovered array structure is created when one of the following
occurs:

8-4

The KTLOAD command is executed (the structure is created by loading


information from the disk configuration definition file).

The KTGETHDA command is executed (the structure is created by loading


information from the disk configuration definition file).

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

The KTQRYDEV command is executed.

The KTSCAN command is executed.

Prefix of the structure name


The prefix of the host-discovered array structure name is the value specified
for the STEM parameter of each command.

REXX variable names and contents


The following table lists and describes the REXX variables in the hostdiscovered array structure. A REXX variable name is preceded by the prefix of
the structure name.

Table 8-4 Host-discovered array structure


REXX variable name

Description
Information for each storage system is stored in lowerlevel REXX variables. nnnnn indicates the storage
system serial number.

LOCAL.SNnnnnn.

Storage system serial number

SerialNum

Storage system model (USP|USPV|VSP)

Model

Microcode number

Microcode

Interface version

IFType

Physical DKC serial number

PhysicalSerialNum

Logical DKC number

LDKCNum
CUxx.
(followed by lower-level REXX variables)

Information for each control unit is stored in lowerlevel REXX variables. xx indicates a control unit
number (hexadecimal).
No information for undefined control unit numbers is
stored in REXX variables. Check the defined control
unit numbers from the map information stored in the
host-discovered array index structure.

POOLxx.
(followed by lower-level REXX variables)

Information for each Dynamic Tiering for Mainframe


pool is stored in lower-level REXX variables. xx
indicates a pool ID (xx is hexadecimal). No information
is stored in REXX variables for undefined pool IDs.
Check the defined pool IDs from the map information
stored in the host-discovered array index structure.

Lower-level REXX variables for LOCAL.SNnnnnn.CUxx.

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

8-5

REXX variable name

Description
Upper-variable name

LOCAL.SNnnnnn.CUxx.

One of the storage system IDs of the control unit

SSID

Information for each command control address is stored in lowerlevel REXX variables. xx indicates a command control address
number (hexadecimal). No information for undefined command
control address numbers is stored in REXX variables. Check the
defined command control address numbers from the map
information stored in the host-discovered array index structure.

CCAxx.

Device number

Devn

Volume serial number

Volser

SMS storage group name

STORGRP

Storage system ID

SSID

Pool ID (decimal number)

POOLID

Volume capacity (number of cylinders)

Cyls

External volume information

External

Y: External volume

N: Not an external volume

N is always specified for Dynamic Tiering for Mainframe volumes or


Dynamic Provisioning for Mainframe volumes.
Tiering policy level

TierLevel

New-page assignment tier

Entry

TierRelocation

Used
Tier.
0
n.

8-6

HIGH: The new page is assigned from the higher tier of tiers
set in the tiering policy.

MIDDLE: The new page is assigned from the middle tier of tiers
set in the tiering policy.

LOW: The new page is assigned from the lower tier of tiers set
in the tiering policy.

Whether to execute tier relocation

Y: Executes tier relocation.

N (other than Y): Does not execute tier relocation.

Total number of pages allocated to the volume


-Number of tiers (n)
Information for each tier is stored in lower-level REXX variables. n
indicates a tier number.

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

REXX variable name

Description
Number of pages assigned to each tier

Used

--

IO.

Number of I/Os for the target volume (integrated value)

Ct

Only the number of I/O operations at the back end are counted as
I/O operations (number of I/O operations for the drive media).

diff

Number of I/Os for the target volume after the previous KTQSTATS
command was issued
This value is invalid if the prefixTPG.n.IO.Interval in the tiering
policy group structure is set to 0.

Note:
Some REXX variables take effect only for Dynamic Tiering for Mainframe
volumes or Dynamic Provisioning for Mainframe volumes. If the value is
not valid, 0 or a NULL is set.
Lower-level REXX variables for LOCAL.SNnnnnn.POOLxx.
REXX variable name
LOCAL.SNnnnnn.POOLxx.

Description
Upper-variable name
Pool name

NAME

Pool type

Type

DT: Dynamic Tiering for Mainframe pool

DP: Dynamic Provisioning for Mainframe pool

OTHER: Other pools

Page size (unit: TRK)

PageSize

Monitoring mode

Auto

RelocateStartTime#
RelocateEndTime#

Y: Automatic execution mode (tier relocation is


performed automatically)

N: Manual execution mode

Tier relocation start time (hh:mm)


Tier relocation end time (hh:mm)
Relocation status

Relocating

RelocatePerCent
ExpectedMigrationPageCt#

Y: Relocation in progress

N: Relocation finished or stopped

Relocation progress (%)


Expected number of migrated pages for the entire
pool

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

8-7

REXX variable name


MigratedPageCt#

Description
Number of migrated pages for the entire pool
--

Tier.

Number of tiers (n)

Information for each tier is stored in lower-level


REXX variables. n indicates a tier number.

n.

Attribute of the drive media in the pool


(hexadecimal)

Media

Capacity

0000: SSD (SSD) or Native Flash (NF)

0001: SAS 15K RPM (SAS 15K)

0002: SAS 10K RPM (SAS 10K)

0003: SATA 7.2K RPM (SATA 7.2K)

0004: External connection (Mid) (EXTERNAL M)

0005: SAS 7.2K RPM (SAS 7.2K)

0006: Mixed

0007: External connection (High) (EXTERNAL H)

0008: External connection (Low) (EXTERNAL L)

Total tier capacity


Used tier capacity

Used

Unit of the total tier capacity and used tier capacity

Unit
EntryBufferPerCent

Free area ratio for new-page assignment (%). This is


the percentage of free area allocated for each tier to
which new pages can be assigned during relocation.

RelocateBufferPerCent

Percentage of the buffer area used for relocation


(%)

m.

m indicates the migration-source tier number.


Expected number of pages to be migrated from tier
ExpectedMigrationPageCt# m to tier n.
MigratedPageCt#

Number of pages migrated from tier m to tier n.

Note:
Some REXX variables take effect only for Dynamic Tiering for Mainframe
pools. If the value is not valid, 0 or a NULL is set.
#:
This does not display information about the relocation that is currently
being executed. This displays information about the relocation that was
performed in the previous cycle.

8-8

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

How to obtain the variable parts (nnnn and xx) in REXX variable
names
To view volume and pool information from the host-discovered array
structure, you need the following information for the storage system to
identify the volume or pool: serial number (nnnnn in SNnnnnn), control unit
number (xx in CUxx), command control address (xx in CCAxx), and pool ID
(xx in POOLxx). You can obtain these values from the REXX variable values in
the tiering policy group structure, host-discovered array index structure, or
device information structure. Use the obtained values to create a REXX
variable name for the host-discovered array structure, and then view the
information. For details, see the sample scripts in which the corresponding
commands are used.
Example of the KTQRYDEV command
This example shows how to obtain the storage system's serial number
(SN), CU number, and command control address from the device
information structure, create the REXX variable name for the hostdiscovered array structure, and then view the tiering policy level of the
volume. In this example, the prefix of the host-discovered array structure
is assumed to be DEMO_STEM.
sym_SN = 'SN' || DEMO_STEM.SerialNum
sym_CU = 'CU' || DEMO_STEM.CUNum
sym_CCA = 'CCA' || DEMO_STEM.CCA
TierLevel = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.TierLevel

Related topics

Appendix C, Sample scripts on page C-1

Tiering policy group structure


The values to be set for the storage system for the volumes belonging to a
tiering policy group are stored in the tiering policy group structure.

When the structure is created


The KTLOAD command is executed (the structure is created by loading
information from the tiering policy group definition file).

Prefix of the structure name


The prefix of the tiering policy group structure name is the value specified for
the STEM parameter of each command.

REXX variable names and contents


The following table lists and describes the REXX variables in the tiering policy
group structure. A REXX variable name is preceded by the prefix of the
structure name.

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

8-9

Table 8-5 Tiering policy group structure


REXX variable name

Description
--

TPG.

Tiering policy group name

ID

--

VOL.

Number of volumes (n)

Information for each volume is stored in lower-level REXX


variables.

n.

Storage system serial number

SerialNum

Command unit number

CUNum

Command control address

CCA

Pool ID (decimal number)

POOLID

Storage system ID

SSID

Tiering policy level

TierLevel

New-page assignment tier

Entry

TierRelocation

HIGH: New pages are assigned to a high-level tier first.

MIDDLE: New pages are assigned to a middle-level tier first.

LOW: New pages are assigned to a low-level tier first.

Whether to execute tier relocation

Y: Executes tier relocation.

N (other than Y): Does not execute tier relocation.

--

IO.
Interval

Interval since issuing the KTQSTATS command (in seconds). This is


the elapsed time since the previous KTQSTATS command was
issued. If the command has not been issued yet or has been
issued only one time, 0 is set.

Device information structure


The address and the pool ID of the volumes subject to the KTQRYDEV
command is stored in the device information structure.

When the structure is created


When the KTQRYDEV command is executed

8-10

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

Prefix of the structure name


The prefix of the device information structure name is the value specified for
the STEM parameter of the KTQRYDEV command.

REXX variable names and contents


The following table lists and describes the REXX variables in the device
information structure. A REXX variable name is preceded by the prefix of the
structure name.

Table 8-6 Device information structure


REXX
variable
name

Description

SerialNum

Storage system serial number

CUNum

Command unit number

CCA

Command control address

POOLID

Pool ID (decimal number)


A NULL is set if the volume subject to the KTQRYDEV command is not a Dynamic
Provisioning for Mainframe volume or a Dynamic Tiering for Mainframe volume.

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

8-11

8-12

REXX variable structures


Hitachi Tiered Storage Manager for Mainframe User Guide

9
Collecting trace information and logs
This chapter describes collecting trace information and logs for Tiered Storage
Manager for Mainframe.
Information that can be used for troubleshooting
Collecting trace information
Log types for Tiered Storage Manager for Mainframe
Collecting event logs
Collecting event logs by using the system logger service
Collecting event logs without using the system logger service
Collecting ISPF logs
Collecting the CLI command-execution log

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-1

Information that can be used for troubleshooting


If an error occurs, trace information and logs can be used for troubleshooting.
The following table shows the information that can be used for
troubleshooting.

Table 9-1 Information that can be used for troubleshooting


Information that can
be used for
troubleshooting

Description

Trace information

Trace information includes user operations and macros issued to the storage
system. It is saved in memory and can be used to help analyze the causes of
errors. In Tiered Storage Manager for Mainframe, trace information saved in
memory is output to an ABEND dump if a CLI command terminates abnormally.

Logs

Error messages and trace information (event log) are collected in log
datasets.

Log data for the CLI commands executed in the ISPF panel are collected in
ISPF log dataset.

CLI command-execution logs are collected in SYSLOG.

Related topics

Collecting trace information on page 9-2

Log types for Tiered Storage Manager for Mainframe on page 9-3

Collecting trace information


Trace information about user operations and macros issued to hardware is
saved in memory. To help analyze the causes of errors, the trace information
can be specified to be output to an ABEND dump if a CLI command
terminates abnormally.
If GTF is started with the GTF parameter specified to acquire an USR trace
(TRACE=USR), trace information will be acquired as a GTF trace with an
event code from X'300' to X'30F'.

Collecting trace information when using scripts


To output ABEND dumps when using scripts to operate Tiered Storage
Manager for Mainframe, specify SYSABEND for a JCL DD statement.

Collecting trace information when using TSO/E


The following describes how to output ABEND dumps when using TSO/E to
operate Tiered Storage Manager for Mainframe.

9-2

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

Procedure
1.

Log on to the TSO/E terminal.

2.

Enter the following commands.

To output an ABEND dump to the spool:


ALLOC DD(SYSABEND) SYSOUT(SYSOUT-class)
To output an ABEND dump to a dataset:
ALLOC DD(SYSABEND) DS(dataset-name)

3.

Execute a CLI command.

4.

If the CLI command terminated abnormally and the system returned to


the READY mode, press the Enter key.
If you enter a TSO/E command without pressing the Enter key, ABEND
dumps might not be output.

Log types for Tiered Storage Manager for Mainframe


Of the acquired trace information, only the information that must be
presented to the user is output to a log.
The following table shows the log types for Tiered Storage Manager for
Mainframe, the collected information, and the output destinations.

Table 9-2 Log types for Tiered Storage Manager for Mainframe
Log type

Collected information

Event log

ISPF log

CLI commandexecution log

Messages

Only in the case of an I/O error,


parameter information, return
information, and sense byte
information for that I/O

Time-stamps

Command parameter information

Transaction logs in the ISPF panel

Messages that were output during


command execution

CLI command name

Parameters

Execution results

Output destination

When the system logger service is


used:
DASD-only log stream for the system
logger service

When the system logger service is


not used:
Log dataset for Tiered Storage
Manager for Mainframe

ISPF log dataset

SYSLOG

Related topics

Collecting event logs on page 9-4

Collecting ISPF logs on page 9-19

Collecting the CLI command-execution log on page 9-20

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-3

Collecting event logs


This section describes how to collect event logs.

How to collect event logs


Two methods are available for collecting event logs. Use the LOGPUT
environment variable or the &YKLOGPT system symbol to select the method.
The methods for collecting event logs are as follows.

Use the system logger service to output event logs to a log stream, and
then use the Tiered Storage Manager for Mainframe tool to output the
event logs from the log stream to a dataset.

Output event logs to a Tiered Storage Manager for Mainframe log dataset
without using the system logger service.

The system logger service provides the MVS-standard functionality for


writing, displaying, and deleting log data.
The system logger service has the following features. Use them as the
guideline for determining whether to use the system logger service.

Provides mechanisms for capacity management (functions for


automatically migrating log data and automatically allocating log
datasets) and troubleshooting (log duplication function).

Allows the users to extract only necessary information later and


customize it.

Allows the users to view logs in the middle of a program.

Related topics

Setting the operating environment by using environment variables on


page 2-19

Setting the operating environment by using system symbols on page 2-21

Collecting event logs by using the system logger service on page 9-5

Collecting event logs without using the system logger service on page
9-16

About event log output datasets


Event log data can be output to two types of datasets.
When the system logger service is used, log data is output to the DASD-only
log stream for the system logger service. Use the event log output tool
(KTLOGCP) to output the log data from the log stream to a dataset.
If the system logger service is not used, log data is output to a Tiered
Storage Manager for Mainframe log dataset for each job.
The following figure provides an overview of event log output.

9-4

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

Figure 9-1 Overview of event log output


For details about log streams, see the manual MVS Programming: Assembler
Services Reference.

Related topics

Collecting event logs by using the system logger service on page 9-5

Collecting event logs without using the system logger service on page
9-16

Collecting event logs by using the system logger service


This section describes how to collect event logs when the system logger
service is used.

Settings for collecting event logs when using the system logger
service
This subsection describes the settings for collecting event logs by using the
system logger service.
To collect event logs by using the system logger service, the settings for
using the system logger service must be specified.
To use the DASD-only log stream for the system logger service, perform all
sysplex setup procedures described in the manual MVS Setting Up a Sysplex
to set up the sysplex.
Care must be taken with the items shown in the following table during setup
of the system logger service.

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-5

Table 9-3 Items that require care during setup of the system logger
service
Item

Required/
optional

Remarks

Setting LOGR couple data sets

Required

--

Defining the SMS for the system


logger service

Optional

Set this item when allocating


staging datasets or log datasets to
the SMS management volume.

Defining a log stream

Required

--

Setting access privileges for


system logger resources

Optional

Set this item when using the


System Authorization Facility (SAF).

Starting the system logger


service

Required

--

Related topics

Setting LOGR couple data sets on page 9-6

Defining the SMS for the system logger service on page 9-6

Defining a log stream on page 9-6

Setting access privileges for system logger resources on page 9-7

Starting the system logger service on page 9-7

Setting LOGR couple data sets


In a sysplex environment, format the LOGR couple datasets and then define
them for the sysplex.

Defining the SMS for the system logger service


To allocate staging datasets and log datasets used by the system logger
service to an SMS management volume, you must define the SMS for the
Tiered Storage Manager for Mainframe system logger service.
You need to define the following items.

SMS storage group

Management class

Storage class

Data class

ACS routine

Defining a log stream


Use the IXCMIAPU utility to define a log stream.

9-6

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

Allocate one Tiered Storage Manager for Mainframe log stream to a system.
In the sysplex environment, allocate one log stream to each system in which
Tiered Storage Manager for Mainframe is started.

Procedure
1.

Correct the parameters including the log stream name


(log_stream_name) for the IXCMIAPU utility shown below according to
the environment.
The following is an example of parameters when an SMS definition is not
used.
//DEFINE1 EXEC PGM=IXCMIAPU
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
DATA TYPE(LOGR) REPORT(YES)
DEFINE LOGSTREAM NAME(log_stream_name)
DASDONLY(YES)
MAXBUFSIZE(64000)
STG_SIZE(800)
LS_SIZE(5000)
HLQ(CCENTRAL)
/*

2.

Execute the IXCMIAPU utility.

Related topics

Parameters specified when a log stream is defined on page 9-8

Setting access privileges for system logger resources


If the System Authorization Facility (SAF) can be used, grant access
privileges to users who execute Tiered Storage Manager for Mainframe
commands because the system performs SAF checks for each request.
The following access privileges must be granted.

CLASS: FACILITY
RESOURCE: MVSADMIN.LOGR
Permission: ALTER permission or READ permission

CLASS: LOGSTRM
RESOURCE: Log stream name
Permission: ALTER permission

Starting the system logger service


This subsection describes how to start the system logger service.
To start the system logger service, activate the subsystem (system logger
address space). If the subsystem is not active, an error will occur in the
connection request macro (IXGCONN).

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-7

Procedure
1.

Use either of the following methods to activate the subsystem.

Add SUBSYS SUBNAME(LOGR) INITRTN(IXGSSINT) to the IEFSSNxx


parmlib member.
To activate the subsystem with this method, you must perform an IPL
again.
Use the SETSSI ADD,SUBNAME=LOGR,INITRTN=IXGSSINT command to
dynamically add the subsystem.

Tip: To stop the system logger service, execute the FORCE IXGLOGR,ARM
command. To restart the system logger service that was stopped by the
FORCE IXGLOGR,ARM command, use the S IXGLOGRS command.

Parameters specified when a log stream is defined


This subsection describes the parameters that are specified when the
IXCMIAPU utility is used to define a log stream.
For details about parameters, see the manual MVS Setting Up a Sysplex.
NAME(log_stream_name)
The log stream name is CCENTRAL.LOG.system-name. For a system-name,
specify the system name of the system symbol (&SYSNAME). If a system
name starts with a number, Tiered Storage Manager for Mainframe
extracts the last five characters of the system name and adds prefixed
YKS to them to form the log stream name. If a system name starts with a
number, the last five characters used for the log stream name must be
unique within the sysplex.
The following shows examples of how a system name starting with a
number is converted to the system name in a log stream name.

For the system name 1SYS starting with a number and consisting of
less than five characters:
YKS is added to the system name to create YKS1SYS.
For the system name 1SYSTEM starting with a number and consisting
of more than five characters:
YKS is added to the last five characters YSTEM to create YKSYSTEM.

For the system names 1SYSTEM and 2SYSTEM, both of which start with
numbers and consist of more than five characters:
YKS is added to the last five characters YSTEM to create YKSYSTEM,
which results in two identical system names. In this case, the system
name (&SYSNAME) specified for the IEASYSxx parmlib member must be
changed.
For details about system names, see the manual MVS Initialization and
Tuning Reference.

DASDONLY(YES)
Specify YES to make the log stream a DASD-only log stream.

9-8

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

MAXBUFSIZE(maxbufsize)
Maximum block size of a log. Specify 64000 (bytes).
STG_SIZE(stg_size)
Specify the size of the staging dataset. Specify a value in the range from
100 (400KB) to 1000 (4MB).
Do not specify this parameter when using an SMS definition.
STG_DATACLAS(stg_dataclas)
Specify the name of the SMS data class used for allocating the DASD
staging dataset for this log stream. Specify this parameter when using an
SMS definition.
STG_MGMTCLAS(stg_mgmtclas)
Specify the name of the SMS management class used for allocating the
DASD staging dataset for this log stream. Specify this parameter when
using an SMS definition.
STG_STORCLAS(stg_storclas)
Specify the name of the SMS storage class used for allocating the DASD
staging dataset for this log stream. Specify this parameter when using an
SMS definition.
LS_SIZE(ls_size)
Specify the size of the DASD log dataset. Specify any size.
The required size depends on the frequency of the output of event log
data from the log stream to a dataset and how event log data is deleted.
Specify an appropriate value to prevent the dataset from being full.
Do not specify this parameter when using an SMS definition.
LS_DATACLAS(ls_dataclas)
Specify the name of the SMS data class used for allocating a log dataset.
Specify this parameter when using an SMS definition.
LS_MGMTCLAS(ls_mgmtclas)
Specify the name of the SMS management class used for allocating a log
dataset. Specify this parameter when using an SMS definition.
LS_STORCLAS(ls_storclas)
Specify the name of the SMS storage class used for allocating a log
dataset. Specify this parameter when using an SMS definition.
AUTODELETE(YES)
Specify this parameter when automatically deleting event log data.
RETPD(retpd)
Specify this parameter when automatically deleting event log data.
Specify the number of days to retain event log data in the log stream.
HLQ(CCENTRAL)
This parameter specifies that CCENTRAL is the high level qualifier used as
a part of the log dataset name. This parameter is optional. If this

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-9

parameter is not specified, the default high level qualifier IXGLOGR will be
a part of the log dataset name.
The specification of the following parameters is optional.

HIGHOFFLOAD

LOWOFFLOAD

LIKE

MODEL

DIAG

JCL example for confirming a log stream


The following shows an example of JCL for confirming the definition of a log
stream and the allocation of a log dataset.
//LIST1 EXEC PGM=IXCMIAPU
//SYSPRINT DD SYSOUT=*
//SYSIN DD *
DATA TYPE(LOGR) REPORT(YES)
LIST LOGSTREAM NAME(log_stream_name) DETAIL(YES)
/*

JCL example for deleting a log stream


The following shows a JCL example used for deleting the log stream when the
log dataset is full.
//DEL1
EXEC PGM=IXCMIAPU
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
DATA TYPE(LOGR)
DELETE LOGSTREAM NAME(log_stream_name)
/*

Preventing the event log from becoming full when the system logger
service is used
This subsection describes how to prevent the event log from becoming full
when the system logger service is used.

Procedure
1.

If a log dataset is full, execution of a CLI command will continue, but


event log data will no longer be output. Use either of the following
management methods to prevent the log dataset from becoming full.

9-10

Automatically delete event log data (specify the AUTODELETE(YES)


parameter when defining the log stream).
Periodically delete and re-define the log stream.

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

Use the IXCMIAPU utility with the DELETE LOGSTREAM


NAME(log_stream_name) parameter specified to delete the log
stream. The log dataset is deleted when the log stream is deleted. For
details, see the manual MVS Setting Up a Sysplex.

Related topics

Parameters specified when a log stream is defined on page 9-8

JCL example for deleting a log stream on page 9-10

Re-defining the log stream when the event log is full


If a log dataset is full, execution of CLI commands will continue, but event log
data will no longer be output. To resume the output of event log data,
suspend the CLI command, and then delete and re-define the log stream.

Procedure
1.

Suspend the CLI command.

2.

Use the event log data output tool (KTLOGCP) to output all log data from
the log stream to a dataset.

3.

Use the IXCMIAPU utility with the DELETE LOGSTREAM


NAME(log_stream_name) parameter specified to delete the log stream.
The log dataset is deleted when the log stream is deleted. For details, see
the manual MVS Setting Up a Sysplex.

4.

Re-define the log stream.

5.

Log on to TSO/E again and then execute the CLI command.

Related topics

Parameters specified when a log stream is defined on page 9-8

Outputting logs by using the event log data output tool on page 9-13

JCL example for deleting a log stream on page 9-10

Restarting the system logger service and re-defining the log stream
when the event log is full
If a log dataset is full, execution of CLI commands will continue, but event log
data will no longer be output. The log stream cannot be deleted during
execution of a CLI command. Therefore, if the CLI command cannot be
stopped when a log dataset is full, you can restart the system logger service
and then delete and re-define the log stream to resume the output of event
log data.

Procedure
1.

Enter the FORCE IXGLOGR,ARM command to stop the system logger


service.

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-11

2.

Enter the S IXGLOGRS command to restart the system logger service.

3.

Use the IXCMIAPU utility with the DELETE LOGSTREAM


NAME(log_stream_name) parameter specified to delete the log stream.
The log dataset is deleted when the log stream is deleted. For details, see
the manual MVS Setting Up a Sysplex.

4.

Re-define the log stream.

Related topics

Starting the system logger service on page 9-7

Parameters specified when a log stream is defined on page 9-8

JCL example for deleting a log stream on page 9-10

Disk space requirements for the event log when the system logger
service is used
The following table shows the amount of log data when the system logger
service is used to output the event log.

Table 9-4 Amount of event log data when the system logger service is
used
Number per
command

Size#1

Types of event log data


Messages (excluding messages output
from the ISPF panel and scripts)

68 + message
length#2

Number of output
messages

Only in the case of an I/O error,


parameter information for the CCW for
that I/O

68 + CCW length#2

Number of I/O errors

Only in the case of an I/O error, return


information for that I/O

224

Number of I/O errors

Only in the case of an I/O error, sense


byte information for that I/O

224

Number of I/O errors

Time-stamps

96

Command parameter information

224

#1
The size is rounded up to a multiple of 32 before being output.
#2
The maximum length is 256 bytes.

Estimating the staging dataset


Estimate the disk capacity based on the amount of event log data.

9-12

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

Estimating the log stream dataset


Estimate the disk capacity based on the amount of offloaded event log data
and the retention period.

Estimating the dataset (OUTLOG) to which logs are output from the
log stream
Estimate the disk capacity based on the amount of offloaded event log data
and the retention period.

Overview of the event log data output tool


The event log data output tool (KTLOGCP) outputs the event log data
accumulated in the log stream to a dataset. The output log data will not be
deleted from the log stream.
KTLOGCP allows you to output only the necessary event log data by specifying
conditions for output data.
The maximum length of a record that can be output is 8,192 bytes. Log data
longer than 8,192 bytes will be divided before being output. The maximum
block length is 32,760 bytes.
Tip: To merge event log data activated by multiple OSs in a sysplex
environment, output the log for each OS from the log stream to a dataset,
transfer files to a PC, and then sort the files in chronological order.

Outputting logs by using the event log data output tool


From the event log output by the system logger service to the data stream,
you can output the required log data to a dataset by using the event log data
output tool (KTLOGCP).

Procedure
1.

Determine the conditions for event log data to be output (start time, end
time, and job name).

2.

Create a control statement for KTLOGCP.


The following shows the format of the SYSIN dataset for specifying a
control statement.

3.

Dataset format: Sequential dataset in the fixed-length record format

Record length: 80 bytes

Block length: Any value (multiple of 80)

Create a JCL for KTLOGCP.


Use the following example to create a JCL for KTLOGCP.
//YUKON01 JOB
//
EXEC PGM=KTLOGCP
//OUTLOG
DD DSN=YUKON.LOG.DATA,DISP=(NEW,KEEP),

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-13

//
RECFM=VB,LRECL=8192,BLKSIZE=32760,
//
SPACE=(CYL,(100,10)),VOL=SER=WKVL01,UNIT=DASD
//SYSPRINT DD SYSOUT=A
//SYSIN
DD *
RANGE STARTTIME(2013/03/24,00:00:00) ENDTIME(2013/03/24,23:59:59)
SELECT COND(JOBNAME,EQ,'USER01T')
SELECT COND(JOBNAME,EQ,'USER01')
/*

4.

Execute KTLOGCP.

Related topics

Control statements for the event log data output tool on page 9-14

Output format of the event log data output tool on page 9-15

Control statements for the event log data output tool


A control statement specified in the DD statement SYSIN for the log data
output tool (KTLOGCP) contains a RANGE control statement, which specifies
the time, and SELECT control statements, which specify the job names.
If the DD statement SYSIN is not specified or if no control statement exists,
all log data for the system logger service will be output from the log stream
to a dataset.

Format of the RANGE control statement


RANGE{
1STARTTIME(yyyy/mm/dd[,hh:mm:ss])

1ENDTIME(yyyy/mm/dd[,hh:mm:ss])|

1STARTTIME(yyyy/mm/dd[,hh:mm:ss])|
1ENDTIME(yyyy/mm/dd[,hh:mm:ss])}

RANGE control statement operands


STARTTIME(yyyy/mm/dd[,hh:mm:ss]) ~ <<1900/01/01,00:00:00>> <<if
hh:mm:ss is omitted, 00:00:00>>
Use the local time to specify the start date and time of the log data to be
output.
ENDTIME(yyyy/mm/dd[,hh:mm:ss]) ~ <<2042/09/17,23:53:47>> <<if
hh:mm:ss is omitted, 23:59:59>>
Use the local time to specify the end date and time of the log data to be
output.
The RANGE control statement can be specified only once at the beginning of
the first control statement line.

Format of the SELECT control statement


SELECT

9-14

1COND(JOBNAME,EQ,value)

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

SELECT control statement operands


COND(JOBNAME,EQ,value) ~ <string of 8 or fewer characters>
Specify the job name as a condition of the log data to be output from the
log stream to a dataset. Enclose the specified value in quotation marks
(').
You can specify a maximum of 100 lines of SELECT control statements. If
multiple lines are specified, all log data that matches the control statements
will be output from the log stream to a dataset.

Coding of the RANGE and SELECT control statements

A line beginning with an asterisk (*) is treated as a comment line.

Columns after the 73rd column in a control statement line are ignored.

Each control statement must be completely specified on one line. A


control statement cannot extend over two or more lines.

Control statement examples


To output the log data with acquisition dates in the range from 2013/03/24
00:00 to 2013/03/24 23:59, specify as follows.
RANGE STARTTIME(2013/03/24,00:00:00) ENDTIME(2013/03/24,23:59:59)
To output the log data with acquisition dates in the range from 2013/03/24
00:00 to 2013/03/24 23:59 and with the job names USER01T or USER01,
specify as follows.
RANGE STARTTIME(2013/03/24,00:00:00) ENDTIME(2013/03/24,23:59:59)
SELECT COND(JOBNAME,EQ,'USER01T')
SELECT COND(JOBNAME,EQ,'USER01')

Output format of the event log data output tool


The following table shows the output format of the event log data output tool.

Table 9-5 Output format of the event log data output tool
Offset

Lengt
h

Output contents

Description

+X'00'

Output data length

Output data length = 32 + log data length (n)

+X'02'

Reserved

'0000'X

+X'04'

Division flag 1

For the first record: '01'X


For records other than the first record: '00'X

+X'05'

Division flag 2

For the last record: '01'X


For records other than the last record: '00'X

+X'06'

GMT time-stamp (TOD


format)

The time-stamp specified by the system logger


service when the log data is output

+X'0E'

Local time-stamp (TOD


format)

The time-stamp specified by the system logger


service when the log data is output

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-15

Offset

Lengt
h

Output contents

Description

+X'16'

10

Reserved

'00 ... 00'X

+X'20'

Log data

--

Collecting event logs without using the system logger


service
If the system logger service is not used, log data is output to a Tiered
Storage Manager for Mainframe log dataset.

Allocating log datasets without using the system logger service


Allocate two sequential datasets (log datasets) to each job to collect logs.

Procedure
1.

Estimate the log dataset capacity.


Estimate the amount of log data based on the frequency at which CLI
commands are issued and the frequency of errors. Allocate enough space
to ensure that log data can be output until a backup of the log dataset is
created in one sequential dataset.

2.

Create log datasets.


For the log dataset, specify the amount of the initial allocation only. The
specification of any additional allocation is ignored.
The following shows the format of the log dataset.

RECFM: VB

LRECL: 8196

BLKSIZE: 8200
The following shows an example of creating log datasets in TSO/E.

ALLOC DS('USER01.YKLOG01') VOL(WKVL01) NEW SP(100) CYL DSORG(PS)


RECFM(V,B) LRECL(8196) BLKSIZE(8200)
ALLOC DS('USER01.YKLOG02') VOL(WKVL01) NEW SP(100) CYL DSORG(PS)
RECFM(V,B) LRECL(8196) BLKSIZE(8200)

3.

Allocate the log datasets.

For TSO/E, use the ALLOC command to allocate DD name YKLOG01 and
DD name YKLOG02 to log datasets.
When using JCL, specify DD statement YKLOG01 and DD statement
YKLOG02 in the JCL.

The following shows a specification example in TSO/E.


ALLOC DD(YKLOG01) DS('USER01.YKLOG01') OLD
ALLOC DD(YKLOG02) DS('USER01.YKLOG02') OLD

9-16

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

The following shows a JCL specification example.


//YKLOG01 DD DSN='USER01.YKLOG01',DISP=OLD,VOL=SER=WKVL01,UNIT=DASD
//YKLOG02 DD DSN='USER01.YKLOG02',DISP=OLD,VOL=SER=WKVL01,UNIT=DASD

Allocate a log dataset for each job. When the job terminates, another job can
reuse that log dataset. In this case, logs are added to the end of the previous
log output.
Note, however, that you need to reallocate a new log dataset rather than
using the existing one in the following cases:

An I/O error occurred in the log dataset.

The OS went down.

Related topics

Disk space requirements for the event log when the system logger service
is not used on page 9-18

Writing to a log dataset without using the system logger service


This subsection describes how to write data to a log dataset without using the
system logger service. How the data is written depends on the number of
allocated log datasets.

When both YKLOG01 and YKLOG02 are specified


1.

Logs are written to YKLOG01. If the log dataset is reused, logs are added
to the end of the previous log output.

2.

If YKLOG01 is full, logs are written to YKLOG02.

3.

If YKLOG02 is also full, logs are written to YKLOG01. In this case, the
existing logs in YKLOG01 are overwritten.

4.

Steps 2 and 3 are repeated.

If a log dataset is full and the log output destination is switched, the KTG291I
message (the log dataset is full) and the KTG292I message (the log dataset is
switched) are output to the console. At this time, the KTG291I message
indicates the name of the log dataset that became full. The KTG292I message
indicates the job name and the DD names of log datasets before and after
switching (YKLOG01 or YKLOG02).
Tip: When a log dataset becomes full (KTG291I and KTG292I messages are
output), you can suspend execution of the script and back up the log dataset
indicated in the KTG291I message. However, the log dataset cannot be
backed up if the KTG292I message indicates the same log dataset before and
after switching. This is because an error might have occurred in either log
dataset and the log dataset before switching has been overwritten.

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-17

If neither YKLOG01 nor YKLOG02 is specified


The KTG261E message is output and processing continues without acquiring
logs. To acquire logs, you need to log on to TSO/E again and then specify the
YKLOG01 and YKLOG02 DD statements.

If either YKLOG01 or YKLOG02 is specified


The KTG261E message is output and logs are output only to the log dataset
for which the DD statement is specified. In this case, if the log dataset
becomes full, it will be overwritten from the beginning.

If an I/O error occurs in YKLOG01 or YKLOG02


The messages from KTG262E to KTG264E are output, and logs will be output
only to the log dataset in which an I/O error has not occurred. If the log
dataset becomes full, it will be overwritten from the beginning. If an I/O error
occurs in both log datasets, processing continues without acquiring logs.
Tip: You cannot view log datasets during execution of a CLI command. Wait
until the executing script terminates and then view the log dataset.

Disk space requirements for the event log when the system logger
service is not used
The following table shows the amount of log data when the event log is
output without using the system logger service.

Table 9-6 Amount of event log data when the system logger service is not
used

Messages (excluding messages output


from the ISPF panel and scripts)

Number per
command

Size#1

Types of event log data

100 + message
length#2

Number of output
messages

Only in the case of an I/O error,


100 + CCW length#2
parameter information for the CCW for
that I/O

Number of I/O errors

Only in the case of an I/O error, return 256


information for that I/O

Number of I/O errors

Only in the case of an I/O error, sense


byte information for that I/O

256

Number of I/O errors

Time-stamps

128

Command parameter information

256

#1
The size is rounded up to a multiple of 32 before being output.
#2

9-18

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

The maximum length is 256 bytes.

Collecting ISPF logs


When a CLI command is executed in the ISPF panel, ISPF log data is
automatically collected to an ISPF log dataset.

Checking ISPF logs


Check the ISPF log showing the operation history for the ISPF panel.

Procedure
1.

In the ISPF Primary Option Menu panel, select 7 (Dialog Test).


The Primary Option panel appears.

2.

Select 5 (Log).
The Browse log panel appears, displaying the contents of the ISPF log.

Preventing the ISPF log dataset from becoming full


If you use the ISPF panel for CLI command operations for a long time, the
ISPF log dataset might become full. This could cause a CLI command to
terminate abnormally. To prevent such a problem, perform the following if
you want to use the ISPF panel for a long time for CLI command operations.

Procedure
1.

When you start using ISPF, delete the ISPF log information from the ISPF
log dataset.

2.

When you perform an operation in the Tiered Storage Manager for


Mainframe panel, enter LOG in the Command line.
The Specify Disposition of Log Data Set panel appears.

3.

Select 3 (Keep existing data set and continue with new data set ).
The ISPF log dataset is switched to another dataset.

You must periodically switch the ISPF log dataset to another dataset to
prevent the ISPF log dataset from becoming full.
Tip: If the CLI command terminated abnormally because the ISPF log dataset
was full, in the ISPF end menu ( Specify Disposition of Log Data Set
panel), select 4 (Keep data set - New (allocate new data set in next session))
to save the current ISPF log dataset, and then allocate another dataset.

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-19

Collecting the CLI command-execution log


You can use the environment variable SYSLOG to specify the commandexecution log (that is, the command name, parameters, and execution
results) to be output to either SYSLOG or the console.
The execution log for the following CLI commands is output. If you specify
that the log is to be output to SYSLOG, the KTC310I and KTC311I message
containing the log is output. If you specify that the log is to be output to the
console, the KTC910I and KTC911I message containing the log is output.
KTACTTPG, KTCONMSG, KTDCTDEV, KTDCTTPG, KTGETHDA, KTIMPORT, KTLOAD,
KTQRYDEV, KTQRYRLC, KTQRYTPG, KTQSTATS, KTSCAN, KTSTORE, KTCONMSG
The log for the KTCONMSG command will be output only when OPEN or CLOSE is
specified in the OP parameter.
There are two methods for extracting output CLI command-execution logs:

Use an ISPF editor.

Use an output script.

Related topics

Setting the operating environment by using environment variables on


page 2-19

Setting the operating environment by using system symbols on page 2-21

Extracting CLI command-execution logs by using an ISPF editor on page


9-20

Extracting CLI command-execution logs by using an extraction script on


page 9-21

Extracting CLI command-execution logs by using an ISPF editor


To use an ISPF editor to extract CLI command-execution logs from SYSLOG
to a sequential dataset:

Procedure
1.

Create a dataset to which log data will be extracted from SYSLOG.


YUKON.KTLOG is assumed as the name of the allocated sequential dataset.

2.

Display SYSLOG in the SDSF panel.

3.

In the panel showing SYSLOG, enter the SDSF command to extract


SYSLOG data for the desired period to the dataset you created in step 1.
To extract information from 13:00 to 14:00, enter as follows.
PRINT ODSN 'YUKON.KTLOG'
PRINT 13:00:00 14:00:00
PRINT CLOSE

9-20

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

4.

Use the ISPF editor to display a panel for editing the dataset created in
step 3.

5.

In the ISPF editor panel, enter the following command to delete the lines
other than the CLI command-execution logs.
If the CLI command-execution logs are specified to be output to SYSLOG
(SYSLOG=YES):
exclude p'KTC31#I' all
delete all nx
reset
save

If the CLI command-execution logs are specified to be output to the


console (SYSLOG=CONSOLE):
exclude p'KTC91#I' all
delete all nx
reset
save

Caution: If the KTC910I message extends to two lines, the second line is
not extracted.
6.

Terminate the ISPF editor.

Extracting CLI command-execution logs by using an extraction script


You can extract CLI command-execution logs to a sequential dataset by using
an extraction script.

Procedure
1.

Create a dataset to which SYSLOG data will be extracted.


YUKON.SYSLOG is assumed as the name of the allocated sequential
dataset.

2.

Create a dataset to which only CLI command-execution logs will be


extracted.
YUKON.KTLOG is assumed as the name of the allocated sequential dataset.

3.

Display SYSLOG in the SDSF panel.

4.

In the panel showing SYSLOG, enter the SDSF command to extract


SYSLOG data for the desired period to the dataset you created in step 1.
To extract the information from 13:00 to 14:00, enter as follows.
PRINT ODSN 'YUKON.SYSLOG'
PRINT 13:00:00 14:00:00
PRINT CLOSE

5.

Execute the CLI command-execution log output procedure to extract the


CLI command-execution log to the dataset you created in step 2.
If the procedure is stored in the sequential dataset YUKON.EXTCMD,
execute as follows.

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

9-21

If the CLI command-execution logs are specified to be output to SYSLOG


(SYSLOG=YES):
EXEC 'YUKON.EXTCMD' 'KTC31 YUKON.SYSLOG YUKON.KTLOG'
If the CLI command-execution logs are specified to be output to the
console (SYSLOG=CONSOLE):
EXEC 'YUKON.EXTCMD' 'KTC91 YUKON.SYSLOG YUKON.KTLOG'
Example of a CLI command-execution log output procedure
/* REXX ***/
Parse Upper Arg Mystrg Myinds Myoutds;
"ALLOCATE DA('"Myinds"') F(INDD) SHR REUSE"
"ALLOCATE DA('"Myoutds"') F(OUTDD) OLD REUSE"
"EXECIO 0 DISKR INDD (OPEN)"
eof='NO'
DO WHILE eof = 'NO'
"EXECIO 1 DISKR INDD (STEM LINE.)"
IF RC = 2 THEN
eof='YES'
ELSE
DO
IF INDEX(LINE.1,Mystrg) <> 0 THEN
DO
"EXECIO 1 DISKW OUTDD (STEM LINE.)"
END
END
END
"EXECIO 0 DISKR INDD (FINIS)"
"EXECIO 0 DISKW OUTDD (FINIS)"
"FREE F(INDD)"
"FREE F(OUTDD)"
EXIT 0

Caution: If the KTC910I message extends to two lines, the second line is not
extracted.
Caution: Care must be taken when executing many CLI commands because
output to SYSLOG increases.

9-22

Collecting trace information and logs


Hitachi Tiered Storage Manager for Mainframe User Guide

A
XML document type definitions for
configuration files
This appendix describes the XML document type definitions for configuration
files used by Tiered Storage Manager for Mainframe.
Elements common to configuration files
Elements in the disk configuration definition file
Elements in the tiering policy group definition file
Example of files used by Tiered Storage Manager for Mainframe

XML document type definitions for configuration files


Hitachi Tiered Storage Manager for Mainframe User Guide

A-1

Elements common to configuration files


The following describes the elements common to all types of configuration
files.
Note that element names, attribute names, and attribute values are case
sensitive.

APIInfo element
The APIInfo element contains information about the configuration file.

Structure
<!ELEMENT APIInfo(ANY)>
<!ATTLIST APIInfo
Level
(7.5.0)#REQUIRED
UpdateID CDATA#IMPLIED
>

The following lists and describes the attributes of this element.


Attribute name

Description

Level

A character string that indicates the API level (XML interface


version of Tiered Storage Manager for Mainframe) is set.

UpdateID

Last update ID

DiskDevice element
Information about the volumes of the storage system is stored in the
DiskDevice element.

Structure
<!ELEMENT DiskDevice(EMPTY)>
<!ATTLIST DiskDevice
SerialNum CDATA#REQUIRED
CUNum
CDATA#REQUIRED
SSID
CDATA#REQUIRED
CCA
CDATA#REQUIRED
POOLID
CDATA#IMPLIED
Cyls
CDATA#IMPLIED
External
(Y|N)#IMPLIED
>

The following lists and describes the attributes of this element.


Attribute name

A-2

Description

SerialNum

Serial number of the storage system

CUNum

Control unit (CU) number

SSID

Storage system ID (SSID)

XML document type definitions for configuration files


Hitachi Tiered Storage Manager for Mainframe User Guide

Attribute name

Description

CCA

Command control address (CCA)

POOLID

Pool ID

Cyls

Volume capacity

External

External volume information

Elements in the disk configuration definition file


The following describes the elements in the disk configuration definition file.

HostDiscoveredArray element
Information about the storage system is stored in the HostDiscoveredArray
element.

Structure
<!ELEMENT HostDiscoveredArray(SoftwareKeys, POOL*,
HostAddressedDisk*)>
<!ATTLIST HostDiscoveredArray
Description
CDATA#REQUIRED
DADID
ID#REQUIRED
NGDADIDEnable
(0|1)#IMPLIED
SerialNum
CDATA#REQUIRED
Model
(7700E|9900|9900V|USP|USPV|VSP)#REQUIRED
Microcode
CDATA#REQUIRED
IFType
CDATA#REQUIRED
PhysicalSerialNum CDATA#IMPLIED
>

The following lists and describes the attributes of this element.


Attribute name

Description

Description

Used by the system.

DADID

Used by the system.

NGDADIDEnable

Used by the system.

SerialNum

Serial number of the scanned storage system

Model

Model of the storage system

Microcode

Microcode number

IFType

Interface version

PhysicalSerialNum

Physical DKC (disk controller) serial number of the storage system

SoftwareKeys element
The SoftwareKeys element is used by the system.

XML document type definitions for configuration files


Hitachi Tiered Storage Manager for Mainframe User Guide

A-3

Structure
<!ELEMENT SoftwareKeys(EMPTY)>
<!ATTLIST SoftwareKeys
TC
(0|1)#REQUIRED
SI
(0|1)#REQUIRED
TCA (0|1)#REQUIRED
UR
(0|1)#REQUIRED
>

POOL element
Information about pools is stored in the POOL element.

Structure
<!ELEMENT POOL(PoolTier*)>
<!ATTLIST POOL
POOLID
CDATA#REQUIRED
NAME
CDATA#IMPLIED
Type
CDATA#REQUIRED
PageSize CDATA#IMPLIED
>

The following lists and describes the attributes of this element.


Attribute name

Description

POOLID

Pool ID

NAME

Pool name

Type

Pool type information:


DT: Dynamic Tiering for Mainframe pool
DP: Dynamic Provisioning for Mainframe pool
OTHER: Other pools

PageSize

Page size

PoolTier element
Information about tiers is stored in the PoolTier element.

Structure
<!ELEMENT PoolTier(ENPTY)>
<!ATTLIST PoolTier
Tier
CDATA#REQUIRED
Media CDATA#IMPLIED
>

The following lists and describes the attributes of this element.


Attribute name
Tier

A-4

Description
Tier number

XML document type definitions for configuration files


Hitachi Tiered Storage Manager for Mainframe User Guide

Attribute name

Description
Attribute of the media that constitutes the pool

Media

The numerical values (hexadecimal) have the following meanings:

0000: SSD (solid state drive) or Native Flash (NF)

0001: SAS 15K RPM (SAS 15K)

0002: SAS 10K RPM (SAS 10K)

0003: SATA 7.2K RPM (SATA 7.2K)

0004: External media (Mid) (EXTERNAL M)

0005: SAS 7.2K RPM (SAS 7.2K)

0006: Mixed

0007: External media (High) (EXTERNAL H)

0008: External media (Low) (EXTERNAL L)

HostAddressedDisk element
Information about the volumes managed by the host is stored in the
HostAddressedDisk element.

Structure
<!ELEMENT HostAddressedDisk(DiskDevice)>
<!ATTLIST HostAddressedDisk
Devn
CDATA#IMPLIED
Volser
CDATA#IMPLIED
STORGRP CDATA#IMPLIED
>

The following lists and describes the attributes of this element.


Attribute name

Description

Devn

Device number

Volser

Volume serial number

STORGRP

Name of the SMS storage group that the volume belongs to

Elements in the tiering policy group definition file


The following describes the elements in the tiering policy group definition file.

TieringPolicyGroup element
Information about tiering policy groups is stored in the TieringPolicyGroup
element.

XML document type definitions for configuration files


Hitachi Tiered Storage Manager for Mainframe User Guide

A-5

Structure
<!ELEMENT TieringPolicyGroup(TieringPolicy*)>
<!ATTLIST TieringPolicyGroup
ID CDATA#REQUIRED
>

The following lists and describes the attributes of this element.


Attribute name

Description
Tiering policy group name

ID

TieringPolicy element
Information about tiering policies is stored in the TieringPolicy element.

Structure
<!ELEMENT TieringPolicy (DiskDevice *)>
<!ATTLIST TieringPolicy
Level
(0|1|2|3|4|5)#IMPLIED
Entry
(HIGH|MIDDLE|LOW)#IMPLIED
TierRelocation (Y|N)#IMPLIED
>

The following lists and describes the attributes of this element.


Attribute name

Description

Level

Tiering policy level

Entry

New-page assignment tier

TierRelocation

HIGH: The new page is assigned from the higher tier of tiers
set in the tiering policy.

MIDDLE: The new page is assigned from the middle tier of


tiers set in the tiering policy.

LOW: The new page is assigned from the lower tier of tiers set
in the tiering policy.

Tier relocation

Y: Executes tier relocation for the volume.

N: Does not execute tier relocation for the volume.

Example of files used by Tiered Storage Manager for


Mainframe
The following figure shows a configuration example of files used by Tiered
Storage Manager for Mainframe.

A-6

XML document type definitions for configuration files


Hitachi Tiered Storage Manager for Mainframe User Guide

Figure A-1 Configuration example of files used by Tiered Storage Manager


for Mainframe

Example of the specifications in a tiering policy information CSV file


#TYPE ,DEVICE,TPGID,TierLvl,Entry,Reloc
STORGRP,SG1
,TPG1 ,2
DEVN
,1101 ,TPG1 ,1
STORGRP,SG2
,TPG1 ,5

Example of a disk configuration definition file that is generated


<?xml version="1.0" encoding="ebcdic-cp-us"?>
<APIInfo Level="7.5.0">
<HostDiscoveredArray SerialNum="14001" Model="VSP"
Microcode="700000FF" IFType="3131" PhysicalSerialNum="14002">
<POOL POOLID="1" NAME="POOL1" Type="DT" PageSize="672">
<PoolTier Tier="1" Media ="0000" />
<PoolTier Tier="2" Media ="0001" />
<PoolTier Tier="3" Media ="0004" />
</POOL>
<POOL POOLID="2" NAME="POOL2" Type="DT" PageSize="672">
<PoolTier Tier="1" Media ="0000" />
<PoolTier Tier="2" Media ="0001" />
<PoolTier Tier="3" Media ="0005" />
</POOL>
<HostAddressedDisk Devn="1101" Volser="VOL010" STORGRP="SG1" >
<DiskDevice SerialNum="14001" CUNum="01" SSID="2340" CCA="12"
POOLID="1" />

XML document type definitions for configuration files


Hitachi Tiered Storage Manager for Mainframe User Guide

A-7

</HostAddressedDisk>
<HostAddressedDisk Devn="1201" Volser="VOL011" STORGRP="SG1">
<DiskDevice SerialNum="14001" CUNum="01" SSID="2340" CCA="01"
POOLID="1" />
</HostAddressedDisk>
<HostAddressedDisk Devn="1202" Volser="VOL012" STORGRP="SG1">
<DiskDevice SerialNum="14001" CUNum="01" SSID="2340" CCA="02"
POOLID="1" />
</HostAddressedDisk>
<HostAddressedDisk Devn="2501" Volser="VOL021" STORGRP="SG2">
<DiskDevice SerialNum="14001" CUNum="02" SSID="2340" CCA="01"
POOLID="2" />
</HostAddressedDisk>
<HostAddressedDisk Devn="2502" Volser="VOL022" STORGRP="SG2">
<DiskDevice SerialNum="14001" CUNum="02" SSID="2340" CCA="02"
POOLID="2" />
</HostAddressedDisk>
</HostDiscoveredArray>
</APIInfo>

Example of a tiering policy group definition file that is generated


<?xml version="1.0" encoding="ebcdic-cp-us"?>
<APIInfo Level="7.5.0">
<TieringPolicyGroup ID="TPG1" >
<TieringPolicy Level="1" Entry="MIDDLE" TierRelocation="Y">
<DiskDevice SerialNum="14001" CUNum="01" SSID="2340" CCA="12"
</TieringPolicy>
<TieringPolicy Level="2" Entry="HIGH" TierRelocation="Y">
<DiskDevice SerialNum="14001" CUNum="01" SSID="2340" CCA="01"
<DiskDevice SerialNum="14001" CUNum="01" SSID="2340" CCA="02"
</TieringPolicy>
<TieringPolicy Level="5" Entry="MIDDLE" TierRelocation="Y">
<DiskDevice SerialNum="14001" CUNum="02" SSID="2340" CCA="01"
<DiskDevice SerialNum="14001" CUNum="02" SSID="2340" CCA="02"
</TieringPolicy>
</TieringPolicyGroup>
</APIInfo>

A-8

XML document type definitions for configuration files


Hitachi Tiered Storage Manager for Mainframe User Guide

/>
/>
/>
/>
/>

B
Commands that can be used in the ISPF
panels
This appendix describes the commands that can be used in the ISPF panels of
Tiered Storage Manager for Mainframe.
ERRCODE
FILTER
FIND
LOCATE
RFIND
SELECT
SORT
How to specify the search or filter conditions in ISPF panels

Commands that can be used in the ISPF panels


Hitachi Tiered Storage Manager for Mainframe User Guide

B-1

ERRCODE
Function
Displays the Error Code Help panel that shows error code details.

Syntax
ERRCODE

Related topics

Error Code Help panel on page 5-14

FILTER
Function
Filters a list according to the specified condition.

Syntax
FILTER[{field-name Filter-condition|RESET}]

The abbreviation of FILTER is FIL.

Parameters
If you omit the parameters, the Filter Options panel appears to allow you to
enter parameter values.
field-name
Specifies the name of the field for which the filter condition is specified.
Filter-condition
Specifies the condition character string.
RESET
Cancels the filter.
Tip: The filtered results will be sorted in ascending order.

Specification examples

Character string specification


Specify as follows to filter the list by the SMS storage group named
STORGRP1.
FIL STORGRP STORGRP1

B-2

Commands that can be used in the ISPF panels


Hitachi Tiered Storage Manager for Mainframe User Guide

Generic name specification


Specify as follows to filter the list by volumes having a volume serial
number beginning with V#704.
FIL Volser V#704*

Range specification
Specify as follows to filter the list by volumes having device numbers from
703B to 7050.
FIL Devn 703B:7050

Related topics

How to specify the search or filter conditions in ISPF panels on page


B-6

FIND
Function
Searches for a specified character string.

Syntax
FIND[ search-string]

The abbreviation of FIND is F.

Parameters
If you omit the parameter, the Find Options panel appears to allow you to
enter parameter values.
search-string
Specifies the search string.

Related topics

How to specify the search or filter conditions in ISPF panels on page


B-6

LOCATE
Function
Searches for the specified character string for a sorted field, and positions the
cursor at the line that matches the specified condition. If the specified

Commands that can be used in the ISPF panels


Hitachi Tiered Storage Manager for Mainframe User Guide

B-3

character string is not found, the cursor is positioned at the line that has the
value nearest to the specified condition.

Syntax
LOCATE[ locate-string]

The abbreviation of LOCATE is L.

Parameters
If you omit the parameter, the Locate Options panelappears to allow you to
enter parameter values.
locate-string
Specifies the condition character string.

Related topics

How to specify the search or filter conditions in ISPF panels on page


B-6

RFIND
Function
Conducts a search again for the character string specified for the FIND
command that was executed immediately before.

Syntax
RFIND

The abbreviation of RFIND is RF.


Tip: If the FIND command has not been executed, the Find Options panel
appears.

SELECT
Function
Sets or cancels an action in the AC field of a line that satisfies the specified
condition.

Syntax
SELECT[ field-name Select-condition[ {action|RESET}]]

The abbreviation of SELECT is SEL.

B-4

Commands that can be used in the ISPF panels


Hitachi Tiered Storage Manager for Mainframe User Guide

Parameters
If you omit the parameters, the Select Options panel appears to allow you
to enter parameter values.
field-name
Specifies the name of the field for which the condition is specified.
Select-condition
Specifies the condition character string.
action
Specifies the action to be set in the AC field. If you do not specify any
action, a slash (/) will be set in the AC field. If the panel has only one
action, that action will be set.
RESET
Cancels the action set in the AC field.

Specification examples

Character string specification


Specify as follows to set V (displaying the Volume Status Detail panel)
in the AC fields for the volumes that belong to the pool with pool ID 120.
SEL PooLID 120 V

Generic name specification


Specify as follows to set D (changing the tiering policy to the default) in
the AC fields for the volumes having a volume serial number beginning
with VOL.
SEL Volser VOL* D

Range specification
Specify as follows to cancel the actions set in the AC fields for the
volumes having device numbers from 0F10 to 0F15.
SEL Devn 0F10:0F15 RESET

Related topics

How to specify the search or filter conditions in ISPF panels on page


B-6

SORT
Function
Sorts information in a displayed list.

Commands that can be used in the ISPF panels


Hitachi Tiered Storage Manager for Mainframe User Guide

B-5

Syntax
SORT[ field-name [{A|D}]]

The abbreviation of SORT is SO.

Parameters
If you omit the parameters, the Sort Options panelappears to allow you to
enter parameter values.
field-name
Specifies the field name as a sort key.
{A|D}
Specifies the sort order.

A: Ascending order

D: Descending order

If you omit this parameter, items in the list will be sorted in ascending
order. If they have already been sorted in ascending order, they will be
sorted in descending order.
Tip: If the list has the PoolID and SN headers and you specify PoolID for
field-name, the information will be sorted by using multiple columns, SN and
PoolID. If the list has the CU and CCA headers and you specify CCA for
field-name, the information will be sorted by using multiple columns, CU and
CCA.
Tip: If you execute the SORT command when the list is filtered, the unfiltered
information is sorted.

How to specify the search or filter conditions in ISPF panels


The following describes how to specify conditions for searching for a line or
filtering in the ISPF panel.
You can specify one of the following ways to specify the search or filter
condition:

Character string specification

Generic name specification


Use the following syntax:

character-string*: Targets all values beginning with character-string.

*: Targets all lines.

Range specification
Use one of the following syntaxes:

B-6

minimum-value:maximum-value
Targets values in the range from minimum-value to maximum-value.

Commands that can be used in the ISPF panels


Hitachi Tiered Storage Manager for Mainframe User Guide

minimum-value:
Targets values that are equal to or greater than minimum-value.
:maximum-value
Targets values that are less than or equal to maximum-value.

Note:

Entries are case-sensitive. However, entries are not case-sensitive in the


Find Options panel (FIND command).

If you want to specify an asterisk as a character (not as a marker for a


generic character) at the end of the character string, specify two asterisks
together (**).

The following table lists the panels (commands) and the specification
methods that can be used.

Panel name (command


name)

Filter Options panel


(FILTER command#)

Select Options panel


(SELECT command#)

Find Options panel (FIND


command#)

Locate Options panel


(LOCATE command#)

Select Pool List panel

Select Storage Group


List panel

Select Volume List panel

Generic name
specification

Character
string
specification

characterstring *

Range specification
*

Yes

Yes

Yes

Yes

Yes

--

--

--

Yes

Yes

--

--

Legend:
Yes: Can be specified
--: Cannot be specified
#
If you want to specify a string in the command line, specify it as follows:

To specify a string that contains non-alphanumeric characters, enclose


the entire string in apostrophes (').
To specify a string that contains an apostrophe, specify two
apostrophes in succession ('').

Commands that can be used in the ISPF panels


Hitachi Tiered Storage Manager for Mainframe User Guide

B-7

B-8

Commands that can be used in the ISPF panels


Hitachi Tiered Storage Manager for Mainframe User Guide

C
Sample scripts
This appendix provides sample scripts for Tiered Storage Manager for
Mainframe.
List of sample scripts
Details about sample scripts

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-1

List of sample scripts


Sample scripts for each CLI command are stored in the sample library. The
following table provides an overview of each sample script.

Table C-1 Overview of sample scripts


Sample
script name

Purpose

Command to
be executed

DD name specification or
parameter

Create a disk
configuration
definition file.

KTSCAN

Display the
contents of
the disk
configuration
definition file.

KTGETHDA

Create a
tiering policy
group
definition file.

KTIMPORT

Display the
contents of
the tiering
policy group
definition file.

KTLOAD

Display the
volume
information.

KTQRYDEV

KTDEMO05

Change the
tiering policy
of a volume
back to the
default.

KTDCTDEV

DEVN(device-number)

--

KTDEMO10

Apply the
tiering policy.

KTLOAD

PREFIX(prefix)

--

KTACTTPG

TPG(tiering-policy-groupID)

Check the
tiering policy.

KTLOAD

PREFIX(prefix)

KTQRYTPG

TPG(tiering-policy-groupID)

Check the
page
relocation
status of
volumes.

KTLOAD

PREFIX(prefix)

KTQRYTPG

TPG(tiering-policy-groupID)

Check the
relocation
progress.

KTLOAD

PREFIX(prefix)

KTQRYTPG

TPG(tiering-policy-groupID)

KTDEMO00

KTDEMO01

KTDEMO02

KTDEMO03

KTDEMO04

KTDEMO11

KTDEMO12

KTDEMO13

C-2

KTSTORE

DD name: KTINDD scan range


list#1

Relevant REXX
variable structure
--

PREFIX(prefix)
DD name: KTDSKDD diskconfiguration-definition-file

Host-discovered array
index structure
Host-discovered array
structure

PREFIX(prefix)

--

POLICY(policy-ID)

DD name: KTTPGDD tieringpolicy-group-definition-file

Host-discovered array
structure
Tiering policy group
structure

DEVN(device-number)

Host-discovered array
structure
Device information
structure

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

Host-discovered array
structure
Tiering policy group
structure
Host-discovered array
structure
Tiering policy group
structure
Host-discovered array
index structure

Sample
script name

Purpose

Command to
be executed

DD name specification or
parameter

Relevant REXX
variable structure
Host-discovered array
structure

KTQRYRLC

Tiering policy group


structure
KTDEMO14

Check I/O
performance
information.

KTLOAD

PREFIX(prefix)

KTQSTATS

TPG(tiering-policy-groupID)
INTERVAL(displayinterval)#2

Host-discovered array
structure
Tiering policy group
structure

#1
Specify the values of the FROM and TO parameters, the FROMVSN and TOVSN
parameters, or the STORGRP parameter of the KTSCAN command for scan
range list. The following shows an example of a record:
DEVN 0000 00FF
VOLSER VOL001 VOL009
STORGRP GRPNAME
#2
Processing is performed repeatedly at the intervals (seconds) specified for
INTERVAL until the processing is canceled.

Details about sample scripts


Details about the sample scripts are provided below.

KTDEMO00 (Create a disk configuration definition file)


/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO00 - A sample demonstration script that
*/
/*
generates DSK configuration dataset.
*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTSCAN
*/
/*
- KTSTORE
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) Dataset which is allocated by ddname KTINDD has records
*/
/*
of scan range list of volume or sms storage group.
*/
/*
Record examples are:
*/
/*
DEVN
0000
00FF
*/
/*
VOLSER VOL001 VOL009
*/
/*
STORGRP GRPNAME
*/
/*
2) The definition files are stored in the dataset with the
*/
/*
prefix specified in PREFIX() option value
*/

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-3

/*
in the script's argument.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO00.";
/*
* Parse argument specified in the EXEC command
*/
PARSE UPPER ARG
@options
PARSE UPPER VALUE @options 'PREFIX()'
with 'PREFIX('opt_prefix')';
/* Check option values. */
IF opt_prefix = '' THEN DO
SAY "Please specify PREFIX() value in the argument.";
EXIT 8;
END;
/*
* Read all records from DD(KTINDD) dataset.
*/
ADDRESS TSO "EXECIO * DISKR KTINDD (FINIS STEM scan_range.";
IF RC /= 0 THEN DO
SAY 'Dataset(KTINDD) read error occurred. rc='RC;
EXIT 8;
END;
/*
* Parse each record of DD(KTINDD) dataset.
*/
ScannedVolumeIsFound='N';
ScanFailed='N';
DO i=1 to scan_range.0;
/*
* Parse scan range list record.
*/
recordStr = SUBSTR(scan_range.i,1,72);
PARSE VAR recordStr scan_type scan_from scan_to .
/*
* Scan volumes by DEVN or VOLSER or STORGRP range,
* and add volume information
* to REXX variables of the STEM() operand specified.
*/
IF scan_type='DEVN' THEN DO
SAY 'Executing KTSCAN DEVN= 'scan_from' - 'scan_to;
CALL KTSCAN "STEM(DEMO_STEM.) MSG(DEMO_MSG.) ARRAYS(DEMO_SCAN.)",
" FROM("scan_from") TO("scan_to")";
END;
ELSE IF scan_type='VOLSER' THEN DO
SAY 'Executing KTSCAN VOLSER= 'scan_from' - 'scan_to;
CALL KTSCAN "STEM(DEMO_STEM.) MSG(DEMO_MSG.) ARRAYS(DEMO_SCAN.)",
" FROMVSN("scan_from") TOVSN("scan_to")";
END;
ELSE IF scan_type='STORGRP' THEN DO
SAY 'Executing KTSCAN STORGRP= 'scan_from;
CALL KTSCAN "STEM(DEMO_STEM.) MSG(DEMO_MSG.) ARRAYS(DEMO_SCAN.)",
" STORGRP("scan_from")";
END;
ELSE DO
SAY 'Ignore KTINDD LINE='recordStr
ITERATE;
END;
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT > 8 THEN
ScanFailed='Y';
ELSE IF RESULT < 8 THEN

C-4

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

ScannedVolumeIsFound='Y';
IF RESULT > 0 THEN
CALL printErrorMessage "KTSCAN" RESULT;
END;
IF ScanFailed='Y' THEN DO
SAY 'KTSCAN error occurred.';
EXIT 8;
END;
IF ScannedVolumeIsFound /='Y' THEN DO
SAY 'Scanned volume is nothing.';
EXIT 4;
END;
/*
* Store scanned volumes information to the DSK configuration dataset.
*
*/
CALL KTSTORE "STEM(DEMO_STEM.) MSG(DEMO_MSG.) ARRAYS(DEMO_SCAN.)",
" PREFIX("opt_prefix") DSK";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTSTORE" RESULT;
EXIT 8;
END;
SAY "#-- END KTDEMO00." /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;

KTDEMO01 (Display the contents of the disk configuration definition


file)
/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO01 - A sample demonstration script that
*/
/*
displays information in the DSK configuration dataset. */
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTGETHDA
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) DSK configuration dataset is already created.
*/
/*
2) DSK configuration dataset is allocated to ddname KTDSKDD.
*/

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-5

/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO01.";
/*
* Get dataset name of ddname KTDSKDD.
*/
fc = LISTDSI("KTDSKDD" "FILE");
IF fc > 4 THEN DO
SAY 'DD(KTDSKDD) is not allocated or invalid.';
EXIT 8;
END;
/*
* Get prefix and serialNum from dataset name.
*/
PARSE VAR sysdsname val_prefix'.DSK.SN'val_SN'.'val_dadid;
/*
* Read DSK configuration file and set pool/volume information
* to REXX variables.
*/
CALL KTGETHDA "STEM(DEMO_STEM.) MSG(DEMO_MSG.)",
" PREFIX("val_prefix") SN("val_SN")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTGETHDA" RESULT;
EXIT 8;
END;
/*
* Display values in the DSK configuration file.
*/
DO k=1 to HCC.HDAKT.0;
val_SN = HCC.HDAKT.k.SerialNum;
sym_SN = 'SN'||val_SN;
/* Display storage system information. */
SAY '';
SAY 'DKC';
SAY ' SN:'
||DEMO_STEM.LOCAL.sym_SN.SerialNum||,
',Model:'
||DEMO_STEM.LOCAL.sym_SN.Model||,
',Microcode:' ||DEMO_STEM.LOCAL.sym_SN.Microcode||,
',IFType:'
||DEMO_STEM.LOCAL.sym_SN.IFType;
/* Find first pool from POOLMap. */
val_POOLMap = VALUE("HCC.HDAKT."||k||".POOLMap");
pos_POOLID = POS('1',val_POOLMap, 1);
/*
* Display pool values in the DSK configuration file.
*/
SAY '';
SAY 'Pools';
SAY '
ID, Type,Pool Name
,Tier1,Tier2,Tier3';
DO WHILE(pos_POOLID /= 0);
val_POOLID = pos_POOLID - 1;
sym_POOLID = 'POOL'||D2X(val_POOLID, 2);
/*
* Get information values about the pool
* from DSK structure REXX variables.
*/
val_Name
= DEMO_STEM.LOCAL.sym_SN.sym_POOLID.NAME;
val_Type
= DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Type;
val_PageSize = DEMO_STEM.LOCAL.sym_SN.sym_POOLID.PageSize;

C-6

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

val_Media = '';
TierCt = DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.0;
IF DATATYPE(TierCt) /= 'NUM' THEN
TierCt = 0;
DO t=1 to TierCt;
/* Get pool's drive media information */
IF val_Media = '' THEN
val_Media = convertMediaType(,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Media);
ELSE
val_Media = val_Media','convertMediaType(,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Media);
END;
/* Display pool information. */
SAY ' 'RIGHT(val_POOLID,3)','RIGHT(val_Type,5)||,
','LEFT(val_Name,32)','val_Media;
/* Find next pool from POOLMap. */
pos_POOLID = POS('1', val_POOLMap, pos_POOLID+1);
END;
SAY '';
SAY 'Volumes';
SAY ' Devn,Volser,STORGRP ,CU,SSID,CCA,POOLID, Cylinders,Ext';
/* Find first cu from CUMap. */
val_CUMap = VALUE("HCC.HDAKT."||k||".CUMap");
pos_CU
= POS('1',val_CUMap, 1);
DO WHILE(pos_CU /= 0);
hex_CU = D2X(pos_CU-1, 2);
sym_CU = 'CU'||hex_CU;
/* Find first CCA from CCAMap. */
val_CCAMap = VALUE("HCC.HDAKT."||k||"."||sym_CU||".CCAMAP");
pos_CCA
= POS('1',val_CCAMap, 1); /* Find mapped CCA. */
DO WHILE(pos_CCA /= 0);
hex_CCA = D2X(pos_CCA-1, 2);
sym_CCA = 'CCA'||hex_CCA;
/*
* Get information values about the volume
* from DSK structure REXX variables.
*/
val_devn
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Devn;
val_Volser
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Volser;
val_STORGRP = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.STORGRP;
val_SSID
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.SSID;
val_POOLID
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.POOLID;
val_Cyls
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Cyls;
val_External = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.External;
/* Display volume information. */
SAY ' 'RIGHT(val_devn,4)','LEFT(val_Volser,6)||,
','LEFT(val_STORGRP,8)||,
','hex_CU','val_SSID', 'hex_CCA','RIGHT(val_POOLID,6)||,
','RIGHT(val_Cyls,10)','RIGHT(val_External,3);
/* Find next CCA from CCAMap. */
pos_CCA = POS('1',val_CCAMap, pos_CCA+1);
END;
/* Find next CU from CUMap. */
pos_CU = POS('1',val_CUMap, pos_CU+1);
END;
END;
SAY "#-- END KTDEMO01."; /* The sample script completed. */
EXIT 0;

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-7

/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;
/*
* convertMediaType: This procedure converts from media type value
*
(<stem>LOCAL.SNnnnnn.POOLxx.Tier.n.Media in the DSK structure)
*
to media type description string.
*/
convertMediaType: procedure
ARG mediaTypeValue;
IF
mediaTypeValue = '0000' THEN
mediaTypeStr = 'SSD';
ELSE IF mediaTypeValue = '0001' THEN
mediaTypeStr = 'SAS 15K';
ELSE IF mediaTypeValue = '0002' THEN
mediaTypeStr = 'SAS 10K';
ELSE IF mediaTypeValue = '0003' THEN
mediaTypeStr = 'SATA 7.2K';
ELSE IF mediaTypeValue = '0004' THEN
mediaTypeStr = 'EXTERNAL M';
ELSE IF mediaTypeValue = '0005' THEN
mediaTypeStr = 'SAS 7.2K';
ELSE IF mediaTypeValue = '0006' THEN
mediaTypeStr = 'MIXED MEDIA';
ELSE IF mediaTypeValue = '0007' THEN
mediaTypeStr = 'EXTERNAL H';
ELSE IF mediaTypeValue = '0008' THEN
mediaTypeStr = 'EXTERNAL L';
ELSE
mediaTypeStr = '';
mediaTypeStr = '"'mediaTypeStr'"';
RETURN mediaTypeStr;

KTDEMO02 (Create a tiering policy group definition file)


/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO02 - A sample demonstration script that
*/
/*
generates TPG configuration dataset.
*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTIMPORT
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) DSK configuration dataset is already created.
*/
/*
2) Tiering policy information CSV dataset is already created.
*/
/*
3) Policy ID of tiering policy information CSV dataset is
*/
/*
specified in POLICY() option value in the script's argument. */

C-8

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

/*
4) The CSV and DSK dataset name's prefix is PREFIX() option
*/
/*
value in the script's argument.
*/
/*
If argument is "PREFIX(KT.DEMO) POLICY(POLICY1)",
*/
/*
CSV dataset name is : KT.DEMO.POLICY.POLICY1
*/
/*
DSK dataset name is : KT.DEMO.DSK.SNnnnnn.LOCAL
*/
/*
nnnnn is serial number
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO02.";
/*
* Parse argument
*/
PARSE UPPER ARG
PARSE UPPER VALUE
PARSE UPPER VALUE

specified in the EXEC command.


@options
@options 'POLICY()'
@options 'PREFIX()'

with 'POLICY('opt_policyid')';
with 'PREFIX('opt_prefix')';

/*
* Check option values in the argument.
*/
IF opt_policyid = '' THEN DO
SAY "Please specify POLICY() value in the argument.";
EXIT 8;
END;
IF opt_prefix = '' THEN DO
SAY "Please specify PREFIX() value in the argument.";
EXIT 8;
END;
/*
* Parse tiering policy information CSV file
* and create TPG configuration file(s).
*/
CALL KTIMPORT "MSG(DEMO_MSG.)",
" PREFIX("opt_prefix") POLICY("opt_policyid")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTIMPORT" RESULT;
EXIT 8;
END;
SAY "#-- END KTDEMO02."; /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-9

KTDEMO03 (Display the contents of the tiering policy group


definition file)
/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO03 - A sample demonstration script that
*/
/*
displays information in the TPG configuration dataset. */
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTLOAD
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) TPG configuration dataset is already created.
*/
/*
2) TPG configuration dataset is allocated to ddname KTTPGDD.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO03.";
/*
* Get dataset name of ddname KTTPGDD.
*/
fc = LISTDSI("KTTPGDD" "FILE");
IF fc > 4 THEN DO;
SAY 'DD(KTTPGDD) is not allocated or invalid.';
EXIT 8;
END;
/*
* Get prefix and serialNum from dataset name.
*/
PARSE VAR sysdsname val_prefix'.TPG.'val_tpgid;
/*
* Load TPG configuration file and set information to REXX variables.
*/
CALL KTLOAD "STEM(DEMO_STEM.) MSG(DEMO_MSG.)",
" PREFIX("val_prefix") TPG("val_tpgid")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTLOAD" RESULT;
EXIT 8;
END;
/*
* Display values in the TPG configuration file.
*/
SAY 'Tiering Policy Group Name: '||DEMO_STEM.TPG.ID;
SAY '';
SAY 'Volumes';
SAY ' Devn,Volser,STORGRP ,SN
,CU,SSID,CCA,POOLID,'||,
'TLv, Entry,Reloc, Cylinders'
DO i=1 to DEMO_STEM.TPG.VOL.0;
/*
* Get information values about the volume
* from TPG structure REXX variables.
*/
val_SN
= DEMO_STEM.TPG.VOL.i.SerialNum;
val_CU
= DEMO_STEM.TPG.VOL.i.CUNum;
val_CCA
= DEMO_STEM.TPG.VOL.i.CCA;
val_TierLevel
= DEMO_STEM.TPG.VOL.i.TierLevel;

C-10

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

val_Entry
= DEMO_STEM.TPG.VOL.i.Entry;
val_TierRelocation= DEMO_STEM.TPG.VOL.i.TierRelocation;
/*
* Generate symbol which is part of the DSK structure REXX variable
* name.
*/
sym_SN = 'SN' ||val_SN;
sym_CU = 'CU' ||val_CU;
sym_CCA = 'CCA'||val_CCA;
/*
* Get information values about the volume
* from DSK structure REXX variables.
*/
val_Devn
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Devn;
val_Volser = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Volser;
val_STORGRP= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.STORGRP;
val_SSID
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.SSID;
val_POOLID = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.POOLID;
val_Cyls
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Cyls;
/*
* Display volume information in the TPG.
*/
SAY ' 'RIGHT(val_Devn,4)','LEFT(val_Volser,6)||,
','LEFT(val_STORGRP,8)','val_SN','val_CU||,
','val_SSID', 'val_CCA','RIGHT(val_POOLID,6)||,
','RIGHT(val_TierLevel,3)','RIGHT(val_Entry,6)||,
','RIGHT(val_TierRelocation,5)||,
','RIGHT(val_Cyls,10);
END;
SAY "#-- END KTDEMO03."; /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;

KTDEMO04 (Display the volume information)


/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO04 - A sample demonstration script that
*/
/*
displays storage information of the target volume's DKC.*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTQRYDEV
*/
/*
*/

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-11

/*
This sample script assumes the following settings.
*/
/*
1) Device number of target (want to get storage information)
*/
/*
volume is specified in the DEVN() option value
*/
/*
in the script's argument.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO04.";
/*
* Parse argument specified in the EXEC command.
*/
PARSE UPPER ARG
@options
PARSE UPPER VALUE @options 'DEVN()'
with 'DEVN('opt_devn')';
/*
* Check option values in the argument.
*/
IF opt_devn = '' THEN DO
SAY "Please specify DEVN() value in the argument.";
EXIT 8;
END;
/*
* Query tiering policy to the target volume.
*/
CALL KTQRYDEV "STEM(DEMO_STEM.) MSG(DEMO_MSG.) DEVN("opt_devn")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTQRYDEV" RESULT;
EXIT 8;
END;
val_SN
val_CU
val_CCA
val_POOLID

=
=
=
=

DEMO_STEM.SerialNum;
DEMO_STEM.CUNum;
DEMO_STEM.CCA;
DEMO_STEM.POOLID;

sym_SN
sym_CU
sym_CCA

= 'SN' ||val_SN;
= 'CU' ||val_CU;
= 'CCA' ||val_CCA;

SAY 'DKC';
SAY ' SN:'
',Model:'
',Microcode:'
',IFType:'

||DEMO_STEM.LOCAL.sym_SN.SerialNum||,
||DEMO_STEM.LOCAL.sym_SN.Model||,
||DEMO_STEM.LOCAL.sym_SN.Microcode||,
||DEMO_STEM.LOCAL.sym_SN.IFType;

IF DATATYPE(val_POOLID)='NUM' THEN DO
/*
* Display Pool values in the volume specified in the DEVN().
*/
SAY '';
SAY 'Pool';
SAY '
ID, Type,Pool Name
,'||,
'Media(Tier1,Tier2,Tier3)';
/* Get pool information. */
sym_POOLID
= 'POOL'||D2X(val_POOLID,2);
val_Name
= DEMO_STEM.LOCAL.sym_SN.sym_POOLID.NAME;
val_Type
= DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Type;
val_PageSize = DEMO_STEM.LOCAL.sym_SN.sym_POOLID.PageSize;
val_Media = '';
TierCt = DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.0;
IF DATATYPE(TierCt) /= 'NUM' THEN
TierCt = 0;

C-12

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

DO t=1 to TierCt;
/* Get pool's drive media information. */
IF val_Media = '' THEN
val_Media = convertMediaType(,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Media);
ELSE
val_Media = val_Media','convertMediaType(,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Media);
END;
/* Display pool information. */
SAY ' 'RIGHT(val_POOLID,3)','RIGHT(val_Type,5)||,
','LEFT(val_Name,32)','val_Media;
END;
SAY '';
SAY 'Volume';
SAY ' Devn,Volser,CU,SSID,CCA,POOLID,TLv, Entry,Reloc';
/*
* Get information values about the volume
* from DSK structure REXX variables.
*/
val_Devn
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Devn;
val_Volser
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Volser;
val_SSID
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.SSID;
val_POOLID
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.POOLID;
val_TierLevel = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.TierLevel;
val_Entry
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Entry;
val_TierRelocation = ,
DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.TierRelocation;
/*
* Display volume information in the TPG.
*/
SAY ' 'RIGHT(val_Devn,4)','LEFT(val_Volser,6)||,
','val_CU','val_SSID', 'val_CCA','RIGHT(val_POOLID,6)||,
','RIGHT(val_TierLevel,3)||,
','RIGHT(val_Entry,6)','RIGHT(val_TierRelocation,5);
SAY "#-- END KTDEMO04."; /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;
/*
* convertMediaType: This procedure converts from media type value
*
(<stem>LOCAL.SNnnnnn.POOLxx.Tier.n.Media in the DSK structure)
*
to media type description string.
*/
convertMediaType: procedure
ARG mediaTypeValue;
IF
mediaTypeValue = '0000' THEN
mediaTypeStr = 'SSD';
ELSE IF mediaTypeValue = '0001' THEN
mediaTypeStr = 'SAS 15K';

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-13

ELSE IF mediaTypeValue = '0002' THEN


mediaTypeStr = 'SAS 10K';
ELSE IF mediaTypeValue = '0003' THEN
mediaTypeStr = 'SATA 7.2K';
ELSE IF mediaTypeValue = '0004' THEN
mediaTypeStr = 'EXTERNAL M';
ELSE IF mediaTypeValue = '0005' THEN
mediaTypeStr = 'SAS 7.2K';
ELSE IF mediaTypeValue = '0006' THEN
mediaTypeStr = 'MIXED MEDIA';
ELSE IF mediaTypeValue = '0007' THEN
mediaTypeStr = 'EXTERNAL H';
ELSE IF mediaTypeValue = '0008' THEN
mediaTypeStr = 'EXTERNAL L';
ELSE
mediaTypeStr = '';
mediaTypeStr = '"'mediaTypeStr'"';
RETURN mediaTypeStr;

KTDEMO05 (Change the tiering policy of a volume back to the


default)
/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO05 - A sample demonstration script that
*/
/*
resets tiering policy of the target volume.
*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTDCTDEV
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) Device number of target (want to reset tiering policy to
*/
/*
default) volume is specified in the DEVN() option value
*/
/*
in the script's argument.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO05.";
/*
* Parse argument specified in the EXEC command.
*/
PARSE UPPER ARG
@options
PARSE UPPER VALUE @options 'DEVN()'
with 'DEVN('opt_devn')';
/*
* Check option values in the argument.
*/
IF opt_devn = '' THEN DO
SAY "Please specify DEVN() value in the argument.";
EXIT 8;
END;
/*
* Reset tiering policy of the target volume.
*/
CALL KTDCTDEV "MSG(DEMO_MSG.) DEVN("opt_devn")";
/*
* Check the return code to see if it is 0 or not.
*/

C-14

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTDCTDEV" RESULT;
EXIT 8;
END;
SAY "#-- END KTDEMO05."; /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;

KTDEMO10 (Apply the tiering policy)


/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO10 - A sample demonstration script that
*/
/*
sets tiering policy to volumes in the TPG.
*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTLOAD
*/
/*
- KTACTTPG
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) TPG and DSK configuration dataset is already created.
*/
/*
2) The TPG and DSK dataset name's prefix is PREFIX() option
*/
/*
value in the script's argument.
*/
/*
3) Tiering Policy Group ID of the TPG configuration dataset is */
/*
specified in TPG() option value in the script's argument.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO10.";
/*
* Parse argument
*/
PARSE UPPER ARG
PARSE UPPER VALUE
PARSE UPPER VALUE

specified in the EXEC command.


@options
@options 'TPG()'
@options 'PREFIX()'

with 'TPG('opt_tpgid')';
with 'PREFIX('opt_prefix')';

/*
* Check option values in the argument.
*/
IF opt_tpgid = '' THEN DO
SAY "Please specify TPG() value in the argument.";
EXIT 8;
END;
IF opt_prefix = '' THEN DO
SAY "Please specify PREFIX() value in the argument.";

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-15

EXIT 8;
END;
/*
* Load TPG configuration file and set information to REXX variables.
*/
CALL KTLOAD "STEM(DEMO_STEM.) MSG(DEMO_MSG.)",
" PREFIX("opt_prefix") TPG("opt_tpgid")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTLOAD" RESULT;
EXIT 8;
END;
/*
* Set tiering policy to each volume in the TPG.
*/
CALL KTACTTPG "STEM(DEMO_STEM.) MSG(DEMO_MSG.)";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTACTTPG" RESULT;
EXIT 8;
END;
SAY "#-- END KTDEMO10."; /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;

KTDEMO11 (Check the tiering policy)


/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO11 - A sample demonstration script that
*/
/*
displays tiering policy setting values of volume
*/
/*
in the TPG.
*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTLOAD
*/
/*
- KTQRYTPG
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) TPG and DSK configuration dataset is already created.
*/
/*
2) The TPG and DSK dataset name's prefix is PREFIX() option
*/

C-16

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

/*
value in the script's argument.
*/
/*
3) Tiering Policy Group ID of the TPG configuration dataset is */
/*
specified in TPG() option value in the script's argument.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO11.";
/*
* Parse argument
*/
PARSE UPPER ARG
PARSE UPPER VALUE
PARSE UPPER VALUE

specified in the EXEC command.


@options
@options 'TPG()'
@options 'PREFIX()'

with 'TPG('opt_tpgid')';
with 'PREFIX('opt_prefix')';

/*
* Check option values in the argument.
*/
IF opt_tpgid = '' THEN DO
SAY "Please specify TPG() value in the argument.";
EXIT 8;
END;
IF opt_prefix = '' THEN DO
SAY "Please specify PREFIX() value in the argument.";
EXIT 8;
END;
/*
* Load TPG configuration file and set information to REXX variables.
*/
CALL KTLOAD "STEM(DEMO_STEM.) MSG(DEMO_MSG.)",
" PREFIX("opt_prefix") TPG("opt_tpgid")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTLOAD" RESULT;
EXIT 8;
END;
/*
* Get tiering policy setting values of volume in the TPG and
* tier status of volumes and pools in the TPG to REXX variables.
*/
CALL KTQRYTPG "STEM(DEMO_STEM.) MSG(DEMO_MSG.)";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTQRYTPG" RESULT;
EXIT 8;
END;
/*
* Display values in the TPG configuration file.
*/
SAY 'Tiering Policy Group Name: '||DEMO_STEM.TPG.ID;
SAY '';
SAY 'Volumes';
SAY ' Devn,Volser,STORGRP ,SN
,CU,SSID,CCA,POOLID'||,
',TLv, Entry,Reloc'
DO i=1 to DEMO_STEM.TPG.VOL.0;
/*
* Generate symbol which is part of the DSK structure REXX variable
* name.
*/
val_SN = DEMO_STEM.TPG.VOL.i.SerialNum;
val_CU = DEMO_STEM.TPG.VOL.i.CUNum;

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-17

val_CCA
sym_SN
sym_CU
sym_CCA

=
=
=
=

DEMO_STEM.TPG.VOL.i.CCA;
'SN' ||val_SN;
'CU' ||val_CU;
'CCA'||val_CCA;

/*
* Get information values about the volume
* from DSK structure REXX variables.
*/
val_Devn
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Devn;
val_Volser
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Volser;
val_STORGRP
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.STORGRP;
val_SSID
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.SSID;
val_POOLID
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.POOLID;
val_TierLevel = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.TierLevel;
val_Entry
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Entry;
val_TierRelocation = ,
DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.TierRelocation;
/*
* Display volume information in the TPG.
*/
SAY ' 'RIGHT(val_Devn,4)','LEFT(val_Volser,6)||,
','LEFT(val_STORGRP,8)','val_SN','val_CU||,
','val_SSID', 'val_CCA','RIGHT(val_POOLID,6)||,
','RIGHT(val_TierLevel,3)||,
','RIGHT(val_Entry,6)','RIGHT(val_TierRelocation,5);
END;
SAY "#-- END KTDEMO11."; /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;

KTDEMO12 (Check the page relocation status)


/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO12 - A sample demonstration script that
*/
/*
displays tier status of volume and pool in the TPG.
*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTLOAD
*/
/*
- KTQRYTPG
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) TPG and DSK configuration dataset is already created.
*/
/*
2) The TPG and DSK dataset name's prefix is PREFIX() option
*/

C-18

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

/*
value in the script's argument.
*/
/*
3) Tiering Policy Group ID of the TPG configuration dataset is */
/*
specified in TPG() option value in the script's argument.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO12.";
NUMERIC DIGITS 10
/*
* Parse argument
*/
PARSE UPPER ARG
PARSE UPPER VALUE
PARSE UPPER VALUE

specified in the EXEC command.


@options
@options 'TPG()'
@options 'PREFIX()'

with 'TPG('opt_tpgid')';
with 'PREFIX('opt_prefix')';

/*
* Check option values in the argument.
*/
IF opt_tpgid = '' THEN DO
SAY "Please specify TPG() value in the argument.";
EXIT 8;
END;
IF opt_prefix = '' THEN DO
SAY "Please specify PREFIX() value in the argument.";
EXIT 8;
END;
/*
* Load TPG configuration file and set information to REXX variables.
*/
CALL KTLOAD "STEM(DEMO_STEM.) MSG(DEMO_MSG.)",
" PREFIX("opt_prefix") TPG("opt_tpgid")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTLOAD" RESULT;
EXIT 8;
END;
/*
* Get tiering policy setting values of volume in the TPG and
* tier status of volumes and pools in the TPG to REXX variables.
*/
CALL KTQRYTPG "STEM(DEMO_STEM.) MSG(DEMO_MSG.)";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTQRYTPG" RESULT;
EXIT 8;
END;
SAY 'Tiering Policy Group Name: '||DEMO_STEM.TPG.ID;
SAY '';
SAY 'Volumes Tier Status';
SAY '
POOL';
SAY ' Devn,Volser,SN
,CU,CCA, ID,TLv,Cylinders,'||,
'Tier1Page,Tier2Page,Tier3Page';
DO i=1 to DEMO_STEM.TPG.VOL.0;
/*
* Generate symbol which is part of the DSK structure REXX variable
* name.
*/
val_SN = DEMO_STEM.TPG.VOL.i.SerialNum;
val_CU = DEMO_STEM.TPG.VOL.i.CUNum;
val_CCA = DEMO_STEM.TPG.VOL.i.CCA;

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-19

sym_SN = 'SN' ||val_SN;


sym_CU = 'CU' ||val_CU;
sym_CCA = 'CCA'||val_CCA;
/*
* Get information values about the volume
* from DSK structure REXX variables.
*/
val_Devn
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Devn;
val_Volser
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Volser;
val_Cyls
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Cyls;
val_POOLID
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.POOLID;
val_TierLevel = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.TierLevel;
/* Display only multi tier volume. */
val_TierCt = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Tier.0;
IF DATATYPE(val_TierCt) /= 'NUM' THEN
ITERATE;
DO t=1 to val_TierCt;
val_pageCt.t = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Tier.t.Used;
END;
DO t=val_TierCt+1 to 3;
val_pageCt.t = 0;
END;
/*
* Display volume's tier information in the TPG.
*/
SAY ' 'RIGHT(val_Devn,4)','LEFT(val_Volser,6)||,
','val_SN','val_CU', 'val_CCA','RIGHT(val_POOLID,3)||,
','RIGHT(val_TierLevel,3)||,
','RIGHT(
val_Cyls,10)||,
','RIGHT(val_pageCt.1,10)||,
','RIGHT(val_pageCt.2,10)||,
','RIGHT(val_pageCt.3,10);
END;
SAY "#-- END KTDEMO12."; /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;

KTDEMO13 (Check the relocation progress)


/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO13 - A sample demonstration script that
*/

C-20

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

/*
displays tier page placement status and
*/
/*
relocate progress in the TPG.
*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTLOAD
*/
/*
- KTQRYTPG
*/
/*
- KTQRYRLC
*/
/*
*/
/*
This sample script assumes the following settings.
*/
/*
1) TPG and DSK configuration dataset is already created.
*/
/*
2) The TPG and DSK dataset name's prefix is PREFIX() option
*/
/*
value in the script's argument.
*/
/*
3) Tiering Policy Group ID of the TPG configuration dataset is */
/*
specified in TPG() option value in the script's argument.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO13.";
NUMERIC DIGITS 11
/* Some rexx value exceed 9digits. */
/*
* Parse argument
*/
PARSE UPPER ARG
PARSE UPPER VALUE
PARSE UPPER VALUE

specified in the EXEC command.


@options
@options 'TPG()'
@options 'PREFIX()'

with 'TPG('opt_tpgid')';
with 'PREFIX('opt_prefix')';

/*
* Check option values in the argument.
*/
IF opt_tpgid = '' THEN DO
SAY "Please specify TPG() value in the argument.";
EXIT 8;
END;
IF opt_prefix = '' THEN DO
SAY "Please specify PREFIX() value in the argument.";
EXIT 8;
END;
/*
* Load TPG configuration file and set information to REXX variables.
*/
CALL KTLOAD "STEM(DEMO_STEM.) MSG(DEMO_MSG.)",
" PREFIX("opt_prefix") TPG("opt_tpgid")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTLOAD" RESULT;
EXIT 8;
END;
/*
* Get tiering policy setting values of volume in the TPG and
* tier status of volumes and pools in the TPG.
*/
CALL KTQRYTPG "STEM(DEMO_STEM.) MSG(DEMO_MSG.)";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTQRYTPG" RESULT;
EXIT 8;
END;
/*
* Get volume/pool relocation progress status in the TPG.
*/
CALL KTQRYRLC "STEM(DEMO_STEM.) MSG(DEMO_MSG.)";
/*

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-21

* Check the return code to see if it is 0 or not.


*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTQRYRLC" RESULT;
EXIT 8;
END;
/*
* Display relocation progress status per volume.
*/
SAY 'Tiering Policy Group Name: '||DEMO_STEM.TPG.ID;
SAY '';
SAY 'Volumes';
SAY '
POOL';
SAY ' Devn,Volser,SN
,CU,CCA, ID,TLv,'||,
'RelocateStatus
,LocatedPage/ TotalPage';
DO i=1 to DEMO_STEM.TPG.VOL.0;
/*
* Generate symbol which is part of the DSK structure REXX variable
* name.
*/
val_SN = DEMO_STEM.TPG.VOL.i.SerialNum;
val_CU = DEMO_STEM.TPG.VOL.i.CUNum;
val_CCA = DEMO_STEM.TPG.VOL.i.CCA;
sym_SN = 'SN' ||val_SN;
sym_CU = 'CU' ||val_CU;
sym_CCA = 'CCA'||val_CCA;
/*
* Get information values about the volume
* from DSK structure REXX variables.
*/
val_Devn
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Devn;
val_Volser = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Volser;
val_POOLID = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.POOLID;
val_TLv
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.TierLevel;
val_pageCt = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Used;
volTierCt = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Tier.0;
IF (volTierCt /=2)&(volTierCt /=3) THEN DO
SAY ' 'RIGHT(val_Devn,4)','LEFT(val_Volser,6)||,
','val_SN','val_CU', 'val_CCA||,
','RIGHT(val_POOLID,3)','RIGHT(val_TLv,3);
ITERATE;
END;
sym_POOLID = 'POOL'||D2X(val_POOLID, 2);
val_RelocatePerCent = ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.RelocatePerCent;
poolTierCt = DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.0;
IF DATATYPE(poolTierCt) /= 'NUM' THEN
poolTierCt = 0;
/* TierLevel TierRange
MultiTier
*
3Tier 2Tier 3Tier 2Tier
*
0 1/2/3 1/2
Y
Y
*
1 1
1
N
N
*
2 1/2
1/2
Y
Y
*
3
2
1/2
N
Y
*
4
2/3 1/2
Y
Y
*
5
3
2
N
N
*/
TierRange.1 = '';
TierRange.2 = '';
TierRange.3 = '';
MultiTier
= 'Y';
IF volTierCt=3 THEN DO /* 3tier? */
IF val_TLv/=3 & val_TLv/=4 & val_TLv/=5 THEN

C-22

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

TierRange.1 = 'Y';
IF val_TLv/=1 & val_TLv/=5 THEN
TierRange.2 = 'Y';
IF val_TLv/=1 & val_TLv/=2 & val_TLv/=3 THEN
TierRange.3 = 'Y';
IF val_TLv=1 | val_TLv=3 | val_TLv=5 THEN
MultiTier
= 'N';
END;
ELSE IF volTierCt=2 THEN DO /* 2tier? */
IF val_TLv /= 5 THEN
TierRange.1 = 'Y';
IF val_TLv /= 1 THEN
TierRange.2 = 'Y';
IF val_TLv=1 | val_TLv=5 THEN
MultiTier
= 'N';
END;
/*
* Calculate page in the tier range for relocate status recognition.
*/
TierRangePageCt = 0;
DO t=1 to volTierCt;
IF TierRange.t = 'Y' THEN DO
TierRangePageCt
= TierRangePageCt
,
+ DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Tier.t.Used;
END;
END;
/*
* Calculate capacity and used in the tier range.
*/
TierRangeCapacity = 0; /* total page count */
TierRangeUsed
= 0; /* used pages count */
TierRangeReserved = 0; /* reserved page count for new & reallocate */
DO t=1 to poolTierCt;
IF TierRange.t = 'Y' THEN DO
ReservedPerCent = 0;
IF DATATYPE(,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.EntryBufferPerCent,
) = 'NUM' THEN DO;
ReservedPerCent = ReservedPerCent + ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.EntryBufferPerCent;
END;
IF DATATYPE(,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.RelocateBufferPerCent,
) = 'NUM' THEN DO;
ReservedPerCent = ReservedPerCent + ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.RelocateBufferPerCent;
END;
TierRangeReserved = TierRangeReserved + TRUNC(,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Capacity,
* ReservedPerCent/100);
TierRangeCapacity = TierRangeCapacity ,
+ DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Capacity;
TierRangeUsed
= TierRangeUsed
,
+ DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Used;
END;
END;
/*
* Identify relocate status as shown below.
*
ALL: Y=All pages are in the expected Tier(s) of the range
*
capacity: expected Tier(s) capacity
* Relocate%: Pool's RelocatePerCent
*
* ALL Capacity Relocate% MultiTier
relocateStatus
*
Y
any
any
N -> done
*
Y
any
100
Y -> done
*
Y
any
>100
Y -> done or relocating

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-23

*
N
full
any
any -> capacity shortage
*
N not full
100
any -> relocate waiting
*
N not full
>100
any -> relocating
*/
IF TierRangePageCt = val_pageCt THEN DO
/* All pages are in the tier. */
IF MultiTier ='N' THEN /* Tier level is not multi tier? */
relocateStatus = 'done
';
ELSE IF val_RelocatePerCent = 100 THEN
relocateStatus = 'done
';
ELSE
relocateStatus = 'done or relocating';
END;
ELSE DO;
IF TierRangeUsed >= TierRangeCapacity - TierRangeReserved THEN
relocateStatus = 'capacity shortage ';
ELSE IF val_RelocatePerCent = 100 THEN
relocateStatus = 'relocate waiting ';
ELSE
relocateStatus = 'relocating
';
END;
SAY ' 'RIGHT(val_Devn,4)','LEFT(val_Volser,6)||,
','val_SN','val_CU', 'val_CCA||,
','RIGHT(val_POOLID,3)','RIGHT(val_TLv,3)||,
','relocateStatus','RIGHT(TierRangePageCt,11)||,
'/'RIGHT(val_pageCt,10);
END;
/*
* Display pool information.
*/
SAY '';
SAY 'Pools';
SAY '
Relocate'||,
' RelocateTime
MigrationPage';
SAY ' SN
, ID, Type,Monitor,active %,'||,
'Start, End,ExpectedCt,MigratedCt';
DO k=1 to HCC.HDAKT.0;
val_SN = HCC.HDAKT.k.SerialNum;
sym_SN = 'SN'||val_SN;
val_POOLMap = VALUE("HCC.HDAKT."||k||".POOLMap");
pos_POOLID = POS('1',val_POOLMap, 1);
DO WHILE(pos_POOLID /= 0);
val_POOLID = pos_POOLID - 1;
sym_POOLID = 'POOL'||D2X(val_POOLID, 2);
/*
* Get information values about the pool
* from DSK structure REXX variables.
*/
val_Type
= DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Type;
IF val_Type='DT' THEN DO;
val_Auto
= DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Auto;
val_RelocatePerCent
= ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.RelocatePerCent;
val_RelocateStartTime
= ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.RelocateStartTime;
val_RelocateEndTime
= ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.RelocateEndTime;
val_Relocating
= ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Relocating;
val_MigratedPageCt
= ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.MigratedPageCt;
val_ExpectedMigrationPageCt = ,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.ExpectedMigrationPageCt;

C-24

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

IF val_Auto = 'Y' THEN


monitorMode = 'auto';
ELSE
monitorMode = 'manual';
/*
* Display pool tier information.
*/
SAY ' 'val_SN','RIGHT(val_POOLID,3)','RIGHT(val_Type,5)||,
','RIGHT(monitorMode,7)||,
','val_Relocating'
'RIGHT(val_RelocatePerCent,3)'%'||,
','RIGHT(val_RelocateStartTime,5)||,
','RIGHT(val_RelocateEndTime,5)||,
','RIGHT(val_ExpectedMigrationPageCt,10)||,
','RIGHT(val_MigratedPageCt,10);
END;
/* Find next pool from POOLMap. */
pos_POOLID = POS('1', val_POOLMap, pos_POOLID+1);
END;
END;
/*
* Display relocation progress status per tier of the pool.
*/
SAY '';
SAY 'Pools tier status';
SAY ' SN
, ID,Tier,
Used/ Capacity,EntryBuf%,RelocBuf%,Media';
DO k=1 to HCC.HDAKT.0;
val_SN = HCC.HDAKT.k.SerialNum;
sym_SN = 'SN'||val_SN;
val_POOLMap = VALUE("HCC.HDAKT."||k||".POOLMap");
pos_POOLID = POS('1',val_POOLMap, 1);
DO WHILE(pos_POOLID /= 0);
val_POOLID = pos_POOLID - 1;
sym_POOLID = 'POOL'||D2X(val_POOLID, 2);
/* get pool's tier information */
poolTierCt = DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.0;
IF DATATYPE(poolTierCt) /= 'NUM' THEN DO;
pos_POOLID = POS('1', val_POOLMap, pos_POOLID+1);
ITERATE;
END;
DO t=1 to poolTierCt;
val_Capacity = DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Capacity;
val_Used
= DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Used;
val_EntryBufferPerCent =,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.EntryBufferPerCent;
val_RelocateBufferPerCent =,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.RelocateBufferPerCent;
val_Media
= convertMediaType(,
DEMO_STEM.LOCAL.sym_SN.sym_POOLID.Tier.t.Media);
/*
* Display pool's tier information.
*/
SAY ' 'val_SN','RIGHT(val_POOLID,3)',
't||,
','RIGHT(val_Used,10)'/'RIGHT(val_Capacity,10)||,
','RIGHT(val_EntryBufferPerCent,8)||,
'%,'RIGHT(val_RelocateBufferPerCent,8)'%,'val_Media;
END;
/* Find next pool from POOLMap. */
pos_POOLID = POS('1', val_POOLMap, pos_POOLID+1);
END;
END;

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-25

SAY "#-- END KTDEMO13."; /* The sample script completed. */


EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages
*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN 0;
/*
* convertMediaType: This procedure converts from media type value
*
(<stem>LOCAL.SNnnnnn.POOLxx.Tier.n.Media in the DSK structure)
*
to media type description string.
*/
convertMediaType: procedure
ARG mediaTypeValue;
IF
mediaTypeValue = '0000' THEN
mediaTypeStr = 'SSD';
ELSE IF mediaTypeValue = '0001' THEN
mediaTypeStr = 'SAS 15K';
ELSE IF mediaTypeValue = '0002' THEN
mediaTypeStr = 'SAS 10K';
ELSE IF mediaTypeValue = '0003' THEN
mediaTypeStr = 'SATA 7.2K';
ELSE IF mediaTypeValue = '0004' THEN
mediaTypeStr = 'EXTERNAL M';
ELSE IF mediaTypeValue = '0005' THEN
mediaTypeStr = 'SAS 7.2K';
ELSE IF mediaTypeValue = '0006' THEN
mediaTypeStr = 'MIXED MEDIA';
ELSE IF mediaTypeValue = '0007' THEN
mediaTypeStr = 'EXTERNAL H';
ELSE IF mediaTypeValue = '0008' THEN
mediaTypeStr = 'EXTERNAL L';
ELSE
mediaTypeStr = '';
mediaTypeStr = '"'mediaTypeStr'"';
RETURN mediaTypeStr;

KTDEMO14 (Check I/O performance information)


/* REXX
*/
/**********************************************************************/
/*
*/
/* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
*/
/*
*/
/**********************************************************************/
/*
*/
/* KTDEMO14 - A sample demonstration script that
*/
/*
displays volume I/O statistics.
*/
/*
*/
/*
This sample script uses the following CLI commands.
*/
/*
- KTLOAD
*/
/*
- KTQSTATS
*/
/*
*/

C-26

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

/*
This sample script assumes the following settings.
*/
/*
1) TPG and DSK configuration dataset is already created.
*/
/*
2) The TPG and DSK dataset name's prefix is PREFIX() option
*/
/*
value in the script's argument.
*/
/*
3) Tiering Policy Group ID of the TPG configuration dataset is */
/*
specified in TPG() option value in the script's argument.
*/
/*
4) KTQSTATS command interval time is specified in the
*/
/*
INTERVAL() option value in the script's argument.
*/
/*
*/
/**********************************************************************/
/* Sample script begins. */
SAY "#-- BEGIN KTDEMO14.";
NUMERIC DIGITS 10
/* Some rexx value exceed 9digits. */
/*
* Parse argument
*/
PARSE UPPER ARG
PARSE UPPER VALUE
PARSE UPPER VALUE
PARSE UPPER VALUE

specified in the EXEC command.


@options
@options 'TPG()'
with 'TPG('opt_tpgid')';
@options 'PREFIX()'
with 'PREFIX('opt_prefix')';
@options 'INTERVAL()' with 'INTERVAL('opt_interval')';

/*
* Check option values in the argument.
*/
IF opt_tpgid = '' THEN DO
SAY "Please specify TPG() value in the argument.";
EXIT 8;
END;
IF opt_prefix = '' THEN DO
SAY "Please specify PREFIX() value in the argument.";
EXIT 8;
END;
IF DATATYPE(opt_interval) /= 'NUM' THEN
opt_interval = 600;
/*
* Load TPG configuration file and set information to REXX variables.
*/
CALL KTLOAD "STEM(DEMO_STEM.) MSG(DEMO_MSG.)",
" PREFIX("opt_prefix") TPG("opt_tpgid")";
/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTLOAD" RESULT;
EXIT 8;
END;
/*
* Display header information.
*/
SAY 'Tiering Policy Group Name : '||DEMO_STEM.TPG.ID;
SAY 'Monitor Interval Time(sec): '||opt_interval;
SAY '';
SAY 'Volume I/O statistics';
/*
* Get I/O statistics each interval time,
* and display I/O statistics values of all volumes in the TPG.
*/
getmsgrc = 0;
EndTime=TIME();
DO WHILE getmsgrc=0;
/*
* Get tiering policy setting values of volume in the TPG and
* tier status of volumes and pools in the TPG to REXX variables.
*/
CALL KTQSTATS "STEM(DEMO_STEM.) MSG(DEMO_MSG.)";

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-27

/*
* Check the return code to see if it is 0 or not.
*/
IF RESULT /= 0 THEN DO
CALL printErrorMessage "KTQSTATS" RESULT;
EXIT 8;
END;
IF DEMO_STEM.TPG.VOL.IO.Interval > 0 THEN DO;
StartTime = EndTime;
EndTime
= TIME();
SAY ' -------------------------------------------------------';
SAY ' 'StartTime' - 'EndTime;
SAY ' -------------------------------------------------------';
SAY ' Devn,Volser,STORGRP ,SN
,CU,CCA'||,
',Tier1 IOPS,Tier2 IOPS,Tier3 IOPS';
DO i=1 to
val_SN
val_CU
val_CCA
sym_SN
sym_CU
sym_CCA

DEMO_STEM.TPG.VOL.0;
= DEMO_STEM.TPG.VOL.i.SerialNum;
= DEMO_STEM.TPG.VOL.i.CUNum;
= DEMO_STEM.TPG.VOL.i.CCA;
= 'SN' ||val_SN;
= 'CU' ||val_CU;
= 'CCA'||val_CCA;

val_Devn
= DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Devn;
val_Volser = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Volser;
val_STORGRP = DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.STORGRP;
/*
* If KTQSTATS is not first call,
* IO.diff has I/O count from last call.
*/
DO j=1 to 3;
val_iops.j=0;
END;
DO j=1 to DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Tier.0;
val_iops.j=DEMO_STEM.LOCAL.sym_SN.sym_CU.sym_CCA.Tier.j.IO.diff,
/DEMO_STEM.TPG.VOL.IO.Interval;
IF TRUNC(val_iops.j) /= val_iops.j THEN DO;
IF val_iops.j < 100 THEN
val_iops.j = TRUNC(val_iops.j,3);
ELSE
val_iops.j = TRUNC(val_iops.j,0);
END;
END;
/*
* Display this volume's I/O statistics.
*/
SAY ' 'RIGHT(val_Devn,4)','LEFT(val_Volser,6)||,
','LEFT(val_STORGRP,8)','val_SN','val_CU||,
', 'val_CCA||','RIGHT(val_iops.1,10)||,
','RIGHT(val_iops.2,10)','RIGHT(val_iops.3,10);
END;
END;
/*
* Wait for interval.
*/
ADDRESS TSO "KTSLEEP SEC("opt_interval")";
END;
SAY "#-- END KTDEMO14."; /* The sample script completed. */
EXIT 0;
/*
* printErrorMessage: This procedure prints all of the error messages

C-28

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

*
in the Message structure when a CLI command failed.
*/
printErrorMessage: procedure expose DEMO_MSG.
ARG cli_name cli_result;
SAY "Command name=" || cli_name || ",result=" || cli_result;
IF DATATYPE(DEMO_MSG.0) = 'NUM' THEN
DO x = 1 to DEMO_MSG.0;
SAY "Severity = " || DEMO_MSG.x.Severity;
SAY "Text
= " || DEMO_MSG.x.Text;
SAY "Value
= " || DEMO_MSG.x.Value;
END;
RETURN
0;

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

C-29

C-30

Sample scripts
Hitachi Tiered Storage Manager for Mainframe User Guide

D
Upgrading Tiered Storage Manager for
Mainframe
This appendix describes how to upgrade Tiered Storage Manager for
Mainframe.
Workflow for upgrading Tiered Storage Manager for Mainframe
Preparation for upgrading Tiered Storage Manager for Mainframe
Upgrading Tiered Storage Manager for Mainframe

Upgrading Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

D-1

Workflow for upgrading Tiered Storage Manager for


Mainframe
The following figure shows the Workflow for upgrading Tiered Storage
Manager for Mainframe.

Figure D-1 Workflow for upgrading


#
You do not need to delete and register a user SVC if the currently enabled
user SVC version satisfies the conditions for the user SVC that are
prerequisites for Tiered Storage Manager for Mainframe after upgrading.

Related topics

D-2

Checking the setting values of the operating environment on page D-3

Creating a backup on page D-3

Deleting the user SVC by using the KTALCSVC environment setup


command on page D-4

Deleting the user SVC from the IEASVCxx parmlib member on page
D-4

Removing the library linkage on page D-5

Upgrading Tiered Storage Manager for Mainframe on page D-6

Upgrading Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

Preparation for upgrading Tiered Storage Manager for


Mainframe
The following describes the tasks that must be performed before upgrading
Tiered Storage Manager for Mainframe.

Checking the setting values of the operating environment


Check the setting values of the operating environment that will be used for
an installation of the new version.

Procedure
1.

Execute the KTDSPENV command as shown below:


START KTDSPENV,PARM='DETAIL'

The values set for the environment variables and system symbolic names
listed in the following table are displayed.

Table D-1 Setting values of the operating environment to be checked


before upgrading
Environment variable

System symbolic names

Description

YKLCNSE

&YKLCNSE

YKLCNS2

&YKLCNS2

LOGPUT

&YKLOGPT

Event log output mode

SYSLOG

&YKSYSLG

Whether to output the log data of


CLI command execution to
SYSLOG or the console

Prefix of a license information


dataset

Related topics

KTDSPENV on page 6-43

Creating a backup
Back up the following files:

Tiering policy group definition file


File name: prefix.TPG.tiering-policy-group-ID

Disk configuration definition file


File name: prefix.DSK.SNnnnnn.LOCAL

Tiering policy information CSV file


File name: prefix.POLICY.policy-ID

Library dataset registered when the current version of Tiered Storage


Manager for Mainframe was installed

Upgrading Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

D-3

Tip: When you back up and rename files, make sure that you change only
the prefix of the file names. Because a file name contains information such as
tiering policy group IDs, changing a file name might cause file consistencies
to be lost, preventing Tiered Storage Manager for Mainframe from operating.

Related topics

Library datasets to be registered after the installation on page 2-10

Deleting the user SVC by using the KTALCSVC environment setup


command
You must delete a user SVC before upgrading and assign the same SVC
number after upgrading if the currently enabled user SVC version is older
than the prerequisite user SVC version of Tiered Storage Manager for
Mainframe after upgrading.
If a dynamic user SVC has been registered by using the KTALCSVC
environment setup command, use the KTALCSVC command to delete the user
SVC.

Procedure
1.

Execute the KTINSCHK command to confirm the currently enabled user


SVC version.

2.

If this version is older than the prerequisite user SVC version of Tiered
Storage Manager for Mainframe after upgrading, execute the KTALCSVC
command as shown below.
START KTALCSVC,PARM='DELETE'

Caution: A user SVC is shared by Tiered Storage Manager for Mainframe and
Business Continuity Manager. Therefore, in a system where Business
Continuity Manager is installed, make sure that Business Continuity Manager
is not running before deleting the user SVC.

Related topics

Prerequisite user SVC versions for Tiered Storage Manager for Mainframe
on page 2-36

KTINSCHK on page 6-39

KTALCSVC on page 6-42

Deleting the user SVC from the IEASVCxx parmlib member


You must delete the user SVC before upgrading, and then re-assign the same
SVC number after version updating if the currently enabled user SVC version
is older than the prerequisite user SVC version of Tiered Storage Manager for
Mainframe after version updating. If the static user SVC has been registered

D-4

Upgrading Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

by using the IEASVCxx parmlib member, delete the user SVC from the
IEASVCxx parmlib member.

Procedure
1.

Execute the KTINSCHK command to confirm the currently enabled user


SVC version.

2.

If this version is older than the prerequisite user SVC version of Tiered
Storage Manager for Mainframe after upgrading, disable (comment out)
the SYMDEF statement that contains the &YKSVCNO system symbolic name
in the IEASYMxx parmlib member, as shown below:

/* SYMDEF(&YKSVCNO='SVC-number') */

3.

Disable (comment out) the SVCPARM statement that specifies the JYUASVC
module of the IEASVCxx parmlib member, as shown below:

/* SVCPARM SVC-number,REPLACE,TYPE(3),EPNAME(JYUASVC),APF(NO),NPRMPT(NO),AR(NO) */

To apply the deletion of the user SVC, perform re-IPL by specifying the CLPA
parameter. Perform re-IPL at the end of the preparation for upgrading.
Caution: A user SVC is shared by Tiered Storage Manager for Mainframe and
Business Continuity Manager. Therefore, in a system where Business
Continuity Manager is installed, make sure that Business Continuity Manager
is not running before deleting the user SVC.

Related topics

Prerequisite user SVC versions for Tiered Storage Manager for Mainframe
on page 2-36

KTINSCHK on page 6-39

Removing the library linkage


Remove all the links to libraries that were established during setup.

Procedure
1.

Remove the linkage of the HDSYPRCT cataloged procedure library.

2.

If the cataloged procedure library has been statically linked to the


IEFPDSI DD name in the MSTJCLxx parmlib member, remove the
linkage.
If the KTALCSVC, KTSETENV, and KTDSPENV members have been copied
from the cataloged procedure library to the user's PROCLIB, delete
those members.

Remove the linkage of the HDSYLNKT load library for LINKLIB.

Upgrading Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

D-5

3.

If the load library for LINKLIB has been statically linked by adding it to
the PROGxx parmlib member, delete the load library from the member.
If the load library for LINKLIB has been dynamically linked to LNKLST
by using the SETPROG LNKLST command, use the SETPROG LNKLST
command to remove the linkage.

If the user SVC has been registered by using the IEASVCxx parmlib
member, remove the linkage of the HDSYLPAT load library for LPALIB.
(This step is unnecessary if the user SVC was registered by using the
YKALCSVC command.)

If the load library for LPALIB has been statically linked by defining it in
the LPALSTxx parmlib member, delete the definition.
If the load library for LPALIB has been dynamically linked to LPALST
by using the SETPROG LPA command, use the SETPROG LPA command
to remove the linkage.

To apply the removal of static linkages, you must perform re-IPL specifying
the CLPA parameter. Perform re-IPL at the end of the preparation for
upgrading.

Upgrading Tiered Storage Manager for Mainframe


The procedure for upgrading Tiered Storage Manager for Mainframe is the
same as for a new installation except the following.
When upgrading Tiered Storage Manager for Mainframe:

You do not need to register a user SVC if the currently enabled user SVC
version satisfies the conditions for the user SVC that are prerequisites for
Tiered Storage Manager for Mainframe.

If the license of the version before migration can be used and there are
no licenses to be added, you do not need to register a license for Tiered
Storage Manager for Mainframe.

Note:

If a task requiring re-IPL was performed during preparation for upgrading,


always perform re-IPL before starting the procedure for upgrading.

If sample JCL HDSKT2DF, which defines the distribution library and target
library, terminated abnormally during installation using SMP/E and
GIM35601E ** DATASET SUBENTRY WAS NOT ADDED BECAUSE IT ALREADY
EXISTS. was output, change the ADD command in HDSKT2DF to the REP
command, and then execute HDSKT2DF again.

Related topics

D-6

Chapter 2, Installation and setup on page 2-1

Upgrading Tiered Storage Manager for Mainframe


Hitachi Tiered Storage Manager for Mainframe User Guide

E
Modifying the sample JCL
This appendix provides examples of how to modify the sample JCL.
Values used in the sample JCL modification examples
ALLOUPLD (creating datasets used for transfers)
RECVUPLD (TSO/E RECEIVE processing)
HDSKTSIN (performing installation without using SMP/E)
SMPALLOC (allocating SMP/E datasets)
HDSKT1AL (allocating the distribution library and target library)
HDSKT2DF (defining the distribution library and target library)
HDSKT3RC (SMP/E RECEIVE processing)
HDSKT4AP (creating target libraries)
HDSKT5AC (creating distribution libraries)

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-1

Values used in the sample JCL modification examples


Prefixes for the dataset names and volumes allocated to the datasets used in
the sample JCL modification examples are shown in the following table.
Dataset use

Volume allocated
to the dataset

Prefix for dataset name

Dataset used for transfers

TSO/E user ID

TSOW00

For TSO/E RECEIVE

TSO/E user ID

TSOW00

SMP/E dataset

HTC1.KT.

SMP001

Target library

HTC1.KT.

KTT000

Distribution library

HTC1.KT.

KTD000

Global zone

HTC1.KT.

SMP001

(SMPTLIB)

In the sample JCL, the nnn part of CHKTnnn and the nnnnnn part of Vnnnnnn
vary depending on the version.

ALLOUPLD (creating datasets used for transfers)


The method for modifying ALLOUPLD, which creates datasets used for
transfers, is described below.
The following numbers correspond to the numbers appearing on the right side
of the sample JCL.
(1) to (3)
Modify the JOB statement in accordance with the installation
environment.
(4) to (14)
Change the prefix for the name of the dataset transfer destination from
HITACHI to the TSO/E user ID.
(15)
Change VOLSER from #tso01 to TSOW00.
//ALLOUPLD JOB (ACCT#),'ALLO UPLD FILES',
-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* This JCL allocates data sets in preparation for storing
//* the data files for installation of HTSM for MF from the
//* distribution CD.
//*
//* Instructions:

E-2

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

//* 1. Change ' HITACHI' to the current USERID.


//* 2. Change '#tso01' to VOLSER of your device.
//* 3. Submit this JCL to allocate the data sets for storing
//*
the data files.
//* 4. Transfer the unzipped .XMIT files to the allocated data sets
//*
via FTP in "BINARY" mode.
//* 5. See RECVUPLD for further procedures.
//*
//*
//* Remove all HTSM for MF files.
//*
//CLEAN
EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
DELETE HITACHI.CHKTnnn.SMPMCS.XMIT
-----(4)
DELETE HITACHI.CHKTnnn.F1.XMIT
-----(5)
DELETE HITACHI.CHKTnnn.F2.XMIT
-----(6)
DELETE HITACHI.CHKTnnn.F3.XMIT
-----(7)
DELETE HITACHI.CHKTnnn.F4.XMIT
-----(8)
DELETE HITACHI.CHKTnnn.F5.XMIT
-----(9)
DELETE HITACHI.CHKTnnn.F6.XMIT
-----(10)
DELETE HITACHI.CHKTnnn.F7.XMIT
-----(11)
DELETE HITACHI.CHKTnnn.F8.XMIT
-----(12)
DELETE HITACHI.CHKTnnn.F9.XMIT
-----(13)
SET MAXCC = 0
/*
//*
//*
Allocate the data sets for storing the data files.
//*
//*
Value
Description
//*
--------------------------------------//
SET PFX=HITACHI
Data set prefix
-----(14)
//
SET VRM=CHKTnnn
Version of HTSM For MF
//
SET VSN=#tso01
VOLSER
-----(15)
//*
//BR14
EXEC PGM=IEFBR14
//SMPMCS
DD DSN=&PFX..&VRM..SMPMCS.XMIT,
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(TRK,(15)),
//
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
//
DISP=(,CATLG,DELETE)
//F1
DD DSN=&PFX..&VRM..F1.XMIT,
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(TRK,(15)),
//
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
//
DISP=(,CATLG,DELETE)
//F2
DD DSN=&PFX..&VRM..F2.XMIT,
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(TRK,(60)),
//
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
//
DISP=(,CATLG,DELETE)
//F3
DD DSN=&PFX..&VRM..F3.XMIT,
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(TRK,(15)),
//
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
//
DISP=(,CATLG,DELETE)
//F4
DD DSN=&PFX..&VRM..F4.XMIT,
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(TRK,(15)),
//
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
//
DISP=(,CATLG,DELETE)
//F5
DD DSN=&PFX..&VRM..F5.XMIT,
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(TRK,(45)),
//
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
//
DISP=(,CATLG,DELETE)
//F6
DD DSN=&PFX..&VRM..F6.XMIT,
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(TRK,(45)),

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-3

//
//
//F7
//
//
//
//
//F8
//
//
//
//
//F9
//
//
//
//

DD

DD

DD

DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
DISP=(,CATLG,DELETE)
DSN=&PFX..&VRM..F7.XMIT,
UNIT=SYSDA,VOL=SER=&VSN,
SPACE=(TRK,(45)),
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
DISP=(,CATLG,DELETE)
DSN=&PFX..&VRM..F8.XMIT,
UNIT=SYSDA,VOL=SER=&VSN,
SPACE=(TRK,(45)),
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
DISP=(,CATLG,DELETE)
DSN=&PFX..&VRM..F9.XMIT,
UNIT=SYSDA,VOL=SER=&VSN,
SPACE=(TRK,(45)),
DCB=(DSORG=PS,RECFM=FB,LRECL=80,BLKSIZE=3120),
DISP=(,CATLG,DELETE)

RECVUPLD (TSO/E RECEIVE processing)


The changes in RECVUPLD, which performs TSO/E RECEIVE processing, are
explained below.
The following numbers correspond to the numbers appearing on the right side
of the sample JCL.
(1) to (3)
Modify the JOB statement in accordance with the installation
environment.
(4) to (14), (16), (18), (20), (22), (24), (26), (28), (30), and (32)
Change the prefix for the dataset name from HITACHI to the TSO/E user
ID.
(15), (17), (19), (21), (23), (25), (27), (29), (31), and (33)
Change VOLSER from #tso01 to TSOW00.
//RECVUPLD JOB (ACCT#),'TSO RECEIVE',
-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* This JOB uses TSO RECEIVE command to receive the data sets
//* that were allocated by ALLOUPLD JCL and contain the unzipped
//* .XMIT files that were uploaded via binary FTP transfer.
//*
//* Instructions:
//* 1. Logon with the same USERID used for ALLOUPLD job.
//* 2. Change 'HITACHI.' prefixes to suit your naming convention.
//* 3. Change '#tso01' to VOLSER of your device.
//* 4. Submit this JCL.
//* 5. See this product's documentation for SMP/E instructions.
//*
Modify the .SMPMCS file so that the chosen file prefix
//*
is indicated in the RFDSNPFX() parameter of the
//*
FUNCTION() statement.
//*
Allocate the .SMPMCS file directly to the SMP/E

E-4

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

//*
SMPPTFIN DD statement on the receive step. SMP/E will
//*
locate the other files via the catalog.
//*
//*
//* Remove all HTSM for MF files.
//*
//CLEAN
EXEC PGM=IDCAMS
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
DELETE HITACHI.CHKTnnn.SMPMCS
-----(4)
DELETE HITACHI.CHKTnnn.F1
-----(5)
DELETE HITACHI.CHKTnnn.F2
-----(6)
DELETE HITACHI.CHKTnnn.F3
-----(7)
DELETE HITACHI.CHKTnnn.F4
-----(8)
DELETE HITACHI.CHKTnnn.F5
-----(9)
DELETE HITACHI.CHKTnnn.F6
-----(10)
DELETE HITACHI.CHKTnnn.F7
-----(11)
DELETE HITACHI.CHKTnnn.F8
-----(12)
DELETE HITACHI.CHKTnnn.F9
-----(13)
SET MAXCC = 0
/*
//*********************************************************************
//* TSO receive to restore portable PDS from BINARY FTP
//*********************************************************************
//S1
EXEC PGM=IKJEFT01
//SYSTSPRT DD SYSOUT=*
//SYSTSIN DD *
RECEIVE INDSN(CHKTnnn.SMPMCS.XMIT)
DSNAME('HITACHI.CHKTnnn.SMPMCS') +
-----(14)
VOLUME(#tso01)
-----(15)
RECEIVE INDSN(CHKTnnn.F1.XMIT)
DSNAME('HITACHI.CHKTnnn.F1') +
-----(16)
VOLUME(#tso01)
-----(17)
RECEIVE INDSN(CHKTnnn.F2.XMIT)
DSNAME('HITACHI.CHKTnnn.F2') +
-----(18)
VOLUME(#tso01)
-----(19)
RECEIVE INDSN(CHKTnnn.F3.XMIT)
DSNAME('HITACHI.CHKTnnn.F3') +
-----(20)
VOLUME(#tso01)
-----(21)
RECEIVE INDSN(CHKTnnn.F4.XMIT)
DSNAME('HITACHI.CHKTnnn.F4') +
-----(22)
VOLUME(#tso01)
-----(23)
RECEIVE INDSN(CHKTnnn.F5.XMIT)
DSNAME('HITACHI.CHKTnnn.F5') +
-----(24)
VOLUME(#tso01)
-----(25)
RECEIVE INDSN(CHKTnnn.F6.XMIT)
DSNAME('HITACHI.CHKTnnn.F6') +
-----(26)
VOLUME(#tso01)
-----(27)
RECEIVE INDSN(CHKTnnn.F7.XMIT)
DSNAME('HITACHI.CHKTnnn.F7') +
-----(28)
VOLUME(#tso01)
-----(29)
RECEIVE INDSN(CHKTnnn.F8.XMIT)
DSNAME('HITACHI.CHKTnnn.F8') +
-----(30)
VOLUME(#tso01)
-----(31)
RECEIVE INDSN(CHKTnnn.F9.XMIT)
DSNAME('HITACHI.CHKTnnn.F9') +
-----(32)
VOLUME(#tso01)
-----(33)
END
/*

HDSKTSIN (performing installation without using SMP/E)


The method for modifying HDSKTSIN, which performs installation without
using SMP/E, is explained below.

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-5

The following numbers correspond to the numbers appearing on the right side
of the sample JCL.
(1) to (3)
Modify the JOB statement in accordance with the installation
environment.
(4)
Change the prefix for the input dataset name from HITACHI to the TSO/E
user ID.
(5)
Change the prefix for the target library name from HITACHI to HTC1.KT.
(6)
Change the volume allocated to the target library from #KT001 to KTT000.
//HDSKTSIN JOB (ACCT#),'SAMPLE COPY',
-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* JCL template for simplified installation of HTSM for MF.
//*
//* This sample shows an installation method that copies
//* distribution data sets directly to the target libraries,
//* without using SMP/E.
//*
//* Instructions:
//* 1) Modify the JOB statement to match your environment.
//* 2) Modify the following values to match your environment:
//*
//*
Value
Description
//*
----------------------------------------//
SET IPFX=HITACHI
Prefix of distribution data sets
-----(4)
//
SET IVRM=CHKTnnn
Version of distribution data sets
//
SET TPFX=HITACHI
Prefix of target libraries
-----(5)
//
SET TVRM=Vnnnnnn
Version of target libraries
//
SET TVSN=#KT001
VOLSER of target libraries
-----(6)
//*
//* 3) Submit the JCL.
//*
//*********************************************************************
//COPY
EXEC PGM=IEBCOPY
//SYSPRINT DD SYSOUT=*
//* Input data sets
//INF1
DD DSN=&IPFX..&IVRM..F1,DISP=SHR
SAMPLIB data set
//INF2
DD DSN=&IPFX..&IVRM..F2,DISP=SHR
LINKLIB data set
//INF3
DD DSN=&IPFX..&IVRM..F3,DISP=SHR
LPALIB data set
//INF4
DD DSN=&IPFX..&IVRM..F4,DISP=SHR
PROCLIB data set
//INF5
DD DSN=&IPFX..&IVRM..F5,DISP=SHR
EXEC(F) data set
//INF6
DD DSN=&IPFX..&IVRM..F6,DISP=SHR
EXEC(V) data set
//INF7
DD DSN=&IPFX..&IVRM..F7,DISP=SHR
PANEL
data set
//INF8
DD DSN=&IPFX..&IVRM..F8,DISP=SHR
MESSAGE data set
//INF9
DD DSN=&IPFX..&IVRM..F9,DISP=SHR
TABLE
data set
//* Output libraries
//OUTF1
DD DSN=&TPFX..&TVRM..HDSKSAMT,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
SAMPLIB
//
SPACE=(TRK,(15,1,5)),DCB=*.INF1
Target library

E-6

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

//OUTF2
DD DSN=&TPFX..&TVRM..HDSKLNKT,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,(75,1,20)),DCB=*.INF2
//OUTF3
DD DSN=&TPFX..&TVRM..HDSKLPAT,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,(1,1,1)),DCB=*.INF3
//OUTF4
DD DSN=&TPFX..&TVRM..HDSKPRCT,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,(5,1,10)),DCB=*.INF4
//OUTF5
DD DSN=&TPFX..&TVRM..HDSKEXET,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,(45,1,10)),DCB=*.INF5
//OUTF6
DD DSN=&TPFX..&TVRM..HDSKEXVT,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,(45,1,10)),DCB=*.INF6
//OUTF7
DD DSN=&TPFX..&TVRM..HDSKPNLT,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,(60,1,200)),DCB=*.INF7
//OUTF8
DD DSN=&TPFX..&TVRM..HDSKMSGT,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,(5,1,5)),DCB=*.INF8
//OUTF9
DD DSN=&TPFX..&TVRM..HDSKTABT,
//
UNIT=3390,VOL=SER=&TVSN,
//
DISP=(NEW,CATLG,DELETE),
//
SPACE=(TRK,(5,1,5)),DCB=*.INF9
//SYSIN
DD *
COPY
OUTDD=OUTF1,INDD=INF1
COPYMOD OUTDD=OUTF2,INDD=INF2
COPYMOD OUTDD=OUTF3,INDD=INF3
COPY
OUTDD=OUTF4,INDD=INF4
COPY
OUTDD=OUTF5,INDD=INF5
COPY
OUTDD=OUTF6,INDD=INF6
COPY
OUTDD=OUTF7,INDD=INF7
COPY
OUTDD=OUTF8,INDD=INF8
COPY
OUTDD=OUTF9,INDD=INF9
/*

LINKLIB
Target library
LPALIB
Target library
PROCLIB
Target library
EXECLIB(F)
Target library
EXECLIB(V)
Target library
PANEL
Target library
MESSAGE
Target library
TABLE
Target library

SMPALLOC (allocating SMP/E datasets)


The method for modifying SMPALLOC, which allocates SMP/E datasets, is
described below.
The following numbers correspond to the numbers appearing on the right side
of the sample JCL.
(1) to (3)
Modify the JOB statement in accordance with the installation
environment.
(4)
Change the prefix for the SMP/E dataset name from HDSKT to HTC1.KT.
(5) and (8)

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-7

Change the volume allocated to the SMP/E dataset from #smp01 to


SMP001.
(6), (7), (9), and (10)
Modify the prefix for the dataset name from HDSKT to HTC1.KT.
//SMPALLOC JOB (ACCT#),'ALLO SMP FILES',
-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* This JCL allocates a CSI data set.
//*
//* Instructions:
//* 1) Modify the JOB statement to match your environment.
//* 2) Modify the following values to match your environment:
//*
//*
Value
Description
//*
--------------------------------------//
SET PFX=HDSKT
Prefix of SMP files
-----(4)
//
SET VSN=#smp01
DASD volume serial for SMP files
-----(5)
//*
//* 3) Submit the JCL.
//*
//*********************************************************************
//STEP01
EXEC PGM=IDCAMS
//CSIVOL
DD UNIT=SYSDA,VOL=SER=&VSN,DISP=SHR
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
DELETE HDSKT.SMPCSI.CSI
-----(6)
SET MAXCC=0
DEFINE CLUSTER(
NAME(HDSKT.SMPCSI.CSI) -----(7)
FREESPACE(10 5)
KEYS(24 0)
RECORDSIZE(24 143)
SHAREOPTIONS(2 3)
UNIQUE
VOLUMES(#smp01)
-----(8)
)
DATA(
NAME(HDSKT.SMPCSI.CSI.DATA) -----(9)
CONTROLINTERVALSIZE(4096) CYLINDERS(1 1)
)
INDEX(
NAME(HDSKT.SMPCSI.CSI.INDEX)-----(10)
CYLINDERS(1 1)
)
/*
//*
//* Initialize a CSI data set. Refer to p.28 of SMP/E User's Guide.
//*
//STEP02
EXEC PGM=IDCAMS
//SMPCSI
DD DISP=OLD,DSN=&PFX..SMPCSI.CSI
//ZPOOL
DD DISP=SHR,DSN=SYS1.MACLIB(GIMZPOOL)
//SYSPRINT DD SYSOUT=*
//SYSIN
DD *
REPRO OUTFILE(SMPCSI)
INFILE(ZPOOL)
/*
//*

E-8

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

//* Allocate data sets for SMP installation of NC


//*
//STEP03
EXEC PGM=IEFBR14
//* Data sets required by SMP
//SMPPTS
DD DSN=&PFX..SMPPTS,
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(CYL,(1,5,10)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=27920)
//SMPSCDS DD DSN=&PFX..SMPSCDS,
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(CYL,(1,5,15)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=27920)
//SMPMTS
DD DSN=&PFX..SMPMTS,
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(CYL,(1,5,5)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=27920)
//SMPSTS
DD DSN=&PFX..SMPSTS,
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(CYL,(1,5,5)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=27920)
//SMPLOG
DD DSN=&PFX..SMPLOG,
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(CYL,(1,5)),
//
DCB=(RECFM=VB,LRECL=510,BLKSIZE=27998)
//SMPLOGA DD DSN=&PFX..SMPLOGA,
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=SYSDA,VOL=SER=&VSN,
//
SPACE=(CYL,(1,5)),
//
DCB=(RECFM=VB,LRECL=510,BLKSIZE=27998)

HDSKT1AL (allocating the distribution library and target


library)
The method for modifying HDSKT1AL, which allocates the distribution library
and target library, is described below.
The following numbers correspond to the numbers appearing on the right side
of the sample JCL.
(1) to (3)
Modify the JOB statement in accordance with the installation
environment.
(4)
Change the prefix for the dataset name from HDSKT to HTC1.KT.
(5)
Change the volume allocated to the target library from #KT001 to KTT000.
(6)
Change the volume allocated to the distribution library from #KT002 to
KTD000.

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-9

//HDSKT1AL JOB (ACCT#),'ALLO UPLD FILES',


-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* This JCL allocates the data sets for SMP/E installation of
//* HTSM for MF.
//*
//* Instructions:
//* 1) Modify the JOB statement to match your environment.
//* 2) Modify the following values to match your environment:
//*
//*
Value
Description
//*
--------------------------------------//
SET PFX=HDSKT
Prefix of SMP files
-----(4)
//
SET VRM=Vnnnnnn
Second level name (VER REL MOD)
//
SET TVSN=#KT001
Target library VOLSER
-----(5)
//
SET DVSN=#KT002
Distribution library VOLSER
-----(6)
//*
//* 3) Submit the JCL.
//*
//*********************************************************************
//ALLOCATE EXEC PGM=IEFBR14
//* Allocate target libraries
//HDSKSAMT DD DSN=&PFX..&VRM..HDSKSAMT,
SAMPLES LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,
//
SPACE=(TRK,(15,1,5)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKLNKT DD DSN=&PFX..&VRM..HDSKLNKT,
LOAD LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,
//
SPACE=(TRK,(75,1,20)),
//
DCB=(BLKSIZE=6144,RECFM=U)
//HDSKLPAT DD DSN=&PFX..&VRM..HDSKLPAT,
LPA LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,
//
SPACE=(TRK,(1,1,1)),
//
DCB=(BLKSIZE=6144,RECFM=U)
//HDSKPRCT DD DSN=&PFX..&VRM..HDSKPRCT,
PROC LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,
//
SPACE=(TRK,(5,1,10)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKEXET DD DSN=&PFX..&VRM..HDSKEXET,
EXEC(F) LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,
//
SPACE=(TRK,(45,1,10)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKEXVT DD DSN=&PFX..&VRM..HDSKEXVT,
EXEC(V) LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,
//
SPACE=(TRK,(45,1,10)),
//
DCB=(BLKSIZE=6120,LRECL=255,RECFM=VB)
//HDSKPNLT DD DSN=&PFX..&VRM..HDSKPNLT,
PANEL LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,
//
SPACE=(TRK,(60,1,200)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKMSGT DD DSN=&PFX..&VRM..HDSKMSGT,
MESSAGE LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,

E-10

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

//
SPACE=(TRK,(5,1,5)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKTABT DD DSN=&PFX..&VRM..HDSKTABT,
TABLE LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&TVSN,
//
SPACE=(TRK,(5,1,5)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//* Allocate distribution libraries
//HDSKSAMD DD DSN=&PFX..&VRM..HDSKSAMD,
SAMPLES LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(15,1,5)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKLNKD DD DSN=&PFX..&VRM..HDSKLNKD,
LOAD LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(75,1,20)),
//
DCB=(BLKSIZE=6144,RECFM=U)
//HDSKLPAD DD DSN=&PFX..&VRM..HDSKLPAD,
LPA LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(1,1,1)),
//
DCB=(BLKSIZE=6144,RECFM=U)
//HDSKPRCD DD DSN=&PFX..&VRM..HDSKPRCD,
PROC LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(5,1,10)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKEXED DD DSN=&PFX..&VRM..HDSKEXED,
EXEC(F) LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(45,1,10)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKEXVD DD DSN=&PFX..&VRM..HDSKEXVD,
EXEC(V) LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(45,1,10)),
//
DCB=(BLKSIZE=6120,LRECL=255,RECFM=VB)
//HDSKPNLD DD DSN=&PFX..&VRM..HDSKPNLD,
PANEL LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(60,1,200)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKMSGD DD DSN=&PFX..&VRM..HDSKMSGD,
MESSAGE LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(5,1,5)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)
//HDSKTABD DD DSN=&PFX..&VRM..HDSKTABD,
TABLE LIBRARY
//
DISP=(NEW,CATLG,DELETE),
//
UNIT=3390,VOL=SER=&DVSN,
//
SPACE=(TRK,(5,1,5)),
//
DCB=(BLKSIZE=6160,LRECL=80,RECFM=FB)

HDSKT2DF (defining the distribution library and target


library)
The method for modifying HDSKT2DF, which defines the distribution library
and the target library, is described below.
The following numbers correspond to the numbers appearing on the right side
of the sample JCL.

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-11

(1) to (3)
Modify the JOB statement in accordance with the installation
environment.
(4)
Change the prefix for the SMP/E dataset name, target library name, and
distribution library name from HDSKT to HTC1.KT.
(5) to (10)
Change the prefix for the SMP/E dataset name from HDSKT to HTC1.KT.
(11)
Change the volume allocated to SMPTLIB from #smp01 to SMP001.
(12) to (29)
Change the prefix for the target library name from HDSKT to HTC1.KT.
(30) to (38)
Change the prefix of the distribution library name from HDSKT to HTC1.KT.
//HDSKT2DF JOB (ACCT#),'DO THE DDDEFS',
-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* This JCL executes SMP/E DDDEF for the distribution libraries and
//* the target libraries.
//*
//* Instructions:
//* 1) Modify the JOB statement to match your environment.
//* 2) Modify the following values to match your environment:
//*
//*
Value
Description
//*
--------------------------------------//*
GIMSMP
Installation SMP/E program
//
SET PFX=HDSKT
Prefix of SMP files
-----(4)
//
SET VRM=Vnnnnnn
Second level name (VER REL MOD)
//*
#smp01
DASD volume serial for SMPTLIB
//*
//* 3) Submit the JCL to begin execution of SMP/E DDDEF.
//*
//*********************************************************************
//S1
EXEC PGM=GIMSMP
//SMPCSI
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//SMPOUT
DD SYSOUT=*
//SMPRPT
DD SYSOUT=*
//SMPLIST DD SYSOUT=*
//SYSPRINT DD SYSOUT=*
//SMPWRK1 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK2 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK3 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),

E-12

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK4 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK6 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,BLKSIZE=3120)
//SYSUT1
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT2
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT3
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT4
DD UNIT=SYSDA,SPACE=(3120,(0038,0100)),
//
DCB=(LRECL=80,BLKSIZE=3120,RECFM=FB)
//* The following data sets would likely be specified in a
//* cataloged procedure customized for a particular customer.
//SMPPTS
DD DISP=SHR,DSN=&PFX..SMPPTS
//SMPLOG
DD DISP=MOD,DSN=&PFX..SMPLOG
//SMPLOGA DD DISP=MOD,DSN=&PFX..SMPLOGA
//SMPCSI
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//GLOBAL
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//TGT1
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//DLIB1
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//* SMP/E control record input
//SMPCNTL DD *
SET
BDY(GLOBAL).
UCLIN.
ADD
GLOBALZONE ZONEINDEX(
(DLIB1,HDSKT.SMPCSI.CSI,DLIB),
(TGT1,HDSKT.SMPCSI.CSI,TARGET))
SREL(Z038).
ADD
DDDEF(SMPPTS)
DA(HDSKT.SMPPTS)
OLD.
ADD
DDDEF(SMPLOG)
DA(HDSKT.SMPLOG)
MOD.
ADD
DDDEF(SMPLOGA)
DA(HDSKT.SMPLOGA)
MOD.
ADD
DDDEF(SMPTLIB)
DSPREFIX(HDSKT.TM)
VOLUME(#smp01)
UNIT(3390)
CYL
SPACE(5,5)
DIR(200)
DSNTYPE(PDS).
ADD
DDDEF(HDSKSAMT)
DA(HDSKT.Vnnnnnn.HDSKSAMT)
OLD.
ADD
DDDEF(HDSKLNKT)
DA(HDSKT.Vnnnnnn.HDSKLNKT)
OLD.
ADD
DDDEF(HDSKLPAT)
DA(HDSKT.Vnnnnnn.HDSKLPAT)
OLD.
ADD
DDDEF(HDSKPRCT)
DA(HDSKT.Vnnnnnn.HDSKPRCT)
OLD.
ADD
DDDEF(HDSKEXET)
DA(HDSKT.Vnnnnnn.HDSKEXET)
OLD.
ADD
DDDEF(HDSKEXVT)
DA(HDSKT.Vnnnnnn.HDSKEXVT)
OLD.
ADD
DDDEF(HDSKPNLT)
DA(HDSKT.Vnnnnnn.HDSKPNLT)
OLD.
ADD
DDDEF(HDSHDSKMSGT)
DA(HDSKT.Vnnnnnn.HDSKMSGT)

-----(5)
-----(6)
-----(7)
-----(8)
-----(9)
-----(10)
-----(11)

-----(12)
-----(13)
-----(14)
-----(15)
-----(16)
-----(17)
-----(18)
-----(19)

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-13

ADD
ENDUCL.
SET
UCLIN.
ADD
ADD
ADD
ADD
ADD
ADD
ADD
ADD
ADD
ADD
ENDUCL.
SET
UCLIN.
ADD
ADD
ADD
ADD
ADD
ADD
ADD
ADD
ADD
ADD

E-14

OLD.
DDDEF(HDSKTABT)
DA(HDSKT.Vnnnnnn.HDSKTABT)
OLD.

-----(20)

BDY(TGT1).
TARGETZONE(TGT1)
RELATED(DLIB1)
SREL(Z038).
DDDEF(HDSKSAMT)
DA(HDSKT.Vnnnnnn.HDSKSAMT)
OLD.
DDDEF(HDSKLNKT)
DA(HDSKT.Vnnnnnn.HDSKLNKT)
OLD.
DDDEF(HDSKLPAT)
DA(HDSKT.Vnnnnnn.HDSKLPAT)
OLD.
DDDEF(HDSKPRCT)
DA(HDSKT.Vnnnnnn.HDSKPRCT)
OLD.
DDDEF(HDSKEXET)
DA(HDSKT.Vnnnnnn.HDSKEXET)
OLD.
DDDEF(HDSKEXVT)
DA(HDSKT.Vnnnnnn.HDSKEXVT)
OLD.
DDDEF(HDSKPNLT)
DA(HDSKT.Vnnnnnn.HDSKPNLT)
OLD.
DDDEF(HDSKMSGT)
DA(HDSKT.Vnnnnnn.HDSKMSGT)
OLD.
DDDEF(HDSKTABT)
DA(HDSKT.Vnnnnnn.HDSKTABT)
OLD.

-----(21)
-----(22)
-----(23)
-----(24)
-----(25)
-----(26)
-----(27)
-----(28)
-----(29)

BDY(DLIB1).
DLIBZONE(DLIB1)
RELATED(TGT1)
SREL(Z038).
DDDEF(HDSKSAMD)
DA(HDSKT.Vnnnnnn.HDSKSAMD)
OLD.
DDDEF(HDSKLNKD)
DA(HDSKT.Vnnnnnn.HDSKLNKD)
OLD.
DDDEF(HDSKLPAD)
DA(HDSKT.Vnnnnnn.HDSKLPAD)
OLD.
DDDEF(HDSKPRCD)
DA(HDSKT.Vnnnnnn.HDSKPRCD)
OLD.
DDDEF(HDSKEXED)
DA(HDSKT.Vnnnnnn.HDSKEXED)
OLD.
DDDEF(HDSKEXVD)
DA(HDSKT.Vnnnnnn.HDSKEXVD)
OLD.
DDDEF(HDSKPNLD)
DA(HDSKT.Vnnnnnn.HDSKPNLD)
OLD.
DDDEF(HDSKMSGD)
DA(HDSKT.Vnnnnnn.HDSKMSGD)
OLD.
DDDEF(HDSKTABD)
DA(HDSKT.Vnnnnnn.HDSKTABD)

-----(30)
-----(31)
-----(32)
-----(33)
-----(34)
-----(35)
-----(36)
-----(37)
-----(38)

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

ENDUCL.
SET
LIST
/*

OLD.
BDY(GLOBAL).
ALLZONES
DDDEF.

HDSKT3RC (SMP/E RECEIVE processing)


The method for modifying HDSKT3RC, which performs SMP/E RECEIVE
processing, is explained below.
The following numbers correspond to the numbers appearing on the right side
of the sample JCL.
(1) to (3)
Modify the JOB statement in accordance with the installation
environment.
(4)
Change the prefix for the dataset name from HDSKT to HTC1.KT.
(5)
Change the volume allocated to the SMP/E dataset from #smp01 to
SMP001.
(6)
Change RFPREFIX from HITACHI to HTC1.KT.
//HDSKT3RC JOB (ACCT#),'RECEIVE HTSM FOR MF',
-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* This JCL executes SMP/E RECEIVE to uncompress .XMIT files.
//*
//* Instructions:
//* 1) Modify the JOB statement to match your environment.
//* 2) Modify the following values to match your environment:
//*
//*
Value
Description
//*
--------------------------------------//*
GIMSMP
Installation SMP/E program
//
SET PFX=HDSKT
Prefix of SMP files
-----(4)
//
SET VRM=Vnnnnnn
Second level name (VER REL MOD)
//
SET VSN=#smp01
DASD volume serial for SMPTLIB
-----(5)
//*
HITACHI
Refer to 4) for detail.
//*
//* 3) Select form of SMPPTFIN DD statement depending upon whether
//*
installing from tape or uploaded .XMIT file.
//*
//* 4) Modify the value of RFPREFIX to match the prefix of the data set
//*
that you created with the JCL 'RECVUPLD'. Refer to the comment
//*
(refer to 3.) in 'RECVUPLD' for more detail.
//*

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-15

//* 5) Submit the JCL.


//*
//*********************************************************************
//RECEIVE EXEC PGM=GIMSMP
//SMPOUT
DD SYSOUT=*
//SMPRPT
DD SYSOUT=*
//SMPLIST DD SYSOUT=*
//SYSPRINT DD SYSOUT=*
//SMPWRK1 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK2 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK3 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK4 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK6 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,BLKSIZE=3120)
//SYSUT1
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT2
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT3
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT4
DD UNIT=SYSDA,SPACE=(3120,(0038,0100)),
//
DCB=(LRECL=80,BLKSIZE=3120,RECFM=FB)
//* The following data sets would likely be specified in a
//* cataloged procedure customized for a particular customer.
//SMPPTS
DD DISP=SHR,DSN=&PFX..SMPPTS
//SMPLOG
DD DISP=MOD,DSN=&PFX..SMPLOG
//SMPLOGA DD DISP=MOD,DSN=&PFX..SMPLOGA
//SMPCSI
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//GLOBAL
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//TGT1
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//DLIB1
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//SMPHOLD DD DUMMY
//SMPTLIB DD DISP=SHR,UNIT=3390,VOL=SER=&VSN
//* Use DASD files if installing from .XMIT distribution
//SMPPTFIN DD DSN=&PFX..CHKTnnn.SMPMCS,DISP=SHR
//* Use tape files if installing from cartridge tape
//*SMPPTFIN DD DSN=SMPMCS,DISP=OLD,
//*
VOL=SER=HDSKT,UNIT=3480,LABEL=(1,SL)
//SMPCNTL DD *
SET
BDY(GLOBAL).
RECEIVE
SELECT(CHKTnnn)
RFPREFIX(HITACHI)
-----(6)
LIST.
/*

HDSKT4AP (creating target libraries)


The method for modifying HDSKT4AP, which creates the target library, is
explained below.
The following numbers correspond to the numbers appearing on the right side
of the sample JCL.
(1) to (3)
Modify the JOB statement in accordance with the installation
environment.

E-16

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

(4)
Change the prefix for the dataset name from HDSKT to HTC1.KT.
(5)
Change the volume allocated to the SMP/E dataset from #smp01 to
SMP001.
(6)
After SMP/E ACCEPT is completed, delete CHECK (or comment it out), and
then perform the job again.
//HDSKT4AP JOB (ACCT#),'APPLY HTSM FOR MF',
-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* This JCL executes SMP/E APPLY to create the target libraries.
//*
//* Instructions:
//* 1) Modify the JOB statement to match your environment.
//* 2) Modify the following values to match your environment:
//*
//*
Value
Description
//*
--------------------------------------//*
GIMSMP
Installation SMP/E program
//
SET PFX=HDSKT
Prefix of SMP files
-----(4)
//
SET VRM=Vnnnnnn
Second level name (VER REL MOD)
//
SET VSN=#smp01
DASD volume serial for SMPTLIB
-----(5)
//*
//* 3) Submit the JCL and make sure that no error occurs.
//* 4) Remove CHECK operand from APPLY and re-submit the JCL to
//*
complete.
//*
//*********************************************************************
//APPLY
EXEC PGM=GIMSMP
//SMPOUT
DD SYSOUT=*
//SMPRPT
DD SYSOUT=*
//SMPLIST DD SYSOUT=*
//SYSPRINT DD SYSOUT=*
//SMPWRK1 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK2 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK3 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK4 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK6 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,BLKSIZE=3120)
//SYSUT1
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT2
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT3
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT4
DD UNIT=SYSDA,SPACE=(3120,(0038,0100)),
//
DCB=(LRECL=80,BLKSIZE=3120,RECFM=FB)
//* The following data sets would likely be specified in a

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-17

//* cataloged procedure customized for a particular customer.


//SMPPTS
DD DISP=SHR,DSN=&PFX..SMPPTS
//SMPLOG
DD DISP=MOD,DSN=&PFX..SMPLOG
//SMPLOGA DD DISP=MOD,DSN=&PFX..SMPLOGA
//SMPCSI
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//GLOBAL
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//TGT1
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//DLIB1
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//SMPTLIB DD DISP=SHR,UNIT=3390,VOL=SER=&VSN
//SMPHOLD DD DUMMY
//SMPSCDS DD DISP=SHR,DSN=&PFX..SMPSCDS
//SMPMTS
DD DISP=SHR,DSN=&PFX..SMPMTS
//SMPSTS
DD DISP=SHR,DSN=&PFX..SMPSTS
//SYSLIB
DD DISP=SHR,DSN=SYS1.MACLIB
//
DD DISP=SHR,DSN=&PFX..SMPMTS
//SMPCNTL DD *
SET
BDY(TGT1).
APPLY
SELECT(CHKTnnn)
CHECK
-----(6)
.
/*

HDSKT5AC (creating distribution libraries)


The method for modifying HDSKT5AC, which creates the distribution library, is
explained below.
The following numbers correspond to the numbers appearing on the right side
of the sample JCL.
(1) to (3)
Modify the JOB statement in accordance with the installation
environment.
(4)
Change the prefix for the dataset name from HDSKT to HTC1.KT.
(5)
Change the volume allocated to the SMP/E dataset from #smp01 to
SMP001.
(6)
After SMP/E ACCEPT is completed, delete CHECK (or comment it out), and
then perform the job again.
//HDSKT5AC JOB (ACCT#),'ALLO UPLD FILES',
-----(1)
//
REGION=0M,CLASS=A,
-----(2)
//
MSGLEVEL=(1,1),MSGCLASS=X,NOTIFY=&SYSUID
-----(3)
//*********************************************************************
//*
//* All Rights Reserved. Copyright (C) 2013, 2014, Hitachi, Ltd.
//*
//*********************************************************************
//*
//* This JCL executes SMP/E ACCEPT to create the distribution libraries.
//*
//* Instructions:
//* 1) Modify the JOB statement to match your environment.

E-18

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

//* 2) Modify the following values to match your environment:


//*
//*
Value
Description
//*
--------------------------------------//*
GIMSMP
Installation SMP/E program
//
SET PFX=HDSKT
Prefix of SMP files
-----(4)
//
SET VRM=Vnnnnnn
Second level name (VER REL MOD)
//
SET VSN=#smp01
DASD volume serial for SMPTLIB
-----(5)
//*
//* 3) Submit the JCL and make sure that no error occurs.
//* 4) Remove CHECK operand from ACCEPT and re-submit the JCL to
//*
complete.
//*
//*********************************************************************
//ACCEPT
EXEC PGM=GIMSMP
//SMPOUT
DD SYSOUT=*
//SMPRPT
DD SYSOUT=*
//SMPLIST DD SYSOUT=*
//SYSPRINT DD SYSOUT=*
//SMPWRK1 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK2 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK3 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK4 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,LRECL=80,BLKSIZE=3120)
//SMPWRK6 DD UNIT=SYSDA,
//
SPACE=(3120,(0364,0380,500)),
//
DCB=(RECFM=FB,BLKSIZE=3120)
//SYSUT1
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT2
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT3
DD UNIT=SYSDA,SPACE=(3120,(0380,0760))
//SYSUT4
DD UNIT=SYSDA,SPACE=(3120,(0038,0100)),
//
DCB=(LRECL=80,BLKSIZE=3120,RECFM=FB)
//* The following data sets would likely be specified in a
//* cataloged procedure customized for a particular customer.
//SMPPTS
DD DISP=SHR,DSN=&PFX..SMPPTS
//SMPLOG
DD DISP=MOD,DSN=&PFX..SMPLOG
//SMPLOGA DD DISP=MOD,DSN=&PFX..SMPLOGA
//SMPCSI
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//GLOBAL
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//TGT1
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//DLIB1
DD DISP=SHR,DSN=&PFX..SMPCSI.CSI
//SMPTLIB DD DISP=SHR,UNIT=3390,VOL=SER=&VSN
//SMPHOLD DD DUMMY
//SMPSCDS DD DISP=SHR,DSN=&PFX..SMPSCDS
//SMPMTS
DD DISP=SHR,DSN=&PFX..SMPMTS
//SMPSTS
DD DISP=SHR,DSN=&PFX..SMPSTS
//SYSLIB
DD DISP=SHR,DSN=SYS1.MACLIB
//
DD DISP=SHR,DSN=&PFX..SMPMTS
//SMPCNTL DD *
SET
BDY(DLIB1).
ACCEPT
SELECT(CHKTnnn)
CHECK
-----(6)
.
/*

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

E-19

E-20

Modifying the sample JCL


Hitachi Tiered Storage Manager for Mainframe User Guide

F
Command syntax descriptions
This chapter describes the command syntax conventions used in this
document.
Command syntax descriptions

Command syntax descriptions


Hitachi Tiered Storage Manager for Mainframe User Guide

F-1

Command syntax descriptions


The following table describes the command syntax conventions used in this
document.

Table F-1 Command syntax descriptions


Symbol
|

Convention
Vertical bars are delimiters between multiple items and represent the word
"or".
Example:
A|B|C means "A, B, or C".

[]

Items enclosed by brackets can be omitted.


If multiple items are described, all the items are omitted or only one of them
is selected.
Example:
[A] means "do not specify anything " or "only specify A".

{}

One item must be selected from among the items enclosed by curly brackets.
Items are delimited by vertical bars (|).
Example:
{A|B|C} means "you must specify A, B, or C".

... or +

The item that immediately precedes an ellipsis symbol can be specified


repeatedly.
Example:
A, ... means "you can specify item A as many times as necessary".
{A|B}+ means "you must specify item A or B as many times as necessary in
any order".
The item that immediately precedes this symbol can be omitted or can be
specified repeatedly.

Example:
{A|B}* means "do not specify anything" or "specify A or B as many times as
necessary in any order".
_

Indicates that the item is a value assumed by the system if one of the items
enclosed by the selection symbols is omitted.
0

Indicates that there can be a space or tab.


Indicates that one or more spaces or tabs are necessary.

Indicates that n or more spaces or tabs are necessary.

The items that immediately precede this symbol must follow the convention
for < >, << >>, or (( )).

<>

Indicates a syntax element that must be used when specifying the item.

<< >>

Indicates a default value used by the system if the item is omitted.

(( ))

Indicates the range of valid values.

The following table shows the syntax elements used in this document.

F-2

Command syntax descriptions


Hitachi Tiered Storage Manager for Mainframe User Guide

Table F-2 Syntax elements


Syntax
element

Valid value

Example

<Numeric
character>

0-9

--

<Alphabetic
character>

A-Z, a-z, at marks (@), hash marks (#), and dollar signs
($)

--

<Uppercase
alphabetic
character>

A-Z, at marks (@), hash marks (#), and dollar signs ($)

--

<Alphanumeric
character>

<Alphabetic character> or <numeric character>

A123

<Alphanumeric
character
string>

<Alphanumeric character>+

A123

<Alphabetic
character
string>

<Alphabetic character>+

A@C

<Hexadecimal
character>

<Numeric character>, A-F, and a-f

--

<Hexadecimal
character
string>

<Hexadecimal character>+

--

<REXX symbol
heading
character>

<Alphabetic characters>, exclamation marks (!), question -marks (?), and underscores (_)

<REXX simple
symbol>

<REXX symbol heading character>{<REXX symbol


heading character> | <numeric character>}*

This setting is not case sensitive.

This setting is not case sensitive.


--

This setting is not case sensitive.


<REXX prefix>

<REXX simple symbol>[.<REXX simple symbol>]*.


This setting is not case sensitive.

<Symbolic
name>

<Uppercase alphabetic character>{<uppercase


alphabetic character>|<numeric character>}*

A?.A123.!
12.
A1234567

Note: A symbolic name can contain eight or fewer


characters.
<Prefix
character
string>

<Symbolic name>[.<symbolic name>]*

Command syntax descriptions


Hitachi Tiered Storage Manager for Mainframe User Guide

A12.B34.C
DE

F-3

F-4

Command syntax descriptions


Hitachi Tiered Storage Manager for Mainframe User Guide

Acronyms and abbreviations


The following acronyms and abbreviations might be used in this guide.

A
APF
authorized program facility
ASCII
american standard code for information interchange

B
Business Continuity Manager
Hitachi Business Continuity Manager

C
CCA
command control address
CCW
channel command word
CLI
command line interface
Command Control Interface
Hitachi Command Control Interface

W X

Acronyms-1
Hitachi Tiered Storage Manager for Mainframe User Guide

CSV
comma-separated values
CU

controller unit

D
DASD
direct access storage device
DEVN
device number
DFSMS
Data Facility Storage Management Subsystem
DKC
disk controller
DLIB
distribution library
DSORG
data set organization
Dynamic Provisioning for Mainframe
Hitachi Dynamic Provisioning Software for Mainframe
Dynamic Tiering for Mainframe
Hitachi Dynamic Tiering Software for Mainframe

E
EBCDIC
extended binary coded decimal interchange code

F
FMID
function modification identifier

Acronyms-2
Hitachi Tiered Storage Manager for Mainframe User Guide

W X

FTP
file transfer protocol

G
GTF
generalized trace facility

I
I/O
input/output
ID

Identifier

IPL
initial program load
ISPF
interactive system productivity facility

J
JCL
job control language

L
LDEV
logical device
LRECL
logical record length

O
OPEX
operating expense

W X

Acronyms-3
Hitachi Tiered Storage Manager for Mainframe User Guide

OS

operating system

R
RACF
resource access control facility
RECFM
record format
REXX
restructured extended executor
ROI
return on investment

S
SAF
system authorization facility
SAS
serial attached SCSI
SATA
serial advanced technology attachment
SCSI
small computer system interface
SLA
service level agreement
SMP/E
system modification program extended
SMS
Units of the storage pool managed by the DFSMS
SSD
solid state drive

Acronyms-4
Hitachi Tiered Storage Manager for Mainframe User Guide

W X

SSID
storage system ID
SVC
supervisor call
SVP
service processor
SYSMOD
SYStem MODification

T
Tiered Storage Manager for Mainframe
Hitachi Tiered Storage Manager for Mainframe
TSO/E
Time Sharing Option/Extensions

V
VM
virtual machine
VSP
Hitachi Virtual Storage Platform

X
XML
extensible markup language

W X

Acronyms-5
Hitachi Tiered Storage Manager for Mainframe User Guide

Acronyms-6
Hitachi Tiered Storage Manager for Mainframe User Guide

W X

Glossary
This glossary describes the terms used in this manual.

A
AC field
An entry field used to specify an action in an ISPF panel. The action specified in the AC
field is executed for the corresponding line when Enter is pressed.

B
Business Continuity Manager
A program used for building a highly reliable backup system in which multiple data
centers are linked together. In the event of a disaster, this program enables operations
to continue by using the copy functions of the storage systems, and also enables you to
minimize the restoration time or data loss from a disaster.

C
CLI command
A command that can be used from the command line interface (CLI) of Tiered Storage
Manager for Mainframe.
CLI command-execution log
The log in which log data for executed CLI commands is recorded.
Command Control Interface
A program that allows users to operate a storage system from the command interface.

W X

Glossary-1
Hitachi Tiered Storage Manager for Mainframe User Guide

COMMAND field
An entry field used to specify an action in an ISPF panel. The action specified in the
COMMAND field is executed for the corresponding line when Enter is pressed.
Configuration file
A generic name for the tiering policy group definition file and disk configuration
definition file.

D
device address
A numbering system for devices that a storage system can use to manage volumes. A
device address is represented by a combination of a CU and a CCA.
device information structure
A REXX variable structure in which device information for volumes is stored.
DEVN
A device number used by a mainframe host to manage storage volumes.
disk configuration definition file
A file that defines the storage system's configuration information.
Dynamic Provisioning for Mainframe
Software that allocates a virtual volume to a host so that the required amount of
physical space can be used according to the data write request.
Dynamic Tiering for Mainframe
Software providing functionality that relocates data according to the access frequency,
in addition to the functionality equivalent to Dynamic Provisioning for Mainframe. In
principle, data areas that are accessed frequently are relocated to a higher-speed
hardware tier, and data areas that are accessed not so frequently are relocated to a
lower-speed hardware tier. This functionality can both improve volume performance and
reduce costs.

E
environment setup command
Commands that are used to set up a Tiered Storage Manager for Mainframe operating
environment. These commands are started by using the START OS command. The
following commands are environment setup commands: KTALCSVC, KTSETENV, and
KTDSPENV

Glossary-2
Hitachi Tiered Storage Manager for Mainframe User Guide

W X

environment variables
Variables which are set by using the KTSETENV command to set up the Tiered Storage
Manager for Mainframe operating environment. Environment variables can be used to
specify the prefixes of license information dataset, whether to use the system logger
service, and whether to output the CLI command-execution log data to SYSLOG or the
console.
event log
The log in which operations of Tiered Storage Manager for Mainframe are logged. The
logged data includes messages, information about parameters used when I/O errors
occurred, and command parameter information.

H
host-discovered array index structure
A REXX variable structure storing information that indicates the storage system and
volume configurations.
host-discovered array structure
A REXX variable structure that stores the values set for a storage system or volume.
The data in host-discovered array structures is saved in the disk configuration definition
file.

L
log stream
An aggregate of log data written by the system logger service.
logical DKC
An aggregate of volumes whose CU numbers are from 00 through FE that can be
handled by VSP. Tiered Storage Manager for Mainframe recognizes a logical DKC as a
storage system. A number assigned to each logical DKC (logical DKC serial number) is
called a storage system's serial number.
logical DKC number
A number (0 or 1) assigned to each logical DKC in the storage system.
logical DKC serial number
A number assigned to each logical disk controller (DKC).

W X

Glossary-3
Hitachi Tiered Storage Manager for Mainframe User Guide

M
message structure
A REXX variable structure that stores messages generated by CLI commands that are
executed.

N
new-page assignment tier
The tier to which new pages are assigned when a host writes data to a volume for the
first time.

P
physical DKC serial number
A number assigned to each storage system.
point-and-shoot
The act of positioning the cursor on an item in a panel and pressing Enter to select it. If
an action has been set for the point-and-shoot item, selecting that item triggers the
action to be executed.

R
REXX
One of the structure programming languages developed by IBM. Mainly used on the IBM
mainframe operating system and used as the macro language for calling applications
and operating system functions.
REXX variable structure
A variable whose value is passed when a CLI command is executed.

S
SMP/E
An IBM installer.
SMS storage group
An aggregate of the volumes that constitute the storage pool managed by DFSMS
(storage management environment in IBM MVS).

Glossary-4
Hitachi Tiered Storage Manager for Mainframe User Guide

W X

SN

The serial number of a storage system.

Storage Navigator
A program product that is connected to a service processor (SVP) to allow users to
operate a storage system remotely.
For details, see the Storage Navigator User Guide.
storage system serial number
A number assigned to each logical disk controller (DKC). This is also called a logical DKC
serial number.
SVP (service processor)
An internal computer in a storage system. Maintenance personnel use it when analyzing
maintenance information or diagnosing devices.
system logger service
MVS series standard functionality for writing, displaying, and deleting log data.

T
tier
Media in a pool grouped by drive type and performance. A maximum of three tiers can
be defined for one pool based on the performance of the media.
tier relocation
A function of Dynamic Tiering for Mainframe. This function automatically allocates data
to appropriate media according to the access frequency, based on the information
collected by performance monitoring. Frequently accessed data is allocated to an upper
tier, which consists of faster media, and infrequently accessed data is allocated to a
lower tier, which consists of lower media.
tiering policy
Information about which tiers data is to be located in, and how data is to be relocated.
tiering policy group
A group of multiple SMS storage groups or volumes. A tiering policy specification or
operation can be performed for each tiering policy group.
tiering policy group definition file
A file that defines tiering policy groups.
tiering policy group structure
A REXX variable structure that stores tiering policy values. Information about the tiering
policy group structure is saved in the tiering policy group definition file.

W X

Glossary-5
Hitachi Tiered Storage Manager for Mainframe User Guide

tiering policy information CSV file


A CSV file that specifies information about the volumes or an SMS storage group, which
are to be defined in the tiering policy group.
tiering policy level
A level of tiers in which data can be relocated. There are six levels, from 0 (default)
through 5. If a tiering policy level is specified, pages are assigned to the tiers that
belong to the specified level, and data is saved on the pages.

V
VOLSER
A volume serial number used by a mainframe host to manage storage volumes.

Glossary-6
Hitachi Tiered Storage Manager for Mainframe User Guide

W X

Index
A
AC field Glossary-1
ALLOUPLD (sample JCL) E-2
ARRAYS parameter [KTSCAN command] 6-26
ARRAYS parameter [KTSTORE command] 6-29
attributes of the distribution libraries (DLIB) 2-33
attributes of the target libraries 2-10

B
Business Continuity Manager

Glossary-1

C
calculating required memory 2-32
CLI command 6-1, Glossary-1
CLI command coding format 6-3
CLI command-execution log 9-3, Glossary-1
collecting trace information 9-2
collecting trace information and logs 9-1
Command Control Interface Glossary-1
COMMAND field Glossary-2
command syntax descriptions F-1
commands that can be used in ISPF panels B-1
common items in the panel 5-4
configuration file Glossary-2
configuration file, disk space requirements of 7-3

D
defining log stream 9-6
defining SMS for system logger service
device address Glossary-2

device information structure 8-10, Glossary-2


Device Scan Scope panel 5-12
DEVN Glossary-2
DEVN parameter [KTDCTDEV command] 6-7
DEVN parameter [KTQRYDEV command] 6-17
disk configuration definition file 1-12, Glossary-2
disk space requirements for event log 9-12, 9-18
DSK parameter [KTSTORE command] 6-29
Dynamic Provisioning for Mainframe Glossary-2
Dynamic Tiering for Mainframe Glossary-2

E
Edit Defaults panel 5-13
environment variable 2-18, Glossary-3
ERRCODE B-2
Error Code Help panel 5-14
error-code parameter [KTERCODE command] 6-38
estimating log stream dataset 9-13
estimating OUTLOG 9-13
estimating staging dataset 9-12
event log 9-3, Glossary-3
event log data output tool 9-13
Exception Message List panel 5-15

F
file provided on the installation media 2-7
files used by Tiered Storage Manager for
Mainframe 7-1
files used by Tiered Storage Manager for
Mainframe and their configuration 1-12

9-6

Index-1
Hitachi Tiered Storage Manager for Mainframe User Guide

files used by Tiered Storage Manager for


Mainframe, dataset format of 7-3
files used by Tiered Storage Manager for
Mainframe, names of 7-2
FILTER B-2
Filter Options panel B-2
filtering displayed information 3-32
FIND B-3
Find Options panel B-3

KTIMPORT command 6-12


KTINSCHK command 6-39
KTLOAD command 6-14
KTLOGCP 9-13
KTQRYDEV command 6-17
KTQRYRLC command 6-19
KTQRYTPG command 6-21
KTQSTATS command 6-23
KTSCAN command 6-25

FMID 2-9
FROM parameter [KTSCAN command] 6-26
FROMVSN parameter [KTSCAN command] 6-26

KTSETENV command 6-45


KTSLEEP command 6-41
KTSTORE command 6-28
KTWTOMSG command 6-32

H
HANDLE parameter [KTCONMSG command] 6-35
HDSKT1AL [sample JCL] E-9
HDSKT2DF [sample JCL] E-11
HDSKT3RC [sample JCL] E-15
HDSKT4AP [sample JCL] E-16
HDSKT5AC [sample JCL] E-18
HDSKTSIN [sample JCL]
E-5
highlighting available point-and-shoot fields 3-35
host-discovered array index structure 8-3,
Glossary-3
host-discovered array structure 8-4, Glossary-3
how to specify filter conditions in ISPF paneIs B-6
how to specify search conditions in ISPF paneIs B-6

I
installation and setup 2-1
overview 2-3
Installation Management area
installation using SMP/E 2-8
ISPF panels 5-1

K
KTACTTPG command 6-5
KTALCSVC command 6-42
KTCONMSG command 6-34
KTDCTDEV command 6-6
KTDCTTPG command 6-8
KTDSPENV command 6-43
KTENV command 6-36
KTERCODE command 6-37
KTGETHDA command 6-9

L
layout of the panel 5-4
library datasets to be registered after the
installation 2-10
license information dataset
creating 2-26
list of CLI commands 6-2
LOCATE B-3
Locate Options panel B-4
log stream Glossary-3
log types 9-3
logical DKC Glossary-3
logical DKC number Glossary-3
logical DKC serial number Glossary-3

M
5-17

Main panel 5-16


Main panel (common) 5-16
Manage Licenses panel 5-22
message structure 8-2, Glossary-4
MIN parameter [KTSLEEP command]
MSG
MSG
MSG
MSG
MSG
MSG
MSG
MSG
MSG
MSG
MSG

parameter
parameter
parameter
parameter
parameter
parameter
parameter
parameter
parameter
parameter
parameter

6-42

[KTACTTPG command] 6-5


[KTDCTDEV command] 6-7
[KTDCTTPG command] 6-8
[KTGETHDA command] 6-10
[KTIMPORT command] 6-12
[KTLOAD command] 6-15
[KTQRYDEV command] 6-17
[KTQRYRLC command] 6-20
[KTQRYTPG command] 6-22
[KTQSTATS command] 6-23
[KTSCAN command] 6-26

Index-2
Hitachi Tiered Storage Manager for Mainframe User Guide

MSG parameter [KTSTORE command] 6-29


MSGID parameter [KTCONMSG command] 6-35

N
New-page assignment description (2-tier
configuration) 7-6
New-page assignment description (3-tier
configuration) 7-6
new-page assignment tier Glossary-4
new-page assignment tier, about 1-9
new-page assignment tier, values 1-10

O
OP parameter [KTCONMSG command] 6-34
OS console command 6-42
OS console command coding format 6-5
coding format 6-5
Overview of assigning new pages to tiers 1-9
overview of Hitachi Tiered Storage Manager for
Mainframe 1-1

P
parameters specified when log stream is defined
9-8
physical DKC serial number Glossary-4
point-and-shoot Glossary-4
Policy ID Entry panel 5-22
Policy CSV List area 5-20
POLICY parameter [KTIMPORT command] 6-13
Pool Selection List panel 5-23
Pool Status Detail panel 5-24
positioning cursor at specific line in sorted field
3-33
PREFIX parameter [KTGETHDA command] 6-10
PREFIX parameter [KTIMPORT command] 6-12
PREFIX parameter [KTLOAD command] 6-15
PREFIX parameter [KTSTORE command] 6-29
Preparing to use Tiered Storage Manager for
Mainframe 2-32
prerequisites for Tiered Storage Manager for
Mainframe 1-10
progress of tier relocation
checking (CLI commands) 4-12

R
RECVUPLD (sample JCL) E-4
registering a license by entering a license key 2-29
registering a license by using a license key file 2-27
registering a user SVC 2-15
registering licenses 2-25
RESET parameter (FILTER command) B-2
RESET parameter (SELECT command) B-5
REXX Glossary-4
REXX external routine 6-5
REXX external routine coding format 6-4
REXX script coding format (REXX external routine)
6-4
REXX script coding format (TSO/E command) 6-4
REXX variable structure 8-1, Glossary-4
RFIND B-4

S
sample JCL E-1
SCAN parameter [KTIMPORT command] 6-13
script coding method 6-4
searching character strings 3-33
SEC parameter [KTSLEEP command] 6-42
SELECT B-4
Select Options panel B-5
Set Defaults area 5-18
setting access privileges for system logger
resources 9-7
setting actions in multiple AC fields 3-34
setting command line location 3-35
Setting Information panel 5-25
setting LOGR couple data sets 9-6
setting number of displayed function keys 3-35
setting operating environment by using
environment variables 2-19
settings required to use Tiered Storage Manager
for Mainframe on the ISPF panel 2-22
SMP/E Glossary-4
SMPALLOC [sample JCL] E-7
SMS storage group Glossary-4
SN Glossary-5
SN parameter [KTGETHDA command] 6-10
SORT B-5
Sort Options panel B-6
sorting items 3-32
SPACE parameter [KTSTORE command] 6-30
specific volume

Index-3
Hitachi Tiered Storage Manager for Mainframe User Guide

deleting from tiering policy group (CLI


commands) 4-17
deleting from tiering policy group (ISPF panels)
3-30
starting system logger service 9-7
STEM parameter [KTACTTPG command] 6-5
STEM parameter [KTDCTTPG command] 6-8
STEM parameter [KTGETHDA command] 6-10
STEM parameter [KTLOAD command] 6-14

tiering policy Glossary-5


applying (CLI commands) 4-9
applying (ISPF panels) 3-8
changing (CLI commands) 4-15
changing (ISPF panels) 3-28
verifying (CLI commands) 4-11
tiering policy group Glossary-5
adding volume (CLI commands) 4-15
adding volume (ISPF panels) 3-29

STEM parameter [KTQRYDEV command] 6-17


STEM parameter [KTQRYRLC command] 6-20
STEM parameter [KTQRYTPG command] 6-22
STEM parameter [KTQSTATS command] 6-23
STEM parameter [KTSCAN command] 6-25
STEM parameter [KTSTORE command] 6-29
stopping the system logger service 9-8
Storage Navigator Glossary-5
storage system
scanning (CLI commands) 4-5
scanning (ISPF panels) 3-5
Storage System List area 5-19
storage system serial number Glossary-5
STORGRP parameter [KTSCAN command] 6-26
SVP (service processor) Glossary-5
Switch the Unit panel 5-12
syntax element F-3
system configuration of Tiered Storage Manager
for Mainframe 1-11
system logger service Glossary-5
system symbol 2-18

changing (ISPF panels) 3-28


defining (CLI commands) 4-7
defining (ISPF panels) 3-3, 3-5, 3-8
defining and verifying (CLI commands) 4-2
verifying (ISPF panels) 3-3
tiering policy group definition file 1-12, Glossary-5
Tiering Policy Group Definition panel 5-26
Tiering Policy Group List area 5-21
Tiering Policy Group Pool List panel 5-27
Tiering Policy Group Pool Status Detail panel 5-28
Tiering Policy Group Storage Group List panel 5-30
tiering policy group structure 8-9, Glossary-5
Tiering Policy Group Summary panel 5-31
Tiering Policy Group Volume List panel 5-33
Tiering Policy Group Volume Status Detail panel
5-35
tiering policy group, about 1-5
tiering policy group, configuration example of 7-8
tiering policy group, grouping patterns of 1-6
tiering policy information CSV file 1-12, Glossary-6
creating (CLI commands) 4-7
creating (ISPF panels) 3-7
example of changing 7-9
modifying (ISPF panels) 3-31
tiering policy information CSV file, format of 7-4
tiering policy level Glossary-6
tiering policy level, about 1-8
tiering policy, about 1-6
tiering policy, overview of
1-7

T
terms used in Tiered Storage Manager for
Mainframe 1-5
text parameter [KTWTOMSG command] 6-33
text-1 parameter [KTWTOMSG command] 6-33
text-2 parameter [KTWTOMSG command] 6-33
tier Glossary-5
tier relocation Glossary-5
Tiered Storage Manager for Mainframe
functionality
overview 1-4
Tiered Storage Manager for Mainframe operations
ISPF panels 3-1
Tiered Storage Manager for Mainframe operations
when using the CLI
CLI commands 4-1

TIMEOUT parameter [KTCONMSG command] 6-35


TO parameter [KTSCAN command] 6-26
TOVSN parameter [KTSCAN command] 6-26
TPG parameter [KTLOAD command] 6-15
TPG parameter [KTSTORE command] 6-29
TSO/E command 6-34
TSO/E command coding format
coding format 6-4
type parameter [KTWTOMSG command] 6-32

Index-4
Hitachi Tiered Storage Manager for Mainframe User Guide

U
Upgrading Tiered Storage Manager for Mainframe
D-1
upgrading, preparation for D-3

V
verification after defining tiering policy group 3-13
verification after scanning storage systems (ISPF
panels) 3-9
Verifying the setup information 2-31
VOLSER Glossary-6
volume I/O performance, checking 4-14
volume information
checking (CLI commands) 4-3
VOLUME parameter [KTSTORE command] 6-30
Volume Selection List panel 5-36
Volume Status Detail panel 5-37

W
Workflow for upgrading Tiered Storage Manager
for Mainframe D-2
workflow for using Tiered Storage Manager for
Mainframe 1-14
writing to log dataset (without using system logger
service) 9-17

Index-5
Hitachi Tiered Storage Manager for Mainframe User Guide

Index-6
Hitachi Tiered Storage Manager for Mainframe User Guide

Hitachi Tiered Storage Manager for Mainframe User Guide

Hitachi Data Systems


Corporate Headquarters
2845 Lafayette Street
Santa Clara, California 95050-2639
U.S.A.
www.hds.com
Regional Contact Information
Americas
+1 408 970 1000
info@hds.com
Europe, Middle East, and Africa
+44 (0)1753 618000
info.emea@hds.com
Asia Pacific
+852 3189 7900
hds.marketing.apac@hds.com

MK-92HC207-01

Vous aimerez peut-être aussi