使用 Command Line Console (CLC)

利用 Command Line Console (CLC)，管理員能夠使用命令列來對解決方案定義 (SPD) 和安裝套件 (IP) 執行某些 GAX 功能。例如，您可能使用 CLC 以無提示方式將 SPD 部署到遠端主機上。

您必須能夠存取作業系統的命令列介面才能使用 CLC。如果不在 GAX 主機上，則本機電腦上必須有 CLC 工具 (gaxclc.jar)。

若要存取 CLC 的內嵌說明檔，請執行以下命令之一：

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

重要

在使用 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 設定檔。

重要

如果未指定旗標，則將 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"
	}
}

重要

應使用 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"
					}
				]
			}
		}
	}
}

重要

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"
					     }
				]
			}
		}
	}
}

重要

• 如果輸入檔案未指定 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。

重要

.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 號碼
• 名稱
• 版本
• 作業系統
• 地區設定
• 狀態

格式

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 號碼
• 名稱
• 版本
• 作業系統
• 地區設定
• 狀態

格式

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