DiscoveryAPI :スコープ対象

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：5分

    • DiscoveryAPI クラスは、単一の IPv4 アドレスのクイックディスカバリーを起動し、単一の構成アイテム (CI) またはすべてのスキャン済み CI について、以前に起動されたディスカバリーステータスのサマリーを返すメソッドを提供します。

    このクラスは sn_discovery 名前空間にあります。

    DiscoveryAPI - discoverIpAddress(文字列 ipAddress, 文字列 application, 文字列 source)

    指定された IPv4 アドレスを検出します。

    指定された IP アドレスまたは指定されたアプリケーションに基づいて、MID サーバーが自動的に選択されます。

    表 : 1. パラメーター
    名前 タイプ 説明
    application 文字列 オプション。MID サーバー用に構成されたアプリケーション。

    sourceパラメーターを定義するが、applicationパラメーターは定義しない場合は、プレースホルダーとして「NULL」を使用します。

    デフォルト:ディスカバリー
    ipAddress 文字列 検出する IP アドレス。
    ソース 文字列 オプション。ディスカバリーのソース。これと同じ値が、ディスカバリーステータスレコードのオプションの [ソース ] フィールドに表示されます。この値は、ディスカバリーがどのようにトリガーされたかを示します。

    デフォルト:Discovery_API
    表 : 2. 戻り値
    タイプ 説明
    文字列 ディスカバリーステータスレコードsys_id
    MID サーバーの選択中に次の例外がスローされる可能性があります。
    • NoSuitableMidServerFoundException: このディスカバリーに利用可能な適切な MID サーバーがありません
    • BadArgumentException: MID サーバーの選択中に無効な引数が検出されました
    		 
    var sysid = sn_discovery.DiscoveryAPI.discoverIpAddress("11.23.125.39");

    DiscoveryAPI:reportCiIpAddressStatus(オブジェクト ipAddress、オブジェクト discoveryStatusSysId)

    特定のステータスsys_idと IPv4 アドレスを指定して、構成アイテムのディスカバリーステータスのサマリーを返すために使用されます。

    次の例外をスローできます。
    • DiscoveryStatusNotFoundException: 次のメッセージが表示されます:sys id「<invalid value> のディスカバリーステータスは存在しません
    • DiscoveryDeviceHistoryNotFoundException: ディスカバリーステータス Sys ID が「<invalid value>」で ipAddress が「<invalid value>」のデバイス履歴が存在しません
    • IllegalArgumentException (無効な入力引数): この引数の例外により、入力値が null になるのを防ぎます。
      • ディスカバリーステータス Sys ID を null にすることはできません
      • ipAddress を null にすることはできません
    • IllegalArgumentException (データベースに格納されている値): この引数の例外は、属性値が正しくない場合に、誤ったデータが呼び出し元に返されるのを防ぎます。
      • ディスカバリーステータスの「ステータス」プロパティを null にすることはできません
      • デバイス履歴の「source」プロパティを null にすることはできません
      • デバイス履歴の「問題」プロパティが整数ではありません:<無効な値>
      • デバイス履歴の「問題」プロパティを 0 未満にすることはできません:<無効な値>
    表 : 3. パラメーター
    名前 タイプ 説明
    ipAddress 文字列 スキャンされた IPv4 アドレス。
    discoveryStatusSysId 文字列 スキャンされた IP アドレスのディスカバリーステータスレコードのsys_id。
    表 : 4. 戻り値
    タイプ 説明
    アレイ 不変の ReportCiStatusOutputJS オブジェクトの JavaScript 配列。 
    var ipResultObj = sn_discovery.DiscoveryAPI.reportCiIpAddressStatus(ipAddress, discoveryStatus);

    DiscoveryAPI:reportCiStatus(オブジェクト discoveryStatusSysId)

    特定のディスカバリーステータスsys_idを指定して、CI ディスカバリーステータスのサマリーを返すために使用されます。

    次の例外をスローできます。
    • DiscoveryStatusNotFoundException: sys id「<invalid value>」のディスカバリーステータスは存在しません
    • DiscoveryDeviceHistoryNotFoundException: ディスカバリーステータス Sys ID が「<invalid value>」で ipAddress が「<invalid value>」のデバイス履歴が存在しません
    • IllegalArgumentException (無効な入力引数): この引数の例外により、入力値が null になるのを防ぎます。
      • ディスカバリーステータス Sys ID を null にすることはできません
      • ipAddress を null にすることはできません
    • IllegalArgumentException (データベースに格納されている値): この引数の例外は、データベースアクセス値に事後条件を課します。
      • ディスカバリーステータスの「ステータス」プロパティを null にすることはできません
      • デバイス履歴の「source」プロパティを null にすることはできません
      • デバイス履歴の「問題」プロパティが整数ではありません:<無効な値>
      • デバイス履歴の「問題」プロパティを 0 未満にすることはできません:<無効な値>
    表 : 5. パラメーター
    名前 タイプ 説明
    sys_id 文字列 ディスカバリーステータスレコードのsys_id。
    表 : 6. 戻り値
    タイプ 説明
    アレイ 不変の ReportCiStatusOutputJS オブジェクトの JavaScript 配列。 
    var ipResultObjArray = sn_discovery.DiscoveryAPI.reportCiStatus(discoveryStatus);
for(var idx=0; idx < ipResultObjArray.length; idx++) {    
var ipResultObj = ipResultObjArray[idx];