Getting information about an iSCSI target of a port on an external 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
This request gets information by searching for an iSCSI target (on an external storage system) that is connected to the local storage system.
Note:
  • 0 is assumed for the virtual port ID if virtual port mode is enabled for the local storage system.

Execution permission

Storage Administrator (View Only)

Request line

POST base-URL/v1/objects/iscsi-ports/object-ID/actions/discover/invoke

Request message

Object ID

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

Attributes

Type

Description

portId

string

(Required) Port number of the local storage system

Query parameters
None.
Body
{
    "parameters": {
        "iscsiIpAddress": "192.168.0.100",
        "tcpPort": 3260
    }
}

Attribute

Type

Description

iscsiIpAddress

string

(Required) IP address of the iSCSI target on the external storage system

Specify an IPv4 or IPv6 IP address.

tcpPort

int

(Optional) TCP port number of the iSCSI target on the external storage system

If this attribute is omitted, the TCP port number of the port on the local storage system is assumed.

Response message

Body
{
    "portId": "CL1-A",
    "externalIscsiTargets": [
        {
            "iscsiIpAddress": "192.168.0.100",
            "tcpPort": 3260,
            "iscsiName": "iqn.rest.example.of.iscsi1",
            "virtualPortId": 0,
            "isRegistered": true
        },
        {
            "iscsiIpAddress": "192.168.0.101",
            "tcpPort": 3260,
            "iscsiName": "iqn.rest.example.of.iscsi2",
            "virtualPortId": 0,
            "isRegistered": false
        }
    ]
}

Attribute

Type

Description

portId

string

Port number of the local storage system

externalIscsiTargets

object[]

The following attributes related to the iSCSI target of the external storage system are output:

  • tcpPort (int)

    TCP port number

  • iscsiIpAddress (string)

    IP address of the iSCSI target

  • iscsiName (string)

    iSCSI name of the iSCSI target

  • 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 the virtual port mode is enabled.

  • isRegistered (boolean)

    Indicates whether this iSCSI target is registered to the iSCSI port of the local storage system
    • true: The iSCSI target is registered to the iSCSI port of the local storage system.
    • false: The iSCSI target is not registered to the iSCSI port of the local storage system.

Action template

None.

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 POST "https://192.0.2.100/ConfigurationManager/v1/objects/iscsi-ports/CL1-A/actions/discover/invoke"