DiscoveryAPI – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 2 Minuten Lesedauer
  • Die DiscoveryAPI Die Klasse bietet Methoden, die eine schnelle Discovery einer einzelnen IPv4-Adresse starten und Zusammenfassungen der zuvor gestarteten Discovery-Status für ein einzelnes Konfigurationselement (Configuration Item, CI) oder für alle gescannten CIs zurückgeben.

    Diese Klasse wird ausgeführt in sn_Discovery Namespace.

    DiscoveryAPI – discoverIpAddress(String ipAddress, Zeichenfolgenanwendung, Zeichenfolgenquelle)

    Erkennt eine angegebene IPv4-Adresse.

    Ein MID Server wird basierend auf der angegebenen IP-Adresse oder der angegebenen Anwendung automatisch ausgewählt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Anwendung Zeichenfolge Optional. Anwendung, die für den MID-Server konfiguriert ist.

    Zum Definieren von sourceParameter, aber kein applicationParameter, verwenden Sie „Null“ als Platzhalter.

    Standard: Discovery

    ipAddress Zeichenfolge Zu erkennende IP-Adresse.
    Quelle Zeichenfolge Optional. Quelle der Discovery. Derselbe Wert wird optional im angezeigt Quelle Feld im Discovery-Statusdatensatz, das angibt, wie die Discovery ausgelöst wurde.

    Standard: Discovery_API

    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Zeichenfolge Sys_ID des Discovery-Statusdatensatzes
    Die folgenden Ausnahmen können während der MID-Server-Auswahl ausgelöst werden:
    • NoSuitableMidServerFoundException: Kein entsprechender MID-Server für diese Discovery verfügbar
    • BadArgumentException: Ungültiges Argument während der MID-Server-Auswahl erkannt
    var sysid = sn_discovery.DiscoveryAPI.discoverIpAddress("11.23.125.39");

    DiscoveryAPI – reportCiIpAddressStatus(Object ipAddress, Object discoveryStatusSysId)

    Wird verwendet, um eine Zusammenfassung des Discovery-Status eines Konfigurationselements anhand der spezifischen Status-sys_ID und IPv4-Adresse zurückzugeben.

    Die folgenden Ausnahmen können ausgelöst werden:
    • DiscoveryStatusNotFoundException: Zeigt diese Meldung an: Discovery-Status mit SYS-ID „< Ungültiger Wert >' ist nicht vorhanden
    • DiscoveryDeviceHistoryNotFoundException: Geräteverlauf mit Discovery-Status-SYS-ID „< Ungültiger Wert >“ und ipAddress „< Ungültiger Wert >' ist nicht vorhanden
    • IllegalArgumentException (Ungültige Eingabeargumente): Diese Argumentausnahme verhindert, dass Eingabewerte null sind.
      • Discovery-Status-SYS-ID darf nicht null sein
      • Ipaddress darf nicht null sein
    • IllegalArgumentException (Werte in Datenbank gespeichert): Diese Argumentausnahme verhindert, dass fehlerhafte Daten an den Anrufer zurückgegeben werden, wenn ungültige Attributwerte vorliegen.
      • Die Eigenschaft „Status“ für den Discovery-Status darf nicht null sein
      • Die Eigenschaft „Quelle“ für den Geräteverlauf darf nicht null sein
      • Die Eigenschaft „Probleme“ des Geräteverlaufs ist keine Ganzzahl: < Ungültiger Wert >
      • Die Eigenschaft „Probleme“ für den Geräteverlauf darf nicht kleiner als 0 sein: < Ungültiger Wert >
    Tabelle : 3. Parameter
    Name Typ Beschreibung
    ipAddress Zeichenfolge Die IPv4-Adresse, die gescannt wurde.
    DiscoveryStatusSysId Zeichenfolge Die sys_ID des Discovery-Statusdatensatzes für die gescannte IP-Adresse.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    array JavaScript-Array von unveränderlichen Elementen BerichtCiStatusOutputJS Objekte.
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
    

    DiscoveryAPI – reportCiStatus(Object discoveryStatusSysId)

    Wird verwendet, um eine Zusammenfassung eines CI-Discovery-Status anhand einer bestimmten Discovery-Status-sys_ID zurückzugeben

    Die folgenden Ausnahmen können ausgelöst werden:
    • DiscoveryStatusNotFoundException: Discovery-Status mit SYS-ID „< Ungültiger Wert >' ist nicht vorhanden
    • DiscoveryDeviceHistoryNotFoundException: Geräteverlauf mit Discovery-Status-SYS-ID „< Ungültiger Wert >“ und ipAddress „< Ungültiger Wert >' ist nicht vorhanden
    • IllegalArgumentException (Ungültige Eingabeargumente): Diese Argumentausnahme verhindert, dass Eingabewerte null sind.
      • Discovery-Status-SYS-ID darf nicht null sein
      • Ipaddress darf nicht null sein
    • IllegalArgumentException (Werte in Datenbank gespeichert): Diese Argumentausnahme erzwingt Post-Bedingungen für Datenbankzugriffswerte.
      • Die Eigenschaft „Status“ für den Discovery-Status darf nicht null sein
      • Die Eigenschaft „Quelle“ für den Geräteverlauf darf nicht null sein
      • Die Eigenschaft „Probleme“ des Geräteverlaufs ist keine Ganzzahl: < Ungültiger Wert >
      • Die Eigenschaft „Probleme“ für den Geräteverlauf darf nicht kleiner als 0 sein: < Ungültiger Wert >
    Tabelle : 5. Parameter
    Name Typ Beschreibung
    sys_id Zeichenfolge Die sys_ID eines Discovery-Statusdatensatzes.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    array JavaScript-Array von unveränderlichen Elementen BerichtCiStatusOutputJS Objekte.
    var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
    for(var idx=0; idx < ipResultObjArray.length; idx++) {    
    var ipResultObj = ipResultObjArray[idx];