Getting information about a specific port

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/simple/v1/objects/ports/object-ID

Request message

Object ID

Specify the id value obtained by getting information about the port.

Attribute	Type	Description
id	int	(Required) Port ID

Query parameters

None.

Body

None.

Response message

Body

The following output is an example of information obtained about a Fibre Channel port (port ID: CL1-A):

{
    "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"
    }
}

The following output is an example of information obtained about an iSCSI port (port ID: CL2-B):

{
  "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
  }
}

For details on the attributes that are obtained, see the description of the API function for getting port information.

Status codes

See HTTP status codes.

Coding example

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/CL1-A