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

Mediante la Consola de línea de comandos (CLC), los administradores pueden usar la línea de comandos para ejecutar algunas funciones de GAX en las definiciones de solución (SPD) y paquetes de instalación (IP). Por ejemplo, puede utilizar la CLC para implementar sin aviso las SPD en hosts remotos.

Para poder usar la CLC, debe tener acceso a la interfaz de línea de comandos del sistema operativo. Si no está en la máquina que aloja GAX, debe tener la herramienta CLC (gaxclc.jar) disponible en la máquina local.

Para tener acceso al archivo incorporado de ayuda de CLC, ejecute alguno de los siguientes comandos:

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

Importante

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

Estructura

La CLC es compatible con los comandos que utilizan la siguiente estructura:

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

En el ejemplo previo:

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

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"

Las SPD

La CLC es compatible con las siguientes operaciones para las SPD:

• agregar
• consultar
• querybyid
• ejecutar
• eliminar
• encrypt (consulte la ficha execute)

agregar

Generalidades

Esta operación agrega una SPD a la base de datos de GAX. Si ya existe la SPD, en función del nombre y la versión del XML de la SPD, esta operación reemplaza la SPD existente.

Si es correcta, la operación proporciona el ID de la SPD que se agregó.

Formato

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

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

Ejemplo

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

consultar

Generalidades

Esta operación hace una consulta a todas las SPD y muestra una tabla con la siguiente información para cada SPD:

• Número de ID
• Nombre
• Versión
• DBID de la empresa

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

querybyid

Generalidades

Esta operación hace una consulta a una SPD por su ID. Si no existe la SPD, la operación no será correcta.

Si es correcta, la operación mostrará una tabla con la siguiente información de la SPD:

• ID del perfil
• Nombre

Por ejemplo:

1 Install

Formato

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

• SPDID—El ID de la SPD por la que se realizó la consulta.

Ejemplo

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

ejecutar

Generalidades

Esta operación ejecuta 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—El ID de la SPD que se ejecutará.
• profileName|-profileID:profileID|-profileName:profileName—El perfil SPD que se ejecutará.

Importante

Si no se especifica ningún indicador, se asume que profileName será el perfil de la SPD que se ejecutará.

• -encrypted—Si se especifica, indica si el archivo de entrada está encriptado.

[+] Mostrar uso

La CLC proporciona un soporte de encriptación para los archivos de entrada que incluyen datos confidenciales, como las 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 encriptado de entrada se almacena en la ubicación especificada en la "ruta del archivo encriptado de salida". Si ya existe el archivo en esa ubicación, se sobrescribirá.

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 contiene los parámetros de la SPD. Si -encrypted está habilitado, el archivo de entrada está encriptado.

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

[+] Mostrar uso

Tipo CADENA

A continuación, se describe la estructura de entrada para un tipo cadena:

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

Ejemplo

Perfil de la 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>

Archivo de entrada para un perfil de instalación

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

Tipo BOOLEANA

A continuación, se describe la estructura de entrada para un tipo booleana:

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

Ejemplo

Perfil de la 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>

Archivo de entrada para un perfil de instalación

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

Tipo ENTERO

A continuación, se describe la estructura de entrada para un tipo entero:

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

Ejemplo

Perfil de la 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>

Archivo de entrada para un perfil de instalación

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

Tipo CONTRASEÑA

A continuación, se describe la estructura de entrada para un tipo contraseña:

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

Importante

Los archivos de entrada que incluyen datos confidenciales, como contraseñas, deben encriptarse usando la operación de encriptación de la SPD.

Ejemplo

Perfil de la 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>

Archivo de entrada para un perfil de instalación

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

Tipo SELECTONE

A continuación, se describe la estructura de entrada para un tipo selectOne con una etiqueta <objectselect>:

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

Importante

La CLC forma intersección (AND) con los filtros definidos en el archivo de la SPD y el archivo de entrada para una entrada selectOne. El criterio del filtro debe ser diferente en el archivo de entrada de la SPD, y los nombres de los filtros deben ser diferentes en la misma definición del filtro.

Ejemplo

Perfil de la 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>

Archivo de entrada para un perfil de instalación

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

Tipo SELECTMULTIPLE

A continuación, se describe la estructura de entrada para un tipo selectMultiple con una etiqueta <objectselect>:

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

Los filtros definidos en el archivo de entrada de la SPD se unen (OR) y, luego, forman intersección (AND) con los filtros definidos en el archivo de la SPD para una entrada selectMultiple.

Ejemplo

Perfil de la 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>

Archivo de entrada para un perfil de instalación

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

La operación da como resultado dos aplicaciones llamadas SIP_lrm26 y SIP_lrm27.

Tipo SELECTONE

A continuación se describe la estructura de entrada para un tipo selectOne/selectMultiple/booleana con la etiqueta <selection>:

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

La CLC elige las opciones definidas en el archivo de entrada de la SPD. Se pueden especificar opciones múltiples solo para el tipo de entrada selectMultiple.

Ejemplo

Perfil de la 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>

Archivo de entrada para un perfil de instalación

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

Importante

• Si el archivo de entrada no especifica ningún valor para un parámetro de la SPD, se utilizará el valor definido en el atributo predeterminado del elemento de entrada.
• Si un elemento de entrada de la SPD tiene el atributo requerido configurado como verdadero, pero no hay un valor de entrada correspondiente proporcionado por la SPD (como predeterminado) o en el archivo de entrada, fallará la ejecución de la SPD.
• Si el elemento de entrada de la SPD tiene el atributo readonly configurado como verdadero, se utilizará para la ejecución el valor del atributo predeterminado, si está definido. Si el valor del atributo readonly está configurado como verdadero, required como falso y el atributo predeterminado no está definido, se utiliza la siguiente lógica para determinar el valor de entrada:
  1. Para el tipo de entrada booleana el valor de entrada se configura como falso.
  2. Para los tipos de entrada cadena y contraseña, el valor de entrada se configura como "".
  3. Para el tipo de entrada entero no se propagará la entrada.
• Si un valor de atributo de diálogo cond se evalúa como falso, la herramienta de la CLC omitirá el diálogo. Ejemplo:

   <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 una SPD. Si no existe la SPD, se producirá un error en la operación.

Formato

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

• SPDID—El ID de la SPD que se eliminará.

Ejemplo

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

Los IP

La CLC es compatible con las siguientes operaciones para la función ip:

• agregar
• consultar
• querybyid
• eliminar

agregar

Generalidades

Esta operación agrega un IP (en paquete de archivo .zip) a la base de datos de GAX. Si el IP ya existe, se reemplaza.

Si es correcta, la operación muestra el ID del IP.

Importante

El archivo .zip debe contener el IP y su carpeta de plantillas.

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"

consultar

Generalidades

Esta operación hace una consulta a todos los IP y muestra una tabla con la siguiente información para cada IP:

• Número de ID
• Nombre
• Versión
• SO
• Configuración regional
• 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

querybyid

Generalidades

Esta operación hace una consulta a todos los IP y muestra una tabla con la siguiente información:

• Número de ID
• Nombre
• Versión
• SO
• Configuración regional
• Estado

Formato

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

• ID del IP—El ID del IP que se consulta.

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

• ID del IP—El ID del IP que se elimina.

Ejemplo

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help