Creating a Host Connection

POST /connection/host/{host_id}/volume/{volume_id}

Introduction

Creates the Connection specified by host_id and volume_id.

Caution
  • If the specified Host has more than one LUN Group set with Affinity, the RESTful API will respond with an error due to an unsupported configuration.

  • If the Connection setting is changed for a Host where shared_host_href_list is returned as the Host information, the Connection settings for the other hosts are also changed. If you still want to set the Connection, you must set the force parameter to true.

  • You cannot specify a CA Port to connect to. The Connection setting with CA Ports that meet the following conditions is automatically established.
    • Affinity Mode is Enable.

    • Connected to the specified Host.

    • The port operation mode is CA or CARA.

    • It is not used by the Storage Cluster function.

  • There is a limit to the number of Hosts that can be connected to a CA Port. A CA Port that exceeds the limit will not be set as a Connection and will exit normally. Refer to the information in the response resource to determine which CA Ports are used for the Connection setting.

  • You cannot create the Connections in the conditions described below. If you want to create the Connection, use ETERNUS SF Storage Cruiser.
    • Connection used in the Storage Cluster function

    • Connection used in VVOL (VVOL Access Path Settings)

  • The number of volumes that can be connected is 256, and the number of hluns that can be specified is between 0 and 255. However, this condition varies depending on the Host Response that is set for the specified Host. If you want to connect 256 or more Volumes to the Host, change the LUN Addressing of the Host Response to "Host Response" (Flat Space Addressing).

  • If the Affinity setting fails after a LUN Group is created, the created LUN Group remains. In this case, the Volume registered in that LUN Group must be removed before deleting the Volume itself. Please remove the LUN Group from ETERNUS Web GUI or ETERNUS CLI.

  • You can find the Href of the created Host Connection in resource_href_list of "GET /job/{job_id}".

  • For tenant users, only a Host and Volume that belong to the tenant of the current user can be specified.

Request Examples

  • This is an example of forcibly creating a Connection to Volume ID 100000 for the Host with Host ID 2.

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/connection/host/2/volume/100000?force=true"
    -d
    '{"hlun": 0}'

Response Examples

{
  "job_id": 8192001,
  "job_href": "/api/v1/job/8192001"
}

Parameters

PATH PARAMETERS

host_id

(required)

integer

Host ID.

volume_id

(required)

integer

Volume ID.

QUERY PARAMETERS

force

boolean

Whether the operation is forced.

Input criteria:

  • If a Connection setting is added for a Host where shared_host_href_list is returned as the Host information, the specified Volume will be accessible from other Hosts in the list.

    In this case, to add the Connection, the force parameter must be set to true. If not specified or false, an error is returned.

REQUEST BODY

hlun

integer

The number of the Volume as seen by the Host.

If not specified, the smallest hlun is set.

Refer to the information on the Connection Resource that was created to determine which hlun was set.

Responses

If the job registration is successful, the HTTP status code will be 202 (Accepted) and the response body will respond.

RESPONSE BODY

job_id

integer

Job ID.

job_href

string

Resource link of the job.