Getting port information

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

None.

Query parameters

Parameter	Type	Filter Condition
protocol	string	(Optional) Specify one of the following values as the protocol of the port: FC iSCSI

Body

None.

Response message

Body

The following in an example of the output when information is obtained about all ports.

{
  "data": [
    {
      "id": "CL1-A",
      "protocol": "FC",
      "portWwn": "50060e80124e3b00",
      "portSpeed": "NUMBER_0",
      "portSecurity": true,
      "fcInformation": {
        "alPa": "EF",
        "fabricSwitchSetting": true,
        "connectionType": "Point_To_Point",
        "sfpDataTransferRate": "NUMBER_16"
      }
    },
    {
      "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": 2
}

The following output is an example of information obtained about ports whose protocol is iSCSI (when iSCSI is specified in the protocol query parameter):

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

Attribute	Type	Description
id	string	Port ID
protocol	string	Protocol that can be any of the following values: FC iSCSI
portWwn	string	WWN of the port This attribute appears if the protocol is FC.
portIscsiName	string	iSCSI name of the port This attribute appears if the protocol is iSCSI.
portSpeed	string	Data transfer speed of the port: NUMBER_0: Auto NUMBER_1: 1 Gbps NUMBER_2: 2 Gbps NUMBER_4: 4 Gbps NUMBER_8: 8 Gbps NUMBER_10: 10 Gbps NUMBER_16: 16 Gbps NUMBER_32: 32 Gbps
portSecurity	boolean	Whether the port security setting is enabled: true: Enabled false: Disabled
fcInformation	object	FC information when the protocol is Fibre Channel: alPa (string) Address of the port used for Arbitrated Loop Physical Address (AL_PA). fabricSwitchSetting (boolean) Whether the fabric switch setting is enabled: true: Enabled false: Disabled connectionType (string) Topology setting: Point_To_Point FC_AL sfpDataTransferRate (string) Transfer rate: NUMBER_16: 16 Gbps NUMBER_32: 32 Gbps
iscsiInformation	object	iSCSI information when the protocol is iSCSI: vlanUse (boolean) Whether the VLANs are enabled: true: Enabled false: Disabled vlanId (int) VLAN ID Appears only if VLANs are enabled. ipMode (string) IP address format: ipv4 ipv4v6 ipv4Information (object) IPv4 information: address (string) IP address subnetMask (string) Subnet mask defaultGateway (string) Default gateway address ipv6Information (object) IPv6 information: linklocal (string) Method for setting the link local address: - Auto - Manual linklocalAddress (string) Link local address linklocalAddressStatus (string) Status of the link local address - INVALID: Invalid - VALID: Valid - ACQUIRING: Acquiring - DUPLICATED: Duplicated This attribute appears if the value of the linklocal attribute is Auto. global (string) Method for setting the global address: - Auto - Manual globalAddress (string) Global address globalAddressStatus (string) Status of the global address - INVALID: Invalid - VALID: Valid - ACQUIRING: Acquiring - DUPLICATED: Duplicated This attribute appears if the value of the globalAddress attribute is Auto. defaultGateway (string) Gateway address isIpv6Updating (boolean) Whether processing is configuring information corresponding to IPv6 true: Processing is occuring If true appears (indicating that processing is occuring), the values before the configuration processing appear for the following attributes: - linklocalAddress - linklocalAddressStatus - globalAddress - globalAddressStatus - defaultGateway - linkMtuSize false: Processing is not occuring tcpPort (int) TCP port number for iSCSI communications. selectiveAck (boolean) Whether selective ACK is enabled: true: Enabled false: Disabled delayedAck (boolean) Whether delayed ACK is enabled: true: Enabled false: Disabled windowSize (string) Window size mtuSize (string) MTU size linkMtuSize (string) Link MTU size keepAliveTimer (int) Value (in seconds) of the Keep Alive timer for iSCSI communications. isnsServerMode (boolean) Whether iSNS server mode is enabled: true: Enabled false: Disabled isnsServerIpAddress (string) IP address of the iSNS server (IPv4 or IPv6) The IP address in use when the iSNS server mode setting is enabled. If virtual ports are enabled, this attribute is hidden. isnsServerPort (int) TCP port number of the iSNS server The TCP port number in use when the iSNS server mode setting is enabled. If virtual ports are enabled, this attribute is hidden. virtualPortEnabled (boolean) Whether the virtual ports are enabled: true: Enabled If this value is true, indicating that virtual ports are enabled, the information for which the virtual port number is 0 appears for the iscsiInformation attribute. false: Disabled

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