Criação de uma atividade SSH

Crie uma atividade que extraia dados de um host de destino que usa o protocolo de rede SSH.

Antes de Iniciar

Funções necessárias: activity_creator ou workflow_admin

Por Que e Quando Desempenhar Esta Tarefa

Para obter instruções sobre como usar o fluxo do processo do modelo de atividade, consulte Como criar atividades personalizadas.

Procedimento

1. Crie uma atividade personalizada.
   Esta ação cria uma atividade personalizada usando um modelo.
2. Depois de configurar as propriedades gerais e criar variáveis de entrada, configure o Comando de Execução SSH.

   Opção	Descrição
   Mapear as variáveis de entrada	Use as variáveis que você criou para configurar o comando que a Orquestração vai executar.
   Host de destino	Nome do host ou endereço IP do servidor de destino para esta atividade.
   Comando	Comando para que esta atividade seja executada no host de destino. Você pode invocar um script do MID Server a partir deste campo usando qualquer tipo de script compatível com a linha de comando SSH. Para obter mais informações, consulte Opções de script SSH avançado abaixo da tabela.
   Diretório	Diretório no host de destino em que o comando é executado.
   Marcador de credencial	O marcador de credencial da Orquestração a ser usado ao executar o comando.
   Requer recursos do MID Server	MID Server com os recursos apropriados para conexão com o host. Por padrão, o sistema seleciona um MID Server que tenha o recurso SSH.
   Execução longa	Se marcada, essa opção desativa o tempo limite da conexão para comandos que podem levar mais tempo para executar que o padrão de 60 segundos. A Orquestração verifica periodicamente o processo em execução para determinar seu status até ser concluído.
   Deve Sudo	Se marcado, permitirá o uso de sudo para executar comandos.

   Nota:

   Você pode mapear valores de parâmetro em uma carga de teste para variáveis na guia Saídas automaticamente. Consulte variáveis de saída do mapeamento automático.

Opções de script SSH avançadas

Para executar um script MID Server no host de destino, especifique o tipo de script e passe o nome do script para o parâmetro ${syncFile()}. O sistema usa este parâmetro para localizar o script nomeado na tabela Arquivo de script do MID Server [ecc_agent_script_file] e executá-lo no host de destino. Por exemplo, um script bash pode ser expresso como:

bash ${syncFile("<MID script name>")} argument1 argument2 argument3

Um script de base (main_script.bash) pode fazer referência a outro script (my_include.bash), bem como a um arquivo separado (.my_profile) localizado no host de destino. Os scripts e o arquivo referenciado devem ser sincronizados com o MID Server, usando o parâmetro ${syncFile()}, para serem executados corretamente.

source ${syncFile(".my_profile")}
cp ${syncFile("my_include.bash")} /usr/ssmith/my_include.bash
bash ${syncFile("main_script.bash")} one two three four five six 
rm /usr/ssmith/my_include.bash

Um exemplo de Python com comentários em linha pode ser semelhante a este:

set $LIB_DIR=/usr/bin;. 
# Sync a file that is referenced inside myF5CreateLBPool.py 
cp ${syncFile("specialFunctions.py")} ~/specialFunctions.py 
# set up environment variables 
source ${syncFile(".python_profile")} 
# call script that sets up dependencies on the box from remote package repos 
python ${syncFile("setupPythonDependencies.py")} pycontrol 
# call a script that requires functions from the package as well as a function from myIncludedFile 
python ${syncFile("myF5CreateLBPool.py")} snow_pool myActualValue 
# user is responsible for their own cleanup 
rm ~/specialFunctions.py 

O que Fazer Depois

• Use o mapeamento automático para gerar saídas e regras de análise
• Se você não usar o mapeamento automático, poderá criar variáveis de saída e regras de análisemanualmente

Parâmetros de execução do modelo SSH

Use parâmetros de execução para criar o script do processo de entrada no formulário de pré-processamento do designer de atividades.

Para obter descrições dos campos de comando, consulte Configuração do comando de execução do SSH.

Nota:

É necessário usar o prefixo executionParam. com todas as variáveis nesta tabela.

Tabela 1. Parâmetros de execução do SSH

Nome	Variável	Tipo	Uso
Origem	origem	Cadeia de caracteres	Host ou destino pretendido.
Comando	comando	Cadeia de caracteres	Comentário a ser executado no host.
Diretório	diretório	Cadeia de caracteres	Diretório no host no qual o comando será executado.
Marcador de credencial	credential_tag	Cadeia de caracteres	O marcador de credencial da Orquestração a ser usado ao executar o comando.
MidCapabilities	midCapabilities	Cadeia de caracteres (separados por vírgulas)	Lista de recursos MID Server exigidos.
ValueCapabilities	valueCapabilities	Matriz de hashmap	Valores de recursos usados para selecionar o MID Server. Para obter mais informações, consulte Recursos do MID Server. Se houver recursos adicionais atribuídos por valor, use este exemplo para personalizar a seleção do MID Server: var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'}; executionParam.valueCapabilities.push(valueCapability);
Execução longa	long_running	Booliano	Indica se o comando é de longa execução. Um valor verdadeiro indica que o comando é de longa execução.
Deve Sudo	must_sudo	Booliano	Indica se esta atividade deve ou não usar sudo para executar comandos raiz. Um valor verdadeiro indica que sudo credenciais SSH devem ser usadas.

Análise de carga e parâmetros de pós-processamento do SSH

Use esses parâmetros para criar um script de pós-processamento, análise de carga e marcação.

Tabela 2. Parâmetros de pós-processamento do SSH

Nome	Variável	Tipo	Uso
Saída	saída	Cadeia de caracteres	Contém a saída retornada do comando SSH.
EccSysID	eccSysID	Cadeia de caracteres	Contém o ID de referência associado à mensagem de entrada da Fila do ECC retornada pela atividade.
ErrorMessages	errorMessages	Cadeia de caracteres	Contém qualquer mensagem de erro retornada do comando do SSH. Este valor será nulo se não houver mensagens de erro.
Marcadores	marcadores	Hashmap de valores de marcador a serem retornados do comando do SSH.	Contém os marcadores usados para extrair a saída usando os comandos do SSH. A saída do marcador é delimitada por sinais de porcentagem dupla, como em %%tagname%%...%%. Configure o comando usando o seguinte formato: %%tagname1%% output1 line 1 output1 line 2 … %% %%tagname2%% output2 line 1 output2 line 2 … %% Os marcadores retornados são objetos de hashmap JavaScript em que cada chave é prefixada com tag anexada ao tagname. {"__text__": "", "tagtagname1":"output1 line1\noutput1 line2\n", "tagtagname2":"output2 line1\noutput2 line2\n"}

Configuração do comando de execução do SSH

Use as variáveis de entrada que você criou para configurar o comando que a Orquestração executa no host de destino.

Antes de Iniciar

Crie as variáveis de entrada necessárias no formulário de Entradas antes de avançar para a fase de Comando de Execução.

Funções necessárias: activity_creator, administrador

Nota:

Você pode testar a conexão de SSH entre o MID Server e o destino sem ter que executar a atividade em um contexto de fluxo de trabalho. Para obter detalhes, consulte saídas do modelo de teste.

Procedimento

1. Arraste as variáveis da lista de entradas e solte-as nos campos de comando.
   O sistema formata a variável na sintaxe apropriada para o comando.

   Figura 1. Comando de execução do SSH

   

2. Preencha os campos exibidos na tabela.

   Tabela 3. Entradas de atividade SSH

   Campo	Descrição
   Entrada	Construtor de variável de entrada. Criação de variáveis de entrada para mapear para campos disponíveis.
   Host de destino	Nome do host ou endereço IP do servidor de destino para esta atividade.
   Comando	Comando para que esta atividade seja executada no host de destino. Você pode invocar um script do MID Server a partir deste campo usando qualquer tipo de script compatível com a linha de comando SSH. Para obter mais informações, consulte Opções de script SSH avançado abaixo da tabela.
   Diretório	Diretório no host de destino em que o comando é executado.
   Marcador de credencial	Os aliases de credencial para atividades da Orquestração a serem usados durante a execução do comando.
   Selecione MID Server por recursos	MID Server com os recursos apropriados para conexão com o host. Por padrão, o sistema seleciona um MID Server que tenha o recurso SSH.
   Execução longa	Caixa de seleção para desabilitar o tempo limite da conexão SSH para comandos que podem levar mais tempo para executar que o padrão de 60 segundos. A Orquestração verifica periodicamente o processo em execução para determinar seu status até ser concluído.
   Deve Sudo	Marque a caixa para permitir o uso de credenciais SSH para executar comandos.

3. Clique em Salvar.
4. Clique em Continuar para avançar para a fase Saídas.