Adding an external path to an external path group

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 adds external path information to an existing external path group. The priority of the path is set in ascending order, according to the order in which the path was added.

Note:

If you use a port for external connections as the endpoint of an I/O path from an external storage system to a local storage system, the I/O path might become disconnected. Use a route that can be used as an external path. For details about external paths, see the Hitachi Universal Volume Manager User Guide.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/external-path-groups/object-ID/actions/add-path/invoke

Request message

Object ID

Specify the value of externalPathGroupId that was obtained by the request to get information about the external path group.

Attribute	Type	Description
externalPathGroupId	int	(Required) External path group number

Query parameters: None.

Body

The following is a coding example when a Fibre Channel port is used:

{
"parameters": {
    "portId":"CL7-A",
    "externalWwn":"50060E801033C2F0"
}
}

When a Fibre Channel port is used:

Attribute	Type	Description
portId	string	(Required) Number of the port on the local storage system
externalWwn	string	(Required) WWN of the external storage system

The following is a coding example when an iSCSI port is used:

{
  "parameters": {
    "portId":"CL1-C",
    "iscsiIpAddress": "192.168.0.100",
    "iscsiName": "iqn.rest.example.of.iscsi1"
  }
}

When an iSCSI port is used:

Attribute	Type	Description
portId	string	(Required) Port number on the local storage system
iscsiIpAddress	string	(Required) IP address of the iSCSI target on the external storage system Specify an IPv4 or IPv6 address.
iscsiName	string	(Required) iSCSI name of the iSCSI target on the external storage system Specify this attribute in iqn or eui format.

Attribute

Type

Description

portId

string

(Required) Port number on the local storage system

iscsiIpAddress

string

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

Specify an IPv4 or IPv6 address.

iscsiName

string

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

Specify this attribute in iqn or eui format.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute	Description
affectedResources	When a Fibre Channel port is used: The URL of the external path group to which the external path was added is returned. When an iSCSI port is used: `affectedResources` is not displayed for this API. To check whether the external path was added to the external path group, use storage management software such as CCI. For VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, you can perform this operation by using the Platform REST API (Simple). For detailed information about this operation, see the Hitachi Storage Advisor Embedded Guide on the Hitachi Vantara Knowledge website.

Attribute

Description

affectedResources

When a Fibre Channel port is used:

The URL of the external path group to which the external path was added is returned.
When an iSCSI port is used:

affectedResources is not displayed for this API.

To check whether the external path was added to the external path group, use storage management software such as CCI. For VSP E series, VSP G350, G370, G700, G900, VSP F350, F370, F700, F900, you can perform this operation by using the Platform REST API (Simple). For detailed information about this operation, see the Hitachi Storage Advisor Embedded Guide on the Hitachi Vantara Knowledge website.

Action template

None.

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 POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/external-path-groups/1/actions/add-path/invoke