7.45　コマンドデバイスを設定する : Hitachi Command Suite Configuration Manager REST API リファレンスガイド

メモ: isSecurityEnabled属性、isUserAuthenticationEnabled属性またはisDeviceGroupDefinitionEnabled属性を省略して実行した場合、実行前の設定が有効でも、実行後には設定が無効になります。コマンドデバイスの属性を変更する場合、設定が意図せず無効にならないように指定してください。

実行権限

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

リクエストライン

PUT ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/ldevs/＜オブジェクトID＞/actions/set-as-command-device/invoke

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

リクエストメッセージ

オブジェクトID

ボリュームの情報取得で取得したldevIdの値を指定します。

属性	型	説明
ldevId	int	（必須）LDEV番号を10進数で指定します。

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

ボディ

コマンドデバイスを設定する場合のコード例を次に示します。

{
  "parameters": {
    "isCommandDevice": true
  }
}

コマンドデバイスの設定、セキュリティの設定、ユーザ認証およびデバイスグループ情報認証を設定する場合のコード例を次に示します。

{
  "parameters": {
    "isCommandDevice": true,
    "isSecurityEnabled": true,
    "isUserAuthenticationEnabled": true,
    "isDeviceGroupDefinitionEnabled": true
  }
}

属性	型	説明
isCommandDevice	boolean	（必須）指定したLDEVをコマンドデバイスにするかどうかを指定します。 `true` ：コマンドデバイスの設定を有効にする `false` ：コマンドデバイスの設定を解除する
isSecurityEnabled	boolean	（任意）コマンドデバイスのセキュリティの設定を有効にするかどうかを指定します。 `true`：セキュリティの設定を有効にする `false`：セキュリティの設定を無効にする省略した場合、`false`が設定されたと見なされます。設定が意図せず無効にならないように指定してください。
isUserAuthenticationEnabled	boolean	（任意）コマンドデバイスのユーザ認証の設定を有効にするかどうかを指定します。 `true`：ユーザ認証の設定を有効にする `false`：ユーザ認証の設定を無効にする省略した場合、`false`が設定されたと見なされます。設定が意図せず無効にならないように指定してください。
isDeviceGroupDefinitionEnabled	boolean	（任意）コマンドデバイスのデバイスグループ情報認証の設定を有効にするかどうかを指定します。 `true`：デバイスグループの情報認証の設定を有効にする `false`：デバイスグループの情報認証の設定を無効にする省略した場合、`false`が設定されたと見なされます。設定が意図せず無効にならないように指定してください。

レスポンスメッセージ

ボディ

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

属性	説明
affectedResources	コマンドデバイス属性を変更したボリュームのURL

Actionテンプレート

GET ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/ldevs/＜オブジェクトID＞/actions/set-as-command-device

ステータスコード

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

ステータスコード	メッセージ	説明
412	Precondition Failed	LDEVが次のどれかの条件を満たすため、指定されたアクションを実行できません。 Thin Image の仮想ボリュームとして使用されている Quorumディスクとして使用されているシステムディスクとして使用されている重複排除用システムデータボリューム（フィンガープリント）、または重複排除用システムデータボリュームとして使用されているプールボリュームとして使用されている Volume Migrationで使用されている

コード例

Actionテンプレートを取得する場合

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/ldevs/1/actions/set-as-command-device

Actionテンプレートを取得してリクエストを実行する場合

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/ldevs/1/actions/set-as-command-device/invoke

7.45 コマンドデバイスを設定する

7.45　コマンドデバイスを設定する