Obtaining Host Information

GET /host/{host_id}

Introduction

Obtains Host information.

Caution

Only the FC Host information and iSCSI Host information are returned.

Request Examples

  • This is an example of obtaining information about FC Host with Host ID 2.

    $ curl -i -H "Authorization: Bearer g17e4umvwYoHuhkG7yCSee.." -X GET "https://192.168.1.1:5665/api/v1/host/2"

Response Examples

{
  "host": {
    "host_id": 65792,
    "host_href": "/api/v1/host/65792",
    "type": "iSCSI",
    "number": 256,
    "name": "HBA#1",
    "iscsi_name": "iqn.1991-05.com.microsoft",
    "alias_name": "IQN-DXL",
    "ip_version": "IPv4",
    "ip_address": "192.168.1.10",
    "chap_user": "host_user1",
    "host_response_name": "Default",
    "is_shared_host_exist": false
  }
}

Parameters

PATH PARAMETERS

host_id

(required)

integer

Host ID.

QUERY PARAMETERS

fields

Array of strings

Parameter to display.

Only the information of the specified Parameter name (Response Body Parameter) is extracted and obtained.

For details about the specification methods, see Property Filter.

Responses

If successful, the HTTP status code is 200 (OK) and the response body is returned.

RESPONSE BODY

host

object

host_id

integer

Host ID.

host_href

string

Resource link of the host.

type

string

Host type.
Item Description
FC FC Host
iSCSI iSCSI Host
number

integer

Host Number.

This is the Host identifier used in ETERNUS Web GUI or ETERNUS CLI.

name

string

Host name.

status

string

Status.
Item Description
Unused Unused host.
Normal All connected Volumes are Normal.
Maintenance Some of the connected Volumes are in the Maintenance state and there are no Volumes in the Error or Warning state.
Warning Some of the connected Volumes are in the Warning state and there are no Volumes in the Error state.
Error Some of the connected Volumes are in the Error state.
wwn

string

FC Host WWN

It will not respond if it is not FC.

iscsi_name

string

iSCSI Host Name

It will not respond if it is not iSCSI.

alias_name

string

Alias Name for iSCSI Name.

It will not respond if it is not iSCSI.

If not set, an empty string is returned.

ip_version

string

The IP format of the iSCSI Host.

It will not respond if it is not iSCSI.
Item Description
IPv4 IPv4 format
IPv6 IPv6 format
ip_address

string

The IP address of the iSCSI Host.

It will not respond if it is not iSCSI.

If not set, an empty string is returned.

In this case, access is allowed from any IP address.

chap_user

string

User name for CHAP authentication.

It will not respond if it is not iSCSI.

If not set, an empty string is returned.

host_response_name

string

Host Response Name assigned to the Host.

is_shared_host_exist

boolean

Indicates whether the Hosts that share the same LUN Group exist.

If true, there are Hosts that share the same LUN Group.

maximum_hlun_count

integer

The maximum number of volumes that can be connected.

The maximum number of HLUNs that are allowed by Host Response is returned.

If Flat Space Addressing is specified as LUN Addressing, 4096 is returned.

If Peripheral Device Addressing is specified as LUN Addressing and the "LUN expand mode" is enabled, 4096 is returned.

If Peripheral Device Addressing is specified as LUN Addressing and the "LUN expand mode" is disabled, 256 is returned.