Hitachi

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

7.15　ポートの情報を取得する

ポートの情報を一覧で取得します。
重要

ストレージシステムがVSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合に、SVP と連携しない構成のとき、クエリにdetailInfoType=loginsを指定してこのAPIを実行すると、同時実行数に注意が必要です。詳細については、「リトライ処理の組み込み」を参照してください。

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/v1/objects/storages/＜ストレージデバイスID＞/ports

リクエストメッセージ

オブジェクトID
なし。
クエリパラメータ

指定した条件で実行結果をフィルタリングしたり、ポートの詳細な情報を追加で取得したりできます。

実行結果をフィルタリングする場合

パラメータ

型

フィルタ条件

portType

string

（任意）ポートの種別

条件として入力できる値を次に示します。

  • FIBRE
  • SCSI
  • ISCSI
  • ENAS
  • ESCON
  • FICON
  • FCoE

指定を省略すると、すべてのポートの種別について情報が取得されます。

portIdパラメータとは同時に指定できません。

portAttributes

string

（任意）ポートの属性

条件として入力できる値を次に示します。

  • TAR：Targetポート（Fibre Target port）
  • MCU：Initiatorポート（MCU Initiator port）
  • RCU：RCUターゲットポート（RCU Target port）
  • ELUN：Externalポート（External Initiator port）

指定を省略すると、すべてのポート属性の情報を取得します。

Bidirectionalポートの場合、４つの属性すべてを取得します。

portIdパラメータとは同時に指定できません。

portId

string

（任意）ポート番号

VSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデルまたはVSP F1500の場合だけ指定できます。

指定を省略すると、すべてのポート番号の情報を取得します。このパラメータを指定するときは、detailInfoTypeパラメータにloginsを必ず指定します。portTypeパラメータ、portAttributesパラメータと同時に指定できません。

詳細情報を追加して取得する場合

パラメータ

型

説明

detailInfoType

string

（任意）取得する詳細情報のタイプ

このパラメータは、実行結果をフィルタリングするパラメータと組み合わせて使うこともできます。

  • logins：HBAのWWNやiSCSIネームのポートへのログイン情報

    ポート種別がFIBRE、FCoE、ISCSIの場合に取得できます。

    VSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデルまたはVSP F1500の場合だけ指定できます。

  • portMode：ポートの動作モード
ボディ
なし。

レスポンスメッセージ

ボディ

すべてのポートの情報を取得した場合の出力例を次に示します。

{
  "data": [
    {
      "portId": "CL1-A",
      "portType": "FIBRE",
      "portAttributes": [
        "TAR",
        "MCU",
        "RCU",
        "ELUN"
      ],
      "portSpeed": "AUT",
      "loopId": "EF",
      "fabricMode": true,
      "portConnection": "PtoP",
      "lunSecuritySetting": true,
      "wwn": "50060e80124e3b00"
    },
    {
      "portId": "CL1-B",
      "portType": "ISCSI",
      "portAttributes": [
        "TAR",
        "MCU",
        "RCU",
        "ELUN"
      ],
      "portSpeed": "10G",
      "loopId": "00",
      "fabricMode": false,
      "lunSecuritySetting": true
    }
  ]
}

ポートの種別を指定してポートの情報を取得した場合の出力例を次に示します。

{
  "data": [
    {
      "portId": "CL1-B",
      "portType": "ISCSI",
      "portAttributes": [
        "TAR",
        "MCU",
        "RCU",
        "ELUN"
      ],
      "portSpeed": "10G",
      "loopId": "00",
      "fabricMode": false,
      "lunSecuritySetting": true
    }
  ]
}

ポートの属性を指定してポートの情報を取得した場合の出力例を次に示します。

{
  "data": [
    {
      "portId": "CLB-C",
      "portType": "ISCSI",
      "portAttributes": [
        "ELUN"
      ],
      "portSpeed": "10G",
      "loopId": "00",
      "fabricMode": false,
      "lunSecuritySetting": false
    }
  ]
}

属性

型

説明

portId

string

ポート番号

portType

string

ポートの種別

次に示す値が表示されます。

FIBRE、SCSI、ISCSI、ENAS、ESCON、FICON、FCoE

portAttributes

string[]

ポート属性の設定値

  • TAR：Targetポート（Fibre Target port）
  • MCU：Initiatorポート（MCU Initiator port）
  • RCU：RCUターゲットポート（RCU Target port）
  • ELUN：Externalポート（External Initiator port）

Bidirectionalポートでは、4つの属性がすべて表示されます。

portSpeed

string

転送速度の設定値

  • AUT（AUTO）
  • nG（nは数字）

loopId

string

ポートのループID（AL_PA）の設定値

fabricMode

boolean

ポートのFabricモード

  • true：設定あり
  • false：設定なし

portConnection

string

ポートのトポロジ設定

  • FCAL
  • PtoP

portType属性がISCSIの場合は表示されません。

lunSecuritySetting

boolean

ポートのLUNセキュリティ設定

  • true：設定あり
  • false：設定なし

wwn

string

外部WWN

portType属性がISCSIの場合は表示されません。

physicalPortId

string

物理ポートのポート番号

Virtual Storage PlatformまたはHUS VMの場合に表示されます。

リソースID引継ぎ構成の場合に表示されます。

詳細情報を追加して取得する場合の出力例を次に示します。

{
  "data" : [ 
    {
      "portId" : "CL1-A",
      "portType" : "FIBRE",
      "portAttributes" : [ "TAR" ],
      "portSpeed" : "AUT",
      "loopId" : "EF",
      "fabricMode" : true,
      "portConnection" : "PtoP",
      "lunSecuritySetting" : true,
      "wwn" : "50060e8007274300",
      "logins" : [
        {
          "loginWwn" : "C0507603BFAA002C",
          "wwnNickName" : "-",
          "isLoggedIn" : false
        }, 
        {
          "loginWwn" : "C05076087D5A0012",
          "wwnNickName" : "ep22_10_0",
          "hostGroupId" : "CL1-A,9",
          "isLoggedIn" : true
        }
      ]
    },
    {
      "portId" : "CL1-B",
      "portType" : "ISCSI",
      "portAttributes" : [ "TAR" ],
      "portSpeed" : "10G",
      "loopId" : "00",
      "fabricMode" : false,
      "lunSecuritySetting" : true,
      "logins" : [
        {
          "loginIscsiName" : "iqn.1991-05.com.microsoft:hy0295",
          "iscsiNickName" : "hypoi0295",
          "hostGroupId" : "CL1-B,0",
          "iscsiTargetName" : "iqn.1994-04.jp.co.hitachi:rsd.h8h.t.10011.1d000",
          "isLoggedIn" : false
        },
        {
          "loginIscsiName" : "iqn.1991-05.com.microsoft:hy0295",
          "iscsiNickName" : "hypoi0295",
          "hostGroupId" : "CL1-B,94",
          "iscsiTargetName" : "iqn.1994-04.jp.co.hitachi:rsd.h8h.t.10011.1d05e",
          "isLoggedIn" : true
        }
      ]
    }
  ]
}

クエリパラメータでdetailInfoTypeにloginsを指定して実行すると、次の情報も取得できます。

属性

型

説明

logins

object[]

HBAのWWNまたはiSCSIネームのストレージシステムのポートへのログイン情報

WWNの場合

  • loginWwn（string）

    HBAのWWN

  • wwnNickName（string）※

    WWNのニックネーム

  • hostGroupId（string）※

    ホストグループのオブジェクトID

  • isLoggedIn（boolean）

    ホストのログイン状態

    • true：ログイン中
    • false：ログインされていない

iSCSIネームの場合

  • loginIscsiName（string）

    iSCSIイニシエータのiSCSIネーム

  • iscsiNickName（string）※

    iSCSIネームのニックネーム

  • hostGroupId（string）※

    iSCSIターゲットのオブジェクトID

  • iscsiTargetName（string）

    iSCSIターゲットのiSCSIネーム

  • isLoggedIn（boolean）

    ホストのログイン状態

    • true：ログイン中
    • false：ログインされていない

注※　これらの属性の値が更新されたあと、REST APIで最新の情報が取得できるようになるまでに30秒から数分程度の時間が掛かることがあります。しばらく待ってから再度リクエストを実行してください（VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合で、SVPと連携しない構成のときを除く）。

クエリパラメータでdetailInfoTypeにportModeを指定して実行すると、次の情報も取得できます。

属性

型

説明

portMode

string

ポートの動作モード

  • FC-NVMe：NVMeモード
  • FCP-SCSI：SCSIモード
  • NOT SUPPORTED：VSP 5000 シリーズ以外の場合、またはFC-NVMe未対応のポートの場合に表示されます。

ステータスコード

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

コード例

すべてのポートの情報を取得する場合

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/ports

ポートの種別を指定してポートの情報を取得する場合

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/ports?portType=ISCSI

ポートの属性を指定してポートの情報を取得する場合

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/ports?portAttributes=ELUN

詳細情報を追加して取得する場合

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session bc9179ae-8223-4da1-8140-e9ef3d65878f" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/800000012345/ports?detailInfoType=logins

関連項目

ページの先頭へ

All Rights Reserved. Copyright© 2016, 2021, Hitachi, Ltd.