Getting information about a specific port

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
The following request gets information about a specific port by specifying the port number. You can use this API to get information about Fibre Channel port, or iSCSI port.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

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

Attribute

Type

Description

portId

string

(Required) Port number

Query parameters

Parameter

Type

Description

detailInfoType

string

(Optional) Type of detailed information to be obtained

  • class

    Adds additional information from the storage system's cache.

    You can specify this item 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".

  • portMode: Operating mode of the port
Body
None.

Response message

Body

The following is an example of the output generated when getting Fibre Channel port information:

{
  "portId": "CL1-A",
  "portType": "FIBRE",
  "portAttributes": [
    "TAR",
    "MCU",
    "RCU",
    "ELUN"
  ],
  "portSpeed": "AUT",
  "loopId": "EF",
  "fabricMode": true,
  "portConnection": "PtoP",
  "lunSecuritySetting": true,
  "wwn": "50060e80124e3b00"
}

For a Fibre Channel port:

Attribute

Type

Description

portId

string

Port number

portType

string

Port type

One of the following values is output:

FIBRE, SCSI, ISCSI, ENAS, ESCON, FICON

portAttributes

string[]

The value set for the port attribute

  • TAR: Target port (Fibre Target port)
  • MCU: Initiator port (MCU Initiator port)
  • RCU: RCU target port (RCU Target port)
  • ELUN: External port (External Initiator port)

For a bidirectional port, all four attributes are output.

portSpeed

string

The value set for the transfer speed

  • AUT (AUTO)
  • nG (where n is a number)

loopId

string

The value set for the port loop ID (AL_PA)

fabricMode

boolean

Fabric mode of the port

  • true: Set.
  • false: Not set.

portConnection

string

Topology setting for the port

  • FCAL
  • PtoP

lunSecuritySetting

boolean

LUN security setting for the port

  • true: Set.
  • false: Not set.

wwn

string

External WWN

logins

object[]

If there is a currently-connected WWN, the following attributes are output:

  • loginWwn (string)

    WWN of the host adapter that is logged in to the port

  • wwnNickName (string)

    Reserved attribute

    The version of this API is always displayed as a hyphen (-).

The following is an example of the output generated when getting iSCSI port information.

{
  "portId" : "CL1-A",
  "portType" : "ISCSI",
  "portAttributes" : [ "TAR", "MCU", "RCU", "ELUN" ],
  "portSpeed" : "10G",
  "loopId" : "00",
  "fabricMode" : false,
  "lunSecuritySetting" : true,
  "tcpOption" : {
    "ipv6Mode" : false,
    "selectiveAckMode" : true,
    "delayedAckMode" : true,
    "isnsService" : false,
    "tagVLan" : false
  },
  "tcpMtu" : 1500,
  "iscsiWindowSize" : "64KB",
  "keepAliveTimer" : 60,
  "tcpPort" : "3260",
  "macAddress" : "00:1f:67:1f:14:1d",
  "ipv4Address" : "192.168.0.100",
  "ipv4Subnetmask" : "255.255.255.0",
  "ipv4GatewayAddress" : "0.0.0.0",
  "ipv6LinkLocalAddress" : {
    "status" : "INV",
    "addressingMode" : "AM",
    "address" : "fe80::"
  },
  "ipv6GlobalAddress" : {
    "status" : "INV",
    "addressingMode" : "AM",
    "address" : "::"
  },
  "ipv6GatewayGlobalAddress" : {
    "status" : "INV",
    "address" : "::",
    "currentAddress" : "::"
  }
}

For an iSCSI port:

Attribute

Type

Description

portId

string

Port number

portType

string

Port type

One of the following values is output:

FIBRE, SCSI, ISCSI, ENAS, ESCON, FICON

portAttributes

string[]

The value set for the port attribute

  • TAR: Target port (Fibre Target port)
  • MCU: Initiator port (MCU Initiator port)
  • RCU: RCU target port (RCU Target port)
  • ELUN: External port (External Initiator port)

For a bidirectional port, all four attributes are output.

portSpeed

string

The value set for the transfer speed

  • AUT (AUTO)
  • nG (where n is a number)

loopId

string

The value set for the port loop ID (AL_PA)

fabricMode

boolean

Fabric mode of the port

  • true: Set.
  • false: Not set.

lunSecuritySetting

boolean

LUN security setting for the port

  • true: Set.
  • false: Not set.

logins

object[]

If there is a currently-connected iSCSI name, the following attributes are output:

  • loginIscsiName (string)

    iSCSI name of the host adapter that is logged in to the port

vLanId

string

VLAN ID (in decimal number format)

tcpOption

object

The following attributes are output:

  • ipv6Mode (boolean)

    IPv6 mode

  • selectiveAckMode (boolean)

    Selective Ack mode

  • delayedAckMode (boolean)

    Delayed Ack mode

  • isnsService (boolean)

    iSNS service

  • tagVLan (boolean)

    Tag VLAN

tcpMtu

int

Value of MTU for iSCSI communication

iscsiWindowSize

string

Value of Window Size for iSCSI communication

keepAliveTimer

int

Value of Keep Alive Timer for iSCSI communication

tcpPort

string

TCP port number for iSCSI communication

macAddress

string

MAC address of the port

ipv4Address

string

IPv4 address

ipv4Subnetmask

string

IPv4 subnet mask

ipv4GatewayAddress

string

IPv4 address of the gateway to be used for iSCSI communication

ipv6LinkLocalAddress

object

The following attributes are output:

  • status (string)

    One of the following values that indicate the status of the IPv6 link local address is output:

    • INV: Invalid
    • VAL: Valid
    • ACQ: Acquiring
    • DUP: Duplicated
    • Unknown: Undefined value
  • addressingMode (string)

    One of the following values that indicate the mode of the IPv6 link local address is output:

    • AM: Auto mode
    • MM: Manual mode
    • Unknown: Undefined value
  • address (string)

    IPv6 link local address value

ipv6GlobalAddress

object

The following attributes are output:

  • status (string)

    One of the following values that indicate the status of the IPv6 global address is output:

    • INV: Invalid
    • VAL: Valid
    • ACQ: Acquiring
    • DUP: Duplicated
    • Unknown: Undefined value
  • addressingMode (string)

    One of the following values that indicate the mode of the IPv6 global address is output:

    • AM: Auto mode
    • MM: Manual mode
    • Unknown: Undefined value
  • address (string)

    IPv6 global address value

ipv6GatewayGlobalAddress

object

The following attributes are output:

  • status (string)

    One of the following values that indicate the status of the IPv6 global address of the gateway to be used for iSCSI communication is output:

    • INV: Invalid
    • VAL: Valid
    • ACQ: Acquiring
    • DUP: Duplicated
    • Unknown: Undefined value
  • address (string)

    IPv6 global address value of the gateway to be used for iSCSI communication

  • currentAddress (string)

    IPv6 global current address value of the gateway to be used for iSCSI communication

isnsPort

string

TCP port number of the iSNS server

isnsAddress

string

Address of the iSNS server

If you run this request with class specified for detailInfoType in the query parameters, additional information from the storage system's cache is also obtained.

Attribute

Type

Description

channelBoardId

int

ID of the channel board

ipv6GlobalAddress2

object

Attributes related to IPv6 Global address2

This information is output for iSCSI ports.

  • address (string)

    Address value for IPv6 Global address2

  • status (string)

    Status of IPv6 Global address2

    • INV: Invalid
    • VAL: Valid
    • ACQ: Acquiring
    • DUP: Duplicated
    • Unknown: Undefined value

This information is not output if iscsiVirtualPortMode is true.

ipv6SubnetPrefixLength

int

Length of the IPv6 subnet prefix

This information is output for iSCSI ports.

If the setting for IPv6 is invalid, -1 is output.

This information is not output if iscsiVirtualPortMode is true.

iscsiInitiatorName

string

iSCSI name of the storage system port

This information is output for iSCSI ports.

t10piMode

string

Status of the T10 PI mode of the port

  • Enable: Enabled
  • Disable: Disabled
  • Unknown: Status unknown (unsupported)

iscsiVirtualPortMode

boolean

Whether iSCSI virtual port mode is enabled

This information is output for iSCSI ports.

  • true: Enabled
  • false: Disabled

You can also get the following information by executing the request with portMode specified for detailInfoType in the query parameters.

Attribute

Type

Description

portMode

string

Operating mode of the port

  • FC-NVMe: NVMe mode
  • FCP-SCSI: SCSI mode
  • NOT SUPPORTED: This value is output if the storage system is not a VSP 5000 series, VSP E1090, VSP E1090H storage system or if the port does not support FC-NVMe.

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