IVdsSubSystem

IVdsSubSystem インターフェース (vdshwprv.h) は、サブシステムに対するクエリ操作および構成操作を実行するためのメソッドを提供します。

IVdsSubSystem::GetProperties (vdshwprv.h) メソッドは、サブシステムのプロパティを返します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

IVdsSubSystem::GetProvider (vdshwprv.h) メソッドは、サブシステムを管理するプロバイダーを返します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

IVdsSubSystem::QueryControllers (vdshwprv.h) メソッドは、サブシステムが管理するオンラインおよびオフラインのコントローラーを列挙するオブジェクトを返します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

コントローラーの数を取得するには QueryControllers メソッドを使用し、返された列挙内のコントローラーを数えます。

サブシステムにコントローラーがない場合、このメソッドは空の列挙オブジェクトを返します。

IVdsSubSystem::QueryLuns (vdshwprv.h) メソッドは、サブシステムで公開されている LUN の列挙を返します。これはハードウェアプロバイダーオブジェクトにのみ適用されます。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

IEnumVdsObject インターフェースには、LUN マスキングに関係なく、サブシステム内のすべての LUN が含まれます。

実装者は、LUN が 0 個のサブシステムごとに空の列挙オブジェクトを返す必要があります。

このメソッドが同時に実行されている 2 つの別々のスレッドで呼び出された場合、結果が一貫しないことがあります。あるスレッドでこのメソッドを呼び出している間に、別の同時実行スレッドで IVdsLun::Delete などのメソッドが呼び出された場合、プロバイダーでアクセス違反が発生する可能性があります。このような同期の問題を最小限に抑えるため、必要に応じてこのクエリ操作を直列化するのはハードウェアプロバイダーの責任です。

IVdsSubSystem::QueryDrives (vdshwprv.h) メソッドは、サブシステム内のドライブを列挙するオブジェクトを返します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

ハードウェアプロバイダーのスタッキングが行われている場合、サブシステム内のドライブが、別のサブシステムによって公開された LUN であることがあります。

実装者は、ドライブが 0 個のサブシステムごとに空の列挙オブジェクトを返す必要があります。

IVdsSubSystem::GetDrive (vdshwprv.h) メソッドは、指定されたドライブを返します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

sSlotNumber と sBusNumber はドライブを一意に識別するため、実装者はドライブを内部的に識別する手段として、それぞれに任意の(ただし一貫した)値を割り当てることができます。バス番号とスロット番号の詳細については、VDS_DRIVE_PROP 構造体の sInternalBusNumber および sSlotNumber メンバーを参照してください。

IVdsSubSystem::Reenumerate (vdshwprv.h) メソッドは、サブシステムに対してバスをスキャンさせ、新たに接続されたドライブや新たに切断されたドライブを検出するよう促します。

このメソッドは、E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

ほとんどのサブシステムは、新しい接続や切断を自動的に検出します。ただし、それを行わないサブシステムに対しては、このメソッドが手動で検出を開始する手段を提供します。この操作は完了までに長い時間がかかることがあります。

このメソッドが新たに接続されたドライブを検出すると、プロバイダーはそのための新しいドライブオブジェクトを作成します。新たに切断されたドライブを検出すると、プロバイダーは最後の VDS 参照が削除されるまで古いドライブオブジェクトを保持し、その後オブジェクトを削除します。

各オブジェクトは、一意で永続的な識別子を持つ必要があります。オブジェクト ID は有効な GUID でなければなりません。実装者は、再列挙の前後の両方に存在するオブジェクトについて、このメソッドを使用して再列挙をまたいでオブジェクト ID を永続化する必要があります。

IVdsSubSystem::SetControllerStatus (vdshwprv.h) メソッドは、サブシステム内のコントローラーのステータス(オンラインまたはオフライン)を設定します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

このメソッドを使用すると、呼び出し元はすべてのコントローラーのステータスを一度に設定できます。単一のコントローラーのステータスを設定するには、IVdsController::SetStatus メソッドを使用します。

呼び出し元は、メソッド呼び出しごとに、コントローラーの完全なセットを pOnlineControllerIdArray または pOfflineControllerIdArray パラメーターのいずれかで渡す必要があります。E_INVALIDARG の戻り値は、サブシステム内のすべてのコントローラーがこのメソッドの引数に指定されていないことを示している場合があります。SetControllerStatus メソッドでは、サブシステム内のすべてのコントローラーが、指定された 2 つの配列のいずれかに存在している必要があります。

IVdsSubSystem::CreateLun (vdshwprv.h) 関数は、論理ユニット番号 (LUN) を作成します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

type パラメーターと pHints パラメーターに適切な値を選択することで、呼び出し元は LUN の属性を全面的に、部分的に、または最小限に指定できます。プロバイダーは、pHints パラメーターが指す VDS_HINTS 構造体で指定された automagic ヒントに基づいて、指定されていない属性を自動的に含めることができます。

VDS プロバイダーが単純なターゲット構成のみをサポートする場合、サブシステムは新たに作成された LUN オブジェクトを iSCSI ターゲットオブジェクトに自動的に関連付ける必要があります。VDS_SUB_SYSTEM_FLAG 列挙の VDS_SF_SUPPORTS_SIMPLE_TARGET_CONFIG 値を参照してください。

pwszUnmaskingList パラメーター内の WWN と IQN のリストには、重複した名前が含まれることがあります。リスト内のすべての名前を検証し、必要に応じて重複を削除するのはプロバイダーの責任です。

LUN を再利用できるように LUN のパーティション情報を削除するのは、ハードウェアプロバイダーの責任です。LUN が MBR ディスクの場合、これはディスクの先頭と末尾の 1 MB にゼロを書き込むことで行われます。GPT ディスクの場合は、ディスクの先頭と末尾の 16 KB にゼロを書き込む必要があります。

E_INVALIDARG と VDS_E_NOT_SUPPORTED の戻り値には微妙な違いがあります。プロバイダーは、VDS API がクライアントに提示できるすべての機能を実装することを期待されているわけではありません。たとえば、CreateLun メソッドは、さまざまな種類の LUN(単純、ミラー、ストライプ、パリティなど)を作成する機能を公開します。ただし、プロバイダーがすべての種類の LUN をサポートする必要はありません。呼び出し元が type パラメーターに有効な VDS_LUN_TYPE 列挙値ではない値を指定した場合、プロバイダーは E_INVALIDARG を返す必要があります。呼び出し元がプロバイダーのサポートしていない有効な type 値を指定した場合、プロバイダーは VDS_E_NOT_SUPPORTED を返す必要があります。

実装者への注: このメソッドの呼び出しが非同期操作を開始しない場合であっても、プロバイダーは ppAsync パラメーターに IVdsAsync インターフェースポインターを返す必要があります。

IVdsSubSystem::ReplaceDrive (vdshwprv.h) メソッドは、サブシステム内のあるドライブを別のドライブに置き換える、または移行します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

IVdsSubSystem::SetStatus (vdshwprv.h) メソッドは、サブシステムのステータスを指定された値に設定します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。

実装者は、ステータスを指定された状態にするために必要なあらゆる操作を実行する責任があります。たとえば、呼び出し元がサブシステムのステータスとして VDS_SSS_OFFLINE を渡した場合、まずキャッシュをクリアする必要があるかもしれません。

IVdsSubSystem::QueryMaxLunCreateSize (vdshwprv.h) メソッドは、指定された LUN の種類とヒントを使用して作成できる LUN の最大サイズを返します。

このメソッドは、E_INVALIDARG や E_OUTOFMEMORY などの標準的な HRESULT 値、および VDS 固有の戻り値 を返すことがあります。また、HRESULT_FROM_WIN32 マクロを使用して変換された システムエラーコード を返すこともあります。エラーは VDS 自体、または使用中の基盤となる VDS プロバイダー から発生する可能性があります。返される可能性のある値には、以下のものが含まれます。