Creating a Host

POST /host

Introduction

Creates a new Host.

Caution

  • Only FC Hosts and iSCSI Hosts can be created.

  • This function cannot be used to create hosts to Host Groups.

  • Use ETERNUS Web GUI or ETERNUS CLI to configure Host Affinity using the Host Group.

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

Request Examples

  • This is an example of creating an FC Host.

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/host"
-d
'{"type": "FC","name": "HBA#1","wwn": "40000000abc80e38","host_response_name": "Solaris MPxIO"}'

  • This is an example of creating an iSCSI Host.

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X POST "https://192.168.1.1:5665/api/v1/host"
-d
'{"type": "iSCSI","name": "HBA#1","iscsi_name": "iqn.1991-05.com.microsoft","alias_name": "IQN-DXL","ip_version": "IPv4","ip_address": "192.168.1.10",}'

Response Examples

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

Parameters

REQUEST BODY

type

(required)

string

Host type.
Item Description
FC FC Host
iSCSI iSCSI Host
name

(required)

string

Host name.

Input criteria:

  • The available number of characters allowed is 1 to 16.

  • Acceptable characters are single byte alphanumeric characters. However, "," and "?" are excluded.

  • You cannot use a name that already exists.
wwn

string

FC Host WWN

This item is required when creating an FC type Host.

Input criteria:

  • Specify a 16-character hexadecimal number.

  • You cannot use a wwn that is already being used.
iscsi_name

string

iSCSI Name of the iSCSI Host.

This item is required when creating an iSCSI type Host.

Input criteria:

  • The available number of characters allowed is 4 to 223.

  • Alphanumeric characters, hyphens (-), dots (.), and colons (:) can be used.

  • The first string must be "iqn." or "eui.".

  • It is not case-sensitive.
alias_name

string

Alias Name for iSCSI Name.

This item is available when creating an iSCSI type Host.

Optional.

Input criteria:

  • The available number of characters allowed is 1 to 31.

  • Alphanumeric characters, symbols (except "," and "?"), and spaces can be used.

  • You cannot use an Alias Name that is already being used.
ip_version

string

The IP format of the iSCSI Host.

This item is required when creating an iSCSI type Host.
Item Description
IPv4 IPv4 format
IPv6 IPv6 format
ip_address

string

The IP address of the iSCSI Host.

This item is available when creating an iSCSI type Host.

To specify an IP address in the IPv4 format, use the IPv4 standard notation (base-256 "d.d.d.d" string).

For IPv6 format, you can specify the following:

  • Link local address

  • Global address

  • Unique local address

  • 6to4 address: If ip_address is omitted, access from any host is allowed if the IP format is specified with ip_version.

    If ip_address is specified, only access from the specified IP address is allowed.

    In this case, specify ip_address using the IP format specified in ip_version.
chap_user

string

User name for CHAP authentication.

This item is available when creating an iSCSI type Host.

Optional if the CHAP authentication is not used.

Input criteria:

  • The available number of characters allowed is 1 to 255.

  • Alphanumeric characters, symbols (except "," and "?"), and spaces can be used.
chap_password

string

Password for CHAP authentication.

This item is available when creating an iSCSI type Host.

If chap_user is specified, a password must be specified.

Input criteria:

  • The available number of characters allowed is 12 to 100.

  • Alphanumeric characters, symbols (except "," and "?"), and spaces can be used.
host_response_name

string

Default: "Default"

Host Response Name assigned to the Host.

If omitted, the Default Host Response is assigned.

The Host Response has the following presets:

  • Default

  • Solaris MPxIO

  • HP-UX

  • AIX

  • AIX VxVM

  • VS850/SVC

  • BS2000

Responses

If successful, the HTTP status code is 202 (Accepted) and the response body is returned.

RESPONSE BODY

job_id

integer

Job ID.
job_href

string

Resource link of the job.