Używanie konsoli wiersza polecenia (CLC)

Konsola wiersza polecenia (Command Line Console, CLC) umożliwia administratorom wykonywanie z poziomu wiersza polecenia 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 polecenia 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:user -p:password -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 przyjmuje, że hasło nie zostało ustawione.
• -s wskazuje, że w konsoli CLC ma być używane bezpieczne połączenie https z serwerem GAX. Jeśli ta flaga nie jest określona, konsola CLC używa zwykłego połączenia http.
• -h:<host>:<port> wskazuje host i port serwera GAX. Jeśli ta flaga nie jest określona, w konsoli CLC są używane 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:password -h:localhost:8080 spd execute 10054 1 "C:/GAX/input.txt"

Operacje SPD

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

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

add

Przegląd

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

W przypadku powodzenia operacji jest zwracany identyfikator dodanej definicji SPD.

Format

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

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

Przykład

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

query

Przegląd

Ta operacja powoduje wykonanie zapytania dotyczącego wszystkich definicji SPD i wyświetlenie tabeli zawierającej następujące dane definicji SPD:

• Identyfikator
• Nazwa
• Wersja
• Identyfikator BD dzierżawcy

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:user -p:password -s -h:<host>:<port> spd query

Przykład

java -jar gaxclc.jar -u:default -p:password -s -h:132.45.43.45:443 spd query

querybyid

Przegląd

Ta operacja powoduje wykonanie zapytania dotyczącego definicji SPD według identyfikatora. Jeśli definicja SPD nie istnieje, operacja zakończy się niepowodzeniem.

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

• Identyfikator profilu
• Nazwa

Przykład:

1 Install

Format

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

• SPDID — identyfikator definicji SPD, której dotyczy zapytanie.

Przykład

java -jar gaxclc.jar -u:default -p:password -h:132.45.43.45:8080 spd query 4374

execute

Przegląd

Ta operacja wykonuje definicję SPD.

Format

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd execute SPDID profileName|-profileID:profileID|-profileName:profileName -encrypted "input file"

• SPDID — identyfikator wykonywanej definicji SPD.
• profileName|-profileID:IDprofilu|-profileName:nazwaProfilu — profil SPD do wykonania.

Ważne

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

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

[+] Pokaż składnię

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

Format:

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

Szyfrowane pliki wejściowe są przechowywane w lokalizacji określonej przez parametr "encrypted output file path". Jeśli plik już istnieje w tej lokalizacji, zostanie zastąpiony.

Przykład:

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"— określa plik wejściowy zawierający parametry definicji SPD. Jeśli flaga -encrypted jest ustawiona, plik wejściowy jest szyfrowany.

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

[+] Pokaż składnię

Typ STRING

Poniżej opisano strukturę wejściową typu string (ciąg znaków):

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

Przykład

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

Plik wejściowy na potrzeby profilu instalacji

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

Typ BOOLEAN

Poniżej opisano strukturę wejściową typu boolean (typ logiczny):

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

Przykład

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

Plik wejściowy na potrzeby profilu instalacji

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

Typ INTEGER

Poniżej opisano strukturę wejściową typu integer (liczba całkowita):

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

Przykład

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

Plik wejściowy na potrzeby profilu instalacji

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

Typ PASSWORD

Poniżej opisano strukturę wejściową typu password (hasło):

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

Ważne

Pliki wejściowe zawierające dane poufne, takie jak hasła, powinny być szyfrowane przy użyciu operacji szyfrowania definicji SPD.

Przykład

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

Plik wejściowy na potrzeby profilu instalacji

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

Typ SELECTONE

Poniżej opisano strukturę wejściową typu selectOne (wybór jednokrotny) ze znacznikiem <objectselect>:

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

Ważne

Konsola CLC nakłada na siebie (operator logiczny AND) filtry zdefiniowane w pliku definicji SPD oraz pliku wejściowym dla typu selectOne. Kryteria filtrowania powinny być inne w pliku wejściowym definicji SPD, a nazwy filtrów w obrębie tej samej definicji filtru powinny się różnić.

Przykład

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

Plik wejściowy na potrzeby profilu instalacji

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

Typ SELECTMULTIPLE

Poniżej opisano strukturę wejściową typu selectMultiple (wybór wielokrotny) ze znacznikiem <objectselect>:

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

Filtry zdefiniowane w pliku wejściowym definicji SPD są łączone (operator logiczny OR) lub nakładane na siebie (operator logiczny AND) z filtrami zdefiniowanymi w pliku wejściowym dla typu selectMultiple.

Przykład

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

Plik wejściowy na potrzeby profilu instalacji

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

Operacja zwraca dwie aplikacje o nazwach SIP_lrm26 i SIP_lrm27.

Typ SELECTONE

|Poniżej opisano strukturę wejściową typu selectOne/selectMultiple/boolean ze znacznikiem <selection>:

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

Konsola CLC wybiera opcje zdefiniowane w pliku wejściowym definicji SPD. Wiele opcji można określić tylko dla typu wejścia selectMultiple.

Przykład

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

Plik wejściowy na potrzeby profilu instalacji

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

Ważne

• Jeśli w pliku wejściowym nie określono wartości parametru SPD, zostanie użyta wartość zdefiniowana atrybutem default elementu wejściowego.
• Jeśli w elemencie wejściowym SPD atrybut required jest ustawiony na true, ale odpowiednia wartość wejściowa nie znajduje się ani w definicji SPD (domyślnie), ani w pliku wejściowym, wykonywanie definicji SPD kończy się niepowodzeniem.
• Jeśli w elemencie wejściowym SPD atrybut readonly jest ustawiony na true, wtedy podczas wykonywania jest używana wartość atrybutu default (pod warunkiem że ją zdefiniowano). Jeśli atrybut readonly jest ustawiony na true, atrybut required na false, a atrybut default nie został określony, do wyznaczenia wartości wejściowej jest stosowany następujący algorytm:
  1. W przypadku typu wejściowego boolean wartość wejściowa jest ustawiana na false.
  2. W przypadku typów wejściowych string i password wartość wejściowa jest ustawiana na "".
  3. W przypadku typu wejściowego integer wejście nie jest propagowane.
• Jeśli wartość atrybutu cond okna dialogowego jest obliczana jako false, okno dialogowe jest pomijane przez narzędzie CLC. Przykład:

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

Przegląd

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

Format

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

• SPDID — identyfikator usuwanej definicji SPD.

Przykład

java -jar gaxclc.jar -u:default -p:password 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

Przegląd

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:user -p:password -s -h:<host>:<port> ip add "path to IP zip file"

Przykład

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

query

Przegląd

Ta operacja powoduje wykonanie zapytania dotyczącego wszystkich pakietów instalacyjnych i wyświetlenie tabeli zawierającej następujące szczegóły pakietów:

• Identyfikator
• Nazwa
• Wersja
• System operacyjny
• Ustawienia regionalne
• Status

Format

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

Przykład

java -jar gaxclc.jar -u:default -p:password -s -h:132.45.43.45:443 ip query

querybyid

Przegląd

Ta operacja powoduje wykonanie zapytania dotyczącego pakietu instalacyjnego według jego identyfikatora i wyświetlenie tabeli zawierającej następujące szczegóły:

• Identyfikator
• Nazwa
• Wersja
• System operacyjny
• Ustawienia regionalne
• Status

Format

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

• IPID — identyfikator pakietu, którego dotyczy zapytanie.

Przykład

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

delete

Przegląd

Ta operacja powoduje usunięcie pakietu instalacyjnego.

Format

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

• IPID — identyfikator pakietu do usunięcia.

Przykład

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help