Tuning Manager APIリファレンスガイド

[目次][索引][前へ][次へ]

3.10 HTM - Agents情報の取得

HTM - Agents情報を取得する方法を示します。

HTTPリクエスト構文（URI）

PUT  <scheme>://<host>:<port>/<application>/<version>/services/agent-manager/actions/list/invoke

リクエストの構造

リクエストボディの構造を次に示します。

 
{
    "agentType" : "<エージェント種別>"
}

表3-10 情報の取得時のリクエストボディのスキーマ

変数名 型 指定要否 説明
agentType string 必須 エージェント種別
  • HTM - Agent for RAIDの場合：raid
  • HTM - Agent for NASの場合：nas
  • すべてのエージェント種別の場合：all

レスポンスの構造

{
    "data": [
        {
            "agentType": "...",
            "hostName": "...",
            "instanceName": "...",
            "model": "...",
            "serialNumber": "...",
            "smuIp": "...",
            "destIp": "...",
            "detourIp": "...",
            "lastMonitoredTime": "<YYYY-MM-DDThh:mm:ssZ>"
        },
        {
                   :
        },
                   :
    ]
}

表3-11 情報の取得時のレスポンスボディのスキーマ

変数名 型 説明
data
― agentType string エージェントの種別
  • HTM - Agent for RAIDの場合：RAID
  • HTM - Agent for NASの場合：NAS
hostName string エージェントのホスト名
instanceName string エージェントのインスタンス名
model string ストレージシステムの機種名※1
serialNumber string ストレージシステムのシリアル番号※1
smuIp string 外部NAS Managerを特定するための情報
外部NAS Managerで管理されるNAS Platformのインスタンスを作成するときに指定したSMU/NAS Manager IP Addressが返却されます。
destIp string Hitachi Virtual File Platform※2を特定するための情報
Hitachi Virtual File Platform※2のインスタンスを作成するときに指定したdestination_addressが返却されます。
detourIp string Hitachi Virtual File Platform※2を特定するための情報
Hitachi Virtual File Platform※2のインスタンスを作成するときに指定したdetour_addressが返却されます。
lastMonitoredTime string エージェントステータスを最後に更新した時間
YYYY-MM-DDThh:mm:ssZ

注※1
次の場合はnullとなります。
  • Tuning Manager Agent REST API コンポーネントのサービス（Tuning Manager - Agent REST Web Service およびTuning Manager - Agent REST Application Service）が停止している，または，正常ではない状態で，HTM - Agents情報の更新処理を実行した場合
この場合は，次の手順を実施してください。
  1. 次のコマンドを実行して，Tuning Manager Agent REST API コンポーネントのサービスを停止します。
    Windowsの場合：
    <エージェントのインストール先フォルダ>\htnm\bin\htmsrv stop -webservice
    Linuxの場合：
    <エージェントのインストール先ディレクトリ>/htnm/bin/htmsrv stop -webservice
  2. htmRestDbEngineMessage#.logを確認して，エラーの要因を取り除きます。
    htmRestDbEngineMessage#.logの格納先については，マニュアル「Hitachi Command Suite Tuning Manager - Agents」のTuning Manager API使用時のログ情報について説明している個所を参照してください。
  3. 次のコマンドを実行して，Tuning Manager Agent REST API コンポーネントのサービスを再起動します。
    Windowsの場合：
    <エージェントのインストール先フォルダ>\htnm\bin\htmsrv start -webservice
    Linuxの場合：
    <エージェントのインストール先ディレクトリ>/htnm/bin/htmsrv start -webservice
  4. HTM - Agents情報の更新処理を再実行します。
  5. HTM - Agents情報の取得処理を再実行します。

注※2
次のファイルサーバを総称して，「Hitachi Virtual File Platform」と呼びます。
  • Hitachi Virtual File Platform
  • Hitachi Capacity Optimization
  • Hitachi Essential NAS Platform

実行例（HTM - Agents情報の取得）

curlコマンドを使用したリクエストメッセージ：

curl -v -u system:manager -H "Content-Type: application/json" -d '{"agentType":"all"}' -X PUT http://server_1:22015/DeviceManagerWebService/analytics/v1/services/agent-manager/actions/list/invoke | python -m json.tool

リクエストに対する実行結果／

リクエストヘッダー：

PUT /DeviceManagerWebService/analytics/v1/services/agent-manager/actions/list/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.13.1.0 zlib/1.2.3 libidn/1.18 libssh2/1.2.2
Host: server_1:22015
Accept: */*
Content-Type: application/json
Content-Length: 19

レスポンスヘッダー：

HTTP/1.1 200 OK
Date: Tue, 20 Oct 2015 07:07:40 GMT
Server: Cosminexus HTTP Server
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json;charset=UTF-8

レスポンスボディ：

{
    "data": [
        {
            "agentType": "RAID",
            "hostName": "agent_1",
            "instanceName": "VSPG1000_instance",
            "model": "VSP G1000",
            "serialNumber": "10182",
            "lastMonitoredTime": "2015-10-20T07:07:37Z",
            "formatVersion": "1.0"
        },
        {
            "agentType": "RAID",
            "hostName": "agent_1",
            "instanceName": "VSP_instance",
            "model": "VSP",
            "serialNumber": "53039",
            "lastMonitoredTime": "2015-10-20T07:07:37Z",
            "formatVersion": "1.0"
        },
        {
            "agentType": "RAID",
            "hostName": "agent_1",
            "instanceName": "USPV_instance",
            "model": "USP V",
            "serialNumber": "10007",
            "lastMonitoredTime": "2015-10-20T07:07:37Z",
            "formatVersion": "1.0"
        }
    ]
}

[目次] [前へ] [次へ]

[マニュアル発行元]

All Rights Reserved. Copyright© 2014, 2020, Hitachi, Ltd.