DiscoveryAPI – Scoped

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 2 Minuten Lesedauer
  • Die Methoden der DiscoveryAPI -Klasse starten eine schnelle Erkennung einer einzelnen IPv4-Adresse und geben Zusammenfassungen zuvor gestarteter Erkennungsstatus für ein einzelnes CI oder für alle gescannten CIs zurück.

    Diese Klasse wird im Namespace sn_discovery ausgeführt.

    Scoped DiscoveryAPI – discoveryIpAddress(String ipAddress, String application, String source)

    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. Für den MID Server konfigurierte Anwendung.

    Um einen source -Parameter, aber keinen application -Parameter zu definieren, verwenden Sie „NULL“ als Platzhalter.

    Standard: Discovery

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

    Standard: Discovery_API

    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Zeichenfolge sys_id des Discovery-Statusdatensatzes.
    Die folgenden Ausnahmen können während der MID Server-Auswahl ausgelöst werden:
    • NoSuitableMidServerFoundException: Für diese Erkennung ist kein geeigneter MID-Server verfügbar
    • BadArgumentException: Ungültiges Argument während der MID-Server-Auswahl erkannt
    var sysid = sn_discovery.DiscoveryAPI.discoverIpAddress("11.23.125.39");

    Scoped DiscoveryAPI – reportCiIpAddressStatus(Object ipAddress, Object discoveryStatusSysId)

    Wird verwendet, um eine Zusammenfassung des Discovery-Status eines Konfigurationselements mit dem spezifischen Status sys_id und der 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 (in Datenbank gespeicherte Werte): Diese Argumentausnahme verhindert, dass fehlerhafte Daten bei ungültigen Attributwerten an den Aufrufer zurückgegeben werden.
      • Discovery-Statuseigenschaft „state“ darf nicht NULL sein
      • Die Eigenschaft „Quelle“ des Geräteverlaufs darf nicht NULL sein
      • Die Eigenschaft „Probleme“ des Geräteverlaufs ist keine Ganzzahl: <ungültiger Wert>
      • Die Eigenschaft „Probleme“ des Geräteverlaufs darf nicht kleiner als 0 sein: <ungültiger Wert>
    Tabelle : 3. Parameter
    Name Typ Beschreibung
    ipAddress Zeichenfolge Die gescannte IPv4-Adresse
    discoveryStatusSysId Zeichenfolge Die sys_id des Discovery-Statusdatensatzes für die gescannte IP-Adresse.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    array JavaScript-Array von unveränderlichen ReportCiStatusOutputJS -Objekten.
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
    

    Scoped DiscoveryAPI – reportCiStatus(Object discoveryStatusSysId)

    Wird verwendet, um eine Zusammenfassung eines CI-Discovery-Status mit 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 (in Datenbank gespeicherte Werte): Diese Argumentausnahme erzwingt Nachbedingungen für Datenbankzugriffswerte.
      • Discovery-Statuseigenschaft „state“ darf nicht NULL sein
      • Die Eigenschaft „Quelle“ des Geräteverlaufs darf nicht NULL sein
      • Die Eigenschaft „Probleme“ des Geräteverlaufs ist keine Ganzzahl: <ungültiger Wert>
      • Die Eigenschaft „Probleme“ des Geräteverlaufs 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. Ergebnisse
    Typ Beschreibung
    array JavaScript-Array von unveränderlichen ReportCiStatusOutputJS -Objekten.
    var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
    for(var idx=0; idx < ipResultObjArray.length; idx++) {    
    var ipResultObj = ipResultObjArray[idx];