Performing a login test on an iSCSI target 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 a login result by logging in to an iSCSI target on an external storage system that is registered to a port on the local storage system.

If an attempt to log in fails, revise the settings so that you can log in to the iSCSI target, or delete that iSCSI target. If iSCSI targets remain to which you cannot log in, attempts to obtain information might fail because a heavy load might be placed on the network or external storage system when you search for an iSCSI target of a port on the external 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/check/invoke

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
{
    "parameters": {
        "iscsiIpAddress": "192.168.0.100",
        "iscsiName": "iqn.rest.example.of.iscsi1"
    }
}

Attribute

Type

Description

iscsiIpAddress

string

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

Specify an IPv4 or IPv6 IP address.

iscsiName

string

(Required) iSCSI name of the iSCSI target of the external storage system

Specify the name in iqn or eui format.

This attribute is case sensitive.

Response message

Body
{
    "portId": "CL1-A",
    "externalIscsiTargets": [
        {
            "iscsiIpAddress": "192.168.0.100",
            "iscsiName": "iqn.rest.example.of.iscsi1",
            "isLoginSucceeded": true
        }
    ]
}

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:

  • iscsiIpAddress (string)

    IP address of the iSCSI target

  • iscsiName (string)

    iSCSI name of the iSCSI target

  • isLoginSucceeded (boolean)

    Result of logging in to the iSCSI target
    • true: The login attempt succeeded.
    • false: The login attempt failed.

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/check/invoke"