ReportCiStatusOutputJS : inclus dans le périmètre

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

    • Les méthodes ReportCiStatusOutputJS sont des méthodes getter qui renvoient des propriétés d’objet spécifiques pour la méthode DiscoveryAPI reportCiIpAddressStatus , puis convertissent les informations en chaîne JSON.

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

    ReportCiStatusOutputJS inclus dans le périmètre : getCiOperationStatus()

    Utilisé pour renvoyer l’état du CI analysé.

    Il s’agit d’un champ calculé en fonction du champ last_state de discovery_device_history table et du champ d’état de la table discovery_status.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun
    Tableau 2. Renvoie
    Type Description
    chaîne Les trois états possibles renvoyés par cette méthode sont :
    • En cours de traitement : Discovery traite toujours la demande.
    • Réussi : un CI a été créé ou mis à jour.
    • NotSuccessful : un CI n’a pas été créé ou mis à jour et l’état de détection est Terminé ou Annulé.
    		 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(CiOperationStatus): " + ipResultObj.getCiOperationStatus());

    ReportCiStatusOutputJS inclus dans le périmètre : getCmdbCI()

    Utilisé pour renvoyer la valeur dans le champ cmdb_ci de la table discovery_device_history pour le CI analysé.

    Tableau 3. Paramètres
    Nom Type Description
    Aucun
    Tableau 4. Renvoie
    Type Description
    chaîne Sys_id du CI créé ou mis à jour. Cette valeur peut être nulle dans le cas de résultats intermédiaires avant la création d’un CI. 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(cmdb): " + ipResultObj.getCmdbCI());

    ReportCiStatusOutputJS inclus dans le périmètre : getDiscoveryState()

    Utilisé pour renvoyer la valeur du champ État dans la table État de détection [discovery_status].

    Les valeurs renvoyées par cette méthode sont utilisées pour calculer la valeur renvoyée par la méthode getCiOperationStatus()

    Tableau 5. Paramètres
    Nom Type Description
    Aucun
    Tableau 6. Renvoie
    Type Description
    chaîne Les états possibles renvoyés par cette méthode sont les suivants :
    • En cours de démarrage
    • Actif
    • Terminé
    • Annulé
    		 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(discoveryState): " + ipResultObj.getDiscoveryState());

    ReportCiStatusOutputJS inclus dans le périmètre : getIpAddress()

    Permet de renvoyer la valeur du champ source dans la table discovery_device_history pour le CI analysé.

    Tableau 7. Paramètres
    Nom Type Description
    Aucun
    Tableau 8. Renvoie
    Type Description
    chaîne Adresse IP du CI analysé. 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(IpAddress): " + ipResultObj.getIpAddress());

    ReportCiStatusOutputJS inclus dans le périmètre : getIssues()

    Permet de renvoyer la valeur du champ problèmes dans la table de discovery_device_history pour le CI analysé.

    Tableau 9. Paramètres
    Nom Type Description
    Aucun
    Tableau 10. Renvoie
    Type Description
    entier Nombre de problèmes dans cette détection pour ce CI. 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(issues): " + ipResultObj.getIssues());

    ReportCiStatusOutputJS inclus dans le périmètre : toJson()

    Permet de sérialiser l’objet ReportCiStatusOutputJS .

    Cette méthode lève l’exception IllegalArgumentExceptionImpossible de sérialiser l’objet lorsque la méthode ne parvient pas à sérialiser l’objet. Le e est l’objet d’exception, qui fournit le message d’exception et la trace.

    Tableau 13. Paramètres
    Nom Type Description
    Aucun
    Tableau 14. Renvoie
    Type Description
    chaîne Instance sérialisée de l’objet ReportCiStatusOutputJS dans une chaîne JSON. 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(json): " + ipResultObj.toJson());