Pesquisa de Texto Unix

• Tipo de Tarefa: ssh_searchtext

Descrição

A Tarefa Unix Search Text permite pesquisar uma string ou um padrão de texto dentro de um ficheiro, seja num servidor remoto (via SSH) ou na máquina local (modo Default).

Pode ser utilizada para analisar ficheiros de log, identificar mensagens de erro ou verificar a presença de informações específicas em ficheiros de configuração ou de texto.

Configuração

A configuração da Tarefa define os detalhes da ligação (se aplicável), o ficheiro a analisar e o texto a procurar. Os campos de configuração da Tarefa podem ser preenchidos manualmente ou através de parâmetros e variáveis do fluxo de trabalho.

Ligação ao Servidor

• Modo de Ligação: define a origem das credenciais utilizadas para a ligação. Pode assumir três modos operacionais:
• Default: a pesquisa é executada na máquina local, sem ligação SSH.
• Manual: permite o preenchimento manual dos parâmetros de ligação SSH.
• Environment: utiliza um ambiente de ligação pré-configurado. Neste modo, é exibido um menu que lista as ligações disponíveis com base no papel associado ao Workflow.
• Endereço IP: endereço IP do servidor remoto.
• Hostname: nome de host do servidor remoto.
• Utilizador: nome de utilizador usado para estabelecer a ligação SSH.
• Palavra-passe: palavra-passe associada ao utilizador de ligação.
• Porta: porta utilizada para a ligação SSH (o valor padrão é 22).

Executar comando como outro utilizador

Ao ativar esta caixa de seleção, é possível executar a pesquisa com um utilizador diferente daquele utilizado para a ligação SSH.

• Utilizador: nome do utilizador com quem o comando será executado.
• Palavra-passe: palavra-passe do utilizador usado para a execução do comando.

Detalhes da Pesquisa

• Caminho do Ficheiro: o caminho completo do ficheiro no servidor remoto onde a pesquisa de texto será efetuada.
• Padrão: o texto ou expressão a ser procurado dentro do ficheiro. Ao lado do campo de texto, um menu permite especificar o modo de pesquisa:
• String: a pesquisa tratará o padrão como uma simples string de texto literal.
• RegExp: a pesquisa interpretará o padrão como uma expressão regular, permitindo pesquisas muito mais complexas e flexíveis.
• Limite de Linhas: ao ativar a caixa de seleção, é possível especificar o número máximo de linhas correspondentes ao padrão que a Tarefa deve retornar. Se não estiver ativado, todas as linhas encontradas serão retornadas.

Parâmetros de Saída

Ao final da pesquisa, a Tarefa expõe os seguintes parâmetros de saída, fornecendo não só as linhas encontradas, mas também dados quantitativos sobre a pesquisa:

• result: contém uma mensagem de texto que descreve o resultado da operação.
• resultJson: representa o resultado da execução da tarefa em formato JSON, incluindo informações gerais, configurações e detalhes da execução.
• occurrences: um contador numérico que indica o número total de vezes em que o Padrão foi encontrado. Isto é particularmente útil porque, se uma única linha contiver o padrão mais do que uma vez, occurrences contará todas, enquanto result retornará a linha apenas uma vez.
• exitStatus: retorna o código de saída do comando grep executado no servidor.
• 0: indica que pelo menos uma correspondência foi encontrada.
• 1: indica que nenhuma correspondência foi encontrada (isto, para grep, não é um erro de execução).
• Valores maiores que 1: indicam um erro de sintaxe ou um problema de acesso ao ficheiro.

Exemplo de parâmetro resultJson

{
  "run_info": {
    "status": "Completed",
    "run_result": "Success"
  },
  "output_parameters": {
    "exitStatus": "0"
  }
}

Nota

• A tarefa executa um comando de pesquisa no ficheiro configurado, localmente ou através de ligação SSH.
• Se for utilizada uma ligação remota com autenticação por chaves SSH, é necessário que a chave pública esteja registada no servidor.
• Se a opção “Executar comando como outro utilizador” estiver ativada, o comando é executado com um utilizador diferente do da ligação principal.
• Em modo Padrão, a pesquisa é executada na máquina local e nenhuma ligação SSH é necessária.