Utilizzo della console a riga di comando (CLC, Command Line Console)

La console a riga di comando (CLC) consente agli amministratori di utilizzare la riga di comando per eseguire alcune funzioni GAX su definizioni di soluzioni (SPD) e pacchetti di installazione (IP). Ad esempio, la console CLC potrebbe essere utilizzata per distribuire automaticamente SPD su host remoti.

Per utilizzare la console CLC è necessario poter accedere all'interfaccia della riga di comando del sistema. Se non si utilizza il computer host GAX, è necessario che lo strumento CLC (gaxclc.jar) sia disponibile sul computer locale.

Per accedere al file della Guida incorporato nello strumento CLC, eseguire uno dei comandi seguenti:

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

Importante

Quando si eseguono comandi con CLC, viene generato un file di registro nella stessa posizione in cui viene eseguito lo strumento.

Struttura

CLC supporta comandi che utilizzano la seguente struttura:

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

Nell'esempio precedente:

• -u:user è il nome utente per accedere al server di configurazione.
• -p:password è la password per accedere al server di configurazione. CLC presume che non vi sia alcuna password se questo flag non specifica un valore.
• -s indica a CLC di utilizzare una connessione https sicura sul server GAX. Se questo flag non è specificato, CLC utilizza http.
• -h:<host>:<port> specifica l’host e la porta del server GAX. Se questo flag non è specificato, CLC utilizza il valore seguente: -h:localhost:8080.
• <function> può essere ip o spd.
• <operation> specifica l’operazione da eseguire. I valori validi per questo flag sono specifici alla funzione indicata al punto precedente (ip o spd).
• <args> specifica gli argomenti dell’operazione. I valori validi per questo flag sono specifici ai parametri <function> e <operation> indicati nei passaggi precedenti.

Di seguito viene fornito un esempio di un comando CLC:

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

SPD

CLC supporta le operazioni seguenti per SPD:

• add
• query
• querybyid
• execute
• elimina
• encrypt (vedere la scheda execute)

add

Presentazione

Questa operazione consente di aggiungere una SPD al database GAX. Se la SPD esiste già, come determinato dal nome e dalla versione nel file XML SPD, questa operazione sostituisce la SPD esistente.

Se viene completata correttamente, l'operazione restituisce l'ID della SPD aggiunta.

Formato

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

• "file path"—Il percorso del file XML.

Esempio

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

query

Presentazione

Questa operazione esegue le query su tutte le SPD e visualizza una tabella con le informazioni seguenti per ogni SPD:

• Numero ID
• Nome
• Versione
• Tenant DBID

Di seguito viene fornito un esempio:

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

Formato

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

Esempio

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

querybyid

Presentazione

Questa operazione esegue query su una SPD mediante il relativo ID. Se la SPD non esiste, l'operazione non viene completata.

Se viene completata correttamente, l'operazione visualizza una tabella con le seguenti informazioni sulla SPD:

• ID profilo
• Nome

Ad esempio:

1 Install

Formato

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

• SPDID—l’ID della SPD oggetto della query.

Esempio

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

execute

Presentazione

Questa operazione consente di eseguire una SPD.

Formato

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

• SPDID—l’ID della SPD da eseguire.
• profileName|-profileID:profileID|-profileName:profileName—Il profilo SPD da eseguire.

Importante

Se non è specificato alcun flag, profileName viene considerato come il profilo SPD da eseguire.

• -encrypted—Se specificato, indica se il file di input è crittografato.

[+] Mostra utilizzo

Lo strumento CLC supporta la crittografia per i file di input che includono dati sensibili come password.

Formato:

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

Il file di input crittografato viene archiviato nella posizione specificata dal "percorso file di output crittografato". Se il file esiste già in questo percorso, viene sovrascritto.

Esempio:

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"

• "file di input"—specifica il file di input che contiene i parametri SPD. Se si imposta -encrypted, il file di input viene crittografato.

Il file di input deve essere nel formato JSONObject e includere parametri SPD per un determinato profilo. Il file deve essere codificato in formato UTF-8.

[+] Mostra utilizzo

Tipo STRINGA

La struttura di input per un valore di tipo stringa viene descritta di seguito:

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

Esempio

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

File di input a seconda del profilo di installazione

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

Tipo BOOLEANO

La struttura di input per un valore di tipo booleano viene descritta di seguito:

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

Esempio

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

File di input a seconda del profilo di installazione

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

Tipo NUMERO INTERO

La struttura di input per un valore di tipo numero intero viene descritta di seguito:

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

Esempio

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

File di input a seconda del profilo di installazione

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

Tipo PASSWORD

La struttura di input per un valore di tipo passwordviene descritta di seguito:

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

Importante

I file di input che contengono dati sensibili, quali password, devono essere crittografati utilizzando SPD.

Esempio

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

File di input a seconda del profilo di installazione

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

Tipo SELECTONE

La struttura di input per un valore di tipo selectOne con un tag <objectselect> viene descritta di seguito:

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

Importante

CLC opera un’intersezione (AND) tra i filtri definiti nel file SPD e nel file di input per un input selectOne. I criteri di filtro dovrebbero essere differenti in un file di input SPD e i nomi dei filtri dovrebbero variare nella stessa definizione di filtro.

Esempio

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

File di input a seconda del profilo di installazione

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

Tipo SELECTMULTIPLE

La struttura di input per un valore di tipo selectMultiple con un tag <objectselect> viene descritta di seguito:

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

I filtri definiti in un file di input SPD vengono uniti (OR) e quindi intersecati (AND) con i filtri definiti in un file SPD per un input di tipo selectMultiple.

Esempio

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

File di input a seconda del profilo di installazione

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

L’operazione restituisce due applicazioni chiamate SIP_lrm26 e SIP_lrm27.

Tipo SELECTONE

La struttura di input per un valore di tipo selectOne/selectMultiple/boolean con un tag <selection> viene descritta di seguito:

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

CLC seleziona le opzioni definite nel file SPD di input. Per specificare più opzioni è necessario utilizzare il tipo di input selectMultiple.

Esempio

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

File di input a seconda del profilo di installazione

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

Importante

• Se nel file di input non viene specificato un valore per un parametro SPD, verrà utilizzato il valore definito nell’attributo default dell’elemento di input.
• Se il valore dell'attributo required di un elemento di input SPD è impostato su vero, ma il valore di input corrispondente viene fornito nella SPD (come predefinito) o nel file di input, l'esecuzione della SPD non riesce.
• Se il valore dell'attributo readonly di un elemento di input SPD è impostato su vero, per l'esecuzione viene utilizzato il valore dell'attributo default, se definito. Se il valore dell'attributo readonly è impostato su vero, required è impostato su falso e l'attributo default non è definito, per determinare il valore di input viene utilizzata la seguente logica:
  1. Per gli input di tipo booleano, il valore di input è impostato su false.
  2. Per gli input di tipo stringa e password, il valore di input è impostato su "".
  3. Per gli input di tipo integer, l’input non viene propagato.
• Se il valore dell’attributo cond di una finestra di dialogo restituisce falso, la finestra viene ignorata dallo strumento CLC. Esempio:

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

  
  

Esempio

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"

elimina

Presentazione

Questa operazione elimina una SPD. Se la SPD non esiste, l'operazione non viene completata.

Formato

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

• SPDID—l’ID della SPD da eliminare.

Esempio

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

IP

CLC supporta le seguenti operazioni per la funzione ip:

• add
• query
• querybyid
• elimina

add

Presentazione

Questa operazione consente di aggiungere un pacchetto di installazione (IP) (sotto forma di file .zip) al database GAX. Se il pacchetto di installazione esiste già, viene sostituito.

Se viene completata correttamente, l'operazione visualizza l'ID del pacchetto di installazione.

Importante

Il file .zip deve contenere il pacchetto di installazione e la cartella dei modelli per il pacchetto di installazione.

Formato

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

Esempio

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

query

Presentazione

Questa operazione consente di eseguire le query su tutti i pacchetti di installazione e visualizza una tabella con le informazioni seguenti per ogni IP:

• Numero ID
• Nome
• Versione
• Sistema operativo
• Impostazioni internazionali
• Stato

Formato

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

Esempio

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

querybyid

Presentazione

Questa operazione consente di eseguire le query su un pacchetto di installazione mediante il relativo ID e visualizza una tabella con le informazioni seguenti:

• Numero ID
• Nome
• Versione
• Sistema operativo
• Impostazioni internazionali
• Stato

Formato

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

• IPID—l’ID dell’IP oggetto della query.

Esempio

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

elimina

Presentazione

Questa operazione elimina un IP.

Formato

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

• IPID—l’ID dell’IP oggetto da eliminare.

Esempio

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help