Hostの登録

POST /host

概要説明

新規にHostを登録します。

注意

  • FC Host、iSCSI Hostのみ登録できます。

  • Host Groupへの登録はできません。

  • Host Groupを使用してHost Affinity設定を行う場合はETERNUS Web GUIまたはETERNUS CLI を使用してください。

  • 作成したHostのHrefは、「GET /job/{job_id}」のresource_href_listで確認できます。

リクエスト例

  • 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"}'

  • 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",}'

レスポンス例

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

Parameters

REQUEST BODY

type

(required)

string

Hostタイプ。
項目 説明
FC FC Host
iSCSI iSCSI Host
name

(required)

string

Host名。

入力条件：

  • 指定可能な文字数は1～16です。

  • 使用可能文字種は半角英数字記号です。ただし、","および"?"は除きます。

  • すでに存在する名前を付けることはできません。
wwn

string

FC HostのWWN。

FCタイプのHostを登録する場合に指定が必須です。

入力条件：

  • 16進数 16文字で指定してください。

  • すでに使用されているwwnを付けることはできません。
iscsi_name

string

iSCSI HostのiSCSI Name。

iSCSIタイプのHostを登録する場合に指定が必須です。

入力条件：

  • 指定可能な文字数は4～223です。

  • 英数字、ハイフン（-）、ドット（.）、コロン（:）が使用できます。

  • 先頭文字列にはiqn. またはeui. を付ける必要があります。

  • 英大文字小文字を区別しません。
alias_name

string

iSCSI Nameに対応するAlias Name。

iSCSIタイプのHostを登録する場合にのみ指定可能です。

使用しない場合は省略可能です。

入力条件：

  • 指定可能な文字数は1～31です。

  • ","、"?" を除く半角英数字記号と、半角スペースが使用できます。

  • すでに使用されているAlias Nameを付けることはできません。
ip_version

string

iSCSI HostのIP形式。

iSCSIタイプのHostを登録する場合に指定が必須です。
項目 説明
IPv4 IPv4形式
IPv6 IPv6形式
ip_address

string

iSCSI HostのIPアドレス。

iSCSIタイプのHostを登録する場合にのみ指定可能です。

IPv4形式の場合、IPv4 標準記法(256 基数表記によるd.d.d.d 形式の文字列)で指定してください。

IPv6形式の場合、以下が指定できます。

  • リンクローカルアドレス

  • グローバルアドレス

  • ユニークローカルアドレス

  • 6to4アドレスip_addressを省略した場合、ip_versionで指定したIP形式であれば任意のIP Addressからのアクセスを許可します。

    ip_addressを指定した場合、指定IP Addressからのアクセスのみを許可します。

    このとき、ip_addressはip_versionで指定したIP形式である必要があります。
chap_user

string

CHAP認証のユーザー名。

iSCSIタイプのHostを登録する場合にのみ指定可能です。

CHAP認証を使用しない場合は省略可能です。

入力条件：

  • 指定可能な文字数は1～255です。

  • ","、"?" を除く半角英数字記号と、半角スペースが使用できます。
chap_password

string

CHAP認証のパスワード。

iSCSIタイプのHostを登録する場合にのみ指定可能です。

chap_userを指定した場合、パスワードの指定が必須です。

入力条件：

  • 指定可能な文字数は12～100です。

  • ","、"?" を除く半角英数字記号と、半角スペースが使用できます。
host_response_name

string

Default: "Default"

Hostに割り当てるHost Response Name。

省略した場合、Default設定のHost Responseが割り当てられます。

Host ResponseにはPresetとして以下があります。

  • Default

  • Solaris MPxIO

  • HP-UX

  • AIX

  • AIX VxVM

  • VS850/SVC

  • BS2000

Responses

正常にジョブ登録できた場合、HTTPステータスコードが202 (Accepted)となりレスポンスボディを応答します。

RESPONSE BODY

job_id

integer

Job ID。
job_href

string

JobのResourceへのLink。