Win32 API 日本語リファレンス
ホーム › Storage.IscsiDisc › ISCSI_LOGIN_OPTIONS

ISCSI_LOGIN_OPTIONS

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 64 バイト / x86: 52 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールド型サイズx64x86説明
VersionDWORD4+0+0構造体内のデータを定義するログインオプション定義のバージョンです。このメンバーには ISCSI_LOGIN_OPTIONS_VERSION 0 を設定しなければなりません。
InformationSpecifiedDWORD4+4+4

ISCSI_LOGIN_OPTIONS 構造体のどの部分に有効なデータが格納されているかを示すビットマップです。

ビット 意味
ISCSI_LOGIN_OPTIONS_USERNAME
 ログイン接続の確立に使用するユーザー名を指定します。
ISCSI_LOGIN_OPTIONS_PASSWORD
 ログイン接続の確立に使用するパスワードを指定します。
ISCSI_LOGIN_OPTIONS_HEADER_DIGEST
 ヘッダーデータの整合性を保証するために使用するダイジェストの種類を指定します。
ISCSI_LOGIN_OPTIONS_DATA_DIGEST
 ヘッダーデータの整合性を保証するために使用するダイジェストの種類を指定します。
ISCSI_LOGIN_OPTIONS_MAXIMUM_CONNECTIONS
 ログインセッションに関連付けられるターゲットデバイスへの接続の最大数を指定します。
ISCSI_LOGIN_OPTIONS_DEFAULT_TIME_2_WAIT
 切断された接続の再接続または再割り当てを試みるまでに待機する最小時間を秒単位で指定します。
ISCSI_LOGIN_OPTIONS_DEFAULT_TIME_2_RETAIN
 DefaultTime2Wait で示される最初の待機の後、コマンドの再割り当てに許可される最大時間を指定します。
ISCSI_LOGIN_OPTIONS_AUTH_TYPE
 ログインセッションを確立する認証の種類を指定します。
LoginFlagsDWORD4+8+8

ログインセッションの特定の特性を定義するログインフラグのビット単位の OR です。次の表は、このメンバーに設定できる値を示しています。

フラグ 意味
ISCSI_LOGIN_FLAG_RESERVED1
 内部使用のために予約済みです。
ISCSI_LOGIN_FLAG_ALLOW_PORTAL_HOPPING
 RADIUS サーバーは、そのように構成されている場合、ターゲットに対してポートホッピング機能を使用できます。
ISCSI_LOGIN_FLAG_REQUIRE_IPSEC
 ログインセッションは IPsec プロトコルを使用しなければなりません。
ISCSI_LOGIN_FLAG_MULTIPATH_ENABLED
 マルチパスが許可されます。指定した場合、iSCSI Initiator サービスは同じターゲットへの複数のセッションを許可します。同じターゲットへのセッションが複数存在する場合は、何らかのマルチパスソフトウェアがインストールされている必要があります。そうでない場合、ターゲット上でデータの破損が発生します。
AuthTypeISCSI_AUTH_TYPES4+12+12認証の種類を示す ISCSI_AUTH_TYPES 型の列挙値です。
HeaderDigestISCSI_DIGEST_TYPES4+16+16ヘッダーデータの整合性を保証するためのダイジェストの種類を示す ISCSI_DIGEST_TYPES 型の列挙値です。
DataDigestISCSI_DIGEST_TYPES4+20+20ヘッダー以外のデータの整合性を保証するためのダイジェストの種類を示す ISCSI_DIGEST_TYPES 型の列挙値です。
MaximumConnectionsDWORD4+24+24ログインセッションに関連付けることができる、ターゲットデバイスへの接続の最大数を指定する 1 から 65535 までの値です。
DefaultTime2WaitDWORD4+28+28切断された接続の再接続または再割り当てを試みるまでに待機する最小時間 (秒単位) です。
DefaultTime2RetainDWORD4+32+32DefaultTime2Wait で示される最初の待機時間が経過した後、接続の再割り当てに許可される最大時間です。
UsernameLengthDWORD4+36+36Username メンバーで指定されたユーザー名の長さ (バイト単位) です。
PasswordLengthDWORD4+40+40Password メンバーで指定されたユーザー名の長さ (バイト単位) です。
UsernameBYTE*8/4+48+44ログインセッションを確立するために認証に使用するユーザー名です。この値は必ずしも文字列であるとは限りません。詳細については、このドキュメントの「解説」セクションを参照してください。
PasswordBYTE*8/4+56+48ログインセッションを確立するために認証に使用するユーザー名です。この値は必ずしも文字列であるとは限りません。詳細については、このドキュメントの「解説」セクションを参照してください。

公式ドキュメント

ISCSI_LOGIN_OPTIONS 構造体は、イニシエーターがログインセッションの特性を指定するために使用します。

解説(Remarks)

イニシエーターは、LoginIScsiTarget ルーチンでログインセッションを作成するときに ISCSI_LOGIN_OPTIONS 構造体を使用します。

Username メンバーと Password メンバーは、iSCSI 認証に使用される文字列またはバイナリ値です。これら 2 つの値の正確な意味と機能は、使用される認証の種類によって異なります。チャレンジハンドシェイク認証プロトコル (CHAP) の場合、Username メンバーの値は CHAP 名であり、Password メンバーの値はターゲットの共有シークレットです。Username に値が指定されていない場合は、イニシエーターのノード名が CHAP 名として使用されます。

認証プロトコルがこれら 2 つの値を文字列にすることを要求する場合、それらは ANSI 文字列でなければなりません。

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

各言語での定義

#include <windows.h>

// ISCSI_LOGIN_OPTIONS  (x64 64 / x86 52 バイト)
typedef struct ISCSI_LOGIN_OPTIONS {
    DWORD Version;
    DWORD InformationSpecified;
    DWORD LoginFlags;
    ISCSI_AUTH_TYPES AuthType;
    ISCSI_DIGEST_TYPES HeaderDigest;
    ISCSI_DIGEST_TYPES DataDigest;
    DWORD MaximumConnections;
    DWORD DefaultTime2Wait;
    DWORD DefaultTime2Retain;
    DWORD UsernameLength;
    DWORD PasswordLength;
    BYTE* Username;
    BYTE* Password;
} ISCSI_LOGIN_OPTIONS;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct ISCSI_LOGIN_OPTIONS
{
    public uint Version;
    public uint InformationSpecified;
    public uint LoginFlags;
    public int AuthType;
    public int HeaderDigest;
    public int DataDigest;
    public uint MaximumConnections;
    public uint DefaultTime2Wait;
    public uint DefaultTime2Retain;
    public uint UsernameLength;
    public uint PasswordLength;
    public IntPtr Username;
    public IntPtr Password;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure ISCSI_LOGIN_OPTIONS
    Public Version As UInteger
    Public InformationSpecified As UInteger
    Public LoginFlags As UInteger
    Public AuthType As Integer
    Public HeaderDigest As Integer
    Public DataDigest As Integer
    Public MaximumConnections As UInteger
    Public DefaultTime2Wait As UInteger
    Public DefaultTime2Retain As UInteger
    Public UsernameLength As UInteger
    Public PasswordLength As UInteger
    Public Username As IntPtr
    Public Password As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class ISCSI_LOGIN_OPTIONS(ctypes.Structure):
    _fields_ = [
        ("Version", wintypes.DWORD),
        ("InformationSpecified", wintypes.DWORD),
        ("LoginFlags", wintypes.DWORD),
        ("AuthType", ctypes.c_int),
        ("HeaderDigest", ctypes.c_int),
        ("DataDigest", ctypes.c_int),
        ("MaximumConnections", wintypes.DWORD),
        ("DefaultTime2Wait", wintypes.DWORD),
        ("DefaultTime2Retain", wintypes.DWORD),
        ("UsernameLength", wintypes.DWORD),
        ("PasswordLength", wintypes.DWORD),
        ("Username", ctypes.c_void_p),
        ("Password", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct ISCSI_LOGIN_OPTIONS {
    pub Version: u32,
    pub InformationSpecified: u32,
    pub LoginFlags: u32,
    pub AuthType: i32,
    pub HeaderDigest: i32,
    pub DataDigest: i32,
    pub MaximumConnections: u32,
    pub DefaultTime2Wait: u32,
    pub DefaultTime2Retain: u32,
    pub UsernameLength: u32,
    pub PasswordLength: u32,
    pub Username: *mut core::ffi::c_void,
    pub Password: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type ISCSI_LOGIN_OPTIONS struct {
	Version uint32
	InformationSpecified uint32
	LoginFlags uint32
	AuthType int32
	HeaderDigest int32
	DataDigest int32
	MaximumConnections uint32
	DefaultTime2Wait uint32
	DefaultTime2Retain uint32
	UsernameLength uint32
	PasswordLength uint32
	Username uintptr
	Password uintptr
}
type
  ISCSI_LOGIN_OPTIONS = record
    Version: DWORD;
    InformationSpecified: DWORD;
    LoginFlags: DWORD;
    AuthType: Integer;
    HeaderDigest: Integer;
    DataDigest: Integer;
    MaximumConnections: DWORD;
    DefaultTime2Wait: DWORD;
    DefaultTime2Retain: DWORD;
    UsernameLength: DWORD;
    PasswordLength: DWORD;
    Username: Pointer;
    Password: Pointer;
  end;
const ISCSI_LOGIN_OPTIONS = extern struct {
    Version: u32,
    InformationSpecified: u32,
    LoginFlags: u32,
    AuthType: i32,
    HeaderDigest: i32,
    DataDigest: i32,
    MaximumConnections: u32,
    DefaultTime2Wait: u32,
    DefaultTime2Retain: u32,
    UsernameLength: u32,
    PasswordLength: u32,
    Username: ?*anyopaque,
    Password: ?*anyopaque,
};
type
  ISCSI_LOGIN_OPTIONS {.bycopy.} = object
    Version: uint32
    InformationSpecified: uint32
    LoginFlags: uint32
    AuthType: int32
    HeaderDigest: int32
    DataDigest: int32
    MaximumConnections: uint32
    DefaultTime2Wait: uint32
    DefaultTime2Retain: uint32
    UsernameLength: uint32
    PasswordLength: uint32
    Username: pointer
    Password: pointer
struct ISCSI_LOGIN_OPTIONS
{
    uint Version;
    uint InformationSpecified;
    uint LoginFlags;
    int AuthType;
    int HeaderDigest;
    int DataDigest;
    uint MaximumConnections;
    uint DefaultTime2Wait;
    uint DefaultTime2Retain;
    uint UsernameLength;
    uint PasswordLength;
    void* Username;
    void* Password;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; ISCSI_LOGIN_OPTIONS サイズ: 52 バイト(x86)
dim st, 13    ; 4byte整数×13(構造体サイズ 52 / 4 切り上げ)
; Version : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; InformationSpecified : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; LoginFlags : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; AuthType : ISCSI_AUTH_TYPES (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; HeaderDigest : ISCSI_DIGEST_TYPES (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; DataDigest : ISCSI_DIGEST_TYPES (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; MaximumConnections : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; DefaultTime2Wait : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; DefaultTime2Retain : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; UsernameLength : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; PasswordLength : DWORD (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; Username : BYTE* (+44, 4byte)  st.11 = 値  /  値 = st.11   (lpoke/lpeek も可)
; Password : BYTE* (+48, 4byte)  st.12 = 値  /  値 = st.12   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; ISCSI_LOGIN_OPTIONS サイズ: 64 バイト(x64)
dim st, 16    ; 4byte整数×16(構造体サイズ 64 / 4 切り上げ)
; Version : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; InformationSpecified : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; LoginFlags : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; AuthType : ISCSI_AUTH_TYPES (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; HeaderDigest : ISCSI_DIGEST_TYPES (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; DataDigest : ISCSI_DIGEST_TYPES (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; MaximumConnections : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; DefaultTime2Wait : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; DefaultTime2Retain : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; UsernameLength : DWORD (+36, 4byte)  st.9 = 値  /  値 = st.9   (lpoke/lpeek も可)
; PasswordLength : DWORD (+40, 4byte)  st.10 = 値  /  値 = st.10   (lpoke/lpeek も可)
; Username : BYTE* (+48, 8byte)  qpoke st,48,値 / qpeek(st,48)  ※IronHSPのみ。3.7/3.8は lpoke st,48,下位 : lpoke st,52,上位
; Password : BYTE* (+56, 8byte)  qpoke st,56,値 / qpeek(st,56)  ※IronHSPのみ。3.7/3.8は lpoke st,56,下位 : lpoke st,60,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global ISCSI_LOGIN_OPTIONS
    #field int Version
    #field int InformationSpecified
    #field int LoginFlags
    #field int AuthType
    #field int HeaderDigest
    #field int DataDigest
    #field int MaximumConnections
    #field int DefaultTime2Wait
    #field int DefaultTime2Retain
    #field int UsernameLength
    #field int PasswordLength
    #field intptr Username
    #field intptr Password
#endstruct

stdim st, ISCSI_LOGIN_OPTIONS        ; NSTRUCT 変数を確保
st->Version = 100
mes "Version=" + st->Version