Использование консоли командной строки (CLC)

Консоль командной строки (CLC) позволяет администраторам использовать командную строку для выполнения определенных функций GAX с определениями решений (SPD) и установочными пакетами (УП). Например, с помощью консоли командной строки можно выполнять скрытое развертывание SPD на удаленных хостах.

Для использования консоли командной строки необходимо иметь доступ к интерфейсу командной строки операционной системы. Если вы работаете не на машине хоста 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 — имя пользователя для входа на сервер конфигурации.
• -p:password — пароль для входа на сервер конфигурации. Инструмент CLC предполагает, что пароль отсутствует, если для данного идентификатора не указано значение.
• -s предписывает CLC использовать безопасное подключение https к серверу GAX. Если этот идентификатор не указан, инструмент 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

Инструмент CLC поддерживает следующие операции для SPD:

• add
• query
• querybyid
• execute
• delete
• encrypt (см. вкладку execute)

add

Обзор

Данная операция добавляет SPD в базу данных GAX. Если SPD уже существует, как показывает имя и версия в SPD XML, данная операция заменяет существующий SPD.

В случае успешного выполнения операция возвращает идентификатор добавленного SPD.

Формат

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd add "путь к файлу"

•  Путь к файлу — путь к файлу XML.

Пример

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

query

Обзор

Данная операция запрашивает все SPD и отображает таблицу, которая содержит следующие данные для каждого SPD.

• Идентификационный номер
• Имя
• Версия
• 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 по идентификатору. Если SPD не существует, происходит сбой операции.

В случае успешного выполнения операция выводит на экран таблицу, которая содержит следующие сведения о SPD.

• Идентификатор профиля
• Имя

Например:

1 Install

Формат

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

• SPDID — идентификатор запрашиваемого SPD.

Пример

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 "файл ввода"

• SPDID — идентификатор выполняемого SPD.
• 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 "путь к файлу ввода" "путь к зашифрованному файлу вывода"

Зашифрованный файл ввода хранится в месте, определяемом параметром путь к зашифрованному файлу вывода. Если файл уже существует в данном местоположении, он будет перезаписан.

Пример.

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"

• файл ввода — указывает файл ввода, который содержит параметры SPD. Если идентификатор -encrypted задан, файл ввода будет зашифрован.

Файл ввода должен иметь формат JSONObject и содержать параметры SPD для конкретного профиля. Файл должен быть закодирован в формате UTF-8.

[+] Показать данные об использовании

The input file must be in JSONObject format and include SPD parameters for a specific profile. The file must be encoded in UTF-8 format.

The input structure for a string type is described below:

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

Example

SPD Profile

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

Input File for Install Profile

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

The input structure for a boolean type is described below:

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

Example

SPD Profile

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

Input File for Install Profile

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

The input structure for an integer type is described below:

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

Example

SPD Profile

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

Input File for Install Profile

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

The input structure for a password type is described below:

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

Important

Input files that include sensitive data such as passwords should be encrypted using the SPD encrypt operation.

Example

SPD Profile

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

Input File for Install Profile

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

The input structure for a selectOne type with an <objectselect> tag is described bellow:

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

Important

CLC intersects (AND) filters defined in the SPD file and input file for a selectOne input. The filter criteria should be different in an SPD input file and filter names should differ in the same filter definition.

Example

SPD Profile

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

Input File for Install Profile

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

The input structure for a selectMultiple type with <objectselect> tag is described below:

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

Filters defined in an SPD input file are joined in union (OR) and then intersect (AND) with filters defined in an SPD file for a selectMultiple input.

Example

SPD Profile

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

Input File for Install Profile

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

The operation returns two applications named SIP_lrm26 and SIP_lrm27.

The input structure for a selectOne/selectMultiple/boolean type with <selection> tag is described below:

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

CLC selects options defined in the SPD input file. Multiple options can be specified only for the selectMultiple input type.

Example

SPD Profile

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

Input File for Install Profile

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

Important

• If the input file does not specify a value for a SPD parameter, the value defined in the default attribute of the input element will be used.
• If an SPD input element has the required attribute set to true, but there is no corresponding input value that is supplied in either the SPD (as a default) or in the input file, then the SPD execution fails.
• If an SPD input element has the readonly attribute value set to true, then the value in the default attribute value is used for the execution, if defined. If the readonly attribute value is set to true, required is set to false, and the default attribute is not defined, then the following logic is used for input value determination:
  1. For the boolean input type, the input value is set to false.
  2. For the string and password input types, the input value is set to "".
  3. For the integer input type, the input is not propagated.
• If a dialog cond attribute value evaluates to false, the dialog is skipped by the CLC tool. Example:

   <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:"Профиль установки" "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.

Пример

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

УП

Инструмент CLC поддерживает следующие операции для функции ip:

• add
• query
• querybyid
• delete

add

Обзор

Данная операция добавляет установочный пакет (в виде файла .zip) в базу данных GAX. Если установочный пакет уже существует, он будет заменен.

В случае успешного выполнения операция выводит на экран идентификатор установочного пакета.

Important

Файл ZIP должен содержать установочный пакет и папку шаблонов для него.

Формат

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> ip add "путь к файлу ZIP с УП"

Пример

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

query

Обзор

Данная операция запрашивает все УП и отображает таблицу, которая содержит следующие данные для каждого УП.

• Идентификационный номер
• Имя
• Версия
• ОС
• Регион
• Состояние

Формат

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

Обзор

Данная операция запрашивает УП по идентификатору и отображает таблицу, которая содержит следующие данные.

• Идентификационный номер
• Имя
• Версия
• ОС
• Регион
• Состояние

Формат

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

• IPID — идентификатор запрашиваемого УП.

Пример

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

delete

Обзор

Данная операция удаляет УП.

Формат

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

• IPID — идентификатор удаляемого УП.

Пример

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help