ホーム › Storage.VirtualDiskService › IVdsServiceIscsi

IVdsServiceIscsi

COM

📘 Microsoft Learn (日本語) · English

IID14fbe036-3ed7-4e10-90e9-a5ff991aff01継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ローカルのイニシエーターサービスと連携するためのメソッドを提供します。CHAPセキュリティ設定の構成や、ターゲットへのログインを行う機能を含みます。

メソッド 7

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

vtbl 3 HRESULT GetInitiatorName(LPWSTR* ppwszIscsiName)

ローカルのイニシエーターサービスのiSCSI名を返します。

ppwszIscsiName

LPWSTR*

out

文字列へのポインターのアドレスです。VDSはこの場所に、初期化された文字列へのポインターを格納します。呼び出し元は、 CoTaskMemFree関数を使用して文字列を解放する必要があります。

戻り値

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

戻り値	説明
S_OK	名前が正常に返されました。
E_POINTER	ppwszIscsiNameパラメーターが有効なポインターではありません。

vtbl 4 HRESULT QueryInitiatorAdapters(IEnumVdsObject** ppEnum)

イニシエーターのiSCSIイニシエーターアダプターを列挙するオブジェクトを返します。

ppEnum

IEnumVdsObject**

out

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

戻り値

戻り値	説明
S_OK	名前が正常に返されました。
E_POINTER	ppEnumパラメーターが有効なポインターではありません。

vtbl 5 HRESULT SetIpsecGroupPresharedKey(VDS_ISCSI_IPSEC_KEY* pIpsecKey)

サポートされていません。このメソッドは将来の使用のために予約されています。(IVdsServiceIscsi.SetIpsecGroupPresharedKey)

pIpsecKey

VDS_ISCSI_IPSEC_KEY*

将来の使用のために予約されています。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻り値	説明
VDS_E_NOT_SUPPORTED	このメソッドは、このリリースではサポートされていません。

vtbl 6 HRESULT SetAllIpsecTunnelAddresses(VDS_IPADDRESS* pTunnelAddress, VDS_IPADDRESS* pDestinationAddress)

サポートされていません。このメソッドは将来の使用のために予約されています。(IVdsServiceIscsi.SetAllIpsecTunnelAddresses)

pTunnelAddress	VDS_IPADDRESS*	in	将来の使用のために予約されています。
pDestinationAddress	VDS_IPADDRESS*	in	将来の使用のために予約されています。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻り値	説明
VDS_E_NOT_SUPPORTED	このメソッドは、このリリースではサポートされていません。

vtbl 7 HRESULT SetAllIpsecSecurity(GUID targetPortalId, ULONGLONG ullSecurityFlags, VDS_ISCSI_IPSEC_KEY* pIpsecKey)

サポートされていません。(IVdsServiceIscsi.SetAllIpsecSecurity)

targetPortalId	GUID	in	将来の使用のために予約されています。
ullSecurityFlags	ULONGLONG	in	将来の使用のために予約されています。
pIpsecKey	VDS_ISCSI_IPSEC_KEY*	in	将来の使用のために予約されています。

戻り値

このメソッドは、次のいずれかの値を返すことがあります。

戻り値	説明
VDS_E_NOT_SUPPORTED	このメソッドは、このリリースではサポートされていません。

vtbl 8 HRESULT SetInitiatorSharedSecret(VDS_ISCSI_SHARED_SECRET* pInitiatorSharedSecret, GUID targetId)

イニシエーターがターゲットを認証する相互CHAP認証で使用される、イニシエーターのCHAP共有シークレットを設定します。

pInitiatorSharedSecret	VDS_ISCSI_SHARED_SECRET*	in	共有シークレットを格納するVDS_ISCSI_SHARED_SECRET 構造体のアドレスです。pSharedSecretメンバーがNULLで、ulSharedSecretSizeが0の場合、SetInitiatorSharedSecretメソッドは既存のシークレットをすべてクリアします。このパラメーターがNULLで、targetId パラメーターがGUID_NULLでない場合、SetInitiatorSharedSecretはイニシエーターとターゲット間の関連付けをクリアします。
targetId	GUID	in	ターゲットのVDS_OBJECT_IDです。共有シークレットをターゲット固有にしない場合、このパラメーターは GUID_NULLに設定します。

戻り値

戻り値/値	説明
S_OK	共有シークレットが正常に設定されました。
VDS_E_INITIALIZED_FAILED 0x80042401L	VDSの初期化に失敗しました。アプリケーションがサービスの初期化完了前にこのメソッドを呼び出した場合、メソッドは初期化が完了するまでブロックされます。初期化が失敗すると、このエラーが返されます。
VDS_E_TARGET_SPECIFIC_NOT_SUPPORTED 0x80042706L	イニシエーターサービスは、ターゲット固有の共有シークレットの設定をサポートしていません。

解説(Remarks)

イニシエーターは、ターゲットごとに異なるCHAP共有シークレットの設定をサポートする場合があります。

イニシエーターがターゲット固有のシークレットをサポートするかどうかを、プログラムから判定する方法はありません。SetInitiatorSharedSecretの呼び出しがVDS_E_TARGET_SPECIFIC_NOT_SUPPORTEDを返した場合は、targetIdパラメーターをGUID_NULLに設定して、メソッドを再度呼び出してください。

Microsoft iSCSI Software Initiatorは、ターゲット固有のシークレットの設定をサポートしていません。

vtbl 9 HRESULT RememberTargetSharedSecret(GUID targetId, VDS_ISCSI_SHARED_SECRET* pTargetSharedSecret)

ターゲットのCHAP共有シークレットをイニシエーターサービスに伝えます。この共有シークレットは、ターゲットログイン時にターゲットがイニシエーターを認証する際に使用されます。

targetId	GUID	in	指定された共有シークレットを持つターゲットのVDS_OBJECT_IDです。このパラメーターは必須であり、GUID_NULLにすることはできません。
pTargetSharedSecret	VDS_ISCSI_SHARED_SECRET*	in	CHAP共有シークレットを格納するVDS_ISCSI_SHARED_SECRET構造体のアドレスです。

戻り値

戻り値/値	説明
S_OK	共有シークレットが正常に記憶されました。
VDS_E_INITIALIZED_FAILED 0x80042401L	VDSの初期化に失敗しました。アプリケーションがサービスの初期化完了前にこのメソッドを呼び出した場合、メソッドは初期化が完了するまでブロックされます。初期化が失敗すると、このエラーが返されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IVdsServiceIscsi "{14FBE036-3ED7-4E10-90E9-A5FF991AFF01}"
#usecom global IVdsServiceIscsi IID_IVdsServiceIscsi "{}"
#comfunc global IVdsServiceIscsi_GetInitiatorName            3 var
#comfunc global IVdsServiceIscsi_QueryInitiatorAdapters      4 sptr
#comfunc global IVdsServiceIscsi_SetIpsecGroupPresharedKey   5 var
#comfunc global IVdsServiceIscsi_SetAllIpsecTunnelAddresses  6 var,var
#comfunc global IVdsServiceIscsi_SetAllIpsecSecurity         7 int,int64,var
#comfunc global IVdsServiceIscsi_SetInitiatorSharedSecret    8 var,int
#comfunc global IVdsServiceIscsi_RememberTargetSharedSecret  9 int,var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IVdsServiceIscsi "{14FBE036-3ED7-4E10-90E9-A5FF991AFF01}"
#usecom global IVdsServiceIscsi IID_IVdsServiceIscsi "{}"
#comfunc global IVdsServiceIscsi_GetInitiatorName            3 sptr
#comfunc global IVdsServiceIscsi_QueryInitiatorAdapters      4 sptr
#comfunc global IVdsServiceIscsi_SetIpsecGroupPresharedKey   5 sptr
#comfunc global IVdsServiceIscsi_SetAllIpsecTunnelAddresses  6 sptr,sptr
#comfunc global IVdsServiceIscsi_SetAllIpsecSecurity         7 int,int64,sptr
#comfunc global IVdsServiceIscsi_SetInitiatorSharedSecret    8 sptr,int
#comfunc global IVdsServiceIscsi_RememberTargetSharedSecret  9 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。