16.3 外部ストレージシステム側ポートの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/discover/invoke
このAPIはPOSTメソッドでも実行できます。
リクエストメッセージ
- オブジェクトID
-
ポートの情報取得で取得したportIdの値を指定します。
属性
型
説明
portId
string
(必須)ローカルストレージシステムのポート番号
- クエリパラメータ
- なし。
- ボディ
-
{ "parameters": { "iscsiIpAddress": "192.168.0.100", "tcpPort": 3260 } }
属性
型
説明
iscsiIpAddress
string
(必須)外部ストレージシステム側のiSCSIターゲットのIPアドレス
IPv4またはIPv6のIPアドレスを指定します。
tcpPort
int
(任意)外部ストレージシステム側のiSCSIターゲットのTCPポート番号
省略した場合は、ローカルストレージシステム側ポートのTCPポート番号が指定されたと見なされます。
レスポンスメッセージ
- ボディ
-
{ "portId": "CL1-A", "externalIscsiTargets": [ { "iscsiIpAddress": "192.168.0.100", "tcpPort": 3260, "iscsiName": "iqn.rest.example.of.iscsi1", "virtualPortId": 0, "isRegistered": true }, { "iscsiIpAddress": "192.168.0.101", "tcpPort": 3260, "iscsiName": "iqn.rest.example.of.iscsi2", "virtualPortId": 0, "isRegistered": false } ] }
属性
型
説明
portId
string
ローカルストレージシステムのポート番号
externalIscsiTargets
object[]
外部ストレージシステムのiSCSI ターゲットに関する次の属性が出力されます。
-
tcpPort(int)
TCPポート番号
-
iscsiIpAddress(string)
iSCSIターゲットのIPアドレス
-
iscsiName(string)
iSCSIターゲットのiSCSIネーム
-
virtualPortId(int)
ローカルストレージシステムが外部ストレージシステムへ接続している仮想ポートのID
仮想ポートモードが有効な場合に出力されます。
-
isRegistered(boolean)
このiSCSIターゲットが、ローカルストレージシステムのiSCSIポートに登録されているかどうか- true:登録されている
- false:登録されていない
-
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/discover/invoke"