Hitachi

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


7.32 iSCSIネームにニックネームを設定する

iSCSIターゲットに登録されているiSCSIネームに、ニックネームを設定します。すでに設定されているニックネームを削除することもできます。
メモ

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

実行権限

ストレージ管理者(プロビジョニング)

リクエストライン

PUT <ベースURL>/v1/objects/storages/<ストレージデバイスID>/host-iscsis/<オブジェクトID

このAPIはPATCHメソッドでも実行できます。

リクエストメッセージ

オブジェクトID

iSCSIネームの情報取得で取得したhostIscsiIdの値を指定します。次のように属性値を連結した形式でも指定できます。

portId>,<hostGroupNumber>,<iscsiName

属性

説明

portId

string

(必須)ポート番号

hostGroupNumber

int

(必須)iSCSIターゲットのターゲットID

iscsiName

string

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

クエリパラメータ
なし。
ボディ

iSCSIネームにニックネームを設定する場合

{
  "iscsiNickname": "REST_API_Testing"
}

iSCSIネームからニックネームを削除する場合

{
  "iscsiNickname": ""
}

属性

説明

iscsiNickname

string

(必須) HBAのiSCSIネームにニックネームを1~32文字で指定します。

次の文字が使用できます。

  • 半角英数字
  • 次の半角記号

    . @ _ \ -

    ハイフン(-)は先頭には指定できません。

iSCSIネームからニックネームを削除する場合は、空文字列を指定します。

レスポンスメッセージ

ボディ

ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。

属性

説明

affectedResources

設定を変更したiSCSIネームのURL

Actionテンプレート

なし。

ステータスコード

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

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/host-iscsis/CL1-B,0,iqn.20150907