Monitorando um Código de Retorno de Comando

É possível definir uma origem de dados para monitorar um aplicativo ou sistema usando um código de retorno de comando. O agente executa o comando, coleta o código de retorno e inclui o resultado para o conjunto de dados de Disponibilidade.

1. Na página Origem de Dados Inicial do Agente ou página Local de Origem de Dados, selecione Comando ou Script na área Categorias de Dados de Monitoramento.
2. Na área Origens de Dados, clique em Um código de retorno de comando.
3. Clique em Avançar.
4. Na página Código de Retorno do Comando, área Informações do Código de Retorno do Comando, digite o nome de exibição.
5. Use as subetapas a seguir para definir e descrever as linhas de comando que deseja que seu código de retorno use.
   Nota: Defina um comando para cada sistema operacional suportado pelo agente. Comandos podem ser compartilhados, mas o conjunto total de sistemas operacionais para todos os comandos deve ser igual ao conjunto sistemas operacionais suportados por agente.
   1. Clique em Incluir na área Comandos da janela Código de Retorno de Comando para abrir a janela Informações do Comando.
   2. Digite uma linha de comandos e selecione um sistema operacional da lista na área Sistemas Operacionais da janela Informações de Comando.
      Nota:

      1. Para um comando Windows , digite o nome completo do comando. Por exemplo, command_to_run.bat e não somente command_to_run.
      2. Coloque aspas em torno do nome de modo que ele não seja analisado pelo interpretador de comandos. Por exemplo, digite este é um test.batargument e não este é um argumento test.bat.
      3. Você pode clicar em um comando e clicar em Editar para modificá-lo ou clicar em Remover para excluí-lo.
   3. Clique em Incluir na área Códigos de Retorno da janela Informações de Comando.
   4. Selecione um tipo de código de retorno na lista que é mostrada na janela Definição de Código de Retorno

      Você pode designar os seguintes estados para os códigos de retorno de teste:

      • ALREADY_RUNNING
      • DEPENDENT_NOT_RUNNING
      • GENERAL_ERROR
      • NOT_RUNNING
      • OK
      • PREREQ_NOT_RUNNING
      • WARNING

   5. Digite um valor numérico para o tipo de código de retorno selecionado.
      O valor do código de retorno é um número inteiro que especifica um código de retorno definido para o código de retorno do comando. Para portabilidade entre sistemas operacionais, use um valor de código de retorno 0 - 255. Para um comando que é executado somente em Windows, o valor de código de retorno pode ser -2147483648 - 2147483647.
   6. Defina uma mensagem para cada código de retorno para que a mensagem e o código possam ser mostrados juntos. Clique em Procurar para configurar o texto da mensagem.
      A janela de mensagens lista mensagens que são definidas no agente. A janela Mensagens (lista) é aberta.

      Nota:

      1. É possível selecionar o texto que foi inserido anteriormente selecionando-o na lista de textos de mensagens em vez de clicar em Procurar. Em seguida, continue na Etapa 5k.
      2. Até definir as mensagens, a lista permanece em branco. É possível usar Editar para alterar uma mensagem definida e Remover para excluir uma ou mais mensagens que você definiu.
   7. Na janela Mensagens (lista), clique em Incluir
      A janela Definição de Mensagem é aberta.

      Nota: O identificador de mensagens é automaticamente gerado para você.
   8. Insira o texto que descreve o significado da nova mensagem no campo Texto da Mensagem.
   9. Clique em OK.
      A janela Mensagens (lista) é aberta mostrando a nova mensagem.
   10. Para verificar a mensagem e torná-la permanente, selecione-a na lista e clique em OK.
       O novo tipo do código de retorno, valor e texto são mostrados na janela Definição de Código de Retorno.
   11. Se desejar que esse código de retorno esteja disponível para outros comandos em outros sistemas operacionais para esse código de retorno de comando, selecione Código de Retorno Global se aplica a todos os comandos. Se você desejar que este código de retorno esteja disponível somente para esse comando, deixe Código de retorno local aplica-se somente a este comando selecionado.
   12. Clique em OK na janela Definição de Código de Retorno.
   13. Defina pelo menos dois códigos de retorno antes de sair da janela Informações de Comando. Um código de retorno para indicar nenhum problema com a disponibilidade, outro para indicar se ocorreu problema. Se deseja incluir outro código de retorno, retorne para a etapa c.
   14. Opcional: Na janela Informações de Comando, na área Arquivos de Comando, clique em Incluir se desejar selecionar um ou mais scripts ou arquivos executáveis para o agente executar.
       O arquivo ou arquivos são copiados na pasta de projeto do agente em scripts/operating system, em que operating system é uma variável que depende do que você selecionou na área Sistemas Operacionais da janela Informações de Comando. Esses arquivos também são fornecidos e distribuídos com o agente. Para editar a definição de um arquivo de comando existente ou o arquivo de comando original desde a cópia no projeto, selecione o arquivo e clique em Editar. Consulte (Editando uma definição de arquivo de comando).
   15. Clique em OK na janela Informações de Comando.
       Nota: A tabela de arquivos de comandos é onde você define quaisquer arquivos externos que deseja incluir no pacote do agente. Esses arquivos são copiados no diretório do projeto e são empacotados com o agente para distribuição.
6. Se você tiver outros códigos de retorno que ainda não estejam definidos, defina e descreva os códigos de retorno globais que seu código de retorno do comando pode usar.
   1. Clique em Incluir na área Códigos de Retorno Globais da página Código de Retorno de Comando.
      Nota: Os códigos de retorno que são definidos aqui são globais. Isto significa que os códigos de retorno são apropriados para todos os comandos definidos para o código de retorno do comando. (Eles não são compartilhados entre os códigos de retorno do comando). Além disso, é possível definir códigos de retorno ao inserir as informações de comando. Os códigos de retorno definidos aqui podem ser globais ou locais. Os códigos de retorno locais são apropriados somente para este comando específico. Essa hierarquia é útil se você tiver um código de retorno que seja o mesmo em todos os sistemas operacionais. (Por exemplo, um código de retorno de 0 significa que tudo está funcionando corretamente. É possível defini-lo para o nível global, e então todos os comandos definidos interpretam 0 dessa forma). Se nenhum dos outros sistemas operacionais retornar um 5, você pode definir o código de retorno 5 somente para o comando Windows. Se você definir um código de retorno no nível do comando local que já está definido no nível global, o nível do comando é usado. É possível usar esse método para substituir códigos de retorno nos sistemas operacionais específicos. Por exemplo, se em todos os sistemas operacionais UNIX, um código de retorno 2 significa uma coisa, mas no Windows, significa algo diferente. Você pode definir um código de retorno 2 no nível global conforme esperado pelos sistemas operacionais UNIX. Em seguida, no comando para o Windows, será possível redefinir o código de retorno 2 para o significado no Windows.
   2. Selecione um tipo de código de retorno na lista que é mostrada na janela Definição de Código de Retorno.

      Você pode designar os seguintes estados para os códigos de retorno de teste:

      • ALREADY_RUNNING
      • DEPENDENT_NOT_RUNNING
      • GENERAL_ERROR
      • NOT_RUNNING
      • OK
      • PREREQ_NOT_RUNNING
      • WARNING
   3. Digite um valor numérico para o tipo de código de retorno selecionado. O valor do código de retorno é um número inteiro que especifica um código de retorno definido para o código de retorno do comando.
   4. Clique em Procurar para configurar o texto da mensagem e seu significado associado. É necessário definir uma mensagem para cada código de retorno para que a mensagem e o código sejam mostrados juntos.

      A janela Mensagens lista mensagens definidas no agente.

      Nota:

      1. Até definir as mensagens, a lista permanece em branco. É possível usar Editar para alterar uma mensagem definida e Remover para excluir uma ou mais mensagens definidas.
      2. É possível selecionar texto que foi inserido anteriormente selecionando-o na lista Texto de Mensagem em vez de clicar em Procurar. Em seguida, continue na Etapa 6h.
   5. Na janela Mensagens (lista), clique em Incluir para ver uma janela Definição de Mensagem, na qual você pode digitar o texto que descreve o significado da nova mensagem.
   6. Clique em OK.
   7. A janela Mensagens (lista) é aberta com a nova mensagem. Para verificar a mensagem e torná-la permanente, selecione-a na lista e clique em OK.
   8. Quando o novo texto, tipo e valor forem mostrados na janela Definição de Código de Retorno, clique em OK.
   9. Na página de código de Retorno do Comando, quando você concluir a definição de códigos de retorno e comandos para todos os sistemas operacionais suportados, execute uma das etapas a seguir:
      • Se estiver usando o assistente de Novo Agente, clique em Avançar ou clique em Concluir para salvar a origem de dados e abrir o Agent Editor.
      • Se estiver usando o assistente de componente do Novo Agente, clique em Concluir para retornar ao Agent Editor.