3.4　ストレージシステムを登録する : Hitachi Command Suite Configuration Manager REST API リファレンスガイド

重要

REST APIサーバに登録されたユーザ情報は、ストレージシステムの構成情報の更新や、REST APIサーバ内の情報を更新するための情報取得時に、REST APIサーバによって利用されます。
REST APIサーバにストレージシステムを登録したあとに、登録したユーザのパスワードをREST APIやStorage Navigatorなどで変更した場合、REST APIサーバに登録されているストレージシステムの情報には変更内容が反映されません。ストレージシステムの情報を変更するAPIで、変更後のパスワードをREST APIサーバにも登録してください。

実行権限

セキュリティ管理者（参照）またはセキュリティ管理者（参照・編集）

リクエストライン

POST  ＜ベースURL＞/v1/objects/storages

リクエストメッセージ

オブジェクトID: なし。

クエリパラメータ: なし。

ボディ

VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合

VSP G900を登録する場合のコード例を次に示します。

{
  "ctl1Ip" : "192.0.10.10",
  "ctl2Ip" : "192.0.10.11",
  "model" : "VSP G900", 
  "serialNumber" : 123456,
  "changeNotificationSetting" : {
    "isNotifiable" : true
  },
  "usesSvp" : true,
  "svpIp" : "192.0.2.100"
}

属性	型	説明
serialNumber	int	（必須）登録するストレージシステムのシリアル番号
model	string	（必須）登録するストレージシステムのモデル名次の値を指定します。 `VSP E590` `VSP E790` `VSP E990` `VSP E590H` `VSP E790H` `VSP G150` `VSP G350` `VSP G370` `VSP G700` `VSP G900` `VSP F350` `VSP F370` `VSP F700` `VSP F900`
targetCtl	string	（任意）REST APIが操作対象とするコントローラ次の値を指定します。 `CTL1`：コントローラ1 `CTL2`：コントローラ2 省略した場合、`CTL1`が設定されます。
ctl1Ip	string	（任意）ストレージシステムのコントローラ1のIPアドレス IPv4またはIPv6のIPアドレスを指定できます。ストレージシステム側でコントローラ1のIPアドレスにIPv4およびIPv6の両方が設定されている場合は、IPv4アドレスを指定してください。省略した場合、値が自動で設定されます。 `targetCtl`属性に`CTL1`を指定した場合、または省略した場合は、この属性を必ず指定してください。
ctl2Ip	string	（任意）ストレージシステムのコントローラ2のIPアドレス IPv4またはIPv6のIPアドレスを指定できます。ストレージシステム側でコントローラ2のIPアドレスにIPv4およびIPv6の両方が設定されている場合は、IPv4アドレスを指定してください。省略した場合、値が自動で設定されます。 `targetCtl`属性に`CTL2`を指定した場合は、この属性を必ず指定してください。
usesSvp	boolean	（任意）SVPと連携するかどうか `true`：連携する `false`：連携しない省略した場合、`false`が設定されます。ストレージシステムの管理にSVPを使用している場合、SVPと連携することをお勧めします。
svpIp	string	（任意）登録するストレージシステムを管理するSVPのIPアドレス IPv4またはIPv6のIPアドレスを指定できます。ストレージシステム側でSVPのIPアドレスにIPv4およびIPv6の両方が設定されている場合は、IPv4アドレスを指定してください。 `usesSvp`属性に`true`を指定した場合は、この属性を必ず指定してください。 `usesSvp`属性に`false`を指定した場合、または省略した場合は、この属性を指定しても無視されます。値を指定しても登録されません。また、ストレージシステムの情報取得のAPIでも出力されません。
mappWebServerHttpsPort	int	（任意）SVPがHTTPS通信で使用するポート番号 `usesSvp`属性に`true`を指定した場合で、ポート番号をデフォルト値の`443`から変更しているときは、この属性を必ず指定してください。省略した場合、`443`が設定されます。 `usesSvp`属性に`false`を指定した場合、または省略した場合は、この属性を指定しても無視されます。値を指定しても登録されません。また、ストレージシステムの情報取得のAPIでも出力されません。
rmiPort	int	（任意）Configuration Manager REST APIサーバとストレージシステム間のRMI通信で使用するポート番号 `usesSvp`属性に`true`を指定した場合で、ポート番号をデフォルト値の`1099`から変更しているときは、この属性を必ず指定してください。省略した場合、`1099`が設定されます。 `usesSvp`属性に`false`を指定した場合、または省略した場合は、この属性を指定しても無視されます。値を指定しても登録されません。また、ストレージシステムの情報取得のAPIでも出力されません。
isSecure	boolean	（任意）REST APIサーバとストレージシステム間のSSL通信の設定 `true`：SSL通信を有効にする省略した場合、`true`が設定されます。通信の安全を確保するため、SSL通信を有効にする設定だけが実行できます。
changeNotificationSetting	object	（任意）ストレージシステムからの構成変更の通知を受信するための設定 `changeNotificationSetting`属性を省略した場合は、`isNotifiable`属性を省略したときの動作と同じです。（任意）isNotifiable（boolean）ストレージシステムからの構成変更の通知を受信するかどうかこの属性は、`true`を指定することを強く推奨します。 `true`：受信する `false`：受信しない `isNotifiable`属性に`true`が指定された場合、内部の構成変更の通知テストに失敗するとエラーになります。省略された場合、`isNotifiable`属性に`true`が指定されたと見なして内部の処理が進みますが、構成変更の通知テストに失敗したときは`isNotifiable`属性を`false`に変更してAPIは正常終了します。構成変更の通知を受信するための設定が意図したとおりに設定されているかどうかは、ストレージシステムの構成変更の通知先の一覧を取得するAPIを実行して確認します。構成変更の通知先としてConfiguration Manager REST APIサーバが登録されていれば、`true`を指定した場合の設定が完了していると判断できます。

VSP 5000 シリーズ、VSP G100、G200、G400、G600、G800、VSP G1000、VSP G1500、VSP F400、F600、F800、VSP F1500、Virtual Storage Platform、Unified Storage VMの場合

VSP G400を登録する場合のコード例を次に示します。

{
  "svpIp": "192.0.2.100",
  "serialNumber": 123456,
  "model": "VSP G400",
  "changeNotificationSetting": {
    "isNotifiable": true,
    "mappWebServerHttpsPort": 443
  }
}

属性	型	説明
svpIp	string	（必須）登録するストレージシステムを管理するSVPのIPアドレス IPv4またはIPv6のIPアドレスを指定できます。ストレージシステム側でSVPのIPアドレスにIPv4およびIPv6の両方が設定されている場合は、IPv4アドレスを指定してください。
rmiPort	int	（任意）Configuration Manager REST APIサーバとストレージシステム間のRMI通信で使用するポート番号 VSP 5000 シリーズの場合、`11099`のみ指定できます。省略したとき、`11099`が設定されます。それ以外の場合、省略したとき、`1099`が設定されます。
mappWebServerHttpsPort	int	（任意）SVPがHTTPS通信で使用するポート番号 REST APIサーバとストレージシステム間でSSL通信をする場合に使用します。この属性はVSP G100、G200、G400、G600、G800、VSP F400、F600、F800のマイクロコードのバージョンが83-04-44-`XX`/`XX`以降の場合に使用できます。ポート番号をデフォルト値の`443`から変更しているとき、変更後の値を指定します。省略した場合、`443`が設定されます。この値を変更した場合、ストレージシステムからの構成変更の通知を受信するときに設定する`mappWebServerHttpsPort`属性にも同じ値を設定してください。
serialNumber	int	（必須）登録するストレージシステムのシリアル番号
model	string	（必須）登録するストレージシステムのモデル名次の値を指定します。 `VSP 5100` `VSP 5500` `VSP 5100H` `VSP 5500H` `VSP G100` `VSP G200` `VSP G400` `VSP G600` `VSP G800` `VSP G1000` `VSP G1500` `VSP F400` `VSP F600` `VSP F800` `VSP F1500` `VSP` `HUS VM`
isSecure^※	boolean	（任意）REST APIサーバとストレージシステム間のSSL通信の設定 `true`：SSL通信を有効にする `false` ：SSL通信を無効にする VSP 5000 シリーズの場合、`true`のみ指定できます。省略したとき、`true`が設定されます。それ以外の場合、省略したとき、`false`が設定されます。 VSP G1000、VSP G1500またはVSP F1500の場合、ストレージシステムのマイクロコードのバージョンは、80-05-2`X`-`XX`/`XX`以降を使用することを推奨します。
changeNotificationSetting	object	（任意）ストレージシステムからの構成変更の通知を受信するための設定この属性はVSP G100、G200、G400、G600、G800、VSP F400、F600、F800のマイクロコードのバージョンが83-04-`XX`-`XX`/`XX`以降の場合、VSP G1000のマイクロコードのバージョンが80-05-`XX`-`XX`/`XX`以降の場合、VSP 5000 シリーズ、VSP G1500またはVSP F1500の場合に利用できます。 `changeNotificationSetting`属性を省略した場合は、`isNotifiable`属性を省略したときの動作と同じです。（任意）isNotifiable（boolean）ストレージシステムからの構成変更の通知を受信するかどうかこの属性は、`true`を指定することを強く推奨します。 `true`：受信する `false`：受信しない `isNotifiable`属性に`true`が指定された場合、内部の構成変更の通知テストに失敗するとエラーになります。省略された場合、`isNotifiable`属性に`true`が指定されたと見なして内部の処理が進みますが、構成変更の通知テストに失敗したときは`isNotifiable`属性を`false`に変更してAPIは正常終了します。構成変更の通知を受信するための設定が意図したとおりに設定されているかどうかは、ストレージシステムの構成変更の通知先の一覧を取得するAPIを実行して確認します。構成変更の通知先としてConfiguration Manager REST APIサーバが登録されていれば、`true`を指定した場合の設定が完了していると判断できます。（任意）mappWebServerHttpsPort（int） SVPがHTTPS通信で使用するポート番号 VSP G100、G200、G400、G600、G800、VSP F400、F600、F800の場合に、ポート番号をデフォルト値の`443`から変更しているとき、変更後の値を指定します。 `isNotifiable`属性が`true`の場合、設定できます。省略した場合、`443`が設定されます。 VSP G100、G200、G400、G600、G800、VSP F400、F600、F800のマイクロコードのバージョンが83-04-44-`XX`/`XX`以降の場合、この値を変更したときは、REST APIサーバとストレージシステム間でSSL通信をするときに設定する`mappWebServerHttpsPort`属性にも同じ値を設定してください。

注※　管理サーバのOSがLinuxの場合、一般ユーザでREST APIをインストールしたときは、指定できる値が制限されます。詳細については、一般ユーザでREST APIをインストールした環境での運用の説明を参照してください。

レスポンスメッセージ

ボディ

{
  "storageDeviceId": "834000123456",
  "model": "VSP G400",
  "serialNumber": 123456
}

属性	型	説明
storageDeviceId	string	登録したストレージシステムのストレージデバイスID
model	string	登録したストレージシステムのモデル名
serialNumber	int	登録したストレージシステムのシリアル番号

ステータスコード

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

ステータスコード	メッセージ	説明
409	Conflict	指定したストレージデバイスIDで、ストレージシステムを登録済みです。
412	Precondition Failed	登録できるストレージシステムの最大数を超えるため、指定されたアクションを実行できません。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -u rest-test:rest-api -X POST --data-binary @./InputParameters.json https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages

3.4 ストレージシステムを登録する

3.4　ストレージシステムを登録する