2.5.4 コレクターの更新
指定したコレクターに含まれるユーザーIDとパスワードの更新を行います。ただし、任意のアプリケーションのコレクターは更新できません。
権限
Admin
APIのバージョン
v1
リクエスト形式
PUT http[s]://host:port/Analytics/version/objects/Collectors/{id}
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。{ "name":"...", "collectorType":"...", "osType":"...", "autoCollectionType":"...", "collectorCredentials":[{ "requireHostAddress":"...", "ipAddress":"...", "accessTargetIdentification":"...", "userId":"...", "password":"...", "updatePassword":"...", "portNumber":"...", "optionalInformation1":"...", "updateOptionalInformation1":"...", "optionalInformation2":"...", "updateOptionalInformation2":"...", "optionalInformation3":"...", "updateOptionalInformation3":"...", "useProxy":"...", "proxyHostAddr":"...", "proxyPort":"...", "proxyUser":"...", "updateProxyPassword":"...", "proxyPassword":"...", "hypertextTransferProtocolType":"...", "domainName":"...", "rootPassword":"...", "updateRootPassword":"...", "useAdministrativeShares":"...", "shareName":"...", "sharedFolder":"...", "logicalHostName":"...", "useLogicalHostName":"..." }, : ], "plugin":{ "instanceID":"..." } }
Collector (Type: Collector)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
コレクターの名称 |
collectorType |
enum |
コレクターの種別 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
osType |
enum |
コレクターのOS種別。コレクターの種別(collectorType)が「AJS」,「PFM」,「IM」の場合のみ指定します (指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。) |
autoCollectionType |
enum |
コレクターの定期実行の設定 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
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つ目の設定値の項目。Base64でエンコードして指定します。 |
updateOptionalInformation1 |
boolean |
オプション1を変更する場合にtrueを設定する。更新時のみ使用。 |
optionalInformation2 |
string |
プラグインにて使用できる情報取得用のオプション情報。2つ目の設定値の項目。Base64でエンコードして指定します。 |
updateOptionalInformation2 |
boolean |
オプション2を変更する場合にtrueを設定する。更新時のみ使用。 |
optionalInformation3 |
string |
プラグインにて使用できる情報取得用のオプション情報。3つ目の設定値の項目。Base64でエンコードして指定します。 |
updateOptionalInformation3 |
boolean |
オプション3を変更する場合にtrueを設定する。更新時のみ使用。 |
useProxy |
boolean |
カスタムコレクターの接続にプロキシを介す場合trueを指定する。 |
proxyHostAddr |
string |
プロキシを使用する場合のプロキシホストアドレス。 |
proxyPort |
int |
プロキシを使用する場合のプロキシポート。 |
proxyUser |
string |
プロキシを使用する場合のプロキシの認証ユーザ。 |
updateProxyPassword |
boolean |
プロキシパスワードを変更する場合にtrueを設定する。更新時のみ使用。 |
proxyPassword |
string |
プロキシを使用する場合のプロキシの認証パスワード。Base64でエンコードして指定します。 |
hypertextTransferProtocolType |
enum |
管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。 (指定可能な値は「列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
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の表を参照してください。) 以下に示す値のみ指定可能です。
|
osType |
enum |
コレクターのOS種別。コレクターの種別(collectorType)が「AJS」,「PFM」,「IM」の場合のみ指定します (指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。) |
autoCollectionType |
enum |
コレクターの定期実行の設定 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
connectResult |
enum |
コレクター の最新の実行結果 (指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
refreshStatus |
enum |
コレクター の実行状態 (指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
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の表を参照してください。) 以下に示す値のみ指定可能です。
|
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の表を参照してください。) 以下に示す値のみ指定可能です。
|
formatversion |
string |
プラグインのフォーマットバージョン |
pluginversion |
string |
プラグインのバージョン |
pluginType |
enum |
プラグインの種別 (指定可能な値は「列挙型一覧」のPluginTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
numOfRelatedResources |
int |
プラグイン情報を用いて発見されたリソースの数 |
isCollector |
boolean |
コレクターであるかどうか。 |
status |
enum |
プラグインの状態 (指定可能な値は「列挙型一覧」のPluginStatusTypeの表を参照してください。) |
ステータスコード
HTTPステータスコード |
Reason phrase |
説明 |
---|---|---|
200 |
OK |
正常終了 |
400 |
Bad Request |
・リクエストボディ形式不正 ・リクエスト不正 |
401 |
Unauthorized |
ログイン権限がない |
403 |
Forbidden |
更新権限がない |
404 |
Not Found |
リソースが存在しない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] PUT /Analytics/v1/objects/Collectors/11 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: 482 [Request Body] { "instanceID" : 11, "name" : "vCenterMonitoring", "collectorType" : "VCENTER", "autoCollectionType" : "AutoConnect", "connectResult" : "NoConnect", "refreshStatus" : "NoConnect", "numOfHypervisors" : 0, "numOfVms" : 0, "collectorCredentials" : [ { "ipAddress" : "172.17.17.116", "userId" : "Administrator", "updatePassword" : true, "password" : "c3lzdGVtOm1hbmFnZXI=", "portNumber" : 443, "hypertextTransferProtocolType" : "HTTPS" } ] } [Response Header] HTTP/1.1 200 OK Date: Fri, 27 Nov 2015 08:42:46 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO ea7ee5beeebb36f7aeb0571ff9adba9e12fca4_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "instanceID" : 11, "name" : "vCenterMonitoring", "collectorType" : "VCENTER", "autoCollectionType" : "AutoConnect", "connectResult" : "NoConnect", "refreshStatus" : "NoConnect", "numOfHypervisors" : 0, "numOfVms" : 0, "numOfApplications" : 0, "numOfContainers": 0, "numOfServices": 0, "numOfResources" 0, "collectorCredentials" : [ { "ipAddress" : "172.17.17.116", "userId" : "Administrator", "portNumber" : 443, "hypertextTransferProtocolType" : "HTTPS" } ] }