Hitachi

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


4.21 ユーザのパスワードを変更する

ストレージシステムのリソースを操作するユーザのパスワードを変更します。外部認証サーバで認証しているユーザのパスワードは変更できません。
次のどれかに該当する場合、指定したユーザがSVP のStorage Device List のストレージ情報にも登録されているときには、そのパスワードも同時に変更できます。
  • VSP G100、G200、G400、G600、G800VSP F400、F600、F800のマイクロコードのバージョンが83-05-2X-XX/XX以降の場合
  • VSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900のマイクロコードのバージョンが88-03-0X-XX/XX以降の場合で、SVPと連携する構成のとき
  • VSP E シリーズの場合で、SVPと連携する構成のとき
重要
  • Storage Device Listのパスワードを変更すると、SVP上の管理ソフトウェアが再起動します。そのため、REST APIやStorage Navigatorなどの管理ソフトウェアが一時的に使用できなくなりますが、ジョブが完了すれば使用できるようになります。
  • Storage Device Listのパスワードを変更する場合、リクエストヘッダでResponse-Job-StatusCompletedを指定することをお勧めします。指定しなかった場合にストレージシステムの処理に失敗したとき、正しく通信エラーの情報が取得できないおそれがあります。
  • REST APIサーバにストレージシステムを登録した時に使用したユーザのIDとパスワードはREST APIサーバに保持されています。このパスワードを変更する場合、ユーザのパスワードを変更するAPIだけではREST APIサーバの保持情報が変わらないため、別途ストレージシステムの情報を変更するAPIを実行し、REST APIサーバが保持している情報を更新してください。
  • REST API を実行するユーザが、対象ストレージシステムのリソースをREST API でロックしている場合、このAPIは実行できません。その場合は、ロックを解除してから実行してください。

実行権限

セキュリティ管理者(参照・編集)

リクエストライン

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

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

リクエストメッセージ

オブジェクトID

ユーザの情報取得で取得したuserObjectIdの値を指定します。

属性

説明

userObjectId

string

(必須)ユーザIDのオブジェクトID

大文字と小文字を区別します。

クエリパラメータ

なし。

ボディ

ストレージシステムのパスワードを変更する場合

{
  "userPassword":"userPass"
}

ストレージシステムおよびStorage Device Listのパスワードを同時に変更する場合

VSP G100、G200、G400、G600、G800VSP F400、F600、F800の例)

{
  "userPassword":"userPass",
  "changesStorageDeviceListPassword":true,
  "mappWebServerHttpsPort":20443
}

ストレージシステムおよびStorage Device Listのパスワードを同時に変更する場合

VSP E シリーズVSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900で、SVPと連携する構成の例)

{
  "userPassword":"userPass",
  "changesStorageDeviceListPassword":true
}

属性

説明

userPassword

string

(必須)新しいパスワード

パスワードに指定できる文字数や使用できる文字については、ユーザIDとパスワードの入力規則の説明を参照してください。

changesStorageDeviceListPassword属性にtrueを指定した場合は、REST APIからストレージシステムを操作するユーザを作成する場合の規則に従ってください。

changesStorageDeviceListPassword

boolean

(任意)Storage Device Listのユーザのパスワードを変更するかどうか

この属性は次のどれかに該当するときに使用できます。
  • VSP G100、G200、G400、G600、G800VSP F400、F600、F800の場合
  • VSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900の場合で、SVPと連携する構成のとき
  • VSP E シリーズの場合で、SVPと連携する構成のとき

この属性を指定すると、ストレージシステムのパスワードに加えてStorage Device Listのパスワードも同時に変更されます。

  • true:Storage Device Listのパスワードを変更する

  • false:Storage Device Listのパスワードを変更しない

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

mappWebServerHttpsPort

int

(任意)SVPがHTTPS通信で使用するポート番号

この属性はVSP G100、G200、G400、G600、G800VSP F400、F600、F800のときに使用できます。

changesStorageDeviceListPassword属性がtrueで、非SSL通信または、DTLS暗号化通信方式でSSL通信を利用しているときに指定します。

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

レスポンスメッセージ

ボディ

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

属性

説明

affectedResources

パスワードを変更したユーザのURL

Actionテンプレート

なし。

ステータスコード

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

コード例

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