Uso de la Consola de línea de comandos (CLC)

La Consola de línea de comandos (CLC) permite a los administradores el uso de la línea de commandos para ejecutar ciertas funciones de GAX en las definiciones de solución (SPD) y paquetes de instalación (IP). Por ejemplo, puede usar la CLC para implementar sin aviso un SPD en host remotos.

Debe estar en capacidad de acceder a la interfaz de línea de comandos del sistema operativo para usar la CLC. Si no se encuentra en la máquina host de GAX, debe tener la herramienta de la CLC (gaxclc.jar) disponible en la máquina local.

Para acceder al archivo de Ayuda insertado en la CLC, ejecute uno de los siguientes comandos:

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

Importante

A medida que se ejecutan comandos con la CLC, se genera un archivo de registro en la misma ubicación en la que se ejecuta la herramienta.

Estructura

La CLC admite comandos que usan la siguiente estructura:

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

En el ejemplo anterior:

• -u:user es el nombre de usuario para iniciar sesión en Configuration Server.
• -p:password es la contraseña para iniciar sesión en Configuration Server. La CLC asume que no hay contraseña si este indicador no especifica un valor.
• -s ordena a la CLC usar una conexión https segura al GAX server. Si no se especifica este indicador, la CLC usa http.
• -h:<host>:<port> especifica el host y el puerto del GAX server. Si no se especifica este indicador, la CLC usa el siguiente valor: -h:localhost:8080.
• <function> puede ser ip o spd.
• <operation> especifica la operación que se va a ejecutar. Los valores válidos para este indicador son específicos de la función especificada en los pasos anteriores (ip o spd).
• <args> especifica los argumentos de la operación. Los valores válidos para este indicador son específicos de la <function> y <operation> los parámetros especificados en los pasos anteriores.

El siguiente es un ejemplo de un comando de la CLC:

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

SPDs

La CLC admite las siguientes operaciones para SPD:

• agregar
• consultar
• consultarporID
• ejecutar
• eliminar
• encriptar (consulte la ficha ejecutar)

agregar

Generalidades

Esta operación agrega un SPD a la base de datos de GAX. Si el SPD ya existe, según lo determinado por el nombre y la versión en el SPD XML, esta operación reemplaza el SPD existente.

De tener éxito, la operación devuelve la ID del SPD agregado.

Formato

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

• "ruta de archivo"—La ruta al archivo XML.

Ejemplo

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

consulta

Generalidades

Esta operación consulta todos los SPD y muestra una tabla que incluye la siguiente información para cada SPD:

• Número de ID
• Nombre
• Versión
• DBID de compañía

El siguiente es un ejemplo:

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

Ejemplo

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

consultaporID

Generalidades

Esta operación consulta un SPD mediante su ID. Si no existe el SPD, falla la operación.

De tener éxito, la operación muestra una tabla que incluye los siguientes detalles sobre el SPD:

• ID del perfil
• Nombre

Por ejemplo:

1 Instalar

Formato

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

• SPDID—La ID del SPD que está siendo consultado.

Ejemplo

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

ejecutar

Generalidades

Esta operación ejecuta un 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—La ID del SPD que se va a ejecutar.
• profileName|-profileID:profileID|-profileName:profileName—El perfil del SPD que se va a ejecutar.

Importante

Si no está especificado ningún indicador, entonces se asume el profileName como el perfil del SPD que se va a ejecutar.

• -encriptado—Si está especificado, indica si el archivo de entrada está encriptado.

[+] Mostrar uso

La CLC provee soporte de encriptación para los archivos de entrada que incluyen datos confidenciales tales como contraseñas.

Formato:

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

El archivo de entrada encriptado se almacena en la ubicación especificada por la "ruta del archivo de salida encriptado". Si ya existe el archivo en esta ubicación, se reemplaza.

Ejemplo:

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"

• "archivo de entrada"—Especifica el archivo de entrada que contienen los parámetros de SPD. Si está configurado -encriptado, el archivo de entrada es encriptado.

El archivo de entrada debe estar en formato JSONObject y debe incluir los parámetros de SPD para un perfil específico. El archivo debe estar codificado en formato UTF-8.

[+] Mostrar uso

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

Importante

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

Importante

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

Importante

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

  
  

Ejemplo

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"

eliminar

Generalidades

Esta operación elimina un SPD. Si no existe un SPD, falla la operación.

Formato

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

• SPDID—La ID del SPD que se va a eliminar.

Ejemplo

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

IPs

La CLC admite las siguientes operaciones para la función ip:

• agregar
• consulta
• consultaporID
• eliminar

agregar

Generalidades

Esta operación agrega un IP (empaquetado en formato de archivo comprimido zip) a la base de datos de GAX. Si ya existe el IP, es reemplazado.

De tener éxito, la operación muestra la ID del IP.

Importante

El archivo comprimido zip debe contener el IP y la carpeta de plantillas para el IP.

Formato

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

Ejemplo

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

consulta

Generalidades

Esta operación consulta todos los IP y muestra una tabla que incluye los siguientes detalles para cada IP:

• Número de ID
• Nombre
• Versión
• OS
• Localización
• Estado

Formato

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

Ejemplo

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

consultaporID

Generalidades

Esta operación consulta un IP mediante su ID y muestra una tabla que incluye los siguientes detalles:

• Número de ID
• Nombre
• Versión
• OS
• Localización
• Estado

Formato

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

• IPID—La ID del IP que se va a consultar.

Ejemplo

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

eliminar

Generalidades

Esta operación elimina un IP.

Formato

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

• IPID—La ID del IP que se va a eliminar.

Ejemplo

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help