Hardware Provider for Microsoft Virtual Disk Service (VDS) User Guide

Part No. 0086372-05A Issue 1.4 January 30, 2009

Hardware Provider for Microsoft Virtual Disk Service (VDS)

Notices
The information in this document is subject to change without notice. While every effort has been made to ensure that all information in this document is accurate, the Authors accept no liability for any errors that may arise. No part of this document may be transmitted or copied in any form, or by any means, for any purpose, without the written permission of the Authors. Issue 1.4 January 30, 2009 Part No. 0086372-05A

Acknowledgments Microsoft is a registered trademark of Microsoft Corporation. All other names, brands, products or services are trademarks or registered trademarks of their respective companies.

ii

Table of Contents

Contents
1 Introduction ..................................................................................................................................... 1.1 Overview ..................................................................................................................................... 1.2 System Requirements ................................................................................................................. 1.2.1 Enclosures .......................................................................................................................... 1.2.2 Host System ....................................................................................................................... 1.2.3 Software ............................................................................................................................. 1.3 Installation ................................................................................................................................... 1.3.1 Uninstallation ...................................................................................................................... 1 1 1 1 2 2 2 3

Using VDS ........................................................................................................................................ 5 2.1 Overview ..................................................................................................................................... 5 2.2 Official VDS Documentation ........................................................................................................ 6 2.3 Supported LUN Types ................................................................................................................. 7 2.3.1 Simple LUN ........................................................................................................................ 7 2.3.2 Stripe LUN .......................................................................................................................... 7 2.3.3 Span LUN ........................................................................................................................... 7 2.3.4 Mirror LUN .......................................................................................................................... 7 2.3.5 Parity/RAID LUN ................................................................................................................ 7 2.4 Supported VDS Functions ........................................................................................................... 8 2.5 Unsupported VDS Functions ..................................................................................................... 11 2.6 Drive Sizes ................................................................................................................................ 12 2.7 VDS Tools ................................................................................................................................. 12 2.7.1 DiskRAID .......................................................................................................................... 12 2.7.2 Storage Manager for SANs .............................................................................................. 13 2.8 Mapping of LUNs to Host .......................................................................................................... 13 Known Issues and Limitations .................................................................................................... 15 Event Codes .................................................................................................................................. 4.1 Events ....................................................................................................................................... 4.2 List of Event Messages ............................................................................................................. A.1 VDS and StorView Terminology ................................................................................................ 17 17 17 19

3 4

iii

Hardware Provider for Microsoft Virtual Disk Service (VDS)

iv

Preface

Preface
What is in this guide This user guide gives you an overview of how to use the Hardware Provider for Microsoft Virtual Disk Service (VDS), which functions are supported, and any issues to be aware of when using the provider. Who should use this guide Storage managers and software testers who need to use compatible Xyratex enclosures via Microsoft Virtual Disk Services (VDS). About this guide This user guide provides the following information: Chapter 1, Introduction, on page 1 gives an overview, system requirements and installation instructions. Chapter 2, Using VDS, on page 5 lists the standard VDS functions that are supported and not supported by the hardware providers. Chapter 3, Known Issues and Limitations, on page 15 lists any issues which may affect use of the software.

Related Documentation
The following documentation is essential for the understanding and use of this software: Official Microsoft documentation for VDS: http://www.microsoft.com/windowsserversystem/storage/storservices.mspx The Microsoft VDS Technical Reference: http://technet2.microsoft.com/WindowsServer/en/Library/1dbc6c24-1477-4f73-a0ae57b4e90808d81033.mspx

Revision History
Version 1.0 1.1 1.2 Date Description of Change November 27, 2007 Initial Release. April 2, 2007 June 20, 2008 Updates. Support for RS-1220-F4-6412E enclosures and Windows Server 2008.

Hardware Provider for Microsoft Virtual Disk Service (VDS)

Version 1.3 1.4

Date August 22, 2008 January 30, 2009

Description of Change Minor updates. Added support for F6500E controller. Added mapping license information.

vi

Introduction

Chapter 1

Introduction
1.1 Overview
VDS (Virtual Disk Service) is a feature of Microsoft Windows (from Windows Server 2003 onwards). It provides a consistent interface for managing storage devices and creating volumes. Each vendor of a storage solution can write their own provider that enables the standard set of VDS commands to be used with their storage device. The advantage of this approach is that multiple storage systems by different vendors can be controlled using the same set of commands provided by VDS. The Xyratex Hardware Provider for VDS enables Microsoft Volume Shadow Copy Services to be used with the RAID controller enclosures listed in 1.2.1 on page 1.

1.2 System Requirements

Use of the Hardware Provider for VDS requires the following:

1.2.1 Enclosures
The following enclosures and RAID Controllers are supported: RS-1220-F4-5402E (F5402E) RS-1220-E3-5402E (E5402E) RS-4835-F4-5404E (F5404E) RS-1220-F4-5412E (F5412E) RS-1220-E3-5412E (E5412E) RS-1220-F4-6412E (F6412E)

Hardware Provider for Microsoft Virtual Disk Service (VDS)

HB-2435-F8-6500E (F6500E) HB-2435-E311-XPN (F6500E)

1.2.2 Host System

The following systems are supported: Microsoft Windows Server 2003 with Service Pack 2 (Web, Standard, Enterprise, Enterprise 64-bit and Standard 64-bit). Microsoft Windows Server 2008 (32-bit, 64-bit and IA64). The following hardware is required: A host bus adapter (HBA). A direct connection from the HBA to the enclosure.

1.2.3 Software
Microsoft VDS 1.1. A VDS client (optional). The Microsoft utility programs Storage Manager for SANs and DiskRAID (both optional).

1.3 Installation
Use the following procedure to install the Hardware Provider for VDS: Double-click the installer executable. Read the license agreement and click I Agree to accept to the terms and conditions. Choose a destination folder for the application (or accept the default) and click Install. You will be informed once the installation is finished. Click Close to dismiss the installation window. Note If the VDS service is running, it will be stopped automatically while the provider is installed. The VDS service will start automatically when a client attempts to access it. However, under some circumstances you may need to manually start the VDS service using the following procedure: Click Start -> Control Panel -> Administrative Tools -> Services. Select Virtual Disk Services from the list. Click the Start hyperlink.

Introduction

Note

The Hardware Provider for VDS can be installed on a system that already has VDS providers from other vendors. Likewise, other VDS providers can be installed after this one without any conflict.

1.3.1 Uninstallation
An uninstall executable is provided in the Program Files\VDS Hardware Provider - Xyratex folder. To remove the software, run the uninstall program and follow the on-screen instructions.

Hardware Provider for Microsoft Virtual Disk Service (VDS)

Using VDS

Chapter 2

Using VDS
2.1 Overview
The VDS (Virtual Disk Service) provider is a dynamic link library (DLL) that works as a translation layer between Microsoft VDS and compatible Xyratex storage solutions. VDS is a Microsoft-specific technology that is able to manage a variety of storage configurations, from single-disk desktops to large external storage arrays. It requires the installation of a client application (or VDS management tool) in order to be fully utilized. Any third party vendor can write a VDS compliant client application. The Hardware Provider for VDS has no direct interface with which a user can interact. However, Microsoft Windows Server 2003 and later, ships with two VDS management tools that can be used to test the provider: 1 Command Line See 2.7.1, DiskRAID, on page 12. 2 Graphical Interface See 2.7.2, Storage Manager for SANs, on page 13.

Hardware Provider for Microsoft Virtual Disk Service (VDS)

The following diagram illustrates, in a simplified manner, how all these components fit together. VDS Client - CLI or GUI (for example, DiskRAID, Storage Manager for SANs, third party application)

Microsoft VDS Service v1.1

Xyratex Hardware Provider for VDS (DLL)

Storage System (for example, F5402E) Table 21 High Level VDS Component Overview

The VDS provider therefore acts as a bridge between the Microsoft VDS software and Xyratex hardware, enabling any third party vendor to create a client tool that can monitor and manage enclosures. Note that multiple providers, from different vendors, can be installed on the same system. VDS has no concept of arrays, it only considers LUNs. Since Xyratex controllers uses both arrays and LUNs, all array based operations take place behind the scenes as part of the internal workings of the provider and are not reported in any form to the user.

2.2 Official VDS Documentation

Since VDS is a Microsoft standard, you should consult the official Microsoft documentation for details on how to use it: http://www.microsoft.com/windowsserversystem/storage/storservices.mspx The VDS Technical Reference is also available from Microsoft: http://technet2.microsoft.com/WindowsServer/en/Library/1dbc6c24-1477-4f73-a0ae57b4e90808d81033.mspx

Using VDS

2.3 Supported LUN Types

The provider supports the following LUN types:

2.3.1 Simple LUN

A simple LUN is created on an array that consists of only one disk. Any other LUN type must straddle at least two disks. Trying to create a stripe LUN or span LUN on a single drive will fail with E_INVALIDARG. Expanding a simple LUN on the same array will leave the LUN type unchanged. Expanding the LUN onto another array will always turn it into a span LUN (in other words, if there is not enough room on the existing drive for the expansion).

2.3.2 Stripe LUN

A stripe LUN must consist of one or more regions on a RAID 0 array that spans 2 or more drives. A LUN is a stripe LUN as long as it consists of regions from a single array. If it is expanded and it uses a region from another array it will become a spanned LUN. Using two regions from the same array means it will still be a stripe LUN.

2.3.3 Span LUN

A span LUN must consist of two or more regions on two separate RAID 0 arrays (the extents cover all the disks in both arrays). At least one array must contain two or more drives. The other array can be a single drive array or a multiple drive array.

2.3.4 Mirror LUN

A mirror LUN must consist of one or more regions from an array with an even number of drives. A mirror LUN will always be created on a mirror array. A mirror LUN can only be expanded onto a larger mirrored LUN.

2.3.5 Parity/RAID LUN

A RAID LUN must consist of one or more regions from an array with 3 or more drives. A RAID LUN will always be created on a RAID array. VDS does not support RAID 50, so it can only create RAID 5 LUNs. A RAID LUN can only be expanded into a larger RAID LUN.

Hardware Provider for Microsoft Virtual Disk Service (VDS)

2.4 Supported VDS Functions

The following VDS functions are supported by the Hardware Provider for VDS: Table 22 Object IEnumVdsObject Supported VDS Functions Method Name Clone Next Reset Skip IVdsAsync QueryStatus Wait IVdsController GetPortProperties GetProperties GetSubSystem Reset SetStatus QueryAssociatedLuns Initialize (internal) IVdsControllerControllerPort IVdsControllerPort QueryControllerPorts Initialize (internal) GetController GetProperties IVdsDrive GetProperties GetSubsystem ClearFlags SetFlags SetStatus Initialize (internal) IVdsHwProvider QuerySubSystems Reenumerate Refresh IVdsHwProviderPrivate QueryIfCreatedLun

Using VDS

Table 22 Object

Supported VDS Functions Method Name GetProviderType GetProperties GetSubsystem Initialize (internal) QueryHints QueryMaxLunExtendSize QueryPlexes Delete Extend SetStatus (offline and online only) SetMask GetIdentificationData

IvdsHwProviderType IVdsLun

IVdsLunControllerPorts

AssociateControllerPorts QueryActiveControllerPorts

IVdsLunNaming IVdsLunPlex

SetFriendlyName GetLun GetProperties QueryExtents QueryHints

IVdsMaintenance (controller)

PulseMaintenance StartMaintenance StopMaintenance

IVdsMaintenance (c-port)

PulseMaintenance StartMaintenance StopMaintenance

IVdsMaintenance (drive)

PulseMaintenance StartMaintenance StopMaintenance

Hardware Provider for Microsoft Virtual Disk Service (VDS)

Table 22 Object

Supported VDS Functions Method Name PulseMaintenance StartMaintenance StopMaintenance

IVdsMaintenance (lun)

IVdsMaintenance (subsystem)

PulseMaintenance StartMaintenance StopMaintenance

IVdsProvider IVdsProviderPrivate

GetProperties GetObject OnLoad OnUnload

IVdsProviderSupport IVdsSubSystem

GetVersionSupport GetDrive GetProperties GetProvider QueryControllers QueryDrives QueryLuns QueryMaxLunCreateSize Reenumerate SetControllerStatus Initialize (internal) CreateLun

IVdsSubSystemNaming

SetFriendlyName

Other vendors providers may support a different set of functions.

10

Using VDS

2.5 Unsupported VDS Functions

The following VDS functions are not supported by the Hardware Provider for VDS:
Table 23 Object IVdsAsync IVdsController Unsupported VDS Functions Method Name Cancel FlushCache GetPortProperties InvalidateCache PulseMaintentance QueryAssociatedLuns StartMaintentance StopMaintentance IVdsControllerPort PulseMaintenance Reset SetStatus StartMaintenance StopMaintenance IVdsDrive PulseMaintenance QueryExtents SetStatus StartMaintenance StopMaintenance IVdsHwProviderPrivateMpio IVdsLun SetAllPathStatusesFromHbaPort AddPlex AssociateControllers ApplyHints QueryActiveControllers Recover RemovePlex Shrink

11

Hardware Provider for Microsoft Virtual Disk Service (VDS)

Table 23 Object IVdsLunMpio

Unsupported VDS Functions Method Name GetLoadBalancePolicy GetPathInfo GetSupportedLbPolicies SetLoadBalancePriority

IVdsLunPlex IVdsSubSystem

ApplyHints PulseMaintenance ReplaceDrive StartMaintenance StopMaintenance SetStatus

Other vendors' providers may support a different set of functions.

2.6 Drive Sizes

Drive manufacturers report their drive sizes by calculating the number of GBs from the number of bytes at 10^9 (a KB is 1000 bytes, a MB is 1000 KBs and a GB is 1000 MBs). Operating systems, on the other hand, calculate GBs from bytes at 2^30 (a KB is 1024 bytes, a MB is 1024 KBs and a GB is 1024 MBs). This can result in a discrepancy in sizes when viewing drives with different applications. This is most obvious when creating small LUN sizes. With Xyratex controllers, LUNs are created with a resolution of 1GB, so the smallest LUN you can create is 1GB. This is 1000000000 bytes. A Windows 1GB LUN is 1073741824 bytes. This equates to 1.07 LUNs. Therefore, if you try to create a 1GB LUN on VDS, the controller can either create a LUN of 1000000000 bytes or 2000000000 bytes. The first is equivalent to about 950MB, and the second is equivalent to about 1900MB. The Xyratex provider will always choose the larger option, since it is assumed that the user needs a minimum of 1GB if they ask for a 1GB LUN.

2.7 VDS Tools

Two helpful tools exist for making use of VDS:

2.7.1 DiskRAID
DiskRAID is a command line tool that can be used to interface with VDS. It is included with the VDS SDK and can also be downloaded from Microsoft or found in the Resource Kit Tools.

12

Using VDS

It is very important that you use the correct version of DiskRaid for VDS 1.1. Check your version of DiskRaid by right clicking the file and selecting the Version tab. The version should show: 5.2.3790.2567 or higher. DiskRaid commands can be scripted for configuration or testing of a subsystem. DiskRaid is part of the Windows Server operating system, and should be located in the WINDOWS\SYSTEM32 folder as a file named diskraid.exe.

2.7.2 Storage Manager for SANs

Storage Manager for SANs (SMS) is a simple graphical user interface for managing Storage Area Networks that comes as part of Windows Server. It is not installed by default, but can be installed using the following procedure: In the Windows Control Panel click Add or Remove Programs. Click the Add/Remove Windows Components icon. Select the Management and Monitoring Tools from the list and click the Details button. Check the Storage Manager for SANs checkbox. Click OK and follow the on-screen instructions. The GUI is then available through Start -> All Programs -> Administrative Tools -> Storage Manager for SANs.

2.8 Mapping of LUNs to Host

When a LUN (logical drive) is to be unmasked to the host (made available as a disk device), the provider will carry out the masking operation as follows: If the SAN LUN mapping feature is disabled, the port mapping mechanism would be used to map the LUN to the host. If the SAN LUN mapping feature is enabled (in other words, a valid license key is entered or the 15day trial period is active) the LUN would be mapped to the host using the SAN LUN mapping mechanism. After the 15-day SAN LUN mapping trial period expires, all SAN LUN mapping will be disabled. This results in LUNs no longer being visible to the hosts. In order to map the LUNs to the host, you must do one of the following: 1 Obtain a valid license key to enable the SAN LUN mappings (in which case, all previously created SAN LUN mappings will be re-activated). 2 Perform new unmasking operations via "diskraid" or "Storage Manager for SANs". This results in the LUNs being unmasked/mapped to the host using the port mapping mechanism.

13

Hardware Provider for Microsoft Virtual Disk Service (VDS)

14

Known Issues and Limitations

Chapter 3

Known Issues and Limitations

The following issues and limitations are present in the current release of Hardware Provider for VDS: Configuration changes made from other clients will not be reflected in VDS without a manual refresh. Flashing of drive LEDs cannot be turned off they can only be set to flash for a specific time period. The following limitations relate to the SetFriendlyName method in the IVdsSubSystemNaming object: The subsystem cannot be given a friendly name until at least one LUN has been created. If the subsystem is renamed without any other configuration being present, it will not persist. The subsystem will retain the default name. If the subsystem has been renamed and all of the LUNs are subsequently deleted, the subsystem name will revert back to the default name. When using the Extend method in the IVdsLun object, if there is insufficient space on the existing array, a whole new array will be created in the background on which to expand the LUN. Existing arrays cannot, in themselves, be extended. This has the following implications: RAID 5 arrays have to be extended by a minimum of 3 drives. RAID 1 arrays have to be extended by an even number of drives. If there are an insufficient number of drives, or if an incorrect number of drives is explicitly specified, an invalid argument error will occur.

15

Hardware Provider for Microsoft Virtual Disk Service (VDS)

There are minimum allowable chunk sizes for RAID 0 and RAID 1 arrays (RAID 5 arrays have no restrictions): Table 31Minimum Chunk Sizes RAID 0: Number of Drives Minimum Chunk Size RAID 1: Number of Drives Minimum Chunk Size 2 or 4 256K 6 128K 8 or more 64K 1 or 2 256K 3 128K 4 or more 64K

Note: Stripe size = (chunk size) x (number of non-parity drives in the array). Passing in an incorrect number of drives will result in an E_INVALIDARG error.

16

Event Codes

Chapter 4

Event Codes
4.1 Events
Xyratex StorView Path Manager for Windows uses the standard Windows Application event log to record any information or errors that may be of interest. To view events: 1 2 In the Windows Control Panel, select Administrative Tools -> Event Viewer. Click on the Application log to view system-level events.

4.2 List of Event Messages

The following event messages may be generated: Table 41 List of Event Messages Additional Information The controller cannot be reset, because it is either missing or has failed. Error Message Cannot reset failed or missing controller A Cannot reset failed or missing controller B Controller reset failed Reset of controller successfully issued Unable to set drive to hotspare. Drive is not free or a redundant array is not present A problem occured whilst trying to start identifying the drive A problem occured whilst trying to stop identifying the drive Starting provider and loading into memory Occurs when the hardware provider for VDS has been started.

17

Hardware Provider for Microsoft Virtual Disk Service (VDS)

Table 41

List of Event Messages Additional Information Occurs when the hardware provider for VDS has been stopped.

Error Message Stopping provider and unloading from memory SES Page 1 was not returned successfully. Number of slots were be set to default (12) LUN created successfully (<GUID>) LUN deleted successfully (<GUID>) A problem occured whilst loading the configuration from the RAID controller. Data may be incorrect VDS is unable to create the array(s) needed for Span LUN

A LUN has been created, the GUID of which is contained in the brackets. A LUN has been deleted, the GUID of which is contained in the brackets.

18

Appendix A

Appendix A

Terminology
A.1 VDS and StorView Terminology
VDS and StorView sometimes use different terms to describe the same concepts. The following table illustrates the differences: Table A1 VDS Term Failed Not Ready Online Comparison of VDS and StorView terms StorView Term Critical Rebuilding Available

19

Hardware Provider for Microsoft Virtual Disk Service (VDS)

20