DiscoveryAPI - スコープ対象

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む5読むのに数分

    • DiscoveryAPI - スコープ指定クラスのメソッドは、単一の IPv4 アドレスのクイック検出を起動し、単一の CI またはすべてのスキャン済み CI について、以前に起動された Discovery ステータスのサマリーを返します。

    スコープ指定の DiscoveryAPI - discoverIpAddress(文字列 ipAddress, 文字列 application, 文字列 source)

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

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

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

    パラメーターではなくapplicationパラメーターを定義するsourceには、プレースホルダーとして "NULL" を使用します。

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

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

    スコープ指定の DiscoveryAPI - reportCiIpAddressStatus(オブジェクト ipAddress, オブジェクト discoveryStatusSysId)

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

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

    スコープ対象 DiscoveryAPI - reportCiStatus(オブジェクト discoveryStatusSysId)

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

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