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 je ve stejném umístění, ve kterém je nástroj používán, generován soubor protokolu.

Struktura

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

java –jar gaxclc.jar -u:uživatel -p:heslo -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 serveru s konfigurací.
• -p:heslo je heslo pro přihlášení k serveru s konfigurací. 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:heslo -h:localhost:8080 spd execute 10054 1 "C:/GAX/input.txt"

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:uživatel -p:heslo -s -h:<host>:<port> spd add "cesta k souboru"

• "cesta k souboru" - cesta k souboru XML.

Příklad

java -jar gaxclc.jar -u:default -p:heslo 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:uživatel -p:heslo -s -h:<host>:<port> spd query

Příklad

java -jar gaxclc.jar -u:default -p:heslo -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:uživatel -p:heslo -s -h:<host>:<port> spd query SPDID

• SPDID - ID definice SPD, na kterou je odesílán dotaz.

Příklad

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

execute

Přehled

Tato operace spustí definici SPD.

Formát

java –jar gaxclc.jar -u:uživatel -p:heslo -s -h:<host>:<port> spd execute SPDID profileName|-profileID:IDprofilu|-profileName:názevProfilu -encrypted "vstupní soubor"

• SPDID - ID spouštěné definice SPD.
• profileName|-profileID:IDprofilu|-profileName:názevProfilu - spouštěný profil 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:uživatel -p:heslo -s -h:<host>:<port> spd encrypt "cesta ke vstupnímu souboru" "cesta k zašifrovanému výstupnímu souboru"

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:heslo spd -encrypted "c:\GAX\input.txt" "c:\GAX\encrypted.txt"

java -jar gaxclc.jar -u:default -p:heslo spd -encrypted "input.txt" "encrypted.txt"

• "vstupní soubor" - určuje vstupní soubor obsahující parametry 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 zakódován ve formátu UTF-8.

[+] Zobrazit používání

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>

  
  

Příklad

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

java -jar gaxclc.jar -u:default -p:heslo -h:localhost:8080 spd execute 10054 -profileName:"Install profile" "C:/GAX/input.txt"

java -jar gaxclc.jar -u:default -p:heslo -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:uživatel -p:heslo -s -h:<host>:<port> spd delete SPDID

• SPDID - ID definice SPD, kterou chcete odstranit.

Příklad

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

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:uživatel -p:heslo -s -h:<host>:<port> ip add "cesta k souboru ZIP balíčku IP"

Příklad

java -jar gaxclc.jar -u:default -p:heslo 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,
• OS,
• místní nastavení,
• stav.

Formát

java –jar gaxclc.jar -u:uživatel -p:heslo -s -h:<host>:<port> ip query

Příklad

java -jar gaxclc.jar -u:default -p:heslo -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,
• OS,
• místní nastavení,
• stav.

Formát

java –jar gaxclc.jar -u:uživatel -p:heslo -s -h:<host>:<port> ip query IPID

• IPID - ID balíčku IP, na který chcete poslat dotaz.

Příklad

java -jar gaxclc.jar -u:default -p:heslo -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:uživatel -p:heslo -s -h:<host>:<port> ip delete IPID

• IPID - ID balíčku IP, který chcete odstranit.

Příklad

java -jar gaxclc.jar -u:uživatel -p:heslo ip delete 547

category:Genesys Administrator Extension category:Genesys Administrator Extension Help