Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド


19.2 ストレージシステムに搭載されたハードウェアの情報を取得する

コントローラの温度やバッテリーの状態など、ストレージシステムに搭載されたハードウェアの情報を取得します。
メモ

このAPIは、VSP 5000 シリーズVSP E シリーズVSP Gx00 モデルVSP G1000VSP G1500VSP Fx00 モデルまたはVSP F1500の場合に使用できます。

実行権限

ストレージ管理者(参照)

リクエストライン

GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/components/instance

リクエストメッセージ

オブジェクトID
instanceを指定します。instanceは、単一のインスタンスしか持たないオブジェクトの場合に、オブジェクトID として指定する固定の値です。
クエリパラメータ

パラメータ

説明

componentOption

string

ストレージシステムがVSP G1000VSP G1500VSP F1500の場合

(必須)取得する詳細情報のタイプ

ストレージシステムがVSP 5000 シリーズVSP E シリーズVSP Gx00 モデルVSP Fx00 モデルの場合

(任意)取得する詳細情報のタイプ

このパラメータに指定できる値を次に示します。

  • class

    ストレージシステムのキャッシュからストレージシステムに搭載されたハードウェアの情報を取得します。

    ストレージシステムがVSP 5000 シリーズVSP E シリーズVSP Gx00 モデルVSP G1000VSP G1500VSP Fx00 モデルVSP F1500の場合に指定できます。VSP E シリーズVSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900の場合、SVP と連携する構成のときに指定できます。

    ストレージシステムがVSP G1000VSP G1500VSP F1500の場合は必ず指定してください。

    最新の情報を取得する場合、事前にストレージシステムの構成情報のキャッシュを更新するAPI を実行する必要があります。詳細については、「ストレージシステムの構成情報のキャッシュを更新する」の説明を参照してください。

    クエリパラメータでcomponentOptionclassを指定した場合、詳細情報だけが取得されます。

ボディ

なし。

レスポンスメッセージ

ボディ
{
    "system": {
        "powerConsumption": 283
    },
    "ctls": [
        {
            "location": "CTL1",
            "status": "Normal",
            "temperature": 29,
            "temperatureStatus": "Normal",
            "charge": 100,
            "type": "Controller Board"
        },
        {
            "location": "CTL2",
            "status": "Normal",
            "temperature": 29,
            "temperatureStatus": "Normal",
            "charge": 100,
            "type": "Controller Board"
        }
    ],
    "cacheMemories": [
        {
            "location": "CTL1 CMG0",
            "status": "Normal",
            "cacheSize": 16
        },
        {
            "location": "CTL2 CMG0",
            "status": "Normal",
            "cacheSize": 16
        }
    ],
    "chbs": [
        {
            "location": "CHB-1A",
            "status": "Normal",
            "type": "10G 2Port iSCSI (Optic)"
        },
        {
            "location": "CHB-2A",
            "status": "Normal",
            "type": "10G 2Port iSCSI (Optic)"
        }
    ],
    "cacheFlashMemories": [
        {
            "location": "CFM-1",
            "status": "Normal",
            "type": "BM05"
        },
        {
            "location": "CFM-2",
            "status": "Normal",
            "type": "BM05"
        }
    ],
    "dkbs": [],
    "lanbs": [],...
}

※が付いている属性は、ハードウェアが存在せず情報を取得できなかった場合には、オブジェクト配下の属性が出力されません。

属性

説明

system

object

ストレージシステムの情報に関する属性が出力されます。

  • powerConsumption(int)

    ストレージシステムの消費電力(W)

    コントローラおよびドライブボックスが1分間に消費する電力の平均が出力されます。

    有効な値が取得できなかった場合は、-1が出力されます。

ctls

object[]

コントローラの情報に関する属性が出力されます。

  • location(string)

    コントローラのロケーション

  • status(string)

    コントローラの状態

    • Normal
    • Warning
    • Blocked
    • Failed
  • temperature(int)

    コントローラの温度(℃)

    -55125の値が出力されます。

    この範囲以外の値が取得された場合は-274が出力されます。

    status属性がBlockedの場合は、コントローラが閉塞する直前に取得した値が出力されます。

    status属性がFailedでも、同様の値が出力されることがあります。

  • temperatureStatus(string)

    コントローラの温度の状態

    • Normal
    • Warning
    • Failed

    VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • charge(int)

    バッテリ充電状況(%)

    0100の値が出力されます。

    この範囲以外の値が取得された場合は-1が出力されます。

    VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • type(string)

    コントローラのタイプ

    • Encryption Controller Board:暗号化有効
    • Encryption Controller Board for NVMe:暗号化有効
    • Controller Board:暗号化無効
    • Controller Board for NVMe:暗号化無効

    有効な値が取得できなかった場合は、-が出力されます。

    VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

cacheMemories

object[]

キャッシュメモリの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    キャッシュメモリのロケーション

  • status(string)

    キャッシュメモリの状態

    • Normal
    • Warning
    • Blocked
  • cacheSize(int)

    キャッシュメモリのサイズ(GB)

    有効な値が取得できなかった場合は、-1が出力されます。

chbs

object[]

チャネルボードの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    チャネルボードのロケーション

  • status(string)

    チャネルボードの状態

    • Normal

    • Warning

    • Blocked

    • Failed

  • type(string)

    チャネルボードのタイプ

    • 8G 4Port FC
    • 16G 2Port FC
    • 32G Ready 4Port FC
    • 10G 2Port iSCSI (Optic)
    • 10G 2Port iSCSI (Copper)

cacheFlashMemories

object[]

キャッシュフラッシュメモリの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    キャッシュフラッシュメモリのロケーション

  • status(string)

    キャッシュフラッシュメモリの状態

    • Normal

    • Warning

    • Blocked

    • Failed

  • type(string)

    キャッシュフラッシュメモリのタイプ

    例:BM30

dkbs

object[]

ディスクボードの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    ディスクボードのロケーション

  • status(string)

    ディスクボードの状態

    • Normal
    • Warning
    • Blocked
    • Failed
  • type(string)

    ディスクボードのタイプ

    例:Disk Board

lanbs

object[]

LANボードの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    LANボードのロケーション

  • status(string)

    LANボードの状態

    • Normal
    • Warning

sfps

object[]

SFP(Small Form Factor Pluggable)情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • portId(string)

    SFPのポート番号

  • status(string)

    SFPの状態

    • Not fix
    • Normal
    • Warning
  • type(string)

    SFPのタイプ

    • Short Wave
    • Long Wave
    • Copper Cable

    ポートが使用されていない場合は、空文字が出力されます。

  • speed(string)

    SFP Speed

    • 16Gbps
    • 32Gbps

    設定がない場合は、空文字が出力されます。

  • portCondition(string)

    SFPのポートの状態

    • Not Available
    • Available (Connected)
    • Available (Not Connected)

    上記以外の場合は、-が出力されます。

    VSP E シリーズVSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900の場合に出力されます。

bkmfs

object[]

バックアップモジュールの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    バックアップモジュールのロケーション

  • status(string)

    バックアップモジュールの状態

    • Normal
    • Warning
    • Blocked
    • Failed
  • batteries(object[])

    バッテリーの情報に関する属性が出力されます。

    • location(string)

      バッテリーのロケーション

    • status(string)

      バッテリーの状態

      Normal

      Warning

      Blocked

      Failed

    • life(int)

      バッテリーの寿命

      0100の値が出力されます。

      この範囲以外の値が取得された場合は、-1が出力されます。

dkcpss

object[]

DKCPSの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    DKCPSのロケーション

  • status(string)

    DKCPSの状態

    • Normal
    • Warning
    • Failed
    • Blocked

driveBoxes

object[]

ドライブボックスの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    ドライブボックスのロケーション

  • type(string)

    ドライブボックスのタイプ

    • DBS
    • DBL
    • DB60
    • DBF
    • DBF2_A
    • DBF2_B
    • DBN
    • DBS2_A
    • DBS2_B
  • led(string)

    LEDの状態

    • ON
    • OFF
  • drives(object[])

    ドライブの情報に関する属性が出力されます。

    • location(string)

      ドライブのロケーション

    • modelCode(string)

      ドライブタイプコード

    • status(string)

      ドライブの状態

      Normal

      Warning

      Warning (Port 0 failed)

      Warning (Port 1 failed)

      Blocked

      Failed

      Copying n % (xxx to xxx)

      Copying n % (xxx from xxx)

      Pending (xxx to xxx)

      Pending (xxx from xxx)

      Copy incomplete

      Reserved

      複数のコピーステータスが存在する場合、全てが出力されます。

    • usage(string)

      ドライブの使用方法

      DATA

      Spare

      Free

    • recomendReplacement(int)

      ドライブ置換推奨

      0: PDEV 置換非推奨

      1: PDEV 置換推奨

  • encs(object[])

    ENCの情報に関する属性が出力されます。

    • location(string)

      ENCのロケーション

    • status(string)

      ENCの状態

      Normal

      Warning

      Blocked

      Failed

  • dbps(object[])

    ドライブボックス電源の情報に関する属性が出力されます。

    • location(string)

      ドライブボックス電源のロケーション

    • status(string)

      ドライブボックス電源の状態

      Normal

      Warning

      Failed

fans

object[]

ファンの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    ファンのロケーション

  • status(string)

    ファンの状態

    • Normal
    • Warning
    • Failed

upsMode

string

UPSモード

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • UPS Interlock Mode 1
  • UPS Interlock Mode 2
  • UPS Interlock Mode 3
  • Standard Mode

pecbs

object[]

PCIe チャネルボードに関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    PCIe チャネルボードのロケーション

  • status(string)

    PCIe チャネルボードの状態

    • Normal
    • Warning
    • Blocked
  • connectionMode(string)

    PCIe チャネルボード接続モジュール

    • Channel Board Box
    • Server Chassis

    上記以外の場合は、-が出力されます。

chbb

object

チャネルボードボックスの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    チャネルボードボックスのロケーション

  • expansionMode(string)

    チャネルボードボックスの拡張モード

    • 1-vSW
    • 2-vSW

    上記以外の場合は、-が出力されます。

pcps

object[]

PCIe チャネルパッケージの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    PCIe チャネルパッケージのロケーション

  • status(string)

    PCIe チャネルパッケージの状態

    • Normal
    • Warning
    • Blocked

swpks

object[]

スイッチパッケージの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    スイッチパッケージのロケーション

  • status(string)

    スイッチパッケージの状態

    • Normal
    • Warning
    • Blocked

chbbfans

object[]

チャネルボードボックスファンの情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    チャネルボードボックスファンのロケーション

  • status(string)

    チャネルボードボックスファンの状態

    • Normal
    • Warning

chbbps

object[]

チャネルボードボックス電源の情報に関する属性が出力されます。

VSP E シリーズVSP Gx00 モデルまたはVSP Fx00 モデルの場合に出力されます。

  • location(string)

    チャネルボードボックス電源のロケーション

  • status(string)

    チャネルボードボックス電源の状態

    • Normal
    • Warning

クエリパラメータでcomponentOptionclassを指定して実行すると、ストレージシステムのキャッシュからの情報だけが取得されます。

属性

説明

cacheMemorySummary

object

キャッシュメモリの概要情報に関する属性

  • status(string)

    キャッシュメモリの状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

sharedMemorySummary

object

共用メモリの概要情報に関する属性

  • status(string)

    共用メモリの状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

VSP E シリーズVSP Gx00 モデルVSP Fx00 モデルの場合、属性の意味とは異なる情報が出力されることがあります。この情報は参照しないでください。

lanbSummary

object

LANボードの概要情報に関する属性

  • status(string)

    LANボードの状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

VSP 5000 シリーズVSP G130、G150、VSP G350、G370、VSP F350、F370、VSP G100、G200VSP G1000VSP G1500VSP F1500の場合、属性の意味とは異なる情報が出力されることがあります。この情報は参照しないでください。

bkmfSummary

object

バックアップモジュールの概要情報に関する属性

  • fanStatus(string)

    ファンの状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

dkcpsSummary

object

DKCPS の概要情報に関する属性

  • status(string)

    DKCPS の状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

driveBoxSummary

object

ドライブボックスの概要情報に関する属性

ストレージシステムによっては、ドライブボックスはドライブシャーシに読み替えてください。

  • powerSupplyStatus(string)

    ドライブボックスの電源の状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown
  • fanStatus(string)

    現在使用されていない属性です。

  • environmentStatus(string)

    ドライブボックスの環境の状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

    VSP G1000VSP G1500VSP F1500の場合、属性の意味とは異なる情報が出力されることがあります。この情報は参照しないでください。

  • driveStatus(string)

    ドライブの状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

    VSP E シリーズ、VSP G700、G900、VSP F700、F900、VSP G400、G600、G800VSP F400、F600、F800の場合、属性の意味とは異なる情報が出力されることがあります。この情報は参照しないでください。

processorSummary

object

プロセッサ の概要情報に関する属性

  • status(string)

    プロセッサ の状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

batterySummary

object

バッテリーの概要情報に関する属性

  • status(string)

    バッテリーの状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

xPathSummary

object

Xパスの概要情報に関する属性

VSP G1000VSP G1500VSP F1500またはVSP 5000 シリーズの場合に出力されます。VSP G1000VSP G1500VSP F1500の場合、マイクロコードのバージョンが80-06-66-00/00-01より前のときには常にNormalと出力されますが、Normalは無効値であることを示します。

VSP 5000 シリーズの場合、Xパスと相互接続スイッチの情報がxPathSummary属性の値として出力されます。

  • status(string)

    Xパスの状態

    • Normal
    • Service
    • Moderate
    • Serious
    • Acute
    • Unknown

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/components/instance