Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


1.8.2 Creating a search range

This section describes the format of the request to be used for creating a search range and the method for creating a request body.

Procedure

  1. Acquire a search range of your choice, so that the acquired search range can be used as a template. Issue the request in the following format:

    GET http://host:port/Analytics/version/objects/IpAddrRanges
  2. Edit the search range (the IpAddrRanges resource) that you acquired in step 1 according to the table below.

    Table 1‒2: Changes to the IpAddrRanges resource

    Member to change

    Whether to change

    Description

    name

    Required

    Change the name to the name of the search range to be created.

    You must specify a name that does not exist in the search range that is already registered.

    ipAddrRange

    Required

    Specify the IP addresses of the range to search. You muse specify a range that does not exist in the search ranges that are already registered.

    usePing

    Optional

    To use Ping in the search, specify true.

    aliveMonitoring

    Optional

    If the search cannot be performed by using the authentication information that is specified at the time of the search, specify true to register, as alive-monitoring targets, resources for which a connection has been confirmed. This can be specified only when true is specified for usePing.

    useAllCredential

    Optional

    To use all authentication information in the search, specify true.

    selectedCredentials

    Optional

    Specify the authentication information that you want to use. For details on how to specify authentication information, see 1.8.1 Creating authentication information.

    useAllPlugin

    Optional

    To use all plug-in information in the search, specify true.

    selectedPlugins

    Optional

    Specify the plug-in information that you want to use. If you want to specify plug-in information, specify false for useAllPlugin.

    deviceClassificationLabel

    Optional

    Specify the name of the classification label assigned to the device.

  3. Issue the request in the following format. Specify the search range you edited in step 2 in the request body.

    POST http://host:port/Analytics/version/objects/IpAddrRanges