Host設定の変更

PATCH /host/{host_id}

概要説明

Hostの設定を変更します。

注意
  • FC Host、iSCSI Hostのみ変更できます。

  • 運用中のホストに関してホスト名以外を変更する場合は、必ず該当ホストのアクセスを停止してください。

  • ホストレスポンスを変更する場合は、変更後にサーバの再起動が必要です。

  • テナントユーザーの場合、自テナントに属するHostのみ変更できます。

リクエスト例

  • Host ID 0 のFC Hostについて、名前を変更する場合の例です。

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X PATCH "https://192.168.1.1:5665/api/v1/host/0"
    -d
    '{"name": "HBA#1",}'
  • Host ID 102 のiSCSI Hostについて、IP Addressを変更する場合の例です。

    $ curl -i -H "Content-Type:application/json" -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X PATCH "https://192.168.1.1:5665/api/v1/host/102"
    -d
    '{"ip_address": "192.168.1.10",}'

レスポンス例

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

Parameters

PATH PARAMETERS

host_id

(required)

integer

Host ID。

REQUEST BODY

name

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にのみ指定可能です。

既存のAlias Nameを削除する場合は、NULL文字列を指定してください。

入力条件:

  • 指定可能な文字数は0~31です。

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

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

ip_address

string

iSCSI HostのIPアドレス。

iSCSIタイプのHostにのみ指定可能です。

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

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

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

  • グローバルアドレス

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

  • 6to4アドレス特定のIPアドレスからのアクセスのみ許可している場合の、IPアドレス変更のみ可能です。

    任意のIPアドレスからのアクセスを許可している場合、IPアドレスを特定するような変更はできません。

chap_user

string

CHAP認証のユーザー名。

iSCSIタイプのHostにのみ指定可能です。

既存のCHAPユーザー名を削除する場合は、NULL文字列を指定してください。

入力条件:

  • 指定可能な文字数は0~255です。

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

chap_password

string

CHAP認証のパスワード。

iSCSIタイプのHostにのみ指定可能です。

入力条件:

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

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

  • ユーザー名の削除を除き、ユーザー名とパスワードどちらか一方のみ指定することはできません。

  • パスワードのみ変更したい場合は、ユーザー名に現在の設定名を指定してください。

host_response_name

string

Hostに割り当てるHost Response Name。

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。