Descoberta.API - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 3 min. de leitura
  • . Descoberta.API A classe 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 está em sn_discovery namespace.

    DiscoveryAPI - discoverIpAddress(cadeia de caracteres ipaddress, cadeia de caracteres da aplicação, cadeia de caracteres de origem)

    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 sourceparâmetro, mas não um applicationParâmetro, use "NULL" como o espaço reservado.

    Padrão: Descoberta

    ipAddress Cadeia de caracteres Endereço IP a ser descoberto.
    origem Cadeia de caracteres Opcional. Origem da Descoberta. Este mesmo valor aparece no opcional Origem Campo no registro 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, Object discoveryStatusSysId)

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

    As seguintes exceções podem ser lançadas:
    • DiscoveryStatusNotFoundException: Exibe esta mensagem: Status da Descoberta com sys ID '' valor inválido " não existe
    • DiscoveryDeviceHistoryNotFoundException: Histórico do dispositivo com sys ID do status da Descoberta ' valor inválido E ipaddress ' valor inválido " não existe
    • IllegalArgumentException (Argumentos de entrada inválidos): Esta exceção de argumento impede 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 "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 imutável ReportCiStatusOutputJS objetos.
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
    

    DiscoveryAPI - reportCiStatus(objeto discoveryStatusSysId)

    Usado para retornar um resumo de um status de Descoberta de IC de acordo com um sys_id de Status da Descoberta específico.

    As seguintes exceções podem ser lançadas:
    • DiscoveryStatusNotFoundException: Status da Descoberta com sys ID ' valor inválido " não existe
    • DiscoveryDeviceHistoryNotFoundException: Histórico do dispositivo com sys ID do status da Descoberta ' valor inválido E ipaddress ' valor inválido " não existe
    • IllegalArgumentException (Argumentos de entrada inválidos): Esta exceção de argumento impede 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 condições POST nos valores de acesso ao banco de dados.
      • A propriedade "estado" do Status da Descoberta não pode ser nula
      • A propriedade "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 imutável ReportCiStatusOutputJS objetos.
    var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
    for(var idx=0; idx < ipResultObjArray.length; idx++) {    
    var ipResultObj = ipResultObjArray[idx];