HP P9000 Tiered Storage Manager Software CLI Reference Guide Part number: TB585-96027 Seventh edition: November 2012
Legal and notice information © Copyright 2010, 2012 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 .............................................................................................. 13 1 Overview of the CLI .......................................................................... 15 List of the CLI commands ............................................................................................................ 15 Volume operations using the CLI .................................................................................................
Format of properties for which multiple elements can be specified ............................................. 37 Properties overview ................................................................................................................... 38 Range of valid property values ................................................................................................... 41 5 Details of CLI commands ................................................................... 53 Common explanation .......
Output items ............................................................................................................... 73 Example and execution results ....................................................................................... 74 DeleteMigrationGroup ........................................................................................................ 75 Syntax ........................................................................................................................
Output items ............................................................................................................. 114 Example and execution results ..................................................................................... 114 CreateShreddingTask ........................................................................................................ 115 Syntax ......................................................................................................................
GetPools ......................................................................................................................... Syntax ...................................................................................................................... Parameters ................................................................................................................ Output items .............................................................................................................
Figures 1 Flow of volume operations ........................................................................................
Tables 1 Overview of CLI commands ...................................................................................... 15 2 CLI commands and the necessary user access permissions ........................................... 27 3 Options common to all CLI commands ....................................................................... 31 4 Types of filter condition expressions ...........................................................................
31 Items output by the GetMigrationGroups command (StorageDomain instance) ................ 77 32 Items output by the GetMigrationGroups command (MigrationGroup instance) ............... 77 33 Parameters of the ModifyMigrationGroup command .................................................... 81 34 Parameters of the AddVolumeToMigrationGroup command ........................................... 83 35 Items output by the AddVolumeToMigrationGroup command (StorageDomain instance) ................................
64 Items output by the GetTasks command (unlocking task) (Task instance) ........................ 128 65 Items output by the GetTasks command (unlocking task) (ErrorInfo instance) .................. 129 66 Items output by the GetTasks command (unlocking task) (UnlockingInfo instance) ........... 129 67 Items output by the GetTasks command (shredding task) (Task instance) ....................... 130 68 Items output by the GetTasks command (shredding task) (ErrorInfo instance) .................
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; and 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. Changes attributes for a storage domain.
Category Command name Description Changes attributes for a migration group.
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 also execute tasks when you create them. By using the CLI, you can migrate a specified migration group. Use the GUI if you want to migrate a specified volume. Only the CLI can be used to create locking, unlocking, or shredding tasks. These tasks cannot be created from the GUI. The CLI cannot manage migration tasks created by using the GUI.
Overview of the CLI
2 Preparations for executing the CLI This chapter explains the preparations to perform before starting to use 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 either a management server or a management client. This section describes how to set up the CLI on a management client.
4. Execute the setup batch file setup.bat from the command prompt, as follows: system-drive\TieredStorageManager\Tiered-Storage-Manager-version\Setup\setup.bat The setup.bat file stores and sets up the common library for collecting trace information, and edits the CLI execution batch file. The common library is stored in the following folder: system-drive\Program Files\Hitachi\HNTRLib2 NOTE: Note the following about executing setup.
2. Use FTP or external storage media to transfer the setup file from the Tiered Storage Manager software management server to the management client. You can transfer the setup file to any location, such as /tmp.
The uninstallation batch file or shell script is located in the same directory as the setup batch file or shell script. Uninstalling the CLI from a Windows system To uninstall the CLI from a Windows system: 1. Back up the htsmcli.properties file. If you are no longer going to use the CLI on the computer it is installed on, you do not need to back up this file. 2.
Preparations after setup This section explains the preparations that must be performed to execute the CLI commands after you have set up the CLI. Setting up the htsmcli.properties file Each time you execute the CLI, you need to enter the server location, user name, password, and whether to use SSL communication. In order to skip this step, you can specify the server location and common options in the htsmcli.properties file in advance.
How to use the htsmaccount command This section describes the htsmaccount command, which encodes a password and outputs it to the htsmcli.properties file or password file.
After the command completes, you do not need to specify the password when using the CLI. After the htsmaccount command finishes and the CLI is set up, use the GetStorageDomains command to make sure that the password is correctly set. Change the access permission for the CLI/logs folder In Windows, before using the CLI, change the access permissions to the CLI/logs folder so that the user accounts that use the CLI can read data from and write data to that folder.
Setting up SSL communication To use SSL to communicate with the Tiered Storage Manager server, you need to set up an environment on Tiered Storage Manager server and the management client that executes the Tiered Storage Manager CLI. For details about how to specify the security communication settings, see the HP P9000 Command View Advanced Edition Suite Software Administrator Guide.
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 CLI commands are executed, settings for users who will execute the commands need to be specified. Use the GUI to specify these settings. For details about how to set user permissions, see the HP P9000 Command View Advanced Edition Suite Software User Guide.
Permission Command name Admin Modify Execute View GetFreeSpaces Y Y Y Y GetMigrationGroups Y Y Y Y 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.
system-drive\TieredStorageManager\Tiered-Storage-Manager-version\CLI\htsmcli arguments In Solaris, HP-UX, or Linux: # ./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.
For details on the CLI command arguments that can be specified for the htsmcli.properties file, see Table 87. 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 description of each argument is provided below.
parameters Parameters contain information passed to the server as part of a request. The parameters required depend on the command requested. Each parameter consists of a name and a value. Options common to all CLI commands There are two kinds of options: those common to all CLI commands, and those used for only some CLI commands. This subsection describes the options common to all CLI commands. If an argument needs to be specified after an option, specify the argument as a single character string.
#1 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 a password as an encoded character string, see “Encoding the password in the property file or password file” on page 23.
is useful when specifying values for command parameters, because it also explains whether values are case sensitive and whether an empty character string can be specified. 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.
A description of the specified command is displayed, including the correct format and parameters.
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 this filter type:GetPools Filter condition expressions for unused capacity Filter condition expressions used to filter unused capacity in storage systems registered in Device Manager (unused-capacity -filter-condition) Specifiable properties See Table 6 and Table
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 Continuous Access Asynchronous volume type ( ContinuousAccessXPAsynchronous ) ContinuousAccessJournal ( ContinuousAccessXPJournal ) This property cannot be specified for HP P9500 storage systems.
Property name Description PVolMigrationGroup#1 If the volume is a Business Copy S-VOL, this is the migration group name containing the corresponding P-VOL. 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 Simplex ContinuousAccessSynchronous ( ContinuousAccessXPSynchronous ) Specifiable characters or values =, <> 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 Hyphen (-) ControllerArrayGroup =, <>, Underscore (_) startsWith, 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. Specify no more than 75 bytes.
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 Specify no more than 75 bytes. 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 Specifiable characters or values For GetStorageArray in Device Manager CLI, specify the value displayed for the name attribute of the StorageArray object. SubsystemName =, <> If you do not know the storage system name, specify the product name and serial number. Specify no more than 384 bytes. =, <>, SubsystemSerialNumber startsWith, contains For GetStorageArray in Device Manager CLI, specify the value displayed for the serialNumber attribute of the StorageArray object.
#2 When possible, capacity values in the output information of CLI commands are expressed in a higher-order unit than the unit specified by the user. For example, the value 10,240 KB is displayed as 10MB. #3 For the drive capacity, a value in KB is obtained from Device Manager. However, in Tiered Storage Manager software, the gigabyte-conversion of those values is used. This conversion involves dividing the drive capacity by 1,048,576 (1,024 x 1,024) and then rounding to the nearest integer.
When possible, capacity values in the output information of CLI commands are expressed in a higher-order unit than the unit specified by the user. For example, the value 10,240 KB is displayed as 10MB. Table 10 Range of valid property values for unused capacity filter conditions Property name ArrayGroup Operators Specifiable values or characters =, <>, For GetStorageArray (subtarget=ArrayGroup) in Device Manager CLI, specify the value displayed for the displayName attribute of the ArrayGroup object.
Property name Operators Specifiable values or characters For GetStorageArray (subtarget=LogicalUnit) in Device Manager CLI, specify the value displayed for the raidType attribute of the LogicalUnit object. RAIDLevel Specify this in the format of RAIDx, or RAIDx(yD+zP). =, <> RAIDx: RAID level yD: Number of data drives zP: Number of parity drives Specify no more than 75 bytes.
Property name Characters that cannot be specified ArrayGroupBusyRate • You cannot add a plus sign (+) to the value. ArrayGroupMaxBusyRate • -0 is treated as 0. BusinessCopy ( BusinessCopyXP ) • A space character cannot be used in the middle of a character string. • The value is not case sensitive. • You cannot add a plus sign (+) to the value. Capacity • -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.
Property name Characters that cannot be specified • The value cannot contain space characters. DiskType • The value is not case sensitive. • Space characters included within the string are disregarded. EmulationType Encryption • The value is not case sensitive. • A space character cannot be used in the middle of a character string. • The value is not case sensitive. • A space character cannot be used in the middle of a character string. FastSnap • The value is not case sensitive.
Property name Characters that cannot be specified • Space characters included within the string are disregarded. SubsystemVendor • The value is not case sensitive. -- SysplexidDevn • You cannot add a plus sign (+) to the value. TotalFreeCapacity • -0 is treated as 0. • The value cannot contain space characters. • The value is not case sensitive. -- VOLSER VolumeLockStatus VolumeStatus • The value cannot contain space characters. XPSnapshot • The value is not case sensitive.
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=2012/11/01 21:43:13 controllerSerialNumber=14011 controllerDisplayModel=XP12000 controllerName=XP12000@10.208.151.
Syntax htsmcli [ server-location] ModifyStorageDomain [ common-option ] [ { -d | --detail } ] name=storage-domain-name [ newname=storage-domain-name ] [ newdescription=description-for-the-storage-domain ] 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.
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. description A description of the storage domain Example and execution results • Command execution example: In this example, the name of the storage domain MegaTechXP12000-Primary is changed to NewStorageDomain.
Syntax htsmcli [ server-location] Refresh [ common-option ] [ storagedomainname=storage-domain-name ] Parameters Parameters do not have to be specified. Table 17 Parameters of the Refresh command Parameter Details Specify the name of the storage domain. storagedomainname If this is omitted, all storage domains are refreshed. Output items Nothing is output by this command.
Syntax htsmcli [ server-location] CreateStorageTier [ common-option ] [ { -d | --detail } ] storagedomainname=storage-domain-name name=storage-tier-name [ resource={ Volume | Pool } ] filtercondition=filter-condition [ description=description-for-the-storage-tier ] [ cost=cost-of-normal-volumes chargefor={ Allocated | Utilized } ] [ thpcost=cost-of-THP-volumes thpchargefor={ Allocated | Consumed | Utilized } ] Options -d or --detail Specify this to display detailed information in the standard output after
Parameter Details Specify the cost of normal volumes by using the following format: currency-code amount / unit-of-capacity / period • currency-code# Specify a currency code conforming to ISO4217 using upper-case characters. • amount Specify an integer from 0 to 9223372036854775807. Do not use commas or periods. • unit-of-capacity [cost] Specify MB, GB, or TB. • period Specify either Month or Year.
LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STD, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, ZMK, ZWL Output items Table 19 Items
htsmcli CreateStorageTier --detail storagedomainname="MegaTechXP12000-Primary" name="MegaTech-HighCost" filtercondition="RAIDLevel='RAID5(3D+1P)' AND ControllerArrayGroup='1-10-1'" • Execution results: RESPONSE: An instance of StorageDomain(1 of 1) name=MegaTechXP12000-Primary List of 1 StorageTier elements: An instance of StorageTier(1 of 1) name=MegaTech-HighCost filterCondition=RAIDLevel = 'RAID5(3D+1P)' AND ControllerArrayGroup = '1-10-1' description= cost= chargefor= thpcost= thpchargefor= DeleteSto
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. Output items The items output by the DeleteStorageTier command are the same as the items output by the CreateStorageTier command. For more information, see “Output items” on page 62 of the CreateStorageTier command.
Syntax htsmcli [ server-location] GetStorageTiers [ common-option ] [ { -d | --detail } ] storagedomainname=storage-domain-name [ name=storage-tier-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, only summary information will be displayed. Parameters Table 22 Parameters of the GetStorageTiers command Parameter Details storagedomainname Specify the name of the storage domain.
Item Description [filterCondition] The filter conditions for the storage tier [numberOfVolumes] The number of real volumes in the storage tier. totalCapacityInGB The total capacity of the real volumes in the storage tier (units: GB). Values less than 1 GB are rounded down and displayed as an integer (for example, 4.5 GB is rounded down to 4 GB).
Item Description The cost of normal volumes is displayed in the following format: cost currency-code amount / unit-of-capacity / period 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.
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 An instance of StorageTier(2 of 2) name=StorageTier-1 filterCondition=RAIDLevel <> 'RAID5(3D+1P)' numberOfVolumes=2 totalCapacityInGB=9 totalCapacityPercentageToStorageDomain=1 usedCapacityInGB=0 usedCapacityPercentage=0 freeCapacityInGB
name=storage-tier-name [ newname=storage-tier-name ] [ { newresource={ Volume | Pool } newfiltercondition=filter-condition | newfiltercondition=filter-condition } ] [ newdescription=description-for-the-storage-tier ] [ newcost=cost-of-normal-volumes ] [ newchargefor={ Allocated | Utilized } ] [ newthpcost=cost-of-THP-volumes ] [ newthpchargefor={ Allocated | Consumed | Utilized } ] Options -d or --detail Specify this to display detailed information in the standard output after CLI command execution.
Parameter Details Specify the cost of normal volumes by using the following format: currency-code amount / unit-of-capacity / period • currency-code Specify a currency code conforming to ISO4217 using upper-case characters. For details on the specifiable values, see currency-code for the cost parameter described in Table 18. • amount Specify an integer from 0 to 9223372036854775807. Do not use commas or periods. • unit-of-capacity Specify MB, GB, or TB.
Legend: [ ]: Specifying this parameter is optional. #1 Specify these parameters so that, after the ModifyStorageTier command is executed, either both the cost of normal volumes and the charge target for the cost of normal volumes are set or neither is set. #2 Specify these parameters so that, after the ModifyStorageTier command is executed, either both the cost of THP volumes and the charge target for the cost of THP volumes are set or neither is set.
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=2012/11/22 19:40:05 reminderDescription=It is scheduled to move.
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 29 Parameters of the DeleteMigrationGroup command Parameter Details storagedomainname Specify the storage domain name. name Specify the name of the migration group to be deleted. Output items The items output by the DeleteMigrationGroup command are the same as the items output by the CreateMigrationGroup command.
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 ] ...] Options -d or --detail Specify this to display detailed information in the standard output after CLI command execution.
Item Description canMigrate Indicates whether migration is possible [notifyToURL] Event notification address remindAt Date and time the specified elapsed-period event occurs [reminderDescription] Description to be displayed when the specified elapsed-period event occurs [lastModifyUserGroup] The user group name of the user who created or last modified the migration group [creationTime] The date and time when the migration group was created [lastModifyTime] The date and time when the migration
Item Description [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. Example and execution results • Command execution example: In this example, detailed information is obtained for all migration groups in the MegaTechXP12000-Primary storage domain.
lastModifyUserGroup=Admin creationTime=2012/11/02 12:06:41 lastModifyTime=2012/11/03 12:06:41 lastMigrationTime= migrationStatus= taskType= taskStatus= numberOfVolumes=0 totalCapacityInGB=0 numberOfManagedVolumes=25 totalManagedCapacityInGB=1,000 consumedCapacityInGB=300 arrayGroupSelectionRule=BalanceCapacity arrayGroupAvoidanceOfMigrationGroups= description=MyMigrationGroup ModifyMigrationGroup The ModifyMigrationGroup command can be used to change information about a migration group.
[ newreminddayslater= number-of-days-before-the-specified-elapsed-period-event-occurs ] [ newreminderdescription= description-for-the-specified-elapsed-period-event ] [ newarraygroupselectionrule={ BalanceCapacity | MinimumCoverage | MaximumCoverage } ] [ newarraygroupavoidanceofmigrationgroups= migration-group-name [,migration-group-name ] ] [ description=description-for-the-migration-group ] Options -d or --detail Specify this to display detailed information in the standard output after CLI command execu
Parameter Details Specify this parameter to modify the parity group selection rule parameter value that was set in CreateMigrationGroup. This can be any of the following: • BalanceCapacity: Balancing the capacity [newarraygroupselectionrule] • MinimumCoverage: Minimizing the distribution • MaximumCoverage: Maximizing the distribution If this parameter is omitted, the parity group selection rule that is used to create migration plans remains unchanged.
remindAt=2012/11/28 19:40:05 reminderDescription=It is scheduled to move. arrayGroupSelectionRule=BalanceCapacity arrayGroupAvoidanceOfMigrationGroups=MG012,MG013 description=MigrationGroup011 AddVolumeToMigrationGroup The AddVolumeToMigrationGroup command can be used to add a volume to the specified migration group. Use the LDEV number in the domain controller (controller LDEV number) to specify a volume.
Parameter Details 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. • When specifying a logical DKC number: Specify 0:02:0a or 00:02:0A.
Item Description arrayGroupAvoidanceOfMigrationGroups Parity group avoidance rule description A description of the migration group If no parity group avoidance rule has been set, nothing is displayed. 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 (:).
controllerdevicenumber="3:A6" movefrommigrationgroup=Yes • Execution results: 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=MigrationGroup011 List of 1 Volume elements: An instance of Volume(1 of 1) controllerDeviceNumber=3:A6 emulation
storagedomainname=storage-domain-name name=migration-group-name controllerdevicenumber=controller-LDEV-number 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 38 Parameters of the RemoveVolumeFromMigrationGroup command Parameter Details storagedomainname Specify the name of the storage domain. name Specify the name of the migration group.
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=MigrationGroup011 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 arrayGroup
If the migration group contains non-migratable volumes, only the volumes that are migratable will be migrated. Note that, if there are no migratable volumes, an error will occur when you attempt to create the migration plan. For non-migratable volumes, the source volume will select itself as the target volume in the candidate migration plan. This command does not reserve volume migration for migration source and target volumes.
Type of information Item permitCrossCLPRMigration pair sourceControllerDeviceNumber Description Specify whether to allow migration between CLPRs. This can be either Yes or No: • Yes: Allow migration between CLPRs • No: Do not allow migration between CLPRs The symbol indicating the start of the specification of a migration source volume and migration target volume The migration source volume.#3 • Specify the controller logical device number.
Parameters Table 40 Parameters of the CreateMigrationPlan command Parameter Details storagedomainname Specify the name of the storage domain. migrationgroupname Specify the name of the migration group. targetstoragetiername Specify the name of the storage tier (migration target storage tier name) to which migration is to be performed.
Item Description Indicates whether migration is permitted for transferring volume data between CLPRs. This can be either Yes or No: • Yes: permitted permitCrossCLPRMigration • No: not permitted [ arrayGroupSelectionRule ] Information about the parity group selection rule is displayed among the LDEV selection rules. [ arrayGroupAvoidanceOfMigrationGroups ] Information about the parity group avoidance rule is displayed among the LDEV selection rules.
When the emulation type is OPEN-V, the CVS attribute is not displayed. When the emulation type is other than OPEN-V and the LDEV type is the CSV attribute, CVS is displayed. When the emulation type is not OPEN-V and the LDEV type is not the CSV attribute, nonCVS is displayed.
The output items described in Table 44 are displayed as comments. The order the items are displayed in and which items are output might differ depending on the version of the Tiered Storage Manager server.
Item Description The controller logical device number of the migration target volume targetControllerDeviceNumber Multiple lines are displayed for a volume when multiple volumes are available as the migration target volume candidate. Volumes that are available as the migration target volume include volumes that have larger capacities than the migration source volume (and need to be re-created).
# Begin Profile Information # List of 2 Profile elements: # An instance of Profile(1 of 2) # configuration=OPEN-V, 1.00 GB(1,049,280 KB, 2,098,560 Blocks) # numberOfNeededVolumes=1 # numberOfAvailableVolumes=14(10) # numberOfDifference=13(9) # An instance of Profile(2 of 2) # configuration=OPEN-V, 2.
# # # # # # # # # # # # # # # # # # Target candidates for source LDEV - 00:11:1F emulationType=OPEN-V CVS=Yes capacityInKB=2,097,600 LBA=4,195,200 subsystem=P9500@10.208.115.
migrationGroupName=MG011 targetStorageTierName=MegaTech-HighCost permitCrossSLPRMigration=No permitCrossCLPRMigration=Yes # arrayGroupSelectionRule=BalanceCapacity # arrayGroupAvoidanceOfMigrationGroups= # Begin Profile Information # List of 2 Profile elements: # An instance of Profile(1 of 2) # configuration=OPEN-V, 1,000 MB(1,024,320 KB, 2,048,640 Blocks) # numberOfNeededVolumes=1 # numberOfAvailableVolumes=4(0) # numberOfDifference=3(-1) # An instance of Profile(2 of 2) # configuration=OPEN-V, 9.
# # # # # # # 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.
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.
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # 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=arrayGroupBusyRate=50.
#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.
• When a refresh is required for the storage domain • The migration group specified for the migrationgroupname parameter at the creation of a task is specified for the migrationgroupname or movetomigrationgroupname parameter in a task that has not ended (End) Other than the above, depending on the type of task, there are conditions under which the task cannot be created. For details, see the commands used to create the task. A task ID is assigned to all created tasks.
• The migration task is changed to the terminated (canceled) status by using the CancelTask command. • The migration task ends with a failure. Once migration terminates normally, the controller LDEV numbers of the migration source and target volumes are swapped. Note that the labels assigned to the volumes remain the same. If you want to change these labels along with migration, do so after the migration task is executed.
NOTE: Depending on filter conditions specified for the target storage tier, even if the migration has terminated normally, the migration source volumes might not be included in the target storage tier.
Parameter Details Specify whether the unused capacity in the migration target volume is to be released after migration terminates normally. • Yes: Release the unused capacity. (Default) • No: Do not release the unused capacity. To enable this parameter specification, the following conditions must be satisfied: [zerodatadiscard] • The migration target volume is either a THP volume or THP pool. • The migration source volume is not a volume that is part of a Business Copy or Snapshot pair.
Item Description previousTargetStorageTierName The name of the migration target storage tier for the previous migration. If migration has never been performed before, nothing is displayed. targetStorageTierName The name of the migration target storage tier eraseData Indicates whether the data for the migration source volume is to be deleted once after migration terminates normally.
RESPONSE: An instance of Task(1 of 1) ID=TK1f2lymqv taskType=Migration status=Standby timeEstimate=0:02:02 creationTime=2012/11/25 16:53:11 endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 previousTargetStorageTierName= targetStorageTierName=MegaTech-HighCost eraseData=No zeroDataDiscard=Yes notifyToURL= description= List of 2 MigrationInfo elements: An instance of MigrationInfo(1 of 2) sourceControllerDeviceNumber=3:A6 targetControllerDeviceNumber=2:80 timeEstimate=0
If any of the following conditions exists, you cannot create a locking task: • 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 102 is met Once a
Parameters Table 48 Parameters of the CreateLockingTask command Parameter Details storagedomainname Specify the name of the storage domain. migrationgroupname Specify the name of the migration group. Specify the locking method to be applied when the locking task is executed.
Item Description migrationGroupName The name of the migration group retentionDays The locked period (in days). If there is no locking period, -1(Unlimited) will be displayed. retainedThrough The date the locked period expires. If there is no expiration date, Unlimited will be displayed. The locking method to be applied when the locking task is executed.
moveToMigrationGroupName= notifyToURL=mailto:test@example.com 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 (2): In this example, a locking task that indefinitely locks volumes in read-only status is created.
• 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 102 is met If a migration group includes a volume that has an expired Data Retention Utility lock, an error occurs when you execute an unlocking task.
Output items Table 52 Items output by the CreateUnlockingTask command (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 (Unlocking) The task status status For details on the values displayed, see “Task statuses” on page 167.
ID=TK1f2lymqv taskType=Unlocking status=Standby creationTime=2012/11/25 16:53:11 endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 moveToMigrationGroupName= notifyToURL=mailto:test@example.
• When any of the conditions that prevent you from creating a task described in “Creating and executing tasks” on page 102 is met After volumes have been completely shredded, the data is gone and you can move the shredded volumes to another migration group. This enables you to set aside volumes without any data to be used again later. If the volume is a THP volume and a target migration group has not specified, the THP volume is deleted after the data is erased.
Legend: [ ]: Specifying this parameter is optional. Output items Table 55 Items output by the CreateShreddingTask command (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 (Shredding) The task status status For details on the values displayed, see “Task statuses” on page 167. The estimated time for the task execution.
Example and execution results • Command execution example: In this example, a shredding task is created that shreds the volumes in the MG011 migration group using the DoD standard method and moves the shredded volumes to the MG044 migration group.
• Tasks created (or ended) on or before the specified base date • Tasks created (or ended) on or after the specified base date • Tasks created (or ended) on the specified base date The GetTasks command can acquire and display information about multiple types of tasks. Therefore, the output items depend on the task type. The output items are described for each task.
Parameter Details Specify the name of the storage system. Specify the value displayed for the name attribute of the StorageArray object for GetStorageArray in Device Manager CLI. subsystemname If you do not know the storage system name, specify the product name and serial number. If you omit this parameter, the storage systems are not narrowed down. Specify the status of the task. status For details about the values that can be specified, see “Task statuses” on page 167.
Output items (migration task) NOTE: For some output items, - or Unknown is output when one of the following conditions are met: • When a storage tier created by using pool filter conditions is selected as a migration target. Unknown is displayed until creation of the volume completes. • When the externally connected storage system is an SMI-S Enabled storage system. - or Unknown is displayed. Table 58 Items output by the GetTasks command (migration task) (Task instance) Item Description The task ID.
Item Description [estimatedMigrationCompletionTime] The date and time when migration is expected to finish dataErasureStartedTime The date and time when erasure execution started [dataErasureCompletionTime] The date and time when erasure execution completed dataErasureProgress Indicates the erasure progress, as a percentage. Values of less than 1% are rounded down and displayed as an integer. (For example, 45.3% is rounded down to 45%.
Item Description totalCapacityInGB The total capacity of the volumes subject to migration in the migration group (units: GB). Values less than 1 GB are rounded down and displayed as an integer (for example, 4.5 GB is rounded down to 4 GB). notifyToURL Event notification address description A description of the task Legend: [ ]: Indicates output only when either the -d or the --detail option is specified.
Item Description sourceCLPRNumber The number for the CLPR to which the migration source volume belongs sourceRAIDLevel The RAID level of the migration source volume.
Item Description targetControllerArrayGroupName The name of the controller parity group in which the migration target volume exists targetArrayGroupName The parity group name of the migration target volume targetArrayGroupBusyRate The parity group usage rate (%) of the target volume. Up to 2 decimal places are displayed. targetArrayGroupMaxBusyRate The maximum parity group usage rate (%) of the target volume. Up to 2 decimal places are displayed.
Item Description The task status status For details on the values displayed, see “Task statuses” on page 167. 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 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 (:).
Output items (unlocking task) NOTE: For some output items, - or Unknown is output when the externally connected storage system is an SMI-S Enabled storage system. Table 64 Items output by the GetTasks command (unlocking 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 ########.
Legend: [ ]: Indicates output only when either the -d or the --detail option is specified. 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.
Output items (shredding task) NOTE: For some output items, - or Unknown is output when the externally connected storage system is an SMI-S Enabled storage system. Table 67 Items output by the GetTasks command (shredding 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 ########.
Item Description Shredding pattern. This can be any of the following: shreddingMethod • ZERO-ONCE: The data 0 is written only once • DoD: The DoD standard method is used moveToMigrationGroupName The target migration group name of a volume whose shredding has been completed totalShreddingCapacityInGB The total capacity of the volumes subject to shredding in the migration group (units: GB). Values of less than 1 GB are rounded down to an integer. (For example, 4.5 GB is rounded down to 4 GB.
Item Description The shredding status of a volume status For details on the values displayed, see “Task statuses” on page 167. 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. The estimated time for task execution for each volume.
ownerGroupID=Admin storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 previousTargetStorageTierName= targetStorageTierName=MegaTech-HighCost eraseData=No zeroDataDiscard=No totalCapacityInGB=19 notifyToURL=mailto:test@example.com description= List of 2 MigrationInfo elements: An instance of MigrationInfo(1 of 2) sourceControllerDeviceNumber=3:A6 sourceSubsystemSerialNumber=14011 sourceSubsystemDisplayModel=XP12000 sourceSubsystemName=XP12000@10.208.151.
sourceControllerArrayGroupName=E9980-1 sourceArrayGroupName=1-9-1 sourceArrayGroupBusyRate=34.56 sourceArrayGroupMaxBusyRate=56.75 targetControllerDeviceNumber=2:84 targetSubsystemSerialNumber=14011 targetSubsystemDisplayModel=XP12000 targetSubsystemName=XP12000@10.208.151.
guardMode=Read only moveToMigrationGroupName= notifyToURL=mailto:test@example.com description= List of 2 LockingInfo elements: An instance of LockingInfo(1 of 2) 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.
An instance of UnlockingInfo(1 of 2) controllerDeviceNumber=3:A6 subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12000@10.208.151.151 subsystemDeviceNumber=3:A6 subsystemDeviceID=status=Standby timeElapsed= An instance of UnlockingInfo(2 of 2) controllerDeviceNumber=3:A7 subsystemSerialNumber=14011 subsystemDisplayModel=XP12000 subsystemName=XP12000@10.208.151.
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.
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:test@example.
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.75 targetControllerDeviceNumber=2:84 targetSubsystemSerialNumber=14011 targetSubsystemDisplayModel=XP12000 targetSubsystemName=XP12000@10.208.151.
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.
• Task has ended (End). • Task is in a storage domain whose refresh status is either Processing or Failure. Syntax htsmcli [ server-location] ModifyTask [ common-option ] [ { -d | --detail } ] id=task-ID [ newnotifytourl=event-notification-address ] [ newdescription=description-of-the-task ] 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.
Example and execution results • Command execution example: 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.
CAUTION: If a volume is being re-created on the migration target and an error occurs during the migration, all the data on the migration target volume might be deleted. Check the output message, and then manually create the volume. Syntax htsmcli [ server-location] ExecuteTask [ common-option ] id=task-ID Parameters Table 71 Parameters of the ExecuteTask command Parameter Details Specify the task ID.
Syntax htsmcli [ server-location] CancelTask [ common-option ] [ --emergency ] id=task-ID Options --emergency When specified, this option forcibly terminates the tasks and volume tasks that have been waiting (tasks on Standby) in the storage domain for which refreshing failed. If you omit this option, the tasks and volume tasks are not forcibly terminated.
• Execution results: No information is output by this command. StopTask The StopTask command can be used to issue to the Tiered Storage Manager server a request to stop a specified task that is in Standby status. This command also cancels migration volume reserve placed by the migration task. The command can stop tasks in the following statuses: • Active However, tasks in one of the following statuses cannot be stopped: • When a shredding task is in the Active.
[ common-option ] [ --emergency ] id=task-ID [ immediate={ Yes | No } ] Options --emergency When specified, this option forcibly terminates the tasks and volume tasks that have not been completed (tasks on standby) in the storage domain for which refreshing failed. If you omit this option, the tasks and volume tasks are not forcibly terminated.
For example, if there are five volumes issuing a stop request, the time required to finish processing for all the volumes takes five times as long to respond than a stop request for just one volume. Output items Nothing is output by this command. Example and execution results • Command execution example: In this example, the task whose task ID is TK1ev677gu is stopped. htsmcli StopTask id=TK1ev677gu • Execution results: No information is output by this command.
Options -f or --force Specify this option to delete without confirmation. To require a response to a confirmation message before deleting a task, omit this option. Parameters Parameters do not have to be specified. Table 74 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.
Parameter Details Specify the type of task. This can be any of the following: • Migration • Shredding • Locking tasktype • Unlocking • VolumeCreation (A specification value used to maintain compatibility with older versions) • ExternalMapping (A specification value used to maintain compatibility with older versions) 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.
targetStorageTierName=MegaTech-HighCost eraseData=No zeroDataDiscard=No notifyToURL=mailto:test@example.
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 75 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.
Output items NOTE: For some output items, Unknown is output when one of the following conditions are met: • When the volume information in the storage domain cannot be obtained for some reason (for example, volumes in the storage system have been deleted by Device Manager). • When the information regarding the externally connected storage cannot be obtained. • When the externally connected storage system is an SMI-S Enabled storage system.
Item Description The used capacity of the volume (units: KB). consumedCapacityInKB If the volume type is normal, the capacity of the normal volume is displayed. If the volume type is virtual, the used capacity of the virtual volume is displayed. If the volume type is pool, nothing is displayed. consumedCapacityPercentage The ratio (percentage) of consumedCapacityInKB to capacityInKB. If the volume type is pool, nothing is displayed.
Item Description The THP pool number. This can be any of the following: • THP x: The targets are THP volumes that are related to a pool or pool volumes. [PoolId] (x: An integer from 0 to 127) • Unassigned: The targets are THP volumes that are not related to a pool. In other cases, nothing is displayed. [PVolMigrationGroupName] [PVolDeviceNumber] [PVolMUNumber] If the volume is a Business Copy S-VOL, this is the migration group name containing the corresponding P-VOL.
# For CLI versions earlier than 7.4.0, if the storage system corresponding to the storage domain is HP P9500, the Fast Snap volume type is combined with the Snapshot volume type and displayed as one value. As a result, the value displayed for xpSnapshot in versions earlier than 7.4.0 is determined as follows: • If the Snapshot volume type and the Fast Snap volume type are both Simplex: Simplex is displayed.
Item Description 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. Alternatively, the encryption feature is not supported.
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.
migrationGroupName= emulationType=OPEN-V CVS=Yes capacityInKB=2,097,152 consumedCapacityInKB=2,097,152 consumedCapacityPercentage=100 RAIDLevel=RAID5(3D+1P) diskType=SAS diskRPM=10,000 encryption=Disabled diskCapacityInGB=269 arrayGroupNumber=16 controllerArrayGroupName=1-2 arrayGroupName=1-2 arrayGroupBusyRate= arrayGroupMaxBusyRate= businessCopy=Simplex continuousAccessSynchronous=Simplex continuousAccessAsynchronous=Simplex continuousAccessJournal=Simplex xpSnapshot=Simplex fastSnap=Simplex xpThinProvisi
guardDate= controllerArrayGroupNumber=16 controllerArrayGroupName=1-2 cacheMode=Unknown IOSuppressionMode=Unknown subsystemDeviceNumber=00:00:40 subsystemDeviceID=subsystemSerialNumber=53038 subsystemDisplayModel=P9500 subsystemName=P9500@10.208.115.233 subsystemVendor=HP arrayGroupNumber=16 arrayGroupName=1-2 arrayGroupBusyRate= arrayGroupMaxBusyRate= An instance of LogicalUnit(2 of 2) controllerDeviceNumber=00:04:FF label= subsystemSerialNumber=53038 subsystemDisplayModel=P9500 subsystemName=P9500@10.208.
reason(2 of 3)=Path (target) reason(3 of 3)=Universal Replicator Status List of 2 LDEV elements: An instance of LDEV(1 of 2) controllerDeviceNumber=00:04:FF controllerSerialNumber=53038 controllerDisplayModel=P9500 controllerName=P9500@10.208.115.
guardMode= retainedThrough= guardDate= controllerArrayGroupNumber=16 controllerArrayGroupName=1-2 cacheMode=Unknown IOSuppressionMode=Unknown subsystemDeviceNumber=00:05:FF subsystemDeviceID=subsystemSerialNumber=53038 subsystemDisplayModel=P9500 subsystemName=P9500@10.208.115.233 subsystemVendor=HP arrayGroupNumber=16 arrayGroupName=1-2 arrayGroupBusyRate= arrayGroupMaxBusyRate= GetPools The GetPools command can be used to list information about THP pools within a storage domain.
Output items Table 80 Items output by the GetPools command (StorageDomain instance) Item Description name The name of the storage domain Table 81 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: 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 numberOfThpVolumes=1
Parameters Table 82 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 subsystemVendor The vendor name of the storage system to which the unused capacity belongs diskType The drive type of the parity group to which the unused capacity belongs The drive speed of the parity group to which the unused capacity belongs diskRPM diskCapacityInGB If this value cannot be obtained, nothing is displayed.
In this example, the GetFreeSpaces command obtains the information about the unused capacity in two storage systems named XP12000#14000.
RAIDLevel=RAID5(3D+1P) subsystemVendor=HP 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.
The table below lists the task statuses used by CLI commands. Among the task statuses in the following table, all values related to volume creation tasks and external mapping tasks are used to maintain compatibility with older versions. Table 85 Task statuses (parameter specification values and output items) Parameter Task status Description Output item GetTasks DeleteTasks Running Active Same as specifying all of the Active statuses at the same time. Y -- -- Active.
Parameter Task status Description Output item GetTasks DeleteTasks Active.WaitingExternalMapping Waiting for external mapping Y# -- Y Active.WaitingMigration Waiting for migration Y# -- Y Active.WaitingPathCreation Waiting for path creation Y# -- Y Active.WaitingRecreateVolume Waiting for volume re-creation -- -- Y Active.WaitingVolumeCreation Waiting for a volume to be created Y# -- Y Active.WaitingZeroDataDiscard Waiting to release unused capacity Y# -- Y Active.
Parameter Task status Description Output item GetTasks Failure.ZeroDataDiscardFailure Release of unused capacity ended in failure DeleteTasks Y# Y# Y Not ended NotEnd Same as multiple specification of Standby and Active. Y -- -- OutOfExecution Not subject to task execution -- -- Y Standby Standby Y -- Y Y Y Y Has been stopped The same as specifying all of the Stop statuses at the same time for a parameter. Stop Stop.DataErasureStop Data erasure has stopped. Y# Y# Y Stop.
6 CLI property files This chapter describes how to specify options and parameters by using the CLI property files. It also explains the properties pertaining to the CLI trace log. Overview of property files for the CLI There are two property files for the CLI. • Properties pertaining to CLI options and parameters are in the htsmcli.properties file • Properties pertaining to the CLI trace log are in the htsmclienv.properties file By default, the files htsmcli.properties and htsmclienv.
In the CLI property files, any line that starts with a hash mark (#) is treated as a comment. Literal strings or numbers do not need to be enclosed in quotation marks. In Java property files, the backslash character (\) is a reserved escape character, and any character following it is treated as a tab, line-feed, or other control character. Because absolute path names on Windows platform generally contain backslashes, each path separator must be preceded by another backslash.
Property Value option.password2 No corresponding argument option.secure --secure option parameter.parameter-name Parameter specified by using a combination name and value NOTE: Only printable characters, (that is ASCII characters and \u0020 - \u007E (which are recognized as ASCII characters)) can be used for property values in the htsmcli.properties file. The following table lists example values for the location of the Tiered Storage Manager server, as well as other options, in the htsmcli.
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 31. option.password property This property specifies the password that corresponds to the user specified for the option.username property. For details about how to specify the value of this property, see the explanation of the --password option in “Options common to all CLI commands” on page 31.
For details about how to specify the value of each command parameter, see “Command parameters” on page 32, and the details about each command. Specifying properties for the trace log in the htsmclienv.properties file Values for CLI log output functions can be set in the htsmclienv.properties file. NOTE: Note the following about the characters that can be specified in the htsmclienv.
TIP: In Solaris, HP-UX, or Linux, CLI trace log files are output with the access permissions -rw-rw-rw-, because the script htsmcli is running using umask 0 . logger.filePath property This property specifies the name of the file to which the trace log data is output, using an absolute path, or a relative path from the CLI installation directory. n.log is automatically appended to the specified file name (where n is a positive integer indicating the log file number).
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. This property can be set to a value from 0 to 30, but HP recommends the default output level of 20.
CLI property files
7 Troubleshooting This chapter explains what to do when CLI problems occur. Troubleshooting the CLI If a CLI problem occurs, do the following: • Make sure that the cause is not a software, computer, or LAN hardware problem, and then restart the computer. • Make sure that no problems exist with the Tiered Storage Manager server. The following table lists details about troubleshooting problems specific to the CLI. Table 90 Troubleshooting the CLI Problem You cannot log in to Tiered Storage Manager software.
Problem An error indicating that the specified command was not found occurred. Cause Recommended action The environment variable HTSM_CLI_HOME has not been specified. Specify the directory containing the htsmcli.properties file in the environment variable HTSM_CLI_HOME. The path to java.exe (or java) has been specified incorrectly or has not been specified. Specify the path of the java command in the environment variable HTSM_CLI_JRE_PATH.
Problem Cause Recommended action The security level of the Tiered Storage Manager server does not match the security level of the CLI. When the security level of the Tiered Storage Manager server changes, the security level must be set again for SSL communication by the CLI.# The content of the specified electronic certificate file is invalid. Use the electronic certificate file downloaded from the Tiered Storage Manager server.# The SSL communication port setting is invalid.
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 describes the reasons displayed by the GetVolumes command when migrations cannot be performed. This section also describes the conditions that must be met when a migration is performed in which THP pools are specified for the migration target and LUSE volumes are specified for the migration source.
Displayed character string Status of the specified volume Command Device The volume is used as a command device. The volume is one of the following: Continuous Access Asynchronous Status < Continuous Access XP Asynchronous Status > • The volume is part of a Continuous Access Asynchronous pair, and the status is neither PSUS nor PSUE. • The volume is part of a Hitachi TrueCopy Asynchronous for Mainframe pair, and the status is not suspended.
Displayed character string Status of the specified volume 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. XP Thin Provisioning [Pool Volume] The volume is a Thin Provisioning Software pool volume.
Displayed character string Status of the specified volume The volume is one of the following: • The volume is part of a Continuous Access Synchronous pair, and the status is either PSUS or PSUE. Continuous Access Synchronous (target) < Continuous Access XP Synchronous (target) > • The volume is part of a Continuous Access Synchronous for Mainframe pair, and the status is suspended. • This applies only to HP P9500 or XP24000/XP20000.
• The number of THP volumes in the migration target pool is less than the maximum value (HP P9500: 63,232; XP24000/XP20000: 8,192). • The maximum over-provisioning percent in the migration target pool does not exceed the warning threshold for the over-provisioning percent. • The maximum over-provisioning percent in the migration target pool does not exceed the upper limit for the over-provisioning percent.
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.
parity group A group of physical drives in a RAID configuration in a storage system. parity group avoidance rule This rule does not select, as a migration target parity group, a parity group that contains an LDEV that belongs to a specific migration group. parity group selection rule This is the rule specified when you want to select a migration target after considering the usage status of parity groups.
THP volume A virtual volume that is created from a THP pool or is related to a THP pool. virtual volume A generic term for virtual volumes used in storage functions.
Glossary
Index AddVolumeToMigrationGroup, 83 cost amount, 61, 70 currency code, 61, 70 format, 61 unit of capacity, 61, 70 unit of period, 61, 70 CreateLockingTask, 108 CreateMigrationGroup, 72 CreateMigrationPlan, 88 CreateMigrationTask, 103 CreateShreddingTask, 115 CreateStorageTier, 59 CreateUnlockingTask, 112 currency code, 61 C D Symbols --emergency, 144, 146 --execute option, 103 --force, 109, 116, 148 --output, 31 --password, 31 --secure using SSL communication, 31 --username, 31 A candidate migration
F I filter condition expressions, 35 filtercondition parameter, 35 newfiltercondition parameter, 35 Overview of properties, 38 Overview of properties that can be specified for pool filter condition expressions, 40 Overview of properties that can be specified for unused capacity filter condition expressions, 41 Overview of properties that can be specified for volume filter condition expressions, 38 property, 41 range of valid property values, 41 range of valid property values for pool filter conditions, 47
N normal volume (Glossary), 195 O obtain list of volumes (LUs), 150 option common options, 31 option.output property, 174 option.password property, 174 option.password2 property, 174 option.secure property, 174 option.username property, 173 over-provisioning percent, 162 P parameter, 32 character length that can be specified, 186 character type that can be specified, 186 parameter.
uninstall batch file or shell script, 22 Windows system, 22 uninstalling, 21 HP-UX, 22 Linux, 22 Solaris, 22 unlocking task creating, 112 immediate execution, 113 User Account Control function, 29 V virtual volume (Glossary), 197 W Windows 7 setup.bat, 20 unsetup.bat, 22 Windows Server 2008 setup.bat, 20 unsetup.bat, 22 Windows Vista 4-byte characters, 32 setup.bat, 20 unsetup.
