DiscoveryAPI - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura
  • A classe DiscoveryAPI fornece métodos que iniciam uma descoberta rápida de um único endereço IPv4 e retornam resumos de status de descoberta iniciados anteriormente para um único item de configuração (IC) ou para todos os ICs verificados.

    Esta classe é executada no namespace sn_discovery.

    DiscoveryAPI - discoveryIpAddress (cadeia de caracteres ipAddress, aplicação de cadeia de caracteres, origem de cadeia de caracteres)

    Descobre um endereço IPv4 especificado.

    Um MID Server é selecionado automaticamente, com base no endereço IP fornecido ou na aplicação especificada.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    aplicação Cadeia de caracteres Opcional. Aplicação configurada para o MID Server.

    Para definir um parâmetro source, mas não um parâmetro application, use "NULL" como o espaço reservado.

    Padrão: Descoberta

    ipAddress Cadeia de caracteres Endereço IP a ser descoberto.
    Fonte Cadeia de caracteres Opcional. Origem da Descoberta. Esse mesmo valor aparece no campo opcional Origem no registro de Status da descoberta, que indica como a Descoberta foi acionada.

    Padrão: Discovery_API

    Tabela 2. Retornos
    Tipo Descrição
    Cadeia de caracteres sys_id do registro de status da descoberta.
    As seguintes exceções podem ser lançadas durante a seleção do MID Server:
    • NoSuitableMidServerFoundException: nenhum MID Server apropriado disponível para esta Descoberta
    • BadArgumentException: argumento inválido detectado durante a seleção do MID Server
    var sysid = sn_discovery.DiscoveryAPI.discoverIpAddress("11.23.125.39");

    DiscoveryAPI - reportCiIpAddressStatus(Object ipAddress, Objeto discoveryStatusSysId)

    Usado para retornar um resumo do status de descoberta de um item de configuração de acordo com o status específico sys_id e o endereço IPv4.

    As seguintes exceções podem ser lançadas:
    • DiscoveryStatusNotFoundException: Exibe esta mensagem: O status da descoberta com o SYS ID '<valor inválido>' não existe
    • DiscoveryDeviceHistoryNotFoundException: o histórico de dispositivos com o SYS ID do status da descoberta '<valor inválido>' e o endereço IP '<valor inválido>' não existe
    • IllegalArgumentException (argumentos de entrada inválidos): esta exceção de argumento evita que os valores de entrada sejam nulos.
      • O SYS ID do status da descoberta não pode ser nulo
      • ipAddress não pode ser nulo
    • IllegalArgumentException (valores armazenados no banco de dados): esta exceção de argumento evita que dados incorretos sejam retornados ao solicitante no caso de valores de atributo incorretos.
      • A propriedade "estado" do status da descoberta não pode ser nula
      • A propriedade de "origem" do histórico do dispositivo não pode ser nula
      • A propriedade "problemas" do histórico do dispositivo não é um número inteiro: <valor inválido>
      • A propriedade "problemas" do histórico do dispositivo não pode ser inferior a 0: <valor inválido>
    Tabela 3. Parâmetros
    Nome Tipo Descrição
    ipAddress Cadeia de caracteres O endereço IPv4 que foi verificado.
    discoveryStatusSysId Cadeia de caracteres O sys_id do registro de status da Descoberta para o endereço IP que foi verificado.
    Tabela 4. Retornos
    Tipo Descrição
    matriz Matriz JavaScript de objetos ReportCiStatusOutputJS imutáveis.
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
    

    DiscoveryAPI - reportCiStatus(Object discoveryStatusSysId)

    Usado para retornar um resumo de um status de descoberta de IC de acordo com um sys_id de status de descoberta específico.

    As seguintes exceções podem ser lançadas:
    • DiscoveryStatusNotFoundException: o status da descoberta com o SYS ID '<valor inválido>' não existe
    • DiscoveryDeviceHistoryNotFoundException: o histórico de dispositivos com o SYS ID do status da descoberta '<valor inválido>' e o endereço IP '<valor inválido>' não existe
    • IllegalArgumentException (argumentos de entrada inválidos): esta exceção de argumento evita que os valores de entrada sejam nulos.
      • O SYS ID do status da descoberta não pode ser nulo
      • ipAddress não pode ser nulo
    • IllegalArgumentException (valores armazenados no banco de dados): esta exceção de argumento impõe pós-condições nos valores de acesso ao banco de dados.
      • A propriedade "estado" do status da descoberta não pode ser nula
      • A propriedade de "origem" do histórico do dispositivo não pode ser nula
      • A propriedade "problemas" do histórico do dispositivo não é um número inteiro: <valor inválido>
      • A propriedade "problemas" do histórico do dispositivo não pode ser inferior a 0: <valor inválido>
    Tabela 5. Parâmetros
    Nome Tipo Descrição
    sys_id Cadeia de caracteres O sys_id de um registro de status da Descoberta.
    Tabela 6. Retornos
    Tipo Descrição
    matriz Matriz JavaScript de objetos ReportCiStatusOutputJS imutáveis.
    var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
    for(var idx=0; idx < ipResultObjArray.length; idx++) {    
    var ipResultObj = ipResultObjArray[idx];