HP StorageWorks XP Tiered Storage Manager CLI Reference Guide Part number: T1785-96003 First edition: 11/2005 Revision history (start here) 1
Legal notices © Copyright 2005 Hewlett-Packard Development Company, L.P. Hewlett-Packard Company makes no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Hewlett-Packard shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material.
Contents Revision history (start here) Revision tables ....................................................................................................................................................... 9 1 Overview of HP StorageWorks XP Tiered Storage Manager 1-1 1-2 2 Tiered Storage Manager Software Components....................................................................................... 10 Volume Migration Using the Tiered Storage Manager CLI..............................................
-4-4 4-4-5 4-4-6 4-4-7 5 ModifyTask ..................................................................................................................................... 94 ExecuteTask................................................................................................................................... 96 CancelTask..................................................................................................................................... 96 DeleteTasks.................................
Figures Figure 1-1 Flow of Migration Operations.................................................................................................................... 11 Figure 1-2 Example Candidate Migration Plan .......................................................................................................... 16 Figure 3-1 Filter Condition Expressions in BNF .........................................................................................................
Table 4-41 Items Output by the GetMigrationGroups Command .............................................................................. 70 Table 4-42 Options of the ModifyMigrationGroup Command .................................................................................... 73 Table 4-43 Parameters of the ModifyMigrationGroup Command .............................................................................. 73 Table 4-44 Items Output by the ModifyMigrationGroup Command .............................
This guide provides information about: • Installing HP StorageWorks Command View XP Advanced Edition Device Manager Server software. • Installing Java™2 Java™ Runtime Environment (JRE). Intended audience This guide is intended for customers and HP authorized service providers who are experienced with the following: • Data processing and direct-access storage device subsystems. • HP StorageWorks XP Series disk array(s).
HP technical support Telephone numbers for worldwide technical support are listed on the HP web site: http://www.hp.com/support/ Collect the following information before calling: • Technical support registration number (if applicable) • Product serial numbers • Product model names and numbers • Applicable error messages • Operating system type and revision level • Detailed, specific questions For continuous quality improvement, calls may be recorded or monitored.
Revision history (start here) Revision tables Date Edition Revision November, 2005 First Initial release Overview of HP StorageWorks XP Tiered Storage Manager Table 2 Revisions Revision history (start here) 9
1 Overview of HP StorageWorks XP Tiered Storage Manager This chapter explains the software components of Tiered Storage Manager as well as volume migration using the Tiered Storage Manager CLI. The explanations on migration cover the overall procedures and commands that can be used at each step, volume filtering and filter conditions, creation of candidate migration plans, and creation and execution of migration tasks.
Overview of HP StorageWorks XP Tiered Storage Manager Figure 1-1 Flow of Migration Operations 1. Map volumes (LDEVs) Use the External Storage XP from StorageWorks XP12000/XP10000 to map the volumes (LDEVs) on external storage subsystems to StorageWorks XP12000/XP10000. Mapping involves determining the controller LDEV numbers on the domain control storage subsystem, for volumes (LDEVs) on external storage subsystems.
NOTE: The storage tier must be created such that it contains a volume whose characteristics match those of the migration source volume. 4. Create a migration group Use the CreateMigrationGroup command to create a migration group in a storage domain. A migration group is a collection of volumes on which application data is stored. Define a migration group to specify a collection of volumes to be migrated simultaneously. 5.
1-2-2 Volume Search and Volume Filter Conditions Volumes in a storage domain and storage tiers can be searched by their attributes. To search volumes, specify a volume filter condition expression. Table 1-2 lists and describes the properties that can be specified for the filtercondition parameter of the GetVolumes command and the CreateMigrationPlan command.
When volume filter conditions are further specified by the filtercondition parameter, candidate migration target volumes are chosen from those that match the specified conditions. See Table 1-2. for details about the properties of the filtercondition parameter that can be specified for creating a candidate migration plan. Table 1-3 lists the items specified for candidate migration plans created as information output for commands.
# CLPRNumber=0 # cacheMode=Disable # IOSupressionMode=Disable sourceControllerDeviceNumber=3:A6 targetControllerDeviceNumber=2:80 # emulationType=OPEN-V # CVS=Yes # capacityInKB=10,240,320 # SLPRNumber=0 # CLPRNumber=0 # arrayGroupName=1-9-1 sourceControllerDeviceNumber=3:A7 targetControllerDeviceNumber=2:84 # Target candidates for source LDEV - 3:A7, 3:A6 # emulationType=OPEN-V # CVS=Yes # capacityInKB=10,240,320 # SLPRNumber=0 # CLPRNumber=0 # arrayGroupName=1-10-1 # targe
# targetControllerDeviceNumber=2:A6 # targetControllerDeviceNumber=2:A7 Figure 1-2 Example Candidate Migration Plan Even if migration target volume candidates cannot be selected for all migration source volumes, the specified candidate migration plan is created for those that can be selected. A candidate for a migration target volume is selected from the logical partition (SLPR and CLPR) to which the migration source volume belongs.
1-2-4 Editing a Migration Plan A candidate migration plan created by the CreateMigrationPlan command can be used as-is for migration, or can be edited as text data by a user as needed. The format for candidate migration plans is as follows: • Each item consists of an item name, equal sign (=), and value, in that order. Note that only the item name is specified for pair. NOTE: Item names are not case-sensitive (for example, storagedomainname and STORAGEDOMAINNAME are equivalent).
• Active.WaitingMigration: Waiting for migration to be performed • Active.Migrating: Migration is being performed • Active.WaitingDataErasure: Waiting for erasure to be performed • Active.DataErasing: Erasure is being performed • Success: Ended in success • Failure.MigrationFailure: Ended in migration failure • Failure.
2 Requirements and Installation This chapter explains the system requirements for operating the Tiered Storage Manager CLI. This chapter also explains installation and setup of the Tiered Storage Manager CLI, which is required for setting an environment where CLI commands can be executed on a Management client.
For commands such as the GetVolumes command that can obtain a large amount of information depending on parameter settings, the amount of memory secured must suit the parameter settings. The maximum amount of memory required for executing the GetVolumes command is about 150 MB. If the value set for HTSM_CLI_MEM_SIZE is not enough for the amount of memory needed during CLI execution, CLI will display the following error message, and then terminate: Exception in thread "main" java.lang.
system-drive\TieredStorageManager\0110\CLI\htsmcli.bat system-drive\TieredStorageManager\0110\CLI\htsmcli.properties system-drive\TieredStorageManager\0110\CLI\htsmclienv.properties NOTE: The decompressed properties file htsmcli.properties is a sample file, and examples of property setting are contained in the file as comment lines. 4. Execute setup.bat, the batch file for setup.
1. Execute the env command to verify that the value set for the PATH system environment variable contains the path in which java is stored. If it does not, add the appropriate path to the system logon script (such as /etc/profile). Once you have verified that setup is complete, edit the properties file as needed. Also, to use a previously backed up properties file, simply replace the existing one. NOTE: The properties file htsmcli.
2-4 Tiered Storage Manager CLI Uninstallation and Unsetup To perform unsetup of CLI, you must execute the batch file or shell script for unsetup. When unsetup of CLI is performed, the files for CLI are deleted and the common library for collecting trace information is uninstalled. The batch file or shell script for unsetup is one of the files decompressed from the setup file during setup, and is located in the same directory as the batch file or shell script for setup.
By using the desired umask, if you want to create a file to which the standard output is to be redirected, use the shell redirect functionality instead of the output option. • Canceling a CLI command by pressing Ctrl + C or closing the window When a CLI command is canceled by pressing Ctrl + C or closing the window, the user does not know the execution result. In such a case, execute a view command, such as GetTasks, to check the execution result.
3 Using the Tiered Storage Manager CLI This chapter provides an overview of the Tiered Storage Manager CLI and describes the structure and syntax of CLI commands.
Table 3-1 CLI Command Categories Category Migration Command Name Description ModifyMigrationGroup Changes attributes for a migration group. The following attributes can be changed: • Migration group name • Attribute indicating whether the migration group is subject to migration operations. • Migration group description AddVolumeToMigrationGroup Adds a volume to a migration group. RemoveVolumeFromMigrationGroup Removes a volume from a migration group.
Table 3-2 Description of CLI Command Elements Command Element Description options Options contain information for controlling the CLI operation. Use the general UNIX format when entering options. There are two kinds of such expressions: one-character expressions and one-word expressions. Insert one hyphen before one-character expressions, and two hyphens before one-word expressions.
Table 3-3 Range of Valid Parameter Values Parameter Permissible Value or Range Valid Characters and Parameter Restrictions Size or Number of Characters name • One of the following names provided in Tiered Storage Manager: - storagedomainname - storagetiername - migrationgroupname -- Up to 75 bytes (when converted to UTF-8). 1 ASCII character is 1 byte, other characters are from 1 to 3 bytes. description -- A to Z a to z 0 to 9 Hyphen (-) Underscore (_) Period (.
Table 3-3 Range of Valid Parameter Values Permissible Value or Range Valid Characters and Parameter Restrictions Size or Number of Characters controllerdevicenumber -- -- canmigrate Yes and No erasedata Yes and No id An ID created by CreateMigrationTas k, this is the value displayed for the ID attribute of the MigrationTask object for CreateMigrationTas k. Two hexadecimal values less than 0x100, separated by a colon (:).
Table 3-3 Range of Valid Parameter Values Parameter Permissible Value or Range direction Before After Just filtercondition See Table 3-4. Valid Characters and Parameter Restrictions symbol + to the value. The value is not case sensitive. • The value cannot contain space characters See Table 3-4. • Size or Number of Characters -- Up to 4,096 bytes (when converted to UTF-8).
The following is an example specification for filtercondition, for a filter condition for a storage tier: Property names are not case sensitive. filtercondition="RAIDLevel='RAID5(3D+1P)' AND DiskType='FC'" Table 3-4 describes the values that can be specified in the properties for the filter condition expressions used for the filtercondition parameter.
Table 3-4 Range of Valid Property Values for Filter Condition Expressions Property Name Permissible Value or Range Valid Characters and Character Restrictions Size or Number of Characters SubsystemName The value displayed for the name attribute of the StorageArray object, in GetStorageArray for the Device Manager CLI. No restrictions on the types of characters exist, but note the following restriction: • The specified value cannot start or end with a space character.
Property Name Permissible Value or Range Valid Characters and Character Restrictions Size or Number of Characters ArrayGroup The value displayed for the displayName attribute of the ArrayGroup object, in GetStorageArray(subtarget= ArrayGroup) for the Device Manager CLI. Part of the value can be specified by using startsWith or contains A to Z a to z 0 to 9 Hyphen (-) Underscore (_) Period (.) At mark (@) Space character ( ) Non-ASCII characters • An empty character string cannot be specified.
Table 3-4 Range of Valid Property Values for Filter Condition Expressions Property Name Permissible Value or Range EmulationType The value displayed for the No restrictions exist. • The specified value emulation attribute of the cannot start or end with a LogicalUnit object, in space character. GetStorageArray(subtarget= • Space characters included LogicalUnit) for the Device within the string are not Manager CLI. discriminated. • The value is not case sensitive.
Property Name Permissible Value or Range Valid Characters and Character Restrictions Size or Number of Characters ControllerArrayGroup This value is displayed in the displayName attribute of the ArrayGroup object for the GetStorageArray (subtarget=ArrayGroup) in Device Manager CLI. A to Z a to z 0 to 9 Hyphen (-) Underscore (_) Period (.) At mark (@) Space character ( ) Non-ASCII characters • The specified value cannot start or end with a space character.
Table 3-5 Recommended/Maximum Values for Tiered Storage Manager Operations Type of Operation Description Recommended Value Maximum Value Storage tier The number of storage tiers within the storage domain 30 or less 100 Migration group The number of migration groups within the storage domain 1,000 5,000 Volume The number of volumes within the storage domain Not applicable 16,384 The number of volumes within the migration group 64 or less 300 The number of unfinished tasks that can be regis
Option Option Argument Description -u or --username user-name Specify the user name used to log on to Tiered Storage Manager server. This is the same as the logon user name for Device Manager. -p or --password password or @name-of-password-file Specify the password corresponding to the user name. You can either specify the password directly, or specify a file that contains the password. When specifying a file name for an argument, add @ before the file name.
Table 3-7 Impact of CLI Commands on Repository Information Category Command Name Repository Information Displayed Repository Information Updated Refresh No Yes CreateStorageTier No Yes DeleteStorageTier No Yes GetStorageTiers Yes No ModifyStorageTier No Yes GetVolumes (with storagetiername specified) Yes No Migration group management CreateMigrationGroup No Yes DeleteMigrationGroup No Yes GetMigrationGroups Yes No ModifyMigrationGroup No Yes AddVolumeToMigrationGr No oup Y
To start a CLI command on a Management client, specify the file as described below from the command line: When the OS is Windows: system-drive\TieredStorageManager\0110\CLI\htsmcli arguments When the OS is Solaris or HP-UX: # ./htsmcli arguments CLI commands can be executed from a Management server.
. . CancelTask DeleteTasks FOR HELP, TYPE: "htsmcli help [command]" AVAILABLE OPTIONS: -u {username} or --username {username} login name for HTSM Server -p {password} or --password {password} login password for HTSM Server -o {filename} or --output {filename} send output to the specified file, instead of the console SPECIFYING PARAMETERS: Specify parameters for a command using name/value pairs, like: controllerserialnumber=30051. parameters for a given command.
4 Detailed Command Descriptions This chapter contains a detailed description for each CLI command.
Table 4-1 Options of the CreateStorageDomain Command Option Name Arguments Optional or Required Description -d or --detail None Optional Specify this to output information about the registered storage domain to the standard output, after command execution. If this is omitted, nothing is output to the standard output.
Table 4-3 Items Output by the CreateStorageDomain Command Type of Information Item Name Description Output by -d description A description of the storage domain. -d Legend: -d indicates output only when either the -d or the --detail option is specified. Example In this example, a StorageWorks XP12000/XP10000 domain control storage subsystem and externally connected storage subsystem group are registered as a storage domain. The name of the storage domain is set as MegaTechXP12000-Primary.
Table 4-6 Items Output by the DeleteStorageDomain Command Type of Information Item Name Description Output by -d Displayed as Unknown Storage domain information name The name of the deleted storage domain. -d -d The model name of the domain control storage subsystem. -d controllerDisplayModel The display model name of the domain control storage subsystem. -d controllerModel controllerName The name of the domain control storage subsystem. -d description A description of the storage domain.
Table 4-7 Options of the GetStorageDomains Command Option Name Arguments Optional or Required Description -d or --detail None Optional Specify this to output all information about the storage domain to the standard output, after command execution. # If this is omitted, only summary information is output. # Summary information consists of the information for items for which the Output by -d column is blank in Table 4-9.
Table 4-9 Items Output by the GetStorageDomains Command Error information Item Name Description Output by -d lastRefreshedTime The date and time when the previous refresh finished. If the previous refresh has not finished, this is blank. -d controllerSerialNumber The serial number of the domain control storage subsystem. -d controllerModel The model name of the domain control storage subsystem. -d controllerDisplayModel The display model name of the domain control storage subsystem.
totalCapacityInGB=Unknown usedCapacityInGB=Unknown usedCapacityPercentage=Unknown freeCapacityInGB=Unknown freeCapacityPercentage=Unknown numberOfSubsystems=Unknown numberOfStorageTiers=3 numberOfMigrationGroups=3 refreshStatus=Failure lastRefreshedTime= controllerSerialNumber=59432 controllerModel=USP controllerDisplayModel=XP12000 controllerName=Unknown description=XP12000-Secondary List of 1 ErrorInfo elements: An instance of ErrorInfo(1 of 1) message=KATS50212-E An attempt to execute the refresh operati
usedCapacityPercentage=Unknown freeCapacityInGB=Unknown freeCapacityPercentage=Unknown numberOfStorageTiers=3 numberOfMigrationGroups=3 refreshStatus=Failure List of 1 ErrorInfo elements: An instance of ErrorInfo(1 of 1) message=KATS50212-E An attempt to execute the refresh operation has failed. D:\> Example (3): In this example, to obtain summary information for all storage domains, the GetStorageDomains command is executed without specifying the storage domain name. However, no storage domain exists.
Table 4-11 Parameters of the ModifyStorageDomain Command Parameter Name Optional or Required Description name Required Specify the name of the storage domain for which you want to change information. newname Optional Specify a new storage domain name. This name should be unique within Tiered Storage Manager. If this is omitted, the name of the storage domain will not change. newdescription Optional Specify a new storage domain description.
• Migration group (when a migration group name is specified) You can also further limit the items obtained by specifying both a volume filter condition and each item such as a storage domain, storage tier, or migration group. Detailed information cannot be obtained for volumes in storage domains that are being refreshed.
Table 4-15 Properties Specifiable for the filtercondition Parameter Property Name Operators Description SubsystemVendor = , <> The name of the storage subsystem vendor. ControllerDeviceNumber = The controller LDEV number. Only a representative LDEV can be specified for a LUSE volume. • Host = , <>, startsWith, contains The name of the host. ArrayGroup = , <>, startsWith, contains The name of the array group. Capacity <, <=, =, <>, > , >= The volume capacity.
Table 4-16 Items Output by the GetVolumes Command Cause of impossibility of migration Description Output by -d CVS The CVS volume attribute of the volume. This can be either Yes or No. -d capacityInKB The resource capacity of the volume (units: KB). #1 raidLevel The RAID level. #1, #2 diskType The disk type. #1, #2 arrayGroupNumber The array group number of the LU in which the data is actually contained in the storage subsystem.
Table 4-16 Items Output by the GetVolumes Command Type of Information Item Name Description Output by -d LDEV information for the domain control storage subsystem controllerDeviceNumber The controller LDEV number. -d controllerSerialNumber The serial number of the domain control storage subsystem. -d controllerModel The model name of the domain control -d storage subsystem. controllerDisplayModel The display model name of the domain -d control storage subsystem.
Table 4-16 Items Output by the GetVolumes Command Type of Information Item Name Description Output by -d Displayed as Unknown subsystemVendor The vendor name of the storage subsystem in which actual data is stored. -d #1 arrayGroupNumber The array group number of the LU in which the data is actually contained in the storage subsystem. -d arrayGroupName The array group name of the LU in which the data is actually contained in the storage subsystem.
Table 4-17 GUI-Displayed Character Strings Representing Reasons a Volume Cannot Be a Migration Target, and a Description of those Character Strings Displayed character string Description Migration Migration source target volume volume NAS (target) NAS system volume - Y Externally Locked A volume that is using an external subsystem function and is locked #2 (not Read/Write) by LUN Security XP Extension Y Y Legend: Y: Corresponds to the reason that cannot be migrated (cannot be used as a volume for
volumeLockStatus=Unlocked path=No hostNames= canMigrate=No List of 2 reason(s) for volume migration exclusion: reason(1 of 2)=LUSE (target) reason(2 of 2)=Universal Replicator List of 1 Ldev elements: An instance of Ldev(1 of 1) controllerDeviceNumber=1:E0 controllerSerialNumber=14011 controllerModel=USP controllerDisplayModel=XP12000 controllerName=XP12000@10.208.151.
arrayGroupNumber=Unknown controllerArrayGroupName= E9980-1 arrayGroupName=Unknown businessCopyXP=Simplex continuousAccessXP=Simplex continuousAccessXPJournal=Simplex snapshotXP=Simplex volumeStatus=Free volumeLockStatus=Unlocked path=No hostNames= canMigrate=Yes List of 0 reason(s) for volume migration exclusion: List of 1 Ldev elements: An instance of Ldev(1 of 1) controllerDeviceNumber=3:FF controllerSerialNumber=14011 controllerModel=USP controllerDisplayModel=XP12000 controllerName=XP12000@10.208.151.
Output (2): RESPONSE: An instance of StorageDomain(1 of 1) name=MegaTechXP12000-Primary List of 2 LogicalUnit elements: An instance of LogicalUnit(1 of 2) controllerDeviceNumber=1:E0 subsystemVendor=HITACHI migrationGroupName= emulationType=OPEN-V capacityInKB=5,120,640 raidLevel=Unknown diskType=Unknown controllerArrayGroupName=E9960-1 arrayGroupName=Unknown volumeStatus=Free volumeLockStatus=Unlocked hostNames= An instance of LogicalUnit(2 of 2) controllerDeviceNumber=3:FF migrationGroupName= emulationTyp
4-1-6 Refresh The Refresh command can be used to perform refresh processing (processing to re-obtain configuration information from Device Manager and register it in the Tiered Storage Manager repository) for all storage domains, or for the storage domain specified by the storagedomainname parameter. Note that refresh processing is performed asynchronously to execution of this command. The GetStorageDomains command can be used to check the refresh status.
Table 4-19 Options of the CreateStorageTier Command Option Name Option Arguments Optional or Required Description -d or --detail None Optional Specify this to output information about the created storage tier to the standard output, after command execution. If this is omitted, nothing is output to the standard output. Table 4-20 Parameters of the CreateStorageTier Command Parameter Name Optional or Required Description storagedomainname Required Specify the name of the storage domain.
D:\>htsmcli CreateStorageTier --detail storagedomainname="MegaTechXP12000Primary" name="MegaTech-HighCost" filterCondition="RAIDLevel='RAID5(3D+1P)' AND ArrayGroup='1-10-1'" Output: RESPONSE: An instance of StorageDomain(1 of 1) name=MegaTechXP12000-Primary List of 1 StorageTier elements: An instance of StorageTier(1 of 1) name=MegaTech-HighCost filterCondition=RAIDLevel = 'RAID5(3D+1P)' AND ArrayGroup = '1-10-1' description= D:\> 4-2-2 DeleteStorageTier The DeleteStorageTier command can be used to delete
Table 4-25 Items Output by the DeleteStorageTier Command Type of Information Item Name Description Output by -d Storage tier information name The name of the deleted storage tier. -d filterCondition Filter conditions for the storage tier. -d description A description of the storage tier. -d Legend: -d indicates output only when either the -d or the --detail option is specified.
Table 4-27 Parameters of the GetStorageTiers Command Parameter name Optional or Required Description storagedomainname Required Specify the name of the storage domain. name Optional Specify the name of the storage tier for which you want to obtain information. If this is omitted, this command will be applied to all storage tiers in the storage domain. When specifying multiple storage tier names, separate each with a comma.
An instance of StorageTier(1 of 2) name=MegaTech-HighCost filterCondition=RAIDLevel = 'RAID5(3D+1P)' AND Capacity < '1GB' numberOfVolumes=91 totalCapacityInGB=387 totalCapacityPercentageToStorageDomain=5 usedCapacityInGB=29 usedCapacityPercentage=8 freeCapacityInGB=358 freeCapacityPercentage=92 description= An instance of StorageTier(2 of 2) name=MyStorageTier filterCondition=RAIDLevel <> 'RAID5(3D+1P)' numberOfVolumes=2 totalCapacityInGB=9 totalCapacityPercentageToStorageDomain=1 usedCapacityInGB=0 usedCap
totalCapacityInGB=9 totalCapacityPercentageToStorageDomain=1 usedCapacityInGB=0 usedCapacityPercentage=0 freeCapacityInGB=9 freeCapacityPercentage=100 D:\> Example (3): In this example, to obtain summary information for all storage tiers in the storage domain MegaTechXP12000-Secondary, the GetStorageTiers command is executed without specifying the storage tier name. However, no storage tier exists.
Table 4-30 Parameters of the ModifyStorageTier Command Parameter Name Optional or Required Description newname Optional Specify a new storage tier name. This name should be unique within the storage domain. If this is omitted, the name of the storage tier will not change. newfiltercondition Optional Specify a filter condition. For details about the property specified in the newfiltercondition parameter, see Table 4-31. If this is omitted, the filter condition will not be updated.
description= D:\> 4-2-5 GetVolumes (with storagetiername Specified) The GetVolumes command with storagetiername parameter specified can be used to obtain a list of volumes (LUs) in the storage tier of the storage domain to specify. You can also limit the volumes obtained, by specifying a volume filter condition. For details about how to specify options, parameters, and filter conditions, or about the items output by this command, see the GetVolumes command in the Storage Domain Management section 4-1-5 .
Table 4-33 Options of the CreateMigrationGroup Command Option Name Option Arguments Optional or Required Description -d or --detail None Optional Specify this to output information about the created migration group to the standard output, after command execution. If this is omitted, nothing is output to the standard output. Table 4-34 Parameters of the CreateMigrationGroup Command Parameter Name Optional or Required Description storagedomainname Required Specify the name of the storage domain.
Command Syntax htsmcli server-location DeleteMigrationGroup { -u | --username } user-name { -p | --password } { password | @name-of-password-file } [ { -o | --output } name-of-the-standard-output-redirect-file ] [ { -d | --detail } ] storagedomainname=storage-domain-name name=migration-group-name Table 4-36 Options of the DeleteMigrationGroup Command Option Name Option Arguments Optional or Required Description -d or --detail None Optional Specify this to output information about the deleted migratio
Information cannot be obtained for migration groups in storage domains that are being refreshed. Command Syntax htsmcli server-location GetMigrationGroups { -u | --username } user-name { -p | --password } { password | @name-of-password-file } [ { -o | --output } name-of-the-standard-output-redirect-file ] [ { -d | --detail } ] storagedomainname=storage-domain-name [ name=migration-group-name [ , migration-group-name ] ...
Table 4-41 Items Output by the GetMigrationGroups Command Type of Information Item Name Description Output by -d lastMigrationTime The date and time when migration was performed for the storage tier specified in targetStorageTierName. If the previous migration has not finished, this is blank. If a new migration task is created, this is blank. migrationStatus The status of the migration task. If migration has not previously been performed, this is blank.
migrationStatus= numberOfVolumes=0 description=MigrationGroup01 An instance of MigrationGroup(2 of 2) name=MyGroup targetStorageTierName= canMigrate=Yes totalCapacityInGB=0 lastModifyUserGroup=Admin creationTime=2005/03/31 12:06:41 lastModifyTime=2005/03/31 12:06:41 lastMigrationTime= migrationStatus= numberOfVolumes=0 description=MyMigrationGroup D:\> Example (2): In this example, summary information is obtained for all migration groups in the MegaTechXP12000-Primary storage domain.
Example (3): In this example, to obtain summary information for all migration groups in the storage domain MegaTechXP12000-Secondary, the GetMigrationGroups command is executed without specifying the migration group name. However, no migration group exists.
Table 4-44 Items Output by the ModifyMigrationGroup Command Type of Information Item Name Description Output by -d Storage domain information name The name of the storage domain. -d Migration group information name The name of the migration group. -d canMigrate Indicates whether migration is possible. -d description A description of the migration group. -d Legend: -d indicates output only when either the -d or the --detail option is specified.
Table 4-45 Options of the AddVolumeToMigrationGroup Command Option Name Option Arguments Optional or Required Description -d or --detail None Optional Specify this to output information about the volume added to the migration group, to the standard output, after command execution. If this is omitted, nothing is output to the standard output.
Example: In this example, a volume is added to the MG011 migration group in the MegaTechXP12000Primary storage domain. The controller LDEV number for the added volume in the domain control storage subsystem is 3:A6.
{ -p | --password } { password | @name-of-password-file } [ { -o | --output } name-of-the-standard-output-redirect-file ] [ { -d | --detail } ] storagedomainname=storage-domain-name name=migration-group-name cotrollerdevicenumber=controller-LDEV-number Table 4-48 Options, RemoveVolumeFromMigrationGroup Command Option Name Option Arguments Optional or Required Description -d or --detail None Optional Specify this to output information about the volume removed from the migration group, to the standard
Table 4-50 Output, RemoveVolumeFromMigrationGroup Command Type of Information Item Name Description Output by -d hostNames The host name. If multiple host names exist, they are separated by commas (,). -d Displayed as Unknown #1 Legend: -d indicates output only when either the -d or the --detail option is specified. #1 Unknown is output when volume information cannot be obtained for the domain control storage subsystem.
Command Syntax htsmcli server-location Getvolumes { -u | --username } user-name { -p | --password } { password | @name-of-password-file } [ { -o | --output } name-of-the-standard-output-redirect-file ] [ { -d | --detail } ] storagedomainname=storage-domain-name [ { storagetiername=storage-tier-name | migrationgroupname=migrationgroup-name } ] [ filtercondition=filter-condition ] 4-4 Migration Commands This section includes a detailed description for each migration command.
migrationgroupname=migration-group-name targetstoragetiername=target-storage-tier-name [ filtercondition=filter-condition ] Table 4-51 Parameters of the CreateMigrationPlan Command Parameter Name Optional or Required Description storagedomainname Required Specify the name of the storage domain. migrationgroupname Required Specify the name of the migration group.
Table 4-53 Items Output by the CreateMigrationPlan Command Type of Information Item Name permitCrossSlprMigration permitCrossClprMigration Information about each volume pair for migration Indicates whether migration is permitted for transferring volume data between SLPRs. Yes: permitted. No: not permitted. # Indicates whether migration is permitted for transferring volume data between CLPRs. Yes: permitted. No: not permitted.
# LUSE=No # LU=3:A7 # emulationType=OPEN-V # CVS=Yes # capacityInKB=10,240,320 # SLPRNumber=0 # CLPRNumber=0 # cacheMode=Disable # IOSuppressionMode=Disable sourceControllerDeviceNumber=3:A7 targetControllerDeviceNumber=2:84 # Target candidates for source LDEV - 3:A7, 3:A6 # emulationType=OPEN-V # CVS=Yes # capacityInKB=10,240,320 # subsystem=USP#14011 # SLPRNumber=0 # CLPRNumber=0 # arrayGroupName=1-10-1 # diskType=FC # RAIDLevel=RAID5(3D+1P) # cacheMode=Disable # I
# targetControllerDeviceNumber=2:A5 # targetControllerDeviceNumber=2:A6 # targetControllerDeviceNumber=2:A7 D:\> Example (2): In this example, the conditions for creation of the candidate migration plan are the same as in example (1), but some of the candidate migration target volumes cannot be found.
pair # LUSE=No # LU=3:A7 # emulationType=OPEN-V # CVS=Yes # capacityInKB=10,240,320 # SLPRNumber=0 # CLPRNumber=0 # cacheMode=Disable # IOSuppressionMode=Disable sourceControllerDeviceNumber=3:A7 targetControllerDeviceNumber=2:84 # Target candidates for source LDEV - 3:A7, 3:A6 # emulationType=OPEN-V # CVS=Yes # capacityInKB=10,240,320 # SLPRNumber=0 # CLPRNumber=0 # arrayGroupName=1-10-1 # diskType=FC # RAIDLevel=RAID5(3D+1P) # cacheMode=Disable # IOSuppressionMode=Di
# targetControllerDeviceNumber=2:A4 # targetControllerDeviceNumber=2:A5 # targetControllerDeviceNumber=2:A6 # targetControllerDeviceNumber=2:A7 KATS10601-E An attempt to create a candidate migration plan has failed. There is a pair for which a target volume was not found. D:\> 4-4-2 CreateMigrationTask The CreateMigrationTask command can be used to create a migration task to perform migration using the specified migration plan.
Table 4-55 Parameters of the CreateMigrationTask Command Parameter Name Optional or Required Description erasedata Optional Specify whether the data for the migration source volume is to be deleted once after migration task creation terminates normally. • Yes: Delete the data. (default) • No: Do not delete the data. description Optional Specify a description of the migration task.
sourceControllerDeviceNumber=3:A7 targetControllerDeviceNumber=2:84 D:\> 4-4-3 GetTasks The GetTasks command can be used to obtain information about the task specified by the id parameter, or about tasks that match other specified parameters. You can also specify a range of tasks by using the status parameter, which indicates the task status.
Table 4-58 Parameters of the GetTasks Command Parameter Name Optional or Required Description targetstoragetiername Optional Specify the name of the migration target storage tier, along with storagedomainname. status Optional Specify the status of the task. This can be any of the following: Standby Active.WaitingMigration (waiting for migration) Active.Migrating Active.WaitingDataErasure (waiting for erasure) Active.DataErasing Success (ended in success) Failure.
Table 4-59 Items Output by the GetTasks Command Type of Information Item Name Description Output by -d creationTime The date and time when the task was created. executionRequestTime The execution request time and date for the task. endTime The date and time when task execution ended. migrationStartedTime The date and time when migration execution started. migrationCompletionTi The date and time when migration execution completed.
Table 4-59 Items Output by the GetTasks Command Type of Information Item Name Description Output by -d sourceSubsystemName The name of the storage subsystem on which data is actually -d stored for the migration source volume. If the subsystem name is unknown, the product name and serial number are displayed. sourcesubsystemVendor The vendor name of the storage subsystem in which actual data is stored.
Table 4-59 Items Output by the GetTasks Command Type of Information Item Name Description Output by -d status The migration status for each volume: -d Standby Active.WaitingMigration (waiting for migration) Active.Migrating Active.WaitingDataErasure (waiting for erasure) Active.DataErasing Success (ended in success) Failure.MigrationFailure (ended in migration failure) Failure.
totalCapacityInGB=19 description= List of 2 MigrationInfo elements: An instance of MigrationInfo(1 of 2) sourceControllerDeviceNumber=3:A6 sourceSubsystemSerialNumber=14011 sourceSubsystemModel=USP sourceSubsystemDisplayModel=XP12000 sourceSubsystemName=XP12000@10.208.151.
sourceSLPRNumber=0 sourceCLPRNumber=0 sourceRaidLevel=RAID5(3D+1P) sourceDiskType=Unknown sourceControllerArrayGroupName=E9980-1 sourceArrayGroupName=1-9-1 targetControllerDeviceNumber=2:84 targetSubsystemSerialNumber=14011 targetSubsystemModel=USP targetSubsystemDisplayModel=XP12000 targetSubsystemName=XP12000@10.208.151.
storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 targetStorageTierName=MegaTech-HighCost eraseData=No totalCapacityInGB=19 description= D:\> Example (3): In this example, to obtain summary information for all the tasks that finished 5 days ago or before among the tasks in the storage domain MegaTechXP12000-Secondary, the GetTasks command is executed. However, no task that matches the conditions exists.
Table 4-62 Items Output by the ModifyTask Command Type of Information Item Name Description Output by -d Task information id The task ID. -d The task ID format is TK########. The time and serial number are converted to base 36 and displayed in the format ########. status The status of the task: Standby Active.WaitingMigration (waiting for migration) Active.Migrating Active.WaitingDataErasure (waiting for erasure) Active.DataErasing -d creationTime The date and time when the task was created.
An instance of MigrationInfo(2 of 2) sourceControllerDeviceNumber=3:A7 targetControllerDeviceNumber=2:84 D:\> 4-4-5 ExecuteTask The ExecuteTask command can be used to request execution of a specified task in the Standby status, on the Tiered Storage Manager server. Task execution is performed asynchronously to this command. Execution cannot be requested on the Tiered Storage Manager server, for a task in a storage domain that is being refreshed.
Table 4-64 Items Output by the CancelTask Command Parameter Name Optional or Required Description id Required Specify the task ID. Example: In this example, the task whose ID is TK1ev677gu is cancelled. D:\>htsmcli CancelTask id=TK1ev677gu Output: No output is generated by this command. 4-4-7 DeleteTasks The DeleteTasks command can be used to delete a task, specified by the id parameter, that has the ended status (End).
Table 4-66 Parameters of the DeleteTasks Command Parameter Name Optional or Required Description storagedomainname Optional Specify the name of the storage domain. This must be specified when migrationgroupname or targetstoragetiername is specified. migrationgroupname Optional Specify the name of the migration group, along with storagedomainname. targetstoragetiername Optional Specify the name of the migration target storage tier, along with storagedomainname.
Table 4-67 Items Output by the DeleteTasks Command Type of Information Item Name Description DataErasureStartedTime The date and time when erasure execution started. DataErasureCompletionTime The date and time when erasure execution completed. DataErasureProgress Indicates the erasure progress, as a percentage. Values less than 1% are rounded down to display an integer. ownerId The user ID of the user that created the task. ownerGroupId The user group ID of the user that created the task.
targetStorageTierName=MegaTech-HighCost eraseData=No totalCapacityInGB=19 description=This property was changed.
5 Tiered Storage Manager Properties Files This chapter describes the properties files for the Tiered Storage Manager CLI. • 5-1 Overview of Properties for Tiered Storage Manager CLI • 5-2 Specifying Values in the htsmcli.properties File • 5-3 Specifying Values in the htsmclienv.properties File 5-1 Overview of Properties for Tiered Storage Manager CLI There are two kinds of properties for the Tiered Storage Manager CLI: those stored in the htsmcli.properties file, and those stored in the htsmclienv.
Type Properties pertaining to the trace log of the CLI File Name htsmclienv.properties Property For Details: parameter.parametername See section 5-2-5 logger.fileCount See section 5-3-1 logger.filePath See section 5-3-2 logger.maxFileSize See section 5-3-3 logger.tracelogLevel See section 5-3-4 5-2 Specifying Values in the htsmcli.
When specifying a file name, precede the file name with the @ character. When a string starting with the @ character is specified, the first line of the text file indicated by the string is treated as the password. 5-2-4 option.username Property Specify the name used to log on to the Tiered Storage Manager server. For details about how to specify the value of this property, see the explanation of the username option in section 3-3 . 5-2-5 parameter.
5-3-4 logger.tracelogLevel Property Specify the threshold for the output level of the trace log. With the Tiered Storage Manager CLI, an output level of 0, 10, 20, or 30 is set based on the contents of the log output message, regardless of whether the type of error message is Error, Warning, or Information. Only messages whose output level is less than or equal to the value set for this property are output to the trace log.
6 Troubleshooting 6-1 Troubleshooting Tiered Storage Manager CLI If a problem occurs with the Tiered Storage Manager CLI, perform the following operations: • Make sure that the cause of the problem is not the software, nor the computer nor the LAN hardware, and then restart the computer. • Make sure that no problems exist with the Tiered Storage Manager server.
Table 6-1 Troubleshooting Tiered Storage Manager CLI Problem Cause Recommended Action In Solaris or HP-UX, add the directory containing java to the environment variable PATH. The time settings on the Management Times, such as the task creation time, that are displayed by CLI commands on client differ from those on the Management server. the Management client do not match those displayed by the Web client or by CLI commands on the Management server.
API application programming interface BNF CLI GB GUI HTSM JRE KB LAN LU MB OS SAN TB TID Bachus Naur form command line interface gigabyte graphical user interface ® HP StorageWorks XP Tiered Storage Manager Java™ Runtime Environment kilobyte local area network logical unit megabyte operating system storage area network terabyte target ID Acronyms and Abbreviations Acronyms and Abbreviations Acronyms and Abbreviations 107
Index adding volume, 75 AddVolumeToMigrationGroup command, 75 argument, 39 CreateStorageTier command, 59; filtercondition parameter, 12 creating: candidate migration plan, 12, 13, 79; migration group, 12, 68; migration task, 12, 17, 85; storage domain, 11; storage tier, 11, 59 B D batch (script) file, 38 DeleteMigrationGroup command, 69 DeleteStorageDomain command, 43 DeleteStorageTier command, 61 DeleteTasks command, 97 deleting: DeleteTask command, 97; migration group, 69; migration source volume dat
ModifyStorageTier command, 65; newfiltercondition parameter, 12 ModifyTask command, 94 N newfiltercondition parameter, 12 O obtaining: list of volume (LU), 50; migration group information, 70; migration task information, 87; storage domain information, 44; storage tier information, 62 option, 27 option.output property, 102 option.password property, 102 option.username property, 103 P parameter, 27; range of specifiable value, 28 parameter.
