Používání konzoly příkazového řádku (CLC)

Konzola příkazového řádku (CLC) umožňuje správcům používat příkazový řádek k provádění určitých funkcí aplikace GAX s definicemi řešení (SPD) a instalačními balíčky (IP). Konzolu CLC můžete použít například k bezobslužnému nasazování definic SPD na vzdálené hostitele.

Abyste mohli konzolu CLC používat, musíte mít přístup k rozhraní příkazového řádku operačního systému. Pokud počítač, který používáte, není hostitelem aplikace GAX, musíte mít v místním počítači k dispozici nástroj CLC (gaxclc.jar).

Chcete-li zobrazit soubor nápovědy integrovaný v konzole CLC, použijte některý z následujících příkazů:

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

Important

Při vytváření příkazů v konzole CLC se ve stejném umístění také generuje soubor protokolu.

Struktura

Konzola CLC podporuje příkazy s následující strukturou:

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> <function> <operation> <args>

Ve výše uvedeném příkladu:

• -u:uživatel je uživatelské jméno pro přihlášení k aplikaci Configuration Server.
• -p:heslo je heslo pro přihlášení k aplikaci Configuration Server. Pokud tento příznak nezadává žádnou hodnotu, konzola CLC bude předpokládat, že heslo neexistuje.
• -s přikazuje konzole CLC použít zabezpečené připojení https k serveru GAX. Pokud tento příznak není zadán, konzola CLC použije protokol http.
• -h:<host>:<port>určuje hostitele a port serveru GAX. Pokud tento příznak není zadán, konzola CLC použije následující hodnotu: -h:localhost:8080.
• <function> může být buď ip, nebo spd.
• <operation> určuje prováděnou operaci. Platné hodnoty pro tento příznak jsou specifické pro funkci, kterou jste určili v předchozím kroku (ip nebo spd).
• <args> určuje argumenty operace. Platné hodnoty pro tento příznak jsou specifické pro parametry <function> a <operation>, které jste určili v předchozích krocích.

Následuje příklad příkazu CLC:

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

Definice SPD

Konzola CLC podporuje následující operace pro definice SPD:

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

add

Přehled

Tato operace přidá definici SPD do databáze GAX. Pokud definice SPD již existuje (lze poznat podle názvu a verze v souboru XML definice SPD), tato operace existující definici SPD nahradí.

Pokud je operace úspěšná, vrátí ID přidané definice SPD.

Formát

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

• "file path"— – cesta k souboru XML.

Příklad

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

query

Přehled

Tato operace pošle dotaz na všechny definice SPD a zobrazí tabulku, která bude uvádět seznam následujících informací o každé definici SPD:

• Číslo ID
• Název
• Verze
• DBID klienta

Následuje příklad:

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

Formát

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

Příklad

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

querybyid

Přehled

Tato operace posílá dotaz na definici SPD podle jejího ID. Pokud definice SPD neexistuje, operace bude neúspěšná.

Pokud je operace úspěšná, zobrazí tabulku se seznamem následujících podrobností o definici SPD:

• ID profilu:
• Název

Například:

1 Install

Formát

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

• SPDID – ID dotazované definice SPD.

Příklad

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

execute

Přehled

Tato operace spustí definici SPD.

Formát

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

• SPDID – ID spouštěné definice SPD.
• profileName|-profileID:profileID|-profileName:profileName – spouštěný profil definice SPD.

Important

Pokud není určen žádný příznak, pak je název profileName považován za profil SPD, který má být spuštěn.

• -encrypted – pokud je tento příznak zadán, vstupní soubor je šifrován.

[+] Zobrazit používání

Konzola CLC poskytuje podporu pro vstupní soubory obsahující citlivá data, jakými jsou například hesla.

Formát:

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

Zašifrovaný vstupní soubor bude uložen do místa určeného proměnnou "cesta k zašifrovanému výstupnímu souboru". Pokud soubor v tomto umístění již existuje, bude přepsán.

Příklad:

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"— – určuje vstupní soubor obsahující parametry definice SPD. Pokud je zadán příznak -encrypted, vstupní soubor je šifrován.

Vstupní soubor musí být ve formátu JSONObject a obsahovat parametry SPD pro konkrétní profil. Soubor musí být kódován ve formátu UTF-8.

[+] Zobrazit používání

Typ STRING

Struktura zadání pro typ string (řetězec) je popsána níže:

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

Příklad

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

Vstupní soubor pro instalaci profilu

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

Typ BOOLEAN

Struktura zadání pro typ boolean (logická hodnota) je popsána níže:

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

Příklad

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

Vstupní soubor pro instalaci profilu

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

Typ INTEGER

Struktura zadání pro typ integer (celé číslo) je popsána níže:

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

Příklad

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

Vstupní soubor pro instalaci profilu

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

Typ PASSWORD

Struktura zadání pro typ password (heslo) je popsána níže:

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

Important

Vstupní soubory zahrnující citlivá data, jako jsou například hesla, by měly být šifrovány pomocí operace šifrování SPD.

Příklad

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

Vstupní soubor pro instalaci profilu

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

Typ SELECTONE

Vstupní struktura pro typ selectOne (vybrat jeden) se značkou <objectselect> je popsána níže:

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

Important

Konzola CLC protíná filtry (A) definované v souboru SPD a vstupním souboru pro vstup selectOne. Kritéria filtrování by měla být ve vstupním souboru SPD odlišná a názvy filtrů by se měly lišit v rámci stejné definice filtrů.

Příklad

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

Vstupní soubor pro instalaci profilu

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

Typ SELECTMULTIPLE

Struktura zadání pro typ selectMultiple (výběr více) se značkou <objectselect> je popsána níže:

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

Filtry definované ve vstupním souboru SPD jsou spojeny sjednocením (NEBO) a poté průnikem (A) s filtry definovanými v souboru SPD pro typ selectMultiple.

Příklad

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

Vstupní soubor pro instalaci profilu

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

Operace vrátí dvě aplikace s názvem SIP_lrm26 a SIP_lrm27.

Typ SELECTONE

Struktura zadání pro typ selectOne/selectMultiple/boolean se značkou <selection> je popsána níže:

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

Konzola CLC vybírá možnosti definované ve vstupním souboru SPD. Více možností lze zvolit pouze pro typ vstupu selectMultiple.

Příklad

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

Vstupní soubor pro instalaci profilu

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

Important

• Pokud vstupní soubor neurčuje hodnotu pro parametr SPD, bude použita hodnota definovaná v atributu default (výchozí) vstupního prvku.
• Pokud má vstupní prvek SPD atribut required (požadováno) nastaven na hodnotu true (pravda), ale neexistuje korespondující vstupní hodnota poskytovaná souborem SPD (jako výchozí) nebo vstupním souborem, provedení definice SPD bude neúspěšné.
• Pokud má vstupní prvek SPD atribut readonly (pouze ke čtení) nastaven na hodnotu true (pravda), bude pro spuštění použita hodnota atributu default (výchozí), pokud je definována. Pokud je atribut readonly (pouze ke čtení) nastaven na hodnotu true, možnost required (požadováno) je nastavena na možnost false (nepravda) a atribut default (výchozí) není definován, je k zjištění hodnoty vstupu použita následující logika:
  1. V případě vstupního typu boolean je vstupní hodnota nastavena na hodnotu false.
  2. V případě vstupního typu string a password je vstupní hodnota nastavena na hodnotu "".
  3. V případě vstupního typu integer není vstup rozšiřován.
• Pokud je hodnota atributu cond dialogového okna vyhodnocena jako nepravda, dialogové okno bude nástrojem CLC vynecháno. Příklad:

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

  
  

Příklad

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

Přehled

Tato operace odstraní definici SPD. Pokud definice SPD neexistuje, operace bude neúspěšná.

Formát

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

• SPDID – ID odstraňované definice SPD.

Příklad

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

Instalační balíčky (IP)

Konzola CLC podporuje následující operace pro funkci ip:

• add
• query
• querybyid
• delete

add

Přehled

Tato operace přidá do databáze GAX balíček IP (zabalený jako soubor ZIP). Pokud balíček IP již existuje, bude nahrazen.

Pokud je operace úspěšná, zobrazí ID balíčku IP.

Important

Soubor ZIP musí obsahovat balíček IP a složku šablon pro balíček IP.

Formát

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

Příklad

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

query

Přehled

Tato operace pošle dotaz na všechny balíčky IP a zobrazí tabulku, která bude uvádět seznam následujících podrobností o každém balíčku IP:

• Číslo ID
• Název
• Verze
• Operační systém
• Místní nastavení
• Stav

Formát

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

Příklad

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

querybyid

Přehled

Tato operace pošle dotaz na balíček IP podle jeho ID a zobrazí tabulku, která bude uvádět seznam následujících podrobností:

• Číslo ID
• Název
• Verze
• Operační systém
• Místní nastavení
• Stav

Formát

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

• IPID – ID dotazovaného balíčku IP.

Příklad

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

delete

Přehled

Tato operace odstraní balíček IP.

Formát

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

• IPID – ID odstraňovaného balíčku IP.

Příklad

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help