Hitachi Unified Storage VM Block Module

Transcription

1 Hitachi Unified Storage VM Block Module System Operations Using Spreadsheets FASTFIND LINKS Contents Product Version Getting Help MK-92HM

2 Hitachi Ltd. All rights reserved. No part of this publication may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, or stored in a database or retrieval system for any purpose without the express written permission of Hitachi, Ltd. (hereinafter referred to as "Hitachi") and Hitachi Data Systems Corporation (hereinafter referred to as "Hitachi Data Systems"). Hitachi and Hitachi Data Systems reserve the right to make changes to this document at any time without notice and assume no responsibility for its use. This document contains the most current information available at the time of publication. When new and/or revised information becomes available, this entire document will be updated and distributed to all registered users. Some of the features described in this document may not be currently available. Refer to the most recent product announcement or contact your local Hitachi Data Systems sales office for information about feature and product availability. Notice: Hitachi Data Systems products and services can be ordered only under the terms and conditions of the applicable Hitachi Data Systems agreements. The use of Hitachi Data Systems products is governed by the terms of your agreements with Hitachi Data Systems. Hitachi is a registered trademark of Hitachi, Ltd. in the United States and other countries. Hitachi Data Systems is a registered trademark and service mark of Hitachi, Ltd. in the United States and other countries. ShadowImage and TrueCopy are registered trademarks of Hitachi Data Systems. AIX and IBM are registered trademarks or trademarks of International Business Machines Corporation. All other trademarks, service marks, and company names are properties of their respective owners. Microsoft product screen shots reprinted with permission from Microsoft Corporation. ii

3 Contents Preface vii Intended audience viii Product version viii Release notes viii Document revision level viii Changes in this revision viii Referenced documents viii Conventions ix Convention for storage capacity values x Accessing product documentation x Getting help x Comments xi 1 Spreadsheet operation overview Processing spreadsheets Spreadsheet operations LUN Manager LUN Expansion Universal Volume Manager About Command Line Interface About Configuration File Loader Resources that can be executed for each function Configuring CLI CLI requirements CLI configuration workflow Setting up CLI directories and files Installing the JRE Editing the Java security policy Creating user authentication files Preparing CLI command files iii

4 CLI termination codes Common requirements and procedures Spreadsheet file formatting requirements Opening spreadsheet files Saving spreadsheet files Working with CLI spreadsheets Workflow for CLI-based spreadsheets Obtaining the CLI-based spreadsheet files Editing the CLI-based spreadsheet Validating the CLI-based spreadsheet Running the CLI-based spreadsheet Running the CFLSET command Running the CFLGET command Working with CFL spreadsheets CFL-based spreadsheet workflow Exporting system settings to a spreadsheet Setting up the CFL-based spreadsheet for editing Editing the CFL-based spreadsheet Importing and validating a CFL-based spreadsheet Running a CFL-based spreadsheet LUN Manager operations Supported operations and workflow LUN Manager's CFL spreadsheet format About function tags About definitions Editing the spreadsheet Changing port settings Configuring host groups Configuring WWNs Configuring LU paths Changing command device settings LUN Expansion operations Supported operations and workflow Prerequisite information Example of basic spreadsheet format Command types and operation tags Editing templates Retrieving LDEV information iv

5 Example output Creating LUSE volumes Example spreadsheet Releasing LUSE volumes Example spreadsheet Universal Volume Manager operations Supported operations and workflow Prerequisites for installing CLI Example of basic spreadsheet format Command types and operation tags Editing templates Retrieving SSID information Retrieving external-volume group information Retrieving external volume information Mapping external volumes with multiple LDEVs Specifying LDEV Capacity Mapping an external volume with one LDEV Disconnecting an external volume Restoring an external volume Deleting external volume mapping Moving external volumes to another path group Moving external volumes to a new path group Universal Replicator for Mainframe operations Supported operations and workflow Required prerequisites Example of basic spreadsheet format Command types and operation tags Editing templates Retrieving pair information Example of retrieved pair tag information Creating pairs Suspending pairs Example of suspending pairs Resynchronizing pairs Example Releasing pairs Executing spreadsheets Troubleshooting Command Line Interface errors v

6 A Configuration File Loader GUI reference A-1 Configuration File Loader window A-2 Glossary Index vi

7 Preface This document describes and provides instructions for using spreadsheets to perform operations on the Hitachi Unified Storage VM (HUS VM) storage system. Please read this document carefully to understand how to use this product, and maintain a copy for reference purposes. This preface includes the following information: Intended audience Product Version Release notes Document revision level Changes in this revision Referenced documents Conventions Convention for storage capacity values Accessing product documentation Getting Help Comments Preface vii

8 Intended audience Product version Release notes This document is intended for system administrators, Hitachi Data Systems representatives, and authorized service providers who are involved in installing, configuring, and operating the HUS VM storage system. Readers of this document should meet the following requirements: You should have a background in data processing and understand RAID storage systems and their basic functions. You should be familiar with the HUS VM storage system, and you should have read the Hitachi Unified Storage VM Block Module Hardware User Guide. You should be familiar with the Storage Navigator software for HUS VM, and you should have read the Hitachi Storage Navigator User Guide. You should be familiar with the software used to create, edit, and manage spreadsheets (such as Microsoft Excel). This document revision applies to HUS VM microcode x or later. The Hitachi Unified Storage VM Release Notes provide information about the HUS VM microcode (DKCMAIN and SVP), including new features and functions and changes. The Release Notes are available on the Hitachi Data Systems Portal: Document revision level Revision Date Description MK-92HM September 2012 Initial release MK-92HM December 2012 Supersedes and replaces MK-92HM MK-92HM October 2013 Supersedes and replaces MK-92HM Changes in this revision Revised CLIset command and termination code examples. See Examples of the batch file for the CFLSET command and Example of a CLI termination code reference. Referenced documents Hitachi Unified Storage VM (HUS VM) documents: Hitachi Storage Navigator User Guide, MK-92HM7016 Hitachi Universal Volume Manager User Guide, MK-92HM7020 Hitachi ShadowImage User Guide, MK-92HM7013 viii Preface

9 Conventions Hitachi Unified Storage VM Block Module Provisioning Guide, MK- 92HM7012 Hitachi TrueCopy User Guide, MK-92HM7018 Hitachi Universal Replicator User Guide, MK-92HM7019 This document uses the following typographic conventions: Convention Description Bold Italic Indicates the following: Text in a window or dialog box, such as menus, menu options, buttons, and labels. Example: On the Add Pair dialog box, click OK. Text appearing on screen or entered by the user. Example: The -split option. The name of a directory, folder, or file. Example: The horcm.conf file. Indicates a variable, which is a placeholder for actual text provided by the user or system. Example: copy source-file target-file Angle brackets are also used to indicate variables. Monospace Indicates text that is displayed on screen or entered by the user. Example: # pairdisplay -g oradb < > angle brackets Indicates a variable, which is a placeholder for actual text provided by the user or system. Example: # pairdisplay -g <group> Italic is also used to indicate variables. [ ] square brackets Indicates optional values. Example: [ a b ] indicates that you can choose a, b, or nothing. { } braces Indicates required or expected values. Example: { a b } indicates that you must choose either a or b. vertical bar Indicates that you have a choice between two or more options or arguments. Examples: [ a b ] indicates that you can choose a, b, or nothing. { a b } indicates that you must choose either a or b. This document uses the following icons to draw attention to information: Icon Meaning Description Tip Helpful information, guidelines, or suggestions for performing tasks more effectively. Note Calls attention to additional information. Caution Failure to take or avoid a specified action can result in adverse conditions or consequences (for example, loss of access to data). Preface ix

10 Icon Meaning Description WARNING Failure to take or avoid a specified action can result in severe conditions or consequences (for example, loss of data). Convention for storage capacity values Physical storage capacity values (disk drive capacity) are calculated based on the following values: Physical capacity unit Value 1 KB 1,000 (10 3 ) bytes 1 MB 1,000 KB or 1,000 2 bytes 1 GB 1,000 MB or 1,000 3 bytes 1 TB 1,000 GB or 1,000 4 bytes 1 PB 1,000 TB or 1,000 5 bytes 1 EB 1,000 PB or 1,000 6 bytes Logical storage capacity values (logical device capacity) are calculated based on the following values: Logical capacity unit Value 1 KB 1,024 (2 10 ) bytes 1 MB 1,024 KB or 1,024 2 bytes 1 GB 1,024 MB or 1,024 3 bytes 1 TB 1,024 GB or 1,024 4 bytes 1 PB 1,024 TB or 1,024 5 bytes 1 EB 1,024 PB or 1,024 6 bytes Accessing product documentation Getting help The Unified Storage VM user documentation is available on the Hitachi Data Systems Portal: Check this site for the most current documentation, including important updates that may have been made after the release of the product. The Hitachi Data Systems customer support staff is available 24 hours a day, seven days a week. If you need technical support, log on to the Hitachi Data Systems Portal for contact information: x Preface

11 Comments Please send us your comments on this document: Include the document title and number, including the revision level (for example, -07), and refer to specific sections and paragraphs whenever possible. All comments become the property of Hitachi Data Systems. Thank you! Preface xi

12 xii Preface

13 1 Spreadsheet operation overview This chapter provides information and instructions for using spreadsheets for HUS VM storage system operations. This topic discusses the software and operations that can be run with spreadsheets. Processing spreadsheets Spreadsheet operations About Command Line Interface About Configuration File Loader Resources that can be executed for each function Spreadsheet operation overview 1 1

14 Processing spreadsheets You can make large-scale changes or perform various operations on a large scale and at a scheduled time by running spreadsheets against HUS VM. An operation is executed when you edit a spreadsheet and run it from the command prompt or file loader. By using the program-specific operation tags and parameters that correspond to the software, you can schedule a disparate range of operations or changes to a system's configuration. Changes and operations using spreadsheets are supported by the following Hitachi software products: LUN Manager (LUNM) LUN Expansion (LUSE) Universal Volume Manager (UVM) Two of these software products LUN Expansion and Universal Volume Manager provide their own spreadsheet templates. Templates are meant to be edited to your specific requirements and then run. LUN Manager spreadsheets are created when you export system information using Storage Navigator CFL. Spreadsheets, after you have written or edited them, are validated and run using either CFL or the Command Line Interface (CLI). These methods are not interchangeable; you use the method supported by the product. Instructions for editing, validating, and running spreadsheets for the supported software are provided. Spreadsheet operations LUN Manager The following topics describe the operations you can perform with each program's spreadsheet, and the required method for executing the spreadsheet. Spreadsheets for LUN Manager are operated using CFL. You can use spreadsheets to add, change, or delete the following settings: Configuration settings, which include: Arbitrated loop-physical address (AL-PA) Data transfer speed (host speed) Topology LUN security Host group settings WWN settings Path settings Command device settings 1 2 Spreadsheet operation overview

15 LUN Expansion Spreadsheets for LUN Expansion are operated using the Command Line Interface (CLI). You can use spreadsheets to perform the following operations: Create LUSE volumes. Get information about LDEVs that can be combined into LUSE volumes. Get information about LDEVs that have been part of LUSE volumes. Release LUSE volumes. Universal Volume Manager Spreadsheets for Universal Volume Manager are operated using the CLI. You can use spreadsheets to perform the following operations: Retrieve SSID information Retrieve external group information Retrieve external volume information Map external volumes with one or more LDEVs Disconnect an external volume Restore an external volume Delete the mapping to an external volume Move one or more external volumes from one path group to another existing path group, or to a new group path. About Command Line Interface The Command Line Interface is a Storage Navigator function. CLI files must be downloaded and configured manually. The CLI provides commands for retrieving, validating, and running spreadsheets. CLI commands are run from a command prompt for the following spreadsheets: LUN Manager Universal Volume Manager The CLI must be set up prior to use. See Configuring CLI on page 2-1 for details. About Configuration File Loader Configuration File Loader (CFL) is a Storage Navigator software application that is installed with Storage Navigator. With CFL, you import and export LUN Manager spreadsheet files, validate the imported spreadsheet, view errors, and then run the spreadsheets on the current storage system. Spreadsheet operation overview 1 3

16 Resources that can be executed for each function Storage Navigator secondary window shows all the resources in the storage system. When you execute each function in the Storage Navigator secondary window, verify the resource group ID in the Basic Information Display dialog boxes, and then execute the operations for the resources assigned to the user account. When you use the functions described in this manual, the resources for each operation must satisfy the specific conditions. For details on the conditions of the resources, see the Hitachi Unified Storage VM Block Module Provisioning Guide. 1 4 Spreadsheet operation overview

17 2 Configuring CLI You check and run spreadsheets using Command Line Interface (CLI) commands for Universal Volume Manager and LUN Expansion operations. Setup is required before using the CLI. LUN Manager uses a Configuration File Loader (CFL). No configuration is necessary for a CFL spreadsheet. CLI requirements CLI configuration workflow Setting up CLI directories and files Installing the JRE Editing the Java security policy Creating user authentication files Preparing CLI command files Configuring CLI 2 1

18 CLI requirements CLI requirements include the following: Storage Navigator Set up the Storage Navigator CLI on a computer that can access Storage Navigator. Spreadsheet software or a text editor (Microsoft Excel is recommended) JAR file for the Storage Navigator CLI Java security policy file JRE User authentication file Permissions for the CLI commands, shown below. Table 2-1 CLI commands and corresponding permissions CLI command CFLCHK CFLGET CFLSET Built-in permission Storage Administrator (view) role. Storage Administrator (view) role. User must hold all the roles below. Storage Administrator (Initial Configuration) Storage Administrator (System Resource Management) Storage Administrator (Provisioning) Storage Administrator (Performance Management) Storage Administrator (Local Copy) Storage Administrator (Remote Copy) CLI configuration workflow The workflow for setting up CLI consists of the following procedures: 1. Copy and set up CLI files. See Setting up CLI directories and files on page 2-2 below. 2. Install the Java Runtime Environment (JRE). See Installing the JRE on page Edit the Java security policy file. See Editing the Java security policy on page 2-4 for details. 4. Create a user authentication file. See Creating user authentication files on page 2-5. Setting up CLI directories and files To install a CLI on a computer with access to Storage Navigator: 1. Create an installation directory to store CLI files. 2. Insert the CD into the CD-ROM drive. 3. Copy the CD's /CFLCLITool directory to the newly created directory. 2 2 Configuring CLI

19 The CLI installation directory contains the following files and subdirectories: CFLCLITool\JSanCLI.jar: CLI JAR file CFLCLITool\java.policy: Java policy file used for Storage Navigator CLI CFLCLITool\sample\: CLI command files. Copy the files to the same directory as the SanCLI.jar file. CFLCLITool\template\: templates for spreadsheets. Installing the JRE Storage Navigator is provided as a Java application program. To use Storage Navigator CLI on JRE 1.5, the Java Runtime Environment (JRE) is required. JRE with support for additional languages is recommended. The dialog for selecting "Support for Additional Languages" does not appear in JRE 1.6. To use a CLI on JRE 1.6, install the setup file with the default settings. 1. Download the JRE setup file from 2. Start the JRE setup file. 3. If the Security Alert dialog box opens, review the displayed information and click Run. The License Agreement dialog box displays. 4. Review the license agreement, select Custom setup and click Accept. The Custom Setup dialog box displays. Figure 2-1 License Agreement dialog box on JRE Click the Support for Additional Languages icon and select This feature will be installed on local hard drive. Configuring CLI 2 3

20 Figure 2-2 Custom Setup dialog box JRE Click Next. The Browser Registration dialog box appears. 7. Select the browsers you want to register with Java(TM) Plug-In and click Next. Installation begins. When completed, the Complete dialog box displays. 8. Click Finish. Editing the Java security policy The Java security policy must be changed in order to run CLI commands. The Java application runs on the Web browser, and communicates with the attached HUS VM storage systems. Use the policy file that CLI provides as a user policy file. If you use this policy file, the security policy changes only when you execute the CLI commands. The policy file is stored in the CLI installation directory. Edit the default policy file (java.policy) a. In the /CFLCLITOOL folder, locate and open java.policy with a text editor. b. Add the following: grant { }; permission java.security.allpermission; For more information about the policy file, see the Java documentation. 2 4 Configuring CLI

21 Creating user authentication files A user authentication file is required for each CLI user. 1. Log in to Storage Navigator using a storage administrator account. 2. From /CFLCLITool/sample, copy one of the following and paste in the /CFLCLITool directory. (This is the same directory in which the JSanCLI.jar is located.) For Windows: mkatfile.bat For UNIX: mkatfile.sh 3. On UNIX systems, if you have a shell program installed in a directory other than /bin, open mkatfile.sh and change #! /bin/csh in the first line to the directory where the shell program is installed (such as /usr/ bin/csh). 4. From the command prompt, change directories to the destinationfolder/cflclitool directory. 5. Run the batch file as follows: mkatfile SVP-ip-address user-id password > myauthentication.txt For UNIX, enter.sh after mkatfile (that is, mkatfile.sh). Specify the following items: SVP-ip-address: specify the IP address of the SVP. To use an IPv6 address, enclose the IPv6 address in square brackets [ ]. user-id: specify the user ID of the storage administrator. password: specify the storage administrator password. When you execute the command, a user authentication file named myauthentication.txt is created in the current directory. For example: In this example for Windows, myauthentication.txt is created using the IP address ( ), user ID (administrator), and password (adminpassword). mkatfile administrator adminpassword >myauthentication.txt In this example for Windows, myauthentication.txt is created using the IP address (fe80::20a:e4ff:fe8f:20b5), user ID (administrator), and password (adminpassword). mkatfile [fe80::20a:e4ff:fe8f:20b5] administrator adminpassword >myauthentication.txt You can change this file name. However, you must use single-byte characters for the file name and use a literal file extension,.txt. If you rename the file, make sure also to change the name of the user authentication file in the.bat file. After the user authentication file is created, set the appropriate access authority for it using your operating system's security feature. Configuring CLI 2 5

22 Preparing CLI command files The directory and filenames of the command batch files are shown below (the same directory as JSanCLI.jar). Both Windows and UNIX files are stored in the same directory. Table 2-2 Batch files for running CLI commands Directory File name Description CFLCLITool\sample CFLCHK.bat Windows CFLCHK.sh UNIX CFLGET.bat Windows CFLGET.sh UNIX CFLSET.bat Windows CFLSET.sh UNIX Validates the spreadsheet to be applied to the CFLSET command. Retrieves storage system information. Applies the contents of the spreadsheet to the storage system. If you change files or directories that are shown in column one of the following table, you must also make the corresponding change or changes that are shown in column two. Table 2-3 File or directory changes If you change... If you rename the user authentication file name... If you move the directory where you store the user authentication file to a directory other than "/CFLCLITool"... If your operating system is UNIX and you install a shell program in a directory other than "/bin"... You must also change... Change.txt in each CLI command file to the file name that you specified. Change this directory location in each file to the relative or absolute path. Only single-byte characters can be specified for a path or file name. No double-byte characters can be specified. Change #! /bin/csh in the first line in each file to your installation directory (such as /usr/bin/csh). Examples of the batch file for the CFLSET command The following table shows examples of the batch file for the CFLSET command. Table 2-4 Examples of the batch file for the CFLSET command Operating system Batch file Windows java -jar -Djava.security.policy=java.policy - Djava.rmi.server.useCodebaseOnly=false JSanCLI.jar myauthentication.txt CFLSET %1 %2 UNIX #! /bin/csh java -jar -Djava.security.policy=java.policy - Djava.rmi.server.useCodebaseOnly=false JSanCLI.jar myauthentication.txt CFLSET $1 $2 2 6 Configuring CLI

23 CLI termination codes When a command completes, a CLI termination code shows the results of the operation. Even when the termination codes terminate normally, make sure to check for errors in the spreadsheet. The following table shows the meanings of the CLI termination codes that are returned when a CLI command (batch file) is executed. Table 2-5 CLI termination code meanings Code Meaning 0 Command completed successfully. Other than 0 An error occurred. You can use a CLI termination code reference in your batch file that causes a message to display at the command prompt. The CLI termination code references that you can use are shown in the following table. Table 2-6 CLI termination code references Batch file or Shell script Termination code reference Windows batch file %errorlevel% UNIX Bourne shell script %? UNIX C shell script %Status Example of a CLI termination code reference The following example shows a reference to a CLI termination code that can be used in a Windows batch file. When the batch file is run and a CLI termination code of 0 is returned, the command prompt displays, "COMMAND SUCCESSFUL". If a CLI termination code other than 0 is returned, the command prompt displays, "COMMAND FAILED". java -jar -Djava.security.policy=java.policy - Djava.rmi.server.useCodebaseOnly=false JSanCLI.jar myauthentication.txt CFLSET %1 %2 if %errorlevel% NEQ 0 echo COMMAND FAILED. if %errorlevel% EQU 0 echo COMMAND SUCCESSFUL. Configuring CLI 2 7

24 2 8 Configuring CLI

25 3 Common requirements and procedures Although the workflows for running Command Line Interface (CLI) spreadsheets and Configuration File Loader (CFL) spreadsheets are different, format requirements and opening and closing procedures are similar. Spreadsheet file formatting requirements Opening spreadsheet files Saving spreadsheet files Common requirements and procedures 3 1

26 Spreadsheet file formatting requirements You set up a spreadsheet file based on specifications required by CLI commands or CFL. Requirements for the detailed content of each spreadsheet are based on the software functionality, and are described in the product-related modules later in this document. Table 3-1 File requirements for CLI, CFL-based spreadsheets Item Requirement File type Text file File name Extension must be ".spd". Maximum number of letters for the file name is 32 including the extension. The following symbols cannot be used for the file name: \ / :, ; *? " < > and space. Maximum number of letters in directory path: - CLI spreadsheets: CFL spreadsheets: 255 Maximum number of rows CLI spreadsheets: 65,536 CFL spreadsheets: 400,000 End-of-line character Maximum number of letters in a row Case-sensitivity Format Comments Linefeed code must be put in the end of each row. CLI spreadsheet: 512 including linefeed CFL/LUN Manager spreadsheet: 200 Not case-sensitive, except for LUN Manager's WWN and host group settings. CLI/CLF spreadsheets The first line contains the spreadsheet version, which is defined for each software. * Separate each parameter with a comma (,). Tab and spaces before or after a comma are ignored. CLI spreadsheets only Add a semicolon (;) at the end of the line where a parameter is written. Begin a comment line with the # character. Comments can consist of characters in any language. * Updating the microcode version of the storage system might change the version of the CLI/CFL spreadsheet. This can affect the number of items or the range of available values. Check the spreadsheet version before editing a spreadsheet. Opening spreadsheet files As best practice, open a spreadsheet file from within a spreadsheet program. Microsoft Excel is recommended for both CLI-based and CFLbased spreadsheet files. 3 2 Common requirements and procedures

27 Saving spreadsheet files When you finish editing a spreadsheet, save the file. This is important for the file validation process. Common requirements and procedures 3 3

28 3 4 Common requirements and procedures

29 4 Working with CLI spreadsheets This topic provides instructions for editing, validating and then running CLIbased spreadsheets. Workflow for CLI-based spreadsheets Obtaining the CLI-based spreadsheet files Editing the CLI-based spreadsheet Validating the CLI-based spreadsheet Running the CLI-based spreadsheet Working with CLI spreadsheets 4 1

30 Workflow for CLI-based spreadsheets Following is the workflow for using a CLI spreadsheet: 1. Obtain a clean CLI spreadsheet by copying and renaming the spreadsheet template. 2. Open the CLI spreadsheet in a spreadsheet program. Open the spreadsheet with the settings specified in Configuring CLI on page 2-1. This also applies to closing and saving the spreadsheet. 3. Edit the spreadsheet. Each spreadsheet has its own operations, functions, and parameters. 4. Go to a command prompt and use the CFLCHK command to validate the spreadsheet file. 5. Correct any errors by re-editing and revalidating the spreadsheet. 6. Run the spreadsheet using the CLI commands, CFLSET or CFLGET. Obtaining the CLI-based spreadsheet files Find and save a copy. Spreadsheet templates for LUN Expansion (LUSE) and Universal Volume Manager are located in your installation directory's / CFLCLITOOLS/template folder. See Setting up CLI directories and files on page 2-2. Original template names for CLI-based spreadsheets are shown in the following table. Table 4-1 Template names for CLI-based spreadsheets Program Product Universal Volume Manager LUN Expansion (LUSE) Template ExternalStorage_AddVolumeSetting2_def_.spd ExternalStorage_AddVolumeSetting_def_.spd ExternalStorage_CheckPath-RestoreVolume_def_.spd ExternalStorage_DeleteVolume_def_.spd ExternalStorage_DisconnectVolume_def_.spd ExternalStorage_DividePathGroup_def_.spd ExternalStorage_Get_def.spd ExternalStorage_UnitePathGroup_def_.spd LUSE_Expansion_def_.spd LUSE_Get_def.spd LUSE_Release_def_.spd Editing the CLI-based spreadsheet Edit and then validate the spreadsheet before running it. Prerequisite information When opening a spreadsheet file, make sure you have reviewed Opening spreadsheet files on page 3-2 for important information. 4 2 Working with CLI spreadsheets

31 When closing a spreadsheet file, make sure to review Saving spreadsheet files on page 3-3. Settings must be strictly formatted to prevent errors during validation. Adhere to the formatting requirements in Spreadsheet file formatting requirements on page 3-2. Follow the program-specific parameter requirements and guidelines in the following topics: LUN Expansion operations on page 7-1 Universal Volume Manager operations on page 8-1 Validating the CLI-based spreadsheet After editing a spreadsheet, you must use the CFLCHK command to validate the spreadsheet before you run the CFLSET command. To validate the CLI-based spreadsheet, go to the command prompt (Start>Run>"cmd") and enter the following: CFLCHK input-file-name output-file-name For example: enter CFLCHK LUSE_ReleaseOperation.spd LUSE_ReleaseOperation_Result.spd In this example, the spreadsheet, LUSE_ReleaseOperation.spd, is checked, and the results are placed in the file, LUSE_ReleaseOperation_Result.spd. Note: For UNIX, add.sh to CFLCHK (that is, CFLCHK.sh). Operand input-file-name output-file-name Description The spreadsheet you want to verify. Include relative or absolute path. Maximum length is 240 characters. The output file name. Include relative or absolute path. Maximum length is 240 characters. Valid parameters read "Normal end" at the end of their lines. Note: Processing suspends when you right-click the command prompt window while the command prompt is not in Quick Edit Mode. To resume processing, press the Esc key, or left-click the command prompt window. Processing also suspends if you left-click when the command prompt is in Quick Edit Mode. To resume processing, press the Esc key, or right-click the command prompt window. If CLI processing is suspended for a long period, RMI time-out occurs and your log-in status is cancelled. When you resume processing in this case, an error ( ) occurs. To avoid this error, resume processing by opening a new command prompt window. Working with CLI spreadsheets 4 3

32 Correcting errors in a CLI-based spreadsheet If you find errors in the results, re-edit the spreadsheet and run the CFLCHK command again. Use the following guidelines to check for errors in the results file: In the results file, the code at the end of the declaration line, (xxxxyyyyy), indicates part codes and error codes. For details, see the Hitachi Storage Navigator Messages. Check errors from the bottom up. Find the last row with an error first. If a lower layer has an error, the upper layers also display an error even though the upper layer may have no error. If a higher layer has an error, parameters in the lower layers are not verified. After correcting the error in the upper layer, re-run CFLCHK to check for errors further down. Example 1 #!Version 06_01_00,CLI_LUSE,Get,;Error( ) [SerialNumber] 64569,;Normal end [LUSE] #^,;Error( ) GET_ALL,; This example shows two errors: In the declaration (top row). The (xxxx-yyyyy) following "Error" is a code-error code, which are described in Hitachi Storage Navigator Messages. In the Suspend-Pair operation tag, identified in the row below beginning begins with #^. In this example, an error occurred in the LUSE tag Example 2 #!Version 06_01_00,CLI_LUSE,VolumeOperation,;Error( ) [SerialNumber] 64601,;Normal end [Expansion] 00,00,00,;Error( ) +,00,00,01,;Error( ) This example shows three errors: In the declaration (top row). The (xxxx-yyyyy) following "Error" is a code-error code, which are described in Hitachi Storage Navigator Messages. Note that the Serial Number operation tag returned a "Normal end" result. "Normal end" indicates that a line is correct. Errors occurred in the first and second row in the Expansion tag. Example Working with CLI spreadsheets

33 The following example shows errors when the parameters are in a hierarchical structure. #!Version 06_01_00,CLI_ExternalStorage,VolumeOperationFibre,;Error( ) [SerialNumber] 65536,;Normal end [AddVolumeSetting] 1,1A,60060E8004F81370,0000,E1-1,Normal,00,OPEN- V,Disable,Enable,;Error( ) +,1B,60060E8004F81371,0001,;Error( ) +,+,00,00,00,96000,0004,; To identify where an error occurred in a hierarchical structure, find the last row with an error. In this example, an error occurred in the second layer that begins with +,. Parameters in the lower layers than the layer with an error are not verified and no execution results are displayed for them. When the errors are corrected, running CFLCHK again will show errors in subsequent lines, if they exist. Running the CLI-based spreadsheet After a CLI-based spreadsheet has been edited and validated, it is ready to run. Spreadsheets for LUN Expansion (LUSE) and Universal Volume Manager are run using the following CLI commands: Use the CFLSET command to change system settings or perform an operation. Use CFLGET to retrieve system information to a file. Running the CFLSET command Run CFLSET to change the configuration settings you have altered in the spreadsheet, or to perform other operations, such as run pair commands. A results file is generated when you run CFLSET, from which you can check whether the operation completed successfully. 1. At a command prompt, change directories to the location of the spreadsheet file. 2. Enter the following: CFLSET input-file-name output-file-name where: input-file-name is the name of the spreadsheet file with relative or absolute path. Maximum length is 240 characters. output-file-name is the name of the results file with relative or absolute path. Maximum length is 240 characters. For example: CFLCHK LUSE_ReleaseOp.spd LUSE_ReleaseOp_Result.spd On UNIX, add ".sh" to CFLSET, that is, CFLSET.sh. Working with CLI spreadsheets 4 5

34 3. Check the results file to verify that the operation completed successfully. Errors that may occur are: A communication error. Volumes or pairs that are not ready to accept changes. Another user is working with the storage system in Storage Navigator in Modify mode. If you have an error, correct the condition and run the command again. Running the CFLGET command Run CFLGET to retrieve storage system information and save it in a file. A results file is generated when you run CFLGET, from which you can check whether the retrieval completed successfully. 1. At a command prompt, change directories to the location of the spreadsheet file. 2. Enter the following: CFLGET input-file-name output-file-directory where: input-file-name is the name of the spreadsheet file with relative or absolute path. Maximum length is 240 characters. output-file directory is the name of the directory in which the results file and the spreadsheet file (output) are saved. Include the relative or absolute path. Maximum length is 150 characters. On UNIX, add ".sh" to CFLGET, that is, CFLGET.sh. For example: CFLGET ExtStorage_VolumeOperation.spd C:\CFLoutput 4 6 Working with CLI spreadsheets

35 5 Working with CFL spreadsheets You can use spreadsheets to automate changes to the storage system's configuration. This topic provides instructions and information for exporting, editing, importing, validating, and running CFL-based spreadsheets. Only LUN Manager uses CFL-based spreadsheets. CFL-based spreadsheet workflow Exporting system settings to a spreadsheet Setting up the CFL-based spreadsheet for editing Editing the CFL-based spreadsheet Importing and validating a CFL-based spreadsheet Running a CFL-based spreadsheet Working with CFL spreadsheets 5 1

36 CFL-based spreadsheet workflow You can perform the following operations using a CFL-based spreadsheet: 1. Obtain the spreadsheet by using CFL to export system information to a file. 2. Open the spreadsheet in a spreadsheet program. Open the spreadsheet with the settings specified in Configuring CLI on page 2-1. Do not use a tool that modifies the format of the file. This also applies to closing and saving the spreadsheet. 3. Edit the spreadsheet. Each spreadsheet has its own operations or functions, and parameters. 4. Validate the spreadsheet file by importing the edited file back into CFL. Error checking is performed during import. 5. Correct any errors by re-editing and revalidating the spreadsheet. 6. Run the spreadsheet in CFL. Exporting system settings to a spreadsheet The first step in setting up an editable spreadsheet is to export system settings from CFL to a spreadsheet file. LUN Manager is the only program product supported by CFL at this time. 1. In Storage Navigator, select Actions > Other Functions > Configuration File Loader from the menu. 2. Change to Modify mode by clicking the icon. 3. In the Configuration File Loader window, click Select Sheet and then select the product whose settings you want to export. 4. Click Export. If you use a Web browser for UNIX systems, the Download Manager dialog box may display when you click Export. If this occurs, close the Download Manager dialog box and continue the operation. 5. In the export dialog box, type or browse to the path where you want to export the file. A file name is supplied, which you can change if desired. Consult Spreadsheet file formatting requirements on page 3-2 for file naming requirements. Figure 5-1 Export dialog box 6. Click Export. The spreadsheet file is exported to the specified location. Continue to the next section to prepare and edit the spreadsheet. After editing, see Importing and validating a CFL-based spreadsheet on page Working with CFL spreadsheets

37 Setting up the CFL-based spreadsheet for editing Though spreadsheet settings have been exported from CFL, the file is not ready to edit yet. The following shows how to set up the exported file for editing, and provides other requirements and recommendations. 1. Open the spreadsheet. See Opening spreadsheet files on page 3-2 for important information. 2. Select and copy all of the settings in the spreadsheet, except the declaration line, and paste them on the right side of the spreadsheet. The editable spreadsheet must adhere to the following: Figure 5-2 Current and new settings 1st column to 7th column: Current settings area. Do not edit. 8th column to 10th column: Blank columns. 11th column to 17th column: New settings area for editing. Although you may want to change some, but not all, settings, you must copy and paste all of the current settings to the new settings area. Any setting that is omitted is deleted when the spreadsheet is run. The following table shows sample function tags and parameters with existing and new locations. Table 5-1 Sample function tags and parameters Column Existing (no editing) Function Tag [Port] [HostGroup] WWN [LUN] [LDEV] 1st Port Port Port Port Ldkc 2nd Security Switch Group Id Group Id Group Id Cu 3rd AL-PA Group Name WWN LunId Ldev 4th Fabric Host Mode Nickname Ldkc Cmd.Dev 5th Connection Option[0:31] Blank Cu Cmd.Sec 6th Channel speed Option[32:63] Blank Ldev Cmd.Usr 7th Blank Option[64:95] Blank Blank Cmd.Grp 8th Blank Blank Blank Blank Attribute * Working with CFL spreadsheets 5 3

38 Column Function Tag [Port] [HostGroup] WWN [LUN] [LDEV] Column 9th 10th New 11th Port Port Port Port Ldkc (for editing) 12th Security Switch Group Id Group Id Group Id Cu 13th AL-PA Group Name WWN LunId Ldev 14th Fabric Host Mode Nickname Ldkc Cmd.Dev 15th Connection Option[0:31] Blank Cu Cmd.Sec 16th Channel speed Option[32:63] Blank Ldev Cmd.Usr 17th Blank Option[64:95] Blank Blank Cmd.Grp * For external volumes, #External is output. The exported spreadsheet contains 10 columns. Editing the CFL-based spreadsheet You edit a spreadsheet to add, change, or delete system settings. Editing a spreadsheet requires the correct formats. Follow these guidelines when editing: Make sure the spreadsheet is set up for editing. See Setting up the CFLbased spreadsheet for editing on page 5-3 Consult the general formatting requirements in Spreadsheet file formatting requirements on page 3-2. Consult function tags and parameters in LUN Manager operations on page Add the word "Change" in the Declaration row in column Edit parameters only in the new settings. 5 4 Working with CFL spreadsheets

39 Figure 5-3 Example CFL-based spreadsheet 3. In the new settings area, edit parameters but not the index. A definition consists of the index and the parameter. The index is fixed for each function tag. Working with CFL spreadsheets 5 5

40 4. Do not duplicate an index within the same function tag. 5. Place a definition between function tags or between a function tag and the end of the file. 6. A function tag may require fewer than seven columns. In this case, leave the unused columns blank. The version of the spreadsheet may also determine the number of parameters for a function tag. Importing and validating a CFL-based spreadsheet After the spreadsheet is edited, import it back into CFL, which validates the spreadsheet during import. 1. Go to Storage Navigator and select Actions > Other Functions > Configuration File Loader from the menu. 2. Change to Modify mode by clicking the icon. 3. In the Configuration File Loader window, click Select Sheet and then select the product whose spreadsheet you want to import. 4. Click Import. If you use a Web browser for UNIX systems, the Download Manager dialog box may display when you click Import. If this occurs, close the Download Manager dialog box and continue the operation. 5. In the dialog box, type the path and spreadsheet file name, or browse to the path and select the.spd spreadsheet file. Figure 5-4 Import dialog box 6. Click Import. When a spreadsheet is imported, CFL verifies the formats. A spreadsheet can be rejected, in which case CFL displays a message with a message code. The following errors can display when a file is rejected. The file name is incorrect (such as the extension is not ".spd", or the file name exceeds the maximum number of letters). The spreadsheet file is not in text file format but is a binary file. The first row of the spreadsheet (the declaration line) is not correctly written, or the stated program product is not installed. There is no function tag in the spreadsheet. A spreadsheet must have at least one function tag. The number of letters in a row exceeds the limit. 7. In the Select Tag box, select any function tag with an asterisk to see errors. 5 6 Working with CFL spreadsheets

41 The Select Tag box is enabled when a spreadsheet is accepted by CFL. At the same time, a second level of error-checking takes place, in which the existing function settings are compared to the new settings. The Select Tag list consists of the spreadsheet's function tags; a function with errors is shown with an asterisk (*). 8. In the Error Information area, check errors for the selected function. Figure 5-5 Error Information area with LUN function errors Each line shows the affected row in the spreadsheet, the error code, the column in the spreadsheet, and a description. Errors that may occur are: A function tag is not supported in the current spreadsheet. Make sure you have not changed a function tag. A parameter value is incorrect or omitted. The range for a parameter is incorrect. Parameter values must be entered in the following ranges: LDKC: 00 CU: 00-3F LDEV: 00 - FF LUN: FF Group ID: 00 - FE Host Mode: 00-4F See Hitachi Storage Navigator Messages for error code information. 9. Edit the spreadsheet to correct errors, then re-import. When all errors are corrected, the spreadsheet imports with no errors. The word, "Ready", displays below the Error Information list, and the Apply button is enabled. Continue to the next section to run the spreadsheet. Running a CFL-based spreadsheet When a spreadsheet is imported into CFL with no errors, "Ready", displays at the bottom right of the Error Information list. This indicates that the spreadsheet is ready to be run. Working with CFL spreadsheets 5 7