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

Command Line Console (CLC) позволяет администраторам использовать командную строку для выполнения определенных функций GAX с определениями решений (SPD) и установочными пакетами (IP). Например, с помощью консоли командной строки можно выполнять скрытое развертывание 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 использовать безопасное подключение 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;
• Удалить
• encrypt (см. вкладку операции execute).

add

Обзор

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

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

Формат

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

• "путь к файлу."—Путь к файлу 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 "input file"

• 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 "input 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"

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

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

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

Тип STRING

Ниже описывается структура входных данных для типа string.

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

Тип BOOLEAN

Ниже описывается структура входных данных для типа boolean.

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

Тип INTEGER

Ниже описывается структура входных данных для типа integer.

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

Тип PASSWORD

Ниже описывается структура входных данных для типа password.

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

Ниже описывается структура входных данных для типа selectOne с тегом <objectselect>.

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

Ниже описывается структура входных данных для типа selectMultiple с тегом <objectselect>.

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

К фильтрам, определенным в файле входных данных SPD, сначала применяется операция логического сложения (ИЛИ), а затем логического умножения (И) на фильтры, определенные в файле SPD для входных данных selectMultiple.

Пример

Профиль 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

Ниже описывается структура входных данных для типа selectOne, selectMultiple или boolean с тегом <selection>.

{
	"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 элемента входных данных.
• Если атрибут required элемента входных данных SPD имеет значение true, но соответствующее входное значение не указано ни в SPD (в качестве значения по умолчанию), ни в файле входных данных, выполнение SPD завершается сбоем.
• Если атрибут readonly элемента входных данных SPD имеет значение true, то при выполнении используется значение атрибута default, если оно определено. Если атрибут readonly имеет значение true, атрибут required — значение false, а атрибут default не определен, то для определения входного значения применяется описанная ниже логика.
  1. Для типа входных данных boolean устанавливается входное значение false.
  2. Для типов входных данных string и password устанавливается входное значение "".
  3. Для типа входных данных integer входное значение не устанавливается.
• Если значение атрибута 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 для удаления.

Пример

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

Установочные пакеты IP

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

• add;
• query;
• querybyid;
• Удалить

add

Обзор

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

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

Important

Файл .zip должен содержать 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.

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

Формат

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 по идентификатору и отображает таблицу, которая содержит следующие данные.

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

Формат

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

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

Пример

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.

Пример

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help