Hitachi

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

7.18　ホストグループまたはiSCSIターゲットの情報を取得する

ポートのホストグループまたはiSCSIターゲットの情報を取得します。
重要

ストレージシステムがVSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合に、クエリパラメータにportId を指定しないとき、このAPI は、同時実行数に注意が必要です。詳細については、「リトライ処理の組み込み」を参照してください。

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/host-groups

リクエストメッセージ

オブジェクトID

なし。

クエリパラメータ

指定した条件で実行結果をフィルタリングしたり、ホストグループの情報を高速に取得したりできます。

  • 実行結果をフィルタリングする場合

    パラメータ

    型

    フィルタ条件

    portId

    string

    VSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデルまたはVSP F1500の場合

    （任意）ポート番号

    指定したときだけ、次の属性も取得されます。

    • iscsiName
    • authenticationMode
    • iscsiTargetDirection
    • hostModeOptions

    省略した場合、すべてのポートについて情報が取得されます。

    HUS VMまたはVSPの場合

    （必須）ポート番号

    isUndefined

    boolean

    （任意） ホストグループまたはiSCSIターゲットが作成されていないホストグループ番号の情報も取得するかどうかを指定します。

    • true：ホストグループまたはiSCSIターゲットが作成されていないホストグループ番号の情報も取得する
    • false：ホストグループまたはiSCSIターゲットが作成されていないホストグループ番号の情報は取得しない

    hostGroupNumberListパラメータと同時に指定できません。

    省略した場合、falseが指定されたと見なされます。

  • 詳細情報を追加して取得する場合

    パラメータ

    型

    説明

    detailInfoType

    string

    （任意）取得する詳細情報のタイプ

    • resourceGroup

      ホストグループまたはiSCSIターゲットのリソースグループに関する情報を取得します。

      この値を指定する場合は、portIdパラメータも必ず指定します。

      accessModeパラメータにstorageCacheを指定する場合、またはisSimpleModeパラメータにtrueを指定する場合は、同時に指定できません。
  • ホストグループの情報を高速に取得する場合

    パラメータ

    型

    説明

    accessMode

    string

    （任意）ホストグループの情報を高速に取得する場合に次の値を指定します。

    • storageCache

    VSP 5000 シリーズ、VSP G100、G200、G400、G600、G800、VSP G1000、VSP G1500、VSP F400、F600、F800またはVSP F1500の場合に指定できます。

    このパラメータを指定すると、キャッシュを利用してホストグループの情報を取得します。このため、パラメータを指定しない場合と比べて高速に情報を取得できます。REST APIまたはRAID Managerを使用してホストグループを作成したあとは、キャッシュに最新の情報が反映されるまでに通常1分から5分、最大1時間程度の時間が掛かることがあります。

    パラメータにportIdを指定した場合、このパラメータは指定できません。

    VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合、このパラメータを指定しても無視されます。

  • 基本的な情報の属性だけを取得する場合

    ストレージシステムがVSP 5000 シリーズ、VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合に指定できます。

    すべての属性を取得する場合に比べて、高速に情報を取得します。

    パラメータ

    型

    フィルタ条件

    isSimpleMode

    boolean

    （任意） 基本的な情報だけに限定して取得するかどうか

    • true：基本的な情報だけを取得する
    • false：すべての情報を取得する

    このパラメータにtrueを指定する場合、portIdパラメータも必ず指定します。

    省略した場合、falseが指定されたと見なされます。

    hostGroupNumberList

    string

    （任意）iSCSI ターゲットのターゲットID

    指定したiSCSIターゲットについて、基本的な情報を取得します。

    このパラメータを指定する場合、isSimpleModeパラメータにtrueを必ず指定します。

    isUndefinedパラメータと同時に指定できません。

    複数指定する場合は、コンマで区切ります。
ボディ

なし。

レスポンスメッセージ

ボディ

基本的な情報の属性だけを取得する場合のコード例を次に示します。

{
  "data": [
    {
      "hostGroupId": "CL1-A,0",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "hostA"
    },
    {
      "hostGroupId": "CL1-B,0",
      "portId": "CL1-B",
      "hostGroupNumber": 0,
      "hostGroupName": "hostB"
    }
  ]
}

基本的な情報の属性だけを取得する場合の属性を次に示します。

属性

型

説明

hostGroupId

string

ホストグループまたはiSCSIターゲットのオブジェクトID

portId

string

ポート番号

hostGroupNumber

int

ポート上のホストグループ番号（iSCSIターゲットの場合はターゲットID）

hostGroupName

string

ホストグループ名（iSCSIターゲットの場合はターゲットエイリアス名）

hostGroupNumberListパラメータを指定しない場合は、先頭の16文字だけ取得します。

iscsiName

string

ポートのiSCSIターゲットのiSCSIネーム

hostGroupNumberListパラメータを指定したときだけ取得します。

authenticationMode

string

iSCSIターゲットの認証モード

hostGroupNumberListパラメータを指定したときだけ取得します。

  • CHAP：CHAP認証モード
  • NONE：無認証モード
  • BOTH：CHAP認証モードおよび無認証モードの両方

iscsiTargetDirection

string

iSCSIターゲットのCHAP認証の方向

hostGroupNumberListパラメータを指定したときだけ取得します。

  • S：単方向（iSCSIターゲットがiSCSIイニシエータを認証する）
  • D：双方向（iSCSIターゲットとiSCSIイニシエータが双方向に認証する）

すべての属性を取得する場合のコード例を次に示します。

すべてのポートのホストグループまたはiSCSIターゲットの情報を取得した場合の出力例を次に示します。

{
  "data": [
    {
      "hostGroupId": "CL1-A,0",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "hostA",
      "hostMode": "WIN",
      "hostModeOptions": [
        1,
        2
      ]
    },
    {
      "hostGroupId": "CL1-B,0",
      "portId": "CL1-B",
      "hostGroupNumber": 0,
      "hostGroupName": "hostB",
      "hostMode": "LINUX/IRIX"
    }
  ]
}

指定したポート番号について、作成されているホストグループまたはiSCSIターゲットの情報を取得した場合の出力例を次に示します。 

{
  "data": [
    {
      "hostGroupId": "CL1-A,0",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "hostA",
      "hostMode": "WIN",
      "hostModeOptions": [
        1,
        2
      ]
    },
    {
      "hostGroupId": "CL1-A,1",
      "portId": "CL1-A",
      "hostGroupNumber": 1,
      "hostGroupName": "hostB",
      "hostMode": "LINUX/IRIX"
    }
  ]
}

リソースグループに関する情報を取得する場合の出力例を次に示します。

この例では、ホストグループまたはiSCSIターゲットが作成されていないホストグループ番号の情報も取得します。 

{
  "data": [
    {
      "hostGroupId": "CL1-A,0",
      "portId": "CL1-A",
      "hostGroupNumber": 0,
      "hostGroupName": "hostA",
      "hostMode": "WIN",
      "hostModeOptions": [
        1,
        2
      ],
      "resourceGroupId": 1,
      "isDefined": true
    },
    {
      "hostGroupId": "CL1-A,1",
      "portId": "CL1-A",
      "hostGroupNumber": 1,
      "hostGroupName": "-",
      "resourceGroupId": 2,
      "isDefined": false
    }
  ]
}

すべての属性を取得する場合の属性を次に示します。

属性

型

説明

hostGroupId

string

ホストグループまたはiSCSIターゲットのオブジェクトID

portId

string

ポート番号

hostGroupNumber

int

ポート上のホストグループ番号（iSCSIターゲットの場合はターゲットID）

hostGroupName

string

ホストグループ名（iSCSIターゲットの場合はターゲットエイリアス名）

iscsiName

string

ポートのiSCSIターゲットのiSCSIネーム

portIdパラメータを指定したときだけ取得します。

authenticationMode

string

iSCSIターゲットの認証モード

portIdパラメータを指定したときだけ取得します。

  • CHAP：CHAP認証モード
  • NONE：無認証モード
  • BOTH：CHAP認証モードおよび無認証モードの両方

iscsiTargetDirection

string

iSCSIターゲットのCHAP認証の方向

portIdパラメータを指定したときだけ取得します。

  • S：単方向（iSCSIターゲットがiSCSIイニシエータを認証する）
  • D：双方向（iSCSIターゲットとiSCSIイニシエータが双方向に認証する）

hostMode

string

ホストグループのホストアダプタ設定用のホストモード

ホストグループ名が定義されている場合に取得します。

取得される値については、ホストグループまたはiSCSIターゲットの設定を変更するAPIの説明を参照してください。

hostModeOptions

int[]

ホストグループのホストモードオプション設定用の番号

portIdパラメータを指定した場合だけ取得されます。

取得される番号については、マニュアルオープンシステム構築ガイド、またはシステム構築ガイドを参照してください。

resourceGroupId

int

所属するリソースグループのリソースグループID

クエリにdetailInfoType=resourceGroupを指定したときだけ取得します。

isDefined

boolean

ホストグループまたはiSCSIターゲットが作成されているかどうか

クエリにdetailInfoType=resourceGroupを指定したときだけ取得します。

  • true：作成済み
  • false：作成されていない

ステータスコード

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

コード例

すべてのポートのホストグループまたはiSCSIターゲットの情報を取得する場合

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/host-groups

指定したポート番号について、作成されているホストグループまたはiSCSIターゲットの情報を取得する場合 

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/host-groups?portId=CL1-A

リソースグループに関する情報を取得する場合

この例では、ホストグループまたはiSCSIターゲットが作成されていないホストグループ番号の情報も取得します。 

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/800000012345/host-groups?portId=CL1-A&isUndefined=true&detailInfoType=resourceGroup

関連項目

ページの先頭へ

All Rights Reserved. Copyright© 2016, 2021, Hitachi, Ltd.