ReportCiStatusOutputJS - スコープ指定

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：5分

    • ReportCiStatusOutputJS API は、DiscoveryAPI reportCiIpAddressStatus メソッドの特定のオブジェクトプロパティを返し、その情報を JSON 文字列に変換するメソッドを提供します。

    このクラスは sn_discovery 名前空間で実行されます。

    ReportCiStatusOutputJS - getCiOperationStatus()

    スキャンされた CI のステータスを返します。

    これは、discovery_device_history テーブルの last_state フィールドと discovery_status テーブルの state フィールドに基づいて計算されたフィールドです。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし
    表 : 2. 返される内容
    タイプ 説明
    文字列 このメソッドによって返される可能性のある 3 つの状態は次のとおりです。
    • 処理中:ディスカバリーはまだ要求を処理しています。
    • 成功:CI が作成または更新されました。
    • NotSuccessful:CI が作成または更新されず、ディスカバリーステータスが [完了] または [キャンセル] でした。
    		 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(CiOperationStatus): " + ipResultObj.getCiOperationStatus());

    ReportCiStatusOutputJS - getCmdbCI()

    スキャンされている CI のdiscovery_device_historyテーブルから cmdb_ci フィールドの値を返します。

    表 : 3. パラメーター
    名前 タイプ 説明
    なし
    表 : 4. 返される内容
    タイプ 説明
    文字列 作成または更新された CI のSys_id。CI が作成される前の中間結果の場合、この値は null にすることができます。 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(cmdb): " + ipResultObj.getCmdbCI());

    ReportCiStatusOutputJS - getDiscoveryState()

    ディスカバリーステータス [discovery_status] テーブルの [ステータス ] フィールドから値を返します。

    このメソッドによって返された値は、 getCiOperationStatus() メソッドによって返された値の計算に使用されます

    表 : 5. パラメーター
    名前 タイプ 説明
    なし
    表 : 6. 返される内容
    タイプ 説明
    文字列 このメソッドによって返される可能性のある状態は次のとおりです。
    • 開始中
    • アクティブ
    • 完了
    • キャンセル
    		 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(discoveryState): " + ipResultObj.getDiscoveryState());

    ReportCiStatusOutputJS - getIpAddress()

    スキャンされている CI のdiscovery_device_historyテーブルのソースフィールドから値を返します。

    表 : 7. パラメーター
    名前 タイプ 説明
    なし
    表 : 8. 返される内容
    タイプ 説明
    文字列 スキャンされている CI の IP アドレス。 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(IpAddress): " + ipResultObj.getIpAddress());

    ReportCiStatusOutputJS - getIssues()

    スキャンされている CI のdiscovery_device_historyテーブルの問題フィールドから値を返します。

    表 : 9. パラメーター
    名前 タイプ 説明
    なし
    表 : 10. 返される内容
    タイプ 説明
    整数 この CI のこのディスカバリーの問題の数。 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(issues): " + ipResultObj.getIssues());

    ReportCiStatusOutputJS - toJson()

    ReportCiStatusOutputJS オブジェクトをシリアル化します。

    このメソッドは、メソッドがオブジェクトをシリアル化できない場合に、 IllegalArgumentException 例外 Cannot serialize object, e をスローします。e は例外オブジェクトで、例外メッセージとトレースを提供します。

    表 : 13. パラメーター
    名前 タイプ 説明
    なし
    表 : 14. 返される内容
    タイプ 説明
    文字列 ReportCiStatusOutputJS オブジェクトのインスタンスを JSON 文字列にシリアル化します。 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);
gs.info("ipResultObj(json): " + ipResultObj.toJson());