Hitachi

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

7.16　特定のポートの情報を取得する

ポート番号を指定して、特定のポートの情報を取得します。このAPIでは、ファイバーチャネルポート、FCoEポート、またはiSCSIポートの情報を取得できます。

実行権限

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

リクエストライン

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

リクエストメッセージ

オブジェクトID

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

属性

型

説明

portId

string

（必須）ポート番号

クエリパラメータ

パラメータ

型

説明

detailInfoType

string

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

  • class

    ストレージシステムのキャッシュからの付加情報を追加します。

    ストレージシステムがVSP 5000 シリーズ、VSP E シリーズ、VSP Gx00 モデル、VSP G1000、VSP G1500、VSP Fx00 モデル、VSP F1500、Virtual Storage Platform、HUS VMの場合に指定できます。VSP E シリーズ、VSP G150、G350、G370、G700、G900、VSP F350、F370、F700、F900の場合、SVP と連携する構成のときに指定できます。

    最新の情報を取得する場合、事前にストレージシステムの構成情報のキャッシュを更新するAPI を実行する必要があります。詳細については、「ストレージシステムの構成情報のキャッシュを更新する」の説明を参照してください。

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

レスポンスメッセージ

ボディ

ファイバーチャネルポートの情報を取得した場合の出力例を次に示します。 

{
  "portId": "CL1-A",
  "portType": "FIBRE",
  "portAttributes": [
    "TAR"
  ],
  "portSpeed": "8G",
  "loopId": "EF",
  "fabricMode": true,
  "portConnection": "FCAL",
  "lunSecuritySetting": true,
  "wwn": "50060e8007274300",
  "logins": [
    {
      "loginWwn": "23880000871ad920",
      "wwnNickName": "-"
    },
    {
      "loginWwn": "23880000871ac910",
      "wwnNickName": "-"
    }
  ]
}

ファイバーチャネルポートの場合

属性

型

説明

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

lunSecuritySetting

boolean

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

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

wwn

string

外部WWN

physicalPortId

string

物理ポートのポート番号

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

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

logins

object[]

現在接続されているWWNがある場合に、次の属性が表示されます。

  • loginWwn（string）

    ポートにログインしているホストアダプタのWWN

  • wwnNickName（string）

    予約されている属性です。

    このAPIのバージョンでは、常にハイフン（-）が表示されます。

過去にログインしたことがあるHBAのWWNの情報を取得したい場合は、ポートの情報を取得するAPIを使用してください。

FCoEポートの情報を取得した場合の出力例を次に示します（現在接続されているWWNがない状態）。

{
  "portId": "CL1-A",
  "portType": "FCoE",
  "portAttributes": [
    "TAR"
  ],
  "portSpeed": "10G",
  "loopId": "98",
  "fabricMode": true,
  "portConnection": "PtoP",
  "lunSecuritySetting": true,
  "wwn": "50060e8007274306",
  "staticMacAddress": "e3:00:00:e0:8b:02",
  "vLanId": "0x03fe",
  "dynamicMacAddress": "e2:00:00:e0:8b:02",
  "virtualPortStatus": "DWN",
  "virtualPortId": "0x00",
  "fcoeSwitchControlId": "0x0000"
}

FCoEポートの場合

属性

型

説明

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

lunSecuritySetting

boolean

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

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

wwn

string

外部WWN

physicalPortId

string

物理ポートのポート番号

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

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

logins

object[]

現在接続されているWWNがある場合に、次の属性が表示されます。

  • loginWwn（string）

    ポートにログインしているホストアダプタのWWN

  • wwnNickName（string）

    予約されている属性です。

    このAPIのバージョンでは、常にハイフン（-）が表示されます。

過去にログインしたことがあるHBAのWWNの情報を取得したい場合は、ポートの情報を取得するAPIを使用してください。

staticMacAddress

string

ポートの静的なMACアドレス

vLanId

string

VLANの値（16進数）

dynamicMacAddress

string

ポートの動的なMACアドレス

virtualPortStatus

string

仮想ポートの状態

  • DWN：リンクダウン
  • LOT：リンクアップ（ログオフ）
  • LIN：リンクアップ（ログオン）

virtualPortId

string

仮想ポートの番号

サポートされていない場合、0x00が表示されます。

fcoeSwitchControlId

string

FCoEスイッチの管理番号

サポートされていない場合、0x0000が表示されます。

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

{
  "portId": "CL1-D",
  "portType": "ISCSI",
  "portAttributes": [
    "TAR"
  ],
  "portSpeed": "10G",
  "loopId": "00",
  "fabricMode": false,
  "lunSecuritySetting": true,
  "logins": [
    {
      "loginIscsiName": "iqn.1996-04.de.suse:01:a0cada20917f"
    }
  ],
  "tcpOption": {
    "ipv6Mode": false,
    "selectiveAckMode": true,
    "delayedAckMode": true,
    "isnsService": false,
    "tagVLan": false
  },
  "tcpMtu": 1500,
  "iscsiWindowSize": "64KB",
  "keepAliveTimer": 60,
  "tcpPort": "3260",
  "ipv4Address": "192.168.116.19",
  "ipv4Subnetmask": "255.255.0.0",
  "ipv4GatewayAddress": "0.0.0.0",
  "ipv6LinkLocalAddress": {
    "status": "INV",
    "addressingMode": "AM",
    "address": "fe80::"
  },
  "ipv6GlobalAddress": {
    "status": "INV",
    "addressingMode": "AM",
    "address": "::"
  },
  "ipv6GatewayGlobalAddress": {
    "status": "INV",
    "address": "::",
    "currentAddress": "::"
  }
}

iSCSIポートの場合

属性

型

説明

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：設定なし

lunSecuritySetting

boolean

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

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

physicalPortId

string

物理ポートのポート番号

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

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

logins

object[]

現在接続されているiSCSIネームがある場合に、次の属性が表示されます。

  • loginIscsiName（string）

    ポートにログインしているホストアダプタのiSCSIネーム

過去にログインしたことがあるiSCSIネームの情報を取得したい場合は、ポートの情報を取得するAPIを使用してください。

vLanId

string

VLAN ID（10進数）

tcpOption

object

次の属性が表示されます。

  • ipv6Mode（boolean）

    IPv6モード

  • selectiveAckMode（boolean）

    Selective Ackモード

  • delayedAckMode（boolean）

    Delayed Ackモード

  • isnsService（boolean）

    iSNSサービス

  • tagVLan（boolean）

    Tag VLAN

tcpMtu

int

iSCSI通信時のMTUの値

iscsiWindowSize

string

iSCSI通信時のWindow Sizeの値

keepAliveTimer

int

iSCSI通信時のKeep Alive Timerの値

tcpPort

string

iSCSI通信時のTCPポート番号

macAddress

string

ポートのMACアドレス

ipv4Address

string

IPv4アドレス

ipv4Subnetmask

string

IPv4サブネットマスク

ipv4GatewayAddress

string

iSCSI通信に使用するゲートウェイのIPv4アドレス

ipv6LinkLocalAddress

object

次の属性が表示されます。

  • status（string）

    IPv6 link local addressの状態を示す次の値が表示されます。

    • INV：無効（Invalid）
    • VAL：有効（Valid）
    • ACQ：取得中（Acquiring）
    • DUP：重複（Duplicated）
    • Unknown：未定義の値
  • addressingMode（string）

    IPv6 link local addressのモードを示す次の値が表示されます。

    • AM：自動取得（Auto mode）
    • MM：手動（Manual mode）
    • Unknown：未定義の値
  • address（string）

    IPv6 link local addressのアドレス値

ipv6GlobalAddress

object

次の属性が表示されます。
  • status（string）

    IPv6 Global addressの状態を示す次の値が表示されます。

    • INV：無効（Invalid）
    • VAL：有効（Valid）
    • ACQ：取得中（Acquiring）
    • DUP：重複（Duplicated）
    • Unknown：未定義の値
  • addressingMode（string）

    IPv6 Global addressのモードを示す次の値が表示されます。

    • AM：自動取得（Auto mode）
    • MM：手動（Manual mode）
    • Unknown：未定義の値
  • address（string）

    IPv6 Global addressのアドレス値

ipv6GatewayGlobalAddress

object

次の属性が表示されます。
  • status（string）

    iSCSI通信に使用するゲートウェイのIPv6 globalの状態を示す次の値が表示されます。

    • INV：無効（Invalid）
    • VAL：有効（Valid）
    • ACQ ：取得中（Acquiring）
    • DUP：重複（Duplicated）
    • Unknown：未定義の値
  • address（string）

    iSCSI通信に使用するゲートウェイのIPv6 globalのaddress値

  • currentAddress（string）

    iSCSI通信に使用するゲートウェイのIPv6 globalのcurrent address値

isnsPort

string

iSNSサーバのTCPポート番号

isnsAddress

string

iSNSサーバのアドレス

クエリパラメータでdetailInfoTypeにclassを指定して実行すると、ストレージシステムのキャッシュからの付加情報も取得されます。

属性

型

説明

channelBoardId

int

チャネルボードのID

ストレージシステムによっては、チャネルボードをチャネルアダプタまたはチャネルブレードに読み替えてください。

ipv6GlobalAddress2

object

IPv6 Global address2 に関する情報

iSCSIポートの場合に出力されます。

  • address（string）

    IPv6 Global address2のアドレス値

  • status（string）

    IPv6 Global address2の状態

    • INV：無効（Invalid）
    • VAL：有効（Valid）
    • ACQ：取得中（Acquiring）
    • DUP：重複（Duplicated）
    • Unknown：未定義の値

iscsiVirtualPortModeがtrueの場合は出力されません。

ipv6SubnetPrefixLength

int

IPv6サブネットプレフィックス長

iSCSIポートの場合に出力されます。

IPv6設定が無効な場合は-1が出力されます。

iscsiVirtualPortModeがtrueの場合は出力されません。

iscsiInitiatorName

string

ストレージシステムのポートのiSCSIネーム

iSCSIポートの場合に出力されます。

t10piMode

string

ポートのT10 PI モードの状態

  • Enable：有効
  • Disable：無効
  • Unknown：状態不明（未サポート）

iscsiVirtualPortMode

boolean

iSCSI仮想ポートモードが有効かどうか

iSCSIポートの場合に出力されます。

  • true：有効
  • false：無効

クエリパラメータで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/CL1-A

関連項目

ページの先頭へ

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