HP StorageWorks P9000 Tiered Storage Manager Software CLI Reference Guide Part number: TB585-96011 Third edition: April 2011
Legal and notice information © Copyright 2010-2011 Hewlett-Packard Development Company, L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice.
Contents Preface .............................................................................................. 15 1 Overview of the CLI .......................................................................... 17 List of the CLI commands ............................................................................................................ 17 Volume operations using the CLI .................................................................................................
Format of properties for which multiple elements can be specified ............................................. 41 Properties overview ................................................................................................................... 42 Range of valid property values ................................................................................................... 45 5 Details of CLI commands ................................................................... 57 Common explanation .......
Output items ............................................................................................................... 82 Example and execution results ....................................................................................... 83 DeleteMigrationGroup ........................................................................................................ 84 Syntax ........................................................................................................................
Output items ............................................................................................................. 129 Example and execution results ..................................................................................... 130 CreateShreddingTask ........................................................................................................ 131 Syntax ......................................................................................................................
Options .................................................................................................................... Parameters ................................................................................................................ Output items ............................................................................................................. Example and execution results ..................................................................................... GetPools ...............
Index ...............................................................................................
Figures 1 Flow of volume operations ........................................................................................
Tables 1 Overview of CLI commands ...................................................................................... 17 2 CLI commands and the necessary user access permissions ........................................... 31 3 Options common to all CLI commands ....................................................................... 35 4 Types of filter condition expressions ...........................................................................
31 Items output by the GetMigrationGroups command (StorageDomain instance) ................ 87 32 Items output by the GetMigrationGroups command (MigrationGroup instance) ............... 87 33 Parameters of the ModifyMigrationGroup command .................................................... 93 34 Parameters of the AddVolumeToMigrationGroup command ........................................... 95 35 Items output by the AddVolumeToMigrationGroup command (StorageDomain instance) ................................
64 Items output by the GetTasks command (unlocking task) (Task instance) ........................ 143 65 Items output by the GetTasks command (unlocking task) (ErrorInfo instance) .................. 145 66 Items output by the GetTasks command (unlocking task) (UnlockingInfo instance) ........... 145 67 Items output by the GetTasks command (shredding task) (Task instance) ....................... 145 68 Items output by the GetTasks command (shredding task) (ErrorInfo instance) .................
97 Properties for the CLI ............................................................................................. 212 98 Correspondence between properties in the htsmcli.properties file and CLI command arguments ............................................................................................................ 213 99 Example settings of property values in the htsmcli.properties file .................................. 213 100 Example settings of property values in the htsmclienv.
Preface This guide explains how to migrate data from one storage system parity group to another using the HP StorageWorks P9000 Tiered Storage Manager command line interface (CLI). Besides command syntax and parameters, topics include CLI requirements, setup, and troubleshooting.
Preface
1 Overview of the CLI This chapter contains a list of the CLI commands and gives an overview of volume operations. List of the CLI commands The CLI enables you to obtain storage domain information, create storage tiers and migration groups, as well as migrate, shred, lock, and unlock volumes. The following table provides an overview of each command. Table 1 Overview of CLI commands Category Command name Description GetStorageDomains Obtains information about storage domains.
Category Command name Description 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.
Volume operations using the CLI The following figure shows the flow of volume operations when the CLI is used. Figure 1 Flow of volume operations You can even execute tasks as you create them. The GUI can be used in the same manner as the CLI to perform operations on volumes. However, only the CLI can lock, unlock, and shredding tasks. These tasks cannot be created from the GUI.
Overview of the CLI
2 Preparations for executing the CLI This chapter explains what must be done before starting up the CLI. More specifically, this chapter explains how to set up the CLI and an environment for the CLI. Setting up the CLI You can operate the CLI on both a management server and a management client. This section describes how to set up the CLI on a management client. When you execute commands on the management server, you do not need to set up the CLI.
3. Unzip the transferred setup file in the Windows system drive. After the setup file is unzipped, several files will be stored on the system drive, such as the batch file for setup, the batch file for uninstallation, the batch file for running the CLI, and the properties files. 4. Execute the batch file for setup (setup.bat) from the command prompt. system-drive\TieredStorageManager\Tiered-Storage-Manager-version\Setup\setup.bat The setup.
2. Use FTP or some sort of external storage media to transfer the setup file from the management server of Tiered Storage Manager software to the management client. You can transfer the setup file to any location, such as /tmp.
Uninstalling the CLI To uninstall the CLI, you must execute the batch file or shell script for uninstallation. If you uninstall the CLI, the files for the CLI are deleted and the common library for collecting trace information is uninstalled. The uninstallation batch file or shell script is located in the same directory as the batch file or shell script for setup. Uninstalling the CLI from a Windows system To uninstall the CLI from a Windows system: 1. Back up the htsmcli.properties file.
2. Execute the shell script for uninstallation (unsetup.sh). /opt/TieredStorageManager/Tiered-Storage-Manager-version/Setup/unsetup.sh The common library for collecting trace information is uninstalled, and the files and directories unzipped from the setup file during the setup are deleted. Preparations after setup This section explains the preparations that must be made to execute the CLI commands after you have set up the CLI. Setting up the htsmcli.
Environment settings for encoding a password There are two levels for encoding passwords, NORMAL and HIGH. If you encode a password in the NORMAL level, environment settings are not required. For details about how to change the encoding level to HIGH for generating a safer and more secure character string, see the HP StorageWorks P9000 Command View Advanced Edition Suite Software Administrator Guide.
When the htsmaccount command is executed, a message appears prompting you to enter the password. If you enter the password twice, that password is encoded and then automatically set for the option.password2 property in the htsmcli.properties file. If a password has been set for the option.password or option.password2 property in the htsmcli.properties file, enter that password when you execute the htsmaccount command.
NOTE: When connecting to the Tiered Storage Manager server, which exists outside the firewall, you need to adjust the firewall settings so that the CLI can use java.exe. Setting up SSL communication For SSL communication with a Tiered Storage Manager server, the CLI needs to have the same electronic certificate as the server. SSL communications at different security levels require different electronic certificate content. To use SSL communication or change security levels for SSL communication: 1.
Since the default unit for this value is bytes, add k or K to specify kilobytes, or m or M to specify megabytes. If the amount of memory set for HTSM_CLI_MEM_SIZE is not enough for CLI execution, the CLI will display the following error message, and then terminate: A java.lang.OutOfMemoryError exception occurred in the main thread. <> If the above error occurs, increase the value of HTSM_CLI_MEM_SIZE, and run the CLI again.
Preparations for executing the CLI
3 Using CLI commands This chapter provides the information required to use CLI commands. This chapter also explains the user permissions, storage location, syntax, and parameter formats of CLI commands. CLI commands and user permissions Before executing Tiered Storage Manager software commands, assign the Device Manager role for the All Resources resource group to the user groups to which users who will execute commands belong.
Permission Command name Admin Modify Execute View GetPools Y Y Y Y GetStorageDomains Y Y Y Y GetStorageTiers Y Y Y Y GetTasks Y Y Y Y GetVolumes Y Y Y Y ModifyMigrationGroup -- Y -- -- ModifyStorageDomain Y Y -- -- ModifyStorageTier -- Y -- -- ModifyTask -- Y -- -- Refresh Y Y -- -- RemoveVolumeFromMigrationGroup -- Y -- -- StopTask -- Y -- -- Legend: Y: Command can be executed. --: Command cannot be executed.
# ./htsmcli arguments If you execute a command without specifying any arguments in the command line, the CLI version and the syntax for displaying Help are displayed. NOTE: Note the following points on CLI execution: • If you have cancelled a CLI command by using the Ctrl + C keys or by closing the window, the command execution result cannot be checked. In such a case, execute a command such as GetTasks to check the command execution result.
If the value of an argument specified in the htsmcli.properties file and the value specified on the command line differ, the value specified from the command line takes precedence over the value in the property file. The descriptions of each argument are provided below. server-location Specify the location of the Tiered Storage Manager server by using the following format: rmi://host-name-or-IP-address:port/HTSMServer (For example, specify a value such as rmi://myhost.mydomain:20352/HTSMServer.
Options common to all CLI commands There are two kinds of options: those used for all CLI commands, and those used for only some CLI commands. This subsection describes the options used for all CLI commands. If an argument needs to be specified after an option, specify the argument as a single character string. Arguments that contain spaces should be enclosed in quotation marks, or whatever is appropriate for the command execution environment. For example: --output "C:\My Documents\redirect.
The --password option or the option.password property in the htsmcli.properties file, which corresponds to the --password option, can be used to specify a plain-text password. The htsmaccount command can be used to specify an encoded character string. Specify a password via the method of your choosing. For details on how to specifying encoded character string passwords, see “Encoding the password in the properties file or password file” on page 25.
CLI command return responses and output information The CLI returns a return value after it has finished executing a process. The following two types of CLI return values exist: • If the return value is 0 or a positive value, the CLI has terminated normally. • If the return value is a negative value, an error (such as a parameter error) was detected in the CLI process. When the CLI terminates normally, the processing results of the command are output to the standard output.
Using CLI commands
4 Filter conditions that can be used in the CLI This chapter provides an overview of the filter condition expressions that can be specified for the filtercondition parameter and the newfiltercondition parameter, and describes the syntax and properties that can be specified for filter condition expressions.
Filter name and function Filter condition expressions for pools Description and commands that have access to the filter Filter condition expressions used to filter pools in storage domains (pool-filter-condition) Command that has access to the filter:GetPools Filter condition expressions for unused capacity Filter condition expressions used to filter unused capacity in storage systems registered in Device Manager (unused-capacityfilter-condition) Specifiable properties See Table 6 and Table 9.
The following is an explanation of repetitive specifications: • Curly brackets ({}) indicate 0 or more repetitions. • One filter condition expression can contain a maximum of 30 comparison-predicate values. NOTE: Unknown cannot be specified for literal. Note that the displayed Unknown might mean that either the value is unknown or the character string is Unknown.
If a value consists of an element that contains one or more commas: Enclose the element in single quotation marks, and then add another single quotation mark for each single quotation mark. After that, enclose the entire value in single quotation marks. The following example shows how to specify an element that contains a comma: Example - When an element contains a comma (e.g., A,B): 1. Enclose the element A,B in single quotation marks (i.e., 'A,B'). 2.
Property name Description BusinessCopy Business Copy volume type ( BusinessCopyXP ) Capacity The volume capacity CLPRNumber The CLPR number ConsumedCapacity The used capacity of the volume ConsumedCapacityPercentage The percentage of the volume that is being used ContinuousAccessAsynchronous ( ContinuousAccessXPAsynchronous ) ContinuousAccessJournal ( ContinuousAccessXPJournal ) Continuous Access Asynchronous volume type Continuous Access Journal volume type ContinuousAccessSynchronous ( Cont
Property name Description PVolMUNumber#1 If the volume is a Business Copy S-VOL, this is the MU number of the corresponding P-VOL.
Property name Description The over-provisioning percent OverProvisioningPercent OverProvisioningWarning The over-provisioning percent indicates the ratio between the THP pool capacity and the total THP volume capacity allocated to the THP pool.
For details about the restrictions on specifying other spaces, empty character strings, or symbolic characters, or about whether the specifiable character string is case sensitive, see Table 11.
Property name Operators ContinuousAccessSynchronous ( ContinuousAccessXPSynchronous ) Specifiable characters or values Simplex =, <> P-VOL S-VOL For GetStorageArray (subtarget=ArrayGroup) in Device Manager CLI, specify the value displayed for the displayName attribute of the ArrayGroup object. You can specify the following characters: A to Z a to z 0 to 9 =, <>, ControllerArrayGroup Hyphen (-) startsWith, Underscore (_) contains Period (.
Property name Operators Specifiable characters or values DiskCapacityInGB#3 <, <=, =, <>, >, >= An integer from 0 to 2,147,483,645 DiskRPM <, <=, =, <>, >, >= An integer from 0 to 2,147,483,645 FC AT DiskType =, <> SAS SSD - EmulationType =, <> For GetStorageArray (subtarget=LogicalUnit) in Device Manager CLI, specify the value displayed for the emulation attribute of the LogicalUnit object. A maximum of 75 bytes can be specified.
Property name Operators Specifiable characters or values You can specify the following characters: A to Z a to z 0 to 9 Hyphen (-) #1 PVolMigrationGroup =, <> Underscore (_) Period (.) At sign (@) Space character ( ) Non-ASCII characters A maximum of 75 bytes can be specified. PVolMUNumber#1 =, <> An integer from 0 to 2 For GetStorageArray (subtarget=LogicalUnit) in Device Manager CLI, specify the value displayed for the raidType attribute of the LogicalUnit object.
Property name Operators =, <>, SubsystemSerialNumber startsWith, contains Specifiable characters or values For GetStorageArray in Device Manager CLI, specify the value displayed for the serialNumber attribute of the StorageArray object. A maximum of 150 bytes can be specified. SubsystemVendor =, <> For GetStorageArray in Device Manager CLI, specify the value displayed for the vendor attribute of the VolumeConnection object. A maximum of 150 bytes can be specified.
volves dividing the drive capacity by 1,048,576 (1,024 x 1,024) and then rounding to the nearest integer. #4 This property is provided to maintain compatibility with previous versions. To specify a new filter condition, use SubsystemDisplayModel. Table 9 Range of valid property values for pool filter conditions Property name Operators Specifiable values or characters Specify a positive integer, or a positive integer with a unit. (For example, 256, 500KB, or 10MB.
Property name Operators Specifiable values or characters Specify a positive integer, or a positive integer with a unit. (For example, 256, 500KB, or 10MB.) Capacity =, <>, >, >=, <, <= • An integer from 0 to 9,223,372,036,854,775,807KB • The units you can specify are KB, MB, GB, and TB. KB is the default unit.
Property name SubsystemVendor Operators Specifiable values or characters =, <> For GetStorageArray in Device Manager CLI, specify the value displayed for the vendor attribute of the VolumeConnection object. A maximum of 150 bytes can be specified. Specify a positive integer, or a positive integer with a unit. (For example, 256, 500KB, or 10MB.) TotalFreeCapacity =, <>, >, >=, <, <= • An integer from 0 to 9,223,372,036,854,775,807KB • The units you can specify are KB, MB, GB, and TB.
Property name Characters that cannot be specified • You cannot add a plus sign (+) to the value. ConsumedCapacity • -0 is treated as 0. • The value cannot contain space characters. • The value is not case sensitive. • You cannot add a plus sign (+) to the value. ConsumedCapacityPercentage • -0 is treated as 0. ContinuousAccessAsynchronous ( ContinuousAccessXPAsynchronous ) ContinuousAccessJournal ( ContinuousAccessXPJournal ) • A space character cannot be used in the middle of a character string.
Property name Characters that cannot be specified OverProvisioningWarning • You cannot add a plus sign (+) to the value. PoolFreeCapacity • -0 is treated as 0. • Space characters cannot be used. • The value is not case sensitive. • Specify characters other than commas (,). PoolId • Space characters between elements are disregarded. -- PortHostStorageDomain PVolMigrationGroup A value must be specified. PVolMUNumber • -0 is treated as 0. • You cannot add a plus sign (+) to the value.
--: Indicates that there are no restrictions on specifiable characters. ( ): Indicates the character string that is used for XP12000/XP10000/SVS200.
5 Details of CLI commands This chapter explains all the functions, specifiable options and parameters, and output items for every CLI command. The chapter also provides examples of how to use each CLI command and the corresponding execution results. Common explanation For each command, the syntax, options, parameters, output items, specification examples, and execution results are provided. For syntax explanations, options that are common to all the commands are written as common-option.
Parameters Parameters do not have to be specified. Table 12 Parameters of the GetStorageDomains command Parameter Details Specify the name of the storage domain about which you want to obtain information. If this is omitted, this command will be applied to all storage domains. name To specify multiple storage domains, separate each name with a comma. No more that 255 storage domains can be specified, limited only by the maximum number of characters allowed by the command line.
Item Description The refresh status. This can be any of the following: • NotInitialized • Processing • Success refreshStatus • Failure • Incomplete (ended without completing refresh) • RefreshRequired [lastRefreshedTime] The date and time when the previous refresh finished. If the previous refresh has not finished, nothing is displayed.
RESPONSE: List of 2 StorageDomain elements: An instance of StorageDomain(1 of 2) name=MegaTechXP12000-Primary totalCapacityInGB=8,552 usedCapacityInGB=6,576 usedCapacityPercentage=77 freeCapacityInGB=1,975 freeCapacityPercentage=23 numberOfSubsystems=2 numberOfStorageTiers=0 numberOfMigrationGroups=0 refreshStatus=Success lastRefreshedTime=2011/04/19 21:43:13 controllerSerialNumber=14011 controllerDisplayModel=XP12000 controllerName=XP12000@10.208.151.
totalCapacityInGB=8,552 usedCapacityInGB=1,616 usedCapacityPercentage=45 freeCapacityInGB=1,976 freeCapacityPercentage=55 numberOfStorageTiers=25 numberOfMigrationGroups=13 refreshStatus=Success An instance of StorageDomain(2 of 2) name=MegaTechXP12000-Secondary totalCapacityInGB=Unknown usedCapacityInGB=Unknown usedCapacityPercentage=Unknown freeCapacityInGB=Unknown freeCapacityPercentage=Unknown numberOfStorageTiers=3 numberOfMigrationGroups=3 refreshStatus=Failure List of 1 ErrorInfo elements: An instanc
• Storage domains whose refresh status is NotInitialized, Processing, or Failure You can use the GetTasks command to check the status of tasks. If this command is executed for a storage domain that requires a refresh, a warning message will be output to the standard error output.
Item Description controllerDisplayModel The model name displayed on the domain controller controllerName The name of the domain controller logicalDKCNumber The logical DKC number of the domain controller. If the storage system is not HP P9500 or XP24000/XP20000, nothing is displayed. description A description of the storage domain NOTE: Unknown is output for some output items when the refresh status is NotInitialized, Processing, or Failure.
RESPONSE: An instance of StorageDomain(1 of 1) name=MyStorageDomain controllerSerialNumber=14011 controllerDisplayModel=XP12000 controllerName=XP12000@10.208.151.
In this example, the Refresh command is issued for the MegaTechXP12000-Primary storage domain, and configuration information is re-obtained from Device Manager and registered in the Tiered Storage Manager repository. htsmcli Refresh storagedomainname="MegaTechXP12000-Primary" • Execution results: No information is output by this command. Use the GetStorageDomains command to check whether the refresh has finished.
Parameters Table 18 Parameters of the CreateStorageTier command Parameter Details storagedomainname Specify the name of the storage domain. Specify the name of the storage tier to be created. name This name should be unique within the storage domain. Specify the type of the storage tier to be created. If you omit this, the condition specified in the filtercondition parameter will be used. [resource] • Volume: Filter volumes. • Pool: Filter pools. Specify a filter condition.
Parameter Details Specify the charge target for the cost of normal volumes. [chargefor] • Allocated: The volume capacity allocated to the host • Utilized: The volume capacity actually used by the host When specifying this parameter, also specify the cost parameter. Specify the cost of THP volumes. [thpcost] The method for specifying this parameter is the same as for the cost parameter. When specifying this parameter, also specify the thpchargefor parameter.
Item Description filterCondition The filter conditions for the storage tier description A description of the storage tier The cost of normal volumes is displayed in the following format: currency-code amount / unit-of-capacity / period cost If this item is not set, nothing is displayed. The charge target for normal volumes. • Allocated: The volume capacity allocated to the host chargefor • Utilized: The volume capacity actually used by the host If this item is not set, nothing is displayed.
thpcost= thpchargefor= • Command execution example (2): A storage tier that consists of volumes and whose RAID level is RAID5(3D+1P) is created in the storage domain MegaTechXP12000-Primary, which needs to be refreshed. The name of the storage tier is set as MegaTech-HighCost.
storagedomainname=storage-domain-name name=storage-tier-name Options -d or --detail Specify this to display detailed information in the standard output after CLI command execution. If you omit this option, nothing will be displayed in the standard output. Parameters Table 21 Parameters of the DeleteStorageTier command Parameter Details storagedomainname Specify the name of the storage domain. name Specify the name of the storage tier to be deleted.
In this example, a storage tier named MegaTech-HighCost is deleted from the storage domain MegaTechXP12000-Primary that needs to be refreshed.
Parameters Table 22 Parameters of the GetStorageTiers command Parameter Details storagedomainname Specify the name of the storage domain. Specify the name of the storage tier about which you want to obtain information. [name] If this is omitted, this command will be applied to all the storage tiers in the storage domain. When specifying multiple storage tier names, separate each one with a comma.
Item Description freeCapacityPercentage The ratio (percentage) of freeCapacityInGB to totalCapacityInGB. Values of less than 1% are rounded down and displayed as an integer. (For example, 45.3% is rounded down to 45%.) [numberOfManagedVolumes] The number of logical volumes in the storage tier. This provides the number of normal volumes and virtual volumes in the storage tier. totalManagedCapacityInGB The total capacity of the normal volumes and virtual volumes in the storage tier (units: GB).
Legend: [ ]: Indicates output only when either the -d or the --detail option is specified. NOTE: For storage tiers created by using pool filter conditions, a hyphen (-) is displayed for some output items because there is no relevant information to be output. Example and execution results • Command execution example (1): In this example, detailed information is obtained for both the MegaTech-HighCost and MyStorageTier storage tiers, in the MegaTechXP12000-Primary storage domain.
usedCapacityPercentage=0 freeCapacityInGB=9 freeCapacityPercentage=100 numberOfManagedVolumes=25 totalManagedCapacityInGB=1,000 usedManagedCapacityInGB=300 usedManagedCapacityPercentage=30 freeManagedCapacityInGB=700 freeManagedCapacityPercentage=70 consumedCapacityInGB=500 description= cost=USD3000/TB/Year chargefor=Allocated thpcost=USD3/GB/Year thpchargefor=Consumed • Command execution example (2): In this example, summary information is obtained for both the MegaTech-HighCost and MyStorageTier storage
freeCapacityPercentage=100 totalManagedCapacityInGB=1,000 usedManagedCapacityInGB=300 usedManagedCapacityPercentage=30 freeManagedCapacityInGB=700 freeManagedCapacityPercentage=70 consumedCapacityInGB=500 cost=USD3000/TB/Year chargefor=Allocated thpcost=USD3/GB/Year thpchargefor=Consumed • Command execution 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
freeManagedCapacityInGB=700 freeManagedCapacityPercentage=70 consumedCapacityInGB=500 cost=USD3000/TB/Year chargefor=Allocated thpcost=USD3/GB/Year thpchargefor=Consumed KATS10622-W message-contents ModifyStorageTier The ModifyStorageTier command can be used to change information (the name, filter condition, or description) of a storage tier.
Parameter Details name Specify the name of the storage tier. [newname] 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. Specify the type of the storage tier. If you omit this, the condition specified in the newfiltercondition parameter will be used. [newresource] • Volume: Filter volumes. • Pool: Filter pools. Specify a filter condition.
Parameter Details Specify the charge target for the cost of normal volume. • Allocated: The volume capacity allocated to the host • Utilized: The volume capacity actually used by the host [newchargefor]#1 You can specify an empty string for this parameter. If you specify an empty string, the old settings will be deleted. If you specify an empty string for this parameter, also specify an empty string for the newcost parameter. Specify the cost of THP volumes.
htsmcli ModifyStorageTier --detail storagedomainname="MegaTechXP12000-Primary" name="MyStorageTier" newname="OurStorageTier" • Execution results (1): RESPONSE: An instance of StorageDomain(1 of 1) name=MegaTechXP12000-Primary List of 1 StorageTier elements: An instance of StorageTier(1 of 1) name=OurStorageTier filterCondition=RAIDLevel <> 'RAID5(3D+1P)' description= cost=USD3000/TB/Year chargefor=Allocated thpcost=USD3/GB/Year thpchargefor=Consumed • Command execution example (2): In this example, the n
CreateMigrationGroup The CreateMigrationGroup command can be used to create a migration group within a storage domain. For the migration group to be created, you can use the canmigrate parameter to specify an attribute indicating whether the migration group is subject to migration operations. If you disable migration, you can prevent the volume belonging to the migration group from being migrated by mistake. In addition, you can set the LDEV selection rules for each migration group.
Parameter Details name Specify the name of the migration group to be created. This name should be unique within the storage domain. Specify whether migration is possible. This can be any of the following: [canmigrate] • Yes: Migration is possible (default). • No: Migration is not possible. [notifytourl] [reminddayslater] Specify the address to be notified when the event occurs. Specify a value by combining mailto: and the email address.
Item Description reminderDescription Description to be displayed when the specified elapsed-period event occurs arrayGroupSelectionRule Parity group selection rule arrayGroupAvoidanceOfMigrationGroups Parity group avoidance rule. If no parity group avoidance rule has been set, nothing is displayed.
arraygroupselectionrule=MinimumCoverage arraygroupavoidanceofmigrationgroups="MG012,MG013" • Execution results (2): RESPONSE: An instance of StorageDomain(1 of 1) name=MegaTechXP12000-Primary List of 1 MigrationGroup elements: An instance of MigrationGroup(1 of 1) name=MG01 canMigrate=Yes notifyToURL=mailto:test@example.com remindAt=2011/04/24 19:40:05 reminderDescription=It is scheduled to move.
• Migration groups specified for tasks that have not yet ended (End) • Migration groups within storage domains whose refresh status is either Processing or Failure • Migration groups specified as a migration target after the completion of a shredding task that has not yet ended (End) • Migration groups specified as a migration target after the completion of a locking task that has not yet ended (End) • Migration groups specified as a migration target after the completion of an unlocking task that has not ye
htsmcli DeleteMigrationGroup --detail storagedomainname="MegaTechXP12000-Primary" name="MG01" • Execution results (1): RESPONSE: An instance of StorageDomain(1 of 1) name=MegaTechXP12000-Primary List of 1 MigrationGroup elements: An instance of MigrationGroup(1 of 1) name=MG01 canMigrate=Yes notifyToURL= remindAt= reminderDescription= arrayGroupSelectionRule=MinimumCoverage arrayGroupAvoidanceOfMigrationGroups=MG012,MG013 description=MigrationGroup01 • Command execution example (2): In this example, the
Information cannot be obtained for migration groups in storage domains whose refresh status is either Processing or Failure. If this command is executed for a storage domain that requires a refresh, a warning message will be output to the standard error output. Syntax htsmcli [ server-location] GetMigrationGroups [ common-option ] [ { -d | --detail } ] storagedomainname=storage-domain-name [ name=migration-group-name [, migration-group-name ] ...
Item Description targetStorageTierName The name of the storage tier for which the migration destination was last specified. If no migration task has ever been created, nothing is displayed.
Item Description [arrayGroupSelectionRule] Parity group selection rule [arrayGroupAvoidanceOfMigrationGroups] Parity group avoidance rule. If no parity group avoidance rule has been set, nothing is displayed. [description] A description of the migration group Legend: [ ]: Indicates output only when either the -d or the --detail option is specified.
remindAt=2011/06/24 19:40:05 reminderDescription=It is scheduled to move.
totalCapacityInGB=0 numberOfManagedVolumes=25 totalManagedCapacityInGB=1,000 consumedCapacityInGB=300 • Command execution 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.
ModifyMigrationGroup The ModifyMigrationGroup command can be used to change information about a migration group.
Parameters Table 33 Parameters of the ModifyMigrationGroup command Parameter Details storagedomainname Specify the name of the storage domain. name Specify the name of the migration group. [newname] Specify a new migration group name. This name should be unique within the storage domain. If this is omitted, the name of the migration group will not change. Specify whether migration is possible. This can be either Yes or No: [newcanmigrate] • Yes: Migration is possible.
Output items The items output by the ModifyMigrationGroup command are the same as the items output by the CreateMigrationGroup command. For more information, see “Output items” on page 82 of the CreateMigrationGroup command. Example and execution results • Command execution example (1): In this example, the name, description, and number of days before the specified elapsed-period event is to occur are changed for the migration group MG01 in the storage domain MegaTechXP12000-Primary.
name=MegaTechXP12000-Primary List of 1 MigrationGroup elements: An instance of MigrationGroup(1 of 1) name=MG011 canMigrate=Yes notifyToURL=mailto:test@example.com remindAt=2011/04/28 19:40:05 reminderDescription=It is scheduled to move. arrayGroupSelectionRule=BalanceCapacity arrayGroupAvoidanceOfMigrationGroups=MG012,MG013 description=MigrationGroup011 KATS10622-W message-contents AddVolumeToMigrationGroup The AddVolumeToMigrationGroup command can be used to add a volume to the specified migration group.
Parameter Details name Specify the name of the migration group. Specify the controller logical device number in the following formats: [logical-DKC-number:]CU-number:LDEV-number controllerdevicenumber Specify hexadecimal values that are less than 0x100 and that are separated by colons (:). A 0 at the beginning of the first value can be omitted. The following are specification examples: • When omitting a logical DKC number: Specify 2:0a or 02:0A.
Item Description description A description of the migration group Table 37 Items output by the AddVolumeToMigrationGroup command (Volume instance) Item Description The controller LDEV number controllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:). emulationType The emulation type The CVS volume attribute of the volume CVS This can be either Yes or No.
htsmcli AddVolumeToMigrationGroup --detail storagedomainname="MegaTechXP12000-Primary" name="MG011" controllerdevicenumber="3:A6" movefrommigrationgroup=Yes • Execution results (1): RESPONSE: An instance of StorageDomain(1 of 1) name=MegaTechXP12000-Primary List of 1 MigrationGroup elements: An instance of MigrationGroup(1 of 1) name=MG011 canMigrate=Yes notifyToURL= remindAt= reminderDescription= arrayGroupSelectionRule=MinimumCoverage arrayGroupAvoidanceOfMigrationGroups=MG012,MG013 description=Migratio
canMigrate=Yes notifyToURL= remindAt= reminderDescription= arrayGroupSelectionRule=MinimumCoverage arrayGroupAvoidanceOfMigrationGroups=MG012,MG013 description=MigrationGroup011 List of 1 Volume elements: An instance of Volume(1 of 1) controllerDeviceNumber=3:A6 emulationType=OPEN-V CVS=Yes capacityInKB=10,240,320 RAIDLevel=RAID5(3D+1P) diskType=Unknown controllerArrayGroupName=E9980-1 arrayGroupName=1-9-1 volumeStatus=Used volumeLockStatus=Unlocked hostNames= KATS10622-W message-contents RemoveVolumeFromM
Parameters Table 38 Parameters of the RemoveVolumeFromMigrationGroup command Parameter Details storagedomainname Specify the name of the storage domain. name Specify the name of the migration group. Specify the controller logical device number in the following formats: [logical-DKC-number:]CU-number:LDEV-number controllerdevicenumber Specify hexadecimal values that are less than 0x100 and that are separated by colons (:). A 0 at the beginning of the first value can be omitted.
List of 1 Volume elements: An instance of Volume(1 of 1) controllerDeviceNumber=3:A7 emulationType=OPEN-V CVS=Yes capacityInKB=10,240,320 RAIDLevel=RAID5(3D+1P) diskType=Unknown controllerArrayGroupName=E9980-1 arrayGroupName=1-9-1 volumeStatus=Used volumeLockStatus=Unlocked hostNames= • Command execution example (2): In this example, a volume whose controller logical device number is 3:A7 is deleted from the migration group MG011 within the storage domain MegaTechXP12000-Primary that needs to be refreshed
Commands for creating tasks This section explains the CLI commands for creating tasks. CreateMigrationPlan It is too time-consuming to create pairs of migration source LDEVs and migration target LDEVs individually. You can use the CreateMigrationPlan command to make Tiered Storage Manager software automatically select all the appropriate LDEVs for migration source LDEVs.
• Item names are not case-sensitive (for example, storagedomainname and STORAGEDOMAINNAME are the same). • Item values are case-sensitive (for example, groupName_1 and GroupName_1 are different). • Lines in which the first non-space character is a hash mark (#) are treated as comments.
Type of information Item Description The target THP pool number. This item is optional. targetPoolId#4 To create and migrate a THP volume, specify the number of the migration target pool in the following format: THP x or THPx (x: 0 to 127) #1 Specify each item once at the beginning of a candidate migration plan. #2 Specify the information for all migration source volumes that belong to the specified migration group.
Legend: [ ]: Specifying this parameter is optional. Output items Table 41 Items output by the CreateMigrationPlan command (information about the overall plan) Item Description plan-type The plan type The plan format version format-version This item is displayed for compatibility between different format versions.
The output items described in Table 42 are displayed between the # Begin Profile Information and # End Profile Information lines as comments. Table 42 Items output by the CreateMigrationPlan command (migration profile information) Item Description configuration The item used to group volumes together by their emulation type, capacity#1, and CVS attribute#2 (configuration). These items are separated by a comma and single-byte space.
Item Description [ CLPRNumber ] The CLPR number [ cacheMode ] The cache mode [ IOSuppressionMode ] The IO suppression mode The controller LDEV number of the migration source volume sourceControllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:). The controller LDEV number of the migration target volume targetControllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:).
Item Description subsystem The model name of the storage system SLPRNumber The SLPR number CLPRNumber The CLPR number arrayGroupName The parity group name of the LDEV diskType The drive type RAIDLevel The RAID level cacheMode The cache mode IOSuppressionMode The I/O suppression mode The volume type This can be any of the following: xpThinProvisioning • -: Normal volumes • THP-VOL: THP volumes • THP-Pool-VOL: THP pool volumes arrayGroupBusyRate The parity group usage (%) arrayGroupMaxBu
Example and execution results • Command execution example (1): In this example, a candidate migration plan is created for when each volume in the MG011 migration group is migrated to the MegaTech-HighCost storage tier, in the MegaTechXP12000Primary storage domain.
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # LUSE=No LU=3:A7 emulationType=OPEN-V CVS=Yes capacityInKB=10,240,320 LBA=20,480,640 SLPRNumber=0 CLPRNumber=0 cacheMode=Disable IOSuppressionMode=Disable sourceControllerDeviceNumber=3:A7 targetControllerDeviceNumber=2:84 Target candidates for source LDEV - 3:A6, 3:A7 emulationType=OPEN-V CVS=Yes capacityInKB=10,240,320 LBA=20,480,640 subsystem=XP12K/10K/SVS200#14011 SLPRNumber=0 CLPRNumber=0 arrayGroupName=1-10-
htsmcli CreateMigrationPlan storagedomainname="MegaTechXP12000-Primary" migrationgroupname="MG001" targetstoragetiername="MegaTech-HighCost" • Execution results (2): If the migration target volumes (candidate volumes) include candidate volumes with the same capacities as their migration source volumes as well as candidate volumes with larger capacities than their migration source volumes: #Example plan for migration plan-type=Migration format-version=1.
# # # # # # # # # # # # # # # # # # # emulationType=OPEN-V CVS=Yes capacityInKB=10,240,320 LBA=20,480,640 subsystem=XP24000@172.16.110.
plan-type=Migration format-version=1.
# # # # # # # # # # arrayGroupName=1-6-1 diskType=RAIDLevel=RAID5(3D+1P) cacheMode=Unknown IOSuppressionMode=Unknown xpThinProvisioning=arrayGroupBusyRate= arrayGroupMaxBusyRate= targetControllerDeviceNumber=00:0A:02 * (00:0A:00) targetControllerDeviceNumber=00:0A:09 * (00:00:0E) # # # # # # # # # # # # # # # # # # Target candidates for source LDEV - 00:00:0E emulationType=OPEN-V CVS=Yes capacityInKB=10,240,320 LBA=20,480,640 subsystem=XP24000@172.16.110.
plan-type=Migration format-version=1.0 storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 targetStorageTierName=MegaTech-HighCost permitCrossSLPRMigration=No permitCrossCLPRMigration=Yes # arrayGroupSelectionRule=MinimumCoverage # arrayGroupAvoidanceOfMigrationGroups=MG012,MG013 # Begin Profile Information # List of 2 Profile elements: # An instance of Profile(1 of 2) # configuration=Open-V,4.
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 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 LBA=20,480,640 subsystem=XP12K/10K/SVS200#14011 SLPRNumber=0 CLPRNumber=0 arrayGroupName=1-10-1 diskType=FC RAIDLevel=RAID5(3D+1P) cacheMode=Disable IOSuppressionMode=Disable xpThinProvisioning=arrayGroupB
#Example plan for migration plan-type=Migration format-version=1.0 storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 targetStorageTierName=MegaTech-HighCost permitCrossSLPRMigration=No permitCrossCLPRMigration=Yes # arrayGroupSelectionRule=MinimumCoverage # arrayGroupAvoidanceOfMigrationGroups=MG012,MG013 # Begin Profile Information # List of 1 Profile elements: # An instance of Profile(1 of 2) # configuration=Open-V,4.
Creating and executing tasks The following are four different combinations of tasks that can be created via the CLI and commands used to create tasks: • Migration task (CreateMigrationTask command) • Locking task (CreateLockingTask command) • Unlocking task (CreateUnlockingTask command) • Shredding task (CreateShreddingTask command) This section contains information that is common to creating and executing tasks.
CreateMigrationTask The CreateMigrationTask command can be used to create a migration task to perform migration using the specified migration plan.
on whether Open Volume Management is installed. For details, see “Conditions for migrating data to THP pools” on page 233. CAUTION: During the execution of a migration in which a volume is re-created, if an error occurs during the processing or the processing stops in the middle, the migration target volume might remain deleted. Check the output message, and then manually create the volume.
Parameter Details Specify whether the data for the migration source volume is to be deleted once after migration terminates normally. This can be either Yes or No: • Yes: Delete the data • No: Do not delete the data [erasedata] The default value differs depending on the value of the server.migration.dataErase.defaultValue key in the server.properties file, and the value of parameter.erasedata in the htsmcli.properties file. The settings in the htsmcli.
Item Description creationTime The date and time when the task was created endTime The date and time when task execution ended ownerID The user ID of the user who created the task storageDomainName The name of the storage domain migrationGroupName The name of the migration group previousTargetStorageTierName The name of the migration target storage tier for the previous migration. If migration has never been performed before, nothing is displayed.
htsmcli CreateMigrationTask migrationplan="D:\\tmp\\plan.
• When there is no volume that can be locked in a migration group specified for the migrationgroupname parameter • The migration group specified for the movetomigrationgroupname parameter at the creation of a task is specified for the migrationgroupname parameter in a task that has not ended (End) • When any of the conditions that prevent you from creating a task described in “Creating and executing tasks” on page 118 is met A locked period can be reset if Tiered Storage Manager software is used to relock a
Parameter [retentiondays] [movetomigrationgroupname] [notifytourl] [description] Details Specify the number of days until the task can unlock the volume (the locked period). The default is 0. You can specify an integer from -1 to 21900. Specify -1 to set an infinite retention period. Specify the name of the target migration group for a volume whose locking has been completed. Specify the address to be notified when the event occurs. Specify a value by combining mailto: and the email address.
Item Description notifyToURL Event notification address description The description of the task Table 50 Items output by the CreateLockingTask command (LockingInfo instance) Item Description Controller logical device number of the volume. controllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:).
htsmcli CreateLockingTask --force storagedomainname=MegaTechXP12000-Primary migrationgroupname=MG011 guardmode=ReadOnly retentiondays=365 • Execution results (2): RESPONSE: An instance of Task(1 of 1) ID=TK1f2lymqv taskType=Locking status=Standby creationTime=2011/04/25 16:53:11 endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 retentionDays=365 retainedThrough= guardMode=Read only moveToMigrationGroupName= notifyToURL=mailto:test@example.
description= List of 2 LockingInfo elements: An instance of LockingInfo(1 of 2) controllerDeviceNumber=3:A6 An instance of LockingInfo(2 of 2) controllerDeviceNumber=3:A7 • Command execution example (4): In this example, the storage domain MegaTechXP12000-Primary, which requires a refresh, is specified as a parameter to execute the CreateLockingTask command: htsmcli CreateLockingTask storagedomainname=MegaTechXP12000-Primary migrationgroupname=MG011 • Execution results (4): The KATS50225-E and KATS50907-
Specify this option to execute the created unlocking task immediately. If this option is omitted, the unlocking task will be placed in Standby status. Parameters Table 51 Parameters of the CreateUnlockingTask command Parameter Details storagedomainname Specify the name of the storage domain. migrationgroupname Specify the name of the migration group. [movetomigrationgroupname] Specify the name of the target migration group for a volume whose unlocking has been completed.
Item Description description The description of the task Table 53 Items output by the CreateUnlockingTask command (UnlockingInfo instance) Item Description Controller logical device number of the volume. controllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:). Example and execution results • Command execution example (1): In this example, an unlocking task that unlocks volumes is created.
The KATS50226-E and KATS50907-E messages are output. CreateShreddingTask The CreateShreddingTask command can be used to create a shredding task that erases all data from a migration group. Shredding is performed for a migration group. If the migration group contains volumes that cannot be shredded (such as locked volumes), the task only erases data from shreddable volumes. You can move the shredded volumes to another migration group.
Parameter Details migrationgroupname Specify the name of the migration group. Specify the shredding pattern. This can be any of the following: [shreddingmethod] • ZERO-ONCE: The data 0 is written only once (default) • DoD: The DoD standard method is used [movetomigrationgroupname] [notifytourl] [description] Specify the name of the target migration group for a volume whose shredding has been completed. Specify the address to be notified when the event occurs.
Item Description notifyToURL Event notification address. description The description of the task Table 56 Items output by the CreateShreddingTask command (ShreddingInfo instance) Item Description Controller logical device number of the volume. controllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:). The estimated time for task execution for each volume. timeEstimate This value is displayed in hhhh:mm:ss format.
An instance of ShreddingInfo(2 of 2) controllerDeviceNumber=3:A7 timeEstimate=0:01:01 • Command execution example (2): This example uses the same conditions as those used for Command execution example (1) to create a shredding task, except that the --force option is specified.
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 use the tasktype parameter to specify the type of target task. You can also specify a range of tasks by using the status parameter, which indicates the task status.
Parameter Details storagedomainname Specify the name of the storage domain. This must be specified when migrationgroupname or targetstoragetiername is specified. migrationgroupname Specify the name of the migration group, along with storagedomainname. targetstoragetiername Specify the name of the migration target storage tier, along with storagedomainname. This parameter is used only for narrowing down the migration tasks. Specify the name of the storage system.
Output items (migration task) Table 58 Items output by the GetTasks command (migration task) (Task instance) Item Description The task ID. ID The task ID format is TK########. The time and serial number are converted to base 36 and displayed in the format ########. taskType The type of task (Migration) The task status status For details on the values displayed, see “Task statuses” on page 207. The estimated time for the task execution.
Item Description [estimatedDataErasureCompletionTime] The date and time when erasure is expected to finish zeroDataDiscardStartedTime The date and time when execution of a zero data discard task started [zeroDataDiscardCompletionTime] The date and time when execution of a zero data discard task completed zeroDataDiscardProgress Indicates the progress of a zero data discard task, as a percentage. Values of less than 1% are rounded down and displayed as an integer. (For example, 45.
The output items described in Table 59 and Table 60 below are output only if the -d or --detail option is specified. Table 59 Items output by the GetTasks command (migration task) (ErrorInfo instance) Item Description message An error message Table 60 Items output by the GetTasks command (migration task) (MigrationInfo instance) Item Description The controller LDEV number of the migration source volume.
Item Description sourceArrayGroupMaxBusyRate The maximum parity group usage rate (%) of the source volume. Up to 2 decimal places are displayed. The controller LDEV number of the migration target volume. targetControllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:).
Item Description The migration status for each volume status migrationProgress For details on the values displayed, see “Task statuses” on page 207. Indicates the migration progress for each volume, as a percentage. Values of less than 1% are rounded down and displayed as an integer. (For example, 45.3% is rounded down to 45%.) The elapsed time from the start of the task execution for each volume. This value is displayed in hhhh:mm:ss format.
Item Description The elapsed time from the starting point of the task execution. This value is displayed in hhhh:mm:ss format. timeElapsed If the elapsed time is 10,000 hours or more, 9999:59:59 is displayed. If the elapsed time cannot be acquired, n/a is displayed. If the task is not executed, nothing is displayed. endTime The date and time when task execution ended lockingProgress Indicates the progress of the locking operation (%).
The output items described in Table 62 and Table 63 below are output only if the -d or --detail option is specified. Table 62 Items output by the GetTasks command (locking task) (ErrorInfo instance) Item Description message Error message Table 63 Items output by the GetTasks command (locking task) (LockingInfo instance) Item Description Controller logical device number of the volume. controllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:).
Item Description The task status status For details on the values displayed, see “Task statuses” on page 207. creationTime The date and time when the task was created executionRequestTime The execution request time and date for the task startTime The date and time when task execution started The elapsed time from the starting point of the task execution. This value is displayed in hhhh:mm:ss format. timeElapsed If the elapsed time is 10,000 hours or more, 9999:59:59 is displayed.
The output items described in Table 65 and Table 66 below are output only if the -d or --detail option is specified. Table 65 Items output by the GetTasks command (unlocking task) (ErrorInfo instance) Item Description message Error message Table 66 Items output by the GetTasks command (unlocking task) (UnlockingInfo instance) Item Description Controller logical device number of the volume.
Item Description The task status status For details on the values displayed, see “Task statuses” on page 207. The estimated time for the task execution. timeEstimate This value is displayed in hhhh:mm:ss format. If the estimated value is 10,000 hours or more, 9999:59:59 is displayed.
The output items described in Table 68 and Table 69 below are output only if the -d or --detail option is specified. Table 68 Items output by the GetTasks command (shredding task) (ErrorInfo instance) Item Description message Error message Table 69 Items output by the GetTasks command (shredding task) (ShreddingInfo instance) Item Description Controller logical device number of the volume.
Output items (volume creation task) Table 70 Items output by the GetTasks command (volume creation task) (Task instance) Item Description The task ID. ID The task ID format is TK########. The time and serial number are converted to base 36 and displayed in the format ########. taskType The type of task (VolumeCreation) The task status status For details on the values displayed, see “Task statuses” on page 207.
The output items described in Table 71 and Table 72 below are output only if the -d or --detail option is specified.
Output items (external mapping task) Table 73 Items output by the GetTasks command (external mapping task) (Task instance) Item Description The task ID. ID The task ID format is TK########. The time and serial number are converted to base 36 and displayed in the format ########. taskType The type of task (ExternalMapping) The task status status For details on the values displayed, see “Task statuses” on page 207.
The output items described in Table 74, Table 75, and Table 76 below are output only if the -d or --detail option is specified. Table 74 Items output by the GetTasks command (external mapping task) (ErrorInfo instance) Item Description message The error message Table 75 Items output by the GetTasks command (external mapping task) (ExternalMappingInfo instance) Item Description The logical device number of the storage system.
Item Description The elapsed time from the start of the task execution for each volume. This value is displayed in hhhh:mm:ss format. timeElapsed If the elapsed time is 10,000 hours or more, 9999:59:59 is displayed. If the elapsed time cannot be acquired, n/a is displayed. If the task is not executed, nothing is displayed.
estimatedMigrationCompletionTime= dataErasureStartedTime= dataErasureCompletionTime= dataErasureProgress=0 estimatedDataErasureCompletionTime= zeroDataDiscardStartedTime= zeroDataDiscardCompletionTime= zeroDataDiscardProgress=0 estimatedZeroDataDiscardCompletionTime= ownerID=user ownerGroupID=Admin storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 previousTargetStorageTierName= targetStorageTierName=MegaTech-HighCost eraseData=No zeroDataDiscard=No totalCapacityInGB=19 notifyToURL=mailto:te
sourceSubsystemSerialNumber=14011 sourceSubsystemDisplayModel=XP12000 sourceSubsystemName=XP12000@10.208.151.151 sourceSubsystemVendor=HP sourceSubsystemDeviceNumber=3:A7 sourceSubsystemDeviceID=sourceSLPRNumber=0 sourceCLPRNumber=0 sourceRAIDLevel=RAID5(3D+1P) sourceDiskType=Unknown sourceControllerArrayGroupName=E9980-1 sourceArrayGroupName=1-9-1 sourceArrayGroupBusyRate=34.56 sourceArrayGroupMaxBusyRate=56.
creationTime=2011/04/25 16:53:11 executionRequestTime= timeElapsed= endTime= migrationStartedTime= migrationProgress=0 dataErasureStartedTime= dataErasureProgress=0 zeroDataDiscardStartedTime= zeroDataDiscardProgress=0 ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 targetStorageTierName=MegaTech-HighCost eraseData=No zeroDataDiscard=No totalCapacityInGB=19 notifyToURL=mailto:test@example.
controllerDeviceNumber=3:A6 subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12000@10.208.151.151 subsystemDeviceNumber=3:A6 subsystemDeviceID=status=Standby timeElapsed= An instance of LockingInfo(2 of 2) controllerDeviceNumber=3:A7 subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12000@10.208.151.
In this example, detailed information is acquired about the unlocking tasks in the MegaTechXP12000-Primary storage domain that were created at least 5 days ago and whose current status is Standby.
htsmcli GetTasks storagedomainname="MegaTechXP12000-Primary" status="Standby" datetype="Creation" daystobase="5" direction="After" • Execution results (6): RESPONSE: List of 1 Task elements: An instance of Task(1 of 1) ID=TK1f2lymqv taskType=Unlocking status=Standby creationTime=2011/04/25 16:53:11 executionRequestTime= startTime= timeElapsed= endTime= unlockingProgress=0 ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 moveToMigrationGroupName= notifyToURL=mailto:test@examp
migrationGroupName=MG011 shreddingMethod=ZERO-ONCE moveToMigrationGroupName=MG044 totalShreddingCapacityInGB=19 notifyToURL=mailto:test@example.com description= List of 2 ShreddingInfo elements: An instance of ShreddingInfo(1 of 2) controllerDeviceNumber=3:A6 subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12000@10.208.151.
ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 shreddingMethod=ZERO-ONCE moveToMigrationGroupName=MG044 totalShreddingCapacityInGB=19 notifyToURL=mailto:test@example.com description= • Command execution example (9): In this example, the GetTasks command is executed to acquire detailed information about tasks that were created within a 5-day period before the command is executed and whose current status is Standby.
• Command execution example (10): In this example, the GetTasks command is executed to acquire summary information about tasks that were created within a 5-day period before the command is executed and whose current status is Standby.
subsystemSerialNumber=10037 subsystemDisplayModel=XP24000 subsystemName=XP24000@10.208.115.221 subsystemVendor=HP totalCapacityInGB=19 notifyToURL=mailto:test@example.com description= List of 1 ExternalMappingInfo elements: An instance of ExternalMappingInfo(1 of 1) deviceNumber=00:03:A7 arrayGroupName=E27-20 externalSubsystemSerialNumber=14011 externalSubsystemDisplayModel=XP12000 externalSubsystemName=XP12000@10.208.151.
creationTime=2011/04/10 10:22:36 executionRequestTime= startTime= timeElapsed= endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary totalCapacityInGB=19 notifyToURL=mailto:test@example.com description= • Command execution example (13): In this example, the GetTasks command is executed to acquire summary information about all tasks in the MegaTechXP12000-Primary storage domain that ended at least 5 days ago; however, there are no tasks that satisfy the specified condition.
migrationStartedTime= migrationCompletionTime= migrationProgress=0 estimatedMigrationCompletionTime= dataErasureStartedTime= dataErasureCompletionTime= dataErasureProgress=0 estimatedDataErasureCompletionTime= zeroDataDiscardStartedTime= zeroDataDiscardCompletionTime= zeroDataDiscardProgress=0 estimatedZeroDataDiscardCompletionTime= ownerID=user ownerGroupID=Admin storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 previousTargetStorageTierName= targetStorageTierName=MegaTech-HighCost eraseDa
timeEstimate=0:01:02 An instance of MigrationInfo(2 of 2) sourceControllerDeviceNumber=3:A7 sourceSubsystemSerialNumber=14011 sourceSubsystemDisplayModel=XP12000 sourceSubsystemName=XP12000@10.208.151.151 sourceSubsystemVendor=HP sourceSubsystemDeviceNumber=3:A7 sourceSubsystemDeviceID=sourceSLPRNumber=0 sourceCLPRNumber=0 sourceRAIDLevel=RAID5(3D+1P) sourceDiskType=Unknown sourceControllerArrayGroupName=E9980-1 sourceArrayGroupName=1-9-1 sourceArrayGroupBusyRate=34.56 sourceArrayGroupMaxBusyRate=56.
controllerDeviceNumber=3:A6 subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12000@10.208.151.151 subsystemDeviceNumber=3:A6 subsystemDeviceID=capacityInKB=10,240,320 status=Standby timeElapsed= timeEstimate=0:01:01 An instance of ShreddingInfo(2 of 2) controllerDeviceNumber=3:A7 subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12000@10.208.151.
In this example, summary information is acquired about multiple types of tasks in the MegaTechXP12000-Primary storage domain that were created at least 5 days ago and whose current status is Standby.
ID=TK1f2lymqv taskType=Unlocking status=Standby creationTime=2011/04/25 16:53:11 executionRequestTime= startTime= timeElapsed= endTime= unlockingProgress=0 ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 moveToMigrationGroupName= notifyToURL=mailto:test@example.com description= ModifyTask The ModifyTask command enables you to change task information (such as the task description and event notification address).
Parameters Table 77 Parameters of the ModifyTask command Parameter Details Specify the task ID. id The task ID is displayed as an ID attribute when task information is output by executing the GetTasks command or another command. Specify the address to be notified when the event occurs. When this item is omitted, the existing event notification address remains unchanged. [newnotifytourl] Specify the address by combining mailto: and the email address character string.
Item Description notifyToURL Event notification address description The description of the task Table 79 Items output by the ModifyTask command (volume creation task) (VolumeCreationInfo instance) Item Description arrayGroupName The parity group name of the volume freeSpaceIndex The amount of the unused capacity in the volume parity group Output items (external mapping task) Table 80 Items output by the ModifyTask command (external mapping task) (Task instance) Item Description The task ID.
Example and execution results • Command execution example (1): In this example, the description of the migration task whose task ID is TK1f2lymqv is changed. htsmcli ModifyTask --detail id="TK1f2lymqv" newdescription="This property was changed.
creationTime=2011/04/25 16:53:11 endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 retentionDays=365 retainedThrough= guardMode=Read only moveToMigrationGroupName= notifyToURL=mailto:test@example.com description=This property was changed.
RESPONSE: An instance of Task(1 of 1) ID=TK1f2lymqv taskType=Shredding status=Standby timeEstimate=0:02:02 creationTime=2011/04/25 16:53:11 endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 shreddingMethod=DoD moveToMigrationGroupName=Already-Shredded-MG notifyToURL=mailto:test@example.com description=This property was changed.
htsmcli ModifyTask --detail id="TK1k7m37qq" newdescription="This property was changed." • Execution results (6): RESPONSE: List of 1 Task elements: An instance of Task(1 of 1) ID=TK1k7m37qq taskType=ExternalMapping status=Standby creationTime=2011/04/10 10:22:36 endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary subsystemName=XP24000@10.208.115.221 notifyToURL=mailto:test@example.com description=This property was changed.
Parameters Table 82 Parameters of the ExecuteTask command Parameter Details Specify the task ID. The task ID is displayed as an ID attribute when task information is output by executing the GetTasks command or another command. id Output items Nothing is output by this command. Example and execution results • Command execution example: In this example, the task whose ID is TK1ev677gu is executed. htsmcli ExecuteTask id=TK1ev677gu • Execution results: No information is output by this command.
If you omit this option, the tasks and volume tasks are not forcibly terminated. NOTE: Specifying --emergency option when Device Manager or the storage system is running normally causes the task volume to remain reserved, creating an inconsistency between Tiered Storage Manager management information and Device Manager or storage system information. After executing this option, take one of the following actions: • When there is a target storage system Refresh the storage system using Device Manager.
• When a task for which the zero data discard function is being executed is in the Active.ZeroDataDiscarding status • When a migration task for which the zero data discard function has not been specified is in the Active.DataErasing status • Stopping The tasks in this status can be stopped only if Yes is specified for the immediate parameter in a migration task. Note that processing for stopping a task is not performed the same time as the execution of this command.
NOTE: Specifying --emergency option when Device Manager or the storage system is running normally causes the task volume to remain reserved, creating an inconsistency between Tiered Storage Manager management information and Device Manager or storage system information. After executing this option, take one of the following actions: • When there is a target storage system Refresh the storage system using Device Manager. • When there is no target storage system Delete the storage system from Device Manager.
htsmcli StopTask id=TK1ev677gu • Execution results: No information is output by this command. DeleteTasks The DeleteTasks command can be used to delete a task, specified by the id parameter, that has the ended status (End). You can specify a range of tasks using the status parameter, which indicates the task status. You can also specify a type of task.
Parameters Parameters do not have to be specified. Table 85 Parameters of the DeleteTasks command Parameter Details Specify the task ID. The task ID is displayed as an ID attribute when task information is output by executing the GetTasks command or another command. id This parameter cannot be specified with other parameters. storagedomainname Specify the name of the storage domain. This must be specified when migrationgroupname or targetstoragetiername is specified.
Parameter Details Specify the type of task. This can be any of the following: • Migration • Shredding • Locking tasktype • Unlocking • VolumeCreation • ExternalMapping If the parameter is omitted, the command does not narrow down the task types. Output items The DeleteTasks command can delete multiple types of tasks. Therefore, the output items depend on the type of task. The items output by the DeleteTasks command are same as the items output when a task is created or task information is updated.
creationTime=2011/04/25 16:53:11 endTime=2011/05/02 16:53:45 ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 previousTargetStorageTierName= targetStorageTierName=MegaTech-HighCost eraseData=No zeroDataDiscard=No notifyToURL=mailto:test@example.
In this example, the cancelled unlocking tasks from the MegaTechXP12000-Primary storage domain are deleted.
List of 2 ShreddingInfo elements: An instance of ShreddingInfo(1 of 2) controllerDeviceNumber=3:A6 timeEstimate=0:01:01 An instance of ShreddingInfo(2 of 2) controllerDeviceNumber=3:A7 timeEstimate=0:01:01 Are you sure you want to delete this task? (Y/N) : • Command execution example (5): In this example, the command deletes the canceled volume creation task from the tasks.
subsystemName=XP24000@10.208.115.221 notifyToURL=mailto:test@example.com description=This property was changed. List of 1 ExternalMappingInfo elements: An instance of ExternalMappingInfo(1 of 1) externalDeviceNumber=0:28 externalDeviceID=Are you sure you want to delete this task? (Y/N) : Commands for obtaining information from the domain controller This section explains the CLI commands for obtaining information from a domain controller.
Options -d or --detail Specify this to display detailed information in the standard output after CLI command execution. If you omit this option, only summary information will be displayed. Parameters Table 86 Parameters of the GetVolumes command Parameter Details storagedomainname Specify the name of the storage domain. [storagetiername] [migrationgroupname] Specify the name of a storage tier. Note that this cannot be specified when migrationgroupname is specified.
Item Description The name of the storage system that stores the actual data. [subsystemName] If the storage system name is unknown, the product name and serial number are displayed. subsystemVendor The vendor name of the storage system that stores the actual data. migrationGroupName The name of the migration group to which the volume belongs emulationType The emulation type [CVS] The CVS volume attribute of the volume. This can be either Yes or No. The capacity of the volume (units: KB).
Item Description [program-product-name] (such as Continuous AccessSynchronous ContinuousAccess Synchronous, ContinuousAccess Asynchronous, ContinuousAccess Journal, xpSnapshot) The program product volume type. Only the names of the program products that must be displayed as LU attributes are displayed. The volume type. This can be any of the following: • -: Normal volumes xpThinProvisioning • THP-VOL: THP volumes • THP-Pool-VOL: THP pool volumes The THP pool number.
Item Description [VOLSER] Mainframe volume information (volume serial number) managed by the mainframe host Indicates whether migration is possible. This can be either Yes or No: canMigrate • Yes: Can migrate. • No: Cannot migrate. [reason] The reason for migration being impossible is displayed. For details about the displayed character strings and their descriptions, see “Reasons a migration might not be possible” on page 230.
Item Description LBA The volume capacity in blocks SLPRNumber The SLPR number CLPRNumber The CLPR number RAIDLevel The RAID level diskType The drive type diskModelName Drive model name Drive speed (rpm) diskRPM - is displayed if SSD is specified for DiskType. Indicates whether the parity group is encrypted. This can be any of the following: • Enabled: The parity group is encrypted. encryption • Disabled: The parity group is not encrypted. • -: Indicates a THP volume, V-VOL, or LUSE volume.
Item Description The LDEV number of the LU in the storage system that stores the actual data. subsystemDeviceNumber The number is displayed as a decimal number or a value that is a combination of hexadecimal values and colons (:). The device ID of the LU in the storage system that stores the actual data. subsystemDeviceID For the HP storage system, - is displayed. subsystemSerialNumber The serial number of the storage system that stores the actual data.
An instance of LogicalUnit(1 of 2) controllerDeviceNumber=1:E0 label=CIPHER subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12K/10K/SVS200#14011 subsystemVendor=HP migrationGroupName= emulationType=OPEN-V CVS=Yes capacityInKB=5,120,640 consumedCapacityInKB=2,560,320 consumedCapacityPercentage=50 RAIDLevel=Unknown diskType=Unknown diskRPM=10,000 encryption=Disabled diskCapacityInGB=4,448 arrayGroupNumber=Unknown controllerArrayGroupName=E9960-1 arrayGroupName=Unknown arrayGroupBusyR
RAIDLevel=Unknown diskType=Unknown diskModelName=DKS2C-K72FC diskRPM=10,000 encryption=Disabled diskCapacityInGB=4,448 guardMode= retainedThrough= guardDate= controllerArrayGroupNumber=0 controllerArrayGroupName=E1-1 cacheMode=Enable IOSuppressionMode=Enable subsystemDeviceNumber=1:E0 subsystemDeviceID=subsystemSerialNumber=14011 subsystemDisplayModel=128 subsystemName=128#14011 subsystemVendor=HP arrayGroupNumber=Unknown arrayGroupName=Unknown arrayGroupBusyRate= arrayGroupMaxBusyRate= An instance of Logic
logicalGroup= port/HostStorageDomain=CL1-B/HCMDS0100 SYSPLEXID/DEVN=SYS0001/1234 VOLSER=vvvvvv canMigrate=No 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 controllerDisplayModel=XP12000 controllerName=XP12000@10.208.151.
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 label=CIPHER subsystemVendor=HP migrationGroupName= emulationType=OPEN-V capacityInKB=5,120,640 consumedCapacityInKB=2,560,320 consumedCapacityPercentage=50 RAIDLevel=Unknown diskType=Unknown controllerArrayGroupName=E9960-1 arrayGroupName=Unknown arrayGroupBusyRate=32.34 arrayGroupMaxBusyRate=45.
RESPONSE: An instance of StorageDomain(1 of 1) name=StorageDomain-600 List of 1 LogicalUnit elements: An instance of LogicalUnit(1 of 1) controllerDeviceNumber=00:A1:E0 label=CIPHER subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12K/10K/SVS200#14011 subsystemVendor=HP migrationGroupName= emulationType=OPEN-V CVS=Yes capacityInKB=5,120,640 consumedCapacityInKB=2,560,320 consumedCapacityPercentage=50 RAIDLevel=Unknown diskType=Unknown diskRPM=10,000 encryption=Disabled diskCapacityI
consumedCapacityInKB=2,560,320 consumedCapacityPercentage=50 cylinders=1,770 LBA=10,241,280 SLPRNumber=0 CLPRNumber=1 RAIDLevel=Unknown diskType=Unknown diskModelName=DKS2C-K72FC diskRPM=10,000 encryption=Disabled diskCapacityInGB=4,448 guardMode= retainedThrough= guardDate= controllerArrayGroupNumber=0 controllerArrayGroupName=E1-1 cacheMode=Enable IOSuppressionMode=Enable subsystemDeviceNumber=00:A1:E0 subsystemDeviceID=subsystemSerialNumber=14011 subsystemDisplayModel=128 subsystemName=128#14011 subsyste
diskType=Unknown controllerArrayGroupName=E9960-1 arrayGroupName=Unknown arrayGroupBusyRate=32.34 arrayGroupMaxBusyRate=45.67 xpThinProvisioning=volumeStatus=Free volumeLockStatus=Unlocked hostNames= canMigrate=Yes • Command execution example (5): In this example, a volume search is performed for the storage tier MyStorageTier in the storage domain MegaTechXP12000-Primary. However, no volume that matches the specified conditions exists.
RAIDLevel=Unknown diskType=Unknown controllerArrayGroupName=E9960-1 arrayGroupName=Unknown arrayGroupBusyRate=32.34 arrayGroupMaxBusyRate=45.67 xpThinProvisioning=volumeStatus=Free volumeLockStatus=Unlocked hostNames= canMigrate=Yes KATS10622-W message-contents GetPools The GetPools command can be used to list information about THP pools within a storage domain. If this command is executed for a storage domain that requires a refresh, a warning message will be output to the standard error output.
Output items Table 91 Items output by the GetPools command (StorageDomain instance) Item Description name The name of the storage domain Table 92 Items output by the GetPools command (Pool instance) Item Description poolId The pool number The status of the pool. This can be any of the following: • Normal: The pool threshold has not been reached. status • OverThreshold: (Warning) The pool threshold (threshold1 or threshold2) has been exceeded. • Blocked: The pool is full or an error has occurred.
htsmcli GetPools storagedomainname="MegaTechXP12000-Primary" • Execution results (1): RESPONSE: An instance of StorageDomain(1 of 1) name=MegaTechXP12000-Primary List of 2 Pool elements: An instance of Pool(1 of 2) poolId=THP 1 status=Normal numberOfThpVolumes=5 capacityInKB=20,640 freeCapacityInKB=10,530 usageRate=59 threshold1=75 threshold2=80 overProvisioningPercent=90 overProvisioningWarning= overProvisioningLimit=110 CLPRNumber=1 An instance of Pool(2 of 2) poolId=THP 2 status=Normal numberOfThpVolum
In this example, information is obtained about pools within the storage domain MegaTechXP12000-Primary that needs to be refreshed.
Parameters Table 93 Parameters of the GetFreeSpaces command Parameter Details Specify the name of the storage system. subsystemname Specify the value displayed for the name attribute of the StorageArray object for GetStorageArray in Device Manager CLI. If you do not know the storage system name, specify the product name and serial number. Specify a filter condition. [filtercondition] For details on the specifiable properties, see Table 7 and Table 10.
Item Description diskCapacityInGB The drive capacity of the parity group to which the unused capacity belongs (units: GB) NOTE: If parity group information cannot be obtained, Unknown is displayed for some output items. Example and execution results • Command execution example (1): In this example, the GetFreeSpaces command obtains the information about unused capacity in the storage system XP12000@10.208.151.151. htsmcli GetFreeSpaces subsystemname="XP12000@10.208.151.
htsmcli GetFreeSpaces subsystemname="XP12000#14000" • Execution results (2): RESPONSE: List of 2 Subsystem elements: An instance of Subsystem(1 of 2) name=XP12000#14000 serialNumber=12345 List of 2 FreeSpace elements: An instance of FreeSpace(1 of 2) arrayGroupName=1-1-1 freeSpaceNumber=1 capacityInKB=22,528 totalFreeCapacityInKB=741,416,632 emulationType=OPEN-V RAIDLevel=RAID5(3D+1P) subsystemVendor=HP diskType=diskRPM=10,000 diskCapacityInGB=268 An instance of FreeSpace(2 of 2) arrayGroupName=1-1-1 free
diskType=diskRPM=10,000 diskCapacityInGB=268 • Command execution example (3): In this example, the GetFreeSpaces command obtains the information about the unused capacity in two storage systems named XP12000#14001 when one of them has no unused capacity.
htsmcli GetFreeSpaces subsystemname="XP12000@10.208.151.151" • Execution results (4): RESPONSE: (Command completed; empty list returned) Task statuses The table below lists the task statuses used by CLI commands. For some commands, you can control the command execution target by specifying task statuses for parameters. In addition, these statuses are also displayed for command output items.
Parameter Task status Description Output item GetTasks DeleteTasks Y# -- Y -- -- Y Y# -- Y Waiting for volume deletion -- -- Y Active.WaitingDeleteVolumePrecreate Waiting for volume deletion before re-creation -- -- Y Active.WaitingExternalMapping Waiting for external mapping Y# -- Y Active.WaitingMigration Waiting for migration Y# -- Y Active.WaitingPathCreation Waiting for path creation Y# -- Y Active.
Parameter Task status Description Output item GetTasks Failure.DeleteVolumeFailure Volume deletion ended in failure Failure.ExternalMappingFailure DeleteTasks -- -- Y External mapping ended in failure Y# Y# Y Failure.MigrationFailure Migration ended in failure Y# Y# Y Failure.PathCreationFailure Path creation ended in failure Y# Y# Y Failure.VolumeCreationFailure Volume creation ended in failure Y# Y# Y Failure.
Parameter Task status Description Output item GetTasks DeleteTasks Stopping.StoppingExternalMapping External mapping is being stopped. -- -- Y Stopping.StoppingPathCreation Path creation is being stopped. -- -- Y Success Success Y Y Y Unknown Unknown -- -- Y Legend: Y: A value can be specified or might be displayed. --: A value cannot be specified or displayed. # Only a lower-level status can be specified by omitting Active., Failure., or Stop..
6 CLI properties files This chapter describes how to specify options and parameters using the CLI properties files. It also explains the properties pertaining to the CLI trace log. Overview of properties files for the CLI There are two kinds of properties files for the CLI. • Properties pertaining to options and parameters for the CLI are in the htsmcli.properties file • Properties pertaining to the trace log for the CLI are in the htsmclienv.properties file By default, the files htsmcli.
These files are in the same format as Java properties files. Properties can be updated using a text editor. Each property has a name and a value, separated by an equal sign, such as foo.bar=12345. Each property is separated by a line-break, which is different for each OS. In the properties files for the CLI, any lines that start with hash marks (#) are treated as comments. Literal strings or numbers do not need to be enclosed in quotation marks.
The following table shows the correspondence between properties in the htsmcli.properties file and CLI command arguments. Table 98 Correspondence between properties in the htsmcli.properties file and CLI command arguments Property Value htsmserver.location The location of the Tiered Storage Manager server option.username --username option option.password --password option option.password2 No corresponding argument option.secure --secure option parameter.
htsmserver.location property This property specifies the location of the Tiered Storage Manager server. For details about how to specify the location of the Tiered Storage Manager server, see “CLI command syntax” on page 33. option.username property This property specifies 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 “Options common to all CLI commands” on page 35. option.
Specify true to use SSL communication. If you do not want to use SSL communication, specify something other than true or nothing at all. For details about the settings for using SSL communication, see “Setting up SSL communication” on page 28. parameter.parameter-name property This property specifies the value of a command parameter. Values specified here are applied to all commands.
logger.tracelogLevel=20 logger.fileCount=5 logger.maxFileSize=3MB logger.filePath=C:\\TieredStorageManager\\Tiered-Storage-Manager-version\\CLI\\logs\\HTSMCLITrace TIP: In Solaris, HP-UX, or Linux, CLI trace log files are output with the access permissions -rw-rw-rw-. This is because the script htsmcli is running using umask 0. logger.
Specifiable values: 2 to 16. Default: 10 logger.tracelogLevel property This property specifies the threshold for the output level of the trace log. With the CLI, an output level of 0, 10, 20, or 30 is set based on the content 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.
CLI properties files
7 Troubleshooting This chapter explains what to do when problems occur with the CLI. Troubleshooting the CLI When a problem occurs with the CLI, do the following: • Make sure that the cause of the problem is not the software, the computer, or the LAN hardware, and then restart the computer. • Make sure that no problems exist with the Tiered Storage Manager server. For details about troubleshooting specific to the CLI, see the following table.
Problem Cause Recommended action The environment variable HTSM_CLI_HOME has not been set up. Set the directory containing the htsmcli.properties file in the environment variable HTSM_CLI_HOME. Specify the path of the java command in the environment variable HTSM_CLI_JRE_PATH. If HTSM_CLI_JRE_PATH is not specified, do the following: An error occurred that indicated the specified command was not found. A path to java.exe (or java) has been specified incorrectly or has not been specified.
Problem Cause Recommended action The specified electronic certificate file cannot be read. Make sure that you have permission to access the electronic certificate file. The content of the specified electronic certificate file is invalid. The SSL communication port setting is invalid. The security level of the Tiered Storage Manager server does not match the security level of the CLI. Use the electronic certificate file downloaded from the Tiered Storage Manager server.
Troubleshooting
8 Support and other resources Numerous support options are available. Contacting HP HP technical support For worldwide technical support information, see the HP support website: http://www.hp.
Support and other resources
A Reference information during operations This appendix contains information that can be referenced when you use the Tiered Storage Manager software CLI. Values that can be used and still guarantee the Tiered Storage Manager operations To guarantee Tiered Storage Manager operations, HP recommends that you specify environment settings and perform operations within the value ranges listed below.
#2 This is the maximum value. If this value is exceeded, an error occurs. The following problems might occur if you operate Tiered Storage Manager software in an environment where one or more values exceed the above values: • The response time during Tiered Storage Manager software operations will greatly increase. • A memory shortage will occur because the amount of memory used by the Tiered Storage Manager server process, GUI process, CLI process, or Web browser will increase.
Parameter Specifiable types and length of characters A maximum of 75 bytes can be specified. • The character types that can be used are limited.# controllerserialnumber • The specified value cannot start or end with a space character. • A value must be specified. cost newcost cost - amount newcost - amount Note that a space at the beginning or end, or between each element, will be ignored. Do not use commas or periods.
Parameter Specifiable types and length of characters A maximum of 75 bytes can be specified. • The character types that can be used are limited.# migrationgroupname • The specified value cannot start or end with a space character. • A value must be specified. migrationplan Specifiable characters for and the allowable length of the file path change depending on the OS. • The value is not case sensitive. movefrommigrationgroup • The value cannot contain any space characters.
Parameter Specifiable types and length of characters resource • The value is not case sensitive. newresource • The value cannot contain any space characters. • You cannot add a plus sign (+) to the value. retentiondays • -0 is treated as 0. shreddingmethod • The value is not case sensitive. status • The value cannot contain any space characters. A maximum of 280 bytes can be specified. storagedomainname • The specified value cannot start or end with a space character.
0 to 9 Hyphen (-) Underscore (_) Period (.) At sign (@) Space character ( ) Non-ASCII characters Reference information regarding migration This section explains the reasons why a migration might not be possible, which might be displayed when executing the GetVolumes command, and the conditions that must be satisfied to specify DP pools as targets.
Displayed character string Status of the specified volume Cache LUN XP Cache Residency Manager or Cache Residency Manager for Mainframe is set for the volume. Command Device The volume is used as a command device. The volume is one of the following: • The volume is part of a Continuous Access pair, and the status is neither PSUS nor PSUE.
Displayed character string Status of the specified volume System Disk The volume is a system drive. The volume is one of the following: • The volume is the P-VOL of a Snapshot pair, its status is PAIR, and the number of generations is 64. XP Snapshot Status • The volume is the P-VOL of a Snapshot pair and its status is not PAIR. • The volume is the V-VOL of a Snapshot pair. • The volume is the POOL of a Snapshot pair.
Displayed character string Status of the specified volume The volume is one of the following: • The volume is part of a Continuous Access pair, and the status is either PSUS or PSUE. Continuous Access Synchronous (target) < Continuous Access XP Synchronous (target) > • The volume is part of a Hitachi TrueCopy for Mainframe pair, and the status is suspended. • This applies only to HP P9500 or XP24000/XP20000. The volume is part of a Continuous Access pair, and the status is Duplex.
• The maximum over-provisioning percent in the migration target pool does not exceed the upper limit for the over-provisioning percent. If the migration source includes THP pool volumes, the following condition must also be satisfied: • The same THP pool cannot contain both migration source and target volumes.
Glossary This glossary defines the special terms used in this document.letter. host group A group of hosts with WWN HBAs that are allowed to issue I/Os to specified volumes. You can specify multiple volumes. Host groups are managed by LUN Manager for the storage. host storage domain A host group. In this manual, host storage domain means the same thing as host group.
- logger.properties file - hppa.properties file The CLI properties files are the following two files: - htsmcli.properties file - htsmclienv.properties file real volume A storage system volume that has an actual capacity. In this manual, a real volume is a volume other than a virtual volume. serial number The device identification number assigned to a storage system.
Index AddVolumeToMigrationGroup, 95 cost amount, 66, 78 currency code, 66, 78 format, 66 unit of capacity, 66, 78 unit of period, 66, 78 CreateLockingTask, 123 CreateMigrationGroup, 81 CreateMigrationPlan, 102 CreateMigrationTask, 119 CreateShreddingTask, 131 CreateStorageTier, 65 CreateUnlockingTask, 128 currency code, 67 C D Symbols --emergency, 175, 177 --execute option, 118 --force, 124, 131, 179 --output, 35 --password, 35 --secure using SSL communication, 35 --username, 35 A candidate migration
F filter condition expression property, 45 range of valid property values for pool filter conditions, 51 range of valid property values for unused capacity filter conditions, 51 range of valid property values for volume filter conditions, 46 restrictions on specifiable characters for property values, 53 syntax, 40 filter condition expressions, 39 filtercondition parameter, 39 newfiltercondition parameter, 39 Overview of properties that can be specified for pool filter condition expressions, 44 Overview of p
N normal volume (Glossary), 235 O obtain list of volumes (LUs), 185 option common options, 35 option.output property, 214 option.password property, 214 option.password2 property, 214 option.secure property, 214 option.username property, 214 over-provisioning percent, 200 P parameter, 36 character length that can be specified, 226 character type that can be specified, 226 parameter.
uninstall, 24 batch file or shell script, 24 Windows system, 24 uninstalling HP-UX, 24 Linux, 24 Solaris, 24 unlocking task creating, 128 immediate execution, 129 User Account Control function, 33 user permission, 31 V virtual volume (Glossary), 236 virtual volume group (Glossary), 236 W Windows 7 setup.bat, 22 unsetup.bat, 24 Windows Server 2008 setup.bat, 22 unsetup.bat, 24 Windows Vista 4-byte characters, 36 setup.bat, 22 unsetup.
