Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


1.3.3 Members of the search range

This section describes the members of the search range (IpAddrRanges resource).

Member name Data type Description Whether to change Whether applicable to filter conditions ($query) Whether applicable to sort conditions ($order-by)
instanceID long

ID for identifying the instance

N N N
name string

Name of the search range

Y N N
ipAddrRange string[]

Search range. Specify the start IP address of the search in the number 0 item of the list. Specify the end IP address of the search in the number 1 item of the list.

Y N N
usePing boolean

Specify whether to execute ping on the target devices during retrieval.

  • true: Use ping.
  • false: Do not use ping.

If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential.

Y N N
aliveMonitoring boolean

Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets.

  • true: Register as alive-monitoring targets.
  • false: Do not register as alive-monitoring targets.

If you specify true for this item, specify true for usePing.

Y N N
useAllCredential boolean

Whether to use all Credential resources

  • true: All Credential resources are used.
  • false: Not all Credential resources are used.
Y N N
selectedCredentials Credential[]

List of authentication information items to be used in a search

Y N N
useAllPlugin boolean
Whether to use all Plug-in resources
  • true: All Plug-inresources are used.
  • false: Not all Plug-in resources are used.
Y N N
selectedPlugins Plugin[] A list of plug-in information to be used to perform searches Y N N
deviceClassificationLabel string Name of the classification label assigned to the device Y N N
numOfRelatedPluginResources int Number of plug-in resources found by using retrieval range. N N N

(Legend) Y: Applicable, N: Not applicable