Usar o Console de Linha de Comando (CLC)

O Console de Linha de Comando (CLC) permite aos administradores usar a linha de comando para executar determinadas funções do GAX nas definições de solução (SPDs) e nos pacotes de instalação (IPs). Por exemplo, você pode usar o CLC para implantar SPDs silenciosamente em hosts remotos.

Você deve poder acessar a interface de linha de comando do sistema operacional para usar o CLC. Se não estiver na máquina host do GAX, você precisa ter a ferramenta CLC (gaxclc.jar) disponível na máquina local.

Para acessar o arquivo de Ajuda integrado ao CLC, execute um dos seguintes comandos:

java –jar gaxclc.jar help

java –jar gaxclc.jar ?

Importante

Conforme você executa comandos com o CLC, um arquivo log é gerado no mesmo local em que a ferramenta é executada.

Estrutura

O CLC oferece suporte a comandos que usam a seguinte estrutura:

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

No exemplo acima:

• -u:user é o nome de usuário para fazer login no Configuration Server.
• -p:password é a senha para fazer login no Configuration Server. O CLC assume que não há senha se este sinalizador não especificar um valor.
• -s instrui o CLC a usar uma conexão https segura com o servidor GAX. Se este sinalizador não estiver especificado, o CLC usa “http”.
• -h:<host>:<port> especifica o host e a porta do servidor GAX. Se este sinalizador não estiver especificado, o CLC usa o seguinte valor: -h:localhost:8080.
• <function> pode ser ip ou spd.
• <operation> especifica os argumentos a executar. Os valores válidos para este sinalizador são específicos da função especificada na etapa anterior (ip ou spd).
• <args> especifica os argumentos de operação. Os valores válidos para este sinalizador são específicos para os parâmetros <function> e <operation> especificados nas etapas anteriores.

O seguinte é um exemplo de um comando do CLC:

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

SPDs

O CLC oferece suporte às seguintes operações para SPDs:

• adicionar
• consultar
• querybyid
• executar
• excluir
• criptografar (consulte a guia executar)

adicionar

Visão geral

Esta operação adiciona um SPD ao banco de dados do GAX. Se o SPD já existir, conforme determinado pelo nome e pela versão no XML do SPD, esta operação substituirá o SPD existente.

Se bem-sucedida, a operação retorna o ID do SPD adicionado.

Formato

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

• "caminho do arquivo"—O caminho do arquivo XML.

Exemplo

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

query

Visão geral

Esta operação consulta todos os SPDs e exibe uma tabela listando o seguinte para cada SPD:

• Número ID
• Nome
• Versão
• DBID do Tenant

Por exemplo:

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

Exemplo

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

querybyid

Visão geral

Esta operação consulta um SPD por ID. Se o SPD não existir, a operação falha.

Se bem-sucedido, a operação exibe uma tabela listando os seguintes detalhes do SPD:

• ID do perfil
• Nome

Por exemplo:

1 Instalar

Formato

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

• SPDID—O ID do SPD que está sendo consultado.

Exemplo

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

execute

Visão geral

Esta operação executa um 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—O ID do SPD a ser executado.
• profileName|-profileID:profileID|-profileName:profileName—O perfil SPD a ser executado.

Importante

Se nenhum sinalizador for especificado, o profileName é assumido como o perfil SPD a ser executado.

• -encrypted—Se especificado, indica se o arquivo de saída está criptografado.

[+] Mostrar Uso

O CLC oferece suporte a criptografia para arquivos de entrada que incluem dados sensíveis como senhas.

Formato:

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> spd encrypt "caminho do arquivo de entrada" "caminho do arquivo de saída criptografado"

O arquivo de entrada criptografado é armazenado no local especificado pelo "caminho do arquivo de saída criptografado". Se o arquivo já existe neste local, ele será substituído.

Exemplo:

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"—Especifica o arquivo de entrada que contém os parâmetros SPD. Se -encrypted estiver definido, o arquivo de saída será criptografado.

O arquivo de entrada deve estar no formato JSONObject e incluir os parâmetros SPD de um perfil específico. O arquivo deve ser codificado no 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>

  
  

Exemplo

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:"Instalar perfil" "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"

excluir

Visão geral

Esta operação exclui um SPD. Se o SPD não existir, a operação falha.

Formato

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

• SPDID—O ID do SPD a ser excluído.

Exemplo

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

IPs

O CLC oferece suporte às seguintes operações para a função ip:

• adicionar
• consultar
• querybyid
• excluir

adicionar

Visão geral

Esta operação adiciona um IP (empacotado como um arquivo .zip) ao banco de dados do GAX. Se o IP já existir, ele será substituído.

Se bem-sucedida, a operação exibe o ID do IP.

Importante

O arquivo .zip deve conter o IP e a pasta de modelos do IP.

Formato

java –jar gaxclc.jar -u:user -p:password -s -h:<host>:<port> ip add "caminho para arquivo zip do IP"

Exemplo

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

query

Visão geral

Esta operação consulta todos os IPs e exibe uma tabela listando o seguinte para cada IP:

• Número ID
• Nome
• Versão
• SO
• Local
• Status

Formato

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

Exemplo

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

querybyid

Visão geral

Esta operação consulta um IP por ID e exibe uma tabela listando os seguintes detalhes:

• Número ID
• Nome
• Versão
• SO
• Local
• Status

Formato

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

• IPID—O ID do IP a consultar.

Exemplo

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

delete

Visão geral

Esta operação exclui um IP.

Formato

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

• IPID—O ID do IP a excluir.

Exemplo

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

category:Genesys Administrator Extension category:Genesys Administrator Extension Help