ホーム › Storage.VirtualDiskService › IVdsIscsiTarget

IVdsIscsiTarget

COM

📘 Microsoft Learn (日本語) · English

IIDaa8f5055-83e5-4bcc-aa73-19851a36a849継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

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

メソッド 10

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetProperties(VDS_ISCSI_TARGET_PROP* pTargetProp)

IVdsIscsiTarget::GetProperties (vdshwprv.h) メソッドは、iSCSIターゲットのプロパティを返します。

pTargetProp

VDS_ISCSI_TARGET_PROP*

out

呼び出し元が割り当てた VDS_ISCSI_TARGET_PROP 構造体のアドレス。VDSは、この構造体の pwszIscsiName および pwszFriendlyName メンバーが指す文字列のためのメモリを割り当てます。呼び出し元は、CoTaskMemFree 関数を使用してこれらの文字列を解放する必要があります。

戻り値

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

リターンコード/値	説明
S_OK	プロパティが正常に返されました。
VDS_S_PROPERTIES_INCOMPLETE 0x00042715L	一部のプロパティは正常に取得されましたが、すべてではありません。デバイスの取り外しなど、すべてのプロパティの取得に失敗する原因は多数存在する点に注意してください。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ポータルオブジェクトは既に存在しません。

vtbl 4 HRESULT GetSubSystem(IVdsSubSystem** ppSubSystem)

IVdsIscsiTarget::GetSubSystem (vdshwprv.h) メソッドは、ターゲットが属するサブシステムを返します。

ppSubSystem

IVdsSubSystem**

out

IVdsSubSystem インターフェースポインターのアドレス。VDSは戻り時にインターフェースを初期化します。呼び出し元はインターフェースを解放する必要があります。

戻り値

リターンコード/値	説明
S_OK	サブシステムオブジェクトが正常に返されました。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。

vtbl 5 HRESULT QueryPortalGroups(IEnumVdsObject** ppEnum)

IVdsIscsiTarget::QueryPortalGroups (vdshwprv.h) メソッドは、ターゲット内のiSCSIポータルグループの列挙を返します。

ppEnum

IEnumVdsObject**

out

ポータルグループをポータルグループオブジェクトとして列挙するために使用できる IEnumVdsObject インターフェースポインターのアドレス。詳細については、列挙オブジェクトの操作を参照してください。呼び出し元は、不要になったら IUnknown::Release メソッドを呼び出して、インターフェースおよび各ポータルグループオブジェクトを解放する必要があります。

戻り値

リターンコード/値	説明
S_OK	ポータルグループの列挙が正常に返されました。ターゲットにポータルグループが存在しない場合、列挙は空になります。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。

vtbl 6 HRESULT QueryAssociatedLuns(IEnumVdsObject** ppEnum)

IVdsIscsiTarget::QueryAssociatedLuns (vdshwprv.h) メソッドは、ターゲットに関連付けられているLUNの列挙を返します。

ppEnum

IEnumVdsObject**

out

LUNを LUNオブジェクトとして列挙するために使用できる IEnumVdsObject インターフェースポインターのアドレス。詳細については、列挙オブジェクトの操作を参照してください。呼び出し元は、不要になったら IUnknown::Release メソッドを呼び出して、インターフェースおよび各LUNオブジェクトを解放する必要があります。

戻り値

リターンコード/値	説明
S_OK	関連付けられたLUNの列挙が正常に返されました。ターゲットに関連付けられたLUNが存在しない場合、列挙は空になります。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。

解説(Remarks)

LUNは、IVdsLunIscsi::AssociateTargets メソッドを呼び出すことでターゲットに関連付けられます。

vtbl 7 HRESULT CreatePortalGroup(IVdsAsync** ppAsync)

IVdsIscsiTarget::CreatePortalGroup (vdshwprv.h) メソッドは、ポータルグループを作成します。新しいポータルグループオブジェクトのインターフェースポインターを取得できます。

ppAsync

IVdsAsync**

out

IVdsAsync インターフェースポインターのアドレス。VDSは戻り時にこれを初期化します。呼び出し元はインターフェースを解放する必要があります。このインターフェースを使用して、操作のキャンセル、完了待機、または状態の照会を行います。このインターフェースで IVdsAsync::Wait メソッドを呼び出して成功の HRESULT 値が返された場合は、各インターフェースポインターに対して IUnknown::Release メソッドを呼び出し、VDS_ASYNC_OUTPUT 構造体で返されたインターフェースを解放する必要があります。ただし、Wait が失敗の HRESULT 値を返した場合、または Wait の pHrResult パラメーターが失敗の HRESULT 値を受け取った場合、VDS_ASYNC_OUTPUT 構造体内のインターフェースポインターは NULL であり、解放する必要はありません。成功または失敗の HRESULT 値は、Winerror.h で定義されている SUCCEEDED および FAILED マクロを使用してテストできます。

戻り値

リターンコード/値	説明
S_OK	ポータルグループが正常に作成されました。
VDS_S_ALREADY_EXISTS 0x00042714L	これ以上ポータルグループを作成できません。CreatePortalGroup メソッドは新しいポータルグループを作成しませんでした。ppAsync パラメーターで返されたインターフェースポインターに対して IVdsAsync::Wait メソッドを呼び出すと、既存のポータルグループオブジェクトが取得されます。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。

vtbl 8 HRESULT Delete(IVdsAsync** ppAsync)

IVdsIscsiTarget::Delete (vdshwprv.h) メソッドは、ターゲットにLUNが関連付けられていない場合に、ターゲットとそのすべてのポータルグループを削除します。

ppAsync

IVdsAsync**

out

戻り値

リターンコード/値	説明
S_OK	ポータルグループが正常に作成されました。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。
VDS_E_ASSOCIATED_LUNS_EXIST 0x8004270BL	このターゲットにLUNが関連付けられています。このターゲットを削除する前に、すべてのLUNをこのターゲットから関連付け解除する必要があります。

vtbl 9 HRESULT SetFriendlyName(LPWSTR pwszFriendlyName)

IVdsIscsiTarget::SetFriendlyName (vdshwprv.h) メソッドは、ターゲットのフレンドリ名を設定します。

pwszFriendlyName

LPWSTR

ターゲットに割り当てるフレンドリ名を指定する文字列。これはiSCSIエイリアスに対応します。

戻り値

リターンコード/値	説明
S_OK	フレンドリ名が正常に設定されました。
VDS_S_NAME_TRUNCATED 0x00042700L	名前は正常に設定されましたが、サブシステムの制限により切り詰める必要がありました。設定された名前は、pwszFriendlyName パラメーターで渡された名前と一致しない場合があります。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。
VDS_E_NOT_SUPPORTED 0x80042400L	この操作またはパラメーターの組み合わせは、このプロバイダーではサポートされていません。

vtbl 10 HRESULT SetSharedSecret(VDS_ISCSI_SHARED_SECRET* pTargetSharedSecret, LPWSTR pwszInitiatorName)

IVdsIscsiTarget::SetSharedSecret メソッドは、ターゲットがイニシエーターを認証する際のCHAP認証で使用される、ターゲットのCHAP共有シークレットを設定します。

pTargetSharedSecret	VDS_ISCSI_SHARED_SECRET*	in	共有シークレットを含む VDS_ISCSI_SHARED_SECRET 構造体のアドレス。pSharedSecret メンバーが NULL で、かつ ulSharedSecretSize が0の場合、SetSharedSecret メソッドは既存のシークレットをクリアします。
pwszInitiatorName	LPWSTR	in	シークレットがイニシエーター固有の場合に、共有シークレットを関連付けるiSCSI名を指定する文字列。渡された値はCHAP名として使用されます。アドレスが NULL の場合、変更はすべてのイニシエーターの既定のシークレットに適用されます。

戻り値

リターンコード/値	説明
S_OK	共有シークレットが正常に設定されました。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。
VDS_E_NOT_SUPPORTED 0x80042400L	この操作またはパラメーターの組み合わせは、このプロバイダーではサポートされていません。
VDS_E_INITIATOR_SPECIFIC_NOT_SUPPORTED 0x80042707L	このターゲットはイニシエーター固有の共有シークレットをサポートしていません。

解説(Remarks)

ハードウェアプロバイダーは、ターゲットの共有シークレットを変更するために、サブシステム自体を構成する必要があります。セキュリティのために使用されるシークレットは、VDSによって永続化されず、またローカルコンピューター上のハードウェアプロバイダーによっても永続化されるべきではありません。ハードウェアプロバイダーは、シークレットを安全な方法でサブシステムに送信する必要があり、その永続化はサブシステムが担当します。

一部のiSCSIターゲットは、イニシエーターごとに異なるCHAP共有シークレットを設定することをサポートしている場合があります。ターゲットがイニシエーター固有のシークレットをサポートしていない場合、SetSharedSecret の呼び出しは VDS_E_INITIATOR_SPECIFIC_NOT_SUPPORTED を返します。

vtbl 11 HRESULT RememberInitiatorSharedSecret(LPWSTR pwszInitiatorName, VDS_ISCSI_SHARED_SECRET* pInitiatorSharedSecret)

IVdsIscsiTarget::RememberInitiatorSharedSecret (vdshwprv.h) メソッドは、相互CHAP認証で使用されるイニシエーターのCHAPシークレットを伝達します。

pwszInitiatorName	LPWSTR	in	イニシエーターのiSCSI名を指定する文字列。このパラメーターは必須であり、NULL にすることはできません。
pInitiatorSharedSecret	VDS_ISCSI_SHARED_SECRET*	in	共有シークレットを含む VDS_ISCSI_SHARED_SECRET 構造体のアドレス。

戻り値

リターンコード/値	説明
S_OK	共有シークレットが正常に記憶されました。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。
VDS_E_NOT_SUPPORTED 0x80042400L	この操作またはパラメーターの組み合わせは、このプロバイダーではサポートされていません。

vtbl 12 HRESULT GetConnectedInitiators(LPWSTR** pppwszInitiatorList, INT* plNumberOfInitiators)

IVdsIscsiTarget::GetConnectedInitiators (vdshwprv.h) メソッドは、現在ターゲットにログインしているイニシエーターのiSCSI名のリストを返します。

pppwszInitiatorList	LPWSTR**	out	現在ターゲットにログインしているイニシエーターのiSCSI名を含む文字列の配列を受け取る変数のアドレス。呼び出し元は、CoTaskMemFree 関数を使用して、この配列内の各文字列および配列自体を解放する必要があります。
plNumberOfInitiators	INT*	out	pppwszInitiatorList で返される文字列の数へのポインター。

戻り値

リターンコード/値	説明
S_OK	接続されているイニシエーターのリストが正常に返されました。
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	別の操作が進行中です。この操作は、先行する操作が完了するまで続行できません。
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	プロバイダーのキャッシュが破損しています。これは、接続されているデバイスに関する情報をキャッシュするプロバイダー内部のソフトウェアまたは通信の問題を示します。呼び出し元は、IVdsHwProvider::Reenumerate メソッドに続いて IVdsHwProvider::Refresh メソッドを使用することで、キャッシュを復元できます。
VDS_E_OBJECT_DELETED 0x8004240BL	ターゲットオブジェクトは既に存在しません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IVdsIscsiTarget "{AA8F5055-83E5-4BCC-AA73-19851A36A849}"
#usecom global IVdsIscsiTarget IID_IVdsIscsiTarget "{}"
#comfunc global IVdsIscsiTarget_GetProperties                  3 var
#comfunc global IVdsIscsiTarget_GetSubSystem                   4 sptr
#comfunc global IVdsIscsiTarget_QueryPortalGroups              5 sptr
#comfunc global IVdsIscsiTarget_QueryAssociatedLuns            6 sptr
#comfunc global IVdsIscsiTarget_CreatePortalGroup              7 sptr
#comfunc global IVdsIscsiTarget_Delete                         8 sptr
#comfunc global IVdsIscsiTarget_SetFriendlyName                9 wstr
#comfunc global IVdsIscsiTarget_SetSharedSecret                10 var,wstr
#comfunc global IVdsIscsiTarget_RememberInitiatorSharedSecret  11 wstr,var
#comfunc global IVdsIscsiTarget_GetConnectedInitiators         12 var,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVdsIscsiTarget "{AA8F5055-83E5-4BCC-AA73-19851A36A849}"
#usecom global IVdsIscsiTarget IID_IVdsIscsiTarget "{}"
#comfunc global IVdsIscsiTarget_GetProperties                  3 sptr
#comfunc global IVdsIscsiTarget_GetSubSystem                   4 sptr
#comfunc global IVdsIscsiTarget_QueryPortalGroups              5 sptr
#comfunc global IVdsIscsiTarget_QueryAssociatedLuns            6 sptr
#comfunc global IVdsIscsiTarget_CreatePortalGroup              7 sptr
#comfunc global IVdsIscsiTarget_Delete                         8 sptr
#comfunc global IVdsIscsiTarget_SetFriendlyName                9 wstr
#comfunc global IVdsIscsiTarget_SetSharedSecret                10 sptr,wstr
#comfunc global IVdsIscsiTarget_RememberInitiatorSharedSecret  11 wstr,sptr
#comfunc global IVdsIscsiTarget_GetConnectedInitiators         12 sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。