Verwendung der Befehlszeilenkonsole (CLC)

An der Befehlszeilenkonsole (CLC) können Administratoren bestimmte Funktionen von GAX für Lösungsdefinitionen (SPDs) und Installationspakete (IPs) ausführen. An der CLC können Sie beispielsweise SPDs im Hintergrund auf Remote-Hosts implementieren.

Die CLC können Sie nur verwenden, wenn Sie über Zugriff auf die Befehlszeilenoberfläche des Betriebssystems verfügen. Auf anderen Computern als dem GAX-Hostcomputer muss lokal das CLC-Tool (gaxclc.jar) verfügbar sein.

Die Hilfedatei für die CLC öffnen Sie mit einem der folgenden Befehle:

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

Wichtig

Bei der Ausführung von Befehlen an der CLC wird im Verzeichnis des Tools eine Protokolldatei erzeugt.

Struktur

Die CLC unterstützt Befehle mit der folgenden Struktur:

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

Im obigen Beispiel:

• -u:user ist der Benutzername für die Anmeldung bei Configuration Server.
• -p:password ist das Passwort für die Anmeldung bei Configuration Server. Wenn für dieses Flag kein Wert angegeben ist, geht die CLC davon aus, dass kein Passwort festgelegt wurde.
• -s gibt an die CLC die Anweisung aus, eine sichere HTTPS-Verbindung mit dem GAX-Server zu verwenden. Wenn dieses Flag nicht festgelegt ist, wird HTTP verwendet.
• -h:<host>:<port> bezeichnet Host und Port des GAX-Servers. Wenn dieses Flag nicht festgelegt ist, wird folgender Wert verwendet. -h:localhost:8080.
• <function> kann auf ip oder auf spd festgelegt sein.
• <operation> gibt den auszuführenden Wert an. Die gültigen Werte für dieses Flag sind von der im vorherigen Schritt angegebenen Funktion abhängig (ip oder spd).
• <args> gibt die Argumente für den Vorgang an. Die gültigen Werte für dieses Flag sind von den in den vorherigen Schritten angegebenen Parametern <function> und <operation> abhängig.

Nachstehend finden Sie ein Beispiel für einen Befehlszeilenkonsolen-Befehl:

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

SPDs

Die CLC unterstützt die folgenden Vorgänge für SPDs:

• add
• query
• querybyid
• execute
• delete
• encrypt (siehe Registerkarte Ausführen)

add

Übersicht

Mit diesem Vorgang wird der GAX-Datenbank eine SPD hinzugefügt. Wenn anhand von Name und Version in der SPD-XML festgestellt wird, dass die SPD bereits vorhanden ist, wird die vorhandene SPD ersetzt.

Bei erfolgreichem Abschluss wird die ID der hinzugefügten SPD zurückgegeben.

Format

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

• "file path": Der Pfad der XML-Datei.

Beispiel

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

query

Übersicht

Mit diesem Vorgang werden alle SPDs abgefragt und eine Tabelle mit den folgenden Angaben zu jeder SPD angezeigt:

• ID-Nummer
• Name
• Version
• Mandanten-DBID

Beispiel:

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

Beispiel

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

querybyid

Übersicht

Mit diesem Vorgang wird eine SPD anhand ihrer ID abgefragt. Wenn die SPD nicht vorhanden ist, schlägt der Vorgang fehl.

Bei erfolgreichem Abschluss wird eine Tabelle der folgenden Details zur SPD angezeigt:

• Profil-ID
• Name

Beispiel:

1 Install

Format

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

• SPDID: Die ID der abgefragten SPD.

Beispiel

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

execute

Übersicht

Mit diesem Vorgang wird eine SPD ausgeführt.

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: Die ID der auszuführenden SPD.
• profileName|-profileID:profileID|-profileName:profileName: Das auszuführende SPD-Profil.

Wichtig

Wenn kein Flag festgelegt ist, wird als auszuführendes SPD-Profil profileName angenommen.

• -encrypted: Gibt ggf. an, ob die Eingabedatei verschlüsselt ist.

[+] Nutzung einblenden

Die CLC unterstützt Verschlüsselung für Eingabedateien mit vertraulichen Daten wie Passwörtern.

Format:

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

Die verschlüsselte Eingabedatei wird in dem durch "encrypted output file path" angegebenen Verzeichnis gespeichert. Wenn die Datei in diesem Verzeichnis bereits vorhanden ist, wird sie überschrieben.

Beispiel:

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": Die Eingabedatei mit SPD-Parametern. Bei Angabe von -encrypted ist die Eingabedatei verschlüsselt.

Die Eingabedatei muss im JSONObject-Format vorliegen und SPD-Parameter für ein bestimmtes Profil enthalten. Die Datei muss im UTF8-Format vorliegen.

[+] Nutzung einblenden

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

Wichtig

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

Wichtig

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

Wichtig

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

  
  

Beispiel

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

Übersicht

Mit diesem Vorgang wird eine SPD gelöscht. Wenn die SPD nicht vorhanden ist, schlägt der Vorgang fehl.

Format

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

• SPDID: Die ID der zu löschenden SPD.

Beispiel

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

IPs

Die CLC unterstützt die folgenden Vorgänge für die IP-Funktion:

• add
• query
• querybyid
• delete

add

Übersicht

Mit diesem Vorgang wird der GAX-Datenbank ein (als ZIP-Paket vorliegendes) IP hinzugefügt. Wenn das IP bereits vorhanden ist, wird es überschrieben.

Bei erfolgreichem Abschluss wird die ID des IP angezeigt.

Wichtig

Die ZIP-Datei muss das IP und den Vorlagenordner für das IP enthalten.

Format

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

Beispiel

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

query

Übersicht

Mit diesem Vorgang werden alle IPs abgefragt und es wird eine Tabelle mit den folgenden Angaben zu jedem IP angezeigt:

• ID-Nummer
• Name
• Version
• BS
• Gebiet
• Status

Format

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

Beispiel

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

querybyid

Übersicht

Mit diesem Vorgang wird ein IP anhand seiner ID abgefragt und eine Tabelle mit den folgenden Angaben zu jedem IP angezeigt:

• ID-Nummer
• Name
• Version
• BS
• Gebiet
• Status

Format

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

• IPID: Die ID des abgefragten IP.

Beispiel

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

delete

Übersicht

Mit diesem Vorgang wird ein IP gelöscht.

Format

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

• IPID: Die ID des zu löschenden IP.

Beispiel

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help