SAN Management Software HyperFS PC Client Tools This guide provides step-by-step instructions for setup, configuration, and maintenance of the Rorke Data HyperFS SAN Management Software Ver 2.1 May 11, 2012
This page left blank intentionally HyperFS Tools
This manual applies to Hyper FS SAN Management Software for the use of HyperFS Client Administration Released January 1, 2012 Copyright 2012 This edition first published 2012. All rights reserved. This publication may not be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written consent of Rorke Data, Inc. Disclaimer Rorke Data makes no representations or warranties with respect to the contents hereof and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose. Furthermore, Rorke Data reserves the right to revise this publication and to make changes from time to time in the content hereof without obligation to notify any person of such revisions or changes. Product specifications are also subject to change without prior notice. Trademarks Rorke Data and the Rorke Data logo are registered trademarks of Rorke Data, Inc. Rorke Data are trademarks of Rorke Data, Inc. in the United States, other countries, or both. Third-party software is copyrighted and licensed from Rorke suppliers. Windows and Microsoft are trademarks of Microsoft Corporation in the United States, other countries, or both. All other names, brands, products or services are trademarks or registered trademarks of their respective owners. Naming conventions For ease of identification purposes, the Rorke Data Hyper FS software can be referred to as the HyperFS or the San Software in the following manual. Changes This Administrators Guide is for information only, and is subject to change without notice. Rorke Data reserves the right to revise this publication, software and product design and to make changes in content from time to time without obligation on the part of Rorke Data to provide notification of such revisions or changes.
Contents HyperFS Tools......................................... 1 Tools console..........................................................1 Launch the console...................................................1 Log Management.......................................................3 Action Log..........................................................3 Performance Log.....................................................5 Event Log...........................................................6 Disk Management.......................................................8 Disk Information......................................................8 Security Settings.....................................................9 System Options........................................................12 Application Language.................................................12 Quick Deployment...................................................13 AutoMount Management..............................................14 Status Monitor Settings...............................................15 Optimization........................................................16 Sector Setting.......................................................17 Time Record........................................................18 Config Export.......................................................19 Index................................................ 20 HyperFS Client Administration Tools User Guide i
HyperFS Tools A suite of administration tools for managing HyperFS clients is installed with the client utility. These tools should be used with guidance from Rorke Data Technical Support. Tools console Launch the console The tools are presented in a convenient console, in three groups: Log Management Action Log Performance Log Event Log Disk Management Disk Information Security Settings System Options Application Language Quick Deployment AutoMount Management Status Monitor Settings Optimization Sector Setting Time Record Config Export There are three ways to launch the HyperFS Tools console: Click Start --> Programs --> HyperFS --> HyperFS Tools. In the HyperFS client console (Windows clients only), right-click the Servers object and select HyperFS Tools (refer to the HyperFS Client Software Utility User Guide). In the HyperFS Installs folder in Windows Explorer, double-click HyperFSTools.exe. HyperFS Client Administration Tools User Guide 1
When the Tools console is open, an icon is shown in the Windows taskbar:. The console includes a navigation pane on the left. When you select a tool in the navigation pane, the settings screen for that tool is displayed on the right. To close the console, click the Exit button. HyperFS Client Administration Tools User Guide 2
Log Management Action Log The Action Log, Performance Log, and Event Log are used for performance analysis and troubleshooting. Use the Action Log tool to configure and record the Action Log, which is displayed from the HyperFS Management Console. Settings Buffer Size - Set the buffer size for log recording. Options: 256 KB, 512 KB, 1 MB, 2 MB (Default), 4 MB, 8 MB, 16 MB. Refresh Time - Set the interval for refreshing the displayed Action Log from the buffer. Options: 0.1s (Default), 0.2s, 0.5s, 1s, 2s. Log Level - Set the level of events to include in the log. Options: FATAL - No events are included. ERROR or WARNING - Error messages INFO (default) - Error messages and events DEBUG - Error messages, events, and debug messages Save Path - Specify a save location for the Action Log.txt file. To do this, you can accept the default location, type a different path in the text box, or click the Browse button, select the path, and then click Save. HyperFS Client Administration Tools User Guide 3
IRP - Displays all possible legacy IRPs. Select the legacy IRPs to include in the Action Log. FAST I/O - Displays all possible FAST I/O requests. Select the FAST I/O requests to include in the Action Log. Functions Record - Records the Action Log and saves the log file to the specified location. Stop - Stops Action Log recording and saves the log file to the specified location. Clear - Clears all events from the Action Log file. HyperFS Client Administration Tools User Guide 4
Performance Log Use the Performance Log tool to configure and record the Performance Log, which can be used to analyze performance bottlenecks. Settings Buffer Size - Set the buffer size for log recording. Options: 256 KB, 512 KB, 1 MB, 2 MB (Default), 4 MB, 8 MB, 16 MB. Record Mode - Specify how the log will be recorded: Single - When you select Record, data currently in the buffer will be written to the log and then recording will stop. Continuous - When you select Record, data will be written to the log continuously until you select Stop Record. Save Path - Specify a save location for the Action Log.bin file. To do this, you can accept the default location, type a different path in the text box, or click the Browse button, select the path, and then click Save. Functions Collect - Collects the Performance Log and stores it in the buffer. Stop Collect - Stops collection. Record - Writes the log from the buffer to a.bin file in the specified location. Stop Record - Stops Performance Log recording and saves the log file to the specified location. Analyze - Converts the *.bin file to an *.ana file that can be viewed in a text editor. Clear - Clears all events from the Performance Log file unless Collect, Record, or Analyze is currently selected. Set up log 1. Display the Performance Log tool. HyperFS Client Administration Tools User Guide 5
2. Choose a buffer size and record mode. 3. Accept the default save path or select another location. 4. Select Collect (which also selects Record) or Record. View log If you have set up the log and selected Collect or Record, you can view the log: 1. Display the Performance Log tool. 2. Stop collecting or recording. 3. Click Analyze, which changes the saved.bin file to an.ana file. 4. Go to the log file location and view the.ana file using a text tool. Event Log Use the Event Log tool to specify the types of events to record in the Event Log, which is displayed from the HyperFS Management Console. HyperFS Client Administration Tools User Guide 6
Settings To set the event level for the Event Log, do the following: 1. Choose an event level in the drop-down list. Four event levels are available: NONE - Do not create an error log ERROR - Error events only EVENT - Error events and information events DEBUG - Error events, information events, and debug events 2. Click Apply. 3. Restart the client machine. To view event logs, right click My computer in Windows Explorer and then select Manage --> System Tools --> Event Viewer - Application. HyperFS Client Administration Tools User Guide 7
Disk Management Disk Information Disk Management tools display information about physical disks and allow you to protect file system volumes. Use the Disk Information tool to display detailed information about all hard disks available to the HyperFS server. Information for each disk includes: Disk Name in the HyperFS system Disk Capacity in MB Sector Size Physical Pages Transfer length Label - Indicates whether or not the disk has a label. Click Refresh to update the display. HyperFS Client Administration Tools User Guide 8
Security Settings Use the Security Setting tool to display security status information for all disks that have been configured as file system volumes and are therefore labeled; protect or unprotect listed volumes; and clear the volume label when necessary. Notes: Removing protection from a volume may cause a loss of file system data on that volume and is not recommended. Removing a label from a volume will destroy the data on the volume. Security information includes: Volume Name - This is the disk name, not the name of the file system volume. Disk State - Indicates whether or not the disk is protected. Label Version - Indicates the version of HyperFS server software. Label Consistency - If a back label exists, indicates whether or not the master label is the same as the back label. This value should always be yes. If the value is no, click Details to see additional information and then contact Technical Support. Protect Unprotect Click Protect to protect all volumes in the list. Protected disks are not visible in Windows Explorer. You can remove protection from all volumes in the list at the same time. 1. Click Unprotect. HyperFS Client Administration Tools User Guide 9
2. Because this operation may cause data to be lost from volumes, type yes in the confirmation dialog, then select OK. Refresh Details Click Refresh to update the display. Click Details to display additional volume details. First Label - Master volume label Back Label - Backup backup label Label information is displayed only for volumes created using HyperFS version 2.0 and above. If the First Label and Back Label are not the same, the incorrect label will be displayed in red and will show an Error prefix. HyperFS Client Administration Tools User Guide 10
Clear Label You can remove labels from one or more volumes in the list at the same time. To do this: 1. Select the volumes whose labels you want to remove. 2. Click Clear Label. 3. Because this operation will cause data to be lost from the selected volumes, type yes in the confirmation dialog, then select OK. HyperFS Client Administration Tools User Guide 11
System Options Application Language System options allow you to customize the HyperFS system and perform important tasks such as exporting the HyperFS Client Configuration file to another machine for safe keeping. Use this tool to specify the language displayed for the HyperFS Client Console, HyperFS Status Monitor, and HyperFS Tools (on Windows clients only). Two languages are supported: English and Simplified Chinese. To change the current language, select the other language in the list and then click Apply. The new language will be used the next time you start the application. HyperFS Client Administration Tools User Guide 12
Quick Deployment Use this tool to export the client configuration profile to a remote location, as well as import the profile in order to restore a client. You can use the Note: Be sure to export the client configuration before updating the HyperFS client software, as this procedure will erase the existing configuration. Once the software upgrade is complete, you can load the configuration from the external file. Export To export the client profile: 1. Specify profile contents by selecting a Profile Level from the drop-down list: Server IP - Basic public information and the server IP address Server IP details - Basic public information and server IP details Server IP details and export path(s) - All information in the level above, plus export path(s) Server IP and export path(s) details - All information in the level above, plus export path(s) details (the default). 2. Specify a Profile Path location. To do this, type a path in the text box or click the Browse button, select the path, and then click Save. The profile name has the format *.cfg. 3. Click Export to export the profile. Import To import the exported profile: 1. Click Browse and navigate to the location of the exported.cfg file. HyperFS Client Administration Tools User Guide 13
2. Select the file, then select Read-Only. Click Open. 3. Click Import. AutoMount Management Use the Automount tool to extend the amount of time during which export paths must mount after you log in to the console. Depending on the number of volumes being connected to, the default timeout of 45 seconds may not be long enough and automount will fail. This timeout value will apply when automount is selected as a Client Console login option. To increase the timeout, type a value in seconds in the text box and click Apply. HyperFS Client Administration Tools User Guide 14
Status Monitor Settings Use the Status Monitor tool to enable/disable the Status Monitor application and/or display. Enable Disable To enable the Status Monitor, select the checkbox and click Apply. If Status Monitor application is running, the display will become visible. If the application is not running, doing this will run the application. To disable the Status Monitor display, de-select the checkbox and click Apply. If the Status Monitor application is running, it will exit. If the Status Monitor application is not running, it is set as disabled and cannot be started. Refer to the HyperFS Client Utility User Guide for details on using the Status Monitor. HyperFS Client Administration Tools User Guide 15
Optimization Use the Optimization tool to improve file system performance by setting a SCSI limit enabling or disabling the read/write cache. SCSI limit To specify a SCSI limit: 1. Select the Force SCSI Limit checkbox to enable the SCSI Limit textbox. 2. Enter a limit value that is more than 4 KB (the default). If you enter a value less than 4 KB, it will be ignored and the previous setting will apply. 3. Click Apply. Read/write setting To disable the cache, select Disable Cache and then click Apply. The new values will take effect the next time export paths associated with the client are mounted. HyperFS Client Administration Tools User Guide 16
Sector Setting Use the Sector Setting tool to define a standard disk sector size for all storage. By default, disk sector size is set to the maximum. To modify the default disk sector size, choose a value from the list (512 KB, 1 KB, 2 KB, or 4 KB) and click Apply. The new disk sector size will take effect the next time each export path is mounted. HyperFS Client Administration Tools User Guide 17
Time Record Use the Time Record tool to record the current system time. This is useful during testing. Click Record to record the current time; click Clear to clear all times from the list. HyperFS Client Administration Tools User Guide 18
Config Export Use the Config Export tool to safeguard client configuration information by saving it to an external file. Note that this saves a.txt file of client configuration. For information about exporting and importing the client.cfg file, refer to Quick Deployment. Save Path - Specify a save location for the configuration.txt file. To do this, you can accept the default location, type a different path in the text box, or click the Browse button, select the path, and then click Save. The configuration file includes the following: Client software version Values set in HyperFS Tools Disk details as displayed in the Disk Information tool Windows OS version Server memory information Network information Device information from the Windows Control Panel. HyperFS Client Administration Tools User Guide 19
Index C Client configuration Export 13 Import 13 Text file 19 Client software updatet 13 D Disk management tools 1, 8 E Export client configuration 13 I Import client configuration 13 Import client configuration 13 Sector Settings 17 Security Settings 9 Clear Label 10 Details 10 Protect 9 Refresh 10 Unprotect 9 Status Monitor Settings 15 Disable 15 Enable 15 Time Record 18 Tools console Icon 2 Launch 1 L Log management tools 1, 3 S System option tools 1, 12 T Tools Action Log 3 Functions 4 Settings 3 Application Language 12 AutoMount Management 14 Configuration Export 19 Save path 19 Disk Information 8 Event Log 6 Settings 6 Optimization 16 Read/write setting 16 SCSI limit 16 Performance Log 5 Functions 5 Settings 5 Setup 5 View 6 Quick Deployment 13 Export client configuration 13 HyperFS Client Administration Tools User Guide 20