Getting information about channel boards

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
This request gets information about all channel boards.
Note:
  • You can use this API function for VSP 5000 series.

  • To get up-to-date information, you must run the API request that refreshes the storage system's cache before running this request. For details, see "Updating the cache of storage system configuration information".

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/channel-boards

Request message

Object ID
None.
Query parameters
None.
Body
None.

Response message

Body
{
  "data" : [ {
    "channelBoardId" : 3,
    "location" : "CHB-01F",
    "clusterNumber" : 1,
    "channelBoardNumber" : 3,
    "channelBoardType" : "FIBRE",
    "numOfPorts" : "4Port",
    "maxPortSpeed" : "32G",
    "cableMaterial" : "-"
  }, {
    "channelBoardId" : 7,
    "location" : "CHB-02F",
    "clusterNumber" : 2,
    "channelBoardNumber" : 3,
    "channelBoardType" : "FIBRE",
    "numOfPorts" : "4Port",
    "maxPortSpeed" : "32G",
    "cableMaterial" : "-"
  } ]
}

Attribute

Type

Description

channelBoardId

int

ID of the channel board

location

string

Location of the channel board

clusterNumber

int

Cluster number of the channel board

channelBoardNumber

int

Number of the channel board

Each channel board in a cluster is assigned a unique number.

channelBoardType

string

Type of ports that are installed on the channel board

  • FICON
  • FIBRE
  • ISCSI

numOfPorts

string

Number of ports that are installed on the channel board

  • 2Port
  • 4Port
  • -

If this information cannot be obtained, a hyphen (-) is output.

maxPortSpeed

string

Data transmission speed of the ports installed on the channel board

  • 10G
  • 16G
  • 32G
  • -

If this information cannot be obtained, a hyphen (-) is output.

cableMaterial

string

Type of cable materials that can be used with the ports that are installed on the channel board

  • Optical
  • -

If no information about the type of cable materials exists, a hyphen (-) is output.

Status codes

For details on the status codes of the request for this operation, see the description on HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/channel-boards