Modifying Host Settings

PATCH /host/{host_id}

Introduction

Modifies the Host settings.

Caution

  • Only FC Hosts and iSCSI Hosts can be modified.

  • To modify parameters other than the host name for the currently operating hosts, make sure to stop access from the relevant host.

  • If you change the host response, you must restart the server after the change.

  • For tenant users, only Hosts that belong to the tenant of the current user can be changed.

Request Examples

  • This is an example of changing the host name for the FC Host with Host ID 0.

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

  • This is an example of changing the IP Address for the FC Host with Host ID 102.

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

Response Examples

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

Parameters

PATH PARAMETERS

host_id

(required)

integer

Host ID.

REQUEST BODY

name

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.

Available only for 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.

Available only for 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.

Available only for iSCSI type Host.

To remove an existing Alias Name, specify a NULL string.

Input criteria:

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

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

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

string

The IP address of the iSCSI Host.

Available only for 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: Only the IP address can be changed if access is allowed from a specific IP address.

    If access is allowed from any IP addresses, the parameters to identify IP addresses cannot be set.
chap_user

string

User name for CHAP authentication.

Available only for iSCSI type Host.

To remove an existing CHAP user name, specify a NULL string.

Input criteria:

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

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

string

Password for CHAP authentication.

Available only for iSCSI type Host.

Input criteria:

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

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

  • You must specify both the username and password at the same time except when deleting a username.

  • If you only want to change the password, specify the current user name.
host_response_name

string

Host Response Name assigned to the Host.

The Host Response has the following presets:

  • Default

  • Solaris MPxIO

  • HP-UX

  • AIX

  • AIX VxVM

  • VS850/SVC

  • BS2000

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.