Getting the iSCSI name of an external storage system that is registered to a port on the local storage system

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 the iSCSI name of an iSCSI target of a port on an external storage system that is registered to a port on the specified local storage system.

Execution permission

Storage Administrator (View Only)

Request line

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

Request message

Object ID

Specify the value of portId that was obtained by the processing to get information about ports.

Attribute

Type

Description

portId

string

(Required) Port number of the local storage system

Query parameters
None.
Body
None.

Response message

Body
{
    "portId": "CL1-A",
    "externalIscsiTargets": [
        {
            "iscsiIpAddress": "192.168.0.100",
            "tcpPort": 3260,
            "iscsiName": "iqn.rest.example.of.iscsi1",
            "authenticationMode": "CHAP",
            "iscsiTargetDirection" "D",
            "chapUserName": "Win_SQL_EX",
            "isSecretSet": true,
            "virtualPortId": 0
        },
        {
            "iscsiIpAddress": "192.168.0.101",
            "tcpPort": 3260,
            "iscsiName": "iqn.rest.example.of.iscsi2",
            "authenticationMode": "NONE",
            "iscsiTargetDirection" "S",
            "chapUserName": "-",
            "isSecretSet": false,
            "virtualPortId": 0
        }
    ]
}

Attribute

Type

Description

portId

string

Port number of the local storage system

externalIscsiTargets

object[]

The attributes related to the iSCSI target on the external storage system are output.

An empty array is output if the port on the external storage system is a Fibre Channel port.

  • iscsiIpAddress (string)

    IP address of the iSCSI target

  • tcpPort (int)

    TCP port number

  • iscsiName (string)

    iSCSI name

  • authenticationMode (string)

    CHAP-authentication mode

    • CHAP: CHAP-authentication mode
    • NONE: No authentication mode
  • iscsiTargetDirection (string)

    Direction of the iSCSI target CHAP-authentication

    • D: Bidirectional authentication (The iSCSI target and the iSCSI initiator authenticate each other.)
    • S: Unidirectional authentication (The iSCSI target authenticates the iSCSI initiator.)
  • chapUserName (string)

    CHAP user name

    The following user name is output: the user name used when the direction of CHAP-authentication is bidirectional.

    This also appears if CHAP-authentication mode is NONE.

    A hyphen (-) appears if the CHAP user name is omitted.#

  • isSecretSet (boolean)

    Indicates whether a secret password is set for the CHAP authentication

    • true: A password is set.
    • false: A password is not set.
  • virtualPortId (int)

    ID of the virtual port by which the local storage system is connected to the external storage system

    This attribute is output if virtual port mode is enabled.

#: A hyphen (-) is output if - is specified for the CHAP user name.

Status codes

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

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session f76884c29fff4dfaa664aa6981087b71" -X GET "https://192.0.2.100/ConfigurationManager/v1/objects/iscsi-ports/CL1-A"