Hitachi

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

2.3.3　探索範囲の作成

探索範囲を新規に作成します。

権限

Admin

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/IpAddrRanges

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。
{
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "aliveMonitoring":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"..."
        },
        :
        ],
        "useAllPlugin":"...",
        "selectedPlugins":[{
            "instanceID":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

属性

データ型

説明

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 を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。

selectedCredentials

Credential[]

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

useAllPlugin

boolean

すべてのプラグインを使用するかどうかのフラグ。"すべて"のプラグインを使用する場合はtrueを指定します。

selectedPlugins

Plugin[]

探索に使用するプラグイン情報のリスト。useAllPluginがfalseで、探索に使用するプラグイン情報のリストが存在する場合に返却します。

deviceClassificationLabel

string

機器に割り当てられた分類ラベル

selectedCredentials (Type: Credential)

属性

データ型

説明

instanceID

long

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

selectedPlugins (Type: Plugin)

属性

データ型

説明

instanceID

long

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

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。
{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "aliveMonitoring":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "useAllPlugin":"...",
        "selectedPlugins":[{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        },
        :
        ],
        "deviceClassificationLabel":"...",
        "numOfRelatedPluginResources":"..."
}

IPAddrRange (Type: IPAddrRange)

属性

データ型

説明

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 を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。

selectedCredentials

Credential[]

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

useAllPlugin

boolean

すべてのプラグインを使用するかどうかのフラグ。"すべて"のプラグインを使用する場合はtrueを指定します。

selectedPlugins

Plugin[]

探索に使用するプラグイン情報のリスト。useAllPluginがfalseで、探索に使用するプラグイン情報のリストが存在する場合に返却します。

deviceClassificationLabel

string

機器に割り当てられた分類ラベル

numOfRelatedPluginResources

int

探索範囲を用いて発見されたプラグインリソースの数。

selectedCredentials (Type: Credential)

属性

データ型

説明

instanceID

long

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

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

  • WMI
  • SSH
  • WBEM
  • SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用しない。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

  • V1_V2C
  • V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

  • MD5
  • SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

  • DES
  • AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

selectedPlugins (Type: Plugin)

属性

データ型

説明

instanceID

long

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

name

string

プラグインの名称

pluginId

string

プラグインを特定するID

protocolType

enum

監視対象への接続に使用するプロトコル

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

  • SNMP

formatversion

string

プラグインのフォーマットバージョン

pluginversion

string

プラグインのバージョン

pluginType

enum

プラグインの種別

(指定可能な値は「列挙型一覧」のPluginTypeの表を参照してください。)

以下に示す値のみ指定可能です。

  • NODE_PLUGIN

numOfRelatedResources

int

プラグイン情報を用いて発見されたリソースの数

isCollector

boolean

コレクターであるかどうか。

status

enum

プラグインの状態

(指定可能な値は「列挙型一覧」のPluginStatusTypeの表を参照してください。)

ステータスコード

HTTPステータスコード

Reason phrase

説明

201

Created

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/IpAddrRanges HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Request Body]
{
  "name": "yy_system_OS",
  "ipAddrRange": [
    "10.197.53.1",
    "10.197.53.200"
  ],
  "usePing": true,
  "aliveMonitoring": false,
  "useAllCredential": false,
  "selectedCredentials": [
    {
      "instanceID": 51
    },
    {
      "instanceID": 52
    }
  ],
  "deviceClassificationLabel": "YY SYSTEM"
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 06 Sep 2019 09:36:53 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6854c0241fe8687e5c5260973a74212b7f61527f_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
Location: http://JP1OAServer:22015/Analytics/v1/objects/IpAddrRanges/101
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked

[Response Body]
{
  "instanceID" : 101,
  "name" : "yy_system_OS",
  "ipAddrRange" : [ "10.197.53.1", "10.197.53.200" ],
  "usePing" : true,
  "aliveMonitoring" : false,
  "useAllCredential" : false,
  "selectedCredentials" : [ {
    "instanceID" : 51,
    "name" : "yy_system_linux",
    "credentialType" : "SSH",
    "userId" : "operator",
    "portNumber" : 22,
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 52,
    "name" : "yy_system_windows",
    "credentialType" : "WMI",
    "userId" : "admin",
    "passwordNotRequired" : false,
    "domainname" : "workspace",
    "numOfRelatedResources" : 0
  } ],
  "deviceClassificationLabel" : "YY SYSTEM"
}

関連項目

ページの先頭へ

All Rights Reserved. Copyright (C) 2019, 2022, Hitachi, Ltd.