Deleting an 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
This request deletes information about an iSCSI name (on the external storage system) that is registered 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 (Provisioning)

Request line

POST base-URL/v1/objects/iscsi-ports/object-ID/actions/remove/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 on the external storage system

Specify an IPv4 or IPv6 IP address.

iscsiName

string

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

Specify the name in iqn or eui format.

This attribute is case sensitive.

Response message

A job object is returned. For details about attributes other than affectedResources, see the description of job objects.

Attribute

Description

affectedResources

URL of the port (on the local storage system) whose iSCSI name information about the external storage system has been deleted

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