tpctool 命令

tpctool 命令是 IBM Spectrum Control CLI 程序。可以单独使用 IBM Spectrum Control tpctool 命令 (使用关联的选项和自变量) ，也可以通过以交互方式启动不带选项或自变量的 tpctool 命令来启动交互式会话。

语法

参数

命令

某个命令（generic、disk、fabric 或 reporting）或命令别名。

connection-options

用于连接 IBM Spectrum Control 的选项。将包括这些选项。

-user
-pwd
-url

在 tpctool 自变量和选项列表中，使用详细信息描述了这些选项。

格式化-选项

这是用于格式化某些命令的输出的选项。

命令选项

这是与定义命令行为的命令关联的选项。

命令参数

通常是用于定义命令选项的值。这些值可以定义为以逗号或空格分隔的字符串值的列表。

以下参数和选项对于 tpctool 有效：

-user user_name: 指定 IBM Spectrum Control 用户标识。
-pwd password: 指定 IBM Spectrum Control 用户标识的密码。
-url url: 指定设备服务器。 URL 的格式为 system:port_number，其中，system 表示主机名或 IP 地址，而 port_number 表示 IBM Spectrum Control 设备服务器端口。
-help | -h | -?: 列出命令的帮助信息。
-ver: 显示已安装的 IBM Spectrum Control的版本。

命令别名

IBM Spectrum Control CLI 通过使用命令配置文件提供命令别名判别功能。缺省配置文件为 c:\program files\ibm\tpc\cli\libs\tpccli.conf。借助别名定义，您可以定义一个别名，后跟表示命令名称的值以及与该命令关联的任何选项。已有别名的命令字符串将替换为定义的值，并且将重新解析整个行。必须先使用 encrypt 命令加密已有别名的命令中使用的密码。

例如，要缩短经常使用的命令，您可以定义以下别名：

tpctool>lsperf = lsdev -user dsadmin -pwd dsadmpw1 -url 9.44.33.126:8990 -fabric -perf

在定义别名之后，您可以运行 lsperf 命令来运行带别名的 lsdev 命令。

您可以提供针对不同设备服务器的简短格式命令，如下所示：

tpctool>lsperfd1 = lsdev -user dsadmin -pwd dsadmpw1 -url hostOne:9161 -perf

tpctool>lsperfd2 = lsdev -user dsadmin -pwd dsadmpw1 -url hostTwo:9161 -perf

可以为已有别名的命令指定更多选项和自变量。

tpctool>lsperfd2 -fabric -ctype port

这将扩展为：

tpctool>lsdev -user dsadmin -pwd dsadmpw1 -url hostTwo:9161 -perf -fabric -ctype port

您也可以嵌套别名：

tpctool>lsperf = lsdev -user dsadmin -pwd dsadmpw1 -url hostTwo:9161 -perf -fabric

tpctool>lsperfd1 = lsdev -user dsadmin -pwd dsadmpw1 -url hostOne:9161

tpctool>lsperfd2 = lsdev -user dsadmin -pwd dsadmpw1 -url hostTwo:9161

要取消设置别名，请输入命令别名的名称，后跟等号 (=)。

lsperf =

在 tpccli.conf 文件中将别名与“键/值对”配合使用时，您必须对每个反斜杠指定四个反斜杠。

例如，此值：

ABCDE1 = CLARiiON\+ABC01234567890+0

将指定为：

ABCDE1 = CLARiiON\\\\+ABC01234567890+0

示例

要启动 IBM Spectrum Control CLI 的交互式会话，请执行以下操作:

以下命令将启动交互式会话。在会话启动之后，您可以在会话中使用其他 CLI 命令：

tpctool

使用凭证启动交互式会话：

以下命令将启动交互式会话并指定用户标识、密码和目标：

tpctool -user adminpass 
-pwd adminpw1 
-url 9.43.124.255:8080

设置用于进行自动登录的凭证

您可以在除缺省文件以外的另一个 CLI 程序配置文件中设置并保存凭证，而不必进入交互方式，这样就不必为每个 tcptool 命令会话重复指定这些凭证。

创建新的配置文件

您可以设置新的位置和文件名，并创建一个包含用于登陆到 tcptool 命令的凭证的新配置文件。

Windows 操作系统的缺省配置文件位置如下所示：

 C:\program files\ibm\tpc\cli\libs\tpccli.conf

对于 Linux® 操作系统:

/opt/IBM/TPC/cli/libs/tpccli.conf

要创建新的配置文件，请执行下列步骤：

对于 Windows 操作系统，请在命令提示符窗口中输入以下命令：
```
SET TPCCFG=C:\installation_dir\cli\config file
```
其中，cli.properties 文件是已存在的缺省配置文件，而 TPCCFG 是配置文件的新名称。
对于 Linux 操作系统：
```
export TPCCFG=../installation_dir/cli/config file
```
其中，cli.properties 文件是已存在的缺省配置文件，而 TPCCFG 是配置文件的新名称。
对新的配置文件进行编辑，使其包含目标、您的用户标识和密码。
例如，对于 Windows 操作系统：
```
C:\installation_dir\cli>tcptool
tpctool> url=localhost:9550 
tpctool> user=db2admin 
tpctool> password=xxxxxxxxxx
```
其中：

url=localhost:9550

这是本地或远程服务器的名称或 IP 地址。

user=db2admin

安装 IBM Spectrum Control时使用的 DB2® 实例名称。

password=xxxxxxxxx

用于登录到 IBM Spectrum Control的密码。
例如，对于 Linux 操作系统：
```
</installation_dir/cli/tpctool.sh
tpctool> url=localhost:9550
tpctool> user=db2inst1 
tpctool> password=xxxxxxxxxx
```
退出 tcptool 会话：
```
tpctool> quit 
```
在 Linux 操作系统上，您退出命令行界面后，如果希望再次访问命令，只需再次运行 export 命令。例如：
```
export TPCCFG=../installation_dir/cli/config file
```

您可以通过交互方式来创建新的配置文件。找到 IBM Spectrum Control 安装目录后，双击 tcptool.bat 文件或在命令提示符窗口上输入 tcptool.bat|sh file 以交互方式启动 tcptool 会话。输入凭证，这样就不需要在启动每个 tcptool 命令时再次指定这些凭证。

例如，在 Windows 系统上，tcptool.bat 文件位于以下位置：

c:\program files\ibm\tpc\cli directory file

在 Linux 操作系统上，必须以 /opt/IBM?TPC/cli 形式将此目录路径添加到 tcptool.sh 文件中。除非特定命令参数要求区分大小写，否则命令输入可以为小写、大写或大小写混合。

返回码

下表包含 tpctool 命令返回的代码。

表 1. tpctool 命令的返回码
代码	描述
0	命令已成功完成。
1	命令对于 tpctool 是未知的，没有解析为别名。
2	没有提供必需的选项。
3	选项对于 tpctool 是未知的，或者不适用于命令。
4	选项缺少必需参数。
5	选项的参数格式无效。
6	自变量的格式无效。
7	提供了无关的自变量或自变量列表。
8	tpctool 客户机无法与设备服务器连接。
9	tpctool 客户机无法使用指定的凭证登录到IBM Spectrum Control 。
10	指定的凭证无权执行请求的操作。
11	未安装和启用必需组件。
12	该命令可能已启动，但与 IBM Spectrum Control 的连接已断开。命令可能没有成功完成。
13	在 IBM Spectrum Control 返回故障之前，部分操作已完成。
14	命令失败。
15	尝试除去的组有关联的子组。除去子组，然后重试该操作。