Używanie konsoli wiersza poleceń (CLC, Command Line Console)

Konsola wiersza poleceń umożliwia administratorom wykonywanie w konsoli wiersza poleceń (CLC) różnych funkcji aplikacji GAX w odniesieniu do definicji rozwiązań (SPD) oraz pakietów instalacyjnych (IP). Konsoli CLC można na przykład używać do cichego wdrażania definicji SPD na hostach zdalnych.

Aby korzystać z konsoli CLC, konieczny jest dostęp do interfejsu wiersza poleceń systemu operacyjnego. Jeśli użytkownik nie pracuje przy komputerze z zainstalowaną aplikacją GAX, na komputerze lokalnym konieczne jest użycie narzędzia CLC (gaxclc.jar).

Aby uzyskać dostęp do pliku pomocy wbudowanego w konsolę CLC, należy wykonać jedno z następujących poleceń:

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

Ważne

Podczas wykonywania poleceń w konsoli CLC w tej samej lokalizacji, z której jest uruchamiane narzędzie, jest generowany plik dziennika.

Składnia

Polecenia konsoli CLC mają następującą składnię:

java –jar gaxclc.jar -u:użytkownik -p:hasło -s -h:<host>:<port> <function> <operation> <args>

W powyższym przykładzie:

• -u:użytkownik to nazwa użytkownika, który loguje się do składnika Configuration Server.
• -p:hasło to hasło użytkownika, który loguje się do składnika Configuration Server. Jeśli dla tej flagi nie określono wartości, konsola CLC uznaje, że hasło nie zostało ustawione.
• -s informuje konsolę CLC, aby używać bezpiecznego połączenia https z serwerem GAX. Jeśli ta flaga nie jest określona, konsola CLC używa zwykłego połączenia http.
• -h:<host>:<port> informuje o hoście i porcie serwera GAX. Jeśli ta flaga nie jest określona, konsola CLC używa następujące wartości: -h:localhost:8080.
• <function> może mieć wartość ip lub spd.
• <operation> określa operację, która ma zostać wykonana. Prawidłowe wartości tej flagi zależą od funkcji określonej w poprzednim kroku (ip lub spd).
• <args> określa argumenty operacji. Prawidłowe wartości tej flagi zależą od parametrów <function> i <operation> określonych w poprzednich krokach.

Poniżej podano przykład polecenia konsoli CLC:

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

SPDs

Konsola CLC obsługuje następujące operacje dotyczące definicji SPD:

• add
• query
• querybyid
• execute
• delete
• encrypt (patrz karta execute)

add

Omówienie

Ta operacja powoduje dodanie definicji rozwiązania do bazy danych GAX. Jeśli definicja rozwiązania, zgodna z nazwą i wersją określoną w pliku XML definicji rozwiązania, już istnieje, ta operacja powoduje zastąpienie istniejącej definicji.

W przypadku powodzenia operacji jest zwracany identyfikator dodanej definicji rozwiązania.

Format

java –jar gaxclc.jar -u:użytkownik -p:hasło -s -h:<host>:<port> spd add "ścieżka pliku"

• "ścieżka pliku" — ścieżka do pliku XML.

Przykład

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

query

Omówienie

Wykonanie tej operacji powoduje odpytanie wszystkich definicji rozwiązań i wyświetlenie tabeli zawierającej poniższe dane definicji:

• Numer identyfikacyjny
• Nazwa
• Wersja
• Identyfikator bazy danych dzierżawcy

Poniżej podano przykład:

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

Format

java –jar gaxclc.jar -u:użytkownik-p:hasło -s -h:<host>:<port> spd query

Przykład

java -jar gaxclc.jar -u:default -p:hasło -s -h:132.45.43.45:443 spd query

querybyid

Omówienie

Wykonanie tej operacji powoduje odpytywanie definicji rozwiązań według identyfikatora. Jeśli definicja rozwiązania nie istnieje, operacja zakończy się niepowodzeniem.

W przypadku powodzenia operacji zostanie wyświetlona tabela zawierająca następujące szczegółowe dane o definicji rozwiązania:

• Identyfikator profilu
• Nazwa

Przykład:

1 Instalacja

Format

java –jar gaxclc.jar -u:użytkownik-p:hasło -s -h:<host>:<port> spd query SPDID

• SPDID — identyfikator odpytywanej definicji rozwiązania.

Przykład

java -jar gaxclc.jar -u:default -p:hasło -h:132.45.43.45:8080 spd query 4374

execute

Omówienie

Ta operacja uruchamia definicję rozwiązania.

Format

java –jar gaxclc.jar -u:użytkownik-p:hasło -s -h:<host>:<port> spd execute SPDID nazwaProfilu|-profileID:IDprofilu|-profileName:nazwaProfilu -encrypted "plik wejściowy"

• SPDID — identyfikator wykonywanej definicji SPD.
• nazwaProfilu|-profileID:IDprofilu|-profileName:nazwaProfilu — profil definicji rozwiązania, który ma zostać wykonany.

Ważne

Jeśli nie określono żadnej flagi, wtedy za parametr nazwaProfilu jest przyjmowana nazwa wykonywanego profilu SPD.

• -encrypted — jeśli określono, informuje, czy plik wejściowy jest szyfrowany.

[+] Pokaż użycie

Konsola CLC obsługuje szyfrowanie plików wejściowych, które zawierają dane poufne, takie jak hasła.

Format:

java –jar gaxclc.jar -u:użytkownik -p:hasło -s -h:<host>:<port> spd encrypt "ścieżka pliku wejściowego" "ścieżka szyfrowanego pliku wyjściowego"

Szyfrowany plik wejściowy znajduje się w lokalizacji określonej przez parametr "ścieżka szyfrowanego pliku wyjściowego". Jeśli plik już istnieje w tej lokalizacji, zostanie zastąpiony.

Przykład:

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

java -jar gaxclc.jar -u:default -p:hasło spd -encrypted "input.txt" "encrypted.txt"

• "plik wejściowy" — określa plik wejściowy zawierający parametry definicji rozwiązania. Jeśli flaga -encrypted jest ustawiona, plik wejściowy jest szyfrowany.

Plik wejściowy musi mieć format JSONObject i zawierać parametry definicji rozwiązania dotyczące konkretnego profilu. Plik musi być zakodowany w formacie UTF-8.

[+] Pokaż użycie

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

Ważne

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

Ważne

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

Ważne

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

  
  

Przykład

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

java -jar gaxclc.jar -u:default -p:hasło -h:localhost:8080 spd execute 10054 -profileName:"Profil instalacji" "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

Omówienie

Ta operacja powoduje usunięcie definicji rozwiązania. Jeśli definicja rozwiązania nie istnieje, operacja zakończy się niepowodzeniem.

Format

java –jar gaxclc.jar -u:użytkownik -p:hasło -s -h:<host>:<port> spd delete SPDID

• SPDID — identyfikator definicji SPD, która ma zostać usunięta.

Przykład

java -jar gaxclc.jar -u:default -p:hasło spd delete 5436

Pakiety instalacyjne

Konsola CLC obsługuje następujące operacje dotyczące funkcji ip (pakietów instalacyjnych):

• add
• query
• querybyid
• delete

add

Omówienie

Ta operacja powoduje dodanie pakietu instalacyjnego (spakowanego jako plik *.zip) do bazy danych aplikacji GAX. Jeśli pakiet instalacyjny już istnieje, zostanie zastąpiony.

W przypadku powodzenia operacji zostanie wyświetlony identyfikator pakietu instalacyjnego.

Ważne

Plik *.zip musi zawierać pakiet instalacyjny oraz folder szablonów pakietu.

Format

java –jar gaxclc.jar -u:użytkownik-p:hasło -s -h:<host>:<port> ip add "ścieżka do pliku zip z pakietem instalacyjnym"

Przykład

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

query

Omówienie

Wykonanie tej operacji powoduje odpytanie wszystkich pakietów instalacyjnych i wyświetlenie tabeli zawierającej poniższe dane szczegółowe pakietów:

• Numer identyfikacyjny
• Nazwa
• Wersja
• System operacyjny
• Ustawienia regionalne
• Stan

Format

java –jar gaxclc.jar -u:użytkownik-p:hasło -s -h:<host>:<port> ip query

Przykład

java -jar gaxclc.jar -u:default -p:hasło-s -h:132.45.43.45:443 ip query

querybyid

Omówienie

Wykonanie tej operacji powoduje odpytanie pakietu instalacyjnego i wyświetlenie tabeli zawierającej poniższe dane szczegółowe:

• Numer identyfikacyjny
• Nazwa
• Wersja
• System operacyjny
• Ustawienia regionalne
• Stan

Format

java –jar gaxclc.jar -u:użytkownik-p:hasło -s -h:<host>:<port> ip query IPID

• IPID — identyfikator odpytywanego pakietu instalacyjnego.

Przykład

java -jar gaxclc.jar -u:default -p:hasło -h:132.45.43.45:8080 ip query 543

delete

Omówienie

Ta operacja powoduje usunięcie pakietu instalacyjnego.

Format

java –jar gaxclc.jar -u:użytkownik-p:hasło -s -h:<host>:<port> ip delete IPID

• IPID — identyfikator usuwanego pakietu instalacyjnego.

Przykład

java -jar gaxclc.jar -u:default -p:hasło ip delete 547

category:Genesys Administrator Extension category:Genesys Administrator Extension Help