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 は、セキュアな https 接続を使用して GAX サーバーに接続するよう CLC に指示します。このフラグを指定しない場合、CLC は http を使用します。
• -h:<host>:<port> は、GAX サーバーのホストとポートを指定します。このフラグを指定しない場合、CLC は -h:localhost:8080 の値を使用します。
• <function> の値は、ip または spd のいずれかです。
• <operation> は、実行する操作を指定します。このフラグの有効値は、前の手順で指定した function の値 (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

CLC では SPD に対して次の操作を実行できます。

• add
• query
• querybyid
• execute
• delete
• encrypt (「execute」タブを参照)

add

概要

この操作は、GAX データベースに SPD を追加します。SPD XML にある名前とバージョンにより SPD が既に存在すると判断された場合には、この操作で既存の 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"

query

概要

すべての 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

概要

この操作は SPD を ID で照会します。該当する 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

execute

概要

この操作は 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 プロファイル。

重要

フラグを指定しない場合、実行する SPD プロファイルとして profileName が使用されます。

• -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 を利用すると、selectOne の入力のための SPD ファイルと入力ファイルで定義されている (AND) フィルターが分割されます。フィルター条件は 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 入力ファイルに定義されたフィルターが和集合 (OR) に結合されてから、selectMultiple 入力用の SPD ファイルに定義されたフィルターで共通集合 (AND) を取得します。

例

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 という名前の 2 つのアプリケーションを返します。

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"

delete

概要

この操作は 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

CLC では ip 機能として次の操作を実行できます。

• add
• query
• querybyid
• delete

add

概要

この操作は IP (.zip ファイルにパッケージ化されたもの) を GAX データベースに追加します。同じ IP が既に存在する場合、既存の IP が置換されます。

操作に成功した場合、追加された IP が表示されます。

重要

.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"

query

概要

この操作はすべての 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

概要

この操作は IP を ID により照会し、次の詳細情報をテーブルに一覧表示します。

• 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

delete

概要

この操作は 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