手册页部分 1M: 系统管理命令

退出打印视图

更新时间: 2014 年 7 月
 
 

itadm(1M)

名称

itadm - 管理 iSCSI 目标

用法概要

itadm create-target [-a,--auth-method radius | chap | none | default]
     [-s,--chap-secret] [-S,--chap-secret-file path]
     [-u,--chap-user chap-user-name] [-n,--node-name target_node_name]
     [-l,--alias alias] [-t,--tpg tpg-name[,tpg-name]]
itadm modify-target [-a,--auth-method radius | chap | none | default]
     [-s,--chap-secret] [-S,--chap-secret-file path]
     [-u,--chap-user chap-user-name] [-n,--node-name new_target_node_name]
     [-l,--alias alias] [-t,--tpg tpg-name[,tpg-name]] target_node_name
itadm delete-target [-f,--force] target_node_name
itadm list-target [-v,--verbose] [target_node_name]
itadm create-tpg tpg_name IP-address[:port] [IP-address[:port]]...
itadm list-tpg [-v,--verbose] [tpg_name]
itadm delete-tpg  [-f,--force] tpg_name
itadm create-initiator [-s,--chap-secret] [-S,--chap-secret-file path]
     [-u,--chap-user chap-user-name] initiator_node_name
itadm modify-initiator [-s,--chap-secret] [-S,--chap-secret-file path]
     [-u,--chap-user chap-user-name] initiator_node_name
itadm list-initiator [-v,--verbose] initiator_node_name
itadm delete-initiator initiator_node_name
itadm modify-defaults [-a,--auth-method radius | chap | none]
     [-r,--radius-server IP-address[:port]] [-d,--radius-secret]
     [-D,--radius-secret-file path][-i,--isns enable | disable]
     [-I,--isns-server IP-address[:port][,IP-address[:port]]]
itadm list-defaults

描述

itadm 命令用于管理 stmfadm(1M)libstmf(3LIB) 中介绍的 SCSI 目标模式框架中的 Internet SCSI (iSCSI) 目标节点。这允许 iSCSI 启动器使用 iSCSI 协议访问 STMF 逻辑单元。除了 iSCSI 目标节点外,itadm 还管理其他两类托管对象:iSCSI 目标门户组与 iSCSI 启动器节点上下文。

itadm 是作为一组子命令以及用于各个子命令的选项和操作数实现的。下文中的相应部分分别描述了这些子命令。除了其子命令,itadm 还有一个帮助命令,用以显示该实用程序的用法信息。该帮助命令是使用 –? 选项调用的。

iSCSI 目标门户组

iSCSI 目标网络门户是指可由启动器节点用来连接到 iSCSI 目标的 IP 地址和 TCP 端口。这些门户的集合称为目标门户组 (Target Portal Group, TPG)。您可以使用 TPG 来限制对 iSCSI 目标的访问。可以使用 itadm modify – t 命令将特定 iSCSI 目标绑定到 TPG。将在属于 TPG 的每个 IP 地址上创建一个 iSCSI 侦听器,它侦听与 iSCSI 目标的连接。

TPG 是由在创建 TPG 时提供的唯一名称所标识的。在创建 TPG 时会自动生成一个范围介于 2-65535 的数字“目标门户组标记”。“目标门户组标记 1”是为没有在目标上设置显式“目标门户组”时使用的“缺省”目标门户组保留的。缺省 TPG 的门户与来自端口 3260 上所有网络接口的请求相匹配。

iSCSI 启动器节点上下文

某些操作,例如通过质询握手身份验证协议 (Challenge Handshake Authentication Protocol, CHAP) 进行的验证,需要与远程 iSCSI 启动器节点关联的参数。这些参数与 iSCSI 启动器节点上下文关联。iSCSI 启动器节点上下文由其启动器节点名称标识,该名称的格式为 IQN 或 EUI 格式(请参见 RFC 3720)。例如:

iqn.1986-03.com.sun:01:e00000000000.47d55444
eui.02004567A425678D

指定 IP 地址

许多 itadm 子命令要求您指定一个或多个具有可选端口号的 IP 地址。对于 IPv4,请使用标准的点分十进制记法。对于 IPv6,请用方括号将地址括起来。以下是示例指定方法。

IPv4:  10.2.4.1
       10.2.4.1:3260
IPv6:  [1080:0:0:0:8:800:200C:417A]
       [1080:0:0:0:8:800:200C:417A]:3260

子命令

下面是 itadm 子命令及其选项。

itadm create-target

itadm create-target [-a,--auth-method radius | chap | none | default]
     [-s,--chap-secret]
     [-S,--chap-secret-file path] [-u,--chap-user chap-user-name]
     [-n,--node-name target_node_name] [-l,--alias alias]
     [-t,--tpg tpg-name[,tpg-name,...]]

使用指定选项创建 iSCSI 目标。选项如下所述。

–a,–-auth-method radius | chap | none | default

指定用于目标的验证方式。有效值是 radiuschapnonechap 表示必须使用质询握手身份验证协议 (Challenge Handshake Authentication Protocol, CHAP) 对连接到此目标的启动器进行验证。radius 表示还应当使用 CHAP 对启动器进行验证,但应当从中央 RADIUS 服务器获取所需的验证参数(请参见 radius-serverradius-secret 选项)。none 表示不需要对与目标的连接进行验证。default 表示目标将使用此属性的全局设置。(请参见 modify-defaults 子命令)。

–s,–-chap-secret

交互 CHAP 验证期间要发送的 CHAP 密钥。此属性没有缺省值。最大长度为 255 个字符;最小必需长度为 12 个字符。

–S,–-chap-secret-file path

–s 选项中所述,包含 CHAP 密钥的临时文件的路径。

–u,–-chap-user chap-user-name

为目标指定在交互 CHAP 验证中使用的 CHAP 用户名。此值只允许用于目标,不能全局设置,并且只会在启动器节点被配置为使用交互 CHAP 验证时使用。如果没有指定值,则将目标节点名称用作用户名。请参见 iscsiadm(1M)

–n,–-node-name target_node_name

iSCSI 目标节点由其目标节点名称标识,该名称的格式为 IQN 或 EUI 格式(请参见 RFC 3720)。此选项用于创建该名称。

–l,–-alias alias

与目标节点关联的替代标识符。此标识符不需要是唯一的。

–t,–-tpg tpg-name[,tpg-name,...]

一个目标门户组 (Target Portal Group, TPG) 列表(用以指定启动器可以用来访问特定目标的 TGP)或者关键字 default。如果指定了 default,目标将使用缺省门户 INADDR_ANY:3260

itadm modify-target

itadm modify-target [-a,--auth-method radius | chap | none | default]
     [-s,--chap-secret] [-S,--chap-secret-file path]
     [-u,--chap-user chap-user-name] [-n,--node-name new_tgt_node_name]
     [-l,--alias alias] [-t,--tpg tpg-name[,tpg-name]] target_node_name

根据指定的选项修改 iSCSI 目标。选项如下所述。

–a,–-auth-method radius | chap | none | default

如上文中的 create-target 子命令部分所述。

–s,–-chap-secret

如上文中的 create-target 子命令部分所述。

–S,–-chap-secret-file path

如上文中的 create-target 子命令部分所述。

–u,–-chap-user chap-user-name

如上文中的 create-target 子命令部分所述。要删除显式设置的 CHAP 用户名,请使用 –u none

–n,–-node-name target_node_name

重命名目标。另请参见上文中的 create-target 子命令部分中对 –n 的说明。

–l,–-alias alias

如上文中的 create-target 子命令部分所述。要删除显式设置的别名,请使用 –l none

–t,–-tpg tpg-name[,tpg-name,...]

如上文中的 create-target 子命令部分所述。

itadm list-target

itadm list-target [–v,–-verbose] [target_node_name]

列出所配置的目标的相关信息。如果指定了 target_node_name,则只会列出关于该目标的信息。选项如下所述。

–v–-verbose

详细模式。

itadm delete-target

itadm delete-target [–f,–-force] target_node_name

删除由 target_node_name 指定的目标。目标必须处于 offline(脱机)状态才能删除。选项如下所述。

–f,–-force

如果目标仍然保持联机状态,此选项将尝试在删除目标前使其脱机。

itadm create-tpg

itadm create-tpg tpg_name IP-address[:port]...

创建由指定的门户组成的 iSCSI 目标门户组,并为其分配标识符 tpg_name。每个门户都是一个 IP 地址与端口对。IPv4 门户是以点分地址表示法指定的,例如 172.31.255.255。IPv6 门户地址必须用方括号括起来。

此子命令没有选项。

itadm list-tpg

itadm list-tpg [–v,–-verbose] [tpg_name]

列出所配置的目标门户组的相关信息。如果指定了 tpg_name,则只会列出与 tpg_name 关联的目标门户组的相关信息。选项如下所述。

–v–-verbose

详细模式。

itadm delete-tpg

itadm delete-tpg  [–f,–-force] tpg_name

删除与 tpg_name 关联的目标门户组。选项如下所述。

–f,–-force

如果 TPG 与任何目标关联,则除非指定了此选项,否则删除的请求将被拒绝。

itadm create-initiator

itadm create-initiator [–s,–-chap-secret] [–S,–-chap-secret-file path]
     [–u,–-chap-user chap-user-name] initiator_node_name

配置与名为 initiator_node_name 的远程启动器关联的参数。选项如下所述。

–s,–-chap-secret

如上文中的 create-target 子命令部分所述。

–S,–-chap-secret-file path

如上文中的 create-target 子命令部分所述。

–u,–-chap-user chap-user-name

为启动器指定用于 CHAP 验证的 CHAP 用户名。如果没有指定值,则将启动器节点名称用作用户名。

itadm modify-initiator

itadm modify-initiator [–s,–-chap-secret] [–S,–-chap-secret-file path]
     [–u,–-chap-user chap-user-name] initiator_node_name

修改与名为 initiator_node_name 的远程启动器关联的参数。选项如下所述。

–s,–-chap-secret

如上文中的 create-target 子命令部分所述。

–S,–-chap-secret-file path

如上文中的 create-target 子命令部分所述。

–u,–-chap-user chap-user-name

为启动器指定用于 CHAP 验证的 CHAP 用户名。如果没有指定值,则将启动器节点名称用作用户名。

itadm delete-initiator

itadm delete-initiator initiator_node_name

删除与名为 initiator_node_name 的远程启动器关联的参数。此子命令没有选项。

itadm list-initiator

itadm list-initiator [-v,--verbose] initiator_node_name

列出与名为 initiator_node_name 的启动器关联的参数。选项如下所述。

–v–-verbose

详细模式。

itadm modify-defaults

itadm modify-defaults [–a,–-auth-method radius | chap | none]
     [–r,–-radius-server IP-address[:port]] [–d,–-radius-secret]
     [–D,–-radius-secret-file path][–i,–-isns enable | disable]
     [–I,–-isns-server IP-address[:port][,IP-address[:port]]]

修改缺省参数。选项如下所述。

–a,–-auth-method radius | chap | none

指定用于所有目标的缺省验证方式。有效值是 radiuschapnonechap 表示必须使用质询握手身份验证协议 (Challenge Handshake Authentication Protocol, CHAP) 对连接到此目标的启动器进行验证。radius 表示还应当使用 CHAP 对启动器进行验证,但应当从中央 RADIUS 服务器获取所需的验证参数。(请参见 –-radius-server–-radius-secret 选项)。none 表示不需要对与目标的连接进行验证。各个目标都可使用 create-targetmodify-target 子命令的 –a 选项覆盖此全局设置。

–d,–-radius-secret

用于集中 CHAP 验证的 RADIUS 共享密钥。

–D,–-radius-secret-file path

–d 选项中所述,包含 CHAP 密钥的临时文件的路径。

–i,–-sns enable | disable

指定是否向所定义的 iSCSI 名称服务 (iSCSI Name Service, iSNS) 服务器集注册目标。

–I,–-isns-server IP-address[:port][,IP-address[:port],...]

定义当设置了与相应目标关联的 isns 选项时,要向其注册 iSCSI 目标节点的 iSNS 服务器的列表。最多可以指定八个 iSNS 服务器。要删除所有 iSNS 服务器,请使用 –I none

–r,–-radius-server IP-address[:port]

指定用于集中 CHAP 验证的 RADIUS 服务器的 IP 地址。

itadm list-defaults

itadm list-defaults

列出关于缺省属性的信息。此子命令没有选项。

示例

示例 1 创建目标

以下命令用于创建目标。

# itadm create-target
Target iqn.1986-03.com.sun:02:72e1b181-7bce-c0e6-851e-ec0d8cf14b7a
successfully created
示例 2 使用特定名称创建目标

以下命令用于使用特定 IQN 创建目标。

# itadm create-target -n eui.20387ab8943ef7548
or:
# itadm create-target \
-n iqn.1986-03.com.sun:02:a9a366f8-cc2b-f291-840948c7f29e
示例 3 更改名称

以下命令用于更改现有目标的 IQN。

# itadm modify-target -n eui.20387ab8943ef7548 \
iqn.1986-03.com.sun:02:a9a366f8-909b-cc2b-f291-840948c7f29e
示例 4 设置 CHAP 验证

以下命令用于使用缺省 CHAP 用户名为目标设置 CHAP 验证。

# itadm modify-initiator -s iqn.1986-03.com.sun:01:e00000000000.47d55444
Enter CHAP secret: *********
Re-enter secret: *********

# itadm modify-target -a chap eui.20387ab8943ef7548
示例 5 创建目标门户组

以下命令用于创建两个目标门户组 AB,并且为 TPG 2 中的地址使用端口 8000。

# itadm create-tpg A 192.168.0.1 192.168.0.2
# itadm create-tpg B 192.168.0.2:8000 192.168.0.2:8000
示例 6 将目标配置为使用 TPG

以下命令用于将目标配置为使用 TPG A 和 B。

# itadm modify-target -t A,B eui.20387ab8943ef7548
示例 7 为特定目标设置 RADIUS 验证

以下命令用于为特定目标设置 RADIUS 验证。

# itadm modify-defaults -r 192.168.10.1 -d
Enter RADIUS secret: *********
Re-enter secret: *********

# itadm modify-target -a radius eui.20387ab8943ef7548
示例 8 为所有目标设置 RADIUS 验证

以下命令用于为所有目标设置 RADIUS 验证。

# itadm modify-defaults -d -r 192.168.10.1 -a radius
Enter RADIUS secret: *********
Re-enter secret: *********

上面的命令假定所有目标都是使用 –a default 创建的。

示例 9 列出缺省属性

以下命令用于列出缺省属性。

# itadm list-defaults
iSCSI Target Default Properties:

alias:          none
auth:           none
radiusserver:   none
radiussecret:   unset
isns:           disabled
isnsserver:     2.3.4.5,4.5.6.7
示例 10 列出目标

以下命令用于列出目标。

# itadm list-target
TARGET NAME                                           STATE    SESSIONS
iqn.1986-03.com.sun:02:72e1b181-7bce-c0e6-851e-ec0d8cf14b7a  online   0
iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227  online   0
iqn.1986-03.com.sun:02:d14125bb-1c9d-c28d-97b0-f89259b642f3  online   0
iqn.1986-03.com.sun:02:03ff9fc5-794a-e9b4-a081-bb82917c292a  online   0
示例 11 列出目标(详细)

以下命令用于使用详细选项列出目标。

# itadm list-target -v
TARGET NAME                                           STATE    SESSIONS
iqn.1986-03.com.sun:02:d23e68d8-2d79-c988-98e7-a6361689d33c  online   0
       alias:                  -
       auth:                   none (defaults)
       targetchapuser:         -
       targetchapsecret:       unset
       tpg-tags:               default
iqn.1986-03.com.sun:02:94ec46d4-c8e1-6993-ef03-ffc1dcd66606  online   1
       alias:                  -
       auth:                   chap
       targetchapuser:         -
       targetchapsecret:       unset
       tpg-tags:               nge1_ipv4 = 3
示例 12 列出特定目标

以下命令用于使用详细选项列出目标。

# itadm list-target -v \
iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227
TARGET NAME                                           STATE    SESSIONS
iqn.1986-03.com.sun:02:2cb0c526-c05a-e279-e396-a367006f4227  online   1
        alias:                  -
        auth:                   chap
        targetchapuser:         -
        targetchapsecret:       unset
        tpg-tags:               nge1_ipv4 = 3

属性

有关下列属性的说明,请参见 attributes(5)

属性类型
属性值
可用性
system/storage/iscsi/iscsi-target
接口稳定性
Committed(已确定)

另请参见

iscsiadm(1M)stmfadm(1M)libstmf(3LIB)attributes(5)