Hitachi

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

2.5.3　コレクターの作成

コレクターを新規に作成します。ただし、任意のアプリケーションのコレクターは作成できません。

権限

Admin

APIのバージョン

v1

リクエスト形式

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

リクエストボディー

リクエストボディーの構造とオブジェクトの属性を次に示します。
{
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "collectorCredentials":[{
            "requireHostAddress":"...",
            "ipAddress":"...",
            "accessTargetIdentification":"...",
            "userId":"...",
            "password":"...",
            "updatePassword":"...",
            "portNumber":"...",
            "optionalInformation1":"...",
            "updateOptionalInformation1":"...",
            "optionalInformation2":"...",
            "updateOptionalInformation2":"...",
            "optionalInformation3":"...",
            "updateOptionalInformation3":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "rootPassword":"...",
            "updateRootPassword":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "plugin":{
            "instanceID":"..."
        }
}

Collector (Type: Collector)

属性

データ型

説明

name

string

コレクターの名称

collectorType

enum

コレクターの種別

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

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

  • VCENTER
  • AJS
  • PFM
  • IM
  • CUSTOM

osType

enum

コレクターのOS種別。コレクターの種別(collectorType)が「AJS」，「PFM」，「IM」の場合のみ指定します

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

autoCollectionType

enum

コレクターの定期実行の設定

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

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

  • AutoConnect
  • NotAutoConnect

collectorCredentials

CollectorCredential[]

監視対象の接続に使用する認証情報

plugin

Plugin

コレクターに適用されたプラグインの詳細情報

collectorCredentials (Type: CollectorCredential)

属性

データ型

説明

requireHostAddress

boolean

IPアドレスまたはホスト名が必要かを判断するフラグ。

・true: IPアドレスが必須。接続先識別キーが不要。

・false: IPアドレスが不要。接続先識別キーが必須。

HTTPプロトコルで使用。

ipAddress

string

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名

accessTargetIdentification

string

IPアドレスを指定しない場合の接続先識別キー。

userId

string

管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。

password

string

管理ソフトウェアへの接続に使用するパスワード。255byte以下の文字列をBase64でエンコードして指定します。

updatePassword

boolean

管理ソフトウェアへの接続に使用するパスワードを変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

portNumber

int

管理ソフトウェアへの接続に使用するポート番号。

optionalInformation1

string

プラグインにて使用できる情報取得用のオプション情報。1つ目の設定値の項目。

updateOptionalInformation1

boolean

オプション1を変更する場合にtrueを設定する。更新時のみ使用。

optionalInformation2

string

プラグインにて使用できる情報取得用のオプション情報。2つ目の設定値の項目。

updateOptionalInformation2

boolean

オプション2を変更する場合にtrueを設定する。更新時のみ使用。

optionalInformation3

string

プラグインにて使用できる情報取得用のオプション情報。3つ目の設定値の項目。

updateOptionalInformation3

boolean

オプション3を変更する場合にtrueを設定する。更新時のみ使用。

hypertextTransferProtocolType

enum

管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。

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

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

  • HTTP
  • HTTPS

domainName

string

ドメイン名。アプリケーション連携でWindows選択時に使用。

rootPassword

string

rootパスワード。アプリケーション連携でUnix選択時に使用。

updateRootPassword

boolean

パスワードを変更する場合にtrueを設定する。更新時のみ使用。

useAdministrativeShares

boolean

管理共有を行う場合にtrueを設定する

shareName

string

共有名

sharedFolder

string

共有フォルダのパス

logicalHostName

string

論理ホスト名

useLogicalHostName

boolean

論理ホスト名を使用する場合にtrueに設定する

plugin (Type: Plugin)

属性

データ型

説明

instanceID

long

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

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。
{
        "instanceID":"...",
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "connectResult":"...",
        "refreshStatus":"...",
        "message":"...",
        "lastRefreshed":"...",
        "refreshDateForInventory":"...",
        "refreshDateForPerformance":"...",
        "refreshDateForState":"...",
        "numOfHypervisors":"...",
        "numOfVms":"...",
        "numOfHosts":"...",
        "numOfApplications":"...",
        "numOfContainers":"...",
        "numOfServices":"...",
        "numOfResources":"...",
        "collectorCredentials":[{
            "requireHostAddress":"...",
            "ipAddress":"...",
            "accessTargetIdentification":"...",
            "userId":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "productName":"...",
        "providerName":"...",
        "refreshDateForApp":"...",
        "plugin":{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        }
}

Collector (Type: Collector)

属性

データ型

説明

instanceID

long

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

name

string

コレクターの名称

collectorType

enum

コレクターの種別

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

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

  • VCENTER
  • AJS
  • PFM
  • IM
  • CUSTOM

osType

enum

コレクターのOS種別。コレクターの種別(collectorType)が「AJS」，「PFM」，「IM」の場合のみ指定します

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

autoCollectionType

enum

コレクターの定期実行の設定

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

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

  • AutoConnect
  • NotAutoConnect

connectResult

enum

コレクター の最新の実行結果

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

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

  • NoConnect
  • Succeeded
  • Failed

refreshStatus

enum

コレクター の実行状態

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

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

  • NoConnect
  • InProgress

message

string

コレクターの実行結果のメッセージ

lastRefreshed

dateTime

最終リフレッシュ日時。以下のうち最新の日時情報が反映されます。

・refreshDateForInventory

・refreshDateForPerformance

・refreshDateForState

refreshDateForInventory

dateTime

構成情報のリフレッシュ日時

refreshDateForPerformance

dateTime

性能情報のリフレッシュ日時

refreshDateForState

dateTime

状態情報のリフレッシュ日時。以下のいずれかの条件に該当する場合に取得できます。

・コレクターの種別がVCENTERである。

・「状態の収集（仮想マシン／ハイパーバイザー）」の収集間隔の設定が有効である。

numOfHypervisors

int

コレクターにより発見されたハイパーバイザーの数

numOfVms

int

コレクターにより発見された仮想マシンの数

numOfHosts

int

コレクターにより発見されたホストの数

numOfApplications

int

コレクターにより発見されたアプリケーションの数

numOfContainers

int

コレクターにより発見されたコンテナノードの数

numOfServices

int

コレクターにより発見されたサービスリソースの数

numOfResources

int

コレクターにより発見された管理リソースの数

collectorCredentials

CollectorCredential[]

監視対象の接続に使用する認証情報

productName

string

収集対象製品名。コレクターの種別が「CUSTOM_APP」の場合に取得できます。

providerName

string

コレクター作成者。コレクターの種別が「CUSTOM_APP」の場合に取得できます。

refreshDateForApp

dateTime

定義反映日時。コレクターの種別が「CUSTOM_APP」の場合に取得できます。

plugin

Plugin

コレクターに適用されたプラグインの詳細情報

collectorCredentials (Type: CollectorCredential)

属性

データ型

説明

requireHostAddress

boolean

IPアドレスまたはホスト名が必要かを判断するフラグ。

・true: IPアドレスが必須。接続先識別キーが不要。

・false: IPアドレスが不要。接続先識別キーが必須。

HTTPプロトコルで使用。

ipAddress

string

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名

accessTargetIdentification

string

IPアドレスを指定しない場合の接続先識別キー。

userId

string

管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。

portNumber

int

管理ソフトウェアへの接続に使用するポート番号。

hypertextTransferProtocolType

enum

管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。

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

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

  • HTTP
  • HTTPS

domainName

string

ドメイン名。アプリケーション連携でWindows選択時に使用。

useAdministrativeShares

boolean

管理共有を行う場合にtrueを設定する

shareName

string

共有名

sharedFolder

string

共有フォルダのパス

logicalHostName

string

論理ホスト名

useLogicalHostName

boolean

論理ホスト名を使用する場合にtrueに設定する

plugin (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/Collectors HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 236

[Request Body]
{
  "name": "test Collector",
  "autoCollectionType": "AutoConnect",
  "collectorType": "VCENTER",
  "collectorCredentials": [
    {
      "ipAddress": "172.17.17.113",
      "userId": "test",
      "password": "dGVzdA==",
      "portNumber": 443,
      "hypertextTransferProtocolType": "HTTPS"
    }
  ]
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 27 Nov 2015 08:23:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO bfb7bb1ac5122d4e95bddc86cfb215f4c04715_WVlGcHsLfg5ffg0I_V0810
Location: http://localhost:22015/Analytics/v1/objects/Collectors/13
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "instanceID" : 13,
  "name" : "vCenter_71",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "Succeeded",
  "refreshStatus" : "NoConnect",
  "lastRefreshed" : "2016-11-21T17:17:59.926+09:00",
  "refreshDateForInventory" : "2016-11-21T16:52:03.271+09:00",
  "refreshDateForPerformance" : "2016-11-21T17:17:59.926+09:00",
  "numOfHypervisors" : 3,
  "numOfVms" : 33,
  "numOfApplications" : 0,
  "numOfContainers": 0,
  "numOfServices": 0,
  "numOfResources" 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.25.73.71",
    "userId" : "administrator@vsphere.local",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

関連項目

ページの先頭へ

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