DiscoveryAPI : Bereichsbezogen

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 2 Minuten Lesedauer
  • Die DiscoveryAPI -Klasse bietet Methoden, die eine schnelle Discovery einer einzelnen IPv4-Adresse starten und Zusammenfassungen zuvor gestarteter Discovery-Status für ein einzelnes Configuration Item (CI) oder für alle gescannten CIs zurückgeben.

    Diese Klasse wird im Namespace sn_discovery ausgeführt.

    DiscoveryAPI - discoveryIpAddress(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. 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 Discovery. Derselbe Wert wird im optionalen Feld Quelle im Datensatz Discovery-Status angezeigt, der angibt, wie die Discovery 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 Discovery ist kein geeigneter MID-Server verfügbar
    • BadArgumentException: Ungültiges Argument bei 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 Nachricht 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.
      • Sys-ID des Discovery-Status darf nicht NULL sein
      • ipAddress darf nicht NULL sein
    • IllegalArgumentException (Werte in Datenbank gespeichert): Diese Argumentausnahme verhindert, dass fehlerhafte Daten an den Aufrufer zurückgegeben werden, wenn die Attributwerte ungültig sind.
      • Die Eigenschaft „state“ für den Discovery-Status 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“ im Geräteverlauf darf nicht kleiner als 0 sein: <ungültiger Wert>
    Tabelle : 3. Parameter
    Name Typ Beschreibung
    ipAddress Zeichenfolge Die gescannte IPv4-Adresse.
    SysId des Discovery-Status Zeichenfolge Die sys_id des Discovery-Statusdatensatzes für die gescannte IP-Adresse.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    array JavaScript-Array unveränderlicher ReportCiStatusOutputJS -Objekte.
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
    

    DiscoveryAPI – reportCiStatus(Object discoveryStatusSysId)

    Wird verwendet, um eine Zusammenfassung des CI-Discovery-Status anhand einer bestimmten sys_id für den Discovery-Status 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.
      • Sys-ID des Discovery-Status darf nicht NULL sein
      • ipAddress darf nicht NULL sein
    • IllegalArgumentException (Werte in Datenbank gespeichert): Diese Argumentausnahme erzwingt Nachbedingungen für Datenbankzugriffswerte.
      • Die Eigenschaft „state“ für den Discovery-Status 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“ im 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. Ergebnisse
    Typ Beschreibung
    array JavaScript-Array unveränderlicher ReportCiStatusOutputJS -Objekte.
    var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
    for(var idx=0; idx < ipResultObjArray.length; idx++) {    
    var ipResultObj = ipResultObjArray[idx];