HP StorageWorks P9000 Tiered Storage Manager Software CLI Reference Guide Part number: TB585-96014 Fourth edition: August 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 ............................................................................................................... 77 Example and execution results ....................................................................................... 78 DeleteMigrationGroup ........................................................................................................ 79 Syntax ........................................................................................................................
Output items ............................................................................................................. 117 Example and execution results ..................................................................................... 118 CreateShreddingTask ........................................................................................................ 118 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) ................ 81 32 Items output by the GetMigrationGroups command (MigrationGroup instance) ............... 81 33 Parameters of the ModifyMigrationGroup command .................................................... 85 34 Parameters of the AddVolumeToMigrationGroup command ........................................... 87 35 Items output by the AddVolumeToMigrationGroup command (StorageDomain instance) ................................
64 Items output by the GetTasks command (unlocking task) (Task instance) ........................ 130 65 Items output by the GetTasks command (unlocking task) (ErrorInfo instance) .................. 131 66 Items output by the GetTasks command (unlocking task) (UnlockingInfo instance) ........... 131 67 Items output by the GetTasks command (shredding task) (Task instance) ....................... 132 68 Items output by the GetTasks command (shredding task) (ErrorInfo instance) .................
97 Properties for the CLI ............................................................................................. 182 98 Correspondence between properties in the htsmcli.properties file and CLI command arguments ............................................................................................................ 183 99 Example settings of property values in the htsmcli.properties file .................................. 183 100 Example property value settings in the htsmclienv.properties file ..
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 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. Set up the Tiered Storage Manager server for SSL communication at the desired security level. 2.
If the above error occurs, increase the value of HTSM_CLI_MEM_SIZE, and then execute the CLI again. Setting up the language type of the CLI to be run on the management client HP recommends that you set the CLI's language type to match the server's locale. HP recommends this because when you operate the CLI on a management client, the language of the information received from the Tiered Storage Manager server depends on the locale of the Tiered Storage Manager server.
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 CLI commands are executed, settings for users who will execute the commands need to be specified. Use the GUI to specify these settings.
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 98. 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.
Option Option argument Description Specify this option for SSL communication between the Tiered Storage Manager server and the CLI. -s or --secure No arguments Various settings must be changed to use SSL communication. For details about how to set this option, see “Setting up SSL communication” on page 28. #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.
NOTE: Note the following points on specifying parameters: • Special care should be taken when using a symbol (<, >, &, or !) to which a special meaning is attached by the OS. To override the OS's special meanings for any of these symbols, a character string containing such a symbol must be enclosed in single (') or double (") quotation marks or must be preceded by an escape character. • Problems might be encountered if you use Windows Vista 4-byte characters.
To display the details on the format for a command, such as GetVolumes or CreateMigrationTask, after help, specify the name of the command. • In Windows: system-drive\TieredStorageManager\Tiered-Storage-Manager-version\CLI\htsmcli help command-name • In Solaris, HP-UX, and Linux: # ./htsmcli help command-name 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 ( 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. 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 =, <>, 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. Specify no more than 150 bytes. SubsystemVendor =, <> For GetStorageArray in Device Manager CLI, specify the value displayed for the vendor attribute of the VolumeConnection object. Specify no more than 150 bytes.
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 =, <>, >, >=, <, <= • Specify 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 Operators Specifiable values or characters Specify a positive integer, or a positive integer with a unit. (For example, 256, 500KB, or 10MB.) TotalFreeCapacity =, <>, >, >=, <, <= • Specify 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.#1 #1 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.
Property name Characters that cannot be specified ContinuousAccessAsynchronous ( ContinuousAccessXPAsynchronous ) ContinuousAccessJournal ( ContinuousAccessXPJournal ) • A space character cannot be used in the middle of a character string. • The value is not case sensitive. ContinuousAccessSynchronous ( ContinuousAccessXPSynchronous ) • A value must be specified.
Property name Characters that cannot be specified • Specify characters other than commas (,). PoolId • Space characters between elements are disregarded. -- PortHostStorageDomain PVolMigrationGroup A value must be specified. • You cannot add a plus sign (+) to the value. PVolMUNumber • -0 is treated as 0. • Space characters included within the string are disregarded. RAIDLevel • The value is not case sensitive. • You cannot add a plus sign (+) to the value. SLPRNumber • -0 is treated as 0.
Filter conditions that can be used in the CLI
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.
Detailed information about MegaTechUSP600-Primary and MegaTechUSP600-Secondary is output. The error information that begins with List of 1 ErrorInfo elements: is displayed at the end of the information about MegaTechUSP600-Secondary because refreshStatus of MegaTechUSP600-Secondary is 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] 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.
Item Description 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. 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 66 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 totalCapacityPercentageToStorageDomain Ratio (percentage) of totalCapacityInGB to the total amount of capacity in the real volumes within the storage domain. Values less than 1% are rounded up to display an integer. usedCapacityInGB The total capacity of the real volumes being used 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 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. The cost of THP volumes is displayed in the following format: thpcost currency-code amount / unit-of-capacity / period If this item is not set, nothing is displayed. The charge target for THP volumes.
freeCapacityInGB=358 freeCapacityPercentage=92 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 An instance of StorageTier(2 of 2) name=StorageTier-1 filterCondition=RAIDLevel <> 'RAID5(3D+1P)' numberOfVolumes=2 totalCapacityInGB=9 totalCapacityPercentageToSto
[ common-option ] [ { -d | --detail } ] storagedomainname=storage-domain-name 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 d
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=2011/08/24 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=2011/08/30 12:06:41 lastModifyTime=2011/09/02 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=2011/08/29 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 1:02:0a or 01: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: 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=MigrationGro
Syntax htsmcli [ server-location] RemoveVolumeFromMigrationGroup [ common-option ] [ { -d | --detail } ] 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.
storagedomainname="MegaTechXP12000-Primary" name="MG011" controllerdevicenumber="3:A7" • 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) control
There are comment lines (lines that begin with #) in the candidate migration plan. If multiple migration target volume candidates exist, they are all shown within comment lines as well. Note that all volumes, other than the first candidate, are chosen not only from the SLPR to which the migration source volume belongs, but also from the other SLPRs.
Type of information Item Description targetStorageTierName The name of the migration target storage tier permitCrossSLPRMigration permitCrossCLPRMigration pair sourceControllerDeviceNumber Specify whether to allow migration between SLPRs. This can be either Yes or No: • Yes: Allow migration between SLPRs • No: Do not allow migration between SLPRs Specify whether to allow migration between CLPRs.
Syntax htsmcli [ server-location] CreateMigrationPlan [ common-option ] storagedomainname=storage-domain-name migrationgroupname=migration-group-name targetstoragetiername=target-storage-tier-name [ filtercondition=filter-condition ] 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.
Item Description Indicates whether migration is permitted for transferring volume data between SLPRs. This can be either Yes or No: permitCrossSLPRMigration • Yes: permitted • No: not permitted No is displayed when a candidate migration plan is created by using the CreateMigrationPlan command. Indicates whether migration is permitted for transferring volume data between CLPRs.
The value in KB is displayed in parentheses in addition to the value in TB, GB, MB, or KB. The value is displayed to two decimal places for TB or GB and as an integer for MB or KB. #2 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.
Legend: [ ]: Indicates a comment line. 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=2011/08/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
[ common-option ] [ { -f | --force } ] [ { -e | --execute } ] storagedomainname=storage-domain-name migrationgroupname=migration-group-name [ guardmode={ ReadOnly | Protect } ] [ retentiondays=locked-period ] [ movetomigrationgroupname=target-migration-group-name-after-locking ] [ notifytourl=event-notification-address ] [ description=task-description ] Options -f or --force Specify this option to create a locking task without confirmation.
Output items Table 49 Items output by the CreateLockingTask 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 (Locking) The task status status For details on the values displayed, see “Task statuses” on page 177.
htsmcli CreateLockingTask storagedomainname=MegaTechXP12000-Primary migrationgroupname=MG011 guardmode=ReadOnly retentiondays=365 Are you sure you want to lock the migration group "MG011"? (Y/N) : • Execution results (1): RESPONSE: An instance of Task(1 of 1) ID=TK1f2lymqv taskType=Locking status=Standby creationTime=2011/08/25 16:53:11 endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 retentionDays=365 retainedThrough= guardMode=Read only moveToMigrationGroupName= n
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 CreateUnlockingTask The CreateUnlockingTask command can be used to create an unlocking task that unlocks volumes whose locked period has expired. Unlocking is performed for a migration group.
Parameter Details 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. [notifytourl] [description] Specify the address to be notified when the event occurs. Specify a value by combining mailto: and the email address. Specify a description of the task. Legend: [ ]: Specifying this parameter is optional.
Example and execution results • Command execution example: In this example, an unlocking task that unlocks volumes is created. htsmcli CreateUnlockingTask storagedomainname=MegaTechXP12000-Primary migrationgroupname=MG011 • Execution results: RESPONSE: An instance of Task(1 of 1) ID=TK1f2lymqv taskType=Unlocking status=Standby creationTime=2011/08/25 16:53:11 endTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 moveToMigrationGroupName= notifyToURL=mailto:test@example.
Syntax htsmcli [ server-location] CreateShreddingTask [ common-option ] [ { -f | --force } ] [ { -e | --execute } ] storagedomainname=storage-domain-name migrationgroupname=migration-group-name [ shreddingmethod={ ZERO-ONCE | DoD } ] [ movetomigrationgroupname=name-of-target-migration-group-after-shredding ] [ notifytourl=event-notification-address ] [ description=task-description ] Options -f or --force Specify this option to create a shredding task without confirmation.
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 177. The estimated time for the task execution. timeEstimate This value is displayed in hhhh:mm:ss format.
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 177.
Item Description The estimated time for the task execution. timeEstimate If you specify the erasedata parameter during task creation, and then execute the task, this value will include the time to delete data. This value is displayed in hhhh:mm:ss format. If the estimated value is 10,000 hours or more, 9999:59:59 is displayed.
Item Description [estimatedZeroDataDiscardCompletionTime] The date and time when a zero data discard task is expected to finish ownerID The user ID of the user who created the task [ownerGroupID] The user group 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.
Item Description sourceSubsystemSerialNumber The serial number of the storage system that stores the actual data for the migration source volume. sourceSubsystemDisplayModel sourceSubsystemName sourceSubsystemVendor sourceSubsystemDeviceNumber sourceSubsystemDeviceID The display name for the model of the storage system that stores the actual data for the migration source volume. If the displayed model name is unknown, the product name is displayed.
Item targetSubsystemName targetSubsystemVendor targetSubsystemDeviceNumber targetSubsystemDeviceID Description The name of the storage system that stores the actual data for the migration target volume. If the storage system name is unknown, the product name and serial number are displayed. The vendor name of the storage system that stores the actual data for the migration target volume The LDEV number of the LU in the storage system that stores the actual data of the migration target volume.
Item Description timeEstimate The estimated time for the task execution for each volume. If you specify the erasedata parameter during task creation, and then execute the task, this value will include the time to delete data. This value is displayed in hhhh:mm:ss format. If the estimated value is 10,000 hours or more, 9999:59:59 is displayed.
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.
Item Description The lock status for a volume status For details on the values displayed, see “Task statuses” on page 177. 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.
Item Description moveToMigrationGroupName The target migration group name of a volume whose unlocking has been completed notifyToURL Event notification address description The description of the task 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.
Output items (shredding task) 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 ########. taskType The type of task (Shredding) The task status status For details on the values displayed, see “Task statuses” on page 177. The estimated time for the task execution. timeEstimate This value is displayed in hhhh:mm:ss format.
Item Description 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.) notifyToURL Event notification address description The description of the task Legend: [ ]: Indicates output only when either the -d or the --detail option is specified.
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. The estimated time for task execution for each volume. timeEstimate This value is displayed in hhhh:mm:ss format.
Item Description totalCapacityInGB The total capacity of the volume to be created (units: GB). Values of less than 1 GB are rounded down and displayed as an integer (for example, 4.5 GB is rounded down to 4 GB). notifyToURL The event notification address description The description of the task Legend: [ ]: Indicates output only when either the -d or the --detail option is specified. The output items described in Table 71 and Table 72 below are output only if the -d or --detail option is specified.
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. Output items (external mapping task) Table 73 Items output by the GetTasks command (external mapping task) (Task instance) Item Description The task ID.
Item Description notifyToURL The event notification address description The description of the task Legend: [ ]: Indicates output only when either the -d or the --detail option is specified. The output items described in Table 74, Table 75, and Table 76 below are output only if the -d or --detail option is specified.
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.
startTime= timeElapsed= endTime= lockingProgress=0 estimatedLockingCompletionTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 retentionDays=365 retainedThrough= 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.
endTime= unlockingProgress=0 estimatedUnlockingCompletionTime= ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 moveToMigrationGroupName= notifyToURL=mailto:test@example.com description= List of 2 UnlockingInfo elements: An instance of UnlockingInfo(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= 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 subsystemSerialNumber=10037 subsystemDisplayModel=XP24000 subsystemName=XP24000@10.208.115.221 subsystemVendor=HP totalCapacityInGB=19 notifyToURL=mailto:test@example.com description= List of 1 VolumeCreationInfo elements: An instance of VolumeCreationInfo(1 of 1) deviceNumber=00:03:A6,00:03:A7 arrayGroupName=E27-20 freeSpaceIndex=5 externalSubsystemSerialNumber=14011 externalSubsystemDisplayModel=XP12000 externalSubsystemName=XP12000@10.208.151.
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.151 externalSubsystemVendor=HP externalDeviceNumber=0:28 externalDeviceID=externalArrayGroupName=1-9-1 pathGroupID=1 capacityInKB=19,922,944 status=Standby timeElapsed= List of 2 ExternalPathInfo elements: An instance of ExternalPathInfo(1 of 2) port=CL1-H WWN=50.06.0E.
timeElapsed= endTime= 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=Meg
migrationProgress=0 timeElapsed= 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.
List of 2 ShreddingInfo elements: An instance of ShreddingInfo(1 of 2) 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.
ModifyTask The ModifyTask command enables you to change task information (such as the task description and event notification address). Task information cannot be changed in the following statuses: • Task has ended (End). • Task is in a storage domain whose refresh status is either Processing or Failure. The ModifyTask command can change the properties of multiple types of tasks. Therefore, the output items depend on the task type. The output items are described for each task.
Output items (for migration tasks, locking tasks, unlocking tasks, and shredding tasks) The following items that are output are the same as the items that are output when a task is created: • Migration task: See “Output items” on page 110 of the CreateMigrationTask command. • Locking task: See “Output items” on page 114 of the CreateLockingTask command. • Unlocking task: See “Output items” on page 117 of the CreateUnlockingTask command.
Item Description taskType The type of task (ExternalMapping) The task status status For details on the values displayed, see “Task statuses” on page 177.
storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 previousTargetStorageTierName= targetStorageTierName=MegaTech-HighCost eraseData=No zeroDataDiscard=No 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.
endTime=2011/09/02 16:53:45 ownerID=user storageDomainName=MegaTechXP12000-Primary migrationGroupName=MG011 previousTargetStorageTierName= targetStorageTierName=MegaTech-HighCost eraseData=No zeroDataDiscard=No notifyToURL=mailto:test@example.
You can specify a storage tier name or migration group name to limit the number of items in the list of volumes. You can further limit the items obtained by specifying the combination of a storage tier or migration group with a volume filter condition. Information cannot be obtained for volumes 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.
Parameter Details Specify a filter condition. [filtercondition] For details on the specifiable properties, see Table 5 and Table 8. If this is omitted, no filter condition is used to narrow down the search. Legend: [ ]: Specifying this parameter is optional.
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.
The output items shown below are output only if the -d or --detail option is specified. When multiple LDEV information items exist, the items are output successively. Table 89 Items output by the GetVolumes command (LDEV instance) Item Description The controller LDEV number. controllerDeviceNumber The number is displayed as a value that is a combination of hexadecimal values and colons (:).
Item Description 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. diskCapacityInGB The drive capacity (units: GB) The guard attribute that is applied to the LDEV. There are six guard attributes, as listed below.
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. arrayGroupNumber The parity group number of the LU in the storage system that stores the actual data. arrayGroupName The parity group name of the LU in the storage system that stores the actual data.
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 xpThinProvisioning=poolId= PVolMigrationGroupName= PVolDeviceNumber= PVolMUNumber= volumeStatus=Free volumeLockStatus=Unlocked path=No hostNames= logicalGroup= port/HostStorageDomain= SYSPLEXID/DEVN=
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.115.
capacityInKB=1,049,280 consumedCapacityInKB=1,049,280 consumedCapacityPercentage=100 cylinders= LBA=2,098,560 SLPRNumber= CLPRNumber=0 RAIDLevel=RAID5(3D+1P) diskType=SAS diskModelName=DKS5B-J300SS diskRPM=10,000 encryption=Disabled diskCapacityInGB=269 guardMode= retainedThrough= guardDate= controllerArrayGroupNumber=16 controllerArrayGroupName=1-2 cacheMode=Unknown IOSuppressionMode=Unknown subsystemDeviceNumber=00:04:FF subsystemDeviceID=subsystemSerialNumber=53038 subsystemDisplayModel=P9500 subsystemNa
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. 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: 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 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.
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. Table 96 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.CreatingVolume Volume creation in progress -- -- Y Active.
Parameter Task status Description Output item GetTasks DeleteTasks 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.
The following table describes 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 a value other than true or nothing. 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-, because the script htsmcli is running using umask 0 . logger.
Default: 10 logger.tracelogLevel property This property specifies the threshold for the output level for trace log data. 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 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.
Problem 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. Specify the path of the java command in the environment variable HTSM_CLI_JRE_PATH. If HTSM_CLI_JRE_PATH is not specified, perform the following: An error indicating that the specified command was not found occurred. The 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 access permissions for 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 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 pair, and the status is neither PSUS nor PSUE. • The volume is part of a Hitachi TrueCopy for Mainframe pair, and the status is not suspended.
Displayed character string Status of the specified volume XP Thin Provisioning [Pool Volume] The volume is a Thin Provisioning Software pool volume. XP Thin Provisioning [Unassigned] The volume is a Thin Provisioning Software virtual volume and is not associated with a pool. Legend: < >: The character string enclosed in parentheses is displayed when an XP12000/XP10000/SVS200 is used.
Displayed character string Status of the specified volume Migration Group (target) The volume is included in another migration group. NAS (target) The volume is a NAS system volume. Path (target) A path is set for the volume. VOLSER (target) VOLSER is set for the volume. The volume satisfies all of the following conditions: XP Snapshot (target) • The volume is the P-VOL of a Snapshot pair. < Snapshot XP (target) > • The status is PAIR. • The number of generations is 63 or less.
Conditions for migrating data from LUSE volumes Tiered Storage Manager software allows LUSE volumes to be specified as migration sources. If LUSE volumes are specified as migration sources, the following conditions must be met: • The migration target volumes must be either all internal volumes or all external volumes. • All the migration target volumes must have the same emulation type, drive type, I/O suppression mode, cache mode, and CLPR. • The migration target volumes must not be THP 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.
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. This rule has the following three options: - BalanceCapacity: Selects migration target volumes so that the parity groups that are selected as the migration destination have the same amount of remaining capacity. - MaximumCoverage: Selects migration target volumes from as many parity groups as possible.
zero data discard Action of discarding and releasing zero data (unused capacity that is not being accessed from hosts) in a migration-target THP volume after migration to a THP volume or THP pool is completed, reducing the amount of THP pool area in use. Zero data discard is the same as zero page reclaim in Device Manager.
Glossary
Index AddVolumeToMigrationGroup, 87 cost amount, 65, 74 currency code, 65, 74 format, 65 unit of capacity, 65, 74 unit of period, 65, 74 CreateLockingTask, 112 CreateMigrationGroup, 76 CreateMigrationPlan, 92 CreateMigrationTask, 107 CreateShreddingTask, 118 CreateStorageTier, 63 CreateUnlockingTask, 116 currency code, 65 C D Symbols --emergency, 153, 155 --execute option, 107 --force, 113, 119, 157 --output, 35 --password, 35 --secure using SSL communication, 36 --username, 35 A candidate migration
F I filter condition expressions, 39 filtercondition parameter, 39 newfiltercondition parameter, 39 Overview of properties, 42 Overview of properties that can be specified for pool filter condition expressions, 44 Overview of properties that can be specified for unused capacity filter condition expressions, 45 Overview of properties that can be specified for volume filter condition expressions, 42 property, 45 range of valid property values, 45 range of valid property values for pool filter conditions, 51
N normal volume (Glossary), 205 O obtain list of volumes (LUs), 160 option common options, 35 option.output property, 184 option.password property, 184 option.password2 property, 184 option.secure property, 184 option.username property, 184 over-provisioning percent, 172 P parameter, 36 character length that can be specified, 196 character type that can be specified, 196 parameter.
uninstalling, 23 HP-UX, 24 Linux, 24 Solaris, 24 Windows system, 24 unlocking task creating, 116 immediate execution, 116 User Account Control function, 33 V virtual volume (Glossary), 206 virtual volume group (Glossary), 206 W Windows 7 setup.bat, 22 unsetup.bat, 24 Windows Server 2008 setup.bat, 22 unsetup.bat, 24 Windows Vista 4-byte characters, 37 setup.bat, 22 unsetup.
