ReportCiStatusOutputJS: スコープ指定

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：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. 返される内容
    タイプ 説明
    文字列 このメソッドによって返される可能性のある状態は次のとおりです。
    • 開始日時
    • [Active (アクティブ)]
    • 完了
    • キャンセル
    		 
    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オブジェクトをシリアル化します。

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

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