Usando o Command Line Console (CLC)

O Command Line Console (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 de 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 a operação 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
• consulta
• 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 "file path"

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

Exemplo

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

consulta

Visão geral

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

• Número de ID
• Nome
• Versão
• DBID de tenant

O seguinte é um 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-sucedida, a operação exibe uma tabela listando os seguintes detalhes do SPD:

• ID do perfil
• Nome

Por exemplo:

1 Install

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

executar

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 entrada 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 "input file path" "encrypted output file path"

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"

• "arquivo de entrada"—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

Tipo CADEIA DE CARACTERES

A estrutura de um tipo cadeia de caracteres está descrita abaixo:

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

Exemplo

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

Arquivo de Entrada para Perfil de Instalação

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

Tipo BOOLEANO

A estrutura de entrada de um tipo booleano está descrita abaixo:

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

Exemplo

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

Arquivo de Entrada para Perfil de Instalação

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

Tipo INTEIRO

A estrutura de entrada de um tipo inteiro está descrita abaixo:

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

Exemplo

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

Arquivo de Entrada para Perfil de Instalação

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

Tipo SENHA

A estrutura da entrada de um tipo senha está descrito abaixo:

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

Importante

Arquivos de entrada com dados sensíveis como senhas devem ser criptografados usando a operação de criptografia SPD.

Exemplo

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

Arquivo de Entrada para Perfil de Instalação

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

Tipo SELECTONE

A estrutura de entrada de um tipo selectOne com uma tag <objectselect> está descrita abaixo:

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

Importante

O CLC intersecciona os filtros (E) definidos no arquivo SPD e no arquivo de entrada para uma entrada selectOne. O critério do filtro deve ser diferente em um arquivo SPD e os nomes dos filtros devem ser diferentes em uma mesma definição.

Exemplo

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

Arquivo de Entrada para Perfil de Instalação

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

Tipo SELECTMULTIPLE

A estrutura de entrada de um tipo selectMultiple com a tag <objectselect> está descrita abaixo:

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

Os filtros definidos em um arquivo de entrada SPD são unidos (OU) e, em seguida, interseccionados (E) com os filtros definidos em um arquivo SPD para uma entrada selectMultiple.

Exemplo

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

Arquivo de Entrada para Perfil de Instalação

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

A operação retorna dois aplicativos chamados de SIP_lrm26 e SIP_lrm27.

Tipo SELECTONE

A estrutura de entrada de um tipo selectOne/selectMultiple/booleano com a tag <selection> está especificada abaixo:

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

O CLC seleciona as opções definidas no arquivo de entrada SPD. Várias opções podem ser especificadas somente para o tipo de entrada selectMultiple.

Exemplo

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

Arquivo de Entrada para Perfil de Instalação

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

Importante

• Se o arquivo de entrada não especificar um valor para um parâmetro SPD, o valor definido no atributo padrão do elemento de entrada será usado.
• Se um elemento de entrada SPD tiver o atributo exigido definido para verdadeiro, mas não houver um valor de entrada correspondente fornecido no SPD (como padrão) ou no arquivo de entrada, a execução do SPD falhará.
• Se um elemento de entrada SPD tiver o atributo somente leitura definido para verdadeiro, o valor no atributo padrão será usado para a execução, se definido. Se o atributosomente leitura estiver definido para verdadeiro, o atributo exigido estiver definido para falso e o atributo padrão não estiver definido, a seguinte lógica será usada para determinar o valor de entrada:
  1. Para o tipo de entrada booleano, o valor de entrada é definido para falso.
  2. Para os tipos de entrada cadeia de caracteres e senha, o valor é definido para "".
  3. Para o tipo de entrada inteiro, a entrada não é propagada.
• Se o valor do atributo cond do diálogo resultar em falso, o diálogo será ignorado pela ferramenta CLC. Exemplo:

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

excluir

Visão geral

Esta operação exclui um SPD. Se 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
• consulta
• 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 "path to IP zip file"

Exemplo

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

consulta

Visão geral

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

• Número de 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 de 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

excluir

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