HP P6000 Replication Solutions Manager CLUI Reference Abstract This document describes the command-line user interface (CLUI) for HP P6000 Replication Solutions Manager (formally HP StorageWorks Replication Solutions Manager), explains how to access the CLUI, and how to use its commands. Operators and administrators of storage area networks (SANs) that include supported HP arrays can use this document as a reference for command syntax and usage.
© Copyright 2004–2012 Hewlett-Packard Development Company, L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice.
Contents 1 Overview..................................................................................................5 Prerequisites.............................................................................................................................5 Sample use..............................................................................................................................5 Specifying resource names..........................................................................................
EXIT......................................................................................................................................25 HELP.....................................................................................................................................25 LOGIN..................................................................................................................................26 SELECT HOST_AGENT............................................................................
1 Overview HP P6000 Replication Solutions Manager (the replication manager) is a graphical and command line user interface for managing replication on HP storage arrays. It is provided with licensed replication products, including HP P6000 Business Copy and HP P6000 Continuous Access. The CLUI is installed with the replication manager and allows you to perform local and remote replication using single commands and scripts. This chapter contains general topics about the CLUI and its use.
. Change the name and write mode of group455: set dr_group group455 name=gr100 wm=asynchronous To select another array, enter the select system command with the name of another array. Specifying resource names If the resource name contains spaces, place quotation marks around the name. For example: select system “new york” show dr_group “hr dbl” If the resource name contains capital letters, enter the names in capital letters.
Table 2 Result codes (continued) Code Description 504 Invalid Command Syntax 505 Invalid Sign-on 506 Security Violation 507 Unknown Command 508 Job Paused Error 509 Job Paused Normal Using CLUI help To display short help for all commands, enter ? and then press Enter. The short help menu appears: Command: ? 0 Success Usage: { a[dd] | c[apture] | del[ete] | exit | h[elp] | login | sel[ect] | set | sho[w] } To display full help for all commands, enter help, and then press Enter.
A space-efficient empty container is comprised of a metadata container only. Space-efficient empty containers can be used to create demand allocated snapshots only. Use containers when you need faster copies; for example, to reduce the time a host application is suspended for a backup. Time is saved because the metadata container was created ahead of time. Follow these guidelines for using containers: • The array must have a local replication license.
• All snapshots of the same virtual disk must be the same type (demand allocated or fully allocated) and redundancy (Vraid) level. • If the disk group has insufficient space to increase the capacity of snapshots, the snapshots will automatically be invalidated, but the source virtual disks will continue accepting requests. • Snapshots are included in the maximum number of virtual disks per array.
• All members of a DR group must have a common preferred controller. HP recommends that all members have the same presentation status (required if members belong to one application). • Failover is permitted only by specifying a destination DR group. • When failsafe mode is enabled, a DR group cannot be suspended. • A suspended DR group cannot be failed over and its members cannot be removed. The exception is that, if the intersite links are broken, a suspended DR group can be failed over.
2 Accessing the CLUI You can access the CLUI using: • Replication manager GUI • Replication manager remote client • Telnet • User-written client After you have accessed the CLUI, you can issue CLUI commands to perform local and remote replication functions. For descriptions of the CLUI commands, see “CLUI commands” (page 16). This chapter describes the ways you can start the CLUI. Using the GUI 1. 2. 3. Start the HP P6000 Replication Solutions Manager GUI.
Remote client switches -? help Displays remote client help in the command line window. Cannot be used with other switches. During an interactive session, use the HELP command. -b block text mode Specifies that responses be in block text. Block text is the default. -c CSV mode Specifies that responses be in comma-separated values. -f file name Specifies the full path and file name of the text file to be used for a file-driven session.
Created Clui Client key at : C:\Documents and Settings\user/.cluiclient/clui client.ckf Created Clui Client encrypted properties at : C:\Documents and Settings\user/.cluiclient/clui client.cpf Key Generation Ending Successfully C:\mydr> Session types You can use the remote client to run interactive, single-command, and file-driven CLUI sessions: • Interactive—Initiates a session that remains open until you close it. You can issue one command at a time.
Single-command session guidelines include: • Include one CLUI command. • Do not include the file-driven switch (-f). • Use a generated security key (no entry) or enter explicit credentials. • Accept default response mode (no entry) or enter a choice. Command Description CLUI: clui “show system list” Log on using security key; issue a CLUI command; default response mode.
Windows To direct successful output to a file called out.log and failure output to a file called err.log, use the following syntax: .\clui.cmd "some command" 1>out.log 2>err.log To direct all output (success and failure) to out.log, use the following syntax: .\clui.cmd "some command" 1>out.log 2>&1 Using a Telnet session CLUI functionality is automatically installed with the replication manager software on the management server.
3 CLUI commands This chapter describes the commands in the HP P6000 Replication Solutions Manager CLUI. Not all commands are supported in all versions of the replication manager. To view the commands supported in your version, enter help, and then press Enter at the command prompt. Syntax conventions Command syntax is the order in which you must enter the CLUI commands, switches, and switch values. Table 3 (page 16) explains the symbols that this chapter uses to depict command syntax.
Switches NOTE: The size, disk_group, and vraid_level switches enable you to create a container by specifying the container properties. The Vdisk switch enables you to create a container by specifying the container's virtual disk. You cannot use both sets of switches in a single command. allocation_policy Sets the allocation policy of the virtual disk. The default setting is fully_allocated. container name Specifies the name of the container virtual disk. disk_group Specifies the container's disk group.
DESTINATION_LOG_DISK_GROUP Specifies the destination log disk group for the DR group. Enclose the text in quotation marks if the destination log disk group name includes spaces. DESTINATION_SYSTEM Required. Specifies the array where the replicated destination virtual disks are created. There is no default value. DESTINATION_VDISK_NAME Specifies the name of the replicated destination virtual disk that is created when the source is added to the DR group.
Syntax a[dd] host_a[gent]|ha [isv[irtualmachine]|ivm=] [ {username=} {password=} ] Switches host agent name Specifies the name of the new host agent. password Specifies the password for the user name. This is required if a username is specified. username Specifies the user name to authenticate the host agent. This switch is optional. For more information, see the HP P6000 Replication Solutions Manager Installation Guide.
[wait] { {vd[isk]=} [cont[ainer]=]} Switches container Specifies the container name to perform mirrorclone operations with. The virtual disk switch is required with this switch. The resulting mirrorclone assumes the target container name. nowait Creates the mirrorclone without waiting for normalization to complete. wait Waits until the new replica is discovered before executing the next step. This is the default behavior.
vdisk Specifies the name of the source virtual disk. This switch is used with the diskgroup_name and redundancy_level switches to create a snapclone. wait Waits until the new replica is discovered before executing the next step. This is the default behavior. ADD SNAPSHOT The ADD SNAPSHOT command creates a point-in-time local replica of a virtual disk or multiple point-in-time replicas of multiple virtual disks. Select an array before using this command.
[allocation_alarm|aa=]} [thin_provisioning|tp={enable|disable}] [vraid_level|vrl={raid0|raid1|raid5|raid6}] Switches allocation_alarm Specifies a threshold at which point a warning event is sent to notify users that the thin provisioned disk is approaching capacity. The default value is 70%. disk_group Specifies the disk group in which the virtual disk is to be created. The disk group can be specified in UNC form, or as a friendly name found on the selected array.
IMPORTANT: Do not reconfigure the selected array while this command is executing. Syntax c[apture] c[onfig_data]|cfg Switches None CAPTURE SYSTEM_DATA The CAPTURE SYSTEM_DATA command enables you to capture replication manager properties and data, and save this information to a specified file. This command is supported when using the CLUI by means of the GUI or the remote client. It is not supported when using the CLUI by Telnet.
Syntax del[ete] host_a[gent]|ha Switches host agent name Specifies the name of the host agent to be deleted. Example del host_a newhost123 DELETE JOB The DELETE JOB command permanently removes a specified job or an instance of a job. You cannot delete jobs that have instances that are running or paused. Syntax del[ete] job [i[nstance]=] Switches job name Specifies the name of the job to be deleted.
DELETE SNAPSHOT The DELETE SNAPSHOT command permanently removes the specified snapshot from a preselected array. Syntax del[ete] snaps[hot]|ss Switches snapshot name Specifies the UNC name of the snapshot to be deleted. DELETE VDISK The DELETE VDISK command permanently removes the specified virtual disk from a preselected array. The virtual disk is no longer accessible and all data is lost. CAUTION: The DELETE VDISK command removes the entire virtual disk from the array.
Switches Leave blank to veiw all help topics. Enter a specific CLUI command to display help topic for that command. LOGIN The LOGIN command authenticates the user for the current management session. Syntax login {username=} {password=} Switches username Required. Specifies the user name to authenticate. password Required. Specifies the password for the user name. SELECT HOST_AGENT The SELECT HOST_AGENT command selects the specified host agent.
Syntax set client {res[ult_format]|rf={block_text|csv|result_code|table_text|xml|xml_raw}} Switches result_format Specifies the result format. The options include block_text, csv, result_code, table_text, xml, or xml_raw. Examples Block text format NY>show ms full 0 Success Name........:manset1 Type........:VirtualDisk Comment.....: Date Created 6/14/04 4:39 PM Member Count: 0 Name........:manset2 Type........:Connection Comment.....
VirtualDisk 6/14/04 4:39 PM 0 XML format
| [ {rem[ove_vdisk]|remvd|rvd=} [del[ete]] ] Switches accessmode Specifies the destination access mode for the DR group. The values are none (default), inquiryonly, or readonly. async_type Defines the async type as basic or enhanced. autosuspend Sets the DR group to autosuspend on link down mode (suspend on failover). add_vdisk Specifies the name of the source virtual disk to add to the DR group.
nosuspend Resumes the replication of data from the source to the destination, similar to a restored connection. refresh Performs a manual refresh of the DR group properties prior to other operations that have been specified in this command. remove_disk Specifies the name of the source virtual disk you want removed from the DR group. The destination virtual disk is removed from the DR group, but it is not deleted. The destination virtual disk remains as an independent virtual disk.
unmount_volume Unmount the storage from the enabled host. If you use this option, the mount_point switch is required. username Specifies the user name for the account that the storage administrator created on the host before installing the HP Replication Solutions Manager host agent software. For more information, see the HP P6000 Replication Solutions Manager Installation Guide. SET HOST_VOLUME The SET HOST_VOLUME command modifies host volume properties.
description Changes the description of the job. disable_schedule Disables the job schedule using the supplied scheduleid switch. enable_schedule Enables the job schedule using the supplied scheduleid switch. mode Sets the run mode for the selected job. Use this switch with the run switch to set the run mode to normal (default), validate, or skip validation. name Changes the name of the job. nowait Runs the job without waiting for it to complete. If you use this option, the run switch is required.
removemember Removes a member from the managed set. If there are spaces in the name, enclose the name in quotation marks. suspend Suspends replication on all members in the managed set. Can be used only if the managed set contains DR groups. SET MIRRORCLONE The SET MIRRORCLONE command modifies the mirrorclone.
password Specifies the password for the user name to authenticate the given remote replication manager server. path Specifies the path for the export operation with an optional file name, or the full file path for import. username Specifies the user name to authenticate the given remote replication manager server. SET SYSTEM The SET SYSTEM command displays the properties of the storage array.
[ {migrate_disk_group|mdg=} [keep={true|false}] ] | [ {migrate_vraid_level|mvrl={raid0|raid1|raid5|raid6}} {migrate_disk_group|mdg=} [keep={true|false}]]| [over_commit|oc={yes|no}] ] [[setname|sn=]] [type={host_fc_port|host_iscsi}] Switches add_presentation Selects an EVA host name to which to present your virtual disks. However, prior to adding presentations, you must identify the specific host name format used in HP P6000 Command View.
SET VM_SERVER The SET VM_SERVER command adds or changes security credentials for accessing a VM server. Syntax set vm_s[erver]|vms {[refresh]} {{username=} {password=}} Switches password Specifies the password for the user account on the VM server. refresh Performs a manual refresh of the VM server properties. username Specifies the user name for the account on the VM server. SHOW CONTAINER The SHOW CONTAINER command displays the properties of containers.
[m[embers]] [refresh] Switches dr_group name Displays properties of the specified DR group. full When used instead of dr_group name, displays the properties of all data replication groups in the array. list Displays a simple list of DR group names. members Displays the members of the DR group. refresh Performs a manual refresh of the DR group properties prior to other operations that were specified in this command.
Syntax sho[w] host_vol[ume]|hostvol|hv [f[ull]] [h[ost]=] [l[ist]] [m[ounts]] [vd[isks]] Switches full When used instead of host_volume name, displays details about all the host volumes. host Required. Specifies the host name where the host volume exists. host_volume name Displays properties about the specified host volume. list Displays a simple list of the host volumes. mounts Displays all mounts for the specified host volume.
Switches full When used instead of managed_set name, displays details about all the managed sets. list Displays a simple list of the managed sets. managed_set name Displays details about the specified managed set. members Lists the members of the managed set. SHOW MIRRORCLONE The SHOW MIRRORCLONE command displays the selected mirrorclone properties.
SHOW SNAPCLONE The SHOW SNAPCLONE command displays the properties of snapclones. Select an array before using this command. Syntax sho[w] snapc[lone]|sc [f[ull]] [l[ist]] [man[aged_set_member]|ms_member|msm] [perf[ormance]] [pres[entation]] [refresh] [repl[ication]] Switches full If used instead of snapclone name, displays details about all snapclones on the array. list Displays a simple list of the snapclones. This is the default output if full or snapclone name are not specified.
refresh Performs a manual refresh of the snapshot properties prior to other operations that were specified in this command. replication Displays the replication properties for the snapshot. snapshot name Displays properties about the specified snapshot. SHOW SYSTEM The SHOW SYSTEM command displays the properties of the selected array.
refresh Performs a manual refresh of the virtual disk properties prior to other operations that were specified in this command. replication Displays replication attributes for the virtual disk. vdisk name Displays properties bout the specified virtual disk. Example show vdisk Vdisk001 presentation SHOW VM_SERVER The SHOW VM_SERVER command displays the properties of VM server, including information such as HBA details.
4 Troubleshooting This chapter offers suggestions for troubleshooting and resolving problems that can occur while using the CLUI. Mounts and unmounts appear to fail in the CLUI Mounts and unmounts of host volumes can appear to fail when you use the CLUI. For example, if you use the set host_agent command to unmount a host volume, and then immediately issue a show host_agent command, the result shows the host volume is still mounted.
5 Support and other resources Contacting HP HP technical support Telephone numbers for worldwide technical support are listed on the HP support website: 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 • Error messages • Operating system type and revision level • Detailed questions For continuous quality improvement, calls be recorded or monitored.
Websites • HP: http://www.hp.com • HP Storage: http://www.hp.com/go/storage • HP Software Downloads: http://www.hp.com/support/downloads • HP Software Depot: http://www.software.hp.com • HP Single Point of Connectivity Knowledge (SPOCK): http://www.hp.com/storage/spock • HP Partner Locator: http://www.hp.com/service_locator • HP SAN manuals: http://www.hp.
Table 4 Document conventions (continued) Convention Element {} Required content in syntax | Character that separates items in a list of choices CAUTION: An alert that calls attention to important information that if not understood or followed can result in data loss data corruption, or damage to hardware or software. NOTE: 46 An alert that contains additional or supplementary information.
A BC 2.x EVMCL to HP Replication Solutions Manager job-related commands BC 2.x EVMCL full syntax evmcl [/output=Filename.
B User-written client examples This appendix contains examples of creating user-written clients to access the CLUI.
print print print print print " port - the port the clui is on\n"; " username - admin user name\n"; " password - admin password\n"; " command - the command to send via the clui - in quotes\n\n"; "*************************************************************************\n"; } # end sub usage Sample socket client using Perl #Copyright: Copyright (c) 2003 #Company: Hewlett-Packard Company use strict; use IO::Socket; my ($hostname, $line, $passwd, $username, $res, $sock, $port, $cmd); if(@ARGV < 5){ usage();
sub usage { print "\n\n\***********************************************************************\n\n"; print print print print print print print "Use: clui_socket_config_retrieval.
#print("$line\n"); } return $resp; } sub usage { print print print print print print print print "\n\n\*************************************************************************\n\n"; "Use: clui_ssl_sample.
Glossary A allocation policy array Storage system rules that govern how virtual disks are created. There are two rules used in creating virtual disks. • Demand allocated–The space a virtual disk requires on the physical disks is not reserved until needed. • Fully allocated–The space a virtual disk requires on the physical disks is reserved, even if the virtual disk is not currently using the space. Synonymous with storage array, storage system, and virtual array.
mirrorclone is said to be synchronized. In a synchronized state, the mirrorclone is automatically updated whenever the source virtual disk is updated. When local replication between a synchronized mirrorclone and the source is stopped by an action or command, the mirrorclone is said to be fractured. In a fractured state, the mirrorclone is not updated when the source virtual disk is updated. At the instant replication is stopped, the mirrorclone is a point-in-time copy of its source.
Index A accessing the CLUI using a Telnet session, 15 using a user-written client session, 15, 48 using the GUI, 11 using the remote client, 11 ADD CONTAINER, 16 ADD DR_GROUP, 17 ADD HOST_AGENT, 19 ADD MANAGED_SET, 19 ADD MIRRORCLONE, 19 ADD SNAPCLONE, 20 ADD SNAPSHOT, 21 ADD VDISK, 21 ADD VM_SERVER, 22 B block text format, 12, 27 C conventions, 45 prerequisites, 5 documentation HP website, 44 providing feedback, 44 DR group adding, 17 deleting, 23 setting, 28 showing, 36 E EXIT, 25 F feedback document
M managed set adding, 19 deleting, 24 setting, 32 showing, 38 mirrorclone adding, 19 deleting, 24 setting, 33 showing, 39 mirrorclones guidelines, 9 O OpenVMS, 12 P prerequisites, product, 5 product providing feedback, 44 R raw XML, 27 raw XML format, 12 redundancy level snapshot guidelines, 8 related documentation, 44 remote client installing, 11 running, 11 session types, 13 switches, 12 using, 11 remote client output, redirecting, 14 remote client session type file-driven, 14 interactive, 13 single-co
socket client using PERL, 49 SSL client using PERL, 50 Telnet client using PERL, 48 U user-written client, 15, 48 V virtual disk adding, 21 deleting, 25 setting, 34 showing, 41 VM server deleting, 25 setting, 22, 36 showing, 42 W websites HP, 45 HP Subscriber's Choice for Business, 44 HP support, 44 X XML format, 12, 28 56 Index
