iscsiadm(8)
iscsiadm(8)
名称iscsiadm - 允许管理 iSCSI 启动器
用法概要
iscsiadm subcommand direct-object [options] [operand]
描述
iscsiadm 命令允许在主机上管理 iSCSI (Internet SCSI) 启动器。iscsiadm 作为一组子命令实现，许多子命令都具有其自己的选项，并在其各自的部分中进行说明。“选项”部分介绍了不与特定子命令关联的选项。
仅当下列服务处于联机状态时，iscsiadm 才会运行：
svc:/network/iscsi/initiator:default
iscsiadm 命令支持下列子命令，下面的小节中详细介绍了这些子命令：
add
向对象添加元素。
list
列出对象的元素。
modify
修改对象的属性。
remove
删除对象的元素。
iscsiadm 子命令基于 direct-object 运行。各个子命令的相应部分中分别对这些子命令进行了说明。
iscsiadm 命令支持 Internet 存储名称服务 (Internet Storage Name Service, iSNS) 以便搜索 iSCSI 目标。此命令支持质询握手身份验证协议 (Challenge Handshake Authentication Protocol, CHAP) 以便进行身份验证。
add 子命令
add 子命令的语法如下：
# iscsiadm add direct_object [operands...]
add 子命令添加下列 direct_object：
discovery-address discovery-address [...]
向搜索地址列表添加目标。搜索地址（如在下面所示的语法中）是在 SendTargets 搜索会话中使用的 IP address:port 组合。通过使用此搜索方法，目标设备可告知启动器由该设备公开的各个目标的目标地址和目标名称。除非已在主机上启用搜索的 SendTargets 方法，否则不会尝试连接到目标。应使用 modify 子命令启用此方法。
discovery-address 参数的格式如下：
如果未指定 port，则将使用缺省值 3260。
isns-server isns-server [...]
向 iSNS 服务器地址列表添加 iSNS 服务器。iSNS 服务器地址（在下面所示的语法中指定）是在 iSNS 搜索会话中使用的 IP 地址-端口组合。通过使用 iSNS 搜索，iSNS 服务器可以向启动器提供有关门户以及与该启动器隶属于同一搜索域中的各个目标的名称的信息。除非已在主机上启用搜索的 iSNS 方法，否则不会尝试连接到 iSNS 服务器。应使用 modify 子命令启用此方法，如下所述。
isns-server 参数的格式如下：
IP_address[:port]
如果未指定端口，则将使用缺省值 3205。
static-config static_target [...]
向静态配置目标的列表添加目标。除非已启用搜索的静态配置方法，否则不会尝试连接到目标。
static_target 参数的格式如下：
list 子命令
list 子命令的语法如下：
# iscsiadm list direct-object [options]
list 子命令显示下列 direct-object 的数据：
discovery
列出搜索方法及其当前激活状态（即启用或禁用）。搜索方法如下所示：
iSNS（Internet Storage Name Service，Internet 存储名称服务）
静态
SendTargets
initiator-node
列出主机上的启动器节点的信息。iSCSI 启动器节点表示逻辑 HBA，它是 iSCSI 目标的逻辑主机连接点。响应中列出的参数值是启动器的缺省参数设置。启动器的每个连接目标都具有不同于启动器节点上的参数值的参数值。
static-config [static_target[, ...]]
列出指定目标的目标名称和地址，或者如果未指定静态目标，则列出所有静态搜索目标。
target [–S] [–v] [target[, ...]]
列出目标的当前参数、连接状态以及用于目标搜索的方法。报告指定目标的信息，或者如果未指定目标，则列出搜索到的所有目标或已使用 modify target 子命令修改其参数的所有目标。
当与指定目标的 –S 选项配合使用时，此子命令将返回：
目标名称
逻辑单元号
供应商 ID
产品 ID
OS 设备名称（例如，/dev/rdsk/c0t2d0s0）
–v 选项提供了更多详细信息，例如，当前登录参数、详细连接信息以及用于搜索目标的搜索方法。
返回 NA 作为搜索方法参数表示目标是使用 iscsiadm modify target-param 命令创建的，并且不会作为搜索目标存在。要删除此类目标，请使用 iscsiadm remove target-param。
登录过程中会从目标端返回 Max Receive Data Segment Length（数据段最大接收长度）。该值只能在目标端设置，且不受协商影响。将 PDU 传送到目标端时，启动器端会观测到该显示值。
target-param [–v] target [...]
列出目标的缺省参数和用户定义参数。输出采用 Default/Configured 格式。Default 代表此参数的缺省值，Configured 代表此参数的配置值。
例如，“数据段最大接收长度”显示 8192/65536，这表示向启动器端传送 PDU 时目标将观测到所配置的上限 65536。
discovery-address [–v] [discovery-address[, ...]]
列出使用 iscsiadm add discovery-address 子命令添加的 discovery-address 对象。
当与 –v 选项配合使用时，列出位于指定 discovery-address 的所有已知目标。–v 选项返回一个或多个目标名称、零个或多个目标地址以及关联的目标门户组标记 (target portal group tag, TPGT)（如果适用）。
isns-server [–v] [isns-server[, ...]]
列出使用 iscsiadm add isns-server 子命令添加的 isns-server 对象。
当与 –v 选项配合使用时，此子命令列出位于指定 isns-server 地址的所有已知目标。–v 选项返回一个或多个目标名称、零个或多个目标地址以及关联的目标门户组标记 (target portal group tag, TPGT)（如果适用）。
modify 子命令
modify 子命令的语法如下：
# iscsiadm modify direct_object [options]
modify 子命令支持下列 direct_object：
discovery [options]
启用搜索方法可使用此方法启动搜索。禁用当前已启用的搜索方法不会影响使用该方法已搜索到的任何目标的连接。
modify discovery 的选项如下所示：
–i, –iSNS enable | disable
启用或禁用 iSNS 搜索。
–s, ––static enable | disable
启用或禁用静态搜索。
–t, ––sendtargets enable | disable
启用或禁用 SendTargets 搜索。
initiator-node [options]
修改启动器的属性。如果当前已连接目标，此操作即可成功。但是，在现有连接会话不再存在并且已建立新连接之前，修改后的参数集对此目标将不会生效。选项 –C 和 ––CHAP-secret 在响应提示时需要输入 CHAP 密钥。
要在禁用 Solaris I/O 多路径功能（以前称为 Sun StorEdge Traffic Manager [STMS] 或 MPxIO）时进行 iSCSI 引导，您可以仅修改下列启动器节点选项：
–r, –-radius-server
–R, –-radius-access
–P, –-radius-shared-secret
要在启用 Solaris I/O 多路径功能时进行 iSCSI 引导，您可以仅修改下列启动器节点选项：
–h, –-headerdigest
–d, –-datadigest
–c, –-configured-sessions
modify initiator-node 的选项如下所示：
–A, ––node-alias
修改启动器节点别名。最大长度为 223 个字符。
–a, ––authentication chap | none
设置身份验证模式。
–C, ––CHAP-secret
设置 CHAP 密钥值。没有缺省值。最大长度为 16 个字符；最小必需长度为 12 个字符。
–c, –-configured-sessions
设置将为每个 iSCSI 目标创建的已配置 iSCSI 会话的数目。This setting will be applied to all iSCSI Targets.If IP addresses are used then you must supply one or more local IP addresses in a comma-separated list.每个 IP 地址都表示一个 iSCSI 会话。TCP connections associated with the session will bind to the particular local IP address.Binding multiple local addresses is a preferred configuration when used with IPMP.
–d, –-datadigest none | CRC32
设置是否启用 CRC32 以便检查 SCSI 数据传送。
–H, ––CHAP-name CHAP name
指定 CHAP 用户名。如果未使用此选项，则会在初始化时将 CHAP 名称设置为启动器节点名称。将身份验证方法设置为 CHAP（请参见上面的 –a/––authentication 选项）时，使用命令 iscsiadm list initiator-node 可显示 CHAP 用户名。
–h, –-headerdigest none | CRC32
设置是否启用 CRC32 以便检查 SCSI 包标头。
–m, –-max-connections number_connections
修改 iSCSI 会话的最大连接数。缺省值为 1。各个会话的最大连接数为 65535。
–N, ––node-name
修改启动器节点名称。最多包含 223 个字符。
注 - 安装 Solaris 时，启动器节点名称设置为全局唯一值。更改此值可能会对 iSCSI 网络中的操作产生负面影响。
–P, –-radius-shared-secret (exclusive)
设置 RADIUS 共享密钥。
–R, –-radius-access enable | disable
设置是否将使用 RADIUS 服务器。
–r, –-radius-server
设置要使用的 radius 服务器的 IP 地址和端口。
–T, ––tunable-param <
指定启动器节点连接的所有目标的一个或多个可调参数。
注 - 只有明确此参数在 iSCSI 网络中的影响的管理员才能修改这些值。
支持的 tunable-prop 选项包括：
recv-login-rsp-timeout
会话登录响应时间
recv-login-rsp-timeout 选项指定 iSCSI 启动器将等待来自 iSCSI 目标的 iSCSI 会话登录请求响应的时间。有效值介于 0 至 60*60 之间，缺省值为 60 秒。
conn-login-max
最长连接重试时间
如果在给定时间段内发生 IO 超时或连接故障，conn-login-max 选项允许 iSCSI 启动器重新建立到目标的连接。有效值为 0 到 60*60。缺省值为 180 秒。
polling-login-delay
登录重试时间间隔
polling-login-delay 选项指定在 iSCSI 启动器定位 IO 超时或连接故障时每次重试登录的时间间隔。有效值为 0 到 60*60。缺省值为 60 秒。
target-param [options] target
修改目标的参数。如果当前已连接目标，修改操作将成功，即使修改后的设置可能不会在几秒后生效也是如此。要确认这些设置是否处于活动状态，请使用 iscsiadm list target –v。如果指定目标不与任何搜索方法相关联，则会使用指定参数创建目标对象。使用此命令修改目标参数之后，将保存新参数，直到在此目标上使用 iscsiadm remove target-param 命令修改或删除这些参数为止。选项 –C 和 ––CHAP-secret 在响应提示时需要输入 CHAP 密钥。
modify target-param 的选项如下所示：
–B, ––bi-directional-authentication enable | disable
设置双向选项。如果设置为 enable，启动器将对指定目标执行双向身份验证。
–C, ––CHAP-secret
设置目标的 CHAP 密钥值。没有缺省值。最大可接受长度为 16 个字符。
–c, ––configured-sessions
设置将为每个 iSCSI 目标创建的已配置 iSCSI 会话的数目。If IP addresses are used then you must supply one or more local IP addresses in a comma-separated list.每个 IP 地址都表示一个 iSCSI 会话。TCP connections associated with the session will bind to the particular local IP address.Binding multiple local addresses is a preferred configuration when used with IPMP.
–d, ––datadigest none | CRC32
设置是为数据启用还是禁用 CRC32。
–H, ––CHAP-name CHAP name
设置 CHAP 用户名。如果未使用此选项，则会在初始化时将 CHAP 名称设置为目标名称。将身份验证方法设置为 CHAP（请参见上面的 initiator-node 直接对象下的 –a/––authentication 选项）时，使用命令 iscsiadm list initiator-node 可显示 CHAP 用户名。
–h, ––headerdigest none | CRC32
设置是为头启用还是禁用 CRC32。
–p, ––login-param
指定一个或多个登录参数设置。
注 - 只有明确此参数在 iSCSI 网络中的影响的管理员才能修改这些值。
登录参数派生自 iSCSI 建议的标准 RFC 3720。有效值包括：
dataseqinorder
yes 或 no
defaulttime2retain
0–3600
defaulttime2wait
0–3600
firstburstlength
512 至 224–1
immediatedata
yes 或 no
initialr2t
yes 或 no
maxburstlength
512 至 224–1
datapduinorder
yes 或 no
maxoutstandingr2t
1 - 65535
maxrecvdataseglen
512 至 224–1
启动器可以通过此选项设置来设置自己的 maxrecvdatasegmentlen。在登录过程中，启动器端向目标发送此参数以声明其数据段最大接收长度。此参数设置可以通过 iscsiadm list target-param -v target 命令显示。
–T, ––tunable-param <
指定启动器节点连接的所有目标的一个或多个可调参数。
注 - 只有明确此参数在 iSCSI 网络中的影响的管理员才能修改可调参数值。
支持的 tunable-prop 选项包括：
recv-login-rsp-timeout
会话登录响应时间
recv-login-rsp-timeout 选项指定 iSCSI 启动器将等待来自 iSCSI 目标的 iSCSI 会话登录请求响应的时间。有效值为 0 到 60*60。缺省值为 60 秒。
conn-login-max
最长连接重试时间
如果在给定时间段内发生 IO 超时或连接故障，conn-login-max 选项允许 iSCSI 启动器重新建立到目标的连接。有效值介于 0 至 60*60 之间，缺省值为 180 秒。
polling-login-delay
登录重试时间间隔
polling-login-delay 选项指定在 iSCSI 启动器定位 IO 超时或连接故障时每次重试登录的时间间隔。有效值介于 0 至 60*60 之间，缺省值为 60 秒。
remove 子命令
remove 子命令的语法如下：
# iscsiadm remove direct_object
remove 子命令支持下列 direct_object：
discovery-address discovery-address, ...
从搜索地址列表中删除目标设备。搜索地址（如在下面所示的语法中）是在 SendTargets 搜索会话中使用的 IP 地址-端口组合。通过使用此搜索方法，目标设备可告知启动器由该设备公开的各个目标的目标地址和目标名称。如果当前已挂载搜索地址公开的任何目标或者设备上存在活动 I/O，则会返回“逻辑单元正在使用”错误，并且此操作将失败。如果关联设备未在使用，则会删除这些设备。
必须将 discovery-address 的格式设置为：
没有与此直接对象相关联的选项。
isns-server isns-server, ...
从 iSNS 服务器地址列表中删除 iSNS 服务器。iSNS 服务器地址（在下面所示的语法中指定）是在 iSNS 搜索会话中使用的 IP 地址-端口组合。通过使用 iSNS 搜索，iSNS 服务器可以向启动器提供有关门户以及与该启动器隶属于同一搜索域中的各个目标的名称的信息。如果当前已挂载通过 iSNS 搜索的任何目标或者设备上存在活动 I/O，则会返回“逻辑单元正在使用”错误，并且此操作将失败。如果关联设备未在使用，则会删除这些设备。
必须将 isns-server 的格式设置为：
IP_address[:port]
没有与此直接对象相关联的选项。
static-config static_target, ...
从静态搜索目标的列表中删除目标。如果正在删除当前已挂载的目标或者设备上存在活动 I/O，则会返回“逻辑单元正在使用”错误，并且此操作将失败。如果设备未在使用，则将删除此设备。
必须将 static_target 的格式设置为：
没有与此直接对象相关联的选项。
target-param target-name
删除 target-name 指定的目标。目标名称的格式如下：
没有与此直接对象相关联的选项。要在启用 Solaris I/O 多路径功能（以前称为 Sun StorEdge Traffic Manager [STMS] 或 MPxIO）时进行 iSCSI 引导，则不能删除目标。
正确使用搜索方法
请勿将目标配置为可供静态和动态搜索方法搜索。使用冗余搜索方法可能会导致在与 iSCSI 目标设备通信时降低性能。
选项
支持下列常规选项：
–V, ––version
显示版本信息。停止后续参数的解释。
–?, ––help
显示帮助信息。可以在没有参数的 iscsiadm 命令、子命令或子命令直接对象组合后面使用。使用适用于您的输入的帮助信息进行响应。例如，如果输入以下内容：
# iscsiadm modify initiator-node --help
...iscsiadm 通过显示可用于子命令和直接对象的此组合的选项来进行响应。
示例
示例 1 添加搜索地址
下面的命令使用 add 子命令添加搜索地址。
# iscsiadm add discovery-address 10.0.0.1:3260 10.0.0.2:3260
示例 2 添加静态目标
下面的命令使用 add 子命令添加静态目标。
# iscsiadm add static-config \
iqn.1999-08.com.array:sn.01234567,10.0.0.1:3260
示例 3 列出当前搜索设置
下面的命令使用 list 子命令列出当前搜索设置。
# iscsiadm list discovery
Discovery:
Static: enabled
Send Targets: disabled
iSNS: enabled
示例 4 获取详细搜索输出
下面的命令使用 –v 选项（其中一个命令使用 v 选项，另一个命令不使用 v 选项）和 list 子命令获取详细输出。
# iscsiadm list discovery-address
Discovery Address: 10.0.0.1:3260
Discovery Address: 10.0.0.2:3260
# iscsiadm list discovery-address -v 10.0.0.1:3260
Discovery Address: 10.0.0.1:3260
Target name: eui.210000203787d1f7
Target address: 10.0.0.1:3260
Target name: eui.210000203787a693
Target address: 10.0.0.1:3260
示例 5 显示有关启动器的信息
下面的命令使用 list 子命令显示有关启动器的信息。
# iscsiadm list initiator-node
Initiator node name: iqn.1986-03.com.company.central.interopv20-1
Initiator node alias: interopv20-1
Login Parameters (Default/Configured):
Header Digest: NONE/NONE
Data Digest: NONE/NONE
Authentication Type: CHAP
CHAP Name: iqn.1986-03.com.company.central.interopv20-1
RADIUS Server: NONE
RADIUS access: disabled
Tunable Parameters (Default/Configured):
Session Login Response Time: 60/-
Maximum Connection Retry Time: 180/-
Login Retry Time Interval: 60/-
Configured Sessions: 1
示例 6 显示静态配置信息
下面的命令使用 list 子命令显示有关静态配置的信息。
# iscsiadm list static-config
Static target: eui.210000203787a693,10.0.0.1:3260
示例 7 显示目标信息
下面的命令显示如何使用 list 子命令和不同选项以便显示有关目标的信息。
# iscsiadm list target
Target: iqn.2004-05.com.abcStorage:Tgt-1
Alias: -
TPGT: 12288
ISID: 4000002a0000
Connections: 1
# iscsiadm list target -v iqn.2004-05.com.abcStorage:Tgt-1
Target: iqn.2004-05.com.abcStorage:Tgt-1
Alias: -
TPGT: 12288
ISID: 4000002a0000
Connections: 1
CID: 0
IP address (Local): 10.4.52.158:32803
IP address (Peer): 10.4.49.70:3260
Transport Type: socket
Discovery Method: SendTargets
Login Parameters (Negotiated):
Data Sequence In Order: yes
Data PDU In Order: yes
Default Time To Retain: 20
Default Time To Wait: 2
Error Recovery Level: 0
First Burst Length: 65536
Immediate Data: yes
Initial Ready To Transfer (R2T): yes
Max Burst Length: 262144
Max Outstanding R2T: 1
Max Receive Data Segment Length: 65536
Max Connections: 1
Header Digest: NONE
Data Digest: NONE
# iscsiadm list target -S iqn.2004-05.com.abcStorage:Tgt-1
Target: iqn.2004-05.com.abcStorage:Tgt-1
Alias: -
TPGT: 12288
ISID: 4000002a0000
Connections: 1
LUN: 6
Vendor: ABCStorage
Product: iSCSI Target
OS Device Name: /dev/rdsk/c3t1d0s2
LUN: 5
Vendor: ABCStorage
Product: iSCSI Target
OS Device Name: /dev/rdsk/c3t0d0s2
示例 8 显示目标参数信息
下面的命令使用 list 子命令显示特定目标的目标信息。
# iscsiadm list target-param -v iqn.2004-05.com.abcStorage:Tgt-1
Target: iqn.2004-05.com.abcStorage:Tgt-1
Alias: -
Bi-directional Authentication: disabled
Authentication Type: NONE
Login Parameters (Default/Configured):
Data Sequence In Order: yes/-
Data PDU In Order: yes/-
Default Time To Retain: 20/-
Default Time To Wait: 2/-
Error Recovery Level: 0/-
First Burst Length: 65536/-
Immediate Data: yes/-
Initial Ready To Transfer (R2T): yes/-
Max Burst Length: 262144/-
Max Outstanding R2T: 1/-
Max Receive Data Segment Length: 65536/-
Max Connections: 1/-
Header Digest: NONE/-
Data Digest: NONE/-
Tunable Parameters (Default/Configured):
Session Login Response Time: 60/-
Maximum Connection Retry Time: 180/-
Login Retry Time Interval: 60/-
Configured Sessions: 1
示例 9 启用静态搜索方法
下面的命令使用 modify 子命令启用静态搜索方法。
# iscsiadm modify discovery --static enable
示例 10 设置 Radius 服务器的 IP 地址
下面的命令使用 modify 子命令设置 radius 服务器的 IP 地址，该服务器将用于 CHAP 身份验证。
# iscsiadm modify initiator --radius-server 10.0.0.1
示例 11 设置启动器的节点名称
下面的命令使用 modify 子命令设置启动器节点的节点名称。
# iscsiadm modify initiator-node -N iqn.2004-10.com.SUN.host-1
示例 12 设置启动器节点的最大连接数
下面的命令使用 modify 子命令设置启动器节点的最大连接数。这允许在一个会话中存在多个连接。
# iscsiadm modify initiator-node -m 3
示例 13 更改目标参数
下面的命令使用 modify 子命令更改指定目标的目标参数的最大连接数。
# iscsiadm modify target-param -m 3 eui.210000203787a693
示例 14 删除搜索地址
下面的命令使用 remove 子命令删除搜索地址。
# iscsiadm remove discovery-address 10.0.0.1:3260
示例 15 删除目标参数
下面的命令使用 remove 子命令删除一组目标参数。
# iscsiadm remove target-param eui.210000203787a693
示例 16 修改最大连接数
下面的命令修改启动器的属性中的每个会话的最大连接数。修改后的值将用于所有会话中的所有目标。
# iscsiadm modify initiator-node --max-connections 4
属性
有关下列属性的说明，请参见 attributes(7)：
属性类型
属性值
可用性
system/storage/iscsi/iscsi-initiator
接口稳定性
Committed（已确定）
另请参见
iscsi(4D), scsi_vhci(4D), attributes(7)
附注
iSCSI 启动器服务由服务管理工具 (Service Management Facility, SMF) 管理，其服务标识符为 svc:/network/iscsi/initiator:default。有关更多信息，请参见 smf(7) 手册页。
此服务可使用 svcadm 命令启用、禁用或重新启动。使用 svcs 命令可以查询此服务的状态。