Hitachi

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


16.5 ローカルストレージシステム側ポートに登録された外部ストレージシステムのiSCSIネームを取得する

指定したローカルストレージシステム側のポートに登録されている、外部ストレージシステム側ポートのiSCSIターゲットのiSCSIネームの情報を取得します。
メモ

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

実行権限

ストレージ管理者(参照)

リクエストライン

GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/iscsi-ports/<オブジェクトID

リクエストメッセージ

オブジェクトID

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

属性

説明

portId

string

(必須)ローカルストレージシステムのポート番号

クエリパラメータ
なし。
ボディ
なし。

レスポンスメッセージ

ボディ
{
    "portId": "CL1-A",
    "externalIscsiTargets": [
        {
            "iscsiIpAddress": "192.168.0.100",
            "tcpPort": 3260,
            "iscsiName": "iqn.rest.example.of.iscsi1",
            "authenticationMode": "CHAP",
            "iscsiTargetDirection" "D",
            "chapUserName": "Win_SQL_EX",
            "isSecretSet": true,
            "virtualPortId": 0
        },
        {
            "iscsiIpAddress": "192.168.0.101",
            "tcpPort": 3260,
            "iscsiName": "iqn.rest.example.of.iscsi2",
            "authenticationMode": "NONE",
            "iscsiTargetDirection" "S",
            "chapUserName": "-",
            "isSecretSet": false,
            "virtualPortId": 0
        }
    ]
}

属性

説明

portId

string

ローカルストレージシステムのポート番号

externalIscsiTargets

object[]

外部ストレージシステム側のiSCSIターゲットに関する属性が出力されます。

外部ストレージシステム側のポートがファイバーチャネルポートの場合は、空の配列が出力されます。

  • iscsiIpAddress(string)

    iSCSIターゲットのIPアドレス

  • tcpPort(int)

    TCPポート番号

  • iscsiName(string)

    iSCSIネーム

  • authenticationMode(string)

    CHAP認証モード

    • CHAP:CHAP認証モード
    • NONE:無認証モード
  • iscsiTargetDirection(string)

    iSCSIターゲットのCHAP認証の方向

    • D:双方向(iSCSIターゲットとiSCSIイニシエータが双方向に認証する)
    • S:単方向(iSCSIターゲットがiSCSIイニシエータを認証する)
  • chapUserName(string)

    CHAPユーザ名

    CHAP認証の方向が双方向の場合に使用するユーザ名が出力されます。

    CHAP認証モードがNONEの場合も表示されます。

    CHAPユーザ名が設定されていない場合は、-(ハイフン)が表示されます。

  • isSecretSet(boolean)

    CHAP認証のシークレットパスワードが設定されているかどうか

    • true:設定されている
    • false:設定されていない
  • virtualPortId(int)

    ローカルストレージシステムが外部ストレージシステムへ接続している仮想ポートのID

    仮想ポートモードが有効な場合に出力されます。

注※ CHAPユーザ名に-が設定されている場合も同様に出力されます。

ステータスコード

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

コード例

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