HP StorageWorks Command View XP Advanced Edition Device Manager CLI User Guide Part number: T1780-96011 Second edition: October, 2005
Legal notices © Copyright 2005 Hewlett-Packard Development Company, L.P. Hewlett-Packard Company makes no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Hewlett-Packard shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material.
Contents Revision history Revision tables ....................................................................................................................................................... 9 1 Command View XP Advanced Edition Device Manager Overview 1-1 1-2 1-3 1-4 1-5 Overview of Command View XP Advanced Edition Device Manager ....................................................... 10 Command View XP Advanced Edition Device Manager Software Components ......................................
-5-13 DeleteWWNGroup.......................................................................................................................... 81 4-5-14 ModifyLunGroup ............................................................................................................................. 81 4-5-15 ModifyWWNGroup.......................................................................................................................... 82 4-6 Host Management Commands.......................................
Figures Figure 3-1 Example of CLI Help for the AddLun Command ...................................................................................... 15 Figure 3-2 CLI Help (continues on next page) ........................................................................................................... 17 Tables Table 1 Document conventions .................................................................................................................................. 7 Table 2 Revisions ................
Table 4-51 AddWWNGroup Command Parameters................................................................................................. 77 Table 4-52 DeleteLun Command Parameters .......................................................................................................... 78 Table 4-53 DeleteLunGroup Command Parameters ................................................................................................ 78 Table 4-54 DeleteWWN Command Parameters ...................................
About this guide This document describes and provides instructions for using the Command Line Interface (CLI) software for HP StorageWorks Command View XP Advanced Edition Device Manager. Intended audience This document assumes that the user: • Has a background in data processing and understands peripheral storage device subsystems and their basic functions. • Is familiar with the operating system which hosts the HP StorageWorks Command View XP Advanced Edition Device Manager Web Client software.
HP technical support Telephone numbers for worldwide technical support are listed on the HP web site: http://www.hp.com/support/ Collect the following information before calling: • Technical support registration number (if applicable) • Product serial numbers • Product model names and numbers • Applicable error messages • Operating system type and revision level • Detailed, specific questions For continuous quality improvement, calls may be recorded or monitored.
Revision history Table 2 Revisions Date Edition Revision July 11, 2005 First Initial Release October, 2005 Second • By the AddHostStorageDomain command and ModifyPort command, the following hostmode modes have been added: • Standard Extension2 • Solaris Extension2 • Windows Extension2 • AIX Extension2 Revision history 9 Revision history Revision tables
1 Command View XP Advanced Edition Device Manager Overview This chapter provides an overview of Command View XP Advanced Edition Device Manager and describes its software components.
the Device Manager server. For further information on Device Manager Web Client, please refer to the HP StorageWorks XP Advanced Edition Device Manager Web Client User Guide. • Agent. The Device Manager agents run on host computers attached to StorageWorks XP Disk Array storage subsystems under management by Device Manager. The Agent on a host collects data on the configuration and utilization of the attached storage and sends this information to the Device Manager server.
2 Setting Up Command Line Interface This chapter describes the system requirements and launching instructions for Device Manager CLI. • CLI Requirements (section 2-1) • Launching CLI (section 2-2) • Using CLI with a secured server (section 2-3) 2-1 Requirements for CLI Operations • Storage Subsystems. All storage subsystems must be configured for Device Manager operations.
• Port number of the Device Manager server (default is 2001) • Base address of the Device Manager server (default is service, unless the server has been configured with a non-standard servlet alias) NOTE: When the CLI properties file has an option with no arguments, you cannot cancel the option from the command line. To launch Device Manager CLI, execute the following command from Device Manager CLI installation directory: • In Windows®: C:\hdvm> hdvmcli.bat • In Solaris™ or HP-UX: # ./hdvmcli.
3 Command Line Interface Syntax and Parameters This chapter describes the command syntax and command parameters. • Command Line Values Syntax (section 3-1) • CLI Return Responses (section 3-2) • Displaying CLI Help (section 3-3) • Guidelines for Executing CLI Commands (section 3-4) 3-1 Command Line Syntax Device Manager CLI only supports ASCII characters.
description=“Our Newest Array” Each command may have required parameters, optional parameters, or both, and you can specify any parameter in the application’s properties file. If a parameter is specified both on the command line and in the properties file, the value from the command line is used. For more information on Device Manager properties, please refer to the HP StorageWorks Command View XP Advanced Edition Device Manager Server Installation and Configuration Guide.
Figure 3-2 displays sample help information, including the CLI version. Device Manager CLI version "1.1.
Figure 3-2 CLI Help (continues on next page) DeleteLUSE AddReplication DeleteReplication ModifyReplication AddConfigFileForReplication GetReplicationControllerPair AddArrayReservation ModifyArrayReservation DeleteArrayReservation GetArrayReservation FOR COMMAND-SPECIFIC HELP, TYPE: "hdvmcli help {server-command}" AVAILABLE OPTIONS: -u {userid} or --user {userid} login user ID for Device Manager Server -p {password} or --password {password} login password for Device Manager Server -s or --secure presence
Table 3-3 Notes on Executing CLI Commands Item Description Related Commands Changing the security or deleting storage that belongs to a LUN group. When changing the security or deleting LUNs that belong to LUN groups, perform operations on each LUN group.If you want to delete or change security for only some of the LUNs that belong to a LUN group, use the ModifyLunGroup command to release the target LUNs from the LUN group, and then perform the operation for each LUN.
4 Command Line Interface Commands This chapter discusses the following topics: • Extracting parameter values (section 4-1) • CLI commands and subsystem applicability (section 4-2) • Storage Array Commands (section 4-3) • Logical Command Groups (section 4-4) • LUN Commands (section 4-5) • Host Management Commands (section 4-6) • Server Management Commands (section 4-7) • Replication Commands (section 4-8) 4-1 Extracting Parameter Values Some of the parameter values for CLI commands can be fou
Table 4-1 Extracting Parameter Values To Find This Parameter Value: Do This: lun Execute the GetStorageArray (subtarget=HostStorageDomain, hsdsubinfo=freelun) command, specifying only the model and serialnum parameters, HostStorageDomain for the subtarget parameter, and freelun for the hsdsubinfo parameter. Use one of the lun values.
Table 4-1 Extracting Parameter Values To Find This Parameter Value: Do This: svolserialnum Execute the GetHost command, and then obtain the value from the execution result. wwn Execute the GetStorageArray (subtarget=Port, portsubinfo=WWN, WWNGroup, wwngroupsubinfo=WWN) command, specifying WWN for the portsubinfo parameter, and then obtain the value from the execution result. NOTE: As an alternative method, you can specify the wwn parameter by creating a new WWN.
Table 4-2 Storage Array Commands Command Name Description Storage Subsystems Section XP12000/XP10000 and XP1024/XP128 XP512/XP48 ModifyArrayReservation Extends the maximum period for which a specified storage subsystem is locked. Y Y 4-3-13 ModifyLogicalUnit Modifies the settings of the logical units and the corresponding LDEVs. Y Y 4-3-14 ModifyPort Modifies port attributes. Y Y 4-3-15 ModifyPortController Modifies port controller attributes.
Table 4-4 LUN Commands Command Name Description Storage Subsystems XP12000/XP10000 and XP1024/XP128 Section XP512/XP48 AddWWNForHostStorageDomain Sets the security of a LUN in the Y host storage domain by assigning its WWN in the host storage domain. Y 4-5-3 AddWWNForLun Sets the security of a path by assigning its WWN. -- Y 4-5-4 AddWWNForLunGroup Sets the security of a LUN in a LUN group by assigning a WWN in the LUN group. -- Y 4-5-5 AddWWNGroup Creates a WWN group.
Table 4-6 Server Management Commands Command Name Description Section AddURLLink Adds the URL associated with the application, and links it to the Command View XP AE 4-7-1 object. DeleteAlerts Deletes information about one or more alerts that are managed by the Device Manager 4-7-2 server. DeleteURLLink Deletes the relationship between the application or web page, and the Device Manager 4-7-3 server object.
• AddLUSE • DeleteLUSE • AddWWNForHostStorageDomain • DeleteWWNForHostStorageDomain • AddWWNForLun • DeleteWWNForLun • DeleteWWN • AddWWNGroup • ModifyWWNGroup • DeleteWWNGroup • AddLunGroup • ModifyLunGroup • DeleteLunGroup • AddWWNForLunGroup • DeleteWWNForLunGroup • AddLogicalUnit • DeleteLogicalUnit • ModifyLogicalUnit • ModifyPort • ModifyPortController Users with access to this command: • Yes: System Administrator, Storage Administrator • No: Guest, Local Sys
NOTE: For the StorageWorks XP12000/XP10000 and XP1024/XP128, when AddHostStorageDomain adds a host storage domain, the LUN security of the target port is automatically enabled. Table 4-9 AddHostStorageDomain Command Parameters Parameter Name Status Description domain Required DomainID of the host storage domain. NOTE: The specifiable values vary, depending on the storage subsystem.
Table 4-9 AddHostStorageDomain Command Parameters Parameter Name Status Description nickname Optional Nickname of the Host Storage Domain. (StorageWorks XP12000/XP10000 The maximum number of characters that can be used for a nickname is as and XP1024/XP128) follows: StorageWorks XP12000/XP10000: 16 bytes DKC microcode version 50-04-01 or later: 32 bytes StorageWorks XP1024/128: 8 bytes serialnum Required Serial number of the storage array for the Host Storage Domain.
Table 4-10 AddLogicalUnit Command Parameters Parameter Name Status Description emulation Optional Emulation type of the logical unit in the StorageWorks XP Disk Array. Specify the same emulation type as the array group in which a logical unit is created. devnum Optional LU device number. If omitted, the number is automatically generated. lusubinfo Optional If set to LDEV, return the information on LDEV(s) related to the LU. Do not include any LU LDEVs.
path=false onDemandDevice=false devType= isStandardLDEV=false guardMode= substance=0 volumeType=3 diskType=-1 cacheResidencyMode=-1 stripeSizeInKB=-1 slprNumber=-1 clprNumber=-1 volumeKind=3 4-3-4 AddLUSE AddLUSE creates a LUSE without any path in the storage device (see Table 4-11).
journalVolumeType=Simplex sysVolFlag=0 externalVolume=0 differentialManagement=0 List of 2 Ldev elements: An instance of LDEV objectID=LDEV.HDS9980V.15001.
• Yes: System Administrator, Storage Administrator • No: Guest, Local Guest • Restricted: A Local System Administrator or Local Storage Administrator can use this command only when updating the registered information. NOTE: When you are performing this command, do not shut down the hosts that are using storage subsystem volumes, or the host for the Device Manager agent, or execution might take longer.
agentVersion=02-05-14 productName=XP1024 controllerVersion=21-04-00-00/00 numberOfControllers=4 capacityInGB=4,018 cacheInMB=-1 sharedMemoryInMB=-1 numberOfSpareDrives=-1 freeCapacityInGB=3,585 allocatedCapacityInGB=434 autoLunCapacityInGB=0 onDemandCapacityInGB=0 totalFreeSpaceInGB=45 largestFreeSpaceInGB=5 capacityInKB=4,213,640,160 freeCapacityInKB=3,759,001,920 allocatedCapacityInKB=454,638,240 autoLunCapacityInKB=0 onDemandCapacityInKB=0 totalFreeSpaceInKB=47,008,512 largestFreeSpaceInKB=5,753,088 mult
• Yes: System Administrator, Storage Administrator, Local System Administrator, Local Storage Administrator • No: Guest, Local Guest Table 4-13 AddStorageArray Command Parameters Parameter Name Status Description model Required Model of the storage subsystem. serialnum Required Serial number of the storage subsystem. Command execution example: hdvmcli DeleteArrayReservation -o "D:\logs\DeleteArrayReservation.
Table 4-15 DeleteLogicalUnit Command Parameters Parameter Name Status Description devnum Required Device number of the LU. model Required Model of the storage array of the LU. serialnum Required Serial number of the storage array of the LU. Command execution example: hdvmcli DeleteLogicalUnit -o "D:\logs\XP12000 DeleteLogicalUnit.
hdvmcli DeleteStorageArray -o "D:\logs\XP1024 DeleteStorageArray.log" "serialnum=10001" "model=XP1024" Command execution result: RESPONSE: (Command completed; no data returned) 4-3-11 GetArrayReservation GetArrayReservation obtains information about a locked storage subsystem. This command does not have parameters.
Command execution example: In this example, the CLI command obtains information about the configuration of all the storage subsystems managed by the Device Manager server: hdvmcli GetStorageArray Command execution result: RESPONSE: An instance of StorageArray objectID=ARRAY.HDS9960.10011 name= XP512@10.208.114.140 description= XP512 (10011) at 10.208.114.
Table 4-19 GetStorageArray (subtarget=ArrayGroup) Command Parameters Parameter Name Status Description serialnum Optional Serial number of the storage subsystem. When you omit this parameter, all the storage subsystems become the target. subtarget Required Specify ArrayGroup. objectid Optional Object ID of the array group in a storage subsystem. When you omit this parameter, all the array groups become the target. arraygroupsubinfo Optional Information obtained about an array group or groups.
mfAllocatedCapacity=0 mfUnallocatedCapacity=0 . . (repeated for other ArrayGroup instances) . Command execution example 2: In this example, the CLI command obtains information only about one array group (object ID: ARRAYGROUP.HDS9980V.10001.1.0) in a storage subsystem (serial number: 10001, model: XP1024). hdvmcli GetStorageArray -o "D:\logs\XP1024 GetStorageArray_ArrayGroup.log" subtarget=ArrayGroup model=XP1024 serialnum=10001 objectID=ARRAYGROUP.HDS9980V.10001.1.
• Restricted to permitted resources: Guest, Local System Administrator, Local Storage Administrator, Local Guest Table 4-20 GetStorageArray (subtarget=Commparameters) Command Parameters Parameter Name Status Description model Optional Model of the storage subsystem. When you omit this parameter, you will obtain information about the models of all storage subsystems. serialnum Optional Serial number of the storage subsystem.
serialNumber=10011 arrayFamily=HDS9900 arrayType=HDS9960 microcodeVersion=01-13-56/00 agentVersion=02-01-06/00 productName=XP512 controllerVersion=01-18-01-00/00 numberOfControllers=1 capacityInGB=1,326 cacheInMB=7,168 sharedMemoryInMB=-1 numberOfSpareDrives=-1 freeCapacityInGB=701 allocatedCapacityInGB=624 autoLunCapacityInGB=0 onDemandCapacityInGB=0 totalFreeSpaceInGB=124 largestFreeSpaceInGB=63 capacityInKB=1,390,713,840 freeCapacityInKB=735,710,400 allocatedCapacityInKB=655,003,440 autoLunCapacityInKB=0
description=Normal An instance of Component name=DKC Cache Switch value=1 description=Normal An instance of Component name=DKC Environment value=1 description=Normal An instance of Component name=DKC Fan value=1 description=Normal An instance of Component name=DKC Power Supply value=1 description=Normal An instance of Component name=DKC Processor value=1 description=Normal An instance of Component name=DKC Shared Memory value=1 description=Normal An instance of Component name=DKU Drive value=1 description=N
Table 4-22 GetStorageArray (subtarget=Filter) Command Parameters Parameter Name Status Description objectID Required Object ID of the component of a storage subsystem. The component identified by the object ID you specify with this parameter will be returned. Command execution example: In this example, the CLI command obtains information about a logical unit (objectID: LU.HDS9980V.10001.100) that is a component of a storage subsystem (serial number: 10001, model: XP1024).
Table 4-23 GetStorageArray (subtarget=FreeSpace) Command Parameters Parameter Name Status Description serialnum Optional Serial number of the storage subsystem. When you omit this parameter, all the storage subsystems become the target. subtarget Required Specify FreeSpace. arraygroupobjid Optional Object ID of an array group that has free space. When you omit this parameter, the command displays the information about all the storage array groups.
fsControlIndex=85 . . (repeated for other ArrayGroup instances) . Command execution example 2: In this example, the CLI command obtains information about the free space in an array group (objectID: ARRAYGROUP.HDS9980V.10001.1.16) that belongs to a storage subsystem (serial number: 10001, model: XP1024). hdvmcli GetStorageArray -o "D:\logs\XP1024 GetStorageArray_FreeSpace.log" subtarget=FreeSpace model=XP1024 serialnum=10001 arraygroupobjid=ARRAYGROUP.HDS9980V.10001.1.
4-3-12-6 GetStorageArray (subtarget=HostStorageDomain) GetStorageArray (subtarget=HostStorageDomain) obtains the information about a host storage domain of one or all storage subsystems.
An instance of FreeLUN lun=10 . . (repeated for other FreeLUN instances) . List of 249 Path elements: An instance of Path objectID=PATH.HDS9980V.10001.7.0.10 devNum=10 portID=7 domainID=0 scsiID=15 LUN=10 wwnSecurityValidity=true . . (repeated for other Path instances) . An instance of HostStorageDomain . . (repeated for other HostStorageDomain instances) .
RESPONSE: An instance of StorageArray . . (Attributes of StorageArray are omitted here) . List of 1756 Ldev elements: An instance of LDEV objectID=LDEV.USP.10001.
Table 4-26 GetStorageArray (subtarget=LogicalUnit) Command Parameters Parameter Name Status Description serialnum Optional Serial number of the storage subsystem. When you omit this parameter, all the storage subsystems become the target. subtarget Required Specify LogicalUnit. lufilter Optional Filter for selecting a logical unit. Available values are ALL, ASSIGNED, and FREE. When you omit this parameter or specify ALL, you will obtain information about all the logical units.
isComposite=0 continuousAccessVolumeType=Simplex businessCopyVolumeType=Simplex snapshotVolumeType=Simplex journalVolumeType=Simplex sysVolFlag=0 externalVolume=1 differentialManagement=0 List of 3 Path elements: An instance of Path . . (Attributes of Path are omitted here) . An instance of Path . . (Attributes of Path are omitted here) . List of 2 WWN elements: An instance of WWN WWN=88.77.77.77.77.77.00.01 nickname=Jane An instance of WWN WWN=88.77.77.77.77.77.3F.04 nickname=Jone . .
vendor= HP . . (repeated for other VolumeConnection instances) . 4-3-12-9 GetStorageArray (subtarget=Path) GetStorageArray (subtarget=Path) obtains the information about a path in one or all storage subsystems.
List of 256 WWN elements: An instance of WWN WWN=88.77.77.77.77.77.00.01 nickname=Jane An instance of WWN WWN=88.77.77.77.77.77.00.02 nickname=Jone . . (repeated for other WWN instances) . Command execution example 2 (objectid parameter specified): In this example, the CLI command obtains information about a path (objectID: PATH.HDS9980V.10001.7.0.99) that is set for a storage subsystem (serial number: 10001, model:XP1024).
Table 4-28 GetStorageArray (subtarget=PDEV) Command Parameters Parameter Name Status Description arraygroupobjid Optional Object ID of the array group containing the PDEVs to be returned. If you intend to obtain the information about the PDEVs in all the array groups, specify ALL. pdevid Optional The right-most value of the object ID of the PDEV to be returned. (Among the four elements of the object ID, the right-most one is the ID of the PDEV.
Table 4-29 GetStorageArray (subtarget=Port) Command Parameters Parameter Name Status Description subtarget Required Specify Port. port Optional Number of the port of the storage subsystem. When you omit this parameter, you will obtain information about all the ports. portsubinfo Optional Specific information about the ports. The value you can specify is WWN, WWNGroup, LUNGroup, or HostStorageDomain. wwngroupsubinfo Optional Information obtained from a WWN group.
domainID=1 hostMode=Standard displayName=CL1-A-1 nickname=HCMD0000 List of 2 WWN elements: An instance of WWN WWN=00.00.00.00.00.00.00.01 nickname=Jane An instance of WWN WWN=00.00.00.00.00.00.00.50 nickname=Jone List of 1 LUNGroup elements An instance of LUNGroup objectID=LUNGroup.HDS9960.10001.0.0.hp name=hp nickname=hp .
displayName=CHA-1P mode=1 type=12 . . (repeated for other PortController instances) . Command execution example 2: In this example, the CLI command obtains information about the port controller (ID: 1) used for a storage subsystem (serial number 10001, model XP1024) hdvmcli GetStorageArray -o "D:\logs\XP1024 GetStorageArray_PortController.log" subtarget=PortController model=XP1024 serialnum=10001 controllernum=1 Command execution result 2: RESPONSE: An instance of StorageArray . .
RESPONSE: An instance of StorageArray . . (Attributes of StorageArray are omitted here) . List of 2 ReplicationInfo elements: An instance of ReplicationInfo objectID=REPINFO.10001.100.10001.101 pvolSerialNumber=10001 pvolArrayType=HDS9980V pvolDevNum=100 pvolObjectID=LU.HDS9980V.10001.100 pvolPoolID=-1 svolSerialNumber=10001 svolArrayType=HDS9980V svolDevNum=101 svolObjectID=LU.HDS9980V.10001.
isComposite=0 continuousAccessVolumeType=Simplex businessCopyVolumeType=S-VOL snapshotVolumeType=Simplex journalVolumeType=Simplex sysVolFlag=0 externalVolume=0 differentialManagement=0 . . (repeated for other ReplicationInfo instances) . 4-3-13 ModifyArrayReservation ModifyArrayReservation extends the period of time that can elapse before the target storage subsystem is unlocked (see Table 4.32). Reservation affects only Storage Array Commands and LUN Commands.
NOTE: If you are using a StorageWorks XP512/XP48, check that at least one path is set for the logical unit that is subject to this command’s processing. NOTE: For the StorageWorks XP512/XP48, make sure that one or more paths have been set to the logical unit to which the command executes. If specifying the commanddevicesecurity parameter, use it with the commanddevice parameter.
4-3-15 ModifyPort ModifyPort will change port and host storage domain attributes.
Table 4-34 ModifyPort Command Parameters Parameter Name Status Description hostmode Optional New host connect mode value for the port. To change this value, you must specify the domain parameter. For values available to the StorageWorks XP Disk Array, see Table 435. hostModeOption Optional (XP12000/XP10000 only) An option of the host connection mode. To specify two or more options, separate them with semicolons (;). For details on the values that you can specify, see Table 4-36.
Table 4-36 hostModeOption Parameter Values and Description hostModeOption Values Description 2 6 Specify this value when using VERITAS™ Database Edition/Advanced Cluster for Real Application Clusters or VERITAS™ Cluster Server 4.0 (I/O fencing feature). Specify this value when all of the following conditions are satisfied: The host connection mode is set to Windows (mode 0C) or Windows Extension (mode 2C). ® An Emulex host bus adapter is in use. A mini-port driver is in use.
objectID=HSDOMAIN.HDS9980V.10001.16.0 portID=16 domainID=0 nickname=HDvM1000 hostMode=Standard 4-3-16 ModifyPortController ModifyPortController supports changing characteristics of a PortController (see Table 4-37).
Table 4-38 RefreshStorageArrays Command Parameters Parameter Name Status Description interval Optional Interval time in minutes from storage subsystem recovery completion to start of next storage subsystem recovery. You can specify a value from 0 to 2147483647. If it is not set, the default interval time is 0. NOTE: An error is generated if you specify a negative number or if you include the plus (+) sign.
• No: Guest, Local Guest Table 4-39 AddLogicalGroup Command Parameters Parameter Name Status Description groupname Required Name for the new logical group. This must be unique among groups within its parent (if the parent parameter is supplied) or unique among top-level groups (if no parent is specified). iconfile Required Name of the icon file that visually represents the new logical group. The specified icons are displayed in the Web Client window.
4-4-2 AddLunScan AddLunScan scans a storage array for LUNs not assigned to a logical group (see Table 4-40). It assigns those LUNs to subgroups of the “LUN Scan” group according to port and security. AddLunScan creates those subgroups, as necessary, returning the specified storage array, and each of the previously unassigned LUNs.
Table 4-41 AddObjectForLogicalGroup Command Parameters Parameter Name Status Description objectid Required Object ID of the logical group. groupelements Required Comma-separated list of one or more object IDs of the HostStorageDomains and/or hosts to add to the logical group. Command execution example: hdvmcli AddObjectForLogicalGroup -o "D:\logs\XP1024 AddObjectForLogicalGroup.log" "objectID=GROUP.0" "groupelements=PATH.HDS9980V.10001.0.0.
Parameter Name Status Description objectid Required Object ID of the logical group. groupelements Required Comma-separated list of one or more object IDs of the HostStorageDomains and/or hosts to be removed from the logical group. These must be valid IDs of objects currently in the group. Command execution example: hdvmcli DeleteObjectForLogicalGroup -o "D:\logs\XP1024 DeleteObjectForLogicalGroup.log" "objectID=GROUP.0" "groupelements=PATH.HDS9980V.10001.0.0.
nickname=1A-G00 An instance of Path objectID=PATH.HDS9980V.10001.0.0.101 devNum=101 portID=0 domainID=0 scsiID=15 LUN=8 wwnSecurityValidity=true . . (repeated for other LogicalGroup instances) . Command execution example 2: hdvmcli GetLogicalGroup -o "D:\logs\GetLogicalGroup.log" "objectID=GROUP.1" "subtarget=Host,HostStorageDomain,path" Command execution result 2: RESPONSE: An instance of LogicalGroup objectID=GROUP.1 name=toro parentID=GROUP.0 logicalPath=root/toro icon=group12.
icon=group12.gif capacity=0 capacityInKB=0 realCapacityInKB=0 percentUsed=0 numberOfLUNs=0 . . (repeated for other LogicalGroup instances) . 4-4-7 ModifyLogicalGroup ModifyLogicalGroup changes one or more characteristics of an existing logical group (see Table 4-45).
• Yes: System Administrator, Storage Administrator, Local System Administrator, Local Storage Administrator • No: Guest, Local Guest • Restricted to permitted resources: Local System Administrator, Local Storage Administrator NOTE: For the StorageWorks XP12000/XP10000 and XP1024/XP128, when AddLun adds a LUN whose domain ID is not 0 to the host storage domain, the LUN security of the target port is automatically enabled.
RESPONSE: An instance of StorageArray . . (Attributes of StorageArray are omitted here) . List of 1 Path elements: objectID=PATH.HDS9960.10001.3.16.127 name=liu devNum=127 portID=3 domainID=16 scsiID=15 LUN=127 wwnSecurityValidity=true List of 1 WWN elements: An instance of WWN WWN=AA.AA.AA.AA.AA.AA.AA.AA nickname=Jane List of 2 Ldev elements: An instance of LDEV objectID=LDEV.HDS9960.10001.
clprNumber=-1 volumeKind=3 Command execution example 2: hdvmcli AddLun -o "D:\logs\XP1024\AddLun.log" "serialnum=10001" "model=XP1024" "name=hp" "port=1" "domain=4" "scsi=15" "lun=114" "lusedevnums=1001,1002" Command execution result 2: RESPONSE: An instance of StorageArray . . (Attributes of StorageArray are omitted here) . List of 1 Path elements: An instance of Path objectID=PATH.HDS9980V.10001.1.4.
path=false onDemandDevice=false devType= isStandardLDEV=true guardMode= substance=0 volumeType=3 diskType=-1 cacheResidencyMode=-1 stripeSizeInKB=-1 slprNumber=-1 clprNumber=-1 Command execution example 3: hdvmcli AddLun -o "D:\logs\XP1024 AddLun.log" "serialnum=10001" "model=XP1024" "name=hp" "port=1" "domain=4" "scsi=15" "lun=120" "devnum=1006" Command execution result 3: RESPONSE: An instance of StorageArray . . (Attributes of StorageArray are omitted here) .
hdvmcli AddLunGroup -o "D:\logs\XP512 AddLunGroup.log" "serialnum=10001" "model=XP512" "port=19" "groupelements=PATH.HDS9960.10001.16.2.0,PATH.HDS9960.10001.16.2.1" "nickname=hp" "name=hp" Command execution result: RESPONSE: An instance of StorageArray . . (Attributes of StorageArray are omitted here) . List of 1 Port elements: An instance of Port . . (Attributes of Port are omitted here) . List of 1 LUNGroup elements: An instance of LUNGroup objectID=LUNGROUP.HDS9960.10001.0.19.
"wwn=22.33.44.55.44.55.44.33,11.33.22.33.44.33.22.22" Command execution result: RESPONSE: An instance of StorageArray . . (Attributes of StorageArray are omitted here) . List of 1 HostStorageDomain elements: An instance of HostStorageDomain objectID=HSDOMAIN.HDS9980V.10001.1.1 portID=1 domainID=1 hostMode=Standard displayName=CL1-B-1 nickname=HCMD0103 List of 2 WWN elements: An instance of WWN WWN=22.33.44.55.44.55.44.33 nickname=Jane An instance of WWN WWN=11.33.22.33.44.33.22.
An instance of Path objectID=PATH.HDS9960.10001.16.0.16 devNum=16 portID=16 domainID=0 scsiID=15 LUN=16 wwnSecurityValidity=true List of 1 WWN elements: An instance of WWN WWN=AA.AA.AA.AA.AA.AA.AA.AA nickname=Jane 4-5-5 AddWWNForLunGroup AddWWNForLunGroup secures a LUN group by assigning one or more WWN(s) to it (XP512/XP48 subsystem only) (see Table 4-50). If all of the WWNs in a WWN group are assigned, the WWN group is used to secure the LUN group.
WWN=11.55.77.99.33.00.22.66 . . (repeated for other Path instances) . 4-5-6 AddWWNGroup AddWWNGroup adds a WWN group to a target storage array port (XP512/XP48 subsystem only) and two or more WWN(s) to the WWN group (see Table 4-51). The maximum number of WWNs in a port WWN group is 127. Only new WWNs (none that pre-exist on the port) can be added. A maximum of 127 WWN groups can be set to a port.
nickname=Jone 4-5-7 DeleteLun DeleteLun deletes a path from a host to a volume (see Table 4-52). If the LUN is secured, the corresponding WWN is required.
"model=XP512" "port=19" "lungroupid=LUNGROUP.HDS9960.10011.19.LG00" Command execution result: RESPONSE: (Command completed; no data returned) 4-5-9 DeleteWWN DeleteWWN removes a WWN from a port (see Table 4-54).
Command execution result: RESPONSE: (Command completed; no data returned) 4-5-11 DeleteWWNForLun DeleteWWNForLun removes access to a WWN path (see Table 4-56). NOTE: This command is available only to users of the StorageWorks XP512/XP48.
Table 4-57 DeleteWWNForLunGroup Command Parameters Parameter Name Status Description wwn Required Comma-separated list of WWNs that exist in the LUN group. Command execution example: hdvmcli DeleteWWNForLunGroup -o "D:\logs\XP512 DeleteWWNForLUNGroup.log" "serialnum=10001" "model=XP512" "port=19" "objectid=LUNGROUP.HDS9960.10001.19.hp" "wwn=11.55.77.99.33.00.22.66,AA.AA.AA.AA.AA.AA.AA.
NOTE: ModifyLunGroup is supported by StorageWorks XP512/XP48 storage subsystems only. Table 4-59 ModifyLunGroup Command Parameters Parameter Name Status Description serialnum Required Serial number of the storage array in which the LUN group exists. model Required Model of the storage array in which the LUN group exists. port Required Port number of the LUN group. objectid Required Object ID of the LUN group.
• No: Guest, Local Guest • Restricted to permitted resources: Local System Administrator and Local Storage Administrator do not have access range limitations. NOTE: ModifyWWNGroup is supported by StorageWorks XP512/XP48 storage subsystems only. Table 4-60 ModifyWWNGroup Command Parameters Parameter Name Status Description serialnum Required Serial number of the storage array in which the WWN group exists. model Required Model of the storage array in which the WWN group exists.
4-6-1 AddHost AddHost adds information about a host server to the Device Manager server (see Table 4-61). Users with access to this command: • Yes: System Administrator, Storage Administrator • No: Guest, Local System Administrator, Local Storage Administrator, Local Guest Table 4-61 AddHost Command Parameters Parameter Name Status Description hostname Required Name of the new host. wwnlist Optional Comma-separated list of WWNs. ipaddress Optional IP address of the new host.
Table 4-62 AddHostInfo Command Parameters Parameter Name Status Description portwwn Optional Port WWN on the host bus adapter. filetype Optional Type of the file System. filename Optional Name of the file System. size Optional LUN size in MB. percentused Optional Percent of the LUN in use.
• Yes: System Administrator, Storage Administrator, Local System Administrator, Local Storage Administrator • No: Guest, Local Guest • Restricted to permitted resources: Local System Administrator, Local Storage Administrator Table 4-63 AddHostRefresh Command Parameter Parameter Name Status Description objectid Required Specify the object ID of the target host. In this example, the CLI command obtains the latest information about the host where an object ID is HOST.5.
Table 4-65 DeleteHostInfo Command Parameters Parameter Name Status Description objectid Required Object ID of the HostInfo record to be removed. Command execution example: hdvmcli DeleteHostInfo -o "D:\logs\XP1024 DeleteHostInfo.log" "objectid=HOSTINFO.MY_HOSTINFO_XP1024.0.15.1" Command execution result: RESPONSE (Command completed; no data returned) 4-6-6 GetHost GetHost returns the information about one or all host servers (see Table 4-66).
objectID=CONFIGFILE.1.11 instanceNumber=11 controlledBy=Device Manager portNumber=50000 valid=1 List of 1 ReplicationGroup elements: An instance of ReplicationGroup objectID=REPGROUP.3 replicationGroupID=3 groupName=HCMD_CG0003 pvolHostID=1 pvolInstanceNumber=11 pvolPortNumber=50,000 svolHostID=2 svolInstanceNumber=12 svolPortNumber=50,001 replicationFunction=BusinessCopy copyTrackSize=15 List of 2 ReplicationInfo elements: An instance of ReplicationInfo objectID=REPINFO.65010001.11.65010001.
ipAddress=192.168.32.63 capacityInKB=0 hostType=-1 List of 2 WWN elements: An instance of WWN WWN=00.99.66.33.88.55.22.77 nickname=Jane An instance of WWN WWN=11.44.77.22.55.88.33.66 nickname=Jone List of 1 ConfigFile elements: An instance of ConfigFile objectID=CONFIGFILE.1.11 instanceNumber=11 controlledBy=Device Manager portNumber=50,000 valid=1 List of 1 ReplicationGroup elements: An instance of ReplicationGroup objectID=REPGROUP.
copyTrackSize=15 splitTime=-1 4-6-7 GetHostInfo GetHostInfo returns either a selected HostInfo record or all the HostInfo on the Device Manager server (see Table 4-67). The name of the host that does not have access privileges is displayed as n/a. Table 4-67 GetHostInfo Command Parameters Parameter Name Status Description objectid Optional Object ID of the HostInfo record to be retrieved. Omit this parameter to return all HostInfo records.
devNum=3 osScsiBus=0 osScsiID=15 osLun=1 portWWN=11.22.33.44.55.66.77.88 fileSystemType=NTFS fileSystemName=C: sizeInMB=10 percentUsed=10 lastUpdated=1039003852 . . (repeated for other HostInfo instances) . 4-6-8 ModifyHost ModifyHost modifies information about a host server (see Table 4-68). NOTE: ModifyHost cannot change WWN information for the external port of a host. A Guest or Local Guest does not have operational permissions.
• Restricted to permitted resources: Local System Administrator and Local Storage Administrator do not have access range limitations. NOTE: A Local System Administrator and Local Storage Administrator can specify HostInfo for a permitted host. Table 4-69 ModifyHostInfo Command Parameters Parameter Name Status Description objectid Required Object ID of the HostInfo record to be modified. serialnum Optional New serial number of the path's storage array. Omit this when no change is required.
scsiID=15 lun=2 devNum=2 osScsiBus=0 osScsiID=15 osLun=1 portWWN=11.33.55.77.99.BB.DD.FF fileSystemType=NTFS1 fileSystemName=oo sizeInMB=156 percentUsed=50 lastUpdated=1039003476 4-7 Server Management Commands The Server Management commands provide some management support for the Device Manager server. 4-7-1 AddURLLink AddURLLink adds a URL associated with an application and links it with a Command View XP AE object (see Table 4-70).
Command execution example 1: hdvmcli DeleteAlerts -o "D:\logs\ALL DeleteAlerts.log" "alertnum=6" Command execution result 1: RESPONSE (Command completed; no data returned) Command execution example 2: hdvmcli DeleteAlerts -o "D:\logs\ALL DeleteAlerts.log" "source=ARRAY.HDS9980V.
Table 4-73 GetAlerts Command Parameters Parameter Name Status Description countfilter Optional (returned alerts not Maximum number of messages to be returned. When you omit this limited by total count, if omitted) parameter, the number of returned alerts is not limited. timefilter Optional Request only messages newer than the date and time. Required format is YYYY/MM/DD HH:MM:SS. When you omit this parameter, the number of returned alerts is not limited.
Users with access to this command: • Yes: System Administrator, Storage Administrator • No: Guest, Local Guest • Restricted to permitted resources: Local System Administrator and Local Storage Administrator do not have access range limitations. Table 4-74 GetLogFile Command Parameters Parameter Name Status Description filename Required Name of the requested log file (access.log, service.log, error.log, or trace.log). Command execution example: hdvmcli GetLogFile -o "D:\logs\GetLogFile.
Table 4-75 GetURLLink Command Parameters Parameter Name Status Description objectid Optional The object ID of the URLLink object to be returned. You can omit this parameter when using the linkedid parameter to return all URLLink objects; do not use the linkedid parameter with the objectid parameter. linkedid Optional The object ID of the linked object. All links to this object are returned.
An instance of DebugLevel value=0 [Full Debugging trace] description=Debugging Trace 4-8 Replication Commands Replication commands provide management support for the Device Manager server. 4-8-1 AddConfigFileForReplication AddConfigFileForReplication creates the Continuous Access XP configuration definition file for RAID Manager that is required to create copy pairs for Business Copy XP, Continuous Access XP, Continuous Access XP Extension, and Snapshot XP.
Table 4-77 AddConfigFileForReplication Command Parameters Parameter Name Status Description pvolserialnum Required Serial number of the storage subsystem that includes the PVOL. pvoldevnum Required Device number of the P-VOL. pvolportid Optional Port number in the Continuous Access XP configuration file that manages the P-VOL path. svolarraytype Required Model of the storage subsystem that includes the S-VOL.
pvolarraytype=model pvolserialnum=serial-number pvoldevnum=device-number [pvolportid=port-number] svolarraytype=model svolserialnum=serial-number svoldevnum=device-number [svolportid=port-number] [replicationfunction= {BusinessCopy|ContinuousAccess|ContinuousAccessExtension|Snapshot}] Command execution example 2: (create a group in the configuration files, and then add pairs to the group). hdvmcli AddConfigFileForReplication -o "D:\logs\XP1024 AddConfigFileForReplication.
Table 4-78 AddReplication Command Parameters Parameter Name Status Description groupname Optional Specify the group name used in the RAID Manager. The maximum number of characters you can use to specify a group name is 31. The group name cannot begin with a number sign (#) or a hyphen (-). NOTE: If the replicationgroupid parameter is specified, this parameter is ignored.
Table 4-78 AddReplication Command Parameters Parameter Name Status Description replicationfunction Optional Specify the type of operation that is to be executed with the copy pair: BusinessCopy: Execute Business Copy XP. ContinuousAccess: Execute Continuous Access XP. ContinuousAccessExtension: Execute Continuous Access XP Extension. Snapshot: Execute Snapshot XP.
hdvmcli [URL] AddReplication [option] replicationgroupid=copy-group-number pvolarraytype=model pvolserialnum=serial-number pvoldevnum=device-number [pvolportid=port-number] svolarraytype=model svolserialnum=serial-number svoldevnum=device-number [svolportid=port-number] [replicationfunction={BusinessCopy|ContinuousAccess|ContinuousAccessExtension|Sna pshot}] [fencelevel=fence-level] [copytracksize=copy-pace] Command execution example 1: This example creates a copy pair for Continuous Access XP in an existin
{BusinessCopy|ContinuousAccess|ContinuousAccessExtension|Snapshot}] [fencelevel=fence-level] [copytracksize=copy-pace] Command execution example 2: This example creates a copy group in the existing RAID Manager configuration definition file and creates a copy pair for Business Copy XP. For the primary volume (P-VOL), specify the logical device (LDEV 11, model number XP1024, and serial number 15001). The host that recognizes the primary volume has ID 1, and the Continuous Access XP instance number is 11.
serial number 35001. The host ID is 4, the Continuous Access XP instance number is 15, the port number is 50002, and the copy pace is 14. hdvmcli AddReplication -o "D:\logs\XP1024 AddReplication.
Table 4-80 DeleteReplication Command Parameters Parameter Name Status Description pvolserialnum Optional Specify the serial number of the storage subsystem that contains the primary volume (P-VOL). pvoldevnum Optional Specify the device number of P-VOL. svolserialnum Optional Specify the serial number of the storage subsystem that contains the S-VOL. svolsequencenum Optional Specify the sequence number of the storage subsystem that contains the S-VOL.
RESPONSE (Command completed; no data returned) 4-8-4 GetReplicationControllerPair GetReplicationControllerPair obtains information about a replication controller pair. In the StorageWorks XP Disk Array, the pairs indicate paths between MCUs and RCUs. Users with access to this command: • Yes: System Administrator, Storage Administrator • No: Guest, Local Guest • Restricted to permitted resources: Local System Administrator and Local Storage Administrator do not have access range limitations.
remoteArrayType=HDS9980V remoteSerialNumber=15001 remoteSSID=65534 remoteControllerID=15 remoteStartDevNum=0 remoteEndDevNum=255 4-8-5 ModifyReplication ModifyReplication changes a copy pair status to split, resync, or restore: • split: Copying between copy pair has stopped. • resync: Synchronization is achieved from P-VOL to S-VOL so that their contents match. • restore: Synchronization is achieved from S-VOL to P-VOL so that their contents match.
groupName=HCMD_CG000d pvolHostID=1 pvolInstanceNumber=11 pvolPortNumber=50,000 svolHostID=3 svolInstanceNumber=12 svolPortNumber=50,001 replicationFunction=BusinessCopy copyTrackSize=15 List of 1 ReplicationInfo elements: An instance of ReplicationInfo objectID=REPINFO.65010001.20.65010001.21 pvolSerialNumber=65010001 pairName=HCMD_CP0001 pvolArrayType=HDS9980V pvolDevNum=20 pvolObjectID=LU.HDS9980V.65010001.20 pvolPoolID=-1 svolSerialNumber=65010001 svolArrayType=HDS9980V svolDevNum=21 svolObjectID=LU.
5 Using the Device Manager Properties File This chapter describes how to use property files to specify option parameters. This chapter also describes how to change certain properties by entering commands on the command line.
# password can be provided directly, or from a password file password=khalsa #password=@D:\\DeviceManager\\.passwd # provide a copy of the raw xml request & response in MessageTrace.log file messagetrace=true ##### COMMAND PARAMETERS #### # set the Array model, for commands that use this parameter model=XP1024 5-2 Using the Properties File to Specify Parameters Specifying a parameter in the properties file in advance allows you to omit entering the parameter at the command prompt.
5-3-3 Message Trace Output You can use the –t or --messagetrace option to record the requests sent to the Device Manager server and the responses received back from the Device Manager server. By default, the messages are recorded in the MessageTrace.log file. You can also turn on message trace and specify the location of the log file in the properties file. For example, you could specify the log file location and turn on message trace in the property file as follows: hdvmcli.
Example 2: Save the following to a file: PAGE 114upTime=1 day 23 hours 35 minutes 27 seconds upSince=Mon, 5 Sep 2005 11:07:51 GMT currentApiVersion=4.3 List of 3 StorageArray elements: An instance of StorageArray arrayFamily=HDS9900 displayArrayFamily=XP512/48 An instance of StorageArray arrayFamily=HDS9900V displayArrayFamily=XP1024/128 An instance of StorageArray arrayFamily=USP displayArrayFamily=XP12K/10K C:\hdvm> NOTE: The XML for this command is now in the MessageTrace.log file. 7. View the contents of the MessageTrace.log file.
C:\hdvm> C:\hdvm> C:\hdvm>do -i getserv.inp RESPONSE: PAGE 1166 Troubleshooting This chapter describes appropriate actions to take if there is a problem with Device Manager CLI. • Troubleshooting (section 6-1) 6-1 Troubleshooting If there is a problem with Device Manager CLI: • Make sure that the problem is not being caused by the PC or LAN hardware or software, and try restarting the PC. • Make sure that the problem is not occurring at the Device Manager server.
Acronyms and Abbreviations AL arbitrated loop API application program interface ASL array support library CLI command-line interface DAMP, DMP disk array management program DKC disk controller FC fibre channel GB gigabytes (1024 MB) GUI graphical user interface HTML hypertext markup language HTTP hypertext transmission protocol HTTPS hypertext transmission protocol secure HBA host bus adapter ID identification, identifier IP internet protocol JRE Java™ Runtime Environment KB
RCU remote control unit (for Continuous Access XP) SCSI small computer system interface SNMP simple network management protocol SSID storage subsystem ID S-VOL secondary volume (for Business Copy XP or Continuous Access XP) SVP service processor (component of XP1024/XP128 and XP512/XP48) URL uniform resource locator VxVm VERITAS™ Volume Manager WWN worldwide name XML extensible markup language Acronyms and Abbreviations 118
