14.3.1 ポートの情報を取得する
ポートの情報を一覧で取得します。
実行権限
ストレージ管理者(参照)
リクエストライン
GET <ベースURL>/simple/v1/objects/ports
リクエストメッセージ
- オブジェクトID
- なし。
- クエリパラメータ
-
パラメータ
型
フィルタ条件
protocol
string
(任意)取得するプロトコルとして、次の値を指定します。
- FC
- iSCSI
- ボディ
- なし。
レスポンスメッセージ
- ボディ
-
すべてのポートの情報を取得した場合の出力例を次に示します。
{ "data": [ { "id": "CL1-A", "protocol": "FC", "portWwn": "50060e8023000100", "portSpeed": "NUMBER_8", "portSecurity": true, "fcInformation": { "alPa": "EF", "fabricSwitchSetting": false, "connectionType": "FC_AL", "sfpDataTransferRate": "NUMBER_16", "portMode": "SCSI" } }, { "id": "CL2-B", "protocol": "iSCSI", "portIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h9h.i.230001.2b", "portSpeed": "NUMBER_10", "portSecurity": true, "iscsiInformation": { "vlanUse": false, "ipMode": "ipv4v6", "ipv4Information": { "address": "192.168.0.188", "subnetMask": "255.255.255.0", "defaultGateway": "0.0.0.0" }, "ipv6Information": { "linklocal": "Auto", "linklocalAddress": "fe80::21f:67ff:feaf:c26d", "linklocalAddressStatus": "VALID", "global": "Manual", "globalAddress": "fe84::1111", "defaultGateway": "::" }, "isIpv6Updating": false, "tcpPort": 3260, "selectiveAck": true, "delayedAck": true, "windowSize": "NUMBER_64K", "mtuSize": "NUMBER_1500", "linkMtuSize": "NUMBER_1500", "keepAliveTimer": 60, "isnsServerMode": false, "isnsServerIpAddress": "0.0.0.0", "isnsServerPort": 3205, "virtualPortEnabled": false } }, ], "count": 2 }
プロトコルがiSCSI(クエリパラメータprotocolにiSCSIを指定)のポートの情報を取得した出力例を次に示します。
{ "data": [ { "id": "CL2-B", "protocol": "iSCSI", "portIscsiName": "iqn.1994-04.jp.co.hitachi:rsd.h8s.i.120160.2b", "portSpeed": "NUMBER_10", "portSecurity": true, "iscsiInformation": { "vlanUse": false, "ipMode": "ipv4v6", "ipv4Information": { "address": "10.1.1.52", "subnetMask": "255.255.0.0", "defaultGateway": "0.0.0.0" }, "ipv6Information": { "linklocal": "Auto", "linklocalAddress": "fe80::21f:67ff:feaf:c278", "linklocalAddressStatus": "VALID", "global": "Auto", "globalAddress": "::", "globalAddressStatus": "INVALID", "defaultGateway": "::" }, "isIpv6Updating: false, "tcpPort": 3260, "selectiveAck": true, "delayedAck": true, "windowSize": "NUMBER_64K", "mtuSize": "NUMBER_9000", "linkMtuSize": "NUMBER_9000", "keepAliveTimer": 60, "isnsServerMode": false, "isnsServerIpAddress": "0.0.0.0", "isnsServerPort": 3205, "virtualPortEnabled": false } } ], "count": 1 }
属性
型
説明
id
string
ポートID
protocol
string
プロトコル
次に示す値が出力されます。
- FC
- iSCSI
portWwn
string
ポートのWWN
プロトコルがFCの場合に出力されます。
portIscsiName
string
ポートのiSCSIネーム
プロトコルがiSCSIの場合に出力されます。
portSpeed
string
ポートのデータ転送速度
- NUMBER_0:自動(Auto)
- NUMBER_1:1Gbps
- NUMBER_2:2Gbps
- NUMBER_4:4Gbps
- NUMBER_8:8Gbps
- NUMBER_10:10Gbps
- NUMBER_16:16Gbps
- NUMBER_25:25Gbps
- NUMBER_32:32Gbps
portSecurity
boolean
ポートのセキュリティの設定が有効かどうかが出力されます。
- true:有効
- false:無効
fcInformation
object
プロトコルがFCの場合に、FCに関する情報が出力されます。
- alPa(string)
ポートのアドレス(AL-PA)
- fabricSwitchSetting(boolean)
Fabricスイッチの設定の有効/無効
- true:有効
- false:無効
- connectionType(string)
トポロジ設定
- Point_To_Point
- FC_AL
- sfpDataTransferRate(string)
転送レート
- NUMBER_16:16Gbps
- NUMBER_32:32Gbps
- portMode(string)
ポートモード
ポートの動作モードを示します。
- INVALID
- SCSI
- NVME
ストレージシステムがVSP E1090、VSP E1090H以外の場合、INVALIDが出力されます。
iscsiInformation
object
プロトコルがiSCSIの場合に、iSCSIに関する情報が出力されます。
- vlanUse(boolean)
VLANの有効/無効
- true:有効
- false:無効
- vlanId(int)
VLAN ID
VLANの設定が有効な場合に出力されます。
- ipMode(string)
IPアドレスの形式
- ipv4
- ipv4v6
- ipv4Information(object)
IPv4に対応する情報
- address(string)
IPアドレス
- subnetMask(string)
サブネットマスク
- defaultGateway(string)
デフォルトゲートウェイのアドレス
- address(string)
- ipv6Information(object)
IPv6に対応する情報
- linklocal(string)
リンクローカルアドレスの設定方法
・Auto
・Manual
- linklocalAddress(string)
リンクローカルアドレス
- linklocalAddressStatus(string)
リンクローカルアドレスの状態
・INVALID:無効
・VALID:有効
・ACQUIRING:取得中
・DUPLICATED:重複
属性linklocalがAutoの場合に出力されます。
- global(string)
グローバルアドレスの設定方法
・Auto
・Manual
- globalAddress(string)
グローバルアドレス
- globalAddressStatus(string)
グローバルアドレスの状態
・INVALID:無効
・VALID:有効
・ACQUIRING:取得中
・DUPLICATED:重複
属性globalがAutoの場合に出力されます。
- defaultGateway(string)
ゲートウェイアドレス
- linklocal(string)
- isIpv6Updating(boolean)
IPv6に対応する情報の設定処理が処理中かどうかが出力されます。
- true:処理中
true(処理中)の場合、次に示す属性には設定前の値が出力されます。
・linklocalAddress
・linklocalAddressStatus
・globalAddress
・globalAddressStatus
・defaultGateway
・linkMtuSize
- false:処理中でない
- true:処理中
- tcpPort(int)
iSCSI 通信時のTCPポート番号
- selectiveAck(boolean)
選択型ACKの有効/無効
- true:有効
- false:無効
- delayedAck(boolean)
遅延ACKの有効/無効
- true:有効
- false:無効
- windowSize(string)
Windowサイズの値
- mtuSize(string)
MTUサイズの値
- linkMtuSize(string)
リンクMTUサイズの値
- keepAliveTimer(int)
iSCSI通信時のKeep Aliveタイマーの設定値(秒)
- isnsServerMode(boolean)
iSNSサーバモードの有効/無効
- true:有効
- false:無効
- isnsServerIpAddress(string)
iSNSサーバのIPアドレス(IPv4またはIPv6)
iSNSサーバモードの設定が有効な場合に有効なIPアドレスの値が出力されます。
仮想ポートが有効な場合、この属性は出力されません。
- isnsServerPort(int)
iSNSサーバのTCPポート番号
iSNSサーバモードの設定が有効な場合に有効なTCPポート番号の値が出力されます。
仮想ポートが有効な場合、この属性は出力されません。
- virtualPortEnabled(boolean)
仮想ポートの有効/無効
- true:有効
仮想ポートがtrue(有効)の場合、属性iscsiInformationには、仮想ポート番号が0の情報が出力されます。
- false:無効
- true:有効
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/ports