Hitachi

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


7.29 iSCSIネームを取得する

ポートとiSCSIターゲットを指定して、iSCSIターゲットに登録されているiSCSIネームの情報を取得します。
メモ

このAPIは、HUS VMの場合は使用できません。

実行権限

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

リクエストライン

GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/host-iscsis

リクエストメッセージ

オブジェクトID
なし。
クエリパラメータ

パラメータ

フィルタ条件

portId

string

(必須)ポート番号

hostGroupNumber

int

(任意)iSCSIターゲットのターゲットID

このパラメータ、hostGroupNameパラメータ、またはhostGroupNumberListパラメータのどれか1つを必ず指定してください。

hostGroupName

string

(任意)iSCSIターゲットの名称

このパラメータ、hostGroupNumberパラメータ、またはhostGroupNumberListパラメータのどれか1つを必ず指定してください。

hostGroupNumberList

string

(任意)iSCSIターゲットのターゲットID

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

このパラメータを指定すると、高速に情報を取得できます。

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

このパラメータ、hostGroupNumberパラメータ、またはhostGroupNameパラメータのどれか1つを必ず指定してください。

displayHostGroupName

boolean

(任意)hostGroupNumberListパラメータを指定した場合にiSCSIターゲット名(hostGroupName属性の値)を取得するかどうか

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

falseを指定すると、trueを指定する場合よりも取得する処理が速くなります。

  • true:iSCSIターゲット名を取得する
  • false:iSCSIターゲット名を取得しない

hostGroupNumberListパラメータが指定されていない場合にこのパラメータを指定しても無視されます。

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

ボディ
なし。

レスポンスメッセージ

ボディ
{
  "data": [
    {
      "hostIscsiId": "CL1-D,1,iqn.1994-05.com.redhat%3A496799ba93",
      "portId": "CL1-D",
      "hostGroupNumber": 1,
      "hostGroupName": "1D-G00",
      "iscsiName": "iqn.1994-05.com.redhat:496799ba93",
      "iscsiNickname": "a_a"
    },
    {
      "hostIscsiId": "CL1-D,1,iqn.1994-05.com.redhat%3Aa7526e46aac.target",
      "portId": "CL1-D",
      "hostGroupNumber": 1,
      "hostGroupName": "1D-G00",
      "iscsiName": "iqn.1994-05.com.redhat:a7526e46aac.target",
      "iscsiNickname": "a_a"
    }
  ]
}

属性

説明

hostIscsiId

string

iSCSIネームのオブジェクトID

portId

string

ポート番号

hostGroupNumber

int

iSCSIターゲットのターゲットID

hostGroupName

string

iSCSIターゲットの名称

クエリパラメータにhostGroupNumberListパラメータを指定し、かつ、displayHostGroupNameパラメータにfalseを指定した場合は取得されません。

iscsiName

string

iSCSIターゲットに登録されているHBA(iSCSIイニシエータ)のiSCSIネーム

iscsiNickname

string

iSCSIのニックネーム

ステータスコード

この操作のリクエストに対するステータスコードについては、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/host-iscsis?portId=CL1-D&hostGroupNumber=1"