7.37　CHAPユーザにシークレットパスワードを設定する

メモ

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

実行権限

ストレージ管理者（プロビジョニング）

リクエストライン

PUT ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/chap-users/＜オブジェクトID＞

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

リクエストメッセージ

オブジェクトID

CHAPユーザの情報取得で取得したchapUserIdの値を指定します。次に示す属性値を連結した形式でも指定できます。

＜portId＞,＜hostGroupNumber＞,＜wayOfChapUser＞,＜chapUserName＞ 

属性	型	説明
portId	string	（必須）ポート番号
hostGroupNumber	int	（必須）iSCSIターゲットのターゲットID
wayOfChapUser	string	（必須）CHAPユーザ名の種類 TAR：iSCSIターゲット側のCHAPユーザ名 INI：HBA（iSCSIイニシエータ）側のCHAPユーザ名
chapUserName	string	（必須）CHAPユーザ名

クエリパラメータ

なし。

ボディ

CHAPユーザにシークレットパスワードを設定する場合

{
  "chapPassword": "TopSecretForMyChap"
}

CHAPユーザのシークレットパスワードをリセットする場合

{
  "chapPassword": ""
}

属性	型	説明
chapPassword	string	指定したCHAPユーザのシークレットパスワードを12～32文字で指定します。 空文字を指定した場合、パスワードがリセットされます。

レスポンスメッセージ

ボディ

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

属性	説明
affectedResources	パスワード設定したCHAPユーザ名の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/chap-users/CL1-D,1,TAR,MyRESTChapUser