Hitachi

JP1 Version 12 JP1/Operations Analytics REST APIリファレンス


1.3.3 探索範囲のメンバー

探索範囲(IpAddrRangesリソース)のメンバーについて説明します。

メンバー名 データ型 説明 変更可否 フィルター条件($query)への適用 ソート条件($order-by)への適用
instanceID long

インスタンスを特定するID

× × ×
name string

探索範囲の名称

× ×
ipAddrRange string[]

探索範囲。リストの0番目に探索開始IPアドレス,リストの1番目に探索終了IPアドレスを指定します。

× ×
usePing boolean

探索実行時に,対象機器に対してpingを実施するかどうかを指定します。

  • true:pingを使用します。
  • false:pingを使用しません。

trueを指定する場合は,必ずaliveMonitoringを設定してください。usePingにfalseを設定する場合または,usePingにtrueを指定し,aliveMonitoringにfalseを指定する場合は,必ずselectedCredentialsまたはuseAllCredentialにtrueを指定してください。

× ×
aliveMonitoring boolean

探索実行時に,設定されている認証情報で探索できなかった場合に,対象機器に対してpingを実行し,接続確認できたリソースを死活監視対象として登録するかどうかを指定します。認証情報の設定がない場合は,接続確認できたリソースを死活監視対象として登録します。

  • true:死活監視をします。
  • false:死活監視をしません。

trueを指定する場合は,必ずusePingをtrueに設定してください。

× ×
useAllCredential boolean

すべてのCredentialを使用するかどうか。

  • true:すべてのCredentialを使用する。
  • false:すべてのCredentialを使用しない。
× ×
selectedCredentials Credential[]

探索に使用する認証情報のリスト

× ×
useAllPlugin boolean
すべてのプラグインを使用するかどうか。
  • true:すべてのプラグインを使用する。
  • false:すべてのプラグインを使用しない。
× ×
selectedPlugins Plugin[] 探索に使用するプラグインのリスト × ×
deviceClassificationLabel string 機器に割り当てられた分類ラベル × ×
numOfRelatedPluginResources int 探索範囲を用いて発見されたプラグインリソースの数。 × × ×

(凡例)○:適応します。 ×:適応しません。