DiscoveryAPI : incluse dans le périmètre

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 3 minutes de lecture

    • Les méthodes de la classe DiscoveryAPI lancent une détection rapide d’une adresse IPv4 unique et renvoient des résumés des états de détection précédemment lancés pour un seul CI ou pour tous les CI analysés.

    Cette classe s’exécute dans l’espace de noms sn_discovery .

    DiscoverAPI incluse dans le périmètre : discoverIpAddress(String ipAddress, String application, String source)

    Détecte une adresse IPv4 spécifiée.

    Un MID Server est sélectionné automatiquement, en fonction de l'adresse IP fournie ou de l'application spécifiée.

    Tableau 1. Paramètres
    Nom Type Description
    l'application Chaîne Facultatif. Application configurée pour Serveur MID.

    Pour définir un source paramètre, mais pas un application paramètre, utilisez « NULL » comme espace réservé.

    Valeur par défaut : Discovery
    ipAddress Chaîne Adresse IP à détecter.
    source Chaîne Facultatif. Source de la détection. Cette même valeur apparaît dans le champ Source facultatif de l’enregistrement État de détection, qui indique comment la détection a été déclenchée.

    Valeur par défaut : Discovery_API
    Tableau 2. Renvoie
    Type Description
    Chaîne État de détection sys_id d’enregistrement.
    Les exceptions suivantes peuvent être levées lors de la sélection du MID Server :
    • NoSuitableMidServerFoundException: aucun MID Server approprié n’est disponible pour cette détection
    • BadArgumentException: argument non valide détecté lors de la sélection du MID Server
    		 
    var sysid = sn_discovery.DiscoveryAPI.discoverIpAddress("11.23.125.39");

    DiscoveryAPI incluse dans le périmètre : reportCiIpAddressStatus(Object ipAddress, Object discoveryStatusSysId)

    Utilisé pour renvoyer un résumé de l’état de détection d’un élément de configuration en fonction du sys_id d’état spécifique et de l’adresse IPv4.

    Les exceptions suivantes peuvent être levées :
    • DiscoveryStatusNotFoundException: affiche le message suivant : Le statut de détection avec l’ID système « < valeur non valide> » n’existe pas.
    • DiscoveryDeviceHistoryNotFoundException: l’historique des appareils avec état de détection ID système « < valeur non valide> » et ipAddress « < valeur non valide> » n’existe pas.
    • IllegalArgumentException (arguments d’entrée non valides) : cette exception d’argument empêche les valeurs d’entrée d’être nulles.
      • L’ID système du statut de détection ne peut pas être nul
      • ipAddress ne peut pas être nul
    • IllegalArgumentException (valeurs stockées dans la base de données) : cette exception d’argument empêche les données erronées d’être renvoyées à l’appelant en cas de mauvaises valeurs d’attribut.
      • La propriété « state » du statut de détection ne peut pas être nulle
      • La propriété « source » de l’historique des appareils ne peut pas être nulle.
      • La propriété « problèmes » de l’historique des appareils n’est pas un nombre entier : <valeur non valide>
      • La propriété « problèmes » de l’historique des appareils ne peut pas être inférieure à 0 : <valeur non valide>
    Tableau 3. Paramètres
    Nom Type Description
    ipAddress chaîne Adresse IPv4 analysée.
    discoveryStatusSysId chaîne sys_id de l’enregistrement d’état de détection pour l’adresse IP qui a été analysée.
    Tableau 4. Renvoie
    Type Description
    tableau Tableau JavaScript d’objets ReportCiStatusOutputJS immuables. 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);

    DiscoveryAPI incluse dans le périmètre : reportCiStatus(Object discoveryStatusSysId)

    Utilisé pour renvoyer un résumé de l’état de détection d’un CI compte tenu d’un sys_id d’état de détection spécifique.

    Les exceptions suivantes peuvent être levées :
    • DiscoveryStatusNotFoundException: le statut de détection avec l’ID système « < valeur non valide> » n’existe pas.
    • DiscoveryDeviceHistoryNotFoundException: l’historique des appareils avec état de détection ID système « < valeur non valide> » et ipAddress « < valeur non valide> » n’existe pas.
    • IllegalArgumentException (arguments d’entrée non valides) : cette exception d’argument empêche les valeurs d’entrée d’être nulles.
      • L’ID système du statut de détection ne peut pas être nul
      • ipAddress ne peut pas être nul
    • IllegalArgumentException (valeurs stockées dans la base de données) : cette exception d’argument impose des conditions post sur les valeurs d’accès à la base de données.
      • La propriété « state » du statut de détection ne peut pas être nulle
      • La propriété « source » de l’historique des appareils ne peut pas être nulle.
      • La propriété « problèmes » de l’historique des appareils n’est pas un nombre entier : <valeur non valide>
      • La propriété « problèmes » de l’historique des appareils ne peut pas être inférieure à 0 : <valeur non valide>
    Tableau 5. Paramètres
    Nom Type Description
    sys_id chaîne sys_id d’un enregistrement d’état de détection.
    Tableau 6. Renvoie
    Type Description
    tableau Tableau JavaScript d’objets ReportCiStatusOutputJS immuables. 
    var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
for(var idx=0; idx < ipResultObjArray.length; idx++) {    
var ipResultObj = ipResultObjArray[idx];