ReportCiStatusOutputJS : inclus dans le champ d’application

L’API ReportCiStatusOutputJS fournit des méthodes qui renvoient des propriétés d’objet spécifiques pour la méthode DiscoveryAPI reportCiIpAddressStatus, puis convertissent les informations en une chaîne JSON.

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

ReportCiStatusOutputJS : getCiOperationStatus()

Renvoie l’état du CI analysé.

Il s’agit d’un champ calculé en fonction du champ last_state dans discovery_device_history table et du champ d’état dans 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 : la Découverte est toujours en cours de traitement de la demande. Réussite : un CI a été créé ou mis à jour. NotSuccessful : un CI n’a pas été créé ou mis à jour et l’état de découverte est Terminé ou Annulé.

var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(CiOperationStatus): " + ipResultObj.getCiOperationStatus());

ReportCiStatusOutputJS : getCmdbCI()

Renvoie la valeur du champ cmdb_ci de la table discovery_device_history du 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 : getDiscoveryState()

Renvoie la valeur du champ État dans la table Statut de détection [discovery_status].

Les valeurs renvoyées par cette méthode sont utilisées pour calculer la valeur retourné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 : getIpAddress()

Renvoie la valeur du champ source dans la table discovery_device_history du 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 : getIssues()

Renvoie la valeur du champ Problèmes dans la table discovery_device_history du CI analysé.

Tableau 9. Paramètres

Nom	Type	Description
Aucun

Tableau 10. Renvoie

Type	Description
entier	Nombre de problèmes dans cette découverte pour ce CI.

var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(issues): " + ipResultObj.getIssues());

ReportCiStatusOutputJS : getIssuesLink()

Renvoie la valeur du champ issues_link dans la table discovery_device_history du CI analysé.

Tableau 11. Paramètres

Nom	Type	Description
Aucun

Tableau 12. Renvoie

Type	Description
chaîne	Champ issues_link de la table discovery_device_history. Il peut s’agir d’une valeur null ou d’une balise d’ancrage définissant un lien hypertexte vers une page qui fournit la liste des problèmes associés au statut de découverte et au CI (adresse IP).

var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(issues_link): " + ipResultObj.getIssuesLink());

ReportCiStatusOutputJS : toJson()

Sérialise l’objet ReportCiStatusOutputJS .

Cette méthode lève l’exception Impossible de sérialiser l’objetIllegalArgumentException, e lorsque la méthode ne peut 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());