16.4　ローカルストレージシステム側ポートに外部ストレージシステムのiSCSIネームを登録する

iSCSIネームを登録したあとは、ログインテストのAPIを実行して、ログインができるかどうかを必ず確認してください。ログインに失敗した場合は、ログインできるように設定を見直すか、そのiSCSIターゲットを削除してください。ログインできないiSCSIターゲットを残しておくと、外部ストレージシステム側ポートのiSCSIターゲットを探索するときに、ネットワークや外部ストレージシステムに負荷がかかり情報取得に失敗するおそれがあります。

メモ

• このAPIは、VSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデルまたはVSP F1500の場合に使用できます。

• ローカルストレージシステムの仮想ポートモードが有効な場合、仮想ポートIDは0が設定されていると見なします。

実行権限

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

リクエストライン

PUT ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/iscsi-ports/＜オブジェクトID＞/actions/register/invoke

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

リクエストメッセージ

オブジェクトID

ポートの情報取得で取得したportIdの値を指定します。

属性	型	説明
portId	string	（必須）ローカルストレージシステムのポート番号

クエリパラメータ

なし。

ボディ

{
    "parameters": {
        "iscsiIpAddress": "192.168.0.100",
        "iscsiName": "iqn.rest.example.of.iscsi1",
        "tcpPort" : 3260
    }
}

属性	型	説明
iscsiIpAddress	string	（必須）外部ストレージシステム側のiSCSIターゲットのIPアドレス IPv4またはIPv6のIPアドレスを指定します。
iscsiName	string	（必須）外部ストレージシステム側のiSCSIターゲットのiSCSIネーム iqn形式またはeui形式で指定します。 大文字小文字を区別します。
tcpPort	int	（任意）外部ストレージシステム側のiSCSIターゲットのTCPポート番号 省略した場合は、ローカルストレージシステム側ポートのTCPポート番号が指定されたと見なされます。 指定するiSCSIネームとIPアドレスが、既にローカルストレージシステムのポートに登録されている場合は、登録済みの値と同じ値を設定するか、属性の指定を省略してください。この場合に指定を省略すると、次のように設定されます。 オブジェクトIDで指定したポートと同じポートにすでに登録されているときは、登録済みのtcpPortの値は変更されません。 オブジェクトIDで指定したポートと異なるポートに登録されているときは、そのポートに登録した際に設定されたtcpPortと同じ値が、指定したポートにも設定されます。

レスポンスメッセージ

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

Actionテンプレート

なし。

ステータスコード

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

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session f76884c29fff4dfaa664aa6981087b71" -X PUT "https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/iscsi-ports/CL1-A/actions/register/invoke"