使用“命令行控制台 (CLC)”

利用命令行控制台 (CLC)，管理员能够使用命令行来对解决方案定义 (SPD) 和安装包 (IP) 执行某些 GAX 功能。例如，您可能使用 CLC 以无提示方式将 SPD 部署到远程主机上。

您必须能够访问操作系统的命令行界面才能使用 CLC。如果不在 GAX 主机上，则本地计算机上必须有 CLC 工具 (gaxclc.jar)。

要访问 CLC 的内嵌帮助文件，请执行以下命令之一：

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

Important

在使用 CLC 执行命令时，将在执行工具的相同位置中生成一个日志文件。

结构

CLC 支持使用以下结构的命令：

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> <function> <operation> <args>

在上面的示例中：

• -u:user 是用于登录到 Configuration Server 的用户名。
• -p:password 是用于登录到 Configuration Server 的密码。如果此标志未指定值，则 CLC 假定没有密码。
• -s 指示 CLC 使用与 GAX 服务器的安全 https 连接。如果未指定此标志，则 CLC 使用 http。
• -h:<host>:<port> 指定 GAX 服务器的主机和端口。如果未指定此标志，则 CLC 使用以下值：-h:localhost:8080.
• <function> 可以是 ip 或 spd。
• <operation> 指定要执行的操作。此标志的有效值特定于您在上一步中指定的功能（ip 或 spd）。
• <args> 指定操作参数。此标志的有效值特定于您在上一步中指定的 <function> 和 <operation> 参数。

下面是一个 CLC 命令示例：

java -jar gaxclc.jar -u:default -p:password -h:localhost:8080 spd execute 10054 1 "C:/GAX/input.txt"

SPD

对于 SPD，CLC 支持以下操作：

• 添加
• 查询
• querybyid
• 执行
• 删除
• encrypt（请参阅 执行 选项卡）

添加

概述

此操作将 SPD 添加到 GAX 数据库。如果 SPD 已存在（根据 SPD XML 中的名称和版本确定），此操作将替换现有 SPD。

如果成功，操作将返回已添加 SPD 的 ID。

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd add "file path"

• "file path"—XML 文件的路径。

示例

java -jar gaxclc.jar -u:default -p:password spd add "c:\GAX\newSpd.xml"

查询

概述

此操作将查询所有 SPD，并显示一个列出每个 SPD 的以下内容的表：

• ID 号
• 名称
• 版本
• 租户 DBID

下面是一个示例：

10054 gvp 8.1.5 1
10060 genesysOne 8.1.5 1
10060 eServices 8.1.5 1

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd query

示例

java -jar gaxclc.jar -u:default -p:password -s -h:132.45.43.45:443 spd query

querybyid

概述

该操作通过其 ID 查询 SPD。如果 SPD 不存在，操作将失败。

如果成功，操作将显示一个列出有关 SPD 的以下详细信息的表：

• 配置文件 ID
• 名称

例如：

1 Install

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd query SPDID

• SPDID— 所查询的 SPD 的 ID。

示例

java -jar gaxclc.jar -u:default -p:password -h:132.45.43.45:8080 spd query 4374

执行

概述

此操作执行 SPD。

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd execute SPDID profileName|-profileID:profileID|-profileName:profileName -encrypted "input file"

• SPDID— 要执行的 SPD 的 ID。
• profileName|-profileID:profileID|-profileName:profileName— 要执行的 SPD 配置文件。

Important

如果未指定标志，则将 profileName 假定为要执行的 SPD 配置文件。

• -encrypted—如果指定，则指示是否对输入文件进行加密。

[+] 显示用法

CLC 为包括敏感数据（例如密码）的输入文件提供加密支持。

格式：

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd encrypt "input file path" "encrypted output file path"

加密的输入文件存储在由 "encrypted output file path" 指定的位置中。如果文件在此位置已存在，则将其覆盖。

示例：

java -jar gaxclc.jar -u:default -p:password spd -encrypted "c:\GAX\input.txt" "c:\GAX\encrypted.txt"

java -jar gaxclc.jar -u:default -p:password spd -encrypted "input.txt" "encrypted.txt"

• "input file"—指定包含 SPD 参数的输入文件。如果设置了 -encrypted，则对输入文件进行加密。

输入文件必须为 JSONObject 格式，并包括特定配置文件的 SPD 参数。文件必须采用 UTF-8 格式进行编码。

[+] 显示用法

字符串类型

下面描述了字符串类型的输入结构：

{
	"Dialog name" : {
		"Input name" : "string"
	}
}

示例

SPD 配置文件

<profile name="Install">
 <dialog step="Step1">
	<input name="NAME_PARAM1" title="PERSON NAME"  default="birit" type="string" required="true">
	   <description>Please enter the person name</description>
	</input>
 </dialog>
 <dialog step="Step2">
	<input name="NAME_PARAM2" title="PERSON NAME"  default="birit" type="string" required="true">
	   <description>Please enter the person name</description>
	</input>
 </dialog>
 <execution>
	<script>
		log('string test' );
	</script>
 </execution>
</profile>

安装配置文件的输入文件

{
	"Step1" : {
		"NAME_PARAM1" : "Kate"
	},
	"Step2" : {
		"NAME_PARAM2" : "John"
	}
}

布尔型类型

下面描述了布尔型类型的输入结构：

{
	"Dialog name" : {
		"Input name" : true/false
	}
}

示例

SPD 配置文件

<profile name="Install">
 <dialog step="Step1">
	<input name="STATUS" title="status"  type="boolean" required="true">
	   <description>status field</description>
	</input>
 </dialog>
 <execution>
	<script>
		log('boolean test');
	</script>
 </execution>
</profile>

安装配置文件的输入文件

{
	"Step1" : {
		"STATUS" : true
	}
}

整数类型

下面描述了整数类型的输入结构：

{
	"Dialog name" : {
		"Input name" : <integer>
	}
}

示例

SPD 配置文件

<profile name="Install">
 <dialog step="Step1">
	<input name="NUMBER" title="number"  type="integer" required="true">
	   <description>number field</description>
	</input>
 </dialog>
 <execution>
	<script>
		log('number test');
	</script>
 </execution>
</profile>

安装配置文件的输入文件

{
	"Step1" : {
		"NUMBER" : 132
	}
}

密码类型

下面描述了密码类型的输入结构：

{
	"Dialog name" : {
		"Input name" : "password"
	}
}

Important

应使用 SPD 加密运算对包括敏感数据（例如密码）的输入文件进行加密。

示例

SPD 配置文件

<profile name="Install">
 <dialog step="Step1">
	<input name="PASSWORD" title="password"  type="password" required="true">
	   <description>password field</description>
	</input>
 </dialog>
 <execution>
	<script>
		log('password test');
	</script>
 </execution>
</profile>

安装配置文件的输入文件

{
	"Step1" : {
		"PASSWORD" : "xyz9846gdkjg"
	}
}

SELECTONE 类型

下面描述了包含 <objectselect> 标记的 selectOne 类型：

{
	"Dialog name" : {
		"Input name" : {
			"objectselect" : {
				"filter" : [{
						"value" : "filter value",
						"name"  : "filter name"
					}
				]
			}
		}
	}
}

Important

CLC 与 SPD 文件和 selectOne 输入的输入文件中定义的过滤器相交 ( 和 )。过滤器条件在 SPD 输入文件中应不同，并且过滤器名称在相同的过滤器定义中应不同。

示例

SPD 配置文件

<profile name="Install">
 <dialog step="Step1">
	<input name="APP_OBJ_SELECT_ONE" title="Application Name" hidden="false" type="selectOne" default="">
				<description>select application</description>
				<objectselect>
					<filter value="CfgApplication" name="type"/>
				</objectselect>
	</input>
 </dialog>
 <execution>
	<script>
		log('test select one' );
	</script>

 </execution>

安装配置文件的输入文件

{
	"Step1" : {
		"APP_OBJ_SELECT_ONE" : {
			"objectselect" : {
				"filter" : [{
						"value" : "SIP_lrm26",
						"name"  : "name"
					}
				]
			}
		}
	}
}

SelectMultiple 类型

下面描述了包含 <objectselect> 标记的 selectMultiple 类型的输入结构：

{
	"Dialog name" : {
		"Input name" : {
			"objectselect" : {
				"filter" : [{
						"value" : "filter value",
						"name"  : "filter name"
					}
				]
			}
		}
	}
}

SPD 输入文件中定义的过滤器在并集中连接 ( 或 )，然后与 selectMultiple 输入的 SPD 文件中定义的过滤器相交 ( 和 )。

示例

SPD 配置文件

<profile name="Install">
 <dialog step="Step1">
	<input name="APP_OBJ_SELECT_MULTIPLE" title="Application Name" hidden="false" type="selectMultiple" default="">
				<description>select application</description>
				<objectselect>
					<filter value="CfgApplication" name="type"/>
				</objectselect>
	</input>
 </dialog>
 <execution>
	<script>
		log('test select multiple' );
	</script>

 </execution>

安装配置文件的输入文件

{
	"Step1" : {
		"APP_OBJ_SELECT_MULTIPLE" : {
			"objectselect" : {
				"filter" : [{
						"value" : "SIP_lrm26",
						"name"  : "name"
					},{
						"value" : "SIP_lrm27",
						"name"  : "name"
					}
				]
			}
		}
	}
}

运算返回名为 SIP_lrm26 和 SIP_lrm27 的两个应用程序。

SELECTONE 类型

下面描述了包含 <selection> 标记的 selectOne/selectMultiple/布尔型类型的输入结构：

{
	"Dialog name" : {
		"Input name" : {
			"selection" : {
				"option" : [{
						"value" : "option value assigned to the input parameter",
						"name"  : "option name is displayed in UI"
					}
				]
			}
		}
	}
}

CLC 选择 SPD 输入文件中定义的选项。只能为 selectMultiple 输入类型指定多个选项。

示例

SPD 配置文件

<profile name="Install">
 <dialog step="Application Parameters">
	<input name="DATA_MODEL" title="Binary Version (32-bit or 64-bit)" default="64" type="selectOne" required="true">
	    <description>This parameter defines the 32-bit or the 64-bit version of the binary to be deployed.  </description>
		<selection>
		    <option name="32" value="32"/>
		    <option name="64" value="64"/>
		</selection>
	</input>
 </dialog>
 <execution>
	<script>
		log('test selection support' );
	</script>

 </execution>

安装配置文件的输入文件

{
	"Application Parameters" : {
		"DATA_MODEL" : {
			"selection" : {
				"option" : [{
						"value" : "64",
						"name"  : "64"
					     }
				]
			}
		}
	}
}

Important

• 如果输入文件未指定 SPD 参数的值，则将使用输入元素的 default 属性中定义的值。
• 如果 SPD 输入元素的 required 属性设置为 true，但没有 SPD（默认值）或输入文件中提供的对应输入值，则 SPD 执行将失败。
• 如果 SPD 输入元素的 readonly 属性值设置为 true，则将为执行使用 default 属性值中的值（如果已定义）。 如果 readonly 属性值设置为 true、required 设置为 false，并且未定义 default 属性，则将使用以下逻辑来确定输入值：
  1. 对于布尔型输入类型，输入值设置为 false。
  2. 对于字符串和密码输入类型，输入值设置为 ""。
  3. 对于整数输入类型，将不会传播输入。
• 如果对话 cond 属性值的计算结果 false，则 CLC 工具将跳过对话。 示例：

   <dialog step="Role input" cond="false">
    <input name="ROLE" title="Role" hidden="false" type="selectOne" required="true">
  	<description>Please indicate the role</description>
  		<objectselect>
  			<filter value="CfgRole" name="type"/>
  		</objectselect>
  	</input>
   </dialog>

  
  

示例

java -jar gaxclc.jar -u:default -p:password -s -h:localhost:8080 spd execute 10054 -profileID:1 "C:/GAX/input.txt"

java -jar gaxclc.jar -u:default -p:password -h:localhost:8080 spd execute 10054 -profileName:"Install profile" "C:/GAX/input.txt"

java -jar gaxclc.jar -u:default -p:password -s -h:localhost:8080 spd execute 10054 1 -encrypted "C:/GAX/encryptedinput.txt"

删除

概述

此操作删除 SPD。如果 SPD 不存在，操作将失败。

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd delete SPDID

• SPDID—要删除的 SPD 的 ID。

示例

java -jar gaxclc.jar -u:default -p:password spd delete 5436

IP

对于 ip 功能，CLC 支持以下操作：

• 添加
• 查询
• querybyid
• 删除

添加

概述

此操作将 IP（打包为 .zip 文件形式）添加到 GAX 数据库。如果 IP 已存在，则将其替换。

如果成功，操作将显示 IP 的 ID。

Important

.zip 文件必须包含 IP 以及 IP 的模板文件夹。

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> ip add "path to IP zip file"

示例

java -jar gaxclc.jar -u:default -p:password ip add "C:\GAX\TESTS\zippedIpUpload\PRODUCTION\IP_TSrvSIP64_18100079b1_ENU_windows.zip"

查询

概述

此操作将查询所有 IP，并显示一个列出每个 IP 的以下详细信息的表：

• ID 号
• 名称
• 版本
• OS
• 区域设置
• 状态

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> ip query

示例

java -jar gaxclc.jar -u:default -p:password -s -h:132.45.43.45:443 ip query

querybyid

概述

此操作将按 ID 查询 IP，并显示一个列出以下详细信息的表：

• ID 号
• 名称
• 版本
• OS
• 区域设置
• 状态

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> ip query IPID

• IPID—要查询的 IP 的 ID。

示例

java -jar gaxclc.jar -u:default -p:password -h:132.45.43.45:8080 ip query 543

删除

概述

此操作删除 IP。

格式

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> ip delete IPID

• IPID—要删除的 IP 的 ID。

示例

java -jar gaxclc.jar -u:default -p:password ip delete 547

category:Genesys Administrator Extension category:Genesys Administrator Extension Help